lemon-core 4.0.1 → 4.0.3

package/dist/tools/tools.d.ts

@@ -1,4 +1,8 @@
 import { CrendentialForAWS } from '../environ';
+import { RuntimeConfigAwsCredentialIdentityProvider } from '@aws-sdk/types/dist-types/identity/AwsCredentialIdentity';
+import { LemonEngine } from '../engine/types';
+/** returns only defined */
+export declare const onlyDefined: <T extends object>(N: T, $def?: T) => T;
 /**
  * load json in sync.
  */
@@ -10,6 +14,34 @@ export declare const loadDataYml: <T extends object = any>(file: string, folder?
 /**
  * dynamic loading credentials by profile. (search PROFILE -> NAME)
  *
- * @returns {Promise<any>} - AWS credentials
+ * @returns {Promise<CrendentialForAWS>} - AWS credentials
  */
-export declare const asyncCredentials: (profile: string) => Promise<CrendentialForAWS>;
+export declare const asyncCredentials: (profile?: string) => Promise<CrendentialForAWS>;
+/**
+ * type: `AwsConfigParams`
+ * - parameters for AWS config.
+ * - used for `awsConfig()`
+ */
+export interface AwsConfigParams {
+    /** AWS region */
+    region?: string;
+    /** AWS profile */
+    profile?: string;
+    /** AWS credentials provider */
+    credentials?: RuntimeConfigAwsCredentialIdentityProvider;
+}
+/**
+ * load config for aws sdk
+ * - if `profile` is not defined, use `AWS_PROFILE` or `default`
+ * - if `region` is not defined, use `AWS_REGION` or `ap-northeast-2`
+ *
+ * ```
+ * # run with default profile
+ * $ npm run test:watch
+ *
+ * # run with `lemon` profile
+ * #npm run test:watch.lemon
+ */
+export declare const awsConfig: <T extends AwsConfigParams>($engine: LemonEngine, params?: string | T | (() => string)) => T & {
+    credentials?: RuntimeConfigAwsCredentialIdentityProvider;
+};

package/dist/tools/tools.js

@@ -12,7 +12,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.asyncCredentials = exports.loadDataYml = exports.loadJsonSync = void 0;
+exports.awsConfig = exports.asyncCredentials = exports.loadDataYml = exports.loadJsonSync = exports.onlyDefined = void 0;
 /**
  * `tools/tools.ts`
  * - additional helper.
@@ -33,6 +33,15 @@ exports.asyncCredentials = exports.loadDataYml = exports.loadJsonSync = void 0;
 const fs_1 = __importDefault(require("fs"));
 const js_yaml_1 = __importDefault(require("js-yaml"));
 const credential_providers_1 = require("@aws-sdk/credential-providers");
+/** returns only defined */
+const onlyDefined = (N, $def = null) => N && typeof N === 'object'
+    ? Object.entries(N).reduce((N, [k, v]) => {
+        if (v !== undefined)
+            N[k] = v;
+        return N;
+    }, {})
+    : $def;
+exports.onlyDefined = onlyDefined;
 /**
  * load json in sync.
  */
@@ -63,7 +72,7 @@ exports.loadDataYml = loadDataYml;
 /**
  * dynamic loading credentials by profile. (search PROFILE -> NAME)
  *
- * @returns {Promise<any>} - AWS credentials
+ * @returns {Promise<CrendentialForAWS>} - AWS credentials
  */
 const asyncCredentials = (profile) => __awaiter(void 0, void 0, void 0, function* () {
     const provider = (0, credential_providers_1.fromIni)({ profile });
@@ -71,4 +80,45 @@ const asyncCredentials = (profile) => __awaiter(void 0, void 0, void 0, function
     return Object.assign(Object.assign({}, $res), { profile });
 });
 exports.asyncCredentials = asyncCredentials;
+/**
+ * load config for aws sdk
+ * - if `profile` is not defined, use `AWS_PROFILE` or `default`
+ * - if `region` is not defined, use `AWS_REGION` or `ap-northeast-2`
+ *
+ * ```
+ * # run with default profile
+ * $ npm run test:watch
+ *
+ * # run with `lemon` profile
+ * #npm run test:watch.lemon
+ */
+const awsConfig = ($engine, 
+/** params or region */
+params) => {
+    var _a;
+    const errScope = `awsConfig(${(_a = $engine === null || $engine === void 0 ? void 0 : $engine.id) !== null && _a !== void 0 ? _a : ''})`;
+    const region = params === undefined
+        ? 'ap-northeast-2'
+        : typeof params === 'string'
+            ? params
+            : typeof params === 'function'
+                ? params()
+                : params === null || params === void 0 ? void 0 : params.region;
+    const _conf = typeof params === 'object' ? params : null;
+    const profile = $engine === null || $engine === void 0 ? void 0 : $engine.environ('NAME', 'none');
+    if (typeof profile !== 'string')
+        throw new Error(`@env.NAME[${typeof profile}] is invalid (check $engine) - ${errScope}`);
+    //* build defualt config.
+    const $conf = (0, exports.onlyDefined)(Object.assign({ profile: profile && profile !== 'none' ? profile : undefined, region }, _conf));
+    if (typeof $conf.region === 'string' && !$conf.region)
+        throw new Error(`.region[${$conf.region}] is invalid (empty) - ${errScope}`);
+    //! load the credentials provider(async function).
+    const credentials = typeof $conf.credentials === 'function'
+        ? $conf.credentials
+        : $conf.profile
+            ? (0, credential_providers_1.fromIni)({ profile: $conf.profile })
+            : undefined;
+    return (0, exports.onlyDefined)(Object.assign(Object.assign({}, $conf), { credentials }));
+};
+exports.awsConfig = awsConfig;
 //# sourceMappingURL=tools.js.map

package/dist/tools/tools.js.map

@@ -1 +1 @@
-{"version":3,"file":"tools.js","sourceRoot":"","sources":["../../src/tools/tools.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA;;;;;;;;;;;;;;;;GAgBG;AACH,4CAAoB;AACpB,sDAA2B;AAC3B,wEAAwD;AAGxD;;GAEG;AACI,MAAM,YAAY,GAAG,CAAyB,IAAY,EAAE,GAAG,GAAG,EAAE,EAAK,EAAE;IAC9E,IAAI,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;IACnD,IAAI;QACA,MAAM,OAAO,GAAG,YAAE,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QACtC,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAM,CAAC;KAC9C;IAAC,OAAO,CAAC,EAAE;QACR,IAAI,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ;YAAG,GAAW,CAAC,KAAK,GAAG,GAAG,CAAC,CAAC,OAAO,IAAI,CAAC,EAAE,CAAC;QAC7E,OAAO,GAAQ,CAAC;KACnB;AACL,CAAC,CAAC;AATW,QAAA,YAAY,gBASvB;AAEF;;GAEG;AACI,MAAM,WAAW,GAAG,CAAyB,IAAY,EAAE,MAAe,EAAK,EAAE;IACpF,MAAM,GAAG,MAAM,IAAI,MAAM,CAAC;IAC1B,MAAM,IAAI,GAAG,KAAK,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;IAC3E,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,IAAI,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,4BAA4B,GAAG,IAAI,CAAC,CAAC;IAC/E,OAAO,iBAAI,CAAC,IAAI,CAAC,YAAE,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;AACpD,CAAC,CAAC;AALW,QAAA,WAAW,eAKtB;AAEF;;;;GAIG;AACI,MAAM,gBAAgB,GAAG,CAAO,OAAe,EAA8B,EAAE;IAClF,MAAM,QAAQ,GAAG,IAAA,8BAAO,EAAC,EAAE,OAAO,EAAE,CAAC,CAAC;IACtC,MAAM,IAAI,GAAG,MAAM,QAAQ,EAAE,CAAC;IAC9B,uCAAY,IAAI,KAAE,OAAO,IAAG;AAChC,CAAC,CAAA,CAAC;AAJW,QAAA,gBAAgB,oBAI3B"}
+{"version":3,"file":"tools.js","sourceRoot":"","sources":["../../src/tools/tools.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA;;;;;;;;;;;;;;;;GAgBG;AACH,4CAAoB;AACpB,sDAA2B;AAC3B,wEAAwD;AAMxD,2BAA2B;AACpB,MAAM,WAAW,GAAG,CAAmB,CAAI,EAAE,OAAU,IAAI,EAAK,EAAE,CACrE,CAAC,IAAI,OAAO,CAAC,KAAK,QAAQ;IACtB,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,MAAM,CAAI,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE;QACtC,IAAI,CAAC,KAAK,SAAS;YAAE,CAAC,CAAC,CAAY,CAAC,GAAG,CAAC,CAAC;QACzC,OAAO,CAAC,CAAC;IACb,CAAC,EAAE,EAAO,CAAC;IACb,CAAC,CAAE,IAAU,CAAC;AANT,QAAA,WAAW,eAMF;AAEtB;;GAEG;AACI,MAAM,YAAY,GAAG,CAAyB,IAAY,EAAE,GAAG,GAAG,EAAE,EAAK,EAAE;IAC9E,IAAI,GAAG,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;IACnD,IAAI;QACA,MAAM,OAAO,GAAG,YAAE,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;QACtC,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAM,CAAC;KAC9C;IAAC,OAAO,CAAC,EAAE;QACR,IAAI,GAAG,IAAI,OAAO,GAAG,KAAK,QAAQ;YAAG,GAAW,CAAC,KAAK,GAAG,GAAG,CAAC,CAAC,OAAO,IAAI,CAAC,EAAE,CAAC;QAC7E,OAAO,GAAQ,CAAC;KACnB;AACL,CAAC,CAAC;AATW,QAAA,YAAY,gBASvB;AAEF;;GAEG;AACI,MAAM,WAAW,GAAG,CAAyB,IAAY,EAAE,MAAe,EAAK,EAAE;IACpF,MAAM,GAAG,MAAM,IAAI,MAAM,CAAC;IAC1B,MAAM,IAAI,GAAG,KAAK,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC;IAC3E,IAAI,CAAC,YAAE,CAAC,UAAU,CAAC,IAAI,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,4BAA4B,GAAG,IAAI,CAAC,CAAC;IAC/E,OAAO,iBAAI,CAAC,IAAI,CAAC,YAAE,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;AACpD,CAAC,CAAC;AALW,QAAA,WAAW,eAKtB;AAEF;;;;GAIG;AACI,MAAM,gBAAgB,GAAG,CAAO,OAAgB,EAA8B,EAAE;IACnF,MAAM,QAAQ,GAAG,IAAA,8BAAO,EAAC,EAAE,OAAO,EAAE,CAAC,CAAC;IACtC,MAAM,IAAI,GAAG,MAAM,QAAQ,EAAE,CAAC;IAC9B,uCAAY,IAAI,KAAE,OAAO,IAAG;AAChC,CAAC,CAAA,CAAC;AAJW,QAAA,gBAAgB,oBAI3B;AAgBF;;;;;;;;;;;GAWG;AACI,MAAM,SAAS,GAAG,CACrB,OAAoB;AACpB,uBAAuB;AACvB,MAAoC,EAC4B,EAAE;;IAClE,MAAM,QAAQ,GAAG,aAAa,MAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,EAAE,mCAAI,EAAE,GAAG,CAAC;IACnD,MAAM,MAAM,GACR,MAAM,KAAK,SAAS;QAChB,CAAC,CAAC,gBAAgB;QAClB,CAAC,CAAC,OAAO,MAAM,KAAK,QAAQ;YAC5B,CAAC,CAAC,MAAM;YACR,CAAC,CAAC,OAAO,MAAM,KAAK,UAAU;gBAC9B,CAAC,CAAC,MAAM,EAAE;gBACV,CAAC,CAAC,MAAM,aAAN,MAAM,uBAAN,MAAM,CAAE,MAAM,CAAC;IACzB,MAAM,KAAK,GAAM,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC;IAC5D,MAAM,OAAO,GAAG,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO,CAAC,MAAM,EAAE,MAAM,CAAW,CAAC;IAC3D,IAAI,OAAO,OAAO,KAAK,QAAQ;QAC3B,MAAM,IAAI,KAAK,CAAC,aAAa,OAAO,OAAO,kCAAkC,QAAQ,EAAE,CAAC,CAAC;IAE7F,yBAAyB;IACzB,MAAM,KAAK,GAAG,IAAA,mBAAW,kBACrB,OAAO,EAAE,OAAO,IAAI,OAAO,KAAK,MAAM,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,EAC5D,MAAM,IACH,KAAK,EACV,CAAC;IACH,IAAI,OAAO,KAAK,CAAC,MAAM,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,MAAM;QACjD,MAAM,IAAI,KAAK,CAAC,WAAW,KAAK,CAAC,MAAM,0BAA0B,QAAQ,EAAE,CAAC,CAAC;IAEjF,kDAAkD;IAClD,MAAM,WAAW,GACb,OAAQ,KAAa,CAAC,WAAW,KAAK,UAAU;QAC5C,CAAC,CAAE,KAAa,CAAC,WAAW;QAC5B,CAAC,CAAC,KAAK,CAAC,OAAO;YACf,CAAC,CAAC,IAAA,8BAAO,EAAC,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC;YACrC,CAAC,CAAC,SAAS,CAAC;IAEpB,OAAO,IAAA,mBAAW,kCAAM,KAAK,KAAE,WAAW,IAAG,CAAC;AAClD,CAAC,CAAC;AArCW,QAAA,SAAS,aAqCpB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lemon-core",
-  "version": "4.0.1",
+  "version": "4.0.3",
   "description": "Lemon Serverless Micro-Service Platform",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -18,12 +18,12 @@
     "test.lemon": "ENV=lemon npm run test",
     "test:dev": "LS=1 jest --config=jest.config.json --watchAll",
     "!test:watch": "---- custom test with profile -----",
-    "test:watch": "LS=1 AWS_SDK_JS_SUPPRESS_MAINTENANCE_MODE_MESSAGE=1 jest --config=jest.config.json --watchAll",
+    "test:watch": "LS=1 jest --config=jest.config.json --watchAll",
     "test:watch.lemon": "ENV=lemon npm run test:watch",
     "!prepare": "------- run self-test with jest -----",
     "prepare": "npm run build",
     "!prepublishOnly": "npm test && npm run lint && npm run format",
-    "@prepublishOnly": "npm test && npm run lint",
+    "#prepublishOnly": "npm test && npm run lint",
     "!plato": "----- analysis code complexity -----",
     "plato": "plato -r -d complexity dist"
   },
@@ -81,7 +81,6 @@
   },
   "devDependencies": {
     "@aws-sdk/types": "^3.804.0",
-    "@smithy/types": "^4.3.0",
     "@smithy/util-stream": "^3.3.4",
     "@types/async": "^3.2.15",
     "@types/crypto-js": "^4.2.2",
@@ -105,12 +104,14 @@
     "faker": "^4.1.0",
     "gh-pages": "^5.0.0",
     "husky": "^8.0.3",
-    "jest": "^27.5.1",
+    "jest": "^28.1.3",
+    "jest-jasmine2": "^28.1.3",
+    "lemon-devkit": "^0.0.3",
     "lint-staged": "^13.1.0",
     "prettier": "^2.7.1",
     "superagent": "^5.3.1",
     "supertest": "^4.0.2",
-    "ts-jest": "^27.1.5",
+    "ts-jest": "^28.0.8",
     "ts-node": "^8.10.2",
     "ttypescript": "^1.5.15",
     "typedoc": "^0.23.15",