@hugoalh/github-sodium 1.1.4 → 2.0.0-beta.1

package/@types/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/@types/github-sodium-sealer.d.mts.map

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

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

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

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

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

package/@types/main.d.ts

@@ -1,9 +1,5 @@
-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;
+import GitHubSodiumSealer = require("./github-sodium-sealer.js");
+import seal = require("./seal.js");
+export const version: 1;
+export { GitHubSodiumSealer, seal, version as v, version as ver };
+//# sourceMappingURL=main.d.ts.map

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

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

package/@types/seal.d.mts

@@ -0,0 +1,9 @@
+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/@types/seal.d.mts.map

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

package/@types/seal.d.ts

@@ -0,0 +1,9 @@
+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/@types/seal.d.ts.map

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

package/LICENSE.md

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

package/README.md

@@ -1,4 +1,4 @@
-# GitHub Sodium (NodeJS Edition)
+# GitHub Sodium (NodeJS)
 
 [`GitHubSodium.NodeJS`](https://github.com/hugoalh-studio/github-sodium-nodejs)
 [![GitHub Contributors](https://img.shields.io/github/contributors/hugoalh-studio/github-sodium-nodejs?label=Contributors&logo=github&logoColor=ffffff&style=flat-square)](https://github.com/hugoalh-studio/github-sodium-nodejs/graphs/contributors)
@@ -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 LibSodiumJS ([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.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 {
+	#publicKey;
+	/**
+	 * @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.#publicKey = publicKey;
+	};
+	/**
+	 * @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), Buffer.from(this.#publicKey, "base64"))).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 {
+	#publicKey;
+	/**
+	 * @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.#publicKey = publicKey;
+	};
+	/**
+	 * @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), Buffer.from(this.#publicKey, "base64"))).toString("base64");
+	};
+};
+export default GitHubSodiumSealer;

package/lib/main.js

@@ -1,24 +1,10 @@
-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-nullable)!`);
-	};
-	if (
-		typeof value !== "string" ||
-		value.length === 0
-	) {
-		throw new TypeError(`Argument \`value\` must be type of string (non-nullable)!`);
-	};
-	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");
+const version = 1;
+module.exports = {
+	GitHubSodiumSealer,
+	seal,
+	v: version,
+	ver: version,
+	version
 };
-module.exports = githubSodium;

package/lib/main.mjs

@@ -1,24 +1,17 @@
-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-nullable)!`);
-	};
-	if (
-		typeof value !== "string" ||
-		value.length === 0
-	) {
-		throw new TypeError(`Argument \`value\` must be type of string (non-nullable)!`);
-	};
-	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";
+const version = 1;
+export {
+	GitHubSodiumSealer,
+	seal,
+	version as v,
+	version as ver,
+	version
+};
+export default {
+	GitHubSodiumSealer,
+	seal,
+	v: version,
+	ver: version,
+	version
 };
-export default githubSodium;

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.4",
+	"version": "2.0.0-beta.1",
 	"description": "A module to provide an easier sodium for GitHub secret.",
 	"keywords": [
 		"github",
@@ -24,7 +24,10 @@
 		"url": "git+https://github.com/hugoalh-studio/github-sodium-nodejs.git"
 	},
 	"dependencies": {
-		"tweetsodium": "^0.0.5"
+		"@hugoalh/advanced-determine": "^7.0.2",
+		"@types/libsodium-wrappers": "^0.7.9",
+		"libsodium-wrappers": "^0.7.10",
+		"tweetsodium": "^0.0.6"
 	},
 	"engines": {
 		"node": ">= 14.15.0",