@hugoalh/github-sodium 1.1.6 → 2.0.1

package/LICENSE.md

@@ -1,27 +1,35 @@
 # MIT License
 
-© 2020 hugoalh Studio
+Copyright © 2020\~2022 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:
 
 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.
+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.
 
 ---
 
-*This is a short and simple list that mostly concluded this license about the permissions 🟢, conditions 🔵, and limitations 🔴, this license content section shall prevail.*
-
-- Commercial Use 🟢
-- Distribution 🟢
-- Modification 🟢
-- Patent Use
-- Private Use 🟢
-- Disclose Source
-- License & Copyright Notice 🔵
-- Network Use Is Distribution
-- Same License
-- State Changes
-- Liability 🔴
-- Trademark Use
-- Warranty 🔴
+## TLDR
+
+This is a short and simple list that mostly concluded this license about the permissions, conditions, and limitations, this license content section shall prevail.
+
+### Permissions
+
+- **Commercial Use:** The licensed material and derivatives may be used for commercial purposes.
+- **Distribution:** The licensed material may be distributed.
+- **Modification:** The licensed material may be modified.
+- **Private Use:** The licensed material may be used and modified in private.
+
+### Conditions
+
+- **License & Copyright Notice:** A copy of the license and copyright notice must be included with the licensed material.
+
+### Limitations
+
+- **Liability:** This license includes a limitation of liability.
+- **Warranty:** This license explicitly states that it does not provide any warranty.
+
+## Attribution
+
+This license is adopted from [Choose A License](https://choosealicense.com/), available at [here](https://choosealicense.com/licenses/mit).

package/README.md

@@ -11,7 +11,7 @@
 [![CodeFactor Grade](https://img.shields.io/codefactor/grade/github/hugoalh-studio/github-sodium-nodejs?label=Grade&logo=codefactor&logoColor=ffffff&style=flat-square)](https://www.codefactor.io/repository/github/hugoalh-studio/github-sodium-nodejs)
 [![LGTM Alerts](https://img.shields.io/lgtm/alerts/g/hugoalh-studio/github-sodium-nodejs?label=Alerts&logo=lgtm&logoColor=ffffff&style=flat-square)
 ![LGTM Grade](https://img.shields.io/lgtm/grade/javascript/g/hugoalh-studio/github-sodium-nodejs?label=Grade&logo=lgtm&logoColor=ffffff&style=flat-square)](https://lgtm.com/projects/g/hugoalh-studio/github-sodium-nodejs)
-[![License](https://img.shields.io/static/v1?label=License&message=MIT&color=brightgreen&style=flat-square)](./LICENSE.md)
+[![License](https://img.shields.io/static/v1?label=License&message=MIT&style=flat-square)](./LICENSE.md)
 
 | **Release** | **Latest** (![GitHub Latest Release Date](https://img.shields.io/github/release-date/hugoalh-studio/github-sodium-nodejs?label=%20&style=flat-square)) | **Pre** (![GitHub Latest Pre-Release Date](https://img.shields.io/github/release-date-pre/hugoalh-studio/github-sodium-nodejs?label=%20&style=flat-square)) |
 |:-:|:-:|:-:|
@@ -22,7 +22,7 @@
 
 A NodeJS module to provide an easier sodium for GitHub secret.
 
-This project is based on TweetSodium ([GitHub](https://github.com/github/tweetsodium))([NPM](https://www.npmjs.com/package/tweetsodium)) with optimization for GitHub secret.
+This project is based on `libsodium.js` ([GitHub](https://github.com/jedisct1/libsodium.js))([NPM](https://www.npmjs.com/package/libsodium))(for ModuleJS) and `tweetsodium` ([GitHub](https://github.com/github/tweetsodium))([NPM](https://www.npmjs.com/package/tweetsodium))(for CommonJS) with optimization for GitHub secret.
 
 ## 📚 Documentation
 
@@ -30,7 +30,8 @@ This project is based on TweetSodium ([GitHub](https://github.com/github/tweetso
 
 #### Install
 
-NodeJS (>= v14.15.0) + NPM (>= v6.14.8):
+- NodeJS >= v14.15.0
+- NPM >= v6.14.8
 
 ```sh
 npm install @hugoalh/github-sodium
@@ -45,21 +46,27 @@ const githubSodium = require("@hugoalh/github-sodium");
 #### Use In ModuleJS
 
 ```js
-import githubSodium from "@hugoalh/github-sodium";
+/* 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
 ```
 
 ### API
 
-```ts
-githubSodium(// Encrypt value to GitHub secret value.
-  publicKey: string,// Organization's or repository's public key, which need for encrypt value to secret value before create or update a secret.
-  value: string// Value that need to encrypt as secret value.
-): string// An encrypted GitHub secret value.
-```
+#### Class
+
+- `GitHubSodiumSealer`
+  - `@constructor(publicKey)`
+  - `encrypt(value)`
+
+#### Function
+
+- `seal(publicKey, value)`
 
 ### Example
 
 ```js
-githubSodium("base64-encoded-public-key", "plain-text-secret");
+new GitHubSodiumSealer("base64-encoded-public-key").encrypt("plain-text-secret");
 //=> "+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0="
 ```

package/lib/github-sodium-sealer.d.mts

@@ -0,0 +1,20 @@
+export default GitHubSodiumSealer;
+/**
+ * @class GitHubSodiumSealer
+ * @description Encrypt value to GitHub secret value.
+ */
+declare 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: string);
+    /**
+     * @method
+     * @param {string} value Value that need to encrypt as secret value.
+     * @returns {string} An encrypted GitHub secret value.
+     */
+    encrypt(value: string): string;
+    #private;
+}
+//# sourceMappingURL=github-sodium-sealer.d.mts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"github-sodium-sealer.d.mts","sourceRoot":"","sources":["github-sodium-sealer.mjs"],"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.d.ts

@@ -0,0 +1,20 @@
+export = GitHubSodiumSealer;
+/**
+ * @class GitHubSodiumSealer
+ * @description Encrypt value to GitHub secret value.
+ */
+declare 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: string);
+    /**
+     * @method
+     * @param {string} value Value that need to encrypt as secret value.
+     * @returns {string} An encrypted GitHub secret value.
+     */
+    encrypt(value: string): string;
+    #private;
+}
+//# sourceMappingURL=github-sodium-sealer.d.ts.map

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

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

package/lib/github-sodium-sealer.js

@@ -0,0 +1,31 @@
+const advancedDetermine = require("@hugoalh/advanced-determine");
+const tweetsodium = require("tweetsodium");
+/**
+ * @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 (!advancedDetermine.isString(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 (!advancedDetermine.isString(value, { empty: false })) {
+			throw new TypeError(`Argument \`value\` must be type of string (non-empty)!`);
+		};
+		return Buffer.from(tweetsodium.seal(Buffer.from(value), this.#publicKeyStorage)).toString("base64");
+	};
+};
+module.exports = GitHubSodiumSealer;

package/lib/github-sodium-sealer.mjs

@@ -0,0 +1,32 @@
+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.mts

@@ -0,0 +1,9 @@
+declare namespace _default {
+    export { GitHubSodiumSealer };
+    export { seal };
+}
+export default _default;
+import GitHubSodiumSealer from "./github-sodium-sealer.mjs";
+import seal from "./seal.mjs";
+export { GitHubSodiumSealer, seal };
+//# sourceMappingURL=main.d.mts.map

package/lib/main.d.mts.map

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

package/lib/main.d.ts

@@ -0,0 +1,4 @@
+import GitHubSodiumSealer = require("./github-sodium-sealer.js");
+import seal = require("./seal.js");
+export { GitHubSodiumSealer, seal };
+//# sourceMappingURL=main.d.ts.map

package/lib/main.d.ts.map

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

package/lib/main.js

@@ -1,24 +1,6 @@
-const sodium = require("tweetsodium");
-/**
- * @function githubSodium
- * @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 githubSodium(publicKey, value) {
-	if (
-		typeof publicKey !== "string" ||
-		publicKey.length === 0
-	) {
-		throw new TypeError(`Argument \`publicKey\` must be type of string (non-empty)!`);
-	};
-	if (
-		typeof value !== "string" ||
-		value.length === 0
-	) {
-		throw new TypeError(`Argument \`value\` must be type of string (non-empty)!`);
-	};
-	return Buffer.from(sodium.seal(Buffer.from(value), Buffer.from(publicKey, "base64"))).toString("base64");
+const GitHubSodiumSealer = require("./github-sodium-sealer.js");
+const seal = require("./seal.js");
+module.exports = {
+	GitHubSodiumSealer,
+	seal
 };
-module.exports = githubSodium;

package/lib/main.mjs

@@ -1,24 +1,10 @@
-import * as sodium from "tweetsodium";
-/**
- * @function githubSodium
- * @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 githubSodium(publicKey, value) {
-	if (
-		typeof publicKey !== "string" ||
-		publicKey.length === 0
-	) {
-		throw new TypeError(`Argument \`publicKey\` must be type of string (non-empty)!`);
-	};
-	if (
-		typeof value !== "string" ||
-		value.length === 0
-	) {
-		throw new TypeError(`Argument \`value\` must be type of string (non-empty)!`);
-	};
-	return Buffer.from(sodium.seal(Buffer.from(value), Buffer.from(publicKey, "base64"))).toString("base64");
+import GitHubSodiumSealer from "./github-sodium-sealer.mjs";
+import seal from "./seal.mjs";
+export {
+	GitHubSodiumSealer,
+	seal
+};
+export default {
+	GitHubSodiumSealer,
+	seal
 };
-export default githubSodium;

package/{@types/main.d.ts → lib/seal.d.mts}

@@ -1,10 +1,9 @@
-export = githubSodium;
-/**
- * @function githubSodium
- * @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 githubSodium(publicKey: string, value: string): string;
-//# sourceMappingURL=main.d.ts.map
+export default seal;
+/**
+ * @function seal
+ * @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;
+//# sourceMappingURL=seal.d.mts.map

package/lib/seal.d.mts.map

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

package/{@types/main.d.mts → lib/seal.d.ts}

@@ -1,10 +1,9 @@
-export default githubSodium;
-/**
- * @function githubSodium
- * @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 githubSodium(publicKey: string, value: string): string;
-//# sourceMappingURL=main.d.mts.map
+export = seal;
+/**
+ * @function seal
+ * @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;
+//# sourceMappingURL=seal.d.ts.map

package/lib/seal.d.ts.map

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

package/lib/seal.js

@@ -0,0 +1,11 @@
+const GitHubSodiumSealer = require("./github-sodium-sealer.js");
+/**
+ * @function seal
+ * @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);
+};
+module.exports = seal;

package/lib/seal.mjs

@@ -0,0 +1,11 @@
+import GitHubSodiumSealer from "./github-sodium-sealer.mjs";
+/**
+ * @function seal
+ * @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;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@hugoalh/github-sodium",
-	"version": "1.1.6",
+	"version": "2.0.1",
 	"description": "A module to provide an easier sodium for GitHub secret.",
 	"keywords": [
 		"github",
@@ -18,13 +18,18 @@
 		"import": "./lib/main.mjs",
 		"require": "./lib/main.js"
 	},
-	"types": "./@types/main.d.ts",
+	"types": "./lib/main.d.ts",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/hugoalh-studio/github-sodium-nodejs.git"
 	},
 	"dependencies": {
-		"tweetsodium": "^0.0.5"
+		"@hugoalh/advanced-determine": "^7.1.3",
+		"libsodium-wrappers": "^0.7.10",
+		"tweetsodium": "^0.0.6"
+	},
+	"devDependencies": {
+		"@types/libsodium-wrappers": "^0.7.9"
 	},
 	"engines": {
 		"node": ">= 14.15.0",

package/@types/main.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"main.d.mts","sourceRoot":"","sources":["../lib/main.mjs"],"names":[],"mappings":";AACA;;;;;;GAMG;AACH,yCAJW,MAAM,SACN,MAAM,GACJ,MAAM,CAgBlB"}

package/@types/main.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"main.d.ts","sourceRoot":"","sources":["../lib/main.js"],"names":[],"mappings":";AACA;;;;;;GAMG;AACH,yCAJW,MAAM,SACN,MAAM,GACJ,MAAM,CAgBlB"}