lemon-model 1.0.5 → 1.1.0

package/README.md

@@ -4,9 +4,10 @@ Common shared model definitions for both `backend` and `frontend`.
 
 ## Usage
 
-To develop backend-api, use [lemon-core](https://github.com/lemoncloud-io/lemon-core) instead of this.
+!TIP! to develop `backend` api, use [lemon-core](https://github.com/lemoncloud-io/lemon-core) instead of this.
 
 ```sh
+# install with npm
 npm install --save lemon-model
 ```
 
@@ -22,10 +23,11 @@ See [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md)
 
 ----------------
 
-# VERSION INFO
+## VERSION INFO
 
 | Version   | Description
 |--         |--
+| 1.0.6     | optimized `SearchBody` with `knn` support.
 | 1.0.5     | optimized `NextIdentity` with `authorization`.
 | 1.0.4     | optimized `NextIdentity` with `referer` and `origin`.
 | 1.0.3     | optimized `NextIdentityCognito`

package/dist/cores/transformer.d.ts

@@ -8,7 +8,7 @@
  *
  * @copyright (C) 2023 LemonCloud Co Ltd. - All Rights Reserved.
  */
-import { CoreModel } from '../types/core-storage';
+import { CoreModel, CoreModifier } from '../types/core-storage';
 /**
  * internal type `Model`
  */
@@ -16,7 +16,7 @@ declare type Model = CoreModel<string>;
 /**
  * partial set of `CoreModel`
  */
-export interface Cores {
+export interface Cores extends Partial<CoreModifier> {
     /**
      * site-id of model
      * - inited by `identity-token` if use session
@@ -126,13 +126,13 @@ export declare abstract class AbstractTransformer<MyModel extends Model, MyView
      * extract only the defined attribute.
      * ex) `{ a:1, b: undefined }` -> `{ a:1 }`
      */
-    onlyDefined: <T extends object>(N: T) => T;
+    onlyDefined: <T extends object>(N?: T) => T;
     /**
      * transform from model to view
      *
      * @see Transformable.modelAsView
      */
-    modelAsView(model: MyModel, hasCores?: boolean): MyView;
+    modelAsView(model?: MyModel | null, hasCores?: boolean): MyView;
     /**
      * transform from body(req-body) to model
      *

package/dist/cores/transformer.js

@@ -25,13 +25,15 @@ class AbstractTransformer {
          * 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;
+        this.onlyDefined = (N) => N === undefined || N === null
+            ? 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

package/dist/cores/transformer.js.map

@@ -1 +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"}
+{"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,CAAY,EAAY,EAAE,CAC9D,CAAC,KAAK,SAAS,IAAI,CAAC,KAAK,IAAI;YACzB,CAAC,CAAC,CAAC;YACH,CAAC,CAAC,CAAC,IAAI,OAAO,CAAC,KAAK,QAAQ;gBAC5B,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,MAAM,CAAI,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE;oBACtC,IAAI,CAAC,KAAK,SAAS;wBAAE,CAAC,CAAC,CAAY,CAAC,GAAG,CAAC,CAAC;oBACzC,OAAO,CAAC,CAAC;gBACb,CAAC,EAAE,EAAO,CAAC;gBACb,CAAC,CAAC,IAAI,CAAC;IAwCnB,CAAC;IAtCG;;;;OAIG;IACI,WAAW,CAAC,KAAsB,EAAE,QAAkB;QACzD,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;AApED,kDAoEC"}

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

@@ -32,11 +32,29 @@ export interface StorageModel extends InternalKey {
     /** json formated string (or parsed object). */
     meta?: string | any;
 }
+/**
+ * class: `CoreModifier`
+ * - common modifier information for core-model
+ */
+export interface CoreModifier {
+    /**
+     * site-id
+     */
+    sid?: string;
+    /**
+     * user-id
+     */
+    uid?: string;
+    /**
+     *  group-id
+     */
+    gid?: string;
+}
 /**
  * class: `InternalModel`
  * - common internal properties. (ONLY FOR INTERNAL PROCESSING)
  */
-export interface InternalModel {
+export interface InternalModel extends CoreModifier {
     /**
      * internal unique partition-key (valid if using default idName )
      */
@@ -47,6 +65,11 @@ export interface InternalModel {
  * - general model out of base Model to support the common usage
  */
 export interface CoreModel<ModelType extends string = string> extends StorageModel, InternalModel {
+    /**
+     * the last modifier info
+     * - set automatically when model is created/updated/deleted.
+     */
+    readonly $?: CoreModifier;
     /**
      * namespace
      */

package/dist/types/core-storage.js

@@ -14,7 +14,20 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CORE_FIELDS = void 0;
 //NOTE! - BE WARE TO USE `ts-transformer-keys` DUE TO MISSING `ttypescript`
-// export const CORE_FIELDS: string[] = keys<CoreModel>().filter(_ => !_.startsWith('_'));
-// _inf(NS, '! CORE_FIELDS =', CORE_FIELDS.join(', ')); // for debugging.
-exports.CORE_FIELDS = 'ns,type,stereo,sid,uid,gid,lock,next,meta,createdAt,updatedAt,deletedAt'.split(',');
+exports.CORE_FIELDS = [
+    '$',
+    'ns',
+    'type',
+    'stereo',
+    'sid',
+    'uid',
+    'gid',
+    'lock',
+    'next',
+    'meta',
+    'createdAt',
+    'updatedAt',
+    'deletedAt',
+    'error',
+];
 //# sourceMappingURL=core-storage.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"core-storage.js","sourceRoot":"","sources":["../../src/types/core-storage.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;GAWG;;;AAgGH,2EAA2E;AAC3E,0FAA0F;AAC1F,yEAAyE;AAC5D,QAAA,WAAW,GAAa,yEAAyE,CAAC,KAAK,CAChH,GAAG,CACN,CAAC"}
+{"version":3,"file":"core-storage.js","sourceRoot":"","sources":["../../src/types/core-storage.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;GAWG;;;AAwHH,2EAA2E;AAC9D,QAAA,WAAW,GAAa;IACjC,GAAG;IACH,IAAI;IACJ,MAAM;IACN,QAAQ;IACR,KAAK;IACL,KAAK;IACL,KAAK;IACL,MAAM;IACN,MAAM;IACN,MAAM;IACN,WAAW;IACX,WAAW;IACX,WAAW;IACX,OAAO;CACV,CAAC"}

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

@@ -9,6 +9,7 @@
  * @date        2021-12-07 support SearchBody
  * @date        2024-12-20 optimized `NextIdentityCognito`
  * @date        2025-05-13 optimized `NextContext` with `Authorization` header
+ * @date        2025-06-12 optimized `SearchBody` with `knn` support
  *
  * @copyright   (C) lemoncloud.io 2019 - All Rights Reserved.
  */
@@ -295,7 +296,9 @@ export interface QueryResult<T> {
     last?: any;
 }
 /**
- * 쿼리의 각 항목의 값들
+ * type: `QueryTerm`
+ * - query term for search.
+ * - it should be compartible with elastic-search.
  */
 export declare type QueryTerm = string | number | string[] | number[] | {
     query: string | number | string[] | number[];
@@ -310,7 +313,9 @@ export declare type QueryTerm = string | number | string[] | number[] | {
     };
 };
 /**
- * 정렬(sort)에 쓰이는 항목.
+ * type: `SortTerm`
+ * - sort term for search.
+ * - it should be compartible with elastic-search.
  */
 export declare type SortTerm = string | {
     [key: string]: 'asc' | 'desc';
@@ -321,7 +326,9 @@ export declare type SortTerm = string | {
     };
 };
 /**
- * 검색 쿼리 항목.
+ * type: `SearchQuery`
+ * - search query for elastic-search.
+ * - it should be compartible with elastic-search.
  */
 export interface SearchQuery {
     term?: {
@@ -358,6 +365,26 @@ export interface SearchQuery {
         should?: SearchQuery | SearchQuery[];
         minimum_should_match?: number;
     };
+    /** required to have mapping type: `knn_vector` */
+    knn?: {
+        /** field (ex: `vector$.sm3`) to query */
+        [field: string]: {
+            vector: number[];
+            /** The number of nearest neighbors to return */
+            k?: number;
+            max_distance?: number;
+            min_score?: number;
+            filter?: SearchQuery;
+            method_parameters?: {
+                ef_search?: number;
+                nprobes?: number;
+            };
+            rescore?: {
+                oversample_factor?: number;
+            } | boolean;
+            expand_nested_docs?: boolean;
+        };
+    };
     query_string?: {
         query: string;
     };

package/dist/types/core-types.js

@@ -10,6 +10,7 @@
  * @date        2021-12-07 support SearchBody
  * @date        2024-12-20 optimized `NextIdentityCognito`
  * @date        2025-05-13 optimized `NextContext` with `Authorization` header
+ * @date        2025-06-12 optimized `SearchBody` with `knn` support
  *
  * @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;;;;;;;;;;;;;GAaG"}
+{"version":3,"file":"core-types.js","sourceRoot":"","sources":["../../src/types/core-types.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;GAcG"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lemon-model",
-  "version": "1.0.5",
+  "version": "1.1.0",
   "description": "Common shared model definitions for Lemon Micro-Service Platform",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",