@nodesecure/rc 1.3.0 → 1.5.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/NodeSecure/rc.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,7 +61,23 @@ const result = (await RC.write(void 0, writeOpts)).unwrap();
 assert.strictEqual(result, void 0);
 ```
 
-> 👀 .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.
+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.
 
 ## 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
 
@@ -140,7 +194,7 @@ assert.strictEqual(RC.CONSTANTS.CONFIGURATION_NAME, ".nodesecurerc");
 We provide by default a configuration generation that we consider `minimal`. On the contrary, a `complete` value will indicate the generation with all possible default keys.
 
 ```ts
-export type RCGenerationMode = "minimal" | "ci" | "report" | "complete";
+export type RCGenerationMode = "minimal" | "ci" | "report" | "scanner" | "complete";
 ```
 
 However, depending on the NodeSecure tool you are working on, it can be interesting to generate a configuration with some property sets specific to your needs.
@@ -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/constants.d.ts

@@ -1,2 +1,2 @@
-export declare const CONFIGURATION_NAME = ".nodesecurerc";
-export declare const GLOBAL_CONFIGURATION_DIRECTORY = "nodesecure";
+export declare const CONFIGURATION_NAME = ".nodesecurerc";
+export declare const GLOBAL_CONFIGURATION_DIRECTORY = "nodesecure";

package/dist/constants.js

@@ -1,3 +1,3 @@
-export const CONFIGURATION_NAME = ".nodesecurerc";
-export const GLOBAL_CONFIGURATION_DIRECTORY = "nodesecure";
+export const CONFIGURATION_NAME = ".nodesecurerc";
+export const GLOBAL_CONFIGURATION_DIRECTORY = "nodesecure";
 //# sourceMappingURL=constants.js.map

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

@@ -1,21 +1,27 @@
-/// <reference types="node" />
-import { Result } from "ts-results";
-import { RequireAtLeastOne } from "type-fest";
-import { RC, RCGenerationMode } from "../rc.js";
-interface createReadOptions {
-    /**
-     * If enabled the file will be created if it does not exist on the disk.
-     *
-     * @default false
-     */
-    createIfDoesNotExist?: boolean;
-    /**
-     * RC Generation mode. This option allows to generate a more or less complete configuration for some NodeSecure tools.
-     *
-     * @default `minimal`
-     */
-    createMode?: RCGenerationMode | RCGenerationMode[];
-}
-export type readOptions = RequireAtLeastOne<createReadOptions, "createIfDoesNotExist" | "createMode">;
-export declare function read(location?: string, options?: readOptions): Promise<Result<RC, NodeJS.ErrnoException>>;
-export {};
+/// <reference types="node" />
+import { Result } from "@openally/result";
+import { RequireAtLeastOne } from "type-fest";
+import { RC, RCGenerationMode } from "../rc.js";
+interface createReadOptions {
+    /**
+     * If enabled the file will be created if it does not exist on the disk.
+     *
+     * @default false
+     */
+    createIfDoesNotExist?: boolean;
+    /**
+     * RC Generation mode. This option allows to generate a more or less complete configuration for some NodeSecure tools.
+     *
+     * @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>>;
+export {};

package/dist/functions/read.js

@@ -1,32 +1,34 @@
-// Import Node.js Dependencies
-import path from "node:path";
-import { once } from "node:events";
-// Import Third-party Dependencies
-import Config from "@slimio/config";
-import TR from "ts-results";
-// Import Internal Dependencies
-import { JSONSchema, generateDefaultRC } from "../rc.js";
-import * as CONSTANTS from "../constants.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 cfgPath = path.join(location, CONSTANTS.CONFIGURATION_NAME);
-        const cfg = new Config(cfgPath, {
-            defaultSchema: JSONSchema,
-            createOnNoEntry: createIfDoesNotExist
-        });
-        await cfg.read(createIfDoesNotExist ? generateDefaultRC(createMode) : void 0);
-        if (createIfDoesNotExist) {
-            await once(cfg, "configWritten");
-        }
-        const result = cfg.payload;
-        await cfg.close();
-        return new Ok(result);
-    }
-    catch (error) {
-        return new Err(error);
-    }
-}
+// Import Node.js Dependencies
+import path from "node:path";
+import { once } from "node:events";
+// Import Third-party Dependencies
+import Config from "@slimio/config";
+import { Ok, Err } from "@openally/result";
+// Import Internal Dependencies
+import { JSONSchema, generateDefaultRC } from "../rc.js";
+import * as CONSTANTS from "../constants.js";
+import { memoize } from "./memoize.js";
+export async function read(location = process.cwd(), options = Object.create(null)) {
+    try {
+        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,
+            createOnNoEntry: createIfDoesNotExist
+        });
+        await cfg.read(createIfDoesNotExist ? generateDefaultRC(createMode) : void 0);
+        if (createIfDoesNotExist) {
+            await once(cfg, "configWritten");
+        }
+        const result = cfg.payload;
+        if (memoizeRc) {
+            memoize(result);
+        }
+        await cfg.close();
+        return Ok(result);
+    }
+    catch (error) {
+        return Err(error);
+    }
+}
 //# sourceMappingURL=read.js.map

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,EAAE,EAAE,EAAE,GAAG,EAAU,MAAM,kBAAkB,CAAC;AAGnD,+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;AA0BvC,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,EAAE,CAAC,MAAM,CAAC,CAAC;KACnB;IACD,OAAO,KAAK,EAAE;QACZ,OAAO,GAAG,CAAC,KAA8B,CAAC,CAAC;KAC5C;AACH,CAAC"}

package/dist/functions/write.d.ts

@@ -1,19 +1,19 @@
-/// <reference types="node" />
-import { Result } from "ts-results";
-import { RC } from "../rc.js";
-/**
- * Overwrite the complete payload. partialUpdate property is mandatory.
- */
-export interface writeCompletePayload {
-    payload: RC;
-    partialUpdate?: false;
-}
-/**
- * Partially update the payload. This implies not to rewrite the content of the file when enabled.
- **/
-export interface writePartialPayload {
-    payload: Partial<RC>;
-    partialUpdate: true;
-}
-export type writeOptions = writeCompletePayload | writePartialPayload;
-export declare function write(location: string | undefined, options: writeOptions): Promise<Result<void, NodeJS.ErrnoException>>;
+/// <reference types="node" />
+import { Result } from "@openally/result";
+import { RC } from "../rc.js";
+/**
+ * Overwrite the complete payload. partialUpdate property is mandatory.
+ */
+export interface writeCompletePayload {
+    payload: RC;
+    partialUpdate?: false;
+}
+/**
+ * Partially update the payload. This implies not to rewrite the content of the file when enabled.
+ **/
+export interface writePartialPayload {
+    payload: Partial<RC>;
+    partialUpdate: true;
+}
+export type writeOptions = writeCompletePayload | writePartialPayload;
+export declare function write(location: string | undefined, options: writeOptions): Promise<Result<void, NodeJS.ErrnoException>>;

package/dist/functions/write.js

@@ -1,28 +1,26 @@
-// Import Node.js Dependencies
-import path from "path";
-// Import Third-party Dependencies
-import Config from "@slimio/config";
-import TR from "ts-results";
-// Import Internal Dependencies
-import { JSONSchema } from "../rc.js";
-import * as CONSTANTS from "../constants.js";
-// CONSTANTS
-const { Ok, Err } = TR;
-export async function write(location = process.cwd(), options) {
-    try {
-        const { payload, partialUpdate = false } = options;
-        const cfgPath = path.join(location, CONSTANTS.CONFIGURATION_NAME);
-        const cfg = new Config(cfgPath, {
-            defaultSchema: JSONSchema
-        });
-        await cfg.read();
-        const newPayloadValue = partialUpdate ? Object.assign(cfg.payload, payload) : payload;
-        cfg.payload = newPayloadValue;
-        await cfg.close();
-        return new Ok(void 0);
-    }
-    catch (error) {
-        return new Err(error);
-    }
-}
+// Import Node.js Dependencies
+import path from "path";
+// Import Third-party Dependencies
+import Config from "@slimio/config";
+import { Ok, Err } from "@openally/result";
+// Import Internal Dependencies
+import { JSONSchema } from "../rc.js";
+import * as CONSTANTS from "../constants.js";
+export async function write(location = process.cwd(), options) {
+    try {
+        const { payload, partialUpdate = false } = options;
+        const cfgPath = path.join(location, CONSTANTS.CONFIGURATION_NAME);
+        const cfg = new Config(cfgPath, {
+            defaultSchema: JSONSchema
+        });
+        await cfg.read();
+        const newPayloadValue = partialUpdate ? Object.assign(cfg.payload, payload) : payload;
+        cfg.payload = newPayloadValue;
+        await cfg.close();
+        return Ok(void 0);
+    }
+    catch (error) {
+        return Err(error);
+    }
+}
 //# sourceMappingURL=write.js.map

package/dist/functions/write.js.map

@@ -1 +1 @@
-{"version":3,"file":"write.js","sourceRoot":"","sources":["../../src/functions/write.ts"],"names":[],"mappings":"AAAA,8BAA8B;AAC9B,OAAO,IAAI,MAAM,MAAM,CAAC;AAExB,kCAAkC;AAClC,OAAO,MAAM,MAAM,gBAAgB,CAAC;AACpC,OAAO,EAAc,MAAM,YAAY,CAAC;AAExC,+BAA+B;AAC/B,OAAO,EAAM,UAAU,EAAE,MAAM,UAAU,CAAC;AAC1C,OAAO,KAAK,SAAS,MAAM,iBAAiB,CAAC;AAE7C,YAAY;AACZ,MAAM,EAAE,EAAE,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC;AAoBvB,MAAM,CAAC,KAAK,UAAU,KAAK,CACzB,QAAQ,GAAG,OAAO,CAAC,GAAG,EAAE,EACxB,OAAqB;IAErB,IAAI;QACF,MAAM,EAAE,OAAO,EAAE,aAAa,GAAG,KAAK,EAAE,GAAG,OAAO,CAAC;QAEnD,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;SAC1B,CAAC,CAAC;QACH,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC;QAEjB,MAAM,eAAe,GAAG,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,OAAa,CAAC;QAC5F,GAAG,CAAC,OAAO,GAAG,eAAe,CAAC;QAE9B,MAAM,GAAG,CAAC,KAAK,EAAE,CAAC;QAElB,OAAO,IAAI,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;KACvB;IACD,OAAO,KAAK,EAAE;QACZ,OAAO,IAAI,GAAG,CAAC,KAA8B,CAAC,CAAC;KAChD;AACH,CAAC"}
+{"version":3,"file":"write.js","sourceRoot":"","sources":["../../src/functions/write.ts"],"names":[],"mappings":"AAAA,8BAA8B;AAC9B,OAAO,IAAI,MAAM,MAAM,CAAC;AAExB,kCAAkC;AAClC,OAAO,MAAM,MAAM,gBAAgB,CAAC;AACpC,OAAO,EAAE,EAAE,EAAE,GAAG,EAAU,MAAM,kBAAkB,CAAC;AAEnD,+BAA+B;AAC/B,OAAO,EAAM,UAAU,EAAE,MAAM,UAAU,CAAC;AAC1C,OAAO,KAAK,SAAS,MAAM,iBAAiB,CAAC;AAmB7C,MAAM,CAAC,KAAK,UAAU,KAAK,CACzB,QAAQ,GAAG,OAAO,CAAC,GAAG,EAAE,EACxB,OAAqB;IAErB,IAAI;QACF,MAAM,EAAE,OAAO,EAAE,aAAa,GAAG,KAAK,EAAE,GAAG,OAAO,CAAC;QAEnD,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;SAC1B,CAAC,CAAC;QACH,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC;QAEjB,MAAM,eAAe,GAAG,aAAa,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,OAAa,CAAC;QAC5F,GAAG,CAAC,OAAO,GAAG,eAAe,CAAC;QAE9B,MAAM,GAAG,CAAC,KAAK,EAAE,CAAC;QAElB,OAAO,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;KACnB;IACD,OAAO,KAAK,EAAE;QACZ,OAAO,GAAG,CAAC,KAA8B,CAAC,CAAC;KAC5C;AACH,CAAC"}

package/dist/index.d.ts

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

package/dist/index.js

@@ -1,5 +1,6 @@
-export * from "./functions/read.js";
-export * from "./functions/write.js";
-export * as CONSTANTS from "./constants.js";
-export { JSONSchema, homedir } from "./rc.js";
+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,EAAc,UAAU,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC"}

package/dist/projects/ci.d.ts

@@ -1,25 +1,25 @@
-import * as jsxray from "@nodesecure/js-x-ray";
-/**
- * Configuration dedicated for NodeSecure CI (or nsci)
- * @see https://github.com/NodeSecure/ci
- * @see https://github.com/NodeSecure/ci-action
- */
-export interface CiConfiguration {
-    /**
-     * List of enabled reporters
-     * @see https://github.com/NodeSecure/ci#reporters
-     */
-    reporters?: ("console" | "html")[];
-    vulnerabilities?: {
-        severity?: "medium" | "high" | "critical" | "all";
-    };
-    /**
-     * JS-X-Ray warnings configuration
-     * @see https://github.com/NodeSecure/js-x-ray#warnings-legends-v20
-     */
-    warnings?: CiWarnings | Record<jsxray.WarningName, CiWarnings>;
-}
-export type CiWarnings = "off" | "error" | "warning";
-export declare function generateCIConfiguration(): {
-    ci: CiConfiguration;
-};
+import * as jsxray from "@nodesecure/js-x-ray";
+/**
+ * Configuration dedicated for NodeSecure CI (or nsci)
+ * @see https://github.com/NodeSecure/ci
+ * @see https://github.com/NodeSecure/ci-action
+ */
+export interface CiConfiguration {
+    /**
+     * List of enabled reporters
+     * @see https://github.com/NodeSecure/ci#reporters
+     */
+    reporters?: ("console" | "html")[];
+    vulnerabilities?: {
+        severity?: "medium" | "high" | "critical" | "all";
+    };
+    /**
+     * JS-X-Ray warnings configuration
+     * @see https://github.com/NodeSecure/js-x-ray#warnings-legends-v20
+     */
+    warnings?: CiWarnings | Record<jsxray.WarningName, CiWarnings>;
+}
+export type CiWarnings = "off" | "error" | "warning";
+export declare function generateCIConfiguration(): {
+    ci: CiConfiguration;
+};

package/dist/projects/ci.js

@@ -1,11 +1,11 @@
-export function generateCIConfiguration() {
-    const ci = {
-        reporters: ["console"],
-        vulnerabilities: {
-            severity: "medium"
-        },
-        warnings: "error"
-    };
-    return { ci };
-}
+export function generateCIConfiguration() {
+    const ci = {
+        reporters: ["console"],
+        vulnerabilities: {
+            severity: "medium"
+        },
+        warnings: "error"
+    };
+    return { ci };
+}
 //# sourceMappingURL=ci.js.map