@hugoalh/github-sodium
v5.0.3
Published
A module to provide an easier sodium for GitHub secrets.
Downloads
101
Readme
GitHub Sodium (ES)
An ES (JavaScript & TypeScript) module to provide an easier sodium for GitHub secrets.
This project is based on "libsodium.js" with optimization for GitHub secrets.
🎯 Target
- Bun ^ v1.0.0
- Cloudflare Workers
- Deno >= v1.34.0 / >= v1.41.1 (For JSR Only)
🛡️ Require Permission
N/A
- NodeJS >= v16.13.0
🔰 Usage
Via JSR With node_modules
🎯 Supported Target
- Bun
- Cloudflare Workers
- NodeJS
- Install via:
- Bun
bunx jsr add @hugoalh/github-sodium[@${Tag}]
- NPM
npx jsr add @hugoalh/github-sodium[@${Tag}]
- PNPM
pnpm dlx jsr add @hugoalh/github-sodium[@${Tag}]
- Yarn
yarn dlx jsr add @hugoalh/github-sodium[@${Tag}]
- Bun
- Import at the script:
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
propertyexports
for available sub paths.- It is recommended to import the module with tag for immutability.
Via JSR With Specifier
🎯 Supported Target
- Deno
- Import at the script:
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
propertyexports
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
- Install via:
- NPM
npm install @hugoalh/github-sodium[@${Tag}]
- PNPM
pnpm add @hugoalh/github-sodium[@${Tag}]
- Yarn
yarn add @hugoalh/github-sodium[@${Tag}]
- NPM
- Import at the script:
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
propertyexports
for available sub paths.- It is recommended to import the module with tag for immutability.
Via NPM With Specifier
🎯 Supported Target
- Bun
- Deno
- Import at the script:
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
propertyexports
for available sub paths.- It is recommended to import the module with tag for immutability.
Via Remote Import
🎯 Supported Target
- Deno
- Import at the script:
/* Via GitHub Raw (Require Tag) */ import ... from "https://raw.githubusercontent.com/hugoalh-studio/github-sodium-es/${Tag}/mod.ts";
ℹ️ 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:
- it's file 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() {}
).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.
🧩 API
class GitHubSodiumSealer { constructor(publicKey: string): GitHubSodiumSealer; encrypt(value: string): string; static seal(publicKey: string, value: string): string; }
function seal(publicKey: string, value: string): string;
✍️ Example
new GitHubSodiumSealer("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234").encrypt("plain-text-secret");