Compare commits
No commits in common. "master" and "v1.0.14" have entirely different histories.
@ -1,66 +0,0 @@
|
|||||||
name: Default (not tags)
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
tags-ignore:
|
|
||||||
- '**'
|
|
||||||
|
|
||||||
env:
|
|
||||||
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
|
||||||
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
|
|
||||||
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
|
|
||||||
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
|
|
||||||
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
|
|
||||||
NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
security:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
continue-on-error: true
|
|
||||||
container:
|
|
||||||
image: ${{ env.IMAGE }}
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v3
|
|
||||||
|
|
||||||
- name: Install pnpm and npmci
|
|
||||||
run: |
|
|
||||||
pnpm install -g pnpm
|
|
||||||
pnpm install -g @shipzone/npmci
|
|
||||||
|
|
||||||
- name: Run npm prepare
|
|
||||||
run: npmci npm prepare
|
|
||||||
|
|
||||||
- name: Audit production dependencies
|
|
||||||
run: |
|
|
||||||
npmci command npm config set registry https://registry.npmjs.org
|
|
||||||
npmci command pnpm audit --audit-level=high --prod
|
|
||||||
continue-on-error: true
|
|
||||||
|
|
||||||
- name: Audit development dependencies
|
|
||||||
run: |
|
|
||||||
npmci command npm config set registry https://registry.npmjs.org
|
|
||||||
npmci command pnpm audit --audit-level=high --dev
|
|
||||||
continue-on-error: true
|
|
||||||
|
|
||||||
test:
|
|
||||||
if: ${{ always() }}
|
|
||||||
needs: security
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
container:
|
|
||||||
image: ${{ env.IMAGE }}
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v3
|
|
||||||
|
|
||||||
- name: Test stable
|
|
||||||
run: |
|
|
||||||
npmci node install stable
|
|
||||||
npmci npm install
|
|
||||||
npmci npm test
|
|
||||||
|
|
||||||
- name: Test build
|
|
||||||
run: |
|
|
||||||
npmci node install stable
|
|
||||||
npmci npm install
|
|
||||||
npmci npm build
|
|
||||||
@ -1,124 +0,0 @@
|
|||||||
name: Default (tags)
|
|
||||||
|
|
||||||
on:
|
|
||||||
push:
|
|
||||||
tags:
|
|
||||||
- '*'
|
|
||||||
|
|
||||||
env:
|
|
||||||
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
|
||||||
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
|
|
||||||
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
|
|
||||||
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
|
|
||||||
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
|
|
||||||
NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
|
|
||||||
|
|
||||||
jobs:
|
|
||||||
security:
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
continue-on-error: true
|
|
||||||
container:
|
|
||||||
image: ${{ env.IMAGE }}
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v3
|
|
||||||
|
|
||||||
- name: Prepare
|
|
||||||
run: |
|
|
||||||
pnpm install -g pnpm
|
|
||||||
pnpm install -g @shipzone/npmci
|
|
||||||
npmci npm prepare
|
|
||||||
|
|
||||||
- name: Audit production dependencies
|
|
||||||
run: |
|
|
||||||
npmci command npm config set registry https://registry.npmjs.org
|
|
||||||
npmci command pnpm audit --audit-level=high --prod
|
|
||||||
continue-on-error: true
|
|
||||||
|
|
||||||
- name: Audit development dependencies
|
|
||||||
run: |
|
|
||||||
npmci command npm config set registry https://registry.npmjs.org
|
|
||||||
npmci command pnpm audit --audit-level=high --dev
|
|
||||||
continue-on-error: true
|
|
||||||
|
|
||||||
test:
|
|
||||||
if: ${{ always() }}
|
|
||||||
needs: security
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
container:
|
|
||||||
image: ${{ env.IMAGE }}
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v3
|
|
||||||
|
|
||||||
- name: Prepare
|
|
||||||
run: |
|
|
||||||
pnpm install -g pnpm
|
|
||||||
pnpm install -g @shipzone/npmci
|
|
||||||
npmci npm prepare
|
|
||||||
|
|
||||||
- name: Test stable
|
|
||||||
run: |
|
|
||||||
npmci node install stable
|
|
||||||
npmci npm install
|
|
||||||
npmci npm test
|
|
||||||
|
|
||||||
- name: Test build
|
|
||||||
run: |
|
|
||||||
npmci node install stable
|
|
||||||
npmci npm install
|
|
||||||
npmci npm build
|
|
||||||
|
|
||||||
release:
|
|
||||||
needs: test
|
|
||||||
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
container:
|
|
||||||
image: ${{ env.IMAGE }}
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v3
|
|
||||||
|
|
||||||
- name: Prepare
|
|
||||||
run: |
|
|
||||||
pnpm install -g pnpm
|
|
||||||
pnpm install -g @shipzone/npmci
|
|
||||||
npmci npm prepare
|
|
||||||
|
|
||||||
- name: Release
|
|
||||||
run: |
|
|
||||||
npmci node install stable
|
|
||||||
npmci npm publish
|
|
||||||
|
|
||||||
metadata:
|
|
||||||
needs: test
|
|
||||||
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
|
|
||||||
runs-on: ubuntu-latest
|
|
||||||
container:
|
|
||||||
image: ${{ env.IMAGE }}
|
|
||||||
continue-on-error: true
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- uses: actions/checkout@v3
|
|
||||||
|
|
||||||
- name: Prepare
|
|
||||||
run: |
|
|
||||||
pnpm install -g pnpm
|
|
||||||
pnpm install -g @shipzone/npmci
|
|
||||||
npmci npm prepare
|
|
||||||
|
|
||||||
- name: Code quality
|
|
||||||
run: |
|
|
||||||
npmci command npm install -g typescript
|
|
||||||
npmci npm install
|
|
||||||
|
|
||||||
- name: Trigger
|
|
||||||
run: npmci trigger
|
|
||||||
|
|
||||||
- name: Build docs and upload artifacts
|
|
||||||
run: |
|
|
||||||
npmci node install stable
|
|
||||||
npmci npm install
|
|
||||||
pnpm install -g @git.zone/tsdoc
|
|
||||||
npmci command tsdoc
|
|
||||||
continue-on-error: true
|
|
||||||
@ -12,25 +12,29 @@ stages:
|
|||||||
- release
|
- release
|
||||||
- metadata
|
- metadata
|
||||||
|
|
||||||
before_script:
|
# ====================
|
||||||
- pnpm install -g pnpm
|
# security stage
|
||||||
- pnpm install -g @shipzone/npmci
|
# ====================
|
||||||
- npmci npm prepare
|
mirror:
|
||||||
|
stage: security
|
||||||
|
script:
|
||||||
|
- npmci git mirror
|
||||||
|
only:
|
||||||
|
- tags
|
||||||
|
tags:
|
||||||
|
- lossless
|
||||||
|
- docker
|
||||||
|
- notpriv
|
||||||
|
|
||||||
# ====================
|
|
||||||
# security stage
|
|
||||||
# ====================
|
|
||||||
# ====================
|
|
||||||
# security stage
|
|
||||||
# ====================
|
|
||||||
auditProductionDependencies:
|
auditProductionDependencies:
|
||||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||||
stage: security
|
stage: security
|
||||||
script:
|
script:
|
||||||
- npmci command npm config set registry https://registry.npmjs.org
|
- npmci npm prepare
|
||||||
- npmci command pnpm audit --audit-level=high --prod
|
- npmci command npm install --production --ignore-scripts
|
||||||
|
- npmci command npm config set registry https://registry.npmjs.org
|
||||||
|
- npmci command npm audit --audit-level=high --only=prod --production
|
||||||
tags:
|
tags:
|
||||||
- lossless
|
|
||||||
- docker
|
- docker
|
||||||
allow_failure: true
|
allow_failure: true
|
||||||
|
|
||||||
@ -38,10 +42,11 @@ auditDevDependencies:
|
|||||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||||
stage: security
|
stage: security
|
||||||
script:
|
script:
|
||||||
|
- npmci npm prepare
|
||||||
|
- npmci command npm install --ignore-scripts
|
||||||
- npmci command npm config set registry https://registry.npmjs.org
|
- npmci command npm config set registry https://registry.npmjs.org
|
||||||
- npmci command pnpm audit --audit-level=high --dev
|
- npmci command npm audit --audit-level=high --only=dev
|
||||||
tags:
|
tags:
|
||||||
- lossless
|
|
||||||
- docker
|
- docker
|
||||||
allow_failure: true
|
allow_failure: true
|
||||||
|
|
||||||
@ -52,6 +57,7 @@ auditDevDependencies:
|
|||||||
testStable:
|
testStable:
|
||||||
stage: test
|
stage: test
|
||||||
script:
|
script:
|
||||||
|
- npmci npm prepare
|
||||||
- npmci node install stable
|
- npmci node install stable
|
||||||
- npmci npm install
|
- npmci npm install
|
||||||
- npmci npm test
|
- npmci npm test
|
||||||
@ -62,9 +68,10 @@ testStable:
|
|||||||
testBuild:
|
testBuild:
|
||||||
stage: test
|
stage: test
|
||||||
script:
|
script:
|
||||||
|
- npmci npm prepare
|
||||||
- npmci node install stable
|
- npmci node install stable
|
||||||
- npmci npm install
|
- npmci npm install
|
||||||
- npmci npm build
|
- npmci command npm run build
|
||||||
coverage: /\d+.?\d+?\%\s*coverage/
|
coverage: /\d+.?\d+?\%\s*coverage/
|
||||||
tags:
|
tags:
|
||||||
- docker
|
- docker
|
||||||
@ -90,9 +97,10 @@ codequality:
|
|||||||
only:
|
only:
|
||||||
- tags
|
- tags
|
||||||
script:
|
script:
|
||||||
- npmci command npm install -g typescript
|
- npmci command npm install -g tslint typescript
|
||||||
- npmci npm prepare
|
- npmci npm prepare
|
||||||
- npmci npm install
|
- npmci npm install
|
||||||
|
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
|
||||||
tags:
|
tags:
|
||||||
- lossless
|
- lossless
|
||||||
- docker
|
- docker
|
||||||
@ -112,9 +120,11 @@ trigger:
|
|||||||
pages:
|
pages:
|
||||||
stage: metadata
|
stage: metadata
|
||||||
script:
|
script:
|
||||||
- npmci node install stable
|
- npmci node install lts
|
||||||
|
- npmci command npm install -g @gitzone/tsdoc
|
||||||
|
- npmci npm prepare
|
||||||
- npmci npm install
|
- npmci npm install
|
||||||
- npmci command npm run buildDocs
|
- npmci command tsdoc
|
||||||
tags:
|
tags:
|
||||||
- lossless
|
- lossless
|
||||||
- docker
|
- docker
|
||||||
|
|||||||
119
changelog.md
119
changelog.md
@ -1,119 +0,0 @@
|
|||||||
# Changelog
|
|
||||||
|
|
||||||
## 2024-09-05 - 2.2.1 - fix(core)
|
|
||||||
Add --allowimplicitany flag to build script
|
|
||||||
|
|
||||||
- Updated the build script in package.json to include the --allowimplicitany flag for TypeScript compilation.
|
|
||||||
|
|
||||||
## 2024-09-05 - 2.2.0 - feat(smartjwt)
|
|
||||||
Add nested JWT functionality
|
|
||||||
|
|
||||||
- Introduce `isNestedJwt` method to check if an object contains a nested JWT
|
|
||||||
- Implement `verifyNestedJwt` method to validate nested JWTs
|
|
||||||
- Add `createNestedJwt` method to create nested JWTs with given payload
|
|
||||||
- Include `nestedJwtGuard` for guarding nested JWT objects
|
|
||||||
|
|
||||||
## 2024-08-26 - 2.1.0 - feat(core)
|
|
||||||
Enhanced JWT handling and key management
|
|
||||||
|
|
||||||
- Introduced the `IObjectWithJwt` type for improved type constraints.
|
|
||||||
- Added support for smartguard to create object guards with JWT validation.
|
|
||||||
- Upgraded dependencies to latest versions.
|
|
||||||
|
|
||||||
## 2024-05-29 - 2.0.4 - Maintenance
|
|
||||||
Minor updates and configuration changes.
|
|
||||||
|
|
||||||
- Updated project description.
|
|
||||||
- Modified tsconfig settings.
|
|
||||||
- Updated npmextra.json with githost.
|
|
||||||
|
|
||||||
## 2024-02-13 - 2.0.3 - Bug Fixes
|
|
||||||
Critical fixes in core functionalities.
|
|
||||||
|
|
||||||
- Fixed core issues.
|
|
||||||
|
|
||||||
## 2023-07-11 - 2.0.2 - Organizational Update
|
|
||||||
Switched to the new organizational scheme.
|
|
||||||
|
|
||||||
- Adjusted project structure to align with new organizational policies.
|
|
||||||
|
|
||||||
## 2022-12-22 - 2.0.1 - Bug Fixes
|
|
||||||
Critical fixes in core functionalities.
|
|
||||||
|
|
||||||
- Fixed core issues.
|
|
||||||
|
|
||||||
## 2022-10-24 - 2.0.0 - Major Update
|
|
||||||
Significant updates including breaking changes.
|
|
||||||
|
|
||||||
- **Breaking Change:** Switched project to ECMAScript modules.
|
|
||||||
|
|
||||||
## 2021-09-22 - 1.0.14 - Bug Fixes
|
|
||||||
Critical fixes in core functionalities.
|
|
||||||
|
|
||||||
- Fixed core issues.
|
|
||||||
|
|
||||||
## 2021-02-20 - 1.0.13 - Bug Fixes
|
|
||||||
Critical fixes in core functionalities.
|
|
||||||
|
|
||||||
- Fixed core issues.
|
|
||||||
|
|
||||||
## 2021-02-09 - 1.0.12 - Bug Fixes
|
|
||||||
Critical fixes in core functionalities.
|
|
||||||
|
|
||||||
- Fixed core issues.
|
|
||||||
|
|
||||||
## 2021-02-09 - 1.0.11 - Bug Fixes
|
|
||||||
Critical fixes in core functionalities.
|
|
||||||
|
|
||||||
- Fixed core issues.
|
|
||||||
|
|
||||||
## 2020-03-28 - 1.0.10 - Bug Fixes
|
|
||||||
Critical fixes in core functionalities.
|
|
||||||
|
|
||||||
- Fixed core issues.
|
|
||||||
|
|
||||||
## 2019-10-01 - 1.0.9 - Bug Fixes
|
|
||||||
Critical fixes in core functionalities.
|
|
||||||
|
|
||||||
- Fixed core issues.
|
|
||||||
|
|
||||||
## 2019-10-01 - 1.0.8 - Bug Fixes
|
|
||||||
Critical fixes in core functionalities.
|
|
||||||
|
|
||||||
- Fixed core issues.
|
|
||||||
|
|
||||||
## 2019-10-01 - 1.0.7 - Bug Fixes
|
|
||||||
Critical fixes in core functionalities.
|
|
||||||
|
|
||||||
- Fixed core issues.
|
|
||||||
|
|
||||||
## 2019-10-01 - 1.0.6 - Bug Fixes
|
|
||||||
Critical fixes in core functionalities.
|
|
||||||
|
|
||||||
- Fixed core issues.
|
|
||||||
|
|
||||||
## 2019-10-01 - 1.0.5 - Bug Fixes
|
|
||||||
Critical fixes in core functionalities.
|
|
||||||
|
|
||||||
- Fixed core issues.
|
|
||||||
|
|
||||||
## 2019-10-01 - 1.0.4 - Bug Fixes
|
|
||||||
Critical fixes in core functionalities.
|
|
||||||
|
|
||||||
- Fixed core issues.
|
|
||||||
|
|
||||||
## 2019-02-23 - 1.0.3 - Bug Fixes
|
|
||||||
Critical fixes in core functionalities.
|
|
||||||
|
|
||||||
- Fixed core issues.
|
|
||||||
|
|
||||||
## 2019-02-23 - 1.0.2 - Bug Fixes
|
|
||||||
Critical fixes in core functionalities.
|
|
||||||
|
|
||||||
- Fixed core issues.
|
|
||||||
|
|
||||||
## 2019-02-23 - 1.0.1 - Bug Fixes
|
|
||||||
Critical fixes in core functionalities.
|
|
||||||
|
|
||||||
- Fixed core issues.
|
|
||||||
|
|
||||||
@ -2,32 +2,17 @@
|
|||||||
"gitzone": {
|
"gitzone": {
|
||||||
"projectType": "npm",
|
"projectType": "npm",
|
||||||
"module": {
|
"module": {
|
||||||
"githost": "code.foss.global",
|
"githost": "gitlab.com",
|
||||||
"gitscope": "push.rocks",
|
"gitscope": "pushrocks",
|
||||||
"gitrepo": "smartjwt",
|
"gitrepo": "smartjwt",
|
||||||
"description": "A JavaScript package for creating and verifying JWTs with strong typing support.",
|
"shortDescription": "a package for handling jwt",
|
||||||
"npmPackagename": "@push.rocks/smartjwt",
|
"npmPackagename": "@pushrocks/smartjwt",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"projectDomain": "push.rocks",
|
"projectDomain": "push.rocks"
|
||||||
"keywords": [
|
|
||||||
"jwt",
|
|
||||||
"jsonwebtoken",
|
|
||||||
"authentication",
|
|
||||||
"security",
|
|
||||||
"typescript",
|
|
||||||
"crypto",
|
|
||||||
"public key",
|
|
||||||
"private key",
|
|
||||||
"token validation",
|
|
||||||
"token creation"
|
|
||||||
]
|
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"npmci": {
|
"npmci": {
|
||||||
"npmGlobalTools": [],
|
"npmGlobalTools": [],
|
||||||
"npmAccessLevel": "public"
|
"npmAccessLevel": "public"
|
||||||
},
|
|
||||||
"tsdoc": {
|
|
||||||
"legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
26187
package-lock.json
generated
Normal file
26187
package-lock.json
generated
Normal file
File diff suppressed because it is too large
Load Diff
49
package.json
49
package.json
@ -1,30 +1,29 @@
|
|||||||
{
|
{
|
||||||
"name": "@push.rocks/smartjwt",
|
"name": "@pushrocks/smartjwt",
|
||||||
"version": "2.2.1",
|
"version": "1.0.14",
|
||||||
"private": false,
|
"private": false,
|
||||||
"description": "A JavaScript package for creating and verifying JWTs with strong typing support.",
|
"description": "a package for handling jwt",
|
||||||
"main": "dist_ts/index.js",
|
"main": "dist_ts/index.js",
|
||||||
"typings": "dist_ts/index.d.ts",
|
"typings": "dist_ts/index.d.ts",
|
||||||
"author": "Lossless GmbH",
|
"author": "Lossless GmbH",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"test": "(tstest test/)",
|
"test": "(tstest test/)",
|
||||||
"build": "(tsbuild --allowimplicitany)"
|
"build": "(tsbuild)",
|
||||||
|
"format": "(gitzone format)"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@git.zone/tsbuild": "^2.1.84",
|
"@gitzone/tsbuild": "^2.1.27",
|
||||||
"@git.zone/tsrun": "^1.2.49",
|
"@gitzone/tstest": "^1.0.57",
|
||||||
"@git.zone/tstest": "^1.0.90",
|
"@pushrocks/tapbundle": "^3.2.14",
|
||||||
"@push.rocks/tapbundle": "^5.0.24",
|
"@types/node": "^16.9.6",
|
||||||
"@types/node": "^22.5.0"
|
"tslint": "^6.1.3",
|
||||||
|
"tslint-config-prettier": "^1.15.0"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@push.rocks/smartcrypto": "^2.0.4",
|
"@pushrocks/smartcrypto": "^1.0.11",
|
||||||
"@push.rocks/smartguard": "^3.1.0",
|
"@types/jsonwebtoken": "^8.5.5",
|
||||||
"@push.rocks/smartjson": "^5.0.20",
|
"jsonwebtoken": "^8.5.1"
|
||||||
"@tsclass/tsclass": "^4.1.2",
|
|
||||||
"@types/jsonwebtoken": "^9.0.6",
|
|
||||||
"jsonwebtoken": "^9.0.2"
|
|
||||||
},
|
},
|
||||||
"files": [
|
"files": [
|
||||||
"ts/**/*",
|
"ts/**/*",
|
||||||
@ -40,23 +39,5 @@
|
|||||||
],
|
],
|
||||||
"browserslist": [
|
"browserslist": [
|
||||||
"last 1 chrome versions"
|
"last 1 chrome versions"
|
||||||
],
|
]
|
||||||
"type": "module",
|
|
||||||
"keywords": [
|
|
||||||
"jwt",
|
|
||||||
"jsonwebtoken",
|
|
||||||
"authentication",
|
|
||||||
"security",
|
|
||||||
"typescript",
|
|
||||||
"crypto",
|
|
||||||
"public key",
|
|
||||||
"private key",
|
|
||||||
"token validation",
|
|
||||||
"token creation"
|
|
||||||
],
|
|
||||||
"homepage": "https://code.foss.global/push.rocks/smartjwt",
|
|
||||||
"repository": {
|
|
||||||
"type": "git",
|
|
||||||
"url": "https://code.foss.global/push.rocks/smartjwt.git"
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|||||||
6884
pnpm-lock.yaml
generated
6884
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
@ -1 +0,0 @@
|
|||||||
|
|
||||||
165
readme.md
165
readme.md
@ -1,151 +1,42 @@
|
|||||||
# @push.rocks/smartjwt
|
# @pushrocks/smartjwt
|
||||||
a package for handling jwt
|
a package for handling jwt
|
||||||
|
|
||||||
## Install
|
## Availabililty and Links
|
||||||
To install @push.rocks/smartjwt, use npm or yarn as follows:
|
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartjwt)
|
||||||
|
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartjwt)
|
||||||
|
* [github.com (source mirror)](https://github.com/pushrocks/smartjwt)
|
||||||
|
* [docs (typedoc)](https://pushrocks.gitlab.io/smartjwt/)
|
||||||
|
|
||||||
```bash
|
## Status for master
|
||||||
npm install @push.rocks/smartjwt --save
|
|
||||||
# or with yarn
|
|
||||||
yarn add @push.rocks/smartjwt
|
|
||||||
```
|
|
||||||
|
|
||||||
Make sure you have Node.js installed on your machine. This library uses modern JavaScript features and requires Node.js version 10.x.x or higher.
|
Status Category | Status Badge
|
||||||
|
-- | --
|
||||||
|
GitLab Pipelines | [](https://lossless.cloud)
|
||||||
|
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
||||||
|
npm | [](https://lossless.cloud)
|
||||||
|
Snyk | [](https://lossless.cloud)
|
||||||
|
TypeScript Support | [](https://lossless.cloud)
|
||||||
|
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||||
|
Code Style | [](https://lossless.cloud)
|
||||||
|
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
||||||
|
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
||||||
|
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
||||||
|
Platform support | [](https://lossless.cloud) [](https://lossless.cloud)
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
This section illustrates how to use the `@push.rocks/smartjwt` package to handle JSON Web Tokens (JWT) in your TypeScript projects with practical and comprehensive examples. Before diving into the scenarios, ensure you have the package installed and are comfortable with TypeScript and async/await syntax.
|
## Contribution
|
||||||
|
|
||||||
### Initializing and Creating a New Key Pair
|
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
|
||||||
|
|
||||||
To utilize `smartjwt` for creating and verifying JWTs, you first need to instantiate `SmartJwt` class and generate or set a key pair (a private and a public key). Let's start by initializing and creating a new key pair:
|
|
||||||
|
|
||||||
```typescript
|
## Contribution
|
||||||
import { SmartJwt } from '@push.rocks/smartjwt';
|
|
||||||
|
|
||||||
async function setup() {
|
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
|
||||||
const smartJwt = new SmartJwt();
|
|
||||||
await smartJwt.createNewKeyPair();
|
|
||||||
console.log('Key pair created successfully');
|
|
||||||
}
|
|
||||||
setup();
|
|
||||||
```
|
|
||||||
|
|
||||||
### Creating a JWT
|
For further information read the linked docs at the top of this readme.
|
||||||
|
|
||||||
Once you have your key pair ready, you can create JWTs by supplying a payload. The payload is the data you want to encode in your JWT. Here's an example of how to create a JWT:
|
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||||
|
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
||||||
|
|
||||||
```typescript
|
[](https://maintainedby.lossless.com)
|
||||||
interface MyPayload {
|
|
||||||
user_id: number;
|
|
||||||
username: string;
|
|
||||||
}
|
|
||||||
|
|
||||||
async function createJwt() {
|
|
||||||
const smartJwt = new SmartJwt<MyPayload>();
|
|
||||||
await smartJwt.createNewKeyPair();
|
|
||||||
const myPayload = {
|
|
||||||
user_id: 123,
|
|
||||||
username: 'example_username'
|
|
||||||
};
|
|
||||||
const jwt = await smartJwt.createJWT(myPayload);
|
|
||||||
console.log(jwt);
|
|
||||||
}
|
|
||||||
createJwt();
|
|
||||||
```
|
|
||||||
|
|
||||||
### Verifying a JWT and Extracting the Payload
|
|
||||||
|
|
||||||
Verifying a JWT is crucial for authentication and authorization processes in applications. When you receive a JWT, you need to verify its integrity and authenticity before trusting the contained information. Here’s how to verify a JWT and extract its payload:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
async function verifyJwt(jwt: string) {
|
|
||||||
const smartJwt = new SmartJwt<MyPayload>();
|
|
||||||
// In a real application, you should set the public key from a trusted source.
|
|
||||||
smartJwt.setPublicPemKeyForVerification('<Your_Public_Key>');
|
|
||||||
|
|
||||||
try {
|
|
||||||
const payload = await smartJwt.verifyJWTAndGetData(jwt);
|
|
||||||
console.log('JWT verified successfully:', payload);
|
|
||||||
} catch (error) {
|
|
||||||
console.error('Failed to verify JWT:', error);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Handling Public and Private Keys
|
|
||||||
|
|
||||||
In scenarios where you have existing keys or receive them from an external source, `smartjwt` allows setting the public and private keys directly instead of generating new ones. Here is an example:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
async function setExistingKeys() {
|
|
||||||
const smartJwt = new SmartJwt<MyPayload>();
|
|
||||||
const privateKeyString = '<Your_Private_Key_PEM_String>';
|
|
||||||
const publicKeyString = '<Your_Public_Key_PEM_String>';
|
|
||||||
|
|
||||||
smartJwt.setPrivateKeyFromPemString(privateKeyString);
|
|
||||||
smartJwt.setPublicKeyFromPemString(publicKeyString);
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Exporting and Importing Key Pairs
|
|
||||||
|
|
||||||
You may need to store your key pairs securely or share them across different parts of your application or with other services securely. `smartjwt` offers a convenient way to export and import key pairs as JSON:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
async function exportAndImportKeyPair() {
|
|
||||||
const smartJwt = new SmartJwt();
|
|
||||||
await smartJwt.createNewKeyPair();
|
|
||||||
const keyPairJson = smartJwt.getKeyPairAsJson();
|
|
||||||
console.log('Exported Key Pair:', keyPairJson);
|
|
||||||
|
|
||||||
const newSmartJwt = new SmartJwt();
|
|
||||||
newSmartJwt.setKeyPairAsJson(keyPairJson);
|
|
||||||
console.log('Imported Key Pair Successfully');
|
|
||||||
}
|
|
||||||
exportAndImportKeyPair();
|
|
||||||
```
|
|
||||||
|
|
||||||
### Complete Scenario: Signing and Verifying a JWT
|
|
||||||
|
|
||||||
Bringing it all together, here is a complete scenario where a JWT is created, signed, and later verified:
|
|
||||||
|
|
||||||
```typescript
|
|
||||||
async function completeScenario() {
|
|
||||||
// Creating a new JWT
|
|
||||||
const smartJwt = new SmartJwt<MyPayload>();
|
|
||||||
await smartJwt.createNewKeyPair();
|
|
||||||
const jwt = await smartJwt.createJWT({ user_id: 123, username: 'exampleuser' });
|
|
||||||
console.log('Created JWT:', jwt);
|
|
||||||
|
|
||||||
// Verifying the JWT in another instance or part of the application
|
|
||||||
const verifier = new SmartJwt<MyPayload>();
|
|
||||||
verifier.setPublicPemKeyForVerification(smartJwt.publicKey.toPemString());
|
|
||||||
const verifiedPayload = await verifier.verifyJWTAndGetData(jwt);
|
|
||||||
console.log('Verified Payload:', verifiedPayload);
|
|
||||||
}
|
|
||||||
completeScenario();
|
|
||||||
```
|
|
||||||
|
|
||||||
By following these examples, you can effectively handle JWT creation, signing, verification, and key management in your TypeScript projects using the `@push.rocks/smartjwt` package. Always ensure to manage your keys securely and avoid exposing sensitive information.
|
|
||||||
|
|
||||||
For further information and advanced features, consult the project's documentation and source code.
|
|
||||||
|
|
||||||
## License and Legal Information
|
|
||||||
|
|
||||||
This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository.
|
|
||||||
|
|
||||||
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
|
|
||||||
|
|
||||||
### Trademarks
|
|
||||||
|
|
||||||
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
|
|
||||||
|
|
||||||
### Company Information
|
|
||||||
|
|
||||||
Task Venture Capital GmbH
|
|
||||||
Registered at District court Bremen HRB 35230 HB, Germany
|
|
||||||
|
|
||||||
For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
|
|
||||||
|
|
||||||
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.
|
|
||||||
|
|||||||
@ -1,5 +1,5 @@
|
|||||||
import { expect, tap } from '@push.rocks/tapbundle';
|
import { expect, tap } from '@pushrocks/tapbundle';
|
||||||
import * as smartjwt from '../ts/index.js';
|
import * as smartjwt from '../ts/index';
|
||||||
|
|
||||||
let smartjwtInstance: smartjwt.SmartJwt;
|
let smartjwtInstance: smartjwt.SmartJwt;
|
||||||
let testJwt: string;
|
let testJwt: string;
|
||||||
@ -22,7 +22,7 @@ tap.test('should create a new jwt', async () => {
|
|||||||
tap.test('should verify a jwt', async () => {
|
tap.test('should verify a jwt', async () => {
|
||||||
const data = await smartjwtInstance.verifyJWTAndGetData(testJwt);
|
const data = await smartjwtInstance.verifyJWTAndGetData(testJwt);
|
||||||
// tslint:disable-next-line: no-unused-expression
|
// tslint:disable-next-line: no-unused-expression
|
||||||
expect(data).not.toBeNull();
|
expect(data).to.not.be.null;
|
||||||
console.log(data);
|
console.log(data);
|
||||||
console.log(smartjwtInstance.publicKey.toPemString());
|
console.log(smartjwtInstance.publicKey.toPemString());
|
||||||
});
|
});
|
||||||
@ -38,7 +38,7 @@ tap.test('should not verify a wrong jwt', async () => {
|
|||||||
} catch (e: any) {
|
} catch (e: any) {
|
||||||
error = e;
|
error = e;
|
||||||
}
|
}
|
||||||
expect(error).toBeInstanceOf(Error);
|
expect(error).to.be.instanceOf(Error);
|
||||||
});
|
});
|
||||||
|
|
||||||
tap.test('should verify a jwt on another instance', async () => {
|
tap.test('should verify a jwt on another instance', async () => {
|
||||||
|
|||||||
@ -1,8 +0,0 @@
|
|||||||
/**
|
|
||||||
* autocreated commitinfo by @push.rocks/commitinfo
|
|
||||||
*/
|
|
||||||
export const commitinfo = {
|
|
||||||
name: '@push.rocks/smartjwt',
|
|
||||||
version: '2.2.1',
|
|
||||||
description: 'A JavaScript package for creating and verifying JWTs with strong typing support.'
|
|
||||||
}
|
|
||||||
@ -1 +1 @@
|
|||||||
export * from './smartjwt.classes.smartjwt.js';
|
export * from './smartjwt.classes.smartjwt';
|
||||||
|
|||||||
@ -1,7 +1,9 @@
|
|||||||
import * as plugins from './smartjwt.plugins.js';
|
import * as plugins from './smartjwt.plugins';
|
||||||
|
|
||||||
// Define the IWithJwt interface with a constraint that T must be an object
|
export interface ISmartJWTJSONKeypair {
|
||||||
export type IObjectWithJwt<T extends object> = T & { jwt: string };
|
privatePem: string;
|
||||||
|
publicPem: string;
|
||||||
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A class to create and validate JWTs and their keys
|
* A class to create and validate JWTs and their keys
|
||||||
@ -49,7 +51,7 @@ export class SmartJwt<T extends object = any> {
|
|||||||
/**
|
/**
|
||||||
* gets the currently set kaypair as json
|
* gets the currently set kaypair as json
|
||||||
*/
|
*/
|
||||||
public getKeyPairAsJson(): plugins.tsclass.network.IJwtKeypair {
|
public getKeyPairAsJson(): ISmartJWTJSONKeypair {
|
||||||
return {
|
return {
|
||||||
privatePem: this.privateKey.toPemString(),
|
privatePem: this.privateKey.toPemString(),
|
||||||
publicPem: this.publicKey.toPemString(),
|
publicPem: this.publicKey.toPemString(),
|
||||||
@ -59,7 +61,7 @@ export class SmartJwt<T extends object = any> {
|
|||||||
/**
|
/**
|
||||||
* sets the currently set keypair as json
|
* sets the currently set keypair as json
|
||||||
*/
|
*/
|
||||||
public setKeyPairAsJson(jsonKeyPair: plugins.tsclass.network.IJwtKeypair) {
|
public setKeyPairAsJson(jsonKeyPair: ISmartJWTJSONKeypair) {
|
||||||
this.privateKey = plugins.smartcrypto.PrivateKey.fromPemString(jsonKeyPair.privatePem);
|
this.privateKey = plugins.smartcrypto.PrivateKey.fromPemString(jsonKeyPair.privatePem);
|
||||||
this.publicKey = plugins.smartcrypto.PublicKey.fromPemString(jsonKeyPair.publicPem);
|
this.publicKey = plugins.smartcrypto.PublicKey.fromPemString(jsonKeyPair.publicPem);
|
||||||
}
|
}
|
||||||
@ -84,38 +86,4 @@ export class SmartJwt<T extends object = any> {
|
|||||||
public async init() {
|
public async init() {
|
||||||
await this.createNewKeyPair();
|
await this.createNewKeyPair();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
public isNestedJwt<T extends object>(
|
|
||||||
object: unknown,
|
|
||||||
): object is IObjectWithJwt<T> {
|
|
||||||
return (
|
|
||||||
typeof object === 'object' &&
|
|
||||||
object !== null &&
|
|
||||||
'jwt' in object &&
|
|
||||||
typeof (object as IObjectWithJwt<T>).jwt === 'string'
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
public async verifyNestedJwt<T extends object>(object: IObjectWithJwt<T>) {
|
|
||||||
const jwtData = await this.verifyJWTAndGetData(object.jwt);
|
|
||||||
(jwtData as any).jwt = object.jwt;
|
|
||||||
return plugins.smartjson.deepEqualObjects(object, jwtData);
|
|
||||||
}
|
|
||||||
|
|
||||||
public async createNestedJwt<T extends object>(payloadArg: T): Promise<IObjectWithJwt<T>> {
|
|
||||||
const jwt = await this.createJWT(payloadArg as any);
|
|
||||||
return {
|
|
||||||
...payloadArg,
|
|
||||||
jwt,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
public nestedJwtGuard = new plugins.smartguard.Guard(async (dataArg: IObjectWithJwt<any>) => {
|
|
||||||
return this.verifyNestedJwt(dataArg);
|
|
||||||
}, {
|
|
||||||
name: 'jwtObjectGuard',
|
|
||||||
failedHint: 'is not a valid jwt object',
|
|
||||||
})
|
|
||||||
}
|
}
|
||||||
|
|||||||
@ -1,17 +1,8 @@
|
|||||||
// @pushrocks scope
|
// @pushrocks scope
|
||||||
import * as smartcrypto from '@push.rocks/smartcrypto';
|
import * as smartcrypto from '@pushrocks/smartcrypto';
|
||||||
import * as smartguard from '@push.rocks/smartguard';
|
|
||||||
import * as smartjson from '@push.rocks/smartjson';
|
|
||||||
|
|
||||||
export { smartcrypto, smartguard, smartjson };
|
export { smartcrypto };
|
||||||
|
|
||||||
// thirdparty scope
|
// thirdparty scope
|
||||||
import jsonwebtoken from 'jsonwebtoken';
|
import * as jsonwebtoken from 'jsonwebtoken';
|
||||||
export { jsonwebtoken };
|
export { jsonwebtoken };
|
||||||
|
|
||||||
// @tsclass scope
|
|
||||||
import * as tsclass from '@tsclass/tsclass';
|
|
||||||
|
|
||||||
export {
|
|
||||||
tsclass
|
|
||||||
};
|
|
||||||
|
|||||||
@ -1,14 +0,0 @@
|
|||||||
{
|
|
||||||
"compilerOptions": {
|
|
||||||
"experimentalDecorators": true,
|
|
||||||
"useDefineForClassFields": false,
|
|
||||||
"target": "ES2022",
|
|
||||||
"module": "NodeNext",
|
|
||||||
"moduleResolution": "NodeNext",
|
|
||||||
"esModuleInterop": true,
|
|
||||||
"verbatimModuleSyntax": true
|
|
||||||
},
|
|
||||||
"exclude": [
|
|
||||||
"dist_*/**/*.d.ts"
|
|
||||||
]
|
|
||||||
}
|
|
||||||
17
tslint.json
Normal file
17
tslint.json
Normal file
@ -0,0 +1,17 @@
|
|||||||
|
{
|
||||||
|
"extends": ["tslint:latest", "tslint-config-prettier"],
|
||||||
|
"rules": {
|
||||||
|
"semicolon": [true, "always"],
|
||||||
|
"no-console": false,
|
||||||
|
"ordered-imports": false,
|
||||||
|
"object-literal-sort-keys": false,
|
||||||
|
"member-ordering": {
|
||||||
|
"options":{
|
||||||
|
"order": [
|
||||||
|
"static-method"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"defaultSeverity": "warning"
|
||||||
|
}
|
||||||
Loading…
x
Reference in New Issue
Block a user