GitHub Sodium (ES)

An ES (JavaScript & TypeScript) module to provide an easier sodium for GitHub secrets.

This project is based on "libsodium.js" with simplify for GitHub secrets.

🔰 Begin

🎯 Targets

	Registry - JSR	Registry - NPM	Remote Import
Bun >= v1.1.0	✔️ `node_modules`	✔️ Specifier `npm:`	❌
Cloudflare Workers	✔️ `node_modules`	✔️ `node_modules`	❌
Deno >= v1.42.0	✔️ Specifier `jsr:`	✔️ Specifier `npm:`	✔️
NodeJS >= v16.13.0	✔️ `node_modules`	✔️ `node_modules`	❌

ℹ️ Note

It is possible to use this module in other methods/ways which not listed in here, however it is not officially supported.

#️⃣ Registries Identifier

JSR:
```
@hugoalh/github-sodium
```
NPM:
```
@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 property exports for available sub paths.

It is recommended to use this module with tag for immutability.

#️⃣ Remote Import Paths

GitHub Raw: (Require Tag)

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.

🛡️ Permissions

This module does not require any permission.

🧩 APIs

class GitHubSodiumSealer {
  constructor(publicKey: string): GitHubSodiumSealer;
  encrypt(value: string): string;
  static seal(publicKey: string, value: string): string;
}

function seal(publicKey: string, value: string): string;

✍️ Examples

new GitHubSodiumSealer("2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234").encrypt("plain-text-secret");

hugoalh-studio / github-sodium-es