@nodesecure/rc 1.3.0 → 1.4.0

package/README.md

@@ -1,11 +1,21 @@
-# rc
-
-![version](https://img.shields.io/badge/dynamic/json.svg?style=for-the-badge&url=https://raw.githubusercontent.com/NodeSecure/rc/master/package.json&query=$.version&label=Version)
-[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg?style=for-the-badge)](https://github.com/NodeSecure/rc/commit-activity)
-[![mit](https://img.shields.io/github/license/Naereen/StrapDown.js.svg?style=for-the-badge)](https://github.com/NodeSecure/rc/blob/master/LICENSE)
-[![OpenSSF
-Scorecard](https://api.securityscorecards.dev/projects/github.com/NodeSecure/rc/badge?style=for-the-badge)](https://api.securityscorecards.dev/projects/github.com/NodeSecure/rc)
-![build](https://img.shields.io/github/actions/workflow/status/NodeSecure/rc/main.yml?style=for-the-badge)
+<p align="center">
+  <img src="https://user-images.githubusercontent.com/4438263/216045720-779bf16d-1d35-409f-a0e6-4019bda8edde.jpg" alt="@nodesecure/rc">
+</p>
+
+<p align="center">
+    <a href="https://github.com/NodeSecure/rc">
+      <img src="https://img.shields.io/badge/dynamic/json.svg?style=for-the-badge&url=https://raw.githubusercontent.com/NodeSecure/rc/master/package.json&query=$.version&label=Version" alt="npm version">
+    </a>
+    <a href="https://github.com/NodeSecure/rc/blob/master/LICENSE">
+      <img src="https://img.shields.io/github/license/Naereen/StrapDown.js.svg?style=for-the-badge" alt="license">
+    </a>
+    <a href="https://api.securityscorecards.dev/projects/github.com/NodeSecure/rc">
+      <img src="https://api.securityscorecards.dev/projects/github.com/NodeSecure/rc/badge?style=for-the-badge" alt="ossf scorecard">
+    </a>
+    <a href="https://github.com/NodeSecure/rc/actions?query=workflow%3A%22Node.js+CI%22">
+      <img src="https://img.shields.io/github/actions/workflow/status/NodeSecure/rc/main.yml?style=for-the-badge" alt="github ci workflow">
+    </a>
+</p>
 
 NodeSecure runtime configuration.
 
@@ -25,7 +35,7 @@ $ yarn add @nodesecure/rc
 
 ## Usage example
 
-Read:
+read:
 
 ```ts
 import * as RC from "@nodesecure/rc";
@@ -36,7 +46,7 @@ const configurationPayload = (
 console.log(configurationPayload);
 ```
 
-Write:
+write:
 
 ```ts
 import assert from "node:assert/strict";
@@ -51,6 +61,22 @@ const result = (await RC.write(void 0, writeOpts)).unwrap();
 assert.strictEqual(result, void 0);
 ```
 
+memoize/memoized:
+
+```ts
+import * as RC from "@nodesecure/rc";
+import assert from "node:assert";
+
+const configurationPayload = (
+    await RC.read(void 0, { createMode: "ci" })
+).unwrap()
+
+RC.memoize(configurationPayload, { overwrite: true });
+
+const memoizedPayload = RC.memoized();
+assert.deepEqual(configurationPayload, memoizedPayload);
+```
+
 > 👀 .read and .write return Rust like [Result](https://doc.rust-lang.org/std/result/) object. Under the hood we use [ts-results](https://github.com/vultix/ts-results) to achieve this.
 
 ## API
@@ -73,6 +99,12 @@ interface createReadOptions {
    * @default `minimal`
    */
   createMode?: RCGenerationMode | RCGenerationMode[];
+  /**
+   * RC automatic caching option. This option allows to cache a configuration passed in parameter.
+   *
+   * @default false
+   */
+  memoize?: boolean;
 }
 
 export type readOptions = RequireAtLeastOne<
@@ -115,6 +147,28 @@ export interface writePartialPayload {
 
 export type writeOptions = writeCompletePayload | writePartialPayload;
 ```
+### memoize(payload: Partial< RC >, options: memoizeOptions = {}): void
+By default, the memory API overwrites the previous stored payload. When the `OVERWRITE` option is `false`, it merges new properties with existing properties.
+
+```ts
+export interface memoizeOptions {
+  overwrite?: boolean;
+}
+```
+The `overwrite` option is used to specify whether data should be overwritten or merged.
+
+### memoized(options: memoizedOptions): Partial< RC > | null
+This method returns null, when the default value is null, otherwise, it returns the current value of `memoizedValue`.
+
+```ts
+export interface memoizedOptions {
+  defaultValue: Partial<RC>;
+}
+```
+If the `defaultValue` property is at null, then this value will be returned when `memoized` is called.
+
+### clearMemoized(): void
+Clear/reset memoized RC
 
 ### homedir(): string
 
@@ -168,9 +222,7 @@ console.log(RC.JSONSchema);
 ## Contributors ✨
 
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-
-[![All Contributors](https://img.shields.io/badge/all_contributors-3-orange.svg?style=flat-square)](#contributors-)
-
+[![All Contributors](https://img.shields.io/badge/all_contributors-4-orange.svg?style=flat-square)](#contributors-)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 
 Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
@@ -179,11 +231,14 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 <!-- prettier-ignore-start -->
 <!-- markdownlint-disable -->
 <table>
-  <tr>
-    <td align="center"><a href="https://www.linkedin.com/in/thomas-gentilhomme/"><img src="https://avatars.githubusercontent.com/u/4438263?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Gentilhomme</b></sub></a><br /><a href="https://github.com/NodeSecure/rc/commits?author=fraxken" title="Code">💻</a> <a href="https://github.com/NodeSecure/rc/issues?q=author%3Afraxken" title="Bug reports">🐛</a> <a href="https://github.com/NodeSecure/rc/pulls?q=is%3Apr+reviewed-by%3Afraxken" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/NodeSecure/rc/commits?author=fraxken" title="Documentation">📖</a> <a href="#security-fraxken" title="Security">🛡️</a></td>
-    <td align="center"><a href="https://dev.to/antoinecoulon"><img src="https://avatars.githubusercontent.com/u/43391199?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Antoine Coulon</b></sub></a><br /><a href="https://github.com/NodeSecure/rc/commits?author=antoine-coulon" title="Code">💻</a> <a href="https://github.com/NodeSecure/rc/issues?q=author%3Aantoine-coulon" title="Bug reports">🐛</a> <a href="https://github.com/NodeSecure/rc/pulls?q=is%3Apr+reviewed-by%3Aantoine-coulon" title="Reviewed Pull Requests">👀</a></td>
-    <td align="center"><a href="https://github.com/PierreDemailly"><img src="https://avatars.githubusercontent.com/u/39910767?v=4?s=100" width="100px;" alt=""/><br /><sub><b>PierreD</b></sub></a><br /><a href="https://github.com/NodeSecure/rc/commits?author=PierreDemailly" title="Code">💻</a></td>
-  </tr>
+  <tbody>
+    <tr>
+      <td align="center" valign="top" width="14.28%"><a href="https://www.linkedin.com/in/thomas-gentilhomme/"><img src="https://avatars.githubusercontent.com/u/4438263?v=4?s=100" width="100px;" alt="Gentilhomme"/><br /><sub><b>Gentilhomme</b></sub></a><br /><a href="https://github.com/NodeSecure/rc/commits?author=fraxken" title="Code">💻</a> <a href="https://github.com/NodeSecure/rc/issues?q=author%3Afraxken" title="Bug reports">🐛</a> <a href="https://github.com/NodeSecure/rc/pulls?q=is%3Apr+reviewed-by%3Afraxken" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/NodeSecure/rc/commits?author=fraxken" title="Documentation">📖</a> <a href="#security-fraxken" title="Security">🛡️</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://dev.to/antoinecoulon"><img src="https://avatars.githubusercontent.com/u/43391199?v=4?s=100" width="100px;" alt="Antoine Coulon"/><br /><sub><b>Antoine Coulon</b></sub></a><br /><a href="https://github.com/NodeSecure/rc/commits?author=antoine-coulon" title="Code">💻</a> <a href="https://github.com/NodeSecure/rc/issues?q=author%3Aantoine-coulon" title="Bug reports">🐛</a> <a href="https://github.com/NodeSecure/rc/pulls?q=is%3Apr+reviewed-by%3Aantoine-coulon" title="Reviewed Pull Requests">👀</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/PierreDemailly"><img src="https://avatars.githubusercontent.com/u/39910767?v=4?s=100" width="100px;" alt="PierreD"/><br /><sub><b>PierreD</b></sub></a><br /><a href="https://github.com/NodeSecure/rc/commits?author=PierreDemailly" title="Code">💻</a></td>
+      <td align="center" valign="top" width="14.28%"><a href="https://github.com/fabnguess"><img src="https://avatars.githubusercontent.com/u/72697416?v=4?s=100" width="100px;" alt="Kouadio Fabrice Nguessan"/><br /><sub><b>Kouadio Fabrice Nguessan</b></sub></a><br /><a href="https://github.com/NodeSecure/rc/commits?author=fabnguess" title="Code">💻</a> <a href="#maintenance-fabnguess" title="Maintenance">🚧</a></td>
+    </tr>
+  </tbody>
 </table>
 
 <!-- markdownlint-restore -->

package/dist/functions/memoize.d.ts

@@ -0,0 +1,14 @@
+import { RC } from "../rc.js";
+export interface memoizeOptions {
+    /**
+     * If enabled it will overwrite (crush) the previous memoized RC
+     * @default true
+     */
+    overwrite?: boolean;
+}
+export declare function memoize(payload: Partial<RC>, options?: memoizeOptions): void;
+export interface memoizedOptions {
+    defaultValue: Partial<RC>;
+}
+export declare function memoized(options?: memoizedOptions): Partial<RC> | null;
+export declare function clearMemoized(): void;

package/dist/functions/memoize.js

@@ -0,0 +1,20 @@
+// Import Third-party Dependencies
+import merge from "lodash.merge";
+let memoizedValue = null;
+export function memoize(payload, options = {}) {
+    const { overwrite = true } = options;
+    if (memoizedValue === null || overwrite) {
+        memoizedValue = payload;
+    }
+    else {
+        memoizedValue = merge({}, memoizedValue, payload);
+    }
+}
+export function memoized(options) {
+    const { defaultValue = null } = options ?? {};
+    return memoizedValue ?? defaultValue;
+}
+export function clearMemoized() {
+    memoizedValue = null;
+}
+//# sourceMappingURL=memoize.js.map

package/dist/functions/memoize.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"memoize.js","sourceRoot":"","sources":["../../src/functions/memoize.ts"],"names":[],"mappings":"AAAA,kCAAkC;AAClC,OAAO,KAAK,MAAM,cAAc,CAAC;AAKjC,IAAI,aAAa,GAAuB,IAAI,CAAC;AAU7C,MAAM,UAAU,OAAO,CACrB,OAAoB,EACpB,UAA0B,EAAE;IAE5B,MAAM,EAAE,SAAS,GAAG,IAAI,EAAE,GAAG,OAAO,CAAC;IAErC,IAAI,aAAa,KAAK,IAAI,IAAI,SAAS,EAAE;QACvC,aAAa,GAAG,OAAO,CAAC;KACzB;SACI;QACH,aAAa,GAAG,KAAK,CAAC,EAAE,EAAE,aAAa,EAAE,OAAO,CAAC,CAAC;KACnD;AACH,CAAC;AAMD,MAAM,UAAU,QAAQ,CACtB,OAAyB;IAEzB,MAAM,EAAE,YAAY,GAAG,IAAI,EAAE,GAAG,OAAO,IAAI,EAAE,CAAC;IAE9C,OAAO,aAAa,IAAI,YAAY,CAAC;AACvC,CAAC;AAED,MAAM,UAAU,aAAa;IAC3B,aAAa,GAAG,IAAI,CAAC;AACvB,CAAC"}

package/dist/functions/read.d.ts

@@ -15,6 +15,12 @@ interface createReadOptions {
      * @default `minimal`
      */
     createMode?: RCGenerationMode | RCGenerationMode[];
+    /**
+     * RC automatic caching option. This option allows to cache a configuration passed in parameter.
+     *
+     * @default false
+     */
+    memoize?: boolean;
 }
 export type readOptions = RequireAtLeastOne<createReadOptions, "createIfDoesNotExist" | "createMode">;
 export declare function read(location?: string, options?: readOptions): Promise<Result<RC, NodeJS.ErrnoException>>;

package/dist/functions/read.js

@@ -7,11 +7,12 @@ import TR from "ts-results";
 // Import Internal Dependencies
 import { JSONSchema, generateDefaultRC } from "../rc.js";
 import * as CONSTANTS from "../constants.js";
+import { memoize } from "./memoize.js";
 // CONSTANTS
 const { Ok, Err } = TR;
 export async function read(location = process.cwd(), options = Object.create(null)) {
     try {
-        const { createIfDoesNotExist = Boolean(options.createMode), createMode } = options;
+        const { createIfDoesNotExist = Boolean(options.createMode), createMode, memoize: memoizeRc = false } = options;
         const cfgPath = path.join(location, CONSTANTS.CONFIGURATION_NAME);
         const cfg = new Config(cfgPath, {
             defaultSchema: JSONSchema,
@@ -22,6 +23,9 @@ export async function read(location = process.cwd(), options = Object.create(nul
             await once(cfg, "configWritten");
         }
         const result = cfg.payload;
+        if (memoizeRc) {
+            memoize(result);
+        }
         await cfg.close();
         return new Ok(result);
     }

package/dist/functions/read.js.map

@@ -1 +1 @@
-{"version":3,"file":"read.js","sourceRoot":"","sources":["../../src/functions/read.ts"],"names":[],"mappings":"AAAA,8BAA8B;AAC9B,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AAEnC,kCAAkC;AAClC,OAAO,MAAM,MAAM,gBAAgB,CAAC;AACpC,OAAO,EAAc,MAAM,YAAY,CAAC;AAGxC,+BAA+B;AAC/B,OAAO,EAAM,UAAU,EAAE,iBAAiB,EAAoB,MAAM,UAAU,CAAC;AAC/E,OAAO,KAAK,SAAS,MAAM,iBAAiB,CAAC;AAE7C,YAAY;AACZ,MAAM,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;AAmBvB,MAAM,CAAC,KAAK,UAAU,IAAI,CACxB,QAAQ,GAAG,OAAO,CAAC,GAAG,EAAE,EACxB,UAAuB,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC;IAE1C,IAAI;QACF,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC;QAEnF,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,kBAAkB,CAAC,CAAC;QAClE,MAAM,GAAG,GAAG,IAAI,MAAM,CAAK,OAAO,EAAE;YAClC,aAAa,EAAE,UAAU;YACzB,eAAe,EAAE,oBAAoB;SACtC,CAAC,CAAC;QAEH,MAAM,GAAG,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;QAC9E,IAAI,oBAAoB,EAAE;YACxB,MAAM,IAAI,CAAC,GAAG,EAAE,eAAe,CAAC,CAAC;SAClC;QACD,MAAM,MAAM,GAAG,GAAG,CAAC,OAAO,CAAC;QAE3B,MAAM,GAAG,CAAC,KAAK,EAAE,CAAC;QAElB,OAAO,IAAI,EAAE,CAAC,MAAM,CAAC,CAAC;KACvB;IACD,OAAO,KAAK,EAAE;QACZ,OAAO,IAAI,GAAG,CAAC,KAA8B,CAAC,CAAC;KAChD;AACH,CAAC"}
+{"version":3,"file":"read.js","sourceRoot":"","sources":["../../src/functions/read.ts"],"names":[],"mappings":"AAAA,8BAA8B;AAC9B,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,IAAI,EAAE,MAAM,aAAa,CAAC;AAEnC,kCAAkC;AAClC,OAAO,MAAM,MAAM,gBAAgB,CAAC;AACpC,OAAO,EAAc,MAAM,YAAY,CAAC;AAGxC,+BAA+B;AAC/B,OAAO,EAAM,UAAU,EAAE,iBAAiB,EAAoB,MAAM,UAAU,CAAC;AAC/E,OAAO,KAAK,SAAS,MAAM,iBAAiB,CAAC;AAC7C,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAEvC,YAAY;AACZ,MAAM,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;AA0BvB,MAAM,CAAC,KAAK,UAAU,IAAI,CACxB,QAAQ,GAAG,OAAO,CAAC,GAAG,EAAE,EACxB,UAAuB,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC;IAE1C,IAAI;QACF,MAAM,EAAE,oBAAoB,GAAG,OAAO,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE,UAAU,EAAE,OAAO,EAAE,SAAS,GAAG,KAAK,EAAE,GAAG,OAAO,CAAC;QAE/G,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,SAAS,CAAC,kBAAkB,CAAC,CAAC;QAClE,MAAM,GAAG,GAAG,IAAI,MAAM,CAAK,OAAO,EAAE;YAClC,aAAa,EAAE,UAAU;YACzB,eAAe,EAAE,oBAAoB;SACtC,CAAC,CAAC;QAEH,MAAM,GAAG,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC,CAAC,iBAAiB,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC;QAC9E,IAAI,oBAAoB,EAAE;YACxB,MAAM,IAAI,CAAC,GAAG,EAAE,eAAe,CAAC,CAAC;SAClC;QACD,MAAM,MAAM,GAAG,GAAG,CAAC,OAAO,CAAC;QAE3B,IAAI,SAAS,EAAE;YACb,OAAO,CAAC,MAAM,CAAC,CAAC;SACjB;QAED,MAAM,GAAG,CAAC,KAAK,EAAE,CAAC;QAElB,OAAO,IAAI,EAAE,CAAC,MAAM,CAAC,CAAC;KACvB;IACD,OAAO,KAAK,EAAE;QACZ,OAAO,IAAI,GAAG,CAAC,KAA8B,CAAC,CAAC;KAChD;AACH,CAAC"}

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./functions/read.js";
 export * from "./functions/write.js";
+export * from "./functions/memoize.js";
 export * as CONSTANTS from "./constants.js";
 export { RC, JSONSchema, homedir } from "./rc.js";

package/dist/index.js

@@ -1,5 +1,6 @@
 export * from "./functions/read.js";
 export * from "./functions/write.js";
+export * from "./functions/memoize.js";
 export * as CONSTANTS from "./constants.js";
 export { JSONSchema, homedir } from "./rc.js";
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAC;AAE5C,OAAO,EAAM,UAAU,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAC;AACpC,cAAc,sBAAsB,CAAC;AACrC,cAAc,wBAAwB,CAAC;AACvC,OAAO,KAAK,SAAS,MAAM,gBAAgB,CAAC;AAE5C,OAAO,EAAM,UAAU,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nodesecure/rc",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "description": "NodeSecure runtime configuration",
   "exports": "./dist/index.js",
   "type": "module",
@@ -35,31 +35,31 @@
   },
   "homepage": "https://github.com/NodeSecure/rc#readme",
   "devDependencies": {
-    "@nodesecure/eslint-config": "^1.6.0",
+    "@nodesecure/eslint-config": "^1.7.0",
     "@types/chai": "^4.3.4",
     "@types/lodash.merge": "^4.6.7",
     "@types/mocha": "^10.0.1",
-    "@types/node": "^18.11.18",
+    "@types/node": "^18.15.3",
     "@types/zen-observable": "^0.8.3",
     "ajv": "^8.12.0",
     "c8": "^7.12.0",
     "chai": "^4.3.7",
-    "eslint": "^8.32.0",
-    "lodash.merge": "^4.6.2",
+    "eslint": "^8.36.0",
     "mocha": "^10.2.0",
     "tape": "^5.6.3",
     "ts-node": "^10.9.1",
-    "tsd": "^0.25.0",
-    "typescript": "^4.9.4"
+    "tsd": "^0.28.0",
+    "typescript": "^5.0.2"
   },
   "dependencies": {
-    "@nodesecure/i18n": "^2.1.1",
-    "@nodesecure/js-x-ray": "^5.1.0",
+    "@nodesecure/i18n": "^3.2.0",
+    "@nodesecure/js-x-ray": "^6.0.1",
     "@nodesecure/vuln": "^1.7.0",
     "@slimio/config": "^1.2.0",
+    "lodash.merge": "^4.6.2",
     "ts-results": "^3.3.0",
     "tslib": "^2.4.1",
-    "type-fest": "^3.5.3"
+    "type-fest": "^3.6.1"
   },
   "tsd": {
     "directory": "test/types",