lemon-core 4.2.7 → 5.0.0

package/dist/extended/abstract-service.d.ts

@@ -6,19 +6,21 @@
  * @date        2021-02-23 initial version
  * @author      Steve <steve@lemoncloud.io>
  * @date        2022-02-18 optimized search w/ ES6.8
- * @date        2022-02-22 optimized w/ `lemon-core#3.0` and `@elastic/elasticsearch`
+ * @date        2022-02-22 optimized w/ `lemon-core#3.0` and the elastic client
  * @date        2022-02-24 use `$id` in elastic-search as `_id` in dynamo-table.
  * @date        2022-03-15 optimized w/ `AbstractProxy`
  * @date        2022-03-17 optimized w/ `lemon-core#3.0.2` and use `env.ES6_DOCTYPE`
  * @date        2022-03-31 optimized w/ unit test spec.
  * @date        2022-05-19 optimized `CacheService` w/ typed key.
+ * @date        2026-10-27 v5 B2-b: `OS2Synchronizer`/`AbstractOS2Instance`; the L1 search instance, its factory and proxy are removed.
+ * @date        2026-10-28 v5 B4: `CoreManager` `fields` may be a model class.
  *
  * @origin      see `lemon-accounts-api/src/service/core-service.ts`
  * @copyright   (C) 2021 LemonCloud Co Ltd. - All Rights Reserved.
  */
-import { AbstractManager, APIHeaders, ApiHttpProxy, CacheService, CoreModel, CoreModelFilterable, DynamoOption, DynamoStreamEvent, Elastic6Option, Elastic6QueryService, Elastic6Service, GeneralKeyMaker, NextContext, NextIdentityAccess, SearchBody, StorageMakeable, TypedStorageService } from '../cores/';
-import { CrendentialForAWS } from '../environ';
-import elasticsearch from '@elastic/elasticsearch';
+import { AbstractManager, CacheService, CoreModel, CoreModelFilterable, DynamoOption, DynamoStreamEvent, OS2BaseOption, OS2QueryService, OS2CoreService, GeneralKeyMaker, NextContext, NextIdentityAccess, SearchBody, StorageMakeable, TypedStorageService } from '../cores/';
+import { ModelClass } from '../cores/storage/model-fields';
+import type { Client } from '@opensearch-project/opensearch';
 /**
  * authentication helper - get identity-id from context
  * @param context the current request context.
@@ -102,7 +104,7 @@ export declare abstract class CoreManager<Model extends CoreModel<ModelType>, Mo
      * constructor
      * @protected
      */
-    protected constructor(type: ModelType, parent: Service, fields: string[], uniqueField?: string);
+    protected constructor(type: ModelType, parent: Service, fields: string[] | ModelClass, uniqueField?: string);
     /**
      * say hello()
      */
@@ -291,13 +293,13 @@ export declare abstract class AbstractProxy<U extends string, T extends CoreServ
     readonly context: NextContext;
     /** (internal) backend-service */
     readonly service: T;
-    /** (internal) cache service instance */
+    /** (internal) cache service instance (v5: no longer created from `CACHE_ENDPOINT`, so `undefined` unless a subclass sets it) */
     readonly cache?: CacheService;
     /**
      * constructor of proxy.
      * @param service user service instance
      * @param parrallel parrallel count (default 2)
-     * @param cacheScope prefix of cache-key (like `lemon:SS:` or `lemon:SS:user`)
+     * @param cacheScope prefix of cache-key (like `lemon:SS:` or `lemon:SS:user`). v5: kept for signature compat, unused.
      */
     constructor(context: NextContext, service: T, parrallel?: number, cacheScope?: string);
     /**
@@ -369,12 +371,6 @@ export declare abstract class AbstractProxy<U extends string, T extends CoreServ
      * get current identity-id
      */
     getCurrentIdentityId(throwable?: boolean): Promise<string>;
-    /**
-     * get the current identity object (or throw access-error)
-     *
-     * @deprecated useless anymore since 3.2.10
-     */
-    getCurrentIdentity$(throwable?: boolean): Promise<NextIdentityAccess>;
 }
 /**
  * type `SearchResult`
@@ -398,10 +394,10 @@ export interface SearchResult<T, U = any> {
     aggregations?: U;
 }
 /**
- * class `Elastic6Synchronizer`
- * - listen DynamoDBStream events and index into Elasticsearch
+ * class `OS2Synchronizer`
+ * - listen DynamoDBStream events and index into OpenSearch
  */
-export declare class Elastic6Synchronizer {
+export declare class OS2Synchronizer {
     /**
      * model synchronizer map
      * @private
@@ -413,11 +409,11 @@ export declare class Elastic6Synchronizer {
      */
     private readonly defModelSynchronizer;
     /**
-     * constructor
-     * @param elastic       (optional) elastic6-service instance
+     * constructor (registers one dynamo-stream listener)
+     * @param elastic       (optional) OS2CoreService instance
      * @param dynamoOptions (optional) dynamo config options
      */
-    constructor(elastic?: Elastic6Service, dynamoOptions?: DynamoOption | {
+    constructor(elastic?: OS2CoreService, dynamoOptions?: DynamoOption | {
         tableName: string;
     });
     /**
@@ -443,71 +439,68 @@ export declare class Elastic6Synchronizer {
     private onAfterSync;
 }
 /**
- * type: `Elastic6ContructParams`
- * - params for `new Elastic6Instance()`
+ * type: `OS2ConstructParams`
+ * - params for `new OS2Instance()` (v5: no engine version, no doc-type)
  */
-export interface Elastic6ContructParams {
+export interface OS2ConstructParams {
     /** url endpoint */
     endpoint: string;
     /** name of index */
     indexName: string;
-    /** ES engine version(6.2 ~ 7.x) */
-    esVersion: string;
-    /** doc-type (only valid under 6.2) */
-    esDocType: string;
     /** dynamo table-name to synchronize */
     tableName: string;
     /** (optional) field to make auto-complele */
     autocompleteFields?: string[];
 }
 /**
- * type: `Elastic6SearchParams`
+ * type: `OS2SearchParams`
  */
-export interface Elastic6SearchParams {
+export interface OS2SearchParams {
     /** index-name */
     indexName?: string;
-    /** search-type */
+    /** search-type (sent as `search_type`) */
     searchType?: 'query_then_fetch' | 'dfs_query_then_fetch';
     /** (optional) signature to check the request */
     signature?: string;
 }
 /**
- * class `AbstractElastic6Instance`
- * - to manipulate the shared Elasticsearch resources.
+ * class `AbstractOS2Instance`
+ * - to manipulate the shared OpenSearch resources.
+ * - the constructor builds nothing; the subclass (`OS2Instance`) builds one service set.
  */
-export declare abstract class AbstractElastic6Instance {
+export declare abstract class AbstractOS2Instance {
     /**
-     * Elasticsearch client
+     * OS2CoreService instance
      */
-    readonly client?: elasticsearch.Client;
+    readonly elastic?: OS2CoreService;
     /**
-     * Elastic6Service instance
+     * OS2QueryService instance
      */
-    readonly elastic?: Elastic6Service;
+    readonly query?: OS2QueryService<any>;
     /**
-     * Elastic6QueryService instance
+     * OS2Synchronizer instance
      */
-    readonly query?: Elastic6QueryService<any>;
+    readonly synchronizer?: OS2Synchronizer;
     /**
-     * Elastic6Synchronizer instance
+     * default constructor (empty: no service, no client, no listener)
      */
-    readonly synchronizer?: Elastic6Synchronizer;
-    /**
-     * default constructor
-     */
-    constructor({ endpoint, indexName, esVersion, esDocType, tableName, autocompleteFields, }: Elastic6ContructParams);
+    constructor();
     /** say hello */
     abstract hello(): string;
     /**
-     * read the current elastic6-option.
+     * the OpenSearch client of `elastic` (created on first access).
      */
-    get options(): Elastic6Option;
+    get client(): Client;
     /**
-     * create Elasticsearch index w/ custom settings
+     * read the current option.
+     */
+    get options(): OS2BaseOption;
+    /**
+     * create the index w/ the default typeless settings (one implementation for every instance)
      */
     createIndex(): Promise<any>;
     /**
-     * destroy Elasticsearch index
+     * destroy the index
      */
     destroyIndex(): Promise<any>;
     /**
@@ -515,87 +508,23 @@ export declare abstract class AbstractElastic6Instance {
      */
     describeIndex(): Promise<any>;
     /**
-     * multi get
+     * multi get (typeless: index + docs only)
      * @param _ids  _id list
      */
     mget<T>(_ids: string[]): Promise<(T | null)[]>;
     /**
      * search raw query
-     * @param body          Elasticsearch Query DSL
-     * @param params        see 'search_type' in Elasticsearch documentation
+     * @param body          OpenSearch Query DSL
+     * @param params        see 'search_type' in OpenSearch documentation
      */
-    search<T>(body: any, params?: Elastic6SearchParams): Promise<SearchResult<T>>;
+    search<T>(body: any, params?: OS2SearchParams): Promise<SearchResult<T>>;
     /**
      * create async generator that yields items queried until last
-     * @param body          Elasticsearch Query DSL
-     * @param searchType    see 'search_type' in Elasticsearch documentation
+     * @param body          OpenSearch Query DSL
+     * @param searchType    see 'search_type' in OpenSearch documentation
      */
     generateSearchResult<T>(body: any, searchType?: 'query_then_fetch' | 'dfs_query_then_fetch'): AsyncGenerator<T[], void, unknown>;
 }
-/**
- * class: `Elastic6Instance`
- * - default agent to handle search.
- */
-export declare class Elastic6Instance extends AbstractElastic6Instance {
-    constructor(params: Elastic6ContructParams);
-    hello(): string;
-    /**
-     * expose the internal helpers. (ONLY for debugging)
-     */
-    get $X(): {
-        /**
-         * describe (or parse) the endpoint url
-         * - it detects if endpoint is the proxied search.
-         * - it detects if endpoint needs the tunneling.
-         *
-         * @param url
-         */
-        describeEndpointUrl: (url: string, options?: {
-            throwable?: boolean;
-            errScope?: string;
-        }) => {
-            /** protocol */
-            protocol: string;
-            /** host name */
-            host: string;
-            /** port number */
-            port: number;
-            /** region in cloud */
-            region: string;
-            /** flag to use tunneling w/ ssh */
-            isTunnel: boolean;
-            /** flag to use proxy */
-            isProxy: boolean;
-        };
-        /**
-         * create http-web-proxy agent which using endpoint as proxy server.
-         * - originally refer to `createHttpWebProxy()`
-         *
-         * # as cases.
-         * as proxy agent: GET <endpoint>/<host?>/<path?>
-         * as direct agent: GET <endpoint>/<id?>/<cmd?>
-         *
-         * @param endpoint  service url (ex: `https://xyz.execute-api.~/dev/search/0/proxy`)
-         * @param options   optionals parameters.
-         */
-        createHttpSearchProxy: (endpoint: string, options?: {
-            /** client-name (default `env.NAME`) */
-            name?: string;
-            /** headers */
-            headers?: APIHeaders;
-            /** path encoder (default encodeURIComponent) */
-            encoder?: (name: string, path: string) => string;
-            /** relay-key in headers for proxy. */
-            relayHeaderKey?: string;
-            /** resultKey in response */
-            resultKey?: string;
-            /** credentials to load */
-            credentials?: CrendentialForAWS;
-            /** region */
-            region?: string;
-        }) => ApiHttpProxy;
-    };
-}
 /**
  * from Elasticsearch document to model item
  * - replace the elastic's `$id` field to `_id` of dynamo-table.
@@ -613,28 +542,8 @@ export interface SearchProxyBody {
     body: SearchBody;
     /** service-name of request (ex: `lemon-sandbox-api`) */
     service?: string;
-    /** index name to search via proxy (must be same as `env.ES6_INDEX`) */
+    /** index name to search via proxy (must be same as `env.OS2_INDEX`) */
     index?: string;
     /** (optional) signature to validate this request. */
     signature?: string;
 }
-/**
- * (internal) factory function for `$ES6`
- *
- * @param options (optional) for debugging
- */
-export declare const _ES6: (options?: {
-    /** endpoint url */
-    endpoint?: string;
-    /** index-name */
-    indexName?: string;
-    /** flag to use search-proxy */
-    useProxy?: boolean;
-    /** (optional) aws:credentials to sign request in proxy */
-    credentials?: CrendentialForAWS;
-}) => Elastic6Instance;
-/**
- * const `$ES6`
- * - default instance as a singleton by env configuration.
- */
-export declare const $ES6: Elastic6Instance;