lemon-core 4.3.0 → 5.0.1

package/dist/extended/abstract-service.js

@@ -32,11 +32,8 @@ var __importStar = (this && this.__importStar) || (function () {
         return result;
     };
 })();
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.$ES6 = exports._ES6 = exports.Elastic6Instance = exports.AbstractElastic6Instance = exports.Elastic6Synchronizer = exports.AbstractProxy = exports.ManagerProxy = exports.CoreManager = exports.CoreService = exports.filterFields = void 0;
+exports.AbstractOS2Instance = exports.OS2Synchronizer = exports.AbstractProxy = exports.ManagerProxy = exports.CoreManager = exports.CoreService = exports.filterFields = void 0;
 exports.asIdentityId = asIdentityId;
 exports.sourceToItem = sourceToItem;
 /**
@@ -47,12 +44,14 @@ exports.sourceToItem = sourceToItem;
  * @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.
@@ -61,9 +60,6 @@ const cores_1 = __importStar(require("../cores/"));
 const engine_1 = require("../engine/");
 const test_helper_1 = require("../common/test-helper");
 const helpers_1 = require("../helpers");
-const sig_v4_1 = require("./libs/sig-v4");
-const request_1 = __importDefault(require("request"));
-const query_string_1 = __importDefault(require("query-string"));
 const NS = engine_1.$U.NS('back', 'blue'); // NAMESPACE TO BE PRINTED.
 /**
  * authentication helper - get identity-id from context
@@ -143,6 +139,7 @@ class CoreManager extends cores_1.AbstractManager {
      * constructor
      * @protected
      */
+    //* v5 B4: `fields` may be a model class (resolved in `AbstractManager`).
     constructor(type, parent, fields, uniqueField) {
         super(type, parent, fields, uniqueField);
     }
@@ -602,23 +599,19 @@ class AbstractProxy {
     context;
     /** (internal) backend-service */
     service;
-    /** (internal) cache service instance */
+    /** (internal) cache service instance (v5: no longer created from `CACHE_ENDPOINT`, so `undefined` unless a subclass sets it) */
     cache;
     /**
      * 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.
      */
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
     constructor(context, service, parrallel = 2, cacheScope) {
         this.context = context;
         this.service = service;
         this.parrallel = parrallel;
-        // create cache
-        const endpoint = engine_1.$U.env('CACHE_ENDPOINT', '');
-        if (cacheScope && endpoint.startsWith('redis:')) {
-            this.cache = cores_1.CacheService.create({ type: 'redis', endpoint, ns: cacheScope });
-        }
     }
     /**
      * say hello().
@@ -782,24 +775,13 @@ class AbstractProxy {
             throw new Error(`400 NOT ALLOWED - getCurrentIdentity(${identityId || ''})`);
         return identityId;
     }
-    /**
-     * get the current identity object (or throw access-error)
-     *
-     * @deprecated useless anymore since 3.2.10
-     */
-    async getCurrentIdentity$(throwable = true) {
-        const identityId = await this.getCurrentIdentityId(throwable);
-        if (!identityId && !throwable)
-            return null;
-        return this.getIdentity$(identityId);
-    }
 }
 exports.AbstractProxy = AbstractProxy;
 /**
- * class `Elastic6Synchronizer`
- * - listen DynamoDBStream events and index into Elasticsearch
+ * class `OS2Synchronizer`
+ * - listen DynamoDBStream events and index into OpenSearch
  */
-class Elastic6Synchronizer {
+class OS2Synchronizer {
     /**
      * model synchronizer map
      * @private
@@ -811,8 +793,8 @@ class Elastic6Synchronizer {
      */
     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, dynamoOptions) {
@@ -825,7 +807,7 @@ class Elastic6Synchronizer {
             idName: dynamoOptions?.idName || '_id', // id (global) of dynamo-table. should be `_id`.
         });
         //* create sync-handler w/ this.
-        const listener = cores_1.LambdaDynamoStreamHandler.createSyncToElastic6(options, elastic, this.filter.bind(this), this.onBeforeSync.bind(this), this.onAfterSync.bind(this));
+        const listener = cores_1.LambdaDynamoStreamHandler.createSyncToOS2(options, elastic, this.filter.bind(this), this.onBeforeSync.bind(this), this.onAfterSync.bind(this));
         cores_1.default.lambda.dynamos.addListener(listener); // register DynamoStream event listener
         //* prepare default synchro
         this.synchronizerMap = new Map();
@@ -874,51 +856,38 @@ class Elastic6Synchronizer {
             await handler.onAfterSync?.(id, eventName, item, diff, prev);
     };
 }
-exports.Elastic6Synchronizer = Elastic6Synchronizer;
+exports.OS2Synchronizer = OS2Synchronizer;
 /**
- * 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.
  */
-class AbstractElastic6Instance {
-    /**
-     * Elasticsearch client
-     */
-    client;
+class AbstractOS2Instance {
     /**
-     * Elastic6Service instance
+     * OS2CoreService instance
      */
     elastic;
     /**
-     * Elastic6QueryService instance
+     * OS2QueryService instance
      */
     query;
     /**
-     * Elastic6Synchronizer instance
+     * OS2Synchronizer instance
      */
     synchronizer;
     /**
-     * default constructor
-     */
-    constructor({ endpoint, indexName, esVersion, esDocType, tableName, autocompleteFields, }) {
-        // initialize Elasticsearch only if there are valid endpoint & index
-        if (endpoint && indexName) {
-            const options = {
-                endpoint,
-                indexName,
-                version: esVersion,
-                autocompleteFields,
-            };
-            if (esDocType)
-                options.docType = esDocType;
-            this.elastic = new cores_1.Elastic6Service(options);
-            this.client = this.elastic.client;
-            this.query = new cores_1.Elastic6QueryService(this.elastic);
-        }
-        // WARN `this.elastic` can be null!
-        this.synchronizer = new Elastic6Synchronizer(this.elastic, { tableName });
+     * default constructor (empty: no service, no client, no listener)
+     */
+    // eslint-disable-next-line @typescript-eslint/no-empty-function
+    constructor() { }
+    /**
+     * the OpenSearch client of `elastic` (created on first access).
+     */
+    get client() {
+        return this.elastic?.client;
     }
     /**
-     * read the current elastic6-option.
+     * read the current option.
      */
     get options() {
         if (!this.elastic)
@@ -926,34 +895,17 @@ class AbstractElastic6Instance {
         return this.elastic.options;
     }
     /**
-     * create Elasticsearch index w/ custom settings
+     * create the index w/ the default typeless settings (one implementation for every instance)
      */
     async createIndex() {
-        if (this.elastic) {
-            const { docType, idName } = this.options;
-            const settings = cores_1.Elastic6Service.prepareSettings({ docType, idName }); // default setting
-            const { version } = this.elastic.options;
-            // force set type of 'score_' field
-            const ver = engine_1.$U.F(version, 7.0);
-            const $set = { score_: { type: 'half_float' } };
-            if (ver < 7.0) {
-                settings.mappings[docType].properties = {
-                    ...(settings.mappings[docType]?.properties || {}),
-                    ...$set,
-                };
-            }
-            else {
-                settings.mappings.properties = {
-                    ...(settings.mappings?.properties || {}),
-                    ...$set,
-                };
-            }
-            return this.elastic.createIndex(settings);
-        }
-        return null;
+        if (!this.elastic)
+            return null;
+        const { idName } = this.options;
+        const settings = cores_1.OS2CoreService.prepareSettings({ idName });
+        return this.elastic.createIndex(settings);
     }
     /**
-     * destroy Elasticsearch index
+     * destroy the index
      */
     async destroyIndex() {
         return this.elastic && (await this.elastic.destroyIndex());
@@ -965,13 +917,12 @@ class AbstractElastic6Instance {
         return this.elastic && (await this.elastic.describe());
     }
     /**
-     * multi get
+     * multi get (typeless: index + docs only)
      * @param _ids  _id list
      */
     async mget(_ids) {
         const $res = await this.client.mget({
             index: this.options.indexName,
-            type: this.options.docType,
             body: {
                 docs: _ids.map(_id => ({ _id })),
             },
@@ -983,22 +934,22 @@ class AbstractElastic6Instance {
     }
     /**
      * 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
      */
     async search(body, params) {
         if (!this.elastic)
             throw new Error(`Could not read Elasticsearch endpoint or index setting.`);
         const searchType = params?.searchType;
         const elastic = params?.indexName
-            ? new cores_1.Elastic6Service({ ...this.options, indexName: params.indexName })
+            ? new cores_1.OS2CoreService({ ...this.options, indexName: params.indexName })
             : this.elastic;
         return elastic.search(body, searchType);
     }
     /**
      * 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
      */
     async *generateSearchResult(body, searchType) {
         if (!body.sort)
@@ -1010,57 +961,7 @@ class AbstractElastic6Instance {
         } while (body.search_after);
     }
 }
-exports.AbstractElastic6Instance = AbstractElastic6Instance;
-/**
- * class: `Elastic6Instance`
- * - default agent to handle search.
- */
-class Elastic6Instance extends AbstractElastic6Instance {
-    constructor(params) {
-        super(params);
-    }
-    hello() {
-        return `Elastic6Instance`;
-    }
-    /**
-     * expose the internal helpers. (ONLY for debugging)
-     */
-    get $X() {
-        return $X;
-    }
-}
-exports.Elastic6Instance = Elastic6Instance;
-/**
- * (internal) class: `Elastic6Proxy`
- * - proxied agent to handle `search()`
- */
-class Elastic6Proxy extends Elastic6Instance {
-    proxy;
-    constructor(params, proxy) {
-        super(params);
-        this.proxy = proxy;
-    }
-    hello() {
-        return `Elastic6Proxy`;
-    }
-    /**
-     * search raw query
-     *
-     * @override
-     */
-    async search(body, params) {
-        const _hmac = (s, delim = ':', prefix = 'v1') => [prefix, engine_1.$U.hmac(Array.isArray(s) ? s.join(delim) : s, 'base64')].join(delim);
-        //* use proxy if possible.
-        if (this.proxy) {
-            const service = (0, helpers_1.$info)()?.service;
-            const indexName = params?.indexName ?? this.options?.indexName ?? '';
-            const signature = params?.signature ?? _hmac([_hmac(service), indexName]);
-            const $body = { body, service, index: indexName, signature };
-            return this.proxy.doProxy('POST', null, null, params, $body);
-        }
-        return super.search(body, params);
-    }
-}
+exports.AbstractOS2Instance = AbstractOS2Instance;
 /**
  * from Elasticsearch document to model item
  * - replace the elastic's `$id` field to `_id` of dynamo-table.
@@ -1076,241 +977,4 @@ function sourceToItem(_source, idName = '$id') {
     }
     return item;
 }
-/**
- * internal helper function.
- */
-const $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, options) => {
-        const errScope = options?.errScope ?? `describeEndpointUrl()`;
-        const throwable = options?.throwable ?? true;
-        url = /^\/\/[a-z0-9]+/.test(url) ? `https:${url}` : url;
-        if (throwable) {
-            if (!url)
-                throw new Error(`@url(string) is required - ${errScope}`);
-            if (!(url?.startsWith('http://') || url?.startsWith('https://')))
-                throw new Error(`@url[${url ?? ''}] is invalid (no http) - ${errScope}`);
-        }
-        const $url = new URL(url);
-        const host = engine_1.$U.S($url.hostname || $url.host);
-        const isTunnel = $url.hostname === 'localhost';
-        const protocol = engine_1.$U.S($url.protocol).split(':')[0] ?? '';
-        const port = engine_1.$U.N($url.port, url?.startsWith('https') ? 443 : 80);
-        const hosts = host.split('.');
-        //* use `/search/0/proxy` working with deployed enpoint (requires access-key)
-        const isProxy = host.endsWith('.amazonaws.com') && hosts[hosts.length - 4] == 'execute-api';
-        const region = isProxy ? hosts[hosts.length - 3] : undefined;
-        return {
-            /** protocol */
-            protocol,
-            /** host name */
-            host,
-            /** port number */
-            port,
-            /** region in cloud */
-            region,
-            /** flag to use tunneling w/ ssh */
-            isTunnel,
-            /** flag to use proxy */
-            isProxy,
-        };
-    },
-    /**
-     * 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, options) => {
-        const name = options?.name ?? engine_1.$U.env('NAME');
-        const errScope = `createHttpSearchProxy(${name ?? ''})`;
-        if (!endpoint)
-            throw new Error(`@endpoint (url) is required - ${errScope}`);
-        const NS = engine_1.$U.NS(`X${name}`, 'magenta'); // NAMESPACE TO BE PRINTED.
-        const headers = options?.headers;
-        const encoder = options?.encoder ?? ((name, path) => path);
-        const relayHeaderKey = options?.relayHeaderKey || '';
-        const resultKey = options?.resultKey ?? '';
-        // initialize AWS SigV4 Client
-        const _client = () => {
-            if (!options?.credentials)
-                return null;
-            const $cred = options?.credentials;
-            const $info = $X.describeEndpointUrl(endpoint, { throwable: false });
-            const config = {
-                accessKey: $cred?.accessKeyId,
-                secretKey: $cred?.secretAccessKey,
-                serviceName: 'execute-api',
-                host: $info?.host,
-                region: options?.region ?? $info?.region,
-                endpoint,
-            };
-            return (0, sig_v4_1.sigV4Client)(config);
-        };
-        const sigClient = _client();
-        /**
-         * class: `ApiHttpProxy`
-         * - http proxy client via backbone's web.
-         */
-        return new (class {
-            // eslint-disable-next-line @typescript-eslint/no-empty-function
-            constructor() { }
-            hello = () => `http-search-proxy:${name}`;
-            doProxy(method, path1, path2, $param, $body, ctx) {
-                if (!method)
-                    throw new Error(`@method is required - ${errScope}`);
-                (0, engine_1._log)(NS, `doProxy(${method})..`);
-                const _isNa = (a) => a === undefined || a === null;
-                (0, engine_1._log)(NS, '> endpoint =', endpoint);
-                _isNa(path1) && (0, engine_1._log)(NS, `> host(id) =`, typeof path1, path1);
-                _isNa(path2) && (0, engine_1._log)(NS, `> path(cmd) =`, typeof path2, path2);
-                // eslint-disable-next-line prettier/prettier
-                const query_string = _isNa($param) ? '' : (typeof $param == 'object' ? query_string_1.default.stringify($param) : `${$param}`);
-                const url = endpoint +
-                    (_isNa(path1) ? '' : `/${encoder('host', path1)}`) +
-                    (_isNa(path1) && _isNa(path2) ? '' : `/${encoder('path', path2)}`) +
-                    (!query_string ? '' : '?' + query_string);
-                const request = request_1.default;
-                const options = {
-                    method,
-                    uri: url,
-                    headers: { ...headers },
-                    body: $body === null ? undefined : $body,
-                    json: typeof $body === 'string' ? false : true,
-                };
-                //* build signed url
-                if (sigClient) {
-                    const signedRequest = sigClient.signRequest({
-                        method,
-                        path: (_isNa(path1) ? '' : `/${encoder('host', path1)}`) +
-                            (_isNa(path1) && _isNa(path2) ? '' : `/${encoder('path', path2)}`),
-                        queryParams: $param,
-                        headers: options.headers,
-                        body: $body,
-                    });
-                    options.headers = { ...options.headers, ...signedRequest.headers };
-                    options.uri = signedRequest.url;
-                }
-                //* relay HEADERS to `WEB-API`
-                if (headers) {
-                    options.headers = Object.keys(headers).reduce((H, key) => {
-                        const val = headers[key];
-                        const name = `${relayHeaderKey}${key}`;
-                        const text = `${val ?? ''}`;
-                        H[name] = text;
-                        return H;
-                    }, options.headers);
-                }
-                (0, engine_1._log)(NS, ' url :=', options.method, url);
-                (0, engine_1._log)(NS, '*', options.method, url, options.json ? 'json' : 'plain');
-                (0, engine_1._log)(NS, '> options =', engine_1.$U.json(options));
-                //* returns promise
-                return new Promise((resolve, reject) => {
-                    //* start request..
-                    request(options, function (error, response, body) {
-                        error && (0, engine_1._err)(NS, '>>>>> requested! err=', error);
-                        if (error)
-                            return reject(error instanceof Error ? error : new Error((0, test_helper_1.GETERR)(error)));
-                        //* detect trouble.
-                        const statusCode = response.statusCode;
-                        const statusMessage = response.statusMessage;
-                        //* if not in success
-                        if (statusCode !== 200 && statusCode !== 201) {
-                            const msg = body ? (0, test_helper_1.GETERR)(body) : `${statusMessage || ''}`;
-                            if (statusCode === 400 || statusCode === 404) {
-                                const title = `${(statusCode == 404 ? '' : statusMessage) || 'NOT FOUND'}`.toUpperCase();
-                                const message = msg.startsWith('404 NOT FOUND')
-                                    ? msg
-                                    : `${statusCode} ${title} - ${msg}`;
-                                return reject(new Error(message));
-                            }
-                            statusMessage && (0, engine_1._log)(NS, `> statusMessage[${statusCode}] =`, statusMessage);
-                            body && (0, engine_1._log)(NS, `> body[${statusCode}] =`, engine_1.$U.json(body));
-                            return reject(new Error(`${statusCode} ${statusMessage || 'FAILURE'} - ${msg}`));
-                        }
-                        //* try to parse body.
-                        try {
-                            if (body && typeof body == 'string' && body.startsWith('{') && body.endsWith('}')) {
-                                body = JSON.parse(body);
-                            }
-                            else if (body && typeof body == 'string' && body.startsWith('[') && body.endsWith(']')) {
-                                body = JSON.parse(body);
-                            }
-                        }
-                        catch (e) {
-                            (0, engine_1._err)(NS, '!WARN! parse(body) =', e instanceof Error ? e : engine_1.$U.json(e));
-                        }
-                        //* ok! succeeded.
-                        resolve(body);
-                    });
-                }).then((res) => {
-                    if (resultKey && res && res[resultKey] !== undefined)
-                        return res[resultKey];
-                    return res;
-                });
-            }
-        })();
-    },
-};
-/**
- * (internal) factory function for `$ES6`
- *
- * @param options (optional) for debugging
- */
-const _ES6 = (options) => {
-    // 0. load from env configuration.
-    const endpoint = options?.endpoint ?? engine_1.$U.env('ES6_ENDPOINT', '');
-    const indexName = options?.indexName ?? engine_1.$U.env('ES6_INDEX', 'test-v1');
-    const esVersion = engine_1.$U.env('ES6_VERSION', '6.8'); //* version of elastic server (default 6.8)
-    const esDocType = engine_1.$U.env('ES6_DOCTYPE', ''); //* version of elastic server (default `_doc`)
-    const tableName = engine_1.$U.env('MY_DYNAMO_TABLE', 'Test');
-    const autocompleteFields = helpers_1.$T.SS(engine_1.$U.env('ES6_AUTOCOMPLETE_FIELDS', ''));
-    // use search-proxy by detectiong automatically.
-    const _isProxy = () => {
-        const isProxy = engine_1.$U.env('ES6_IS_PROXY', '')?.toLowerCase();
-        if (isProxy == '1' || isProxy == 'y' || isProxy == 'true')
-            return true;
-        if (endpoint) {
-            const $res = $X.describeEndpointUrl(endpoint, { throwable: false });
-            if ($res?.isProxy)
-                return true;
-        }
-        return false;
-    };
-    const useProxy = options?.useProxy ?? _isProxy();
-    // prepare constructor parameters.
-    const params = {
-        endpoint,
-        indexName,
-        esVersion,
-        esDocType,
-        tableName,
-        autocompleteFields,
-    };
-    //* use proxy.
-    if (useProxy) {
-        const credentials = options?.credentials;
-        const proxy = $X.createHttpSearchProxy(endpoint, { credentials });
-        return new Elastic6Proxy(params, proxy);
-    }
-    //* make a default instance.
-    return new Elastic6Instance(params);
-};
-exports._ES6 = _ES6;
-/**
- * const `$ES6`
- * - default instance as a singleton by env configuration.
- */
-exports.$ES6 = (0, exports._ES6)();
 //# sourceMappingURL=abstract-service.js.map