@hugoalh/github-sodium 2.0.1 → 3.0.0
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/README.md +45 -30
- package/lib/github-sodium-sealer.d.ts +1 -1
- package/lib/github-sodium-sealer.d.ts.map +1 -1
- package/lib/github-sodium-sealer.js +12 -11
- package/lib/main.d.ts +7 -2
- package/lib/main.js +7 -3
- package/lib/seal.d.ts +1 -1
- package/lib/seal.js +3 -3
- package/package.json +12 -11
- package/lib/github-sodium-sealer.d.mts +0 -20
- package/lib/github-sodium-sealer.d.mts.map +0 -1
- package/lib/github-sodium-sealer.mjs +0 -32
- package/lib/main.d.mts +0 -9
- package/lib/main.d.mts.map +0 -1
- package/lib/main.mjs +0 -10
- package/lib/seal.d.mts +0 -9
- package/lib/seal.d.mts.map +0 -1
- package/lib/seal.mjs +0 -11
package/README.md
CHANGED
|
@@ -1,28 +1,26 @@
|
|
|
1
1
|
# GitHub Sodium (NodeJS)
|
|
2
2
|
|
|
3
3
|
[`GitHubSodium.NodeJS`](https://github.com/hugoalh-studio/github-sodium-nodejs)
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
[) | **Pre** () |
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
[](https://github.com/hugoalh-studio/github-sodium-nodejs/stargazers)
|
|
8
|
+
[](https://github.com/hugoalh-studio/github-sodium-nodejs/graphs/contributors)
|
|
9
|
+
[](https://github.com/hugoalh-studio/github-sodium-nodejs/issues)
|
|
10
|
+
[](https://github.com/hugoalh-studio/github-sodium-nodejs/pulls)
|
|
11
|
+
[](https://github.com/hugoalh-studio/github-sodium-nodejs/discussions)
|
|
12
|
+
[](https://www.codefactor.io/repository/github/hugoalh-studio/github-sodium-nodejs)
|
|
13
|
+
|
|
14
|
+
| **Releases** | **Latest** () | **Pre** () |
|
|
17
15
|
|:-:|:-:|:-:|
|
|
18
|
-
| [
|
|
19
|
-
| [
|
|
16
|
+
| [](https://github.com/hugoalh-studio/github-sodium-nodejs/releases)  |  |  |
|
|
17
|
+
| [](https://www.npmjs.com/package/@hugoalh/github-sodium)  |  |  |
|
|
20
18
|
|
|
21
19
|
## 📝 Description
|
|
22
20
|
|
|
23
|
-
A NodeJS module to provide an easier sodium for GitHub
|
|
21
|
+
A NodeJS module to provide an easier sodium for GitHub secrets.
|
|
24
22
|
|
|
25
|
-
This project is based on `libsodium.js` ([GitHub](https://github.com/jedisct1/libsodium.js))([NPM](https://www.npmjs.com/package/libsodium))
|
|
23
|
+
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.
|
|
26
24
|
|
|
27
25
|
## 📚 Documentation
|
|
28
26
|
|
|
@@ -30,20 +28,13 @@ This project is based on `libsodium.js` ([GitHub](https://github.com/jedisct1/li
|
|
|
30
28
|
|
|
31
29
|
#### Install
|
|
32
30
|
|
|
33
|
-
- NodeJS
|
|
34
|
-
- NPM >= v6.14.8
|
|
31
|
+
- NodeJS ^ v12.20.0 || ^ v14.15.0 || >= v16.13.0
|
|
35
32
|
|
|
36
33
|
```sh
|
|
37
34
|
npm install @hugoalh/github-sodium
|
|
38
35
|
```
|
|
39
36
|
|
|
40
|
-
#### Use
|
|
41
|
-
|
|
42
|
-
```js
|
|
43
|
-
const githubSodium = require("@hugoalh/github-sodium");
|
|
44
|
-
```
|
|
45
|
-
|
|
46
|
-
#### Use In ModuleJS
|
|
37
|
+
#### Use
|
|
47
38
|
|
|
48
39
|
```js
|
|
49
40
|
/* Either */
|
|
@@ -56,13 +47,37 @@ import { ... } from "@hugoalh/github-sodium";// Part / Tree-shake
|
|
|
56
47
|
|
|
57
48
|
#### Class
|
|
58
49
|
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
50
|
+
<ul>
|
|
51
|
+
<li><code>GitHubSodiumSealer</code></li>
|
|
52
|
+
<ul>
|
|
53
|
+
<li>
|
|
54
|
+
|
|
55
|
+
```ts
|
|
56
|
+
@constructor(publicKey: string): GitHubSodiumSealer
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
</li>
|
|
60
|
+
<li>
|
|
61
|
+
|
|
62
|
+
```ts
|
|
63
|
+
encrypt(value: string): string
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
</li>
|
|
67
|
+
</ul>
|
|
68
|
+
</ul>
|
|
62
69
|
|
|
63
70
|
#### Function
|
|
64
71
|
|
|
65
|
-
|
|
72
|
+
<ul>
|
|
73
|
+
<li>
|
|
74
|
+
|
|
75
|
+
```ts
|
|
76
|
+
seal(publicKey: string, value: string): string
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
</li>
|
|
80
|
+
</ul>
|
|
66
81
|
|
|
67
82
|
### Example
|
|
68
83
|
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"github-sodium-sealer.d.ts","sourceRoot":"","sources":["github-sodium-sealer.js"],"names":[],"mappings":";
|
|
1
|
+
{"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"}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
1
|
+
import { isString as adIsString } from "@hugoalh/advanced-determine";
|
|
2
|
+
import libsodium from "libsodium-wrappers";
|
|
3
|
+
await libsodium.ready;
|
|
3
4
|
/**
|
|
4
5
|
* @class GitHubSodiumSealer
|
|
5
6
|
* @description Encrypt value to GitHub secret value.
|
|
@@ -11,21 +12,21 @@ class GitHubSodiumSealer {
|
|
|
11
12
|
* @param {string} publicKey Organization's or repository's public key, which need for encrypt value to secret value before create or update a secret.
|
|
12
13
|
*/
|
|
13
14
|
constructor(publicKey) {
|
|
14
|
-
if (!
|
|
15
|
+
if (!adIsString(publicKey, { empty: false })) {
|
|
15
16
|
throw new TypeError(`Argument \`publicKey\` must be type of string (non-empty)!`);
|
|
16
|
-
}
|
|
17
|
+
}
|
|
17
18
|
this.#publicKeyStorage = Buffer.from(publicKey, "base64");
|
|
18
|
-
}
|
|
19
|
+
}
|
|
19
20
|
/**
|
|
20
21
|
* @method
|
|
21
22
|
* @param {string} value Value that need to encrypt as secret value.
|
|
22
23
|
* @returns {string} An encrypted GitHub secret value.
|
|
23
24
|
*/
|
|
24
25
|
encrypt(value) {
|
|
25
|
-
if (!
|
|
26
|
+
if (!adIsString(value, { empty: false })) {
|
|
26
27
|
throw new TypeError(`Argument \`value\` must be type of string (non-empty)!`);
|
|
27
|
-
}
|
|
28
|
-
return Buffer.from(
|
|
29
|
-
}
|
|
30
|
-
}
|
|
31
|
-
|
|
28
|
+
}
|
|
29
|
+
return Buffer.from(libsodium.crypto_box_seal(Buffer.from(value), this.#publicKeyStorage)).toString("base64");
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
export default GitHubSodiumSealer;
|
package/lib/main.d.ts
CHANGED
|
@@ -1,4 +1,9 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
1
|
+
declare namespace _default {
|
|
2
|
+
export { GitHubSodiumSealer };
|
|
3
|
+
export { seal };
|
|
4
|
+
}
|
|
5
|
+
export default _default;
|
|
6
|
+
import GitHubSodiumSealer from "./github-sodium-sealer.js";
|
|
7
|
+
import seal from "./seal.js";
|
|
3
8
|
export { GitHubSodiumSealer, seal };
|
|
4
9
|
//# sourceMappingURL=main.d.ts.map
|
package/lib/main.js
CHANGED
|
@@ -1,6 +1,10 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
1
|
+
import GitHubSodiumSealer from "./github-sodium-sealer.js";
|
|
2
|
+
import seal from "./seal.js";
|
|
3
|
+
export {
|
|
4
|
+
GitHubSodiumSealer,
|
|
5
|
+
seal
|
|
6
|
+
};
|
|
7
|
+
export default {
|
|
4
8
|
GitHubSodiumSealer,
|
|
5
9
|
seal
|
|
6
10
|
};
|
package/lib/seal.d.ts
CHANGED
package/lib/seal.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
|
|
1
|
+
import GitHubSodiumSealer from "./github-sodium-sealer.js";
|
|
2
2
|
/**
|
|
3
3
|
* @function seal
|
|
4
4
|
* @param {string} publicKey Organization's or repository's public key, which need for encrypt value to secret value before create or update a secret.
|
|
@@ -7,5 +7,5 @@ const GitHubSodiumSealer = require("./github-sodium-sealer.js");
|
|
|
7
7
|
*/
|
|
8
8
|
function seal(publicKey, value) {
|
|
9
9
|
return new GitHubSodiumSealer(publicKey).encrypt(value);
|
|
10
|
-
}
|
|
11
|
-
|
|
10
|
+
}
|
|
11
|
+
export default seal;
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@hugoalh/github-sodium",
|
|
3
|
-
"version": "
|
|
4
|
-
"description": "A module to provide an easier sodium for GitHub
|
|
3
|
+
"version": "3.0.0",
|
|
4
|
+
"description": "A module to provide an easier sodium for GitHub secrets.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"github",
|
|
7
7
|
"sodium"
|
|
@@ -12,11 +12,10 @@
|
|
|
12
12
|
},
|
|
13
13
|
"license": "MIT",
|
|
14
14
|
"author": "hugoalh",
|
|
15
|
+
"type": "module",
|
|
15
16
|
"main": "./lib/main.js",
|
|
16
|
-
"module": "./lib/main.mjs",
|
|
17
17
|
"exports": {
|
|
18
|
-
"import": "./lib/main.
|
|
19
|
-
"require": "./lib/main.js"
|
|
18
|
+
"import": "./lib/main.js"
|
|
20
19
|
},
|
|
21
20
|
"types": "./lib/main.d.ts",
|
|
22
21
|
"repository": {
|
|
@@ -24,16 +23,18 @@
|
|
|
24
23
|
"url": "git+https://github.com/hugoalh-studio/github-sodium-nodejs.git"
|
|
25
24
|
},
|
|
26
25
|
"dependencies": {
|
|
27
|
-
"@hugoalh/advanced-determine": "^7.1.
|
|
28
|
-
"libsodium-wrappers": "^0.7.10"
|
|
29
|
-
"tweetsodium": "^0.0.6"
|
|
26
|
+
"@hugoalh/advanced-determine": "^7.1.4",
|
|
27
|
+
"libsodium-wrappers": "^0.7.10"
|
|
30
28
|
},
|
|
31
29
|
"devDependencies": {
|
|
32
|
-
"@types/libsodium-wrappers": "^0.7.9"
|
|
30
|
+
"@types/libsodium-wrappers": "^0.7.9",
|
|
31
|
+
"@types/node": "^18.7.18",
|
|
32
|
+
"eslint": "^8.23.1",
|
|
33
|
+
"eslint-plugin-only-warn": "^1.0.3",
|
|
34
|
+
"typescript": "^4.8.3"
|
|
33
35
|
},
|
|
34
36
|
"engines": {
|
|
35
|
-
"node": "
|
|
36
|
-
"npm": ">= 6.14.8"
|
|
37
|
+
"node": "^12.20.0 || ^14.15.0 || >=16.13.0"
|
|
37
38
|
},
|
|
38
39
|
"private": false
|
|
39
40
|
}
|
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
export default GitHubSodiumSealer;
|
|
2
|
-
/**
|
|
3
|
-
* @class GitHubSodiumSealer
|
|
4
|
-
* @description Encrypt value to GitHub secret value.
|
|
5
|
-
*/
|
|
6
|
-
declare class GitHubSodiumSealer {
|
|
7
|
-
/**
|
|
8
|
-
* @constructor
|
|
9
|
-
* @param {string} publicKey Organization's or repository's public key, which need for encrypt value to secret value before create or update a secret.
|
|
10
|
-
*/
|
|
11
|
-
constructor(publicKey: string);
|
|
12
|
-
/**
|
|
13
|
-
* @method
|
|
14
|
-
* @param {string} value Value that need to encrypt as secret value.
|
|
15
|
-
* @returns {string} An encrypted GitHub secret value.
|
|
16
|
-
*/
|
|
17
|
-
encrypt(value: string): string;
|
|
18
|
-
#private;
|
|
19
|
-
}
|
|
20
|
-
//# sourceMappingURL=github-sodium-sealer.d.mts.map
|
|
@@ -1 +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"}
|
|
@@ -1,32 +0,0 @@
|
|
|
1
|
-
import { isString as adIsString } from "@hugoalh/advanced-determine";
|
|
2
|
-
import libsodium from "libsodium-wrappers";
|
|
3
|
-
await libsodium.ready;
|
|
4
|
-
/**
|
|
5
|
-
* @class GitHubSodiumSealer
|
|
6
|
-
* @description Encrypt value to GitHub secret value.
|
|
7
|
-
*/
|
|
8
|
-
class GitHubSodiumSealer {
|
|
9
|
-
#publicKeyStorage;
|
|
10
|
-
/**
|
|
11
|
-
* @constructor
|
|
12
|
-
* @param {string} publicKey Organization's or repository's public key, which need for encrypt value to secret value before create or update a secret.
|
|
13
|
-
*/
|
|
14
|
-
constructor(publicKey) {
|
|
15
|
-
if (!adIsString(publicKey, { empty: false })) {
|
|
16
|
-
throw new TypeError(`Argument \`publicKey\` must be type of string (non-empty)!`);
|
|
17
|
-
};
|
|
18
|
-
this.#publicKeyStorage = Buffer.from(publicKey, "base64");
|
|
19
|
-
};
|
|
20
|
-
/**
|
|
21
|
-
* @method
|
|
22
|
-
* @param {string} value Value that need to encrypt as secret value.
|
|
23
|
-
* @returns {string} An encrypted GitHub secret value.
|
|
24
|
-
*/
|
|
25
|
-
encrypt(value) {
|
|
26
|
-
if (!adIsString(value, { empty: false })) {
|
|
27
|
-
throw new TypeError(`Argument \`value\` must be type of string (non-empty)!`);
|
|
28
|
-
};
|
|
29
|
-
return Buffer.from(libsodium.crypto_box_seal(Buffer.from(value), this.#publicKeyStorage)).toString("base64");
|
|
30
|
-
};
|
|
31
|
-
};
|
|
32
|
-
export default GitHubSodiumSealer;
|
package/lib/main.d.mts
DELETED
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
declare namespace _default {
|
|
2
|
-
export { GitHubSodiumSealer };
|
|
3
|
-
export { seal };
|
|
4
|
-
}
|
|
5
|
-
export default _default;
|
|
6
|
-
import GitHubSodiumSealer from "./github-sodium-sealer.mjs";
|
|
7
|
-
import seal from "./seal.mjs";
|
|
8
|
-
export { GitHubSodiumSealer, seal };
|
|
9
|
-
//# sourceMappingURL=main.d.mts.map
|
package/lib/main.d.mts.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"main.d.mts","sourceRoot":"","sources":["main.mjs"],"names":[],"mappings":""}
|
package/lib/main.mjs
DELETED
package/lib/seal.d.mts
DELETED
|
@@ -1,9 +0,0 @@
|
|
|
1
|
-
export default seal;
|
|
2
|
-
/**
|
|
3
|
-
* @function seal
|
|
4
|
-
* @param {string} publicKey Organization's or repository's public key, which need for encrypt value to secret value before create or update a secret.
|
|
5
|
-
* @param {string} value Value that need to encrypt as secret value.
|
|
6
|
-
* @returns {string} An encrypted GitHub secret value.
|
|
7
|
-
*/
|
|
8
|
-
declare function seal(publicKey: string, value: string): string;
|
|
9
|
-
//# sourceMappingURL=seal.d.mts.map
|
package/lib/seal.d.mts.map
DELETED
|
@@ -1 +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/lib/seal.mjs
DELETED
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
import GitHubSodiumSealer from "./github-sodium-sealer.mjs";
|
|
2
|
-
/**
|
|
3
|
-
* @function seal
|
|
4
|
-
* @param {string} publicKey Organization's or repository's public key, which need for encrypt value to secret value before create or update a secret.
|
|
5
|
-
* @param {string} value Value that need to encrypt as secret value.
|
|
6
|
-
* @returns {string} An encrypted GitHub secret value.
|
|
7
|
-
*/
|
|
8
|
-
function seal(publicKey, value) {
|
|
9
|
-
return new GitHubSodiumSealer(publicKey).encrypt(value);
|
|
10
|
-
};
|
|
11
|
-
export default seal;
|