From 49a1fd26e722b76e36fe9f7ae23d99a9cca51a7a Mon Sep 17 00:00:00 2001 From: Mal <=> Date: Sun, 6 Sep 2020 12:07:26 +0200 Subject: [PATCH] First API requests implemented. --- .gitignore | 3 +- index.html | 11 ++++++ js/api/ApiRequest.ts | 54 +++++++++++++++++++++++++++++ js/api/RequestMethod.ts | 8 +++++ js/api/UserGetApiRequest.ts | 10 ++++++ tsconfig.json | 69 +++++++++++++++++++++++++++++++++++++ 6 files changed, 154 insertions(+), 1 deletion(-) create mode 100644 index.html create mode 100644 js/api/ApiRequest.ts create mode 100644 js/api/RequestMethod.ts create mode 100644 js/api/UserGetApiRequest.ts create mode 100644 tsconfig.json diff --git a/.gitignore b/.gitignore index c4e618d..5f918aa 100644 --- a/.gitignore +++ b/.gitignore @@ -3,4 +3,5 @@ backend/cache backend/tmp backend/qr api/docs -.idea +*.js +.idea \ No newline at end of file diff --git a/index.html b/index.html new file mode 100644 index 0000000..00611c9 --- /dev/null +++ b/index.html @@ -0,0 +1,11 @@ + + + + + Ringfinger + + + + + + \ No newline at end of file diff --git a/js/api/ApiRequest.ts b/js/api/ApiRequest.ts new file mode 100644 index 0000000..f016fc2 --- /dev/null +++ b/js/api/ApiRequest.ts @@ -0,0 +1,54 @@ +import RequestMethod from "./RequestMethod.js"; + +export default class ApiRequest +{ + protected static BASE_URL: string = 'api/v1/'; + + protected request: XMLHttpRequest; + protected method: RequestMethod; + protected url: string; + protected parameters: Record = {}; + protected onSuccess: (responseText: string, status: number) => void; + protected onError: (responseText: string, status: number) => void; + + public constructor(url: string, method: RequestMethod) + { + this.url = ApiRequest.BASE_URL + url; + this.method = method; + this.request = new XMLHttpRequest(); + this.request.open(this.method, this.url); + this.onSuccess = () => {}; + this.onError = () => {}; + } + + public addParameter(name: string, value: any): void + { + this.parameters[name] = value; + } + + public submit(): void + { + this.request.onreadystatechange = () => { + if (this.request.readyState === 4) { + if (this.request.status === 200) { + this.onSuccess(this.request.responseText, this.request.status); + } else { + this.onError(this.request.responseText, this.request.status); + } + } + } + + this.request.setRequestHeader('Content-Type', 'application/json'); + this.request.send(JSON.stringify(this.parameters)); + } + + public setOnSuccess(callback: (responseText: string, status: number) => void): void + { + this.onSuccess = callback; + } + + public setOnError(callback: (responseText: string, status: number) => void): void + { + this.onError = callback; + } +} diff --git a/js/api/RequestMethod.ts b/js/api/RequestMethod.ts new file mode 100644 index 0000000..d9162fc --- /dev/null +++ b/js/api/RequestMethod.ts @@ -0,0 +1,8 @@ +enum RequestMethod { + GET = 'GET', + POST = 'POST', + PUT = 'PUT', + DELETE = 'DELETE', +} + +export default RequestMethod; diff --git a/js/api/UserGetApiRequest.ts b/js/api/UserGetApiRequest.ts new file mode 100644 index 0000000..79a27be --- /dev/null +++ b/js/api/UserGetApiRequest.ts @@ -0,0 +1,10 @@ +import ApiRequest from "./ApiRequest.js"; +import RequestMethod from "./RequestMethod.js"; + +export default class UserGetApiRequest extends ApiRequest +{ + public constructor(userId: number) + { + super('user/' + userId, RequestMethod.GET); + } +} diff --git a/tsconfig.json b/tsconfig.json new file mode 100644 index 0000000..87452b0 --- /dev/null +++ b/tsconfig.json @@ -0,0 +1,69 @@ +{ + "compilerOptions": { + /* Visit https://aka.ms/tsconfig.json to read more about this file */ + + /* Basic Options */ + // "incremental": true, /* Enable incremental compilation */ + "target": "es6", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */ + "module": "es2020", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */ + // "lib": [], /* Specify library files to be included in the compilation. */ + // "allowJs": true, /* Allow javascript files to be compiled. */ + // "checkJs": true, /* Report errors in .js files. */ + // "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */ + // "declaration": true, /* Generates corresponding '.d.ts' file. */ + // "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */ + // "sourceMap": true, /* Generates corresponding '.map' file. */ + // "outFile": "./", /* Concatenate and emit output to single file. */ + // "outDir": "./", /* Redirect output structure to the directory. */ + // "rootDir": "./", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */ + // "composite": true, /* Enable project compilation */ + // "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */ + // "removeComments": true, /* Do not emit comments to output. */ + // "noEmit": true, /* Do not emit outputs. */ + // "importHelpers": true, /* Import emit helpers from 'tslib'. */ + // "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */ + // "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */ + + /* Strict Type-Checking Options */ + "strict": true, /* Enable all strict type-checking options. */ + // "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */ + // "strictNullChecks": true, /* Enable strict null checks. */ + // "strictFunctionTypes": true, /* Enable strict checking of function types. */ + // "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */ + // "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */ + // "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */ + // "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */ + + /* Additional Checks */ + // "noUnusedLocals": true, /* Report errors on unused locals. */ + // "noUnusedParameters": true, /* Report errors on unused parameters. */ + // "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */ + // "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */ + + /* Module Resolution Options */ + // "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */ + // "baseUrl": "./", /* Base directory to resolve non-absolute module names. */ + // "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */ + // "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */ + // "typeRoots": [], /* List of folders to include type definitions from. */ + // "types": [], /* Type declaration files to be included in compilation. */ + // "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */ + "esModuleInterop": true, /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */ + // "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */ + // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */ + + /* Source Map Options */ + // "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */ + // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */ + // "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */ + // "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */ + + /* Experimental Options */ + // "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */ + // "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */ + + /* Advanced Options */ + "skipLibCheck": true, /* Skip type checking of declaration files. */ + "forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */ + } +}