@hugoalh/github-sodium 5.0.3 → 5.1.0

package/LICENSE.md

@@ -1,6 +1,6 @@
 # MIT License
 
-Copyright © 2020\~2024 hugoalh Studio
+Copyright © 2020\~2024 hugoalh
 
 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,161 +2,82 @@
 
 [**⚖️** MIT](./LICENSE.md)
 
-[![GitHub: hugoalh-studio/github-sodium-es](https://img.shields.io/github/v/release/hugoalh-studio/github-sodium-es?label=hugoalh-studio/github-sodium-es&labelColor=181717&logo=github&logoColor=ffffff&sort=semver&style=flat "GitHub: hugoalh-studio/github-sodium-es")](https://github.com/hugoalh-studio/github-sodium-es)
-[![JSR: @hugoalh/github-sodium](https://img.shields.io/jsr/v/@hugoalh/github-sodium?label=JSR%20@hugoalh/github-sodium&labelColor=F7DF1E&logoColor=000000&style=flat "JSR: @hugoalh/github-sodium")](https://jsr.io/@hugoalh/github-sodium)
+[![GitHub: hugoalh/github-sodium-es](https://img.shields.io/github/v/release/hugoalh/github-sodium-es?label=hugoalh/github-sodium-es&labelColor=181717&logo=github&logoColor=ffffff&sort=semver&style=flat "GitHub: hugoalh/github-sodium-es")](https://github.com/hugoalh/github-sodium-es)
+[![JSR: @hugoalh/github-sodium](https://img.shields.io/jsr/v/@hugoalh/github-sodium?label=@hugoalh/github-sodium&labelColor=F7DF1E&logo=jsr&logoColor=000000&style=flat "JSR: @hugoalh/github-sodium")](https://jsr.io/@hugoalh/github-sodium)
 [![NPM: @hugoalh/github-sodium](https://img.shields.io/npm/v/@hugoalh/github-sodium?label=@hugoalh/github-sodium&labelColor=CB3837&logo=npm&logoColor=ffffff&style=flat "NPM: @hugoalh/github-sodium")](https://www.npmjs.com/package/@hugoalh/github-sodium)
 
-An ES (JavaScript & TypeScript) module to provide an easier sodium for GitHub secrets.
+An ES (JavaScript & TypeScript) module to provide an easier and simplified method for encrypt GitHub secrets, based on the NPM package [`libsodium.js`](https://www.npmjs.com/package/libsodium-wrappers).
 
-This project is based on "[libsodium.js](https://github.com/jedisct1/libsodium.js)" with optimization for GitHub secrets.
+## 🔰 Begin
 
-## 🎯 Target
+### 🎯 Targets
 
-- Bun ^ v1.0.0
-- Cloudflare Workers
-- Deno >= v1.34.0 / >= v1.41.1 (For JSR Only)
-  > **🛡️ Require Permission**
-  >
-  > *N/A*
-- NodeJS >= v16.13.0
+|  | **Remote** | **JSR** | **NPM** |
+|:--|:--|:--|:--|
+| **[Bun](https://bun.sh/)** >= v1.1.0 | ❌ | ❓ | ✔️ |
+| **[Cloudflare Workers](https://workers.cloudflare.com/)** | ❌ | ❓ | ✔️ |
+| **[Deno](https://deno.land/)** >= v1.42.0 | ✔️ | ✔️ | ✔️ |
+| **[NodeJS](https://nodejs.org/)** >= v16.13.0 | ❌ | ❓ | ✔️ |
 
-## 🔰 Usage
+> [!NOTE]
+> - It is possible to use this module in other methods/ways which not listed in here, however those methods/ways are not officially supported, and should beware maybe cause security issues.
 
-### Via JSR With `node_modules`
+### #️⃣ Resources Identifier
 
-> **🎯 Supported Target**
->
-> - Bun
-> - Cloudflare Workers
-> - NodeJS
-
-1. Install via:
-    - Bun
-      ```sh
-      bunx jsr add @hugoalh/github-sodium[@${Tag}]
-      ```
-    - NPM
-      ```sh
-      npx jsr add @hugoalh/github-sodium[@${Tag}]
-      ```
-    - PNPM
-      ```sh
-      pnpm dlx jsr add @hugoalh/github-sodium[@${Tag}]
-      ```
-    - Yarn
-      ```sh
-      yarn dlx jsr add @hugoalh/github-sodium[@${Tag}]
-      ```
-2. Import at the script:
-    ```ts
-    import ... from "@hugoalh/github-sodium";
-    ```
-
-> **ℹ️ Note**
->
-> - Although it is recommended to import the entire module, it is also able to import part of the module with sub path if available, please visit [file `jsr.jsonc`](./jsr.jsonc) property `exports` for available sub paths.
-> - It is recommended to import the module with tag for immutability.
-
-### Via JSR With Specifier
-
-> **🎯 Supported Target**
->
-> - Deno
-
-1. Import at the script:
-    ```ts
-    import ... from "jsr:@hugoalh/github-sodium[@${Tag}]";
-    ```
-
-> **ℹ️ Note**
->
-> - Although it is recommended to import the entire module, it is also able to import part of the module with sub path if available, please visit [file `jsr.jsonc`](./jsr.jsonc) property `exports` for available sub paths.
-> - It is recommended to import the module with tag for immutability.
-
-### Via NPM With `node_modules`
-
-> **🎯 Supported Target**
->
-> - Cloudflare Workers
-> - NodeJS
-
-1. Install via:
-    - NPM
-      ```sh
-      npm install @hugoalh/github-sodium[@${Tag}]
-      ```
-    - PNPM
-      ```sh
-      pnpm add @hugoalh/github-sodium[@${Tag}]
-      ```
-    - Yarn
-      ```sh
-      yarn add @hugoalh/github-sodium[@${Tag}]
-      ```
-2. Import at the script:
-    ```ts
-    import ... from "@hugoalh/github-sodium";
-    ```
-
-> **ℹ️ Note**
->
-> - Although it is recommended to import the entire module, it is also able to import part of the module with sub path if available, please visit [file `jsr.jsonc`](./jsr.jsonc) property `exports` for available sub paths.
-> - It is recommended to import the module with tag for immutability.
-
-### Via NPM With Specifier
-
-> **🎯 Supported Target**
->
-> - Bun
-> - Deno
-
-1. Import at the script:
-    ```ts
-    import ... from "npm:@hugoalh/github-sodium[@${Tag}]";
-    ```
-
-> **ℹ️ Note**
->
-> - Although it is recommended to import the entire module, it is also able to import part of the module with sub path if available, please visit [file `jsr.jsonc`](./jsr.jsonc) property `exports` for available sub paths.
-> - It is recommended to import the module with tag for immutability.
-
-### Via Remote Import
-
-> **🎯 Supported Target**
->
-> - Deno
-
-1. Import at the script:
-    ```ts
-    /* Via GitHub Raw (Require Tag) */
-    import ... from "https://raw.githubusercontent.com/hugoalh-studio/github-sodium-es/${Tag}/mod.ts";
-    ```
+- **Remote - GitHub Raw:**
+  ```
+  https://raw.githubusercontent.com/hugoalh/github-sodium-es/{Tag}/mod.ts
+  ```
+- **JSR:**
+  ```
+  [jsr:]@hugoalh/github-sodium[@{Tag}]
+  ```
+- **NPM:**
+  ```
+  [npm:]@hugoalh/github-sodium[@{Tag}]
+  ```
 
-> **ℹ️ Note**
->
-> - Although it is recommended to import the entire module with the main path `mod.ts`, it is also able to import part of the module with sub path if available, but do not import if:
+> [!NOTE]
+> - For usage of remote resources, it is recommended to import the entire module with the main path `mod.ts`, however it is also able to import part of the module with sub path if available, but do not import if:
 >
->   - it's file path has an underscore prefix (e.g.: `_foo.ts`, `_util/bar.ts`), or
+>   - it's path has an underscore prefix (e.g.: `_foo.ts`, `_util/bar.ts`), or
 >   - it is a benchmark or test file (e.g.: `foo.bench.ts`, `foo.test.ts`), or
->   - it's symbol has an underscore prefix (e.g.: `export function _baz() {}`).
+>   - it's symbol has an underscore prefix (e.g.: `_bar`, `_foo`).
 >
 >   These elements are not considered part of the public API, thus no stability is guaranteed for them.
-> - Although there have 3rd party services which provide enhanced, equal, or similar methods/ways to remote import the module, beware these services maybe inject unrelated elements and thus affect the security.
+> - For usage of JSR or NPM resources, it is recommended to import the entire module with the main entrypoint, however it is also able to import part of the module with sub entrypoint if available, please visit the [file `jsr.jsonc`](./jsr.jsonc) property `exports` for available sub entrypoints.
+> - It is recommended to use this module with tag for immutability.
 
-## 🧩 API
+### 🛡️ Require Runtime Permissions
+
+*This module does not require any runtime permission.*
+
+## 🧩 APIs (Excerpt)
 
 - ```ts
   class GitHubSodiumSealer {
-    constructor(publicKey: string): GitHubSodiumSealer;
+    constructor(publicKey: string, keyID?: string);
     encrypt(value: string): string;
-    static seal(publicKey: string, value: string): string;
+    encryptToRequestBody(value: string): GitHubRESTSetPublicKeyRequestBody;
+    getKeyID(): string | undefined;
+    get keyID(): string | undefined;
+    static fromJSON(input: JSONObject): GitHubSodiumSealer;
+    static async fromResponse(input: Response): Promise<GitHubSodiumSealer>;
   }
   ```
 - ```ts
-  function seal(publicKey: string, value: string): string;
+  interface GitHubRESTSetPublicKeyRequestBody {
+    encrypted_value: string;
+    key_id: string;
+  }
   ```
 
-## ✍️ Example
+> [!NOTE]
+> - For the full or prettier documentation, can visit via:
+>   - [Deno CLI `deno doc`](https://docs.deno.com/runtime/reference/cli/documentation_generator/)
+>   - [JSR](https://jsr.io/@hugoalh/github-sodium)
+
+## ✍️ Examples
 
 - ```ts
   new GitHubSodiumSealer("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234").encrypt("plain-text-secret");

package/mod.d.ts

@@ -0,0 +1,70 @@
+import { type JSONObject } from "@hugoalh/is-json";
+export interface GitHubRESTSetPublicKeyRequestBody {
+    encrypted_value: string;
+    key_id: string;
+}
+/**
+ * GitHub sodium sealer for encrypt value to the GitHub secret value.
+ */
+export declare class GitHubSodiumSealer {
+    #private;
+    get [Symbol.toStringTag](): string;
+    /**
+     * Initialize the GitHub sodium sealer.
+     * @param {string} publicKey Public key, which get from the GitHub organization or repository, need for encrypt value to the GitHub secret value before create or update the GitHub secret.
+     * @param {string} [keyID] ID of the key, which get from the GitHub organization or repository, need for create or update the GitHub secret. This parameter is optional if no need to output as part of the {@linkcode Request} body.
+     */
+    constructor(publicKey: string, keyID?: string);
+    /**
+     * Encrypt value to the GitHub secret value.
+     * @param {string} value Value that need to encrypt as the GitHub secret value.
+     * @returns {string} An encrypted GitHub secret value.
+     */
+    encrypt(value: string): string;
+    /**
+     * Encrypt value to the GitHub secret value, and output as part of the {@linkcode Request} body for create or update GitHub secret via the GitHub REST API.
+     * @param {string} value Value that need to encrypt as the GitHub secret value.
+     * @returns {GitHubRESTSetPublicKeyRequestBody} Part of the {@linkcode Request} body for create or update GitHub secret via the GitHub REST API.
+     */
+    encryptToRequestBody(value: string): GitHubRESTSetPublicKeyRequestBody;
+    /**
+     * Get the ID of the key.
+     * @returns {string | undefined} ID of the key.
+     */
+    getKeyID(): string | undefined;
+    /**
+     * Get the ID of the key.
+     * @returns {string | undefined} ID of the key.
+     */
+    get keyID(): string | undefined;
+    /**
+     * Initialize the GitHub sodium sealer with the {@linkcode Response} JSON body from get GitHub secret public key via the GitHub REST API.
+     * @param {JSONObject} input {@linkcode Response} JSON body.
+     * @returns {GitHubSodiumSealer} GitHub sodium sealer.
+     */
+    static fromJSON(input: JSONObject): GitHubSodiumSealer;
+    /**
+     * Initialize the GitHub sodium sealer with the {@linkcode Response} from get GitHub secret public key via the GitHub REST API.
+     * @param {Response} input {@linkcode Response}.
+     * @returns {Promise<GitHubSodiumSealer>} GitHub sodium sealer.
+     */
+    static fromResponse(input: Response): Promise<GitHubSodiumSealer>;
+    /**
+     * Encrypt value to the GitHub secret value.
+     * @param {string} publicKey Public key, which get from the GitHub organization or repository, need for encrypt value to the GitHub secret value before create or update the GitHub secret.
+     * @param {string} value Value that need to encrypt as the GitHub secret value.
+     * @returns {string} An encrypted GitHub secret value.
+     * @deprecated Migrate to `new GitHubSodiumSealer(publicKey).encrypt(value)`.
+     */
+    static seal(publicKey: string, value: string): string;
+}
+export default GitHubSodiumSealer;
+/**
+ * Encrypt value to the GitHub secret value.
+ * @param {string} publicKey Public key, which get from the GitHub organization or repository, need for encrypt value to the GitHub secret value before create or update the GitHub secret.
+ * @param {string} value Value that need to encrypt as the GitHub secret value.
+ * @returns {string} An encrypted GitHub secret value.
+ * @deprecated Migrate to `new GitHubSodiumSealer(publicKey).encrypt(value)`.
+ */
+export declare function seal(publicKey: string, value: string): string;
+//# sourceMappingURL=mod.d.ts.map

package/mod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AAEA,OAAO,EAEN,KAAK,UAAU,EACf,MAAM,kBAAkB,CAAC;AAE1B,MAAM,WAAW,iCAAiC;IACjD,eAAe,EAAE,MAAM,CAAC;IACxB,MAAM,EAAE,MAAM,CAAC;CACf;AACD;;GAEG;AACH,qBAAa,kBAAkB;;IAC9B,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,MAAM,CAEjC;IAGD;;;;OAIG;gBACS,SAAS,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM;IAa7C;;;;OAIG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAM9B;;;;OAIG;IACH,oBAAoB,CAAC,KAAK,EAAE,MAAM,GAAG,iCAAiC;IAStE;;;OAGG;IACH,QAAQ,IAAI,MAAM,GAAG,SAAS;IAG9B;;;OAGG;IACH,IAAI,KAAK,IAAI,MAAM,GAAG,SAAS,CAE9B;IACD;;;;OAIG;IACH,MAAM,CAAC,QAAQ,CAAC,KAAK,EAAE,UAAU,GAAG,kBAAkB;IAStD;;;;OAIG;WACU,YAAY,CAAC,KAAK,EAAE,QAAQ,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAOvE;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM;CAGrD;AACD,eAAe,kBAAkB,CAAC;AAClC;;;;;;GAMG;AACH,wBAAgB,IAAI,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAE7D"}

package/mod.js

@@ -0,0 +1,114 @@
+import { Buffer } from "node:buffer";
+import libsodium from "libsodium-wrappers";
+import { isJSONObject } from "@hugoalh/is-json";
+await libsodium.ready;
+/**
+ * GitHub sodium sealer for encrypt value to the GitHub secret value.
+ */
+export class GitHubSodiumSealer {
+    get [Symbol.toStringTag]() {
+        return "GitHubSodiumSealer";
+    }
+    #keyID;
+    #publicKey;
+    /**
+     * Initialize the GitHub sodium sealer.
+     * @param {string} publicKey Public key, which get from the GitHub organization or repository, need for encrypt value to the GitHub secret value before create or update the GitHub secret.
+     * @param {string} [keyID] ID of the key, which get from the GitHub organization or repository, need for create or update the GitHub secret. This parameter is optional if no need to output as part of the {@linkcode Request} body.
+     */
+    constructor(publicKey, keyID) {
+        if (!(typeof keyID === "undefined" ||
+            (typeof keyID === "string" && keyID.length > 0))) {
+            throw new TypeError(`Parameter \`keyID\` is not \`undefined\`, or a string which is non empty!`);
+        }
+        if (!(publicKey.length > 0)) {
+            throw new SyntaxError(`Parameter \`publicKey\` is not a string which is non empty!`);
+        }
+        this.#keyID = keyID;
+        this.#publicKey = Buffer.from(publicKey, "base64");
+    }
+    /**
+     * Encrypt value to the GitHub secret value.
+     * @param {string} value Value that need to encrypt as the GitHub secret value.
+     * @returns {string} An encrypted GitHub secret value.
+     */
+    encrypt(value) {
+        if (!(value.length > 0)) {
+            throw new SyntaxError(`Parameter \`value\` is not a string which is non empty!`);
+        }
+        return Buffer.from(libsodium.crypto_box_seal(Buffer.from(value), this.#publicKey)).toString("base64");
+    }
+    /**
+     * Encrypt value to the GitHub secret value, and output as part of the {@linkcode Request} body for create or update GitHub secret via the GitHub REST API.
+     * @param {string} value Value that need to encrypt as the GitHub secret value.
+     * @returns {GitHubRESTSetPublicKeyRequestBody} Part of the {@linkcode Request} body for create or update GitHub secret via the GitHub REST API.
+     */
+    encryptToRequestBody(value) {
+        if (this.#keyID !== "string") {
+            throw new Error(`Key ID was not defined at the initialize stage!`);
+        }
+        return {
+            encrypted_value: this.encrypt(value),
+            key_id: this.#keyID
+        };
+    }
+    /**
+     * Get the ID of the key.
+     * @returns {string | undefined} ID of the key.
+     */
+    getKeyID() {
+        return this.#keyID;
+    }
+    /**
+     * Get the ID of the key.
+     * @returns {string | undefined} ID of the key.
+     */
+    get keyID() {
+        return this.#keyID;
+    }
+    /**
+     * Initialize the GitHub sodium sealer with the {@linkcode Response} JSON body from get GitHub secret public key via the GitHub REST API.
+     * @param {JSONObject} input {@linkcode Response} JSON body.
+     * @returns {GitHubSodiumSealer} GitHub sodium sealer.
+     */
+    static fromJSON(input) {
+        if (typeof input.key !== "string" ||
+            typeof input.key_id !== "string") {
+            throw new Error(`Parameter \`input\` is not a valid response JSON body!`);
+        }
+        return new this(input.key, input.key_id);
+    }
+    /**
+     * Initialize the GitHub sodium sealer with the {@linkcode Response} from get GitHub secret public key via the GitHub REST API.
+     * @param {Response} input {@linkcode Response}.
+     * @returns {Promise<GitHubSodiumSealer>} GitHub sodium sealer.
+     */
+    static async fromResponse(input) {
+        const responsePayload = await input.clone().json();
+        if (!isJSONObject(responsePayload)) {
+            throw new Error(`Parameter \`input\` is not a valid response!`);
+        }
+        return GitHubSodiumSealer.fromJSON(responsePayload);
+    }
+    /**
+     * Encrypt value to the GitHub secret value.
+     * @param {string} publicKey Public key, which get from the GitHub organization or repository, need for encrypt value to the GitHub secret value before create or update the GitHub secret.
+     * @param {string} value Value that need to encrypt as the GitHub secret value.
+     * @returns {string} An encrypted GitHub secret value.
+     * @deprecated Migrate to `new GitHubSodiumSealer(publicKey).encrypt(value)`.
+     */
+    static seal(publicKey, value) {
+        return new this(publicKey).encrypt(value);
+    }
+}
+export default GitHubSodiumSealer;
+/**
+ * Encrypt value to the GitHub secret value.
+ * @param {string} publicKey Public key, which get from the GitHub organization or repository, need for encrypt value to the GitHub secret value before create or update the GitHub secret.
+ * @param {string} value Value that need to encrypt as the GitHub secret value.
+ * @returns {string} An encrypted GitHub secret value.
+ * @deprecated Migrate to `new GitHubSodiumSealer(publicKey).encrypt(value)`.
+ */
+export function seal(publicKey, value) {
+    return new GitHubSodiumSealer(publicKey).encrypt(value);
+}

package/package.json

@@ -1,47 +1,40 @@
 {
 	"name": "@hugoalh/github-sodium",
-	"version": "5.0.3",
-	"description": "A module to provide an easier sodium for GitHub secrets.",
+	"version": "5.1.0",
+	"description": "A module to provide an easier and simplified method for encrypt GitHub secrets.",
 	"keywords": [
 		"github",
 		"sodium"
 	],
-	"homepage": "https://github.com/hugoalh-studio/github-sodium-es#readme",
+	"homepage": "https://github.com/hugoalh/github-sodium-es#readme",
 	"bugs": {
-		"url": "https://github.com/hugoalh-studio/github-sodium-es/issues"
+		"url": "https://github.com/hugoalh/github-sodium-es/issues"
 	},
 	"license": "MIT",
 	"author": "hugoalh",
-	"files": [
-		"asset/**",
-		"bin/**",
-		"dist/**",
-		"lib/**",
-		"LICENSE*.md",
-		"package.json",
-		"README*.md"
-	],
 	"type": "module",
-	"main": "./dist/mod.js",
+	"main": "./mod.js",
+	"module": "./mod.js",
 	"exports": {
-		"types": "./dist/mod.d.ts",
-		"import": "./dist/mod.js"
+		".": {
+			"import": {
+				"types": "./mod.d.ts",
+				"default": "./mod.js"
+			}
+		}
 	},
-	"types": "./dist/mod.d.ts",
+	"types": "./mod.d.ts",
 	"repository": {
 		"type": "git",
-		"url": "git+https://github.com/hugoalh-studio/github-sodium-es.git"
-	},
-	"scripts": {
-		"build": "tsc"
+		"url": "git+https://github.com/hugoalh/github-sodium-es.git"
 	},
+	"scripts": {},
 	"dependencies": {
-		"libsodium-wrappers": "0.7.13"
+		"@hugoalh/is-json": "^1.0.4",
+		"libsodium-wrappers": "^0.7.15"
 	},
 	"devDependencies": {
-		"@types/libsodium-wrappers": "0.7.14",
-		"@types/node": "20.12.7",
-		"typescript": "^5.4.5"
+		"@types/node": "^20.9.0"
 	},
 	"engines": {
 		"node": ">=16.13.0"
@@ -49,5 +42,6 @@
 	"private": false,
 	"publishConfig": {
 		"access": "public"
-	}
-}
+	},
+	"_generatedBy": "dnt@dev"
+}

package/dist/mod.d.ts

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

package/dist/mod.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"mod.d.ts","sourceRoot":"","sources":["../src/mod.ts"],"names":[],"mappings":"AAGA;;GAEG;AACH,qBAAa,kBAAkB;;IAE9B;;;OAGG;gBACS,SAAS,EAAE,MAAM;IAM7B;;;;OAIG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;IAM9B;;;;;OAKG;IACH,MAAM,CAAC,IAAI,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM;CAGrD;AACD,eAAe,kBAAkB,CAAC;AAClC;;;;;GAKG;AACH,wBAAgB,IAAI,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,MAAM,CAE7D"}

package/dist/mod.js

@@ -1,49 +0,0 @@
-import { Buffer } from "node:buffer";
-import libsodium from "libsodium-wrappers";
-await libsodium.ready;
-/**
- * GitHub sodium sealer for encrypt value to GitHub secret value.
- */
-export class GitHubSodiumSealer {
-    #publicKey;
-    /**
-     * Initialize GitHub sodium sealer.
-     * @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 (!(publicKey.length > 0)) {
-            throw new SyntaxError(`Argument \`publicKey\` is not a string which is non-empty!`);
-        }
-        this.#publicKey = Buffer.from(publicKey, "base64");
-    }
-    /**
-     * Encrypt value to GitHub secret value.
-     * @param {string} value Value that need to encrypt as secret value.
-     * @returns {string} An encrypted GitHub secret value.
-     */
-    encrypt(value) {
-        if (!(value.length > 0)) {
-            throw new SyntaxError(`Argument \`value\` is not a string which is non-empty!`);
-        }
-        return Buffer.from(libsodium.crypto_box_seal(Buffer.from(value), this.#publicKey)).toString("base64");
-    }
-    /**
-     * 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);
-    }
-}
-export default GitHubSodiumSealer;
-/**
- * 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.
- */
-export function seal(publicKey, value) {
-    return new GitHubSodiumSealer(publicKey).encrypt(value);
-}