lemon-core 4.2.6 → 4.3.0

package/dist/extended/cores/types.d.ts

@@ -0,0 +1,236 @@
+/**
+ * `types.ts`
+ * - common types used in `/cores`
+ *
+ * @author      Steve <steve@lemoncloud.io>
+ * @date        2022-06-21 optimized w/ `abstract-services`
+ * @date        2022-06-28 added `Codable` interface for general types.
+ * @date        2023-01-18 optimized with `lemon-core@3.2.4`
+ * @date        2023-02-15 optimized with `lemon-core@3.2.5`
+ * @date        2024-11-14 optimized `IdentityToken`.
+ *
+ * @copyright   (C) 2022 LemonCloud Co Ltd. - All Rights Reserved.
+ * @origin      `@lemoncloud/lemon-templates-api/cores`
+ */
+import { NextIdentity, CoreModel, View, Body } from 'lemon-model';
+export type { CoreModel, View, Body };
+/** type: `IdentityTokenSite` */
+export interface IdentityTokenSite {
+    /** site-code (ex: kwonsun) */
+    code?: string;
+    /** name of site (ex: 권선) */
+    name?: string;
+}
+/** type: `IdentityTokenUser` */
+export interface IdentityTokenUser {
+    /** name of user (ex: 홍길동) */
+    name?: string;
+    /** nick of user (ex: 홍사마) */
+    nick?: string;
+    /** (optional) login-id of user */
+    login?: string;
+    /** (optional) email of user */
+    email?: string;
+}
+/** type: `IdentityTokenGroup` */
+export interface IdentityTokenGroup {
+    /** site-code (ex: kwonsun) */
+    code?: string;
+    /** name of site (ex: 권선) */
+    name?: string;
+}
+/**
+ * type: `IdentityToken` (named as `session`)
+ * - 계정토큰(= JWT(IdentityToken))으로, `/refresh`시 AWS Key와 함께 발급됨 (기본, 1일동안 유효함)
+ * - `backend-api`에서 조직/그룹/사용자에 맞게 재설정됨!
+ * - 세션토큰 검사는 `proxy.getCurrentSession()` 이용하기
+ */
+export interface IdentityToken<T = any, U extends IdentityTokenUser = IdentityTokenUser, S extends IdentityTokenSite = IdentityTokenSite, G extends IdentityTokenGroup = IdentityTokenGroup> extends NextIdentity<T> {
+    /**
+     * cloud-id (= id in `AWS ACCOUNT_NO`)
+     * - `#` 일경우, 무시됨.
+     * - aws 계정 수준의 cloud-id
+     */
+    cid: string;
+    /**
+     * site-id (= id in `SiteModel(사이트)`)
+     * - `#` 일경우, 특정 site에 엮이지 않음 (무시됨)
+     * - `0000` 일경우, 기본 site 정보로 환경설정에 따름
+     * - 메인 `backend-api` (see `.iss`)에서 관리되는 `site-model`의 id
+     *
+     * @see SiteModel
+     */
+    sid: string;
+    /**
+     * group-id (= id in `GroupModel(그룹)`)
+     * - `group`은 `user`를 물리적 구분으로 나눠서 생각해볼때 이용가능함.
+     *
+     * @see GroupModel
+     */
+    gid: string;
+    /**
+     * user-id (= id in `UserModel(유저)`)
+     * - 메인 `backend-api` (see `.iss`)에서 관리되는 `user-model`의 id.
+     *
+     * @see UserModel
+     */
+    uid: string;
+    /**
+     * auth-id (= id in `AuthModel(인정정보)`)
+     * - 메인 `backend-api` (see `.iss`)에서 관리되는 `auth-model`의 id.
+     * - 인증 정보를 통해서, 로그인의 추가 상세 정보를 알 수 있음.
+     *
+     * @see AuthModel
+     */
+    aid: string;
+    /**
+     * (optional) delegator-id (= 위임된 게스트 User ID)
+     * - **중계서버(`backend-api`)에서만 유효한 필드.** 다른 시스템(socials 등)은 이 필드를 신뢰하지 말 것.
+     * - 소셜 로그인 세션에서 원본 디바이스 게스트 User ID를 가리킴 (= `AuthModel.linkUserId`).
+     * - 채팅(개인 채팅방) 도메인은 본 신원이 아닌 `did`를 채택하여 게스트의 데이터를 그대로 이용함.
+     * - 게스트 세션이거나 위임이 없을 때는 `undefined`.
+     */
+    did?: string;
+    /**
+     * list of roles  (like `user`, `admin`, `super`)
+     */
+    roles: string[];
+    /**
+     * (optional) internal `identity-id` (= delegated identity)
+     * - `.identityId` 는 aws cognito 인증을 통해서, 현재 인증된 `identity-id`를 알 수 있음
+     * - 다만, `delegated`된 경우에는 위임된 id 가 들어감.
+     *
+     * @deprecated 삭제될 예정! @241114
+     */
+    iid?: string;
+    /**
+     * service-name of issuer
+     * ex) `lemon-backend-api`
+     */
+    iss?: string;
+    /** Site Info */
+    Site: S;
+    /** User Info */
+    User: U;
+    /** (optional) Group Info */
+    Group?: G;
+}
+/**
+ * type `ListResult`
+ */
+export interface ListResult<T, R = any> {
+    /**
+     * total searched count
+     */
+    total?: number;
+    /**
+     * max items count in the page
+     */
+    limit?: number;
+    /**
+     * current page number.
+     */
+    page?: number;
+    /**
+     * (optional) time took in sec
+     */
+    took?: number;
+    /**
+     * items searched
+     */
+    list: T[];
+    /**
+     * (optional) aggr list
+     */
+    aggr?: R | R[];
+}
+export interface AggrResult {
+    [key: string]: {
+        [key: string]: number;
+    };
+}
+export interface AggrKeyCount {
+    /** name of key(or bucket name) */
+    key: string;
+    /** number of count */
+    val: number;
+}
+/**
+ * type `PaginatedListResult`
+ */
+export interface PaginatedListResult<T, R = string> extends ListResult<T, R> {
+    /**
+     * current page
+     */
+    page: number;
+}
+/**
+ * type `ListParam`
+ */
+export interface ListParam {
+    /**
+     * max items count to be fetched
+     */
+    limit?: number;
+    /**
+     * (optional) sorting order
+     *  - 'asc': older first
+     *  - 'desc': newer first
+     *  - string: extended sorting features
+     */
+    sort?: 'asc' | 'desc' | string;
+}
+/**
+ * type `PaginateParam`
+ */
+export interface PaginateParam extends ListParam {
+    /**
+     * page # to fetch (0-indexed)
+     */
+    page?: number;
+    /**
+     * (optional) offset # from start.
+     */
+    offset?: number;
+    /**
+     * (optional) flag to filter by uid
+     */
+    uid?: string;
+    /**
+     * (optional) flag to filter by sid (only for admin role)
+     */
+    sid?: string;
+}
+/**
+ * type `BulkUpdateBody`
+ */
+export interface BulkUpdateBody<T> extends BulkBody<T> {
+    /**
+     * list bulk update model with id
+     */
+    list: T[];
+}
+/**
+ * body data for bulk
+ */
+export interface BulkBody<T> {
+    list: T[];
+}
+/**
+ * list of the selected model-id
+ */
+export interface BodyList<T extends {
+    id: string;
+} = {
+    id: string;
+}> {
+    list: T[];
+}
+/**
+ * type `BulkItemsResult`
+ */
+export interface BulkItemsResult {
+    success: number;
+    failed: number;
+    failedItems: any[];
+}

package/dist/extended/cores/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/extended/cores/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/extended/cores/types.ts"],"names":[],"mappings":""}

package/dist/generated/field-registry.d.ts

@@ -1,10 +1,12 @@
 export declare const fieldKeys: {
+    readonly coreModel: <T extends object>() => Array<Extract<keyof T, string>>;
+    readonly myTestModel: <T extends object>() => Array<Extract<keyof T, string>>;
     readonly testModel: <T extends object>() => Array<Extract<keyof T, string>>;
 };
 export declare const fieldRegistryMeta: {
     readonly kind: "concrete";
     readonly schemaVersion: 1;
-    readonly entryCount: 1;
-    readonly checksum: "175c2e4da9bda595";
+    readonly entryCount: 3;
+    readonly checksum: "f00dc1d624f9c0a3";
     readonly generatedBy: "lemon-fields";
 };

package/dist/generated/field-registry.js

@@ -4,14 +4,18 @@ exports.fieldRegistryMeta = exports.fieldKeys = void 0;
 // AUTO-GENERATED by lemon-devkit `lemon-fields` — do not edit manually.
 // Regenerate: lemon-fields gen
 exports.fieldKeys = {
+    // source: src/extended/cores/abstract-services.ts#CoreModel
+    coreModel: () => ["$", "ns", "type", "stereo", "sid", "uid", "gid", "lock", "next", "meta", "createdAt", "updatedAt", "deletedAt", "error", "id", "_id"],
+    // source: src/extended/cores/abstract-services.spec.ts#MyTestModel
+    myTestModel: () => ["name", "test", "extra", "Model", "$identity", "$", "ns", "type", "stereo", "sid", "uid", "gid", "lock", "next", "meta", "createdAt", "updatedAt", "deletedAt", "error", "id", "_id"],
     // source: src/extended/abstract-service.spec.ts#TestModel
     testModel: () => ["name", "test", "A", "AB", "A_B", "Model", "$model", "object$", "extra", "keepMe", "$", "ns", "type", "stereo", "sid", "uid", "gid", "lock", "next", "meta", "createdAt", "updatedAt", "deletedAt", "error", "id", "_id"],
 };
 exports.fieldRegistryMeta = {
     "kind": "concrete",
     "schemaVersion": 1,
-    "entryCount": 1,
-    "checksum": "175c2e4da9bda595",
+    "entryCount": 3,
+    "checksum": "f00dc1d624f9c0a3",
     "generatedBy": "lemon-fields"
 };
 //# sourceMappingURL=field-registry.js.map

package/dist/generated/field-registry.js.map

@@ -1 +1 @@
-{"version":3,"file":"field-registry.js","sourceRoot":"","sources":["../../src/generated/field-registry.ts"],"names":[],"mappings":";;;AAAA,wEAAwE;AACxE,+BAA+B;AAClB,QAAA,SAAS,GAAG;IACrB,0DAA0D;IAC1D,SAAS,EAAE,GAAqB,EAAE,CAC9B,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,WAAW,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,CAAoC;CAC3P,CAAC;AAEE,QAAA,iBAAiB,GAAG;IAC7B,MAAM,EAAE,UAAU;IAClB,eAAe,EAAE,CAAC;IAClB,YAAY,EAAE,CAAC;IACf,UAAU,EAAE,kBAAkB;IAC9B,aAAa,EAAE,cAAc;CACvB,CAAC"}
+{"version":3,"file":"field-registry.js","sourceRoot":"","sources":["../../src/generated/field-registry.ts"],"names":[],"mappings":";;;AAAA,wEAAwE;AACxE,+BAA+B;AAClB,QAAA,SAAS,GAAG;IACrB,4DAA4D;IAC5D,SAAS,EAAE,GAAqB,EAAE,CAC9B,CAAC,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,WAAW,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,CAAoC;IAC9K,mEAAmE;IACnE,WAAW,EAAE,GAAqB,EAAE,CAChC,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,WAAW,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,CAAoC;IAC7N,0DAA0D;IAC1D,SAAS,EAAE,GAAqB,EAAE,CAC9B,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,WAAW,EAAE,WAAW,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,CAAoC;CAC3P,CAAC;AAEE,QAAA,iBAAiB,GAAG;IAC7B,MAAM,EAAE,UAAU;IAClB,eAAe,EAAE,CAAC;IAClB,YAAY,EAAE,CAAC;IACf,UAAU,EAAE,kBAAkB;IAC9B,aAAa,EAAE,cAAc;CACvB,CAAC"}

package/dist/index.d.ts

@@ -23,6 +23,14 @@ import * as controllers from './controllers/';
 export { lib, tools };
 export * from './helpers/';
 export * from './extended/';
+export * from './extended/cores/';
+export { $T } from './extended/cores/commons';
+export { onlyDefined } from './common/test-helper';
+export { sourceToItem, $ES6 } from './extended/abstract-service';
+export { withBrowserCache } from './extended/cores/browser-cache';
+export { $ES6Routed } from './extended/cores/abstract-services';
+export type { IdentityToken, IdentityTokenSite, IdentityTokenUser, IdentityTokenGroup, ListResult, PaginatedListResult, AggrKeyCount, ListParam, PaginateParam, BulkUpdateBody, BulkBody, BodyList, BulkItemsResult, } from './extended/cores/types';
+export { parseListParam, parsePaginateParam } from './extended/cores/commons';
 declare const _default: {
     engine: import("./engine/types").LemonEngine;
     cores: {

package/dist/index.js

@@ -39,7 +39,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.tools = exports.lib = void 0;
+exports.parsePaginateParam = exports.parseListParam = exports.$ES6Routed = exports.withBrowserCache = exports.$ES6 = exports.sourceToItem = exports.onlyDefined = exports.$T = exports.tools = exports.lib = void 0;
 /**
  * `index.ts`
  * - main index
@@ -71,6 +71,23 @@ exports.tools = tools;
 const controllers = __importStar(require("./controllers/"));
 __exportStar(require("./helpers/"), exports);
 __exportStar(require("./extended/"), exports);
+//* export the L2 template layer. explicit lines below pin the name collisions with L1:
+__exportStar(require("./extended/cores/"), exports);
+var commons_1 = require("./extended/cores/commons"); //* L2 wins — 4.2.x semantics (`asLut`/`BN`/`asMeta`, `S2` trims)
+Object.defineProperty(exports, "$T", { enumerable: true, get: function () { return commons_1.$T; } });
+var test_helper_1 = require("./common/test-helper"); //* L1 wins — signature compat (`(N, $def)`)
+Object.defineProperty(exports, "onlyDefined", { enumerable: true, get: function () { return test_helper_1.onlyDefined; } });
+var abstract_service_1 = require("./extended/abstract-service"); //* L1 wins — keep existing behavior
+Object.defineProperty(exports, "sourceToItem", { enumerable: true, get: function () { return abstract_service_1.sourceToItem; } });
+Object.defineProperty(exports, "$ES6", { enumerable: true, get: function () { return abstract_service_1.$ES6; } });
+var browser_cache_1 = require("./extended/cores/browser-cache"); //* not in the cores barrel (optional util)
+Object.defineProperty(exports, "withBrowserCache", { enumerable: true, get: function () { return browser_cache_1.withBrowserCache; } });
+var abstract_services_1 = require("./extended/cores/abstract-services"); //* explicit name only — root `$ES6` above must stay non-OS2 (decision #3); prevents silent search-backend swap
+Object.defineProperty(exports, "$ES6Routed", { enumerable: true, get: function () { return abstract_services_1.$ES6Routed; } });
+//* same L2-wins rationale as `$T` above — these call the same underlying parsing, duplicated verbatim.
+var commons_2 = require("./extended/cores/commons");
+Object.defineProperty(exports, "parseListParam", { enumerable: true, get: function () { return commons_2.parseListParam; } });
+Object.defineProperty(exports, "parsePaginateParam", { enumerable: true, get: function () { return commons_2.parsePaginateParam; } });
 //* export as default.
 exports.default = { engine: engine_1.default, cores: cores_1.default, tools, controllers };
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;;;;;;;;;;;;GAYG;AACH,8EAA8E;AAC9E,iDAA+B;AAC/B,uDAAqC;AACrC,4CAA0B;AAC1B,2CAAyB;AACzB,2CAAyB;AACzB,iDAA+B;AAE/B,qCAAqC;AACrC,uDAA+B;AAC/B,qDAA6B;AAE7B,oBAAoB;AACpB,4CAA8B;AAKrB,kBAAG;AAJZ,gDAAkC;AAIpB,sBAAK;AAHnB,4DAA8C;AAI9C,6CAA2B;AAC3B,8CAA4B;AAE5B,sBAAsB;AACtB,kBAAe,EAAE,MAAM,EAAN,gBAAM,EAAE,KAAK,EAAL,eAAK,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA;;;;;;;;;;;;GAYG;AACH,8EAA8E;AAC9E,iDAA+B;AAC/B,uDAAqC;AACrC,4CAA0B;AAC1B,2CAAyB;AACzB,2CAAyB;AACzB,iDAA+B;AAE/B,qCAAqC;AACrC,uDAA+B;AAC/B,qDAA6B;AAE7B,oBAAoB;AACpB,4CAA8B;AAKrB,kBAAG;AAJZ,gDAAkC;AAIpB,sBAAK;AAHnB,4DAA8C;AAI9C,6CAA2B;AAC3B,8CAA4B;AAE5B,uFAAuF;AACvF,oDAAkC;AAClC,oDAA8C,CAAC,iEAAiE;AAAvG,6FAAA,EAAE,OAAA;AACX,oDAAmD,CAAC,4CAA4C;AAAvF,0GAAA,WAAW,OAAA;AACpB,gEAAiE,CAAC,oCAAoC;AAA7F,gHAAA,YAAY,OAAA;AAAE,wGAAA,IAAI,OAAA;AAC3B,gEAAkE,CAAC,2CAA2C;AAArG,iHAAA,gBAAgB,OAAA;AACzB,wEAAgE,CAAC,+GAA+G;AAAvK,+GAAA,UAAU,OAAA;AAsBnB,uGAAuG;AACvG,oDAA8E;AAArE,yGAAA,cAAc,OAAA;AAAE,6GAAA,kBAAkB,OAAA;AAE3C,sBAAsB;AACtB,kBAAe,EAAE,MAAM,EAAN,gBAAM,EAAE,KAAK,EAAL,eAAK,EAAE,KAAK,EAAE,WAAW,EAAE,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lemon-core",
-  "version": "4.2.6",
+  "version": "4.3.0",
   "description": "Lemon Serverless Micro-Service Platform",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",