@hugoalh/github-sodium 3.1.0 → 3.1.2

package/README.md

@@ -1,8 +1,7 @@
 # GitHub Sodium (NodeJS)
 
-[`GitHubSodium.NodeJS`](https://github.com/hugoalh-studio/github-sodium-nodejs)
-
 ![License](https://img.shields.io/static/v1?label=License&message=MIT&style=flat-square "License")
+[![GitHub Repository](https://img.shields.io/badge/Repository-181717?logo=github&logoColor=ffffff&style=flat-square "GitHub Repository")](https://github.com/hugoalh-studio/github-sodium-nodejs)
 [![GitHub Stars](https://img.shields.io/github/stars/hugoalh-studio/github-sodium-nodejs?label=Stars&logo=github&logoColor=ffffff&style=flat-square "GitHub Stars")](https://github.com/hugoalh-studio/github-sodium-nodejs/stargazers)
 [![GitHub Contributors](https://img.shields.io/github/contributors/hugoalh-studio/github-sodium-nodejs?label=Contributors&logo=github&logoColor=ffffff&style=flat-square "GitHub Contributors")](https://github.com/hugoalh-studio/github-sodium-nodejs/graphs/contributors)
 [![GitHub Issues](https://img.shields.io/github/issues-raw/hugoalh-studio/github-sodium-nodejs?label=Issues&logo=github&logoColor=ffffff&style=flat-square "GitHub Issues")](https://github.com/hugoalh-studio/github-sodium-nodejs/issues)
@@ -25,16 +24,12 @@ This project is based on `libsodium.js` ([GitHub](https://github.com/jedisct1/li
 
 ### Getting Started
 
-#### Install
-
-- NodeJS ^ v12.20.0 || ^ v14.15.0 || >= v16.13.0
+- NodeJS ^ v12.20.0 \|\| ^ v14.15.0 \|\| >= v16.13.0
 
 ```sh
 npm install @hugoalh/github-sodium
 ```
 
-#### Use
-
 ```js
 /* Either */
 import { ... } from "@hugoalh/github-sodium";// Named Import
@@ -46,28 +41,16 @@ import githubSodium from "@hugoalh/github-sodium";// Default Import
 
 #### Class
 
-<ul>
-<li>
-
-```ts
-new GitHubSodiumSealer(publicKey: string): GitHubSodiumSealer;
-  .encrypt(value: string): string;
-```
-
-</li>
-</ul>
+- ```ts
+  new GitHubSodiumSealer(publicKey: string): GitHubSodiumSealer;
+    .encrypt(value: string): string;
+  ```
 
 #### Function
 
-<ul>
-<li>
-
-```ts
-seal(publicKey: string, value: string): string;
-```
-
-</li>
-</ul>
+- ```ts
+  seal(publicKey: string, value: string): string;
+  ```
 
 ### Example
 

package/dist/main.d.ts

@@ -1,5 +1,37 @@
-import GitHubSodiumSealer from "./github-sodium-sealer.js";
-import seal from "./seal.js";
+/**
+ * @class GitHubSodiumSealer
+ * @description Encrypt value to GitHub secret value.
+ */
+declare class GitHubSodiumSealer {
+    #private;
+    /**
+     * @constructor
+     * @param {string} publicKey Organization's or repository's public key, which need for encrypt value to secret value before create or update a secret.
+     */
+    constructor(publicKey: string);
+    /**
+     * @method encrypt
+     * @param {string} value Value that need to encrypt as secret value.
+     * @returns {string} An encrypted GitHub secret value.
+     */
+    encrypt(value: string): string;
+    /**
+     * @static seal
+     * @description Encrypt value to GitHub secret value.
+     * @param {string} publicKey Organization's or repository's public key, which need for encrypt value to secret value before create or update a secret.
+     * @param {string} value Value that need to encrypt as secret value.
+     * @returns {string} An encrypted GitHub secret value.
+     */
+    static seal(publicKey: string, value: string): string;
+}
+/**
+ * @function seal
+ * @description Encrypt value to GitHub secret value.
+ * @param {string} publicKey Organization's or repository's public key, which need for encrypt value to secret value before create or update a secret.
+ * @param {string} value Value that need to encrypt as secret value.
+ * @returns {string} An encrypted GitHub secret value.
+ */
+declare function seal(publicKey: string, value: string): string;
 export { GitHubSodiumSealer, seal };
 declare const _default: {
     GitHubSodiumSealer: typeof GitHubSodiumSealer;

package/dist/main.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":"AAAA,OAAO,kBAAkB,MAAM,2BAA2B,CAAC;AAC3D,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EACN,kBAAkB,EAClB,IAAI,EACJ,CAAC;;;;;AACF,wBAGE"}
+{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,cAAM,kBAAkB;;IAEvB;;;OAGG;gBACS,SAAS,EAAE,MAAM;IAS7B;;;;OAIG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAS9B;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM;CAGrD;AACD;;;;;;GAMG;AACH,iBAAS,IAAI,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAEtD;AACD,OAAO,EACN,kBAAkB,EAClB,IAAI,EACJ,CAAC;;;;;AACF,wBAGE"}

package/dist/main.js

@@ -1,5 +1,72 @@
-import GitHubSodiumSealer from "./github-sodium-sealer.js";
-import seal from "./seal.js";
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
+    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
+};
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _GitHubSodiumSealer_publicKeyBuffer;
+import libsodium from "libsodium-wrappers";
+await libsodium.ready;
+/**
+ * @class GitHubSodiumSealer
+ * @description Encrypt value to GitHub secret value.
+ */
+class GitHubSodiumSealer {
+    /**
+     * @constructor
+     * @param {string} publicKey Organization's or repository's public key, which need for encrypt value to secret value before create or update a secret.
+     */
+    constructor(publicKey) {
+        _GitHubSodiumSealer_publicKeyBuffer.set(this, void 0);
+        if (typeof publicKey !== "string") {
+            throw new TypeError(`Argument \`publicKey\` must be type of string!`);
+        }
+        if (!(publicKey.length > 0)) {
+            throw new Error(`Argument \`publicKey\` must be a string which is non-empty!`);
+        }
+        __classPrivateFieldSet(this, _GitHubSodiumSealer_publicKeyBuffer, Buffer.from(publicKey, "base64"), "f");
+    }
+    /**
+     * @method encrypt
+     * @param {string} value Value that need to encrypt as secret value.
+     * @returns {string} An encrypted GitHub secret value.
+     */
+    encrypt(value) {
+        if (typeof value !== "string") {
+            throw new TypeError(`Argument \`value\` must be type of string!`);
+        }
+        if (!(value.length > 0)) {
+            throw new Error(`Argument \`value\` must be a string which is non-empty!`);
+        }
+        return Buffer.from(libsodium.crypto_box_seal(Buffer.from(value), __classPrivateFieldGet(this, _GitHubSodiumSealer_publicKeyBuffer, "f"))).toString("base64");
+    }
+    /**
+     * @static seal
+     * @description Encrypt value to GitHub secret value.
+     * @param {string} publicKey Organization's or repository's public key, which need for encrypt value to secret value before create or update a secret.
+     * @param {string} value Value that need to encrypt as secret value.
+     * @returns {string} An encrypted GitHub secret value.
+     */
+    static seal(publicKey, value) {
+        return new this(publicKey).encrypt(value);
+    }
+}
+_GitHubSodiumSealer_publicKeyBuffer = new WeakMap();
+/**
+ * @function seal
+ * @description Encrypt value to GitHub secret value.
+ * @param {string} publicKey Organization's or repository's public key, which need for encrypt value to secret value before create or update a secret.
+ * @param {string} value Value that need to encrypt as secret value.
+ * @returns {string} An encrypted GitHub secret value.
+ */
+function seal(publicKey, value) {
+    return new GitHubSodiumSealer(publicKey).encrypt(value);
+}
 export { GitHubSodiumSealer, seal };
 export default {
     GitHubSodiumSealer,

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@hugoalh/github-sodium",
-	"version": "3.1.0",
+	"version": "3.1.2",
 	"description": "A module to provide an easier sodium for GitHub secrets.",
 	"keywords": [
 		"github",
@@ -23,17 +23,16 @@
 		"url": "git+https://github.com/hugoalh-studio/github-sodium-nodejs.git"
 	},
 	"dependencies": {
-		"@hugoalh/advanced-determine": "^10.2.1",
 		"libsodium-wrappers": "^0.7.11"
 	},
 	"devDependencies": {
 		"@types/libsodium-wrappers": "^0.7.10",
-		"@types/node": "^18.15.0",
-		"@typescript-eslint/eslint-plugin": "^5.54.1",
-		"@typescript-eslint/parser": "^5.54.1",
-		"eslint": "^8.36.0",
+		"@types/node": "^18.15.11",
+		"@typescript-eslint/eslint-plugin": "^5.59.0",
+		"@typescript-eslint/parser": "^5.59.0",
+		"eslint": "^8.38.0",
 		"eslint-plugin-only-warn": "^1.1.0",
-		"typescript": "^4.9.5"
+		"typescript": "^5.0.4"
 	},
 	"engines": {
 		"node": "^12.20.0 || ^14.15.0 || >=16.13.0"

package/dist/github-sodium-sealer.d.ts

@@ -1,28 +0,0 @@
-/**
- * @class GitHubSodiumSealer
- * @description Encrypt value to GitHub secret value.
- */
-declare class GitHubSodiumSealer {
-    #private;
-    /**
-     * @constructor
-     * @param {string} publicKey Organization's or repository's public key, which need for encrypt value to secret value before create or update a secret.
-     */
-    constructor(publicKey: string);
-    /**
-     * @method encrypt
-     * @param {string} value Value that need to encrypt as secret value.
-     * @returns {string} An encrypted GitHub secret value.
-     */
-    encrypt(value: string): string;
-    /**
-     * @static seal
-     * @description Encrypt value to GitHub secret value.
-     * @param {string} publicKey Organization's or repository's public key, which need for encrypt value to secret value before create or update a secret.
-     * @param {string} value Value that need to encrypt as secret value.
-     * @returns {string} An encrypted GitHub secret value.
-     */
-    static seal(publicKey: string, value: string): string;
-}
-export default GitHubSodiumSealer;
-//# sourceMappingURL=github-sodium-sealer.d.ts.map

package/dist/github-sodium-sealer.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"github-sodium-sealer.d.ts","sourceRoot":"","sources":["../src/github-sodium-sealer.ts"],"names":[],"mappings":"AAIA;;;GAGG;AACH,cAAM,kBAAkB;;IAEvB;;;OAGG;gBACS,SAAS,EAAE,MAAM;IAM7B;;;;OAIG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAM9B;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM;CAGrD;AACD,eAAe,kBAAkB,CAAC"}

package/dist/github-sodium-sealer.js

@@ -1,56 +0,0 @@
-var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
-    if (kind === "m") throw new TypeError("Private method is not writable");
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
-    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
-};
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
-};
-var _GitHubSodiumSealer_publicKeyStorage;
-import { StringItemFilter } from "@hugoalh/advanced-determine";
-import libsodium from "libsodium-wrappers";
-await libsodium.ready;
-const stringFilter = new StringItemFilter();
-/**
- * @class GitHubSodiumSealer
- * @description Encrypt value to GitHub secret value.
- */
-class GitHubSodiumSealer {
-    /**
-     * @constructor
-     * @param {string} publicKey Organization's or repository's public key, which need for encrypt value to secret value before create or update a secret.
-     */
-    constructor(publicKey) {
-        _GitHubSodiumSealer_publicKeyStorage.set(this, void 0);
-        if (!stringFilter.test(publicKey)) {
-            throw new TypeError(`Argument \`publicKey\` must be type of string (non-empty)!`);
-        }
-        __classPrivateFieldSet(this, _GitHubSodiumSealer_publicKeyStorage, Buffer.from(publicKey, "base64"), "f");
-    }
-    /**
-     * @method encrypt
-     * @param {string} value Value that need to encrypt as secret value.
-     * @returns {string} An encrypted GitHub secret value.
-     */
-    encrypt(value) {
-        if (!stringFilter.test(value)) {
-            throw new TypeError(`Argument \`value\` must be type of string (non-empty)!`);
-        }
-        return Buffer.from(libsodium.crypto_box_seal(Buffer.from(value), __classPrivateFieldGet(this, _GitHubSodiumSealer_publicKeyStorage, "f"))).toString("base64");
-    }
-    /**
-     * @static seal
-     * @description Encrypt value to GitHub secret value.
-     * @param {string} publicKey Organization's or repository's public key, which need for encrypt value to secret value before create or update a secret.
-     * @param {string} value Value that need to encrypt as secret value.
-     * @returns {string} An encrypted GitHub secret value.
-     */
-    static seal(publicKey, value) {
-        return new this(publicKey).encrypt(value);
-    }
-}
-_GitHubSodiumSealer_publicKeyStorage = new WeakMap();
-export default GitHubSodiumSealer;

package/dist/seal.d.ts

@@ -1,10 +0,0 @@
-/**
- * @function seal
- * @description Encrypt value to GitHub secret value.
- * @param {string} publicKey Organization's or repository's public key, which need for encrypt value to secret value before create or update a secret.
- * @param {string} value Value that need to encrypt as secret value.
- * @returns {string} An encrypted GitHub secret value.
- */
-declare function seal(publicKey: string, value: string): string;
-export default seal;
-//# sourceMappingURL=seal.d.ts.map

package/dist/seal.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"seal.d.ts","sourceRoot":"","sources":["../src/seal.ts"],"names":[],"mappings":"AACA;;;;;;GAMG;AACH,iBAAS,IAAI,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAEtD;AACD,eAAe,IAAI,CAAC"}

package/dist/seal.js

@@ -1,12 +0,0 @@
-import GitHubSodiumSealer from "./github-sodium-sealer.js";
-/**
- * @function seal
- * @description Encrypt value to GitHub secret value.
- * @param {string} publicKey Organization's or repository's public key, which need for encrypt value to secret value before create or update a secret.
- * @param {string} value Value that need to encrypt as secret value.
- * @returns {string} An encrypted GitHub secret value.
- */
-function seal(publicKey, value) {
-    return new GitHubSodiumSealer(publicKey).encrypt(value);
-}
-export default seal;