lemon-core 4.3.0 → 5.0.1

package/dist/extended/cores/abstract-services.d.ts

@@ -1,10 +1,13 @@
-import { SearchType, Elastic6Service, Elastic6Option, Elastic6QueryService } from '../../cores/';
+import { SearchType, OS2CoreService, OS2BaseOption, OS2QueryService } from '../../cores/';
 import { DynamoScanFilter, ApiHttpProxy } from '../../cores/';
-import { elasticsearch, SearchResponse, Elastic6Item } from '../../cores/';
-import { Elastic6Synchronizer, CoreManager, CoreService, SearchResult, ManagerProxy, AbstractProxy, Elastic6Instance } from '../abstract-service';
+import { OS2Item } from '../../cores/';
+import type { Client } from '@opensearch-project/opensearch';
+import { OS2Synchronizer, CoreManager, CoreService, SearchResult, ManagerProxy, AbstractProxy, AbstractOS2Instance, OS2ConstructParams } from '../abstract-service';
+export { sourceToItem } from '../abstract-service';
 import { Incrementable, CoreModel, SearchBody, SearchQuery, NextContext, NextIdentity, SortTerm, SimpleSet, GeneralItem } from 'lemon-model';
 import { BulkItemsResult, IdentityToken, ListResult, PaginateParam } from './types';
 import { CrendentialForAWS } from '../../environ';
+import { ModelClass } from '../../cores/storage/model-fields';
 export type SearchParam<T> = T & {
     [key: string]: string | number;
 };
@@ -87,22 +90,21 @@ export declare abstract class MyCoreService<Model extends CoreModel<ModelType>,
     abstract createProxy(context: NextContext): Proxy;
     /**
      * make proxy, and use callback to handle.
-     * - it will save automatically.
+     * - it will save automatically on success.
+     * - v5: on exception it saves only when `options.saveOnError` is true (default false, B5 § 6.7).
      */
-    guardProxy: <T>(context: NextContext, callback: (proxy: Proxy) => Promise<T>) => Promise<T>;
+    guardProxy: <T>(context: NextContext, callback: (proxy: Proxy) => Promise<T>, options?: {
+        saveOnError?: boolean;
+    }) => Promise<T>;
     /**
-     * run search
-     * - override this to hide `$ES6`
+     * run search (via `$OS2`)
+     * - override this to hide `$OS2`
      */
     doSearch<T>(body: SearchBody): Promise<SearchResult<T>>;
     /**
      * check if using useSession from environ.
      */
     isUseSession(): boolean;
-    /**
-     * @deprecated typo kept for 1 minor as a non-breaking alias — use `isUseSession()` instead. (cores-migration P1, decision #2)
-     */
-    isUseSssion(): boolean;
     /**
      * check if search-engine is supportable
      * @returns
@@ -117,7 +119,7 @@ export declare abstract class MyCoreService<Model extends CoreModel<ModelType>,
  */
 export declare abstract class MyCoreManager<Model extends CoreModel<ModelType>, ModelType extends string, Service extends MyCoreService<Model, ModelType, any>> extends CoreManager<Model, ModelType, Service> {
     readonly options?: {
-        /** enable to sync with es6 (default true) */
+        /** enable to sync with the search engine (v5 default false — B5 § 6.7) */
         enableSync?: boolean;
         /** unique field */
         uniqueField?: string;
@@ -132,8 +134,8 @@ export declare abstract class MyCoreManager<Model extends CoreModel<ModelType>,
      * constructor
      * @protected
      */
-    protected constructor(type: ModelType, parent: Service, fields: string[], options?: {
-        /** enable to sync with es6 (default true) */
+    protected constructor(type: ModelType, parent: Service, fields: string[] | ModelClass, options?: {
+        /** enable to sync with the search engine (v5 default false — B5 § 6.7) */
         enableSync?: boolean;
         /** unique field */
         uniqueField?: string;
@@ -356,7 +358,7 @@ export declare class MyCoreProxy<U extends string, MyService extends MyCoreServi
     }): boolean;
     /**
      * check if current context has `admin` access
-     * 1. run in local environ (or internal protocol with domin='localhost')
+     * 1. run in local mode (`$U.isLocalMode()`, v5 — no longer `domain='localhost'`)
      * 2. access via signed access-key
      * 3. authorized cognito and has `admin` role in identity-token.
      *
@@ -525,10 +527,6 @@ interface ElasticParams<T extends object = any> {
      * body content.
      */
     body: T;
-    /**
-     * document type (optional).
-     */
-    type?: string;
 }
 /**
  * parameters for Elasticsearch search operations.
@@ -544,47 +542,27 @@ interface ElasticSearchParams<T extends object = any> {
      * search body content.
      */
     body: T;
-    /**
-     * document type (optional).
-     */
-    type?: string;
     /**
      * search type
      * (e.g., 'query_then_fetch', 'dfs_query_then_fetch').
      */
-    searchType: SearchType;
+    search_type?: SearchType;
 }
 /**
  * class: `OS2Service`
  * - Master 권한 전용 Elasticsearch 관리 서비스
- * - elasticsearch service for OS2.
+ * - service for OS2: data path via FGAC (`$fgac`), index management via the master client.
  */
-export declare class OS2Service<T extends Elastic6Item = any> extends Elastic6Service<any> {
-    protected _options: Elastic6Option;
-    readonly _client: elasticsearch.Client;
+export declare class OS2Service<T extends OS2Item = any> extends OS2CoreService<any> {
     readonly $fgac: OS2FGACManager;
-    static instance(endpoint: string): {
-        client: elasticsearch.Client;
-    };
-    constructor(options: Elastic6Option, fgac: OS2FGACManager);
-    get client(): elasticsearch.Client;
-    get options(): Elastic6Option;
     /**
-     * describe `settings` and `mappings` of index.
+     * constructor (no client here; the master client is created on first `client` access)
      */
-    describe(): Promise<{
-        settings: any;
-        mappings: any;
-    }>;
+    constructor(options: OS2BaseOption, fgac: OS2FGACManager);
     /**
-     * create index by name
-     * @param settings - creating settings
+     * build the master client: `auth` is read from config now (after engine init), and set only when both exist.
      */
-    createIndex(settings?: any): Promise<{
-        status: any;
-        index: string;
-        acknowledged: any;
-    }>;
+    protected createClient(): Client;
     /**
      * delete index by name
      */
@@ -606,12 +584,11 @@ export declare class OS2Service<T extends Elastic6Item = any> extends Elastic6Se
         idName?: string;
     }): Promise<BulkItemsResult>;
     /**
-     * push item for time-series data.
+     * push item for time-series data (via FGAC; the result is the response body itself).
      *
      * @param item - item to push
-     * @param type - document type (default: doc-type given at construction time)
      */
-    pushItem(item: T, type?: string): Promise<T>;
+    pushItem(item: T): Promise<T>;
     /**
      * read item with projections
      *
@@ -647,13 +624,6 @@ export declare class OS2Service<T extends Elastic6Item = any> extends Elastic6Se
      * @param searchType - type of search (e.g., 'query_then_fetch', 'dfs_query_then_fetch').
      */
     searchRaw<T extends object = any>(body: SearchBody, searchType?: SearchType): Promise<T>;
-    /**
-     * run search, and get the formatmted response.
-     * @param body - Elasticsearch Query DSL that defines the search request (e.g., size, query, filters).
-     * @param searchType - type of search (e.g., 'query_then_fetch', 'dfs_query_then_fetch').
-     *
-     */
-    search(body: SearchBody, searchType?: SearchType): Promise<SearchResponse>;
 }
 /**
  * type: `OS2FGACManager`
@@ -661,8 +631,8 @@ export declare class OS2Service<T extends Elastic6Item = any> extends Elastic6Se
  */
 export declare class OS2FGACManager {
     private _fgacProxy;
-    readonly options: Elastic6Option;
-    constructor(options: Elastic6Option);
+    readonly options: OS2BaseOption;
+    constructor(options: OS2BaseOption);
     hello: () => string;
     get proxy(): ApiHttpProxy;
     /** FGAC 기반 검색 */
@@ -714,7 +684,7 @@ export declare class OS2FGACManager {
     doFgacOpenIndex<R = any>(index: string): Promise<R>;
 }
 /** extended option for `OS2Instance` */
-export interface OS2Option extends Elastic6Option {
+export interface OS2Option extends OS2BaseOption {
     /** (optional) role-name in FGAC */
     roleName?: string;
     /** (optional) user-name in FGAC */
@@ -723,35 +693,27 @@ export interface OS2Option extends Elastic6Option {
 /**
  * OS2 인스턴스
  * - describeIndex(), destroyIndex(), search() with elastic initialized by master-key
+ * - one service set (fgac, elastic, query, synchronizer) only when `endpoint && indexName`.
  */
-export declare class OS2Instance extends Elastic6Instance {
-    readonly client?: elasticsearch.Client;
+export declare class OS2Instance extends AbstractOS2Instance {
     readonly elastic?: OS2Service;
-    readonly query?: Elastic6QueryService<any>;
-    readonly synchronizer?: Elastic6Synchronizer;
+    readonly query?: OS2QueryService<any>;
+    readonly synchronizer?: OS2Synchronizer;
     readonly fgac?: OS2FGACManager;
-    constructor({ endpoint, indexName, idName, esVersion, esDocType, tableName, autocompleteFields, roleName, userName, }: {
-        endpoint: string;
-        indexName: string;
+    /**
+     * build one service set when `endpoint && indexName` (no client: it is created on first use).
+     */
+    constructor({ endpoint, indexName, idName, tableName, autocompleteFields, roleName, userName, }: OS2ConstructParams & {
+        /** (optional) id-name (default `$id`, `null` = unset) */
         idName?: string;
-        esVersion: string;
-        esDocType: string;
-        tableName: string;
-        autocompleteFields: string[];
+        /** (optional) role-name in FGAC */
         roleName?: string;
+        /** (optional) user-name in FGAC */
         userName?: string;
     });
     hello: () => string;
     get options(): OS2Option;
     get $X2(): typeof $X2;
-    /**
-     * display index settings and mappings
-     */
-    describeIndex(): Promise<any>;
-    /**
-     * create Elasticsearch index with ES7+ mapping structure
-     */
-    createIndex(): Promise<any>;
     /**
      * search
      */
@@ -773,7 +735,6 @@ export declare class OS2Instance extends Elastic6Instance {
         idName?: string;
     }): Promise<BulkItemsResult>;
 }
-export declare function sourceToItem<T>(_source: T, idName?: string): T;
 /**
  * internal tools
  */
@@ -795,16 +756,16 @@ declare const $X2: {
 };
 /**
  * factory of `OS2Instance`
+ * - reads `OS2_ENDPOINT`, `OS2_INDEX`, `MY_DYNAMO_TABLE`, `OS2_AUTOCOMPLETE_FIELDS` (no version, no doc-type).
  */
 export declare const _OS2: (options?: OS2Option) => OS2Instance;
+/**
+ * the default `OS2Instance`, built lazily by `_OS2()` on first access (S-25).
+ * - nothing is built at import: no client, no dynamo-stream listener.
+ * - without `OS2_ENDPOINT` it is an `OS2Instance` with `options === null`.
+ */
 export declare const $OS2: OS2Instance;
-export declare const $ES6: Elastic6Instance;
 /**
- * explicit alias for the OS2-routing `$ES6` above (decision #3, cores-migration P1).
- * - kept as `$ES6` here for deep-import compatibility (`lemon-core/dist/extended/cores`).
- * - exported at root ONLY under this name: root `$ES6` stays pinned to the L1
- *   (non-OS2) `extended/abstract-service` version, so consumers must opt in by
- *   name instead of silently getting OS2-routing behavior via the root barrel.
+ * explicit alias of `$OS2` (the same object). The name is kept; the meaning is OS2.
  */
-export declare const $ES6Routed: Elastic6Instance;
-export {};
+export declare const $ES6Routed: OS2Instance;