@hugoalh/github-sodium 2.0.3 → 3.0.1

package/README.md

@@ -20,7 +20,7 @@
 
 A NodeJS module to provide an easier sodium for GitHub secrets.
 
-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 secrets.
+This project is based on `libsodium.js` ([GitHub](https://github.com/jedisct1/libsodium.js))([NPM](https://www.npmjs.com/package/libsodium)) with optimization for GitHub secrets.
 
 ## 📚 Documentation
 
@@ -28,7 +28,7 @@ This project is based on `libsodium.js` ([GitHub](https://github.com/jedisct1/li
 
 #### Install
 
-- NodeJS >= v10.13.0
+- NodeJS ^ v12.20.0 || ^ v14.15.0 || >= v16.13.0
 
 ```sh
 npm install @hugoalh/github-sodium
@@ -36,14 +36,6 @@ npm install @hugoalh/github-sodium
 
 #### Use
 
-##### CommonJS
-
-```js
-const githubSodium = require("@hugoalh/github-sodium");
-```
-
-##### ModuleJS
-
 ```js
 /* Either */
 import * as githubSodium from "@hugoalh/github-sodium";// All

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

@@ -1,4 +1,4 @@
-export = GitHubSodiumSealer;
+export default GitHubSodiumSealer;
 /**
  * @class GitHubSodiumSealer
  * @description Encrypt value to GitHub secret value.

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

@@ -1 +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"}
+{"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,5 +1,6 @@
-const advancedDetermine = require("@hugoalh/advanced-determine");
-const tweetsodium = require("tweetsodium");
+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.
@@ -11,7 +12,7 @@ class GitHubSodiumSealer {
 	 * @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 })) {
+		if (!adIsString(publicKey, { empty: false })) {
 			throw new TypeError(`Argument \`publicKey\` must be type of string (non-empty)!`);
 		}
 		this.#publicKeyStorage = Buffer.from(publicKey, "base64");
@@ -22,10 +23,10 @@ class GitHubSodiumSealer {
 	 * @returns {string} An encrypted GitHub secret value.
 	 */
 	encrypt(value) {
-		if (!advancedDetermine.isString(value, { empty: false })) {
+		if (!adIsString(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");
+		return Buffer.from(libsodium.crypto_box_seal(Buffer.from(value), this.#publicKeyStorage)).toString("base64");
 	}
 }
-module.exports = GitHubSodiumSealer;
+export default GitHubSodiumSealer;

package/lib/main.d.ts

@@ -1,4 +1,9 @@
-import GitHubSodiumSealer = require("./github-sodium-sealer.js");
-import seal = require("./seal.js");
+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 };
 //# sourceMappingURL=main.d.ts.map

package/lib/main.js

@@ -1,6 +1,10 @@
-const GitHubSodiumSealer = require("./github-sodium-sealer.js");
-const seal = require("./seal.js");
-module.exports = {
+import GitHubSodiumSealer from "./github-sodium-sealer.js";
+import seal from "./seal.js";
+export {
+	GitHubSodiumSealer,
+	seal
+};
+export default {
 	GitHubSodiumSealer,
 	seal
 };

package/lib/seal.d.ts

@@ -1,4 +1,4 @@
-export = seal;
+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.

package/lib/seal.js

@@ -1,4 +1,4 @@
-const GitHubSodiumSealer = require("./github-sodium-sealer.js");
+import GitHubSodiumSealer from "./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.
@@ -8,4 +8,4 @@ const GitHubSodiumSealer = require("./github-sodium-sealer.js");
 function seal(publicKey, value) {
 	return new GitHubSodiumSealer(publicKey).encrypt(value);
 }
-module.exports = seal;
+export default seal;

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@hugoalh/github-sodium",
-	"version": "2.0.3",
-	"description": "A module to provide an easier sodium for GitHub secret.",
+	"version": "3.0.1",
+	"description": "A module to provide an easier sodium for GitHub secrets.",
 	"keywords": [
 		"github",
 		"sodium"
@@ -12,11 +12,10 @@
 	},
 	"license": "MIT",
 	"author": "hugoalh",
+	"type": "module",
 	"main": "./lib/main.js",
-	"module": "./lib/main.mjs",
 	"exports": {
-		"import": "./lib/main.mjs",
-		"require": "./lib/main.js"
+		"import": "./lib/main.js"
 	},
 	"types": "./lib/main.d.ts",
 	"repository": {
@@ -25,8 +24,7 @@
 	},
 	"dependencies": {
 		"@hugoalh/advanced-determine": "^7.2.0",
-		"libsodium-wrappers": "^0.7.10",
-		"tweetsodium": "0.0.5"
+		"libsodium-wrappers": "^0.7.10"
 	},
 	"devDependencies": {
 		"@types/libsodium-wrappers": "^0.7.10",
@@ -36,7 +34,7 @@
 		"typescript": "^4.8.4"
 	},
 	"engines": {
-		"node": ">=10.13.0"
+		"node": "^12.20.0 || ^14.15.0 || >=16.13.0"
 	},
 	"private": false
 }

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

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

@@ -1 +0,0 @@
-{"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.mjs

@@ -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.mts

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

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

package/lib/main.mjs

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

package/lib/seal.d.mts

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

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

package/lib/seal.mjs

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