@hugoalh/github-sodium 3.0.1 → 3.1.0

package/LICENSE.md

@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright © 2020\~2022 hugoalh Studio
+Copyright © 2020\~2023 hugoalh Studio
 
 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:
 

package/README.md

@@ -2,7 +2,6 @@
 
 [`GitHubSodium.NodeJS`](https://github.com/hugoalh-studio/github-sodium-nodejs)
 
-![NodeJS](https://img.shields.io/badge/NodeJS-339933?logo=nodedotjs&logoColor=ffffff&style=flat-square "NodeJS")
 ![License](https://img.shields.io/static/v1?label=License&message=MIT&style=flat-square "License")
 [![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)
@@ -38,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
@@ -48,24 +47,15 @@ import { ... } from "@hugoalh/github-sodium";// Part / Tree-shake
 #### Class
 
 <ul>
-<li><code>GitHubSodiumSealer</code></li>
-<ul>
-<li>
-
-```ts
-@constructor(publicKey: string): GitHubSodiumSealer
-```
-
-</li>
 <li>
 
 ```ts
-encrypt(value: string): string
+new GitHubSodiumSealer(publicKey: string): GitHubSodiumSealer;
+  .encrypt(value: string): string;
 ```
 
 </li>
 </ul>
-</ul>
 
 #### Function
 
@@ -73,7 +63,7 @@ encrypt(value: string): string
 <li>
 
 ```ts
-seal(publicKey: string, value: string): string
+seal(publicKey: string, value: string): string;
 ```
 
 </li>

package/{lib → dist}/github-sodium-sealer.d.ts

@@ -1,20 +1,28 @@
-export default GitHubSodiumSealer;
 /**
  * @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
+     * @method encrypt
      * @param {string} value Value that need to encrypt as secret value.
      * @returns {string} An encrypted GitHub secret value.
      */
     encrypt(value: string): string;
-    #private;
+    /**
+     * @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

@@ -0,0 +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;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

@@ -0,0 +1,56 @@
+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/{lib → dist}/main.d.ts

@@ -1,9 +1,9 @@
-declare namespace _default {
-    export { GitHubSodiumSealer };
-    export { seal };
-}
-export default _default;
 import GitHubSodiumSealer from "./github-sodium-sealer.js";
 import seal from "./seal.js";
 export { GitHubSodiumSealer, seal };
+declare const _default: {
+    GitHubSodiumSealer: typeof GitHubSodiumSealer;
+    seal: typeof seal;
+};
+export default _default;
 //# sourceMappingURL=main.d.ts.map

package/dist/main.d.ts.map

@@ -0,0 +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"}

package/{lib → dist}/main.js

@@ -1,10 +1,7 @@
 import GitHubSodiumSealer from "./github-sodium-sealer.js";
 import seal from "./seal.js";
-export {
-	GitHubSodiumSealer,
-	seal
-};
+export { GitHubSodiumSealer, seal };
 export default {
-	GitHubSodiumSealer,
-	seal
+    GitHubSodiumSealer,
+    seal
 };

package/{lib → dist}/seal.d.ts

@@ -1,9 +1,10 @@
-export default seal;
 /**
  * @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

@@ -0,0 +1 @@
+{"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/{lib → dist}/seal.js

@@ -1,11 +1,12 @@
 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);
+    return new GitHubSodiumSealer(publicKey).encrypt(value);
 }
 export default seal;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@hugoalh/github-sodium",
-	"version": "3.0.1",
+	"version": "3.1.0",
 	"description": "A module to provide an easier sodium for GitHub secrets.",
 	"keywords": [
 		"github",
@@ -13,25 +13,27 @@
 	"license": "MIT",
 	"author": "hugoalh",
 	"type": "module",
-	"main": "./lib/main.js",
+	"main": "./dist/main.js",
 	"exports": {
-		"import": "./lib/main.js"
+		"import": "./dist/main.js"
 	},
-	"types": "./lib/main.d.ts",
+	"types": "./dist/main.d.ts",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/hugoalh-studio/github-sodium-nodejs.git"
 	},
 	"dependencies": {
-		"@hugoalh/advanced-determine": "^7.2.0",
-		"libsodium-wrappers": "^0.7.10"
+		"@hugoalh/advanced-determine": "^10.2.1",
+		"libsodium-wrappers": "^0.7.11"
 	},
 	"devDependencies": {
 		"@types/libsodium-wrappers": "^0.7.10",
-		"@types/node": "^18.8.4",
-		"eslint": "^8.25.0",
-		"eslint-plugin-only-warn": "^1.0.3",
-		"typescript": "^4.8.4"
+		"@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"
 	},
 	"engines": {
 		"node": "^12.20.0 || ^14.15.0 || >=16.13.0"

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

@@ -1 +0,0 @@
-{"version":3,"file":"github-sodium-sealer.d.ts","sourceRoot":"","sources":["github-sodium-sealer.js"],"names":[],"mappings":";AAGA;;;GAGG;AACH;IAEC;;;OAGG;IACH,uBAFW,MAAM,EAOhB;IACD;;;;OAIG;IACH,eAHW,MAAM,GACJ,MAAM,CAOlB;;CACD"}

package/lib/github-sodium-sealer.js

@@ -1,32 +0,0 @@
-import { isString as adIsString } from "@hugoalh/advanced-determine";
-import libsodium from "libsodium-wrappers";
-await libsodium.ready;
-/**
- * @class GitHubSodiumSealer
- * @description Encrypt value to GitHub secret value.
- */
-class GitHubSodiumSealer {
-	#publicKeyStorage;
-	/**
-	 * @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) {
-		if (!adIsString(publicKey, { empty: false })) {
-			throw new TypeError(`Argument \`publicKey\` must be type of string (non-empty)!`);
-		}
-		this.#publicKeyStorage = Buffer.from(publicKey, "base64");
-	}
-	/**
-	 * @method
-	 * @param {string} value Value that need to encrypt as secret value.
-	 * @returns {string} An encrypted GitHub secret value.
-	 */
-	encrypt(value) {
-		if (!adIsString(value, { empty: false })) {
-			throw new TypeError(`Argument \`value\` must be type of string (non-empty)!`);
-		}
-		return Buffer.from(libsodium.crypto_box_seal(Buffer.from(value), this.#publicKeyStorage)).toString("base64");
-	}
-}
-export default GitHubSodiumSealer;

package/lib/main.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["main.js"],"names":[],"mappings":""}

package/lib/seal.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"seal.d.ts","sourceRoot":"","sources":["seal.js"],"names":[],"mappings":";AACA;;;;;GAKG;AACH,iCAJW,MAAM,SACN,MAAM,GACJ,MAAM,CAIlB"}