@hugoalh/github-sodium 5.1.0 → 6.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # MIT License
2
2
 
3
- Copyright © 2020\~2024 hugoalh
3
+ Copyright © 2020\~2026 HUGOALH
4
4
 
5
5
  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:
6
6
 
package/README.md CHANGED
@@ -2,83 +2,95 @@
2
2
 
3
3
  [**⚖️** MIT](./LICENSE.md)
4
4
 
5
- [![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)
6
- [![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)
7
- [![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)
5
+ 🔗
6
+ [DistBoard @hugoalh](https://hugoalh.github.io/distboard/github_sodium_ecmascript)
7
+ ● [GitHub](https://github.com/hugoalh/github-sodium-es)
8
+ ● [JSR](https://jsr.io/@hugoalh/github-sodium)
9
+ ● [NPM](https://www.npmjs.com/package/@hugoalh/github-sodium)
8
10
 
9
- 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).
11
+ An ECMAScript module to provide an easier and simplified method for encrypt GitHub secrets.
10
12
 
11
- ## 🔰 Begin
13
+ ## 🌟 Features
12
14
 
13
- ### 🎯 Targets
15
+ - Support multiple implementations:
16
+ - **LibSodium:** Default; Recommended by GitHub; Bad compatibility with bundler or compiler.
17
+ - **TweetSodium:** Originally created by GitHub but deprecated and unmaintained ([Repository](https://github.com/github/tweetsodium)), currently maintain here; Good compatibility with bundler or compiler.
14
18
 
15
- | | **Remote** | **JSR** | **NPM** |
16
- |:--|:--|:--|:--|
17
- | **[Bun](https://bun.sh/)** >= v1.1.0 | ❌ | ❓ | ✔️ |
18
- | **[Cloudflare Workers](https://workers.cloudflare.com/)** | ❌ | ❓ | ✔️ |
19
- | **[Deno](https://deno.land/)** >= v1.42.0 | ✔️ | ✔️ | ✔️ |
20
- | **[NodeJS](https://nodejs.org/)** >= v16.13.0 | ❌ | ❓ | ✔️ |
19
+ ## 🎯 Runtime Targets
21
20
 
22
- > [!NOTE]
23
- > - 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.
21
+ Any runtime which support ECMAScript should able to use this; These runtimes are officially supported:
22
+
23
+ - **[Bun](https://bun.sh/)** >= v1.1.0
24
+ - **[Deno](https://deno.land/)** >= v2.1.0
25
+ - **[NodeJS](https://nodejs.org/)** >= v20.9.0
26
+
27
+ ## 🛡️ Runtime Permissions
28
+
29
+ This does not request any runtime permission.
24
30
 
25
- ### #️⃣ Resources Identifier
31
+ ## #️⃣ Sources & Entrypoints
26
32
 
27
- - **Remote - GitHub Raw:**
33
+ - GitHub Raw
28
34
  ```
29
35
  https://raw.githubusercontent.com/hugoalh/github-sodium-es/{Tag}/mod.ts
30
36
  ```
31
- - **JSR:**
37
+ - JSR
32
38
  ```
33
- [jsr:]@hugoalh/github-sodium[@{Tag}]
39
+ jsr:@hugoalh/github-sodium[@{Tag}]
34
40
  ```
35
- - **NPM:**
41
+ - NPM
36
42
  ```
37
- [npm:]@hugoalh/github-sodium[@{Tag}]
43
+ npm:@hugoalh/github-sodium[@{Tag}]
38
44
  ```
39
45
 
40
- > [!NOTE]
41
- > - 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:
42
- >
43
- > - it's path has an underscore prefix (e.g.: `_foo.ts`, `_util/bar.ts`), or
44
- > - it is a benchmark or test file (e.g.: `foo.bench.ts`, `foo.test.ts`), or
45
- > - it's symbol has an underscore prefix (e.g.: `_bar`, `_foo`).
46
- >
47
- > These elements are not considered part of the public API, thus no stability is guaranteed for them.
48
- > - 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.
49
- > - It is recommended to use this module with tag for immutability.
50
-
51
- ### 🛡️ Require Runtime Permissions
46
+ | **Name** | **Path** | **Description** |
47
+ |:--|:--|:--|
48
+ | `.` | `./mod.ts` | Default (LibSodium). |
49
+ | `./cli` | N/A | CLI for default (LibSodium). |
50
+ | `./libsodium` | `./libsodium.ts` | LibSodium. |
51
+ | `./libsodium/cli` | `./libsodium/cli.ts` | CLI for LibSodium. |
52
+ | `./tweetsodium` | `./tweetsodium.ts` | TweetSodium. |
53
+ | `./tweetsodium/cli` | `./tweetsodium/cli.ts` | CLI for TweetSodium. |
52
54
 
53
- *This module does not require any runtime permission.*
55
+ > [!NOTE]
56
+ > - Different runtimes have vary support for the sources and entrypoints, visit the runtime documentation for more information.
57
+ > - It is recommended to include tag for immutability.
58
+ > - These are not part of the public APIs hence should not be used:
59
+ > - Benchmark/Test file (e.g.: `example.bench.ts`, `example.test.ts`).
60
+ > - Entrypoint name or path include any underscore prefix (e.g.: `_example.ts`, `foo/_example.ts`).
61
+ > - Identifier/Namespace/Symbol include any underscore prefix (e.g.: `_example`, `Foo._example`).
54
62
 
55
- ## 🧩 APIs (Excerpt)
63
+ ## 🧩 APIs
56
64
 
57
65
  - ```ts
58
66
  class GitHubSodiumSealer {
59
- constructor(publicKey: string, keyID?: string);
67
+ constructor(publicKey: string);
60
68
  encrypt(value: string): string;
61
- encryptToRequestBody(value: string): GitHubRESTSetPublicKeyRequestBody;
62
- getKeyID(): string | undefined;
63
- get keyID(): string | undefined;
64
- static fromJSON(input: JSONObject): GitHubSodiumSealer;
65
- static async fromResponse(input: Response): Promise<GitHubSodiumSealer>;
66
- }
67
- ```
68
- - ```ts
69
- interface GitHubRESTSetPublicKeyRequestBody {
70
- encrypted_value: string;
71
- key_id: string;
72
69
  }
73
70
  ```
74
71
 
75
72
  > [!NOTE]
76
73
  > - For the full or prettier documentation, can visit via:
77
- > - [Deno CLI `deno doc`](https://docs.deno.com/runtime/reference/cli/documentation_generator/)
74
+ > - [Deno CLI `deno doc`](https://docs.deno.com/runtime/reference/cli/doc/)
78
75
  > - [JSR](https://jsr.io/@hugoalh/github-sodium)
79
76
 
77
+ ## 🧩 CLIs
78
+
79
+ - ```powershell
80
+ ghs $PublicKey $SecretValue
81
+ ```
82
+ - ```powershell
83
+ ghs-ls $PublicKey $SecretValue
84
+ ```
85
+ - ```powershell
86
+ ghs-ts $PublicKey $SecretValue
87
+ ```
88
+
80
89
  ## ✍️ Examples
81
90
 
82
91
  - ```ts
83
92
  new GitHubSodiumSealer("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234").encrypt("plain-text-secret");
84
93
  ```
94
+ - ```powershell
95
+ ghs '2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234' 'plain-text-secret'
96
+ ```
@@ -0,0 +1,101 @@
1
+ /**
2
+ * Based on [import-meta-ponyfill](https://github.com/gaubee/import-meta-ponyfill),
3
+ * but instead of using npm to install additional dependencies,
4
+ * this approach manually consolidates cjs/mjs/d.ts into a single file.
5
+ *
6
+ * Note that this code might be imported multiple times
7
+ * (for example, both dnt.test.polyfills.ts and dnt.polyfills.ts contain this code;
8
+ * or Node.js might dynamically clear the cache and then force a require).
9
+ * Therefore, it's important to avoid redundant writes to global objects.
10
+ * Additionally, consider that commonjs is used alongside esm,
11
+ * so the two ponyfill functions are stored independently in two separate global objects.
12
+ */
13
+ import { createRequire } from "node:module";
14
+ import { type URL } from "node:url";
15
+ declare global {
16
+ interface ImportMeta {
17
+ /** A string representation of the fully qualified module URL. When the
18
+ * module is loaded locally, the value will be a file URL (e.g.
19
+ * `file:///path/module.ts`).
20
+ *
21
+ * You can also parse the string as a URL to determine more information about
22
+ * how the current module was loaded. For example to determine if a module was
23
+ * local or not:
24
+ *
25
+ * ```ts
26
+ * const url = new URL(import.meta.url);
27
+ * if (url.protocol === "file:") {
28
+ * console.log("this module was loaded locally");
29
+ * }
30
+ * ```
31
+ */
32
+ url: string;
33
+ /**
34
+ * A function that returns resolved specifier as if it would be imported
35
+ * using `import(specifier)`.
36
+ *
37
+ * ```ts
38
+ * console.log(import.meta.resolve("./foo.js"));
39
+ * // file:///dev/foo.js
40
+ * ```
41
+ *
42
+ * @param specifier The module specifier to resolve relative to `parent`.
43
+ * @param parent The absolute parent module URL to resolve from.
44
+ * @returns The absolute (`file:`) URL string for the resolved module.
45
+ */
46
+ resolve(specifier: string, parent?: string | URL | undefined): string;
47
+ /** A flag that indicates if the current module is the main module that was
48
+ * called when starting the program under Deno.
49
+ *
50
+ * ```ts
51
+ * if (import.meta.main) {
52
+ * // this was loaded as the main module, maybe do some bootstrapping
53
+ * }
54
+ * ```
55
+ */
56
+ main: boolean;
57
+ /** The absolute path of the current module.
58
+ *
59
+ * This property is only provided for local modules (ie. using `file://` URLs).
60
+ *
61
+ * Example:
62
+ * ```
63
+ * // Unix
64
+ * console.log(import.meta.filename); // /home/alice/my_module.ts
65
+ *
66
+ * // Windows
67
+ * console.log(import.meta.filename); // C:\alice\my_module.ts
68
+ * ```
69
+ */
70
+ filename: string;
71
+ /** The absolute path of the directory containing the current module.
72
+ *
73
+ * This property is only provided for local modules (ie. using `file://` URLs).
74
+ *
75
+ * * Example:
76
+ * ```
77
+ * // Unix
78
+ * console.log(import.meta.dirname); // /home/alice
79
+ *
80
+ * // Windows
81
+ * console.log(import.meta.dirname); // C:\alice
82
+ * ```
83
+ */
84
+ dirname: string;
85
+ }
86
+ }
87
+ type NodeRequest = ReturnType<typeof createRequire>;
88
+ type NodeModule = NonNullable<NodeRequest["main"]>;
89
+ interface ImportMetaPonyfillCommonjs {
90
+ (require: NodeRequest, module: NodeModule): ImportMeta;
91
+ }
92
+ interface ImportMetaPonyfillEsmodule {
93
+ (importMeta: ImportMeta): ImportMeta;
94
+ }
95
+ interface ImportMetaPonyfill extends ImportMetaPonyfillCommonjs, ImportMetaPonyfillEsmodule {
96
+ }
97
+ export declare let import_meta_ponyfill_commonjs: ImportMetaPonyfillCommonjs;
98
+ export declare let import_meta_ponyfill_esmodule: ImportMetaPonyfillEsmodule;
99
+ export declare let import_meta_ponyfill: ImportMetaPonyfill;
100
+ export {};
101
+ //# sourceMappingURL=_dnt.polyfills.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"_dnt.polyfills.d.ts","sourceRoot":"","sources":["src/_dnt.polyfills.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAEH,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAE5C,OAAO,EAAgC,KAAK,GAAG,EAAE,MAAM,UAAU,CAAC;AAGlE,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,UAAU;QAClB;;;;;;;;;;;;;;WAcG;QACH,GAAG,EAAE,MAAM,CAAC;QACZ;;;;;;;;;;;;WAYG;QACH,OAAO,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,GAAG,GAAG,GAAG,SAAS,GAAG,MAAM,CAAC;QACtE;;;;;;;;WAQG;QACH,IAAI,EAAE,OAAO,CAAC;QAEd;;;;;;;;;;;;WAYG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;;;;;;;;;;;WAYG;QACH,OAAO,EAAE,MAAM,CAAC;KACjB;CACF;AAED,KAAK,WAAW,GAAG,UAAU,CAAC,OAAO,aAAa,CAAC,CAAC;AACpD,KAAK,UAAU,GAAG,WAAW,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC;AACnD,UAAU,0BAA0B;IAClC,CAAC,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,UAAU,GAAG,UAAU,CAAC;CACxD;AACD,UAAU,0BAA0B;IAClC,CAAC,UAAU,EAAE,UAAU,GAAG,UAAU,CAAC;CACtC;AACD,UAAU,kBACR,SAAQ,0BAA0B,EAAE,0BAA0B;CAC/D;AAiBD,eAAO,IAAI,6BAA6B,EA2BnC,0BAA0B,CAAC;AAMhC,eAAO,IAAI,6BAA6B,EA4DnC,0BAA0B,CAAC;AAMhC,eAAO,IAAI,oBAAoB,EAoB1B,kBAAkB,CAAC"}
@@ -0,0 +1,127 @@
1
+ /**
2
+ * Based on [import-meta-ponyfill](https://github.com/gaubee/import-meta-ponyfill),
3
+ * but instead of using npm to install additional dependencies,
4
+ * this approach manually consolidates cjs/mjs/d.ts into a single file.
5
+ *
6
+ * Note that this code might be imported multiple times
7
+ * (for example, both dnt.test.polyfills.ts and dnt.polyfills.ts contain this code;
8
+ * or Node.js might dynamically clear the cache and then force a require).
9
+ * Therefore, it's important to avoid redundant writes to global objects.
10
+ * Additionally, consider that commonjs is used alongside esm,
11
+ * so the two ponyfill functions are stored independently in two separate global objects.
12
+ */
13
+ //@ts-ignore
14
+ import { createRequire } from "node:module";
15
+ //@ts-ignore
16
+ import { fileURLToPath, pathToFileURL } from "node:url";
17
+ //@ts-ignore
18
+ import { dirname } from "node:path";
19
+ const defineGlobalPonyfill = (symbolFor, fn) => {
20
+ if (!Reflect.has(globalThis, Symbol.for(symbolFor))) {
21
+ Object.defineProperty(globalThis, Symbol.for(symbolFor), {
22
+ configurable: true,
23
+ get() {
24
+ return fn;
25
+ },
26
+ });
27
+ }
28
+ };
29
+ export let import_meta_ponyfill_commonjs = (Reflect.get(globalThis, Symbol.for("import-meta-ponyfill-commonjs")) ??
30
+ (() => {
31
+ const moduleImportMetaWM = new WeakMap();
32
+ return (require, module) => {
33
+ let importMetaCache = moduleImportMetaWM.get(module);
34
+ if (importMetaCache == null) {
35
+ const importMeta = Object.assign(Object.create(null), {
36
+ url: pathToFileURL(module.filename).href,
37
+ main: require.main == module,
38
+ resolve: (specifier, parentURL = importMeta.url) => {
39
+ return pathToFileURL((importMeta.url === parentURL
40
+ ? require
41
+ : createRequire(parentURL))
42
+ .resolve(specifier)).href;
43
+ },
44
+ filename: module.filename,
45
+ dirname: module.path,
46
+ });
47
+ moduleImportMetaWM.set(module, importMeta);
48
+ importMetaCache = importMeta;
49
+ }
50
+ return importMetaCache;
51
+ };
52
+ })());
53
+ defineGlobalPonyfill("import-meta-ponyfill-commonjs", import_meta_ponyfill_commonjs);
54
+ export let import_meta_ponyfill_esmodule = (Reflect.get(globalThis, Symbol.for("import-meta-ponyfill-esmodule")) ??
55
+ ((importMeta) => {
56
+ const resolveFunStr = String(importMeta.resolve);
57
+ const shimWs = new WeakSet();
58
+ //@ts-ignore
59
+ const mainUrl = ("file:///" + process.argv[1].replace(/\\/g, "/"))
60
+ .replace(/\/{3,}/, "///");
61
+ const commonShim = (importMeta) => {
62
+ if (typeof importMeta.main !== "boolean") {
63
+ importMeta.main = importMeta.url === mainUrl;
64
+ }
65
+ if (typeof importMeta.filename !== "string") {
66
+ importMeta.filename = fileURLToPath(importMeta.url);
67
+ importMeta.dirname = dirname(importMeta.filename);
68
+ }
69
+ };
70
+ if (
71
+ // v16.2.0+, v14.18.0+: Add support for WHATWG URL object to parentURL parameter.
72
+ resolveFunStr === "undefined" ||
73
+ // v20.0.0+, v18.19.0+"" This API now returns a string synchronously instead of a Promise.
74
+ resolveFunStr.startsWith("async")
75
+ // enable by --experimental-import-meta-resolve flag
76
+ ) {
77
+ import_meta_ponyfill_esmodule = (importMeta) => {
78
+ if (!shimWs.has(importMeta)) {
79
+ shimWs.add(importMeta);
80
+ const importMetaUrlRequire = {
81
+ url: importMeta.url,
82
+ require: createRequire(importMeta.url),
83
+ };
84
+ importMeta.resolve = function resolve(specifier, parentURL = importMeta.url) {
85
+ return pathToFileURL((importMetaUrlRequire.url === parentURL
86
+ ? importMetaUrlRequire.require
87
+ : createRequire(parentURL)).resolve(specifier)).href;
88
+ };
89
+ commonShim(importMeta);
90
+ }
91
+ return importMeta;
92
+ };
93
+ }
94
+ else {
95
+ /// native support
96
+ import_meta_ponyfill_esmodule = (importMeta) => {
97
+ if (!shimWs.has(importMeta)) {
98
+ shimWs.add(importMeta);
99
+ commonShim(importMeta);
100
+ }
101
+ return importMeta;
102
+ };
103
+ }
104
+ return import_meta_ponyfill_esmodule(importMeta);
105
+ }));
106
+ defineGlobalPonyfill("import-meta-ponyfill-esmodule", import_meta_ponyfill_esmodule);
107
+ export let import_meta_ponyfill = ((...args) => {
108
+ const _MODULE = (() => {
109
+ if (typeof require === "function" && typeof module === "object") {
110
+ return "commonjs";
111
+ }
112
+ else {
113
+ // eval("typeof import.meta");
114
+ return "esmodule";
115
+ }
116
+ })();
117
+ if (_MODULE === "commonjs") {
118
+ //@ts-ignore
119
+ import_meta_ponyfill = (r, m) => import_meta_ponyfill_commonjs(r, m);
120
+ }
121
+ else {
122
+ //@ts-ignore
123
+ import_meta_ponyfill = (im) => import_meta_ponyfill_esmodule(im);
124
+ }
125
+ //@ts-ignore
126
+ return import_meta_ponyfill(...args);
127
+ });
@@ -0,0 +1,12 @@
1
+ export { Deno } from "@deno/shim-deno";
2
+ export { alert, confirm, prompt } from "@deno/shim-prompts";
3
+ export { setInterval, setTimeout } from "@deno/shim-timers";
4
+ export declare const dntGlobalThis: Omit<typeof globalThis, "Deno" | "alert" | "confirm" | "prompt" | "setInterval" | "setTimeout"> & {
5
+ Deno: any;
6
+ alert: any;
7
+ confirm: any;
8
+ prompt: any;
9
+ setInterval: any;
10
+ setTimeout: any;
11
+ };
12
+ //# sourceMappingURL=_dnt.shims.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"_dnt.shims.d.ts","sourceRoot":"","sources":["src/_dnt.shims.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AAEvC,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAE5D,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAU5D,eAAO,MAAM,aAAa;;;;;;;CAA2C,CAAC"}
package/_dnt.shims.js ADDED
@@ -0,0 +1,70 @@
1
+ import { Deno } from "@deno/shim-deno";
2
+ export { Deno } from "@deno/shim-deno";
3
+ import { alert, confirm, prompt } from "@deno/shim-prompts";
4
+ export { alert, confirm, prompt } from "@deno/shim-prompts";
5
+ import { setInterval, setTimeout } from "@deno/shim-timers";
6
+ export { setInterval, setTimeout } from "@deno/shim-timers";
7
+ const dntGlobals = {
8
+ Deno,
9
+ alert,
10
+ confirm,
11
+ prompt,
12
+ setInterval,
13
+ setTimeout,
14
+ };
15
+ export const dntGlobalThis = createMergeProxy(globalThis, dntGlobals);
16
+ function createMergeProxy(baseObj, extObj) {
17
+ return new Proxy(baseObj, {
18
+ get(_target, prop, _receiver) {
19
+ if (prop in extObj) {
20
+ return extObj[prop];
21
+ }
22
+ else {
23
+ return baseObj[prop];
24
+ }
25
+ },
26
+ set(_target, prop, value) {
27
+ if (prop in extObj) {
28
+ delete extObj[prop];
29
+ }
30
+ baseObj[prop] = value;
31
+ return true;
32
+ },
33
+ deleteProperty(_target, prop) {
34
+ let success = false;
35
+ if (prop in extObj) {
36
+ delete extObj[prop];
37
+ success = true;
38
+ }
39
+ if (prop in baseObj) {
40
+ delete baseObj[prop];
41
+ success = true;
42
+ }
43
+ return success;
44
+ },
45
+ ownKeys(_target) {
46
+ const baseKeys = Reflect.ownKeys(baseObj);
47
+ const extKeys = Reflect.ownKeys(extObj);
48
+ const extKeysSet = new Set(extKeys);
49
+ return [...baseKeys.filter((k) => !extKeysSet.has(k)), ...extKeys];
50
+ },
51
+ defineProperty(_target, prop, desc) {
52
+ if (prop in extObj) {
53
+ delete extObj[prop];
54
+ }
55
+ Reflect.defineProperty(baseObj, prop, desc);
56
+ return true;
57
+ },
58
+ getOwnPropertyDescriptor(_target, prop) {
59
+ if (prop in extObj) {
60
+ return Reflect.getOwnPropertyDescriptor(extObj, prop);
61
+ }
62
+ else {
63
+ return Reflect.getOwnPropertyDescriptor(baseObj, prop);
64
+ }
65
+ },
66
+ has(_target, prop) {
67
+ return prop in extObj || prop in baseObj;
68
+ },
69
+ });
70
+ }
package/_polyfill.d.ts ADDED
@@ -0,0 +1 @@
1
+ //# sourceMappingURL=_polyfill.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"_polyfill.d.ts","sourceRoot":"","sources":["src/_polyfill.ts"],"names":[],"mappings":""}
package/_polyfill.js ADDED
@@ -0,0 +1,9 @@
1
+ "use strict";
2
+ if (typeof Uint8Array.fromBase64 === "undefined") {
3
+ //deno-lint-ignore hugoalh/no-import-dynamic -- Polyfill.
4
+ await import("es-arraybuffer-base64/Uint8Array.fromBase64/auto");
5
+ }
6
+ if (typeof Uint8Array.prototype.toBase64 === "undefined") {
7
+ //deno-lint-ignore hugoalh/no-import-dynamic -- Polyfill.
8
+ await import("es-arraybuffer-base64/Uint8Array.prototype.toBase64/auto");
9
+ }
@@ -0,0 +1,3 @@
1
+ #!/usr/bin/env node
2
+ import "../_dnt.polyfills.js";
3
+ //# sourceMappingURL=cli.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/libsodium/cli.ts"],"names":[],"mappings":";AACA,OAAO,sBAAsB,CAAC;AAC9B,OAAO,sBAAsB,CAAC;AAC9B,OAAO,sBAAsB,CAAC;AAC9B,OAAO,sBAAsB,CAAC"}
@@ -0,0 +1,13 @@
1
+ #!/usr/bin/env node
2
+ import "../_dnt.polyfills.js";
3
+ import * as dntShim from "../_dnt.shims.js";
4
+ import { GitHubSodiumSealer } from "../libsodium.js";
5
+ if (!globalThis[Symbol.for("import-meta-ponyfill-esmodule")](import.meta).main) {
6
+ throw new Error(`This entrypoint is for command line only!`);
7
+ }
8
+ const args = dntShim.Deno.args;
9
+ if (args.length !== 2) {
10
+ throw new Error(`Invalid arguments length; Expect: 2, Current: ${args.length}.`);
11
+ }
12
+ const [publicKey, secretValue] = args;
13
+ console.log(new GitHubSodiumSealer(publicKey).encrypt(secretValue));
package/libsodium.d.ts ADDED
@@ -0,0 +1,22 @@
1
+ import "./_dnt.polyfills.js";
2
+ import "./_polyfill.js";
3
+ /**
4
+ * GitHub sodium sealer for encrypt value to the GitHub secret value.
5
+ */
6
+ export declare class GitHubSodiumSealer {
7
+ #private;
8
+ get [Symbol.toStringTag](): string;
9
+ /**
10
+ * Initialize.
11
+ * @param {string} publicKey Public key (recipient's 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.
12
+ */
13
+ constructor(publicKey: string);
14
+ /**
15
+ * Encrypt value to the GitHub secret value.
16
+ * @param {string} value Value that need to encrypt as the GitHub secret value.
17
+ * @returns {string} An encrypted GitHub secret value.
18
+ */
19
+ encrypt(value: string): string;
20
+ }
21
+ export default GitHubSodiumSealer;
22
+ //# sourceMappingURL=libsodium.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"libsodium.d.ts","sourceRoot":"","sources":["src/libsodium.ts"],"names":[],"mappings":"AAAA,OAAO,qBAAqB,CAAC;AAC7B,OAAO,qBAAqB,CAAC;AAE7B,OAAO,gBAAgB,CAAC;AAExB;;GAEG;AACH,qBAAa,kBAAkB;;IAC9B,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,MAAM,CAEjC;IAED;;;OAGG;gBACS,SAAS,EAAE,MAAM;IAM7B;;;;OAIG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;CAM9B;AACD,eAAe,kBAAkB,CAAC"}
package/libsodium.js ADDED
@@ -0,0 +1,35 @@
1
+ import "./_dnt.polyfills.js";
2
+ import libsodium from "libsodium-wrappers";
3
+ import "./_polyfill.js";
4
+ await libsodium.ready;
5
+ /**
6
+ * GitHub sodium sealer for encrypt value to the GitHub secret value.
7
+ */
8
+ export class GitHubSodiumSealer {
9
+ get [Symbol.toStringTag]() {
10
+ return "GitHubSodiumSealer/LibSodium";
11
+ }
12
+ #publicKey;
13
+ /**
14
+ * Initialize.
15
+ * @param {string} publicKey Public key (recipient's 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.
16
+ */
17
+ constructor(publicKey) {
18
+ if (!(publicKey.length > 0)) {
19
+ throw new SyntaxError(`Parameter \`publicKey\` is not a string which is non empty!`);
20
+ }
21
+ this.#publicKey = Uint8Array.fromBase64(publicKey);
22
+ }
23
+ /**
24
+ * Encrypt value to the GitHub secret value.
25
+ * @param {string} value Value that need to encrypt as the GitHub secret value.
26
+ * @returns {string} An encrypted GitHub secret value.
27
+ */
28
+ encrypt(value) {
29
+ if (!(value.length > 0)) {
30
+ throw new SyntaxError(`Parameter \`value\` is not a string which is non empty!`);
31
+ }
32
+ return libsodium.crypto_box_seal(new TextEncoder().encode(value), this.#publicKey).toBase64();
33
+ }
34
+ }
35
+ export default GitHubSodiumSealer;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@hugoalh/github-sodium",
3
- "version": "5.1.0",
3
+ "version": "6.0.1",
4
4
  "description": "A module to provide an easier and simplified method for encrypt GitHub secrets.",
5
5
  "keywords": [
6
6
  "github",
@@ -13,31 +13,67 @@
13
13
  "license": "MIT",
14
14
  "author": "hugoalh",
15
15
  "type": "module",
16
- "main": "./mod.js",
17
- "module": "./mod.js",
16
+ "bin": {
17
+ "ghs": "./libsodium/cli.js",
18
+ "ghs-ls": "./libsodium/cli.js",
19
+ "ghs-ts": "./tweetsodium/cli.js"
20
+ },
21
+ "main": "./libsodium.js",
22
+ "module": "./libsodium.js",
18
23
  "exports": {
24
+ "./cli": {
25
+ "import": {
26
+ "types": "./libsodium/cli.d.ts",
27
+ "default": "./libsodium/cli.js"
28
+ }
29
+ },
30
+ "./libsodium": {
31
+ "import": {
32
+ "types": "./libsodium.d.ts",
33
+ "default": "./libsodium.js"
34
+ }
35
+ },
36
+ "./libsodium/cli": {
37
+ "import": {
38
+ "types": "./libsodium/cli.d.ts",
39
+ "default": "./libsodium/cli.js"
40
+ }
41
+ },
42
+ "./tweetsodium": {
43
+ "import": {
44
+ "types": "./tweetsodium.d.ts",
45
+ "default": "./tweetsodium.js"
46
+ }
47
+ },
48
+ "./tweetsodium/cli": {
49
+ "import": {
50
+ "types": "./tweetsodium/cli.d.ts",
51
+ "default": "./tweetsodium/cli.js"
52
+ }
53
+ },
19
54
  ".": {
20
55
  "import": {
21
- "types": "./mod.d.ts",
22
- "default": "./mod.js"
56
+ "types": "./libsodium.d.ts",
57
+ "default": "./libsodium.js"
23
58
  }
24
59
  }
25
60
  },
26
- "types": "./mod.d.ts",
61
+ "types": "./libsodium.d.ts",
27
62
  "repository": {
28
63
  "type": "git",
29
64
  "url": "git+https://github.com/hugoalh/github-sodium-es.git"
30
65
  },
31
- "scripts": {},
32
66
  "dependencies": {
33
- "@hugoalh/is-json": "^1.0.4",
34
- "libsodium-wrappers": "^0.7.15"
67
+ "@hugoalh/blake": "^0.2.2",
68
+ "@hugoalh/nacl": "^0.2.1",
69
+ "es-arraybuffer-base64": "^1.1.2",
70
+ "libsodium-wrappers": "^0.8.4",
71
+ "@deno/shim-deno": "^0.19.2",
72
+ "@deno/shim-prompts": "^0.1.1",
73
+ "@deno/shim-timers": "^0.1.0"
35
74
  },
36
75
  "devDependencies": {
37
- "@types/node": "^20.9.0"
38
- },
39
- "engines": {
40
- "node": ">=16.13.0"
76
+ "@types/node": "^24.5.0"
41
77
  },
42
78
  "private": false,
43
79
  "publishConfig": {
@@ -0,0 +1,3 @@
1
+ #!/usr/bin/env node
2
+ import "../_dnt.polyfills.js";
3
+ //# sourceMappingURL=cli.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"cli.d.ts","sourceRoot":"","sources":["../src/tweetsodium/cli.ts"],"names":[],"mappings":";AACA,OAAO,sBAAsB,CAAC;AAC9B,OAAO,sBAAsB,CAAC"}
@@ -0,0 +1,13 @@
1
+ #!/usr/bin/env node
2
+ import "../_dnt.polyfills.js";
3
+ import * as dntShim from "../_dnt.shims.js";
4
+ import { GitHubSodiumSealer } from "../tweetsodium.js";
5
+ if (!globalThis[Symbol.for("import-meta-ponyfill-esmodule")](import.meta).main) {
6
+ throw new Error(`This entrypoint is for command line only!`);
7
+ }
8
+ const args = dntShim.Deno.args;
9
+ if (args.length !== 2) {
10
+ throw new Error(`Invalid arguments length; Expect: 2, Current: ${args.length}.`);
11
+ }
12
+ const [publicKey, secretValue] = args;
13
+ console.log(new GitHubSodiumSealer(publicKey).encrypt(secretValue));
@@ -0,0 +1,22 @@
1
+ import "./_dnt.polyfills.js";
2
+ import "./_polyfill.js";
3
+ /**
4
+ * GitHub sodium sealer for encrypt value to the GitHub secret value.
5
+ */
6
+ export declare class GitHubSodiumSealer {
7
+ #private;
8
+ get [Symbol.toStringTag](): string;
9
+ /**
10
+ * Initialize.
11
+ * @param {string} publicKey Public key (recipient's 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.
12
+ */
13
+ constructor(publicKey: string);
14
+ /**
15
+ * Encrypt value to the GitHub secret value.
16
+ * @param {string} value Value that need to encrypt as the GitHub secret value.
17
+ * @returns {string} An encrypted GitHub secret value.
18
+ */
19
+ encrypt(value: string): string;
20
+ }
21
+ export default GitHubSodiumSealer;
22
+ //# sourceMappingURL=tweetsodium.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"tweetsodium.d.ts","sourceRoot":"","sources":["src/tweetsodium.ts"],"names":[],"mappings":"AAAA,OAAO,qBAAqB,CAAC;AAU7B,OAAO,gBAAgB,CAAC;AAExB;;GAEG;AACH,qBAAa,kBAAkB;;IAC9B,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,MAAM,CAEjC;IAED;;;OAGG;gBACS,SAAS,EAAE,MAAM;IAM7B;;;;OAIG;IACH,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM;CAe9B;AACD,eAAe,kBAAkB,CAAC"}
package/tweetsodium.js ADDED
@@ -0,0 +1,43 @@
1
+ import "./_dnt.polyfills.js";
2
+ import { Blake2B } from "@hugoalh/blake/2b";
3
+ import { box, boxKeyPair, boxNonceLength, boxOverheadLength, boxPublicKeyLength } from "@hugoalh/nacl";
4
+ import "./_polyfill.js";
5
+ const sodiumOverheadLength = boxOverheadLength + boxPublicKeyLength;
6
+ /**
7
+ * GitHub sodium sealer for encrypt value to the GitHub secret value.
8
+ */
9
+ export class GitHubSodiumSealer {
10
+ get [Symbol.toStringTag]() {
11
+ return "GitHubSodiumSealer/TweetSodium";
12
+ }
13
+ #publicKey;
14
+ /**
15
+ * Initialize.
16
+ * @param {string} publicKey Public key (recipient's 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.
17
+ */
18
+ constructor(publicKey) {
19
+ if (!(publicKey.length > 0)) {
20
+ throw new SyntaxError(`Parameter \`publicKey\` is not a string which is non empty!`);
21
+ }
22
+ this.#publicKey = Uint8Array.fromBase64(publicKey);
23
+ }
24
+ /**
25
+ * Encrypt value to the GitHub secret value.
26
+ * @param {string} value Value that need to encrypt as the GitHub secret value.
27
+ * @returns {string} An encrypted GitHub secret value.
28
+ */
29
+ encrypt(value) {
30
+ if (!(value.length > 0)) {
31
+ throw new SyntaxError(`Parameter \`value\` is not a string which is non empty!`);
32
+ }
33
+ const ekp = boxKeyPair();
34
+ const result = new Uint8Array(sodiumOverheadLength + value.length);
35
+ result.set(ekp.publicKey, 0);
36
+ // 24 bytes nonce, which is a Blake2B digest from the ephemeral public key and the recipient's public key.
37
+ const nonce = new Blake2B({ length: boxNonceLength }).update(ekp.publicKey).update(this.#publicKey).hash();
38
+ const cipherText = box(new TextEncoder().encode(value), nonce, this.#publicKey, ekp.secretKey);
39
+ result.set(cipherText, boxPublicKeyLength);
40
+ return result.toBase64();
41
+ }
42
+ }
43
+ export default GitHubSodiumSealer;
package/mod.d.ts DELETED
@@ -1,70 +0,0 @@
1
- import { type JSONObject } from "@hugoalh/is-json";
2
- export interface GitHubRESTSetPublicKeyRequestBody {
3
- encrypted_value: string;
4
- key_id: string;
5
- }
6
- /**
7
- * GitHub sodium sealer for encrypt value to the GitHub secret value.
8
- */
9
- export declare class GitHubSodiumSealer {
10
- #private;
11
- get [Symbol.toStringTag](): string;
12
- /**
13
- * Initialize the GitHub sodium sealer.
14
- * @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.
15
- * @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.
16
- */
17
- constructor(publicKey: string, keyID?: string);
18
- /**
19
- * Encrypt value to the GitHub secret value.
20
- * @param {string} value Value that need to encrypt as the GitHub secret value.
21
- * @returns {string} An encrypted GitHub secret value.
22
- */
23
- encrypt(value: string): string;
24
- /**
25
- * 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.
26
- * @param {string} value Value that need to encrypt as the GitHub secret value.
27
- * @returns {GitHubRESTSetPublicKeyRequestBody} Part of the {@linkcode Request} body for create or update GitHub secret via the GitHub REST API.
28
- */
29
- encryptToRequestBody(value: string): GitHubRESTSetPublicKeyRequestBody;
30
- /**
31
- * Get the ID of the key.
32
- * @returns {string | undefined} ID of the key.
33
- */
34
- getKeyID(): string | undefined;
35
- /**
36
- * Get the ID of the key.
37
- * @returns {string | undefined} ID of the key.
38
- */
39
- get keyID(): string | undefined;
40
- /**
41
- * Initialize the GitHub sodium sealer with the {@linkcode Response} JSON body from get GitHub secret public key via the GitHub REST API.
42
- * @param {JSONObject} input {@linkcode Response} JSON body.
43
- * @returns {GitHubSodiumSealer} GitHub sodium sealer.
44
- */
45
- static fromJSON(input: JSONObject): GitHubSodiumSealer;
46
- /**
47
- * Initialize the GitHub sodium sealer with the {@linkcode Response} from get GitHub secret public key via the GitHub REST API.
48
- * @param {Response} input {@linkcode Response}.
49
- * @returns {Promise<GitHubSodiumSealer>} GitHub sodium sealer.
50
- */
51
- static fromResponse(input: Response): Promise<GitHubSodiumSealer>;
52
- /**
53
- * Encrypt value to the GitHub secret value.
54
- * @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.
55
- * @param {string} value Value that need to encrypt as the GitHub secret value.
56
- * @returns {string} An encrypted GitHub secret value.
57
- * @deprecated Migrate to `new GitHubSodiumSealer(publicKey).encrypt(value)`.
58
- */
59
- static seal(publicKey: string, value: string): string;
60
- }
61
- export default GitHubSodiumSealer;
62
- /**
63
- * Encrypt value to the GitHub secret value.
64
- * @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.
65
- * @param {string} value Value that need to encrypt as the GitHub secret value.
66
- * @returns {string} An encrypted GitHub secret value.
67
- * @deprecated Migrate to `new GitHubSodiumSealer(publicKey).encrypt(value)`.
68
- */
69
- export declare function seal(publicKey: string, value: string): string;
70
- //# sourceMappingURL=mod.d.ts.map
package/mod.d.ts.map DELETED
@@ -1 +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 DELETED
@@ -1,114 +0,0 @@
1
- import { Buffer } from "node:buffer";
2
- import libsodium from "libsodium-wrappers";
3
- import { isJSONObject } from "@hugoalh/is-json";
4
- await libsodium.ready;
5
- /**
6
- * GitHub sodium sealer for encrypt value to the GitHub secret value.
7
- */
8
- export class GitHubSodiumSealer {
9
- get [Symbol.toStringTag]() {
10
- return "GitHubSodiumSealer";
11
- }
12
- #keyID;
13
- #publicKey;
14
- /**
15
- * Initialize the GitHub sodium sealer.
16
- * @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.
17
- * @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.
18
- */
19
- constructor(publicKey, keyID) {
20
- if (!(typeof keyID === "undefined" ||
21
- (typeof keyID === "string" && keyID.length > 0))) {
22
- throw new TypeError(`Parameter \`keyID\` is not \`undefined\`, or a string which is non empty!`);
23
- }
24
- if (!(publicKey.length > 0)) {
25
- throw new SyntaxError(`Parameter \`publicKey\` is not a string which is non empty!`);
26
- }
27
- this.#keyID = keyID;
28
- this.#publicKey = Buffer.from(publicKey, "base64");
29
- }
30
- /**
31
- * Encrypt value to the GitHub secret value.
32
- * @param {string} value Value that need to encrypt as the GitHub secret value.
33
- * @returns {string} An encrypted GitHub secret value.
34
- */
35
- encrypt(value) {
36
- if (!(value.length > 0)) {
37
- throw new SyntaxError(`Parameter \`value\` is not a string which is non empty!`);
38
- }
39
- return Buffer.from(libsodium.crypto_box_seal(Buffer.from(value), this.#publicKey)).toString("base64");
40
- }
41
- /**
42
- * 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.
43
- * @param {string} value Value that need to encrypt as the GitHub secret value.
44
- * @returns {GitHubRESTSetPublicKeyRequestBody} Part of the {@linkcode Request} body for create or update GitHub secret via the GitHub REST API.
45
- */
46
- encryptToRequestBody(value) {
47
- if (this.#keyID !== "string") {
48
- throw new Error(`Key ID was not defined at the initialize stage!`);
49
- }
50
- return {
51
- encrypted_value: this.encrypt(value),
52
- key_id: this.#keyID
53
- };
54
- }
55
- /**
56
- * Get the ID of the key.
57
- * @returns {string | undefined} ID of the key.
58
- */
59
- getKeyID() {
60
- return this.#keyID;
61
- }
62
- /**
63
- * Get the ID of the key.
64
- * @returns {string | undefined} ID of the key.
65
- */
66
- get keyID() {
67
- return this.#keyID;
68
- }
69
- /**
70
- * Initialize the GitHub sodium sealer with the {@linkcode Response} JSON body from get GitHub secret public key via the GitHub REST API.
71
- * @param {JSONObject} input {@linkcode Response} JSON body.
72
- * @returns {GitHubSodiumSealer} GitHub sodium sealer.
73
- */
74
- static fromJSON(input) {
75
- if (typeof input.key !== "string" ||
76
- typeof input.key_id !== "string") {
77
- throw new Error(`Parameter \`input\` is not a valid response JSON body!`);
78
- }
79
- return new this(input.key, input.key_id);
80
- }
81
- /**
82
- * Initialize the GitHub sodium sealer with the {@linkcode Response} from get GitHub secret public key via the GitHub REST API.
83
- * @param {Response} input {@linkcode Response}.
84
- * @returns {Promise<GitHubSodiumSealer>} GitHub sodium sealer.
85
- */
86
- static async fromResponse(input) {
87
- const responsePayload = await input.clone().json();
88
- if (!isJSONObject(responsePayload)) {
89
- throw new Error(`Parameter \`input\` is not a valid response!`);
90
- }
91
- return GitHubSodiumSealer.fromJSON(responsePayload);
92
- }
93
- /**
94
- * Encrypt value to the GitHub secret value.
95
- * @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.
96
- * @param {string} value Value that need to encrypt as the GitHub secret value.
97
- * @returns {string} An encrypted GitHub secret value.
98
- * @deprecated Migrate to `new GitHubSodiumSealer(publicKey).encrypt(value)`.
99
- */
100
- static seal(publicKey, value) {
101
- return new this(publicKey).encrypt(value);
102
- }
103
- }
104
- export default GitHubSodiumSealer;
105
- /**
106
- * Encrypt value to the GitHub secret value.
107
- * @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.
108
- * @param {string} value Value that need to encrypt as the GitHub secret value.
109
- * @returns {string} An encrypted GitHub secret value.
110
- * @deprecated Migrate to `new GitHubSodiumSealer(publicKey).encrypt(value)`.
111
- */
112
- export function seal(publicKey, value) {
113
- return new GitHubSodiumSealer(publicKey).encrypt(value);
114
- }