@hugoalh/github-sodium

An ECMAScript (JavaScript & TypeScript) module to provide an easier and simplified method for encrypt GitHub secrets.

https://github.com/hugoalh/github-sodium-es

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Committers with academic emails
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (7.3%) to scientific vocabulary

Keywords

ecmascript ecmascript-module es es-module esm esmodule github javascript js sodium ts typescript

Keywords from Contributors

interactive optim mesh interpretability profiles sequences generic projection embedded hacking

Last synced: 4 months ago · JSON representation ·

Repository

An ECMAScript (JavaScript & TypeScript) module to provide an easier and simplified method for encrypt GitHub secrets.

Basic Info

Host: GitHub
Owner: hugoalh
License: other
Language: TypeScript
Default Branch: main
Homepage:
Size: 566 KB

Statistics

Stars: 3
Watchers: 1
Forks: 0
Open Issues: 0
Releases: 25

Topics

ecmascript ecmascript-module es es-module esm esmodule github javascript js sodium ts typescript

Created about 5 years ago · Last pushed 4 months ago

Metadata Files

Readme Contributing License Citation Codeowners Security

README.md

GitHub Sodium (ES)

⚖️ MIT

An ECMAScript (JavaScript & TypeScript) module to provide an easier and simplified method for encrypt GitHub secrets.

🔰 Begin

🎯 Targets

| Targets | Remote | JSR | NPM | |:--|:-:|:-:|:-:| | Bun >= v1.1.0 | ❌ | ✔️ | ✔️ | | Deno >= v2.1.0 | ✔️ | ✔️ | ✔️ | | NodeJS >= v20.9.0 | ❌ | ✔️ | ✔️ |

[!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.

#️⃣ Resources Identifier

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] - 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 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.: _bar, _foo).

These elements are not considered part of the public API, thus no stability is guaranteed for them. - 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 property exports for available sub entrypoints. - It is recommended to use this module with tag for immutability.

🛡️ Runtime Permissions

This module does not request any runtime permission.

🧩 APIs

ts class GitHubSodiumSealer { constructor(publicKey: string); encrypt(value: string): string; }
ts class GitHubSodiumSealerExtend extends GitHubSodiumSealer { constructor(publicKey: string, keyID: string); encryptToRequestBody(value: string): GitHubRESTSetSecretRequestBody; get keyID(): string; static fromJSON(input: JSONObject): GitHubSodiumSealerExtend; static fromResponse(input: Response): Promise<GitHubSodiumSealerExtend>; }
ts interface GitHubRESTSetSecretRequestBody { encrypted_value: string; key_id: string; }

[!NOTE] - For the full or prettier documentation, can visit via: - Deno CLI deno doc - JSR

✍️ Examples

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

Owner

Name: hugoalh
Login: hugoalh
Kind: user
Location: Everywhere
Company: @hugoalh-studio

Twitter: hugoalhofficial
Repositories: 12
Profile: https://github.com/hugoalh

Lead of @hugoalh-studio; Full time software developer; Part time freelancer

Citation (CITATION.cff)

# yaml-language-server: $schema=https://citation-file-format.github.io/1.2.0/schema.json
cff-version: "1.2.0"
title: "GitHub Sodium (ES)"
message: "If you use this software, please cite it using the metadata from this file."
type: "software"
authors:
  - name: "hugoalh"
repository-code: "https://github.com/hugoalh/github-sodium-es"
keywords:
  - "ecmascript"
  - "ecmascript-module"
  - "es"
  - "es-module"
  - "esm"
  - "esmodule"
  - "github"
  - "javascript"
  - "js"
  - "sodium"
  - "ts"
  - "typescript"
license: "MIT"

GitHub Events

Total

Create event: 6
Issues event: 2
Release event: 1
Delete event: 8
Issue comment event: 10
Push event: 26
Pull request event: 13

Last Year

Create event: 6
Issues event: 2
Release event: 1
Delete event: 8
Issue comment event: 10
Push event: 26
Pull request event: 13

Committers

Last synced: 6 months ago

All Time

Total Commits: 371
Total Committers: 2
Avg Commits per committer: 185.5
Development Distribution Score (DDS): 0.299

Past Year

Commits: 26
Committers: 2
Avg Commits per committer: 13.0
Development Distribution Score (DDS): 0.077

Top Committers

Name	Email	Commits
hugoalh	3****h	260
dependabot[bot]	4****]	111

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 1
Total pull requests: 102
Average time to close issues: 2 days
Average time to close pull requests: 5 days
Total issue authors: 1
Total pull request authors: 1
Average comments per issue: 4.0
Average comments per pull request: 0.93
Merged pull requests: 8
Bot issues: 0
Bot pull requests: 102

Past Year

Issues: 1
Pull requests: 20
Average time to close issues: 2 days
Average time to close pull requests: 13 days
Issue authors: 1
Pull request authors: 1
Average comments per issue: 4.0
Average comments per pull request: 0.9
Merged pull requests: 2
Bot issues: 0
Bot pull requests: 20

View more stats

Top Authors

Issue Authors

dependabot[bot] (1)
lisahns (1)

Pull Request Authors

dependabot[bot] (98)

Top Labels

Issue Labels

Status/Investigating 🔍 (1) Type/Bug 🐛 (1) Platform/GitHubActions (1) Status/Pending 🔵 (1) Type/Dependency 📦 (1)

Pull Request Labels

Type/Dependency 📦 (97) Platform/NodeJS (88) Status/Pending 🔵 (86) Platform/GitHubActions (9) Priority/Low 🟢 (8) Status/Duplicated 🔁 (2) github-actions (1) dependency 📦 (1)

Packages

Total packages: 1
Total downloads:
- npm 42 last-month

Total dependent packages: 3
Total dependent repositories: 2
Total versions: 25
Total maintainers: 1

npmjs.org: @hugoalh/github-sodium

A module to provide an easier and simplified method for encrypt GitHub secrets.

Homepage: https://github.com/hugoalh/github-sodium-es#readme
License: MIT
Latest release: 5.1.0
published about 1 year ago

Versions: 25
Dependent Packages: 3
Dependent Repositories: 2
Downloads: 42 Last month

Rankings

Dependent packages count: 5.9%

Dependent repos count: 7.6%

Forks count: 11.6%

Average: 12.9%

Stargazers count: 16.7%

Downloads: 22.6%

Maintainers (1)

hugoalh

Last synced: 4 months ago

Dependencies

.github/workflows/scan-virus.yml actions

actions/checkout v3.3.0 composite
hugoalh/scan-virus-ghaction v0.6.4 composite

package-lock.json npm

105 dependencies

package.json npm

@types/libsodium-wrappers ^0.7.10 development
@types/node ^18.11.19 development
eslint ^8.33.0 development
eslint-plugin-only-warn ^1.1.0 development
typescript ^4.9.5 development
@hugoalh/advanced-determine ^7.2.0
libsodium-wrappers ^0.7.10

.github/workflows/announce-new-release-discord.yml actions

.github/workflows/codeql-analysis.yml actions

.github/workflows/publish-nodejs-package-npm.yml actions

.github/workflows/sync-labels.yml actions