@nodesecure/rc 1.2.0 → 1.3.0

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2021 NodeSecure
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2021 NodeSecure
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,13 +1,16 @@
 # rc
-![version](https://img.shields.io/badge/dynamic/json.svg?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)](https://github.com/NodeSecure/rc/commit-activity)
-[![Security Responsible Disclosure](https://img.shields.io/badge/Security-Responsible%20Disclosure-yellow.svg)](https://github.com/nodejs/security-wg/blob/master/processes/responsible_disclosure_template.md
-)
-[![mit](https://img.shields.io/github/license/Naereen/StrapDown.js.svg)](https://github.com/NodeSecure/rc/blob/master/LICENSE)
+
+![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)
 
 NodeSecure runtime configuration.
 
 ## Requirements
+
 - [Node.js](https://nodejs.org/en/) v16 or higher
 
 ## Getting Started
@@ -34,18 +37,17 @@ console.log(configurationPayload);
 ```
 
 Write:
+
 ```ts
 import assert from "node:assert/strict";
 import * as RC from "@nodesecure/rc";
 
 const writeOpts: RC.writeOptions = {
   payload: { version: "2.0.0" },
-  partialUpdate: true
+  partialUpdate: true,
 };
 
-const result = (
-  await RC.write(void 0, writeOpts)
-).unwrap();
+const result = (await RC.write(void 0, writeOpts)).unwrap();
 assert.strictEqual(result, void 0);
 ```
 
@@ -73,7 +75,10 @@ interface createReadOptions {
   createMode?: RCGenerationMode | RCGenerationMode[];
 }
 
-export type readOptions = RequireAtLeastOne<createReadOptions, "createIfDoesNotExist" | "createMode">;
+export type readOptions = RequireAtLeastOne<
+  createReadOptions,
+  "createIfDoesNotExist" | "createMode"
+>;
 ```
 
 The `createIfDoesNotExist` argument can be ignored if `createMode` is provided.
@@ -145,7 +150,7 @@ Note that you can combine several modes:
 ```ts
 import * as RC from "@nodesecure/rc";
 
-await RC.read(void 0, { createMode: ["ci", "report"] })
+await RC.read(void 0, { createMode: ["ci", "report"] });
 ```
 
 ## JSON Schema
@@ -153,6 +158,7 @@ await RC.read(void 0, { createMode: ["ci", "report"] })
 The runtime configuration is validated with a JSON Schema: `./src/schema/nodesecurerc.json`.
 
 It can be retrieved by API if required:
+
 ```ts
 import * as RC from "@nodesecure/rc";
 
@@ -162,7 +168,9 @@ 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-BADGE:END -->
 
 Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
@@ -184,4 +192,5 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 <!-- ALL-CONTRIBUTORS-LIST:END -->
 
 ## License
+
 MIT

package/dist/functions/read.d.ts

@@ -16,6 +16,6 @@ interface createReadOptions {
      */
     createMode?: RCGenerationMode | RCGenerationMode[];
 }
-export declare type readOptions = RequireAtLeastOne<createReadOptions, "createIfDoesNotExist" | "createMode">;
+export type readOptions = RequireAtLeastOne<createReadOptions, "createIfDoesNotExist" | "createMode">;
 export declare function read(location?: string, options?: readOptions): Promise<Result<RC, NodeJS.ErrnoException>>;
 export {};

package/dist/functions/write.d.ts

@@ -15,5 +15,5 @@ export interface writePartialPayload {
     payload: Partial<RC>;
     partialUpdate: true;
 }
-export declare type writeOptions = writeCompletePayload | writePartialPayload;
+export type writeOptions = writeCompletePayload | writePartialPayload;
 export declare function write(location: string | undefined, options: writeOptions): Promise<Result<void, NodeJS.ErrnoException>>;

package/dist/projects/ci.d.ts

@@ -19,7 +19,7 @@ export interface CiConfiguration {
      */
     warnings?: CiWarnings | Record<jsxray.WarningName, CiWarnings>;
 }
-export declare type CiWarnings = "off" | "error" | "warning";
+export type CiWarnings = "off" | "error" | "warning";
 export declare function generateCIConfiguration(): {
     ci: CiConfiguration;
 };

package/dist/rc.d.ts

@@ -26,7 +26,7 @@ export interface RC {
     /** NodeSecure report Object configuration */
     report?: ReportConfiguration;
 }
-export declare type RCGenerationMode = "minimal" | "ci" | "report" | "complete";
+export type RCGenerationMode = "minimal" | "ci" | "report" | "complete";
 /**
  * @example
  * generateDefaultRC("complete");

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nodesecure/rc",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "description": "NodeSecure runtime configuration",
   "exports": "./dist/index.js",
   "type": "module",
@@ -35,30 +35,31 @@
   },
   "homepage": "https://github.com/NodeSecure/rc#readme",
   "devDependencies": {
-    "@nodesecure/eslint-config": "^1.4.1",
-    "@types/chai": "^4.3.1",
+    "@nodesecure/eslint-config": "^1.6.0",
+    "@types/chai": "^4.3.4",
     "@types/lodash.merge": "^4.6.7",
-    "@types/mocha": "^9.1.1",
-    "@types/node": "^18.0.0",
+    "@types/mocha": "^10.0.1",
+    "@types/node": "^18.11.18",
     "@types/zen-observable": "^0.8.3",
-    "ajv": "^8.11.0",
-    "c8": "^7.11.3",
-    "chai": "^4.3.6",
-    "eslint": "^8.18.0",
+    "ajv": "^8.12.0",
+    "c8": "^7.12.0",
+    "chai": "^4.3.7",
+    "eslint": "^8.32.0",
     "lodash.merge": "^4.6.2",
-    "mocha": "^9.2.2",
-    "tape": "^5.5.3",
-    "ts-node": "^10.8.1",
-    "tsd": "^0.21.0",
-    "typescript": "^4.7.4"
+    "mocha": "^10.2.0",
+    "tape": "^5.6.3",
+    "ts-node": "^10.9.1",
+    "tsd": "^0.25.0",
+    "typescript": "^4.9.4"
   },
   "dependencies": {
-    "@nodesecure/i18n": "^1.5.0",
-    "@nodesecure/js-x-ray": "^5.0.1",
+    "@nodesecure/i18n": "^2.1.1",
+    "@nodesecure/js-x-ray": "^5.1.0",
     "@nodesecure/vuln": "^1.7.0",
-    "@slimio/config": "^1.0.1",
+    "@slimio/config": "^1.2.0",
     "ts-results": "^3.3.0",
-    "type-fest": "^2.13.1"
+    "tslib": "^2.4.1",
+    "type-fest": "^3.5.3"
   },
   "tsd": {
     "directory": "test/types",