lemon-model 1.0.1 → 1.0.3

package/README.md

@@ -1,13 +1,13 @@
 # lemon-model
 
-Common shared model definitions for both backend and frontend.
+Common shared model definitions for both `backend` and `frontend`.
 
 ## Usage
 
 To develop backend-api, use `lemon-core` instead of this.
 
 ```sh
-npm install --save lemon-core
+$ npm install --save lemon-core
 ```
 
 
@@ -28,4 +28,5 @@ See [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md)
 
 | Version   | Description
 |--         |--
+| 1.0.3     | optimized `NextIdentityCognito`
 | 1.0.0     | initial types out of the original `lemon-core@3.1.1`

package/dist/cores/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * `index.ts`
+ * - main index
+ *
+ * @author      Steve Jung <steve@lemoncloud.io>
+ * @date        2023-01-19 initial version
+ *
+ * @copyright (C) lemoncloud.io 2023 - All Rights Reserved.
+ */
+export * from './transformer';

package/dist/cores/index.js

@@ -0,0 +1,27 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/**
+ * `index.ts`
+ * - main index
+ *
+ * @author      Steve Jung <steve@lemoncloud.io>
+ * @date        2023-01-19 initial version
+ *
+ * @copyright (C) lemoncloud.io 2023 - All Rights Reserved.
+ */
+__exportStar(require("./transformer"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cores/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/cores/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA;;;;;;;;GAQG;AACH,gDAA8B"}

package/dist/cores/transformer.d.ts

@@ -0,0 +1,143 @@
+/**
+ * `transformer.ts`
+ * - general transformer between `Model`, `View` and `Body`
+ *
+ *
+ * @author      Steve <steve@lemoncloud.io>
+ * @date        2023-01-19 initial version
+ *
+ * @copyright (C) 2023 LemonCloud Co Ltd. - All Rights Reserved.
+ */
+import { CoreModel } from '../types/core-storage';
+/**
+ * internal type `Model`
+ */
+declare type Model = CoreModel<string>;
+/**
+ * partial set of `CoreModel`
+ */
+export interface Cores {
+    /**
+     * site-id of model
+     * - inited by `identity-token` if use session
+     */
+    sid?: string;
+    /**
+     * user-id of model
+     * - inited by `identity-token` if use session
+     */
+    uid?: string;
+    /**
+     *  group-id of model
+     * - inited by `identity-token` if use session
+     */
+    gid?: string;
+}
+/**
+ * common `View` types.
+ * - layout of response.
+ */
+export interface View {
+    /**
+     * (optional) model's id
+     */
+    id?: string;
+    /**
+     * created timestamp
+     */
+    createdAt?: number;
+    /**
+     * updated timestamp
+     */
+    updatedAt?: number;
+    /**
+     * deleted timestamp
+     */
+    deletedAt?: number;
+    /**
+     * (optional) internal error.
+     */
+    error?: string;
+    /**
+     * (optional) internal cores data
+     */
+    readonly $?: Cores;
+}
+/**
+ * common `Body` types.
+ * - layout of request's body.
+ */
+export interface Body {
+    /**
+     * (optional) target model's id
+     */
+    id?: string;
+}
+/**
+ * transform model to view, or body to model.
+ * - required the sub-class model of `CoreModel`
+ *
+ * @see CoreModel
+ */
+export interface Transformable<MyModel extends Model, MyView extends View, MyBody extends Body> {
+    /**
+     * transform model to view
+     * - result will be response json.
+     *
+     * @param model the data model.
+     * @param hasCores (optional) include the properties in `CoreModel` as `$`
+     */
+    modelAsView: (model: MyModel, hasCores?: boolean) => MyView;
+    /**
+     * transform request-body to model.
+     * - must check data types
+     *
+     * @param body the body posted
+     * @param isCreate (optional) if body is for creation.
+     */
+    bodyToModel: (body: MyBody, isCreate?: boolean) => MyModel;
+}
+/**
+ * reverse into model from remote view & body.
+ */
+export interface Reversable<Model, View = Model, Body = Model> {
+    /**
+     * convert response-view to model
+     */
+    asModel: (view: View) => Model;
+    /**
+     * convert model to request-body.
+     */
+    asBody: (model: Model) => Body;
+}
+/**
+ * type: `AbstractTransformer`
+ * - common base class of `Transformable`
+ */
+export declare abstract class AbstractTransformer<MyModel extends Model, MyView extends View, MyBody extends Body> implements Transformable<MyModel, MyView, MyBody> {
+    /**
+     * check in date: YYYY-MM-DD
+     *
+     * @param val string
+     * @param field (optional) target field name to use
+     */
+    asDate: (val: string, field?: string) => string;
+    /**
+     * extract only the defined attribute.
+     * ex) `{ a:1, b: undefined }` -> `{ a:1 }`
+     */
+    onlyDefined: <T extends object>(N: T) => T;
+    /**
+     * transform from model to view
+     *
+     * @see Transformable.modelAsView
+     */
+    modelAsView(model: MyModel, hasCores?: boolean): MyView;
+    /**
+     * transform from body(req-body) to model
+     *
+     * @see Transformable.bodyToModel
+     */
+    bodyToModel(body: MyBody | any, isCreate?: boolean): MyModel;
+}
+export {};

package/dist/cores/transformer.js

@@ -0,0 +1,78 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AbstractTransformer = void 0;
+/**
+ * type: `AbstractTransformer`
+ * - common base class of `Transformable`
+ */
+class AbstractTransformer {
+    constructor() {
+        /**
+         * check in date: YYYY-MM-DD
+         *
+         * @param val string
+         * @param field (optional) target field name to use
+         */
+        this.asDate = (val, field = 'date') => {
+            if (!val || typeof val !== 'string')
+                return '';
+            const re = /^[12]\d{3}-(0[1-9]|1[0-2])-(0[1-9]|[12]\d|3[01])$/;
+            if (!re.test(val))
+                throw new Error(`.${field}[${val}] is invalid format - asDate()`);
+            return val;
+        };
+        /**
+         * extract only the defined attribute.
+         * ex) `{ a:1, b: undefined }` -> `{ a:1 }`
+         */
+        this.onlyDefined = (N) => N && typeof N === 'object'
+            ? Object.entries(N).reduce((N, [k, v]) => {
+                if (v !== undefined)
+                    N[k] = v;
+                return N;
+            }, {})
+            : null;
+    }
+    /**
+     * transform from model to view
+     *
+     * @see Transformable.modelAsView
+     */
+    modelAsView(model, hasCores) {
+        if (!model || typeof model !== 'object')
+            return null;
+        const view = {
+            id: model.id,
+            createdAt: model.createdAt,
+            updatedAt: model.updatedAt,
+            deletedAt: model.deletedAt,
+        };
+        if (model.error)
+            view.error = model.error;
+        if (hasCores) {
+            const $ = this.onlyDefined({
+                sid: model.sid,
+                gid: model.gid,
+                uid: model.uid,
+            });
+            Object.assign(view, { $ });
+        }
+        return this.onlyDefined(view);
+    }
+    /**
+     * transform from body(req-body) to model
+     *
+     * @see Transformable.bodyToModel
+     */
+    bodyToModel(body, isCreate) {
+        var _a;
+        if (!body || typeof body !== 'object')
+            return null;
+        const model = {};
+        if ((body === null || body === void 0 ? void 0 : body.id) !== undefined)
+            model.id = `${(_a = body.id) !== null && _a !== void 0 ? _a : ''}`;
+        return model;
+    }
+}
+exports.AbstractTransformer = AbstractTransformer;
+//# sourceMappingURL=transformer.js.map

package/dist/cores/transformer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"transformer.js","sourceRoot":"","sources":["../../src/cores/transformer.ts"],"names":[],"mappings":";;;AA0HA;;;GAGG;AACH,MAAsB,mBAAmB;IAAzC;QAGI;;;;;WAKG;QACI,WAAM,GAAG,CAAC,GAAW,EAAE,KAAK,GAAG,MAAM,EAAE,EAAE;YAC5C,IAAI,CAAC,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ;gBAAE,OAAO,EAAE,CAAC;YAC/C,MAAM,EAAE,GAAG,mDAAmD,CAAC;YAC/D,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC;gBAAE,MAAM,IAAI,KAAK,CAAC,IAAI,KAAK,IAAI,GAAG,gCAAgC,CAAC,CAAC;YACrF,OAAO,GAAG,CAAC;QACf,CAAC,CAAC;QAEF;;;WAGG;QACI,gBAAW,GAAG,CAAmB,CAAI,EAAE,EAAE,CAC5C,CAAC,IAAI,OAAO,CAAC,KAAK,QAAQ;YACtB,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,MAAM,CAAI,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE;gBACtC,IAAI,CAAC,KAAK,SAAS;oBAAE,CAAC,CAAC,CAAY,CAAC,GAAG,CAAC,CAAC;gBACzC,OAAO,CAAC,CAAC;YACb,CAAC,EAAE,EAAO,CAAC;YACb,CAAC,CAAC,IAAI,CAAC;IAwCnB,CAAC;IAtCG;;;;OAIG;IACI,WAAW,CAAC,KAAc,EAAE,QAAkB;QACjD,IAAI,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ;YAAE,OAAO,IAAI,CAAC;QACrD,MAAM,IAAI,GAAS;YACf,EAAE,EAAE,KAAK,CAAC,EAAE;YACZ,SAAS,EAAE,KAAK,CAAC,SAAS;YAC1B,SAAS,EAAE,KAAK,CAAC,SAAS;YAC1B,SAAS,EAAE,KAAK,CAAC,SAAS;SAC7B,CAAC;QACF,IAAI,KAAK,CAAC,KAAK;YAAE,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC,KAAK,CAAC;QAC1C,IAAI,QAAQ,EAAE;YACV,MAAM,CAAC,GAAG,IAAI,CAAC,WAAW,CAAQ;gBAC9B,GAAG,EAAE,KAAK,CAAC,GAAG;gBACd,GAAG,EAAE,KAAK,CAAC,GAAG;gBACd,GAAG,EAAE,KAAK,CAAC,GAAG;aACjB,CAAC,CAAC;YACH,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC,EAAE,CAAC,CAAC;SAC9B;QACD,OAAO,IAAI,CAAC,WAAW,CAAS,IAAc,CAAC,CAAC;IACpD,CAAC;IAED;;;;OAIG;IACI,WAAW,CAAC,IAAkB,EAAE,QAAkB;;QACrD,IAAI,CAAC,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ;YAAE,OAAO,IAAI,CAAC;QACnD,MAAM,KAAK,GAAG,EAAa,CAAC;QAE5B,IAAI,CAAA,IAAI,aAAJ,IAAI,uBAAJ,IAAI,CAAE,EAAE,MAAK,SAAS;YAAE,KAAK,CAAC,EAAE,GAAG,GAAG,MAAA,IAAI,CAAC,EAAE,mCAAI,EAAE,EAAE,CAAC;QAE1D,OAAO,KAAgB,CAAC;IAC5B,CAAC;CACJ;AAlED,kDAkEC"}

package/dist/index.d.ts

@@ -9,3 +9,4 @@
  * @copyright (C) lemoncloud.io 2019 - All Rights Reserved.
  */
 export * from './types';
+export * from './cores';

package/dist/index.js

@@ -25,4 +25,5 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * @copyright (C) lemoncloud.io 2019 - All Rights Reserved.
  */
 __exportStar(require("./types"), exports);
+__exportStar(require("./cores"), exports);
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA;;;;;;;;;GASG;AACH,0CAAwB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA;;;;;;;;;GASG;AACH,0CAAwB;AACxB,0CAAwB"}

package/dist/types/core-types.d.ts

@@ -7,6 +7,7 @@
  * @date        2019-11-20 initial version
  * @date        2020-01-03 support cognito-identity
  * @date        2021-12-07 support SearchBody
+ * @date        2024-12-20 optimized `NextIdentityCognito`
  *
  * @copyright   (C) lemoncloud.io 2019 - All Rights Reserved.
  */
@@ -139,6 +140,14 @@ export interface NextIdentityCognito<T = any> extends NextIdentity<T> {
      * - available since `3.1.1`
      */
     caller?: string;
+    /**
+     * (optional) access-key used to sign.
+     */
+    accessKey?: string;
+    /**
+     * (optional) api-key if applicable.
+     */
+    apiKey?: string;
 }
 /**
  * class: `NextIdentityAcess`

package/dist/types/core-types.js

@@ -8,6 +8,7 @@
  * @date        2019-11-20 initial version
  * @date        2020-01-03 support cognito-identity
  * @date        2021-12-07 support SearchBody
+ * @date        2024-12-20 optimized `NextIdentityCognito`
  *
  * @copyright   (C) lemoncloud.io 2019 - All Rights Reserved.
  */

package/dist/types/core-types.js.map

@@ -1 +1 @@
-{"version":3,"file":"core-types.js","sourceRoot":"","sources":["../../src/types/core-types.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;GAWG"}
+{"version":3,"file":"core-types.js","sourceRoot":"","sources":["../../src/types/core-types.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;GAYG"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lemon-model",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "Common shared model definitions for Lemon Micro-Service Platform",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -35,11 +35,10 @@
     "dist/**/*"
   ],
   "engines": {
-    "node": ">=12.22.12"
+    "node": ">=18.19.0"
   },
   "author": "Steve Jung <steve@lemoncloud.io>",
   "license": "MIT",
-  "dependencies": {},
   "devDependencies": {
     "@types/async": "^3.2.3",
     "@types/cookie-parser": "^1.4.2",
@@ -57,13 +56,13 @@
     "gh-pages": "^2.2.0",
     "husky": "^2.2.0",
     "jest": "^27.5.1",
-    "lint-staged": "^8.1.6",
+    "lint-staged": "^13.1.0",
     "prettier": "^2.6.0",
     "superagent": "^5.3.1",
     "supertest": "^4.0.2",
     "ts-jest": "^27.1.3",
     "ts-node": "^8.10.2",
-    "ttypescript": "^1.5.13",
+    "ttypescript": "^1.5.15",
     "typedoc": "^0.15.8",
     "typescript": "^4.6.2"
   },