6 Commits

Author SHA1 Message Date
94a1f693d3 2.0.0 2022-10-24 07:14:18 +02:00
60da639d69 BREAKING CHANGE(core): switch to esm 2022-10-24 07:14:17 +02:00
85d958e424 1.0.14 2021-09-22 01:29:47 +02:00
0dc089f811 fix(core): update 2021-09-22 01:29:47 +02:00
f4448d8501 1.0.13 2021-02-20 18:02:53 +00:00
d36056bd46 fix(core): update 2021-02-20 18:02:53 +00:00
16 changed files with 4606 additions and 11380 deletions

4
.gitignore vendored
View File

@ -15,8 +15,6 @@ node_modules/
# builds # builds
dist/ dist/
dist_web/ dist_*/
dist_serve/
dist_ts_web/
# custom # custom

View File

@ -4,35 +4,46 @@ image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
cache: cache:
paths: paths:
- .npmci_cache/ - .npmci_cache/
key: "$CI_BUILD_STAGE" key: '$CI_BUILD_STAGE'
stages: stages:
- security - security
- test - test
- release - release
- metadata - metadata
before_script:
- pnpm install -g pnpm
- pnpm install -g @shipzone/npmci
- npmci npm prepare
# ==================== # ====================
# security stage # security stage
# ==================== # ====================
mirror: # ====================
# security stage
# ====================
auditProductionDependencies:
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
stage: security stage: security
script: script:
- npmci git mirror - npmci command npm config set registry https://registry.npmjs.org
- npmci command pnpm audit --audit-level=high --prod
tags: tags:
- lossless
- docker - docker
- notpriv allow_failure: true
snyk: auditDevDependencies:
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
stage: security stage: security
script: script:
- npmci npm prepare - npmci command npm config set registry https://registry.npmjs.org
- npmci command npm install -g snyk - npmci command pnpm audit --audit-level=high --dev
- npmci command npm install --ignore-scripts
- npmci command snyk test
tags: tags:
- lossless
- docker - docker
- notpriv allow_failure: true
# ==================== # ====================
# test stage # test stage
@ -41,26 +52,22 @@ snyk:
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
coverage: /\d+.?\d+?\%\s*coverage/ coverage: /\d+.?\d+?\%\s*coverage/
tags: tags:
- docker - docker
- priv
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 command npm run build - npmci command npm run build
coverage: /\d+.?\d+?\%\s*coverage/ coverage: /\d+.?\d+?\%\s*coverage/
tags: tags:
- docker - docker
- notpriv
release: release:
stage: release stage: release
@ -70,6 +77,7 @@ release:
only: only:
- tags - tags
tags: tags:
- lossless
- docker - docker
- notpriv - notpriv
@ -79,12 +87,14 @@ release:
codequality: codequality:
stage: metadata stage: metadata
allow_failure: true allow_failure: true
only:
- tags
script: script:
- npmci command npm install -g tslint typescript - npmci command npm install -g typescript
- npmci npm prepare - npmci npm prepare
- npmci npm install - npmci npm install
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
tags: tags:
- lossless
- docker - docker
- priv - priv
@ -95,20 +105,18 @@ trigger:
only: only:
- tags - tags
tags: tags:
- lossless
- docker - docker
- notpriv - notpriv
pages: pages:
image: hosttoday/ht-docker-dbase:npmci
services:
- docker:stable-dind
stage: metadata stage: metadata
script: script:
- npmci command npm install -g @gitzone/tsdoc - npmci node install stable
- npmci npm prepare
- npmci npm install - npmci npm install
- npmci command tsdoc - npmci command npm run buildDocs
tags: tags:
- lossless
- docker - docker
- notpriv - notpriv
only: only:

11
.vscode/launch.json vendored Normal file
View File

@ -0,0 +1,11 @@
{
"version": "0.2.0",
"configurations": [
{
"command": "npm test",
"name": "Run npm test",
"request": "launch",
"type": "node-terminal"
}
]
}

26
.vscode/settings.json vendored Normal file
View File

@ -0,0 +1,26 @@
{
"json.schemas": [
{
"fileMatch": ["/npmextra.json"],
"schema": {
"type": "object",
"properties": {
"npmci": {
"type": "object",
"description": "settings for npmci"
},
"gitzone": {
"type": "object",
"description": "settings for gitzone",
"properties": {
"projectType": {
"type": "string",
"enum": ["website", "element", "service", "npm", "wcc"]
}
}
}
}
}
}
]
}

View File

@ -1,10 +1,11 @@
{ {
"gitzone": { "gitzone": {
"projectType": "npm",
"module": { "module": {
"githost": "gitlab.com", "githost": "gitlab.com",
"gitscope": "pushrocks", "gitscope": "pushrocks",
"gitrepo": "smartjwt", "gitrepo": "smartjwt",
"shortDescription": "a package for handling jwt", "description": "a package for handling jwt",
"npmPackagename": "@pushrocks/smartjwt", "npmPackagename": "@pushrocks/smartjwt",
"license": "MIT", "license": "MIT",
"projectDomain": "push.rocks" "projectDomain": "push.rocks"

11276
package-lock.json generated

File diff suppressed because it is too large Load Diff

View File

@ -1,6 +1,6 @@
{ {
"name": "@pushrocks/smartjwt", "name": "@pushrocks/smartjwt",
"version": "1.0.12", "version": "2.0.0",
"private": false, "private": false,
"description": "a package for handling jwt", "description": "a package for handling jwt",
"main": "dist_ts/index.js", "main": "dist_ts/index.js",
@ -10,30 +10,35 @@
"scripts": { "scripts": {
"test": "(tstest test/)", "test": "(tstest test/)",
"build": "(tsbuild)", "build": "(tsbuild)",
"format": "(gitzone format)" "format": "(gitzone format)",
"buildDocs": "tsdoc"
}, },
"devDependencies": { "devDependencies": {
"@gitzone/tsbuild": "^2.1.25", "@gitzone/tsbuild": "^2.1.28",
"@gitzone/tstest": "^1.0.52", "@gitzone/tsrun": "^1.2.39",
"@pushrocks/tapbundle": "^3.2.10", "@gitzone/tstest": "^1.0.59",
"@types/node": "^14.14.25", "@pushrocks/tapbundle": "^5.0.4",
"tslint": "^6.1.3", "@types/node": "^18.11.4"
"tslint-config-prettier": "^1.15.0"
}, },
"dependencies": { "dependencies": {
"@pushrocks/smartcrypto": "^1.0.9", "@pushrocks/smartcrypto": "^2.0.1",
"@types/jsonwebtoken": "^8.5.0", "@types/jsonwebtoken": "^8.5.5",
"jsonwebtoken": "^8.5.1" "jsonwebtoken": "^8.5.1"
}, },
"files": [ "files": [
"ts/*", "ts/**/*",
"ts_web/*", "ts_web/**/*",
"dist/*", "dist/**/*",
"dist_web/*", "dist_*/**/*",
"dist_ts_web/*", "dist_ts/**/*",
"assets/*", "dist_ts_web/**/*",
"assets/**/*",
"cli.js", "cli.js",
"npmextra.json", "npmextra.json",
"readme.md" "readme.md"
] ],
"browserslist": [
"last 1 chrome versions"
],
"type": "module"
} }

4437
pnpm-lock.yaml generated Normal file

File diff suppressed because it is too large Load Diff

View File

@ -8,16 +8,31 @@ a package for handling jwt
* [docs (typedoc)](https://pushrocks.gitlab.io/smartjwt/) * [docs (typedoc)](https://pushrocks.gitlab.io/smartjwt/)
## Status for master ## Status for master
[![build status](https://gitlab.com/pushrocks/smartjwt/badges/master/build.svg)](https://gitlab.com/pushrocks/smartjwt/commits/master)
[![coverage report](https://gitlab.com/pushrocks/smartjwt/badges/master/coverage.svg)](https://gitlab.com/pushrocks/smartjwt/commits/master) Status Category | Status Badge
[![npm downloads per month](https://img.shields.io/npm/dm/@pushrocks/smartjwt.svg)](https://www.npmjs.com/package/@pushrocks/smartjwt) -- | --
[![Known Vulnerabilities](https://snyk.io/test/npm/@pushrocks/smartjwt/badge.svg)](https://snyk.io/test/npm/@pushrocks/smartjwt) GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartjwt/badges/master/pipeline.svg)](https://lossless.cloud)
[![TypeScript](https://img.shields.io/badge/TypeScript->=%203.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/) GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartjwt/badges/master/coverage.svg)](https://lossless.cloud)
[![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/) npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartjwt)](https://lossless.cloud)
[![JavaScript Style Guide](https://img.shields.io/badge/code%20style-prettier-ff69b4.svg)](https://prettier.io/) Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/smartjwt)](https://lossless.cloud)
TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud)
node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud)
PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@pushrocks/smartjwt)](https://lossless.cloud)
PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartjwt)](https://lossless.cloud)
BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smartjwt)](https://lossless.cloud)
Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud)
## Usage ## Usage
## Contribution
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). :)
## Contribution
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). :)
For further information read the linked docs at the top of this readme. For further information read the linked docs at the top of this readme.
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh) > MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)

View File

@ -1,5 +1,5 @@
import { expect, tap } from '@pushrocks/tapbundle'; import { expect, tap } from '@pushrocks/tapbundle';
import * as smartjwt from '../ts/index'; import * as smartjwt from '../ts/index.js';
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).to.not.be.null; expect(data).not.toBeNull();
console.log(data); console.log(data);
console.log(smartjwtInstance.publicKey.toPemString()); console.log(smartjwtInstance.publicKey.toPemString());
}); });
@ -35,10 +35,10 @@ tap.test('should not verify a wrong jwt', async () => {
let error: Error; let error: Error;
try { try {
await smartjwtInstance.verifyJWTAndGetData(newJwt); await smartjwtInstance.verifyJWTAndGetData(newJwt);
} catch (e) { } catch (e: any) {
error = e; error = e;
} }
expect(error).to.be.instanceOf(Error); expect(error).toBeInstanceOf(Error);
}); });
tap.test('should verify a jwt on another instance', async () => { tap.test('should verify a jwt on another instance', async () => {

8
ts/00_commitinfo_data.ts Normal file
View File

@ -0,0 +1,8 @@
/**
* autocreated commitinfo by @pushrocks/commitinfo
*/
export const commitinfo = {
name: '@pushrocks/smartjwt',
version: '2.0.0',
description: 'a package for handling jwt'
}

View File

@ -1 +1 @@
export * from './smartjwt.classes.smartjwt'; export * from './smartjwt.classes.smartjwt.js';

View File

@ -1,4 +1,4 @@
import * as plugins from './smartjwt.plugins'; import * as plugins from './smartjwt.plugins.js';
export interface ISmartJWTJSONKeypair { export interface ISmartJWTJSONKeypair {
privatePem: string; privatePem: string;
@ -20,7 +20,7 @@ export class SmartJwt<T extends object = any> {
*/ */
public async createJWT(payloadArg: T) { public async createJWT(payloadArg: T) {
return plugins.jsonwebtoken.sign(payloadArg, this.privateKey.toPemString(), { return plugins.jsonwebtoken.sign(payloadArg, this.privateKey.toPemString(), {
algorithm: 'RS256' algorithm: 'RS256',
}); });
} }
@ -29,7 +29,7 @@ export class SmartJwt<T extends object = any> {
*/ */
public async verifyJWTAndGetData(jwtArg: string): Promise<T> { public async verifyJWTAndGetData(jwtArg: string): Promise<T> {
const result = plugins.jsonwebtoken.verify(jwtArg, this.publicKey.toPemString(), { const result = plugins.jsonwebtoken.verify(jwtArg, this.publicKey.toPemString(), {
algorithms: ['RS256'] algorithms: ['RS256'],
}); });
return result as any; return result as any;
} }
@ -54,7 +54,7 @@ export class SmartJwt<T extends object = any> {
public getKeyPairAsJson(): ISmartJWTJSONKeypair { public getKeyPairAsJson(): ISmartJWTJSONKeypair {
return { return {
privatePem: this.privateKey.toPemString(), privatePem: this.privateKey.toPemString(),
publicPem: this.publicKey.toPemString() publicPem: this.publicKey.toPemString(),
}; };
} }

View File

@ -4,5 +4,5 @@ import * as smartcrypto from '@pushrocks/smartcrypto';
export { smartcrypto }; export { smartcrypto };
// thirdparty scope // thirdparty scope
import * as jsonwebtoken from 'jsonwebtoken'; import jsonwebtoken from 'jsonwebtoken';
export { jsonwebtoken }; export { jsonwebtoken };

10
tsconfig.json Normal file
View File

@ -0,0 +1,10 @@
{
"compilerOptions": {
"experimentalDecorators": true,
"useDefineForClassFields": false,
"target": "ES2022",
"module": "ES2022",
"moduleResolution": "nodenext",
"esModuleInterop": true
}
}

View File

@ -1,17 +0,0 @@
{
"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"
}