diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..8b4a82e --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +node_modules/ +dist/ +.DS_Store \ No newline at end of file diff --git a/package-lock.json b/package-lock.json new file mode 100644 index 0000000..aeaffd6 --- /dev/null +++ b/package-lock.json @@ -0,0 +1,29 @@ +{ + "name": "l5", + "version": "1.0.0", + "lockfileVersion": 3, + "requires": true, + "packages": { + "": { + "name": "l5", + "version": "1.0.0", + "license": "ISC", + "devDependencies": { + "typescript": "^5.3.3" + } + }, + "node_modules/typescript": { + "version": "5.3.3", + "resolved": "https://registry.npmjs.org/typescript/-/typescript-5.3.3.tgz", + "integrity": "sha512-pXWcraxM0uxAS+tN0AG/BF2TyqmHO014Z070UsJ+pFvYuRSq8KH8DmWpnbXe0pEPDHXZV3FcAbJkijJ5oNEnWw==", + "dev": true, + "bin": { + "tsc": "bin/tsc", + "tsserver": "bin/tsserver" + }, + "engines": { + "node": ">=14.17" + } + } + } +} diff --git a/package.json b/package.json new file mode 100644 index 0000000..f8ef922 --- /dev/null +++ b/package.json @@ -0,0 +1,14 @@ +{ + "name": "l5", + "version": "1.0.0", + "description": "", + "main": "index.ts", + "scripts": { + "test": "echo \"Error: no test specified\" && exit 1" + }, + "author": "", + "license": "ISC", + "devDependencies": { + "typescript": "^5.3.3" + } +} diff --git a/src/index.ts b/src/index.ts new file mode 100644 index 0000000..739f6ae --- /dev/null +++ b/src/index.ts @@ -0,0 +1 @@ +export * from './types' \ No newline at end of file diff --git a/src/l5Client.ts b/src/l5Client.ts new file mode 100644 index 0000000..4e556b3 --- /dev/null +++ b/src/l5Client.ts @@ -0,0 +1,103 @@ +import { Filter, Paginator } from "./types"; + +export default class l5Client { + private _baseUrl: string; + private _route: string = ""; + private _headers: Record = {}; + private _queryParams: { [key: string]: string } = {}; + + constructor(baseUrl: string, headers: Record = {}) { + this._baseUrl = baseUrl.replace(/^\/?|\/?$/g, ""); + this._headers = headers; + } + + route(route: string): this { + this._route = route.replace(/^\/?|\/?$/g, ""); + this._queryParams = {}; + return this; + } + + // auth(username: string, password: string): this { + // this._url.username = username + // this._url.password = password + // return this + // } + + search(key: string, operator: string, value: string): this { + this._queryParams[Filter.QueryParamKeys.SearchFields] = + (this._queryParams[Filter.QueryParamKeys.SearchFields] || "") + + `${key}:${operator};`; + this._queryParams[Filter.QueryParamKeys.Search] = + (this._queryParams[Filter.QueryParamKeys.Search] || "") + + `${key}:${value};`; + return this; + } + + paginate(page: number = 1, perPage: number = 20): this { + this._queryParams[Filter.QueryParamKeys.Page] = page.toString(); + this._queryParams[Filter.QueryParamKeys.PerPage] = perPage.toString(); + return this; + } + + order(direction: Filter.OrderDirection, column: string): this; + order( + direction: Filter.OrderDirection, + column: string, + joinTable?: string + ): this; + order( + direction: Filter.OrderDirection, + column: string, + joinTable?: string, + joinColumn?: string + ): this; + order( + direction: Filter.OrderDirection, + column: string, + joinTable?: string, + joinColumn?: string + ): this { + if (joinTable === undefined && joinColumn === undefined) { + // 1. order by own table column + this._queryParams[Filter.QueryParamKeys.OrderBy] = ( + (this._queryParams[Filter.QueryParamKeys.OrderBy] || "") + `${column};` + ).replace(/^\;?|\;?$/g, ""); + } else if (joinTable !== undefined && joinColumn === undefined) { + // 2. order by join table column + this._queryParams[Filter.QueryParamKeys.OrderBy] = ( + (this._queryParams[Filter.QueryParamKeys.OrderBy] || "") + + `${joinTable}|${column};` + ).replace(/^\;?|\;?$/g, ""); + } else if (joinTable !== undefined && joinColumn !== undefined) { + // 3. order by join table column and specify join column + this._queryParams[Filter.QueryParamKeys.OrderBy] = ( + (this._queryParams[Filter.QueryParamKeys.OrderBy] || "") + + `${joinTable}:${joinColumn}|${column};` + ).replace(/^\;?|\;?$/g, ""); + } + this._queryParams[Filter.QueryParamKeys.OrderDir] = ( + (this._queryParams[Filter.QueryParamKeys.OrderDir] || "") + `${direction}` + ).replace(/^\;?|\;?$/g, ""); + return this; + } + + async fetch(): Promise> { + const res = await fetch(this.buildUrl(), { + method: "GET", + headers: this._headers, + }); + return await res.json(); + } + + private buildUrl(): string { + const url = new URL(`${this._baseUrl}/${this._route}`); + Object.entries(this._queryParams).forEach(([key, value]) => { + if (value !== null && value !== undefined) { + url.searchParams.append(key, value.toString()); + } + }); + console.log("--- URL:", url); + + return url.toString(); + } +} diff --git a/src/types.ts b/src/types.ts new file mode 100644 index 0000000..a490c73 --- /dev/null +++ b/src/types.ts @@ -0,0 +1,28 @@ +export namespace Filter { + + export enum QueryParamKeys { + Page = "page", + PerPage = "perPage", + OrderBy = "orderBy", + OrderDir = "orderType", + Search = "search", + SearchFields = "searchFields", + } + + export enum OrderDirection { + Ascending = 'asc', + Descending = 'desc' + } +} + +export type Paginator = { + data: T[] + meta: { + current_page: number + last_page: number + from: number + to: number + total: number + per_page: number + } +} \ No newline at end of file diff --git a/tsconfig.json b/tsconfig.json new file mode 100644 index 0000000..d583cce --- /dev/null +++ b/tsconfig.json @@ -0,0 +1,109 @@ +{ + "compilerOptions": { + /* Visit https://aka.ms/tsconfig to read more about this file */ + + /* Projects */ + // "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */ + // "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */ + // "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */ + // "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */ + // "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */ + // "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */ + + /* Language and Environment */ + "target": "ES2017", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */ + // "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */ + // "jsx": "preserve", /* Specify what JSX code is generated. */ + // "experimentalDecorators": true, /* Enable experimental support for legacy experimental decorators. */ + // "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */ + // "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */ + // "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */ + // "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */ + // "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */ + // "noLib": true, /* Disable including any library files, including the default lib.d.ts. */ + // "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */ + // "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */ + + /* Modules */ + "module": "commonjs", /* Specify what module code is generated. */ + "rootDir": "./src", /* Specify the root folder within your source files. */ + // "moduleResolution": "node10", /* Specify how TypeScript looks up a file from a given module specifier. */ + // "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */ + // "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */ + // "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */ + // "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */ + // "types": [], /* Specify type package names to be included without being referenced in a source file. */ + // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */ + // "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */ + // "allowImportingTsExtensions": true, /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */ + // "resolvePackageJsonExports": true, /* Use the package.json 'exports' field when resolving package imports. */ + // "resolvePackageJsonImports": true, /* Use the package.json 'imports' field when resolving imports. */ + // "customConditions": [], /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */ + // "resolveJsonModule": true, /* Enable importing .json files. */ + // "allowArbitraryExtensions": true, /* Enable importing files with any extension, provided a declaration file is present. */ + // "noResolve": true, /* Disallow 'import's, 'require's or ''s from expanding the number of files TypeScript should add to a project. */ + + /* JavaScript Support */ + // "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */ + // "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */ + // "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */ + + /* Emit */ + // "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */ + // "declarationMap": true, /* Create sourcemaps for d.ts files. */ + // "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */ + // "sourceMap": true, /* Create source map files for emitted JavaScript files. */ + // "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */ + // "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */ + "outDir": "./dist", /* Specify an output folder for all emitted files. */ + // "removeComments": true, /* Disable emitting comments. */ + // "noEmit": true, /* Disable emitting files from a compilation. */ + // "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */ + // "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */ + // "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */ + // "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */ + // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */ + // "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */ + // "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */ + // "newLine": "crlf", /* Set the newline character for emitting files. */ + // "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */ + // "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */ + // "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */ + // "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */ + // "declarationDir": "./", /* Specify the output directory for generated declaration files. */ + // "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */ + + /* Interop Constraints */ + // "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */ + // "verbatimModuleSyntax": true, /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */ + // "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */ + "esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */ + // "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */ + "forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */ + + /* Type Checking */ + "strict": true, /* Enable all strict type-checking options. */ + // "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */ + // "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */ + // "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */ + // "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */ + // "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */ + // "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */ + // "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */ + // "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */ + // "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */ + // "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */ + // "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */ + // "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */ + // "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */ + // "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */ + // "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */ + // "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */ + // "allowUnusedLabels": true, /* Disable error reporting for unused labels. */ + // "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */ + + /* Completeness */ + // "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */ + "skipLibCheck": true /* Skip type checking all .d.ts files. */ + } +}