refactor(service/storage): rewrite structure

packages/core/nano-server/src/nano-server.ts

@@ -177,9 +177,9 @@ export class AlwatrNanoServer {
 
     const middleware =
       this.middlewareList[connection.method]?.[route] ||
-      this.middlewareList.all[route] ||
+      this.middlewareList.ALL[route] ||
       this.middlewareList[connection.method]?.all ||
-      this.middlewareList.all.all;
+      this.middlewareList.ALL.all;
 
     try {
       if (typeof middleware === 'function') {
@@ -234,17 +234,7 @@ export class AlwatrConnection {
    * Request method.
    */
   // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-  readonly method = this.incomingMessage.method!.toUpperCase() as Methods;
-
-  /**
-   * The token placed in the request header.
-   */
-  readonly token = this._getToken();
-
-  /**
-   * Request body for POST & PUT method.
-   */
-  readonly bodyPromise = this._getRequestBody();
+  readonly method = this.incomingMessage.method!.toUpperCase() as Exclude<Methods, 'ALL'>;
 
   protected _logger = createLogger(`alwatr-nano-server-connection`);
 
@@ -314,7 +304,10 @@ export class AlwatrConnection {
     this.serverResponse.end();
   }
 
-  protected _getToken(): string | null {
+  /**
+   * Get the token placed in the request header.
+   */
+  getToken(): string | null {
     const auth = this.incomingMessage.headers.authorization?.split(' ');
 
     if (auth == null || auth[0] !== 'Bearer') {
@@ -324,9 +317,12 @@ export class AlwatrConnection {
     return auth[1];
   }
 
-  protected async _getRequestBody(): Promise<string | null> {
+  /**
+   * Get request body.
+   */
+  async getBody(): Promise<string | null> {
     // method must be POST or PUT
-    if (!(this.method === 'POST' || this.method === 'PUT')) {
+    if (!(this.method === 'POST' || this.method === 'PUT' || this.method === 'PATCH')) {
       return null;
     }
 
@@ -352,10 +348,19 @@ export class AlwatrConnection {
    * ```
    */
   async requireJsonBody<Type extends Record<string, unknown>>(): Promise<Type | null> {
-    // if request content type is json, parse the body
-    const body = await this.bodyPromise;
+    // if request content type is json
+    if (this.incomingMessage.headers['content-type'] !== 'application/json') {
+      this.reply({
+        ok: false,
+        statusCode: 400,
+        errorCode: 'require_body_json',
+      });
+      return null;
+    }
+
+    const body = await this.getBody();
 
-    if (body === null || body.length === 0) {
+    if (body == null || body.length === 0) {
       this.reply({
         ok: false,
         statusCode: 400,
@@ -376,4 +381,57 @@ export class AlwatrConnection {
       return null;
     }
   }
+
+  requireToken(validator?: (token: string) => boolean | Array<string> | string): string | null {
+    const token = this.getToken();
+
+    if (token == null) {
+      this.reply({
+        ok: false,
+        statusCode: 401,
+        errorCode: 'authorization_required',
+      });
+      return null;
+    }
+    else if (validator === undefined) return token;
+    else if (typeof validator === 'string') {
+      if (token === validator) return token;
+    }
+    else if (Array.isArray(validator)) {
+      if (validator.includes(token)) return token;
+    }
+    else if (typeof validator === 'function') {
+      if (validator(token) === true) return token;
+    }
+
+    this.reply({
+      ok: false,
+      statusCode: 403,
+      errorCode: 'access_denied',
+    });
+    return null;
+  }
+
+
+  requireQueryParams<T extends ParamsType = ParamsType>(
+      params: Record<string, 'string' | 'number' | 'boolean'>,
+  ): T | null {
+    const parsedParams: Partial<T> = {};
+
+    for (const paramName in params) {
+      const paramType = params[paramName];
+      parsedParams[paramName] = this._sanitizeParam(paramName, paramType);
+      if (parsedParams[paramName] == null) {
+        this.reply({
+          ok: false,
+          statusCode: 406,
+          errorCode: `${param}_query_parameter_required`,
+        });
+        return null;
+      }
+    }
+
+    return parsedParams as T;
+  }
 }
+type ParamsType = Record<string, string | number | boolean>

packages/core/nano-server/src/type.ts

@@ -13,7 +13,7 @@ interface ReplySuccessContent {
 
 export type ReplyContent = ReplyFailedContent | ReplySuccessContent;
 
-export type Methods = '*' | 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'CONNECT' | 'TRACE' | 'OPTIONS' | 'PATCH';
+export type Methods = 'ALL' | 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'CONNECT' | 'TRACE' | 'OPTIONS' | 'PATCH';
 
 export interface Config {
   /**

packages/nanoservice/storage/demo.http

@@ -1,50 +1,49 @@
 @apiUrl = http://localhost:80
 @apiVersion = v0
-@token = demo_123456789_123456789_123456789_123456789_123456789
+@token = alwatr_110_313
 
-### Get a public storage
-GET {{apiUrl}}/{{apiVersion}}/comment-list/page-1.json
+### Get a public storage over nginx serve
+# GET {{apiUrl}}/{{apiVersion}}/public/comments/page1.json
 
-### Get a document by storageName/docId
-GET {{apiUrl}}/{{apiVersion}}/sample/doc-id-1
+### Get a document by storageName and docId
+GET {{apiUrl}}/{{apiVersion}}/?storage=comments/page1&id=c1
 authorization: Bearer {{token}}
 
-### Update/insert a document in storageName
-POST {{apiUrl}}/{{apiVersion}}/sample
+### Insert document
+PATCH {{apiUrl}}/{{apiVersion}}/?storage=comments/page1
 authorization: Bearer {{token}}
 Content-Type: application/json
 
 {
-  "_id": "doc-id-1",
+  "_id": "c1",
+  "_updatedBy": "demo",
   "from": "Ali Mihandoost",
-  "message": "Salam ;)"
+  "message": "Salam"
 }
 
-### Insert a document to storageName
-PUT {{apiUrl}}/{{apiVersion}}/sample
+### Edit document
+PATCH {{apiUrl}}/{{apiVersion}}/?storage=comments/page1
 authorization: Bearer {{token}}
 Content-Type: application/json
 
 {
+  "_id": "c1",
+  "_updatedBy": "demo",
   "from": "Ali Mihandoost",
   "message": "Salam ;)"
 }
 
-### Insert a document to storageName with custom id
-PUT {{apiUrl}}/{{apiVersion}}/sample
+### Remove document
+DELETE {{apiUrl}}/{{apiVersion}}/?storage=comments/page1&id=c1
 authorization: Bearer {{token}}
-Content-Type: application/json
-
-{
-  "_id": "doc-id-2",
-  "from": "Ali Mihandoost",
-  "message": "Salam ;)"
-}
 
-### Insert a document to storageName with custom id
-DELETE {{apiUrl}}/{{apiVersion}}/sample/doc-id-2
+### Get keys
+GET {{apiUrl}}/{{apiVersion}}/keys?storage=comments/page1
 authorization: Bearer {{token}}
 
+### Get all data
+GET {{apiUrl}}/{{apiVersion}}/all?storage=comments/page1
+authorization: Bearer {{token}}
 
 ### === Test other routes and errors ===
 
@@ -61,14 +60,19 @@ TRACE {{apiUrl}}/{{apiVersion}}
 GET {{apiUrl}}/{{apiVersion}}/health
 
 ### empty body
-POST {{apiUrl}}/{{apiVersion}}
+### Insert document
+PATCH {{apiUrl}}/{{apiVersion}}/?storage=comments/page1
+authorization: Bearer {{token}}
 Content-Type: application/json
 
 ### invalid json
-POST {{apiUrl}}/{{apiVersion}}/echo
+PATCH {{apiUrl}}/{{apiVersion}}/?storage=comments/page1
+authorization: Bearer {{token}}
 Content-Type: application/json
 
 {
-  "a": 1,
-  b: 2,
+  "_id": "c1",
+  "_updatedBy": "demo",
+  from: "Ali Mihandoost",
+  "message": "Salam"
 }

packages/nanoservice/storage/package.json

@@ -33,31 +33,30 @@
   "scripts": {
     "l": "yarn lint",
     "b": "yarn build",
-    "cb": "npm-run-all --sequential clean build",
-    "s": "npm-run-all --sequential clean build serve",
+    "cb": "run-s clean build",
+    "s": "run-s clean build serve",
     "w": "yarn watch",
     "f": "yarn format",
     "fl": "yarn format:eslint",
     "fp": "yarn format:prettier",
     "start": "yarn serve",
-    "lint": "npm-run-all --sequential lint:*",
+    "lint": "run-s lint:*",
     "lint:ts": "eslint **/*.ts",
-    "build": "npm-run-all --sequential build:*",
+    "build": "run-s build:*",
     "build:ts": "tsc --build",
-    "format": "npm-run-all --sequential format:prettier format:eslint",
+    "format": "run-s format:prettier format:eslint",
     "format:eslint": "eslint **/*.ts --fix",
     "format:prettier": "prettier \"**/*.{html,json,md,ts}\" --ignore-path ./.eslintignore --write",
     "clean": "rimraf dist/",
     "serve": "node dist/index.js",
     "serve:debug": "node --inspect dist/index.js",
-    "watch": "npm-run-all --parallel watch:ts watch:node",
-    "watch:node": "nodemon dist/index.js",
-    "watch:debug-node": "nodemon --inspect dist/index.js",
+    "watch": "run-s clean build && run-p watch:ts watch:node",
+    "watch:node": "nodemon -w dist/ dist/index.js",
+    "watch:debug-node": "nodemon -w dist/ --inspect dist/index.js",
     "watch:ts": "yarn build:ts --watch --preserveWatchOutput"
   },
   "dependencies": {
     "@alwatr/logger": "^0.21.0",
-    "@alwatr/math": "^0.21.0",
     "@alwatr/nano-server": "^0.21.0",
     "@alwatr/storage": "^0.21.0"
   },

packages/nanoservice/storage/src/index.ts

@@ -1,6 +1,8 @@
-import './route/home.js';
-import './route/update.js';
 import './route/get.js';
+import './route/update.js';
+import './route/remove.js';
+import './route/keys.js';
+import './route/get-all.js';
 import {logger} from './lib/config.js';
 
 logger.logOther('..:: Alwatr Storage Nanoservice API ::..');

packages/nanoservice/storage/src/lib/config.ts

@@ -1,13 +1,12 @@
 import {createLogger} from '@alwatr/logger';
-import {isNumber} from '@alwatr/math';
+
+export const logger = createLogger('service-storage');
 
 export const config = {
-  /* eslint-disable @typescript-eslint/no-non-null-assertion */
-  port: isNumber(process.env.PORT) ? +process.env.PORT! : 80,
+  host: process.env.HOST ?? '0.0.0.0',
+  port: process.env.PORT != null ? +process.env.PORT : 80,
   storagePath: process.env.STORAGE_PATH ?? 'db',
-  dataModelName: process.env.DATA_MODEL_NAME ?? 'data-model-list',
+  token: process.env.TOKEN ?? 'alwatr_110_313',
 };
 
-export const logger = createLogger('service-storage');
-
-logger.logProperty('config', config);
+logger.logProperty('config', {...config, token: '***'});

packages/nanoservice/storage/src/lib/storage-provider.ts

@@ -2,35 +2,4 @@ import {AlwatrStorageProvider} from '@alwatr/storage/provider.js';
 
 import {config} from './config.js';
 
-import type {DataModel} from './type.js';
-
 export const storageProvider = new AlwatrStorageProvider({path: config.storagePath});
-
-const dataModelStorage = await storageProvider.get<DataModel>({
-  name: config.dataModelName,
-  path: `${config.storagePath}/private`,
-});
-
-if (dataModelStorage.length === 0) {
-  dataModelStorage.set({
-    _id: 'sample',
-    _updatedBy: 'system',
-    subFolder: 'public',
-    subStorage: false,
-  });
-}
-
-export function getDataModel(storageName: string): DataModel | null {
-  const splittedName = storageName.split('/');
-  let testStorageName = '';
-  for (let i = 0; i < splittedName.length; i++) {
-    testStorageName += splittedName[i];
-    const dataModel = dataModelStorage.get(testStorageName, true);
-    if (dataModel != null) {
-      if (dataModel.subStorage === false && dataModel._id !== storageName) continue;
-      return dataModel;
-    }
-    testStorageName += '/';
-  }
-  return null;
-}