lemon-model 1.0.5 → 1.0.6

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/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.0.6",
   "description": "Common shared model definitions for Lemon Micro-Service Platform",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",