@hugoalh/github-sodium 3.0.2 → 3.1.0

package/README.md

@@ -37,9 +37,9 @@ npm install @hugoalh/github-sodium
 
 ```js
 /* Either */
-import * as githubSodium from "@hugoalh/github-sodium";// All
-import githubSodium from "@hugoalh/github-sodium";// All (>= v2.0.0)
-import { ... } from "@hugoalh/github-sodium";// Part / Tree-shake
+import { ... } from "@hugoalh/github-sodium";// Named Import
+import * as githubSodium from "@hugoalh/github-sodium";// Namespace Import
+import githubSodium from "@hugoalh/github-sodium";// Default Import
 ```
 
 ### API
@@ -50,8 +50,8 @@ import { ... } from "@hugoalh/github-sodium";// Part / Tree-shake
 <li>
 
 ```ts
-GitHubSodiumSealer(publicKey: string): GitHubSodiumSealer;
-GitHubSodiumSealer.encrypt(value: string): string;
+new GitHubSodiumSealer(publicKey: string): GitHubSodiumSealer;
+  .encrypt(value: string): string;
 ```
 
 </li>

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

@@ -10,11 +10,19 @@ declare class GitHubSodiumSealer {
      */
     constructor(publicKey: string);
     /**
-     * @method
+     * @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 +1 @@
-{"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;CAM9B;AACD,eAAe,kBAAkB,CAAC"}
+{"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

@@ -31,7 +31,7 @@ class GitHubSodiumSealer {
         __classPrivateFieldSet(this, _GitHubSodiumSealer_publicKeyStorage, Buffer.from(publicKey, "base64"), "f");
     }
     /**
-     * @method
+     * @method encrypt
      * @param {string} value Value that need to encrypt as secret value.
      * @returns {string} An encrypted GitHub secret value.
      */
@@ -41,6 +41,16 @@ class GitHubSodiumSealer {
         }
         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,5 +1,6 @@
 /**
  * @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.

package/dist/seal.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"seal.d.ts","sourceRoot":"","sources":["../src/seal.ts"],"names":[],"mappings":"AACA;;;;;GAKG;AACH,iBAAS,IAAI,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAEtD;AACD,eAAe,IAAI,CAAC"}
+{"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,6 +1,7 @@
 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.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@hugoalh/github-sodium",
-	"version": "3.0.2",
+	"version": "3.1.0",
 	"description": "A module to provide an easier sodium for GitHub secrets.",
 	"keywords": [
 		"github",
@@ -23,15 +23,15 @@
 		"url": "git+https://github.com/hugoalh-studio/github-sodium-nodejs.git"
 	},
 	"dependencies": {
-		"@hugoalh/advanced-determine": "^10.0.0",
+		"@hugoalh/advanced-determine": "^10.2.1",
 		"libsodium-wrappers": "^0.7.11"
 	},
 	"devDependencies": {
 		"@types/libsodium-wrappers": "^0.7.10",
-		"@types/node": "^18.14.1",
-		"@typescript-eslint/eslint-plugin": "^5.53.0",
-		"@typescript-eslint/parser": "^5.53.0",
-		"eslint": "^8.34.0",
+		"@types/node": "^18.15.0",
+		"@typescript-eslint/eslint-plugin": "^5.54.1",
+		"@typescript-eslint/parser": "^5.54.1",
+		"eslint": "^8.36.0",
 		"eslint-plugin-only-warn": "^1.1.0",
 		"typescript": "^4.9.5"
 	},