dan/jose
1
0
Fork 0
mirror of https://github.com/danbulant/jose synced 2026-05-24 12:35:36 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

chore: update build deps and docs

Browse source
This commit is contained in:
Filip Skokan 2021-03-15 15:49:11 +01:00
parent 5cba6b0fdd
commit edfc6863e5
6 changed files with 46 additions and 179 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
README.md
View file

@ -54,31 +54,31 @@ npm install jose@npm:jose-browser-runtime
## Documentation ## Documentation
- JSON Web Tokens (JWT) - JSON Web Tokens (JWT)
- [Signing](docs/classes/_jwt_sign_.signjwt.md#readme) - [Signing](docs/classes/jwt_sign.signjwt.md#readme)
- [Verification & Claims Set Validation](docs/functions/_jwt_verify_.jwtverify.md#readme) - [Verification & Claims Set Validation](docs/functions/jwt_verify.jwtverify.md#readme)
- Encrypted JSON Web Tokens - Encrypted JSON Web Tokens
- [Encryption](docs/classes/_jwt_encrypt_.encryptjwt.md#readme) - [Encryption](docs/classes/jwt_encrypt.encryptjwt.md#readme)
- [Decryption & Claims Set Validation](docs/functions/_jwt_decrypt_.jwtdecrypt.md#readme) - [Decryption & Claims Set Validation](docs/functions/jwt_decrypt.jwtdecrypt.md#readme)
- JSON Web Encryption (JWE) - JSON Web Encryption (JWE)
- Encryption - [Compact](docs/classes/_jwe_compact_encrypt_.compactencrypt.md#readme), [Flattened](docs/classes/_jwe_flattened_encrypt_.flattenedencrypt.md#readme) - Encryption - [Compact](docs/classes/jwe_compact_encrypt.compactencrypt.md#readme), [Flattened](docs/classes/jwe_flattened_encrypt.flattenedencrypt.md#readme)
- Decryption - [Compact](docs/functions/_jwe_compact_decrypt_.compactdecrypt.md#readme), [Flattened](docs/functions/_jwe_flattened_decrypt_.flatteneddecrypt.md#readme), [General](docs/functions/_jwe_general_decrypt_.generaldecrypt.md#readme) - Decryption - [Compact](docs/functions/jwe_compact_decrypt.compactdecrypt.md#readme), [Flattened](docs/functions/jwe_flattened_decrypt.flatteneddecrypt.md#readme), [General](docs/functions/jwe_general_decrypt.generaldecrypt.md#readme)
- JSON Web Signature (JWS) - JSON Web Signature (JWS)
- Signing - [Compact](docs/classes/_jws_compact_sign_.compactsign.md#readme), [Flattened](docs/classes/_jws_flattened_sign_.flattenedsign.md#readme), [General](docs/classes/_jws_general_sign_.generalsign.md#readme) - Signing - [Compact](docs/classes/jws_compact_sign.compactsign.md#readme), [Flattened](docs/classes/jws_flattened_sign.flattenedsign.md#readme), [General](docs/classes/jws_general_sign.generalsign.md#readme)
- Verification - [Compact](docs/functions/_jws_compact_verify_.compactverify.md#readme), [Flattened](docs/functions/_jws_flattened_verify_.flattenedverify.md#readme), [General](docs/functions/_jws_general_verify_.generalverify.md#readme) - Verification - [Compact](docs/functions/jws_compact_verify.compactverify.md#readme), [Flattened](docs/functions/jws_flattened_verify.flattenedverify.md#readme), [General](docs/functions/jws_general_verify.generalverify.md#readme)
- JSON Web Key (JWK) - JSON Web Key (JWK)
- [Parsing (JWK to KeyLike)](docs/functions/_jwk_parse_.parsejwk.md#readme) - [Parsing (JWK to KeyLike)](docs/functions/jwk_parse.parsejwk.md#readme)
- [Conversion (KeyLike to JWK)](docs/functions/_jwk_from_key_like_.fromkeylike.md#readme) - [Conversion (KeyLike to JWK)](docs/functions/jwk_from_key_like.fromkeylike.md#readme)
- [Thumbprints](docs/functions/_jwk_thumbprint_.calculatethumbprint.md#readme) - [Thumbprints](docs/functions/jwk_thumbprint.calculatethumbprint.md#readme)
- [EmbeddedJWK](docs/functions/_jwk_embedded_.embeddedjwk.md#readme) - [EmbeddedJWK](docs/functions/jwk_embedded.embeddedjwk.md#readme)
- JSON Web Key Set (JWKS) - JSON Web Key Set (JWKS)
- [Verify using a remote JWKSet](docs/functions/_jwks_remote_.createremotejwkset.md#readme) - [Verify using a remote JWKSet](docs/functions/jwks_remote.createremotejwkset.md#readme)
- Key Pair or Secret Generation (Generate KeyLike) - Key Pair or Secret Generation (Generate KeyLike)
- [Asymmetric Key Pair Generation](docs/functions/_util_generate_key_pair_.generatekeypair.md#readme) - [Asymmetric Key Pair Generation](docs/functions/util_generate_key_pair.generatekeypair.md#readme)
- [Symmetric Secret Generation](docs/functions/_util_generate_secret_.generatesecret.md#readme) - [Symmetric Secret Generation](docs/functions/util_generate_secret.generatesecret.md#readme)
- Utilities - Utilities
- [Decoding Token's Protected Header](docs/functions/_util_decode_protected_header_.decodeprotectedheader.md#readme) - [Decoding Token's Protected Header](docs/functions/util_decode_protected_header.decodeprotectedheader.md#readme)
- [Unsecured JWT](docs/classes/_jwt_unsecured_.unsecuredjwt.md#readme) - [Unsecured JWT](docs/classes/jwt_unsecured.unsecuredjwt.md#readme)
- [JOSE Errors](docs/modules/_util_errors_.md) - [JOSE Errors](docs/modules/util_errors.md)
## Examples ## Examples

36
docs/README.md
View file

@ -9,30 +9,30 @@ If you or your business use `jose`, please consider becoming a [sponsor][support
## Available modules ## Available modules
- JSON Web Tokens (JWT) - JSON Web Tokens (JWT)
- [Signing](classes/_jwt_sign_.signjwt.md#readme) - [Signing](classes/jwt_sign.signjwt.md#readme)
- [Verification & Claims Set Validation](functions/_jwt_verify_.jwtverify.md#readme) - [Verification & Claims Set Validation](functions/jwt_verify.jwtverify.md#readme)
- Encrypted JSON Web Tokens - Encrypted JSON Web Tokens
- [Encryption](classes/_jwt_encrypt_.encryptjwt.md#readme) - [Encryption](classes/jwt_encrypt.encryptjwt.md#readme)
- [Decryption & Claims Set Validation](functions/_jwt_decrypt_.jwtdecrypt.md#readme) - [Decryption & Claims Set Validation](functions/jwt_decrypt.jwtdecrypt.md#readme)
- JSON Web Encryption (JWE) - JSON Web Encryption (JWE)
- Encryption - [Compact](classes/_jwe_compact_encrypt_.compactencrypt.md#readme), [Flattened](classes/_jwe_flattened_encrypt_.flattenedencrypt.md#readme) - Encryption - [Compact](classes/jwe_compact_encrypt.compactencrypt.md#readme), [Flattened](classes/jwe_flattened_encrypt.flattenedencrypt.md#readme)
- Decryption - [Compact](functions/_jwe_compact_decrypt_.compactdecrypt.md#readme), [Flattened](functions/_jwe_flattened_decrypt_.flatteneddecrypt.md#readme), [General](functions/_jwe_general_decrypt_.generaldecrypt.md#readme) - Decryption - [Compact](functions/jwe_compact_decrypt.compactdecrypt.md#readme), [Flattened](functions/jwe_flattened_decrypt.flatteneddecrypt.md#readme), [General](functions/jwe_general_decrypt.generaldecrypt.md#readme)
- JSON Web Signature (JWS) - JSON Web Signature (JWS)
- Signing - [Compact](classes/_jws_compact_sign_.compactsign.md#readme), [Flattened](classes/_jws_flattened_sign_.flattenedsign.md#readme), [General](classes/_jws_general_sign_.generalsign.md#readme) - Signing - [Compact](classes/jws_compact_sign.compactsign.md#readme), [Flattened](classes/jws_flattened_sign.flattenedsign.md#readme), [General](classes/jws_general_sign.generalsign.md#readme)
- Verification - [Compact](functions/_jws_compact_verify_.compactverify.md#readme), [Flattened](functions/_jws_flattened_verify_.flattenedverify.md#readme), [General](functions/_jws_general_verify_.generalverify.md#readme) - Verification - [Compact](functions/jws_compact_verify.compactverify.md#readme), [Flattened](functions/jws_flattened_verify.flattenedverify.md#readme), [General](functions/jws_general_verify.generalverify.md#readme)
- JSON Web Key (JWK) - JSON Web Key (JWK)
- [Parsing (JWK to KeyLike)](functions/_jwk_parse_.parsejwk.md#readme) - [Parsing (JWK to KeyLike)](functions/jwk_parse.parsejwk.md#readme)
- [Conversion (KeyLike to JWK)](functions/_jwk_from_key_like_.fromkeylike.md#readme) - [Conversion (KeyLike to JWK)](functions/jwk_from_key_like.fromkeylike.md#readme)
- [Thumbprints](functions/_jwk_thumbprint_.calculatethumbprint.md#readme) - [Thumbprints](functions/jwk_thumbprint.calculatethumbprint.md#readme)
- [EmbeddedJWK](functions/_jwk_embedded_.embeddedjwk.md#readme) - [EmbeddedJWK](functions/jwk_embedded.embeddedjwk.md#readme)
- JSON Web Key Set (JWKS) - JSON Web Key Set (JWKS)
- [Verify using a remote JWKSet](functions/_jwks_remote_.createremotejwkset.md#readme) - [Verify using a remote JWKSet](functions/jwks_remote.createremotejwkset.md#readme)
- Key Pair or Secret Generation (Generate KeyLike) - Key Pair or Secret Generation (Generate KeyLike)
- [Asymmetric Key Pair Generation](functions/_util_generate_key_pair_.generatekeypair.md#readme) - [Asymmetric Key Pair Generation](functions/util_generate_key_pair.generatekeypair.md#readme)
- [Symmetric Secret Generation](functions/_util_generate_secret_.generatesecret.md#readme) - [Symmetric Secret Generation](functions/util_generate_secret.generatesecret.md#readme)
- Utilities - Utilities
- [Decoding Token's Protected Header](functions/_util_decode_protected_header_.decodeprotectedheader.md#readme) - [Decoding Token's Protected Header](functions/util_decode_protected_header.decodeprotectedheader.md#readme)
- [Unsecured JWT](classes/_jwt_unsecured_.unsecuredjwt.md#readme) - [Unsecured JWT](classes/jwt_unsecured.unsecuredjwt.md#readme)
- [JOSE Errors](modules/_util_errors_.md) - [JOSE Errors](modules/util_errors.md)
[support-sponsor]: https://github.com/sponsors/panva [support-sponsor]: https://github.com/sponsors/panva

18
package.json
View file

@ -331,7 +331,7 @@
"coverage-cryptokey": "npm run-script runtime-node && c8 npm run-script test-cryptokey", "coverage-cryptokey": "npm run-script runtime-node && c8 npm run-script test-cryptokey",
"coverage-webcrypto": "npm run-script runtime-node-webcrypto && c8 npm run-script test-webcrypto", "coverage-webcrypto": "npm run-script runtime-node-webcrypto && c8 npm run-script test-webcrypto",
"docs": "run-s docs:*", "docs": "run-s docs:*",
"docs:generate": "typedoc --disableOutputCheck --excludeNotExported --excludePrivate --excludeProtected --gitRevision main --readme none --listInvalidSymbolLinks --plugin typedoc-plugin-markdown --out docs --includeDeclarations --excludeExternals --tsconfig ./tsconfig/browser.json --mode modules src/types.d.ts src/jwt/*.ts src/jwe/**/*.ts src/jws/**/*.ts src/jwk/*.ts src/jwks/*.ts src/util/*.ts --hideProjectName --hideGenerator --allReflectionsHaveOwnDocument --hideBreadcrumbs", "docs:generate": "typedoc --allReflectionsHaveOwnDocument --excludePrivate --excludeProtected --gitRevision main --readme none --plugin typedoc-plugin-markdown --out docs --excludeExternals --tsconfig ./tsconfig/browser.json --hideGenerator --hideBreadcrumbs src/types.d.ts src/jwt/*.ts src/jwe/**/*.ts src/jws/**/*.ts src/jwk/*.ts src/jwks/*.ts src/util/*.ts",
"esbuild-find": "find src -type f -name '*.ts' -not -path '*/runtime/*/*' -not -name '*.d.ts' -print0", "esbuild-find": "find src -type f -name '*.ts' -not -path '*/runtime/*/*' -not -name '*.d.ts' -print0",
"lint": "eslint --config ./src/.eslintrc.json ./src", "lint": "eslint --config ./src/.eslintrc.json ./src",
"runtime-browser": "run-s runtime:clear runtime:browser:* runtime:refs", "runtime-browser": "run-s runtime:clear runtime:browser:* runtime:refs",
@ -354,13 +354,13 @@
"ava": "^3.13.0", "ava": "^3.13.0",
"bowser": "^2.11.0", "bowser": "^2.11.0",
"c8": "^7.3.5", "c8": "^7.3.5",
"esbuild": "0.8.31", "esbuild": "^0.9.2",
"eslint": "7.17.0", "eslint": "^7.22.0",
"eslint-config-airbnb-base": "14.2.1", "eslint-config-airbnb-base": "14.2.1",
"eslint-config-airbnb-typescript": "12.0.0", "eslint-config-airbnb-typescript": "^12.3.1",
"eslint-config-prettier": "7.1.0", "eslint-config-prettier": "^8.1.0",
"eslint-plugin-import": "2.22.1", "eslint-plugin-import": "2.22.1",
"eslint-plugin-jsdoc": "30.7.13", "eslint-plugin-jsdoc": "^32.3.0",
"glob": "^7.1.6", "glob": "^7.1.6",
"karma": "^5.2.3", "karma": "^5.2.3",
"karma-brief-reporter": "0.2.1", "karma-brief-reporter": "0.2.1",
@ -371,9 +371,9 @@
"prettier": "^2.2.0", "prettier": "^2.2.0",
"qunit": "^2.12.0", "qunit": "^2.12.0",
"timekeeper": "^2.2.0", "timekeeper": "^2.2.0",
"typedoc": "0.19.2", "typedoc": "^0.20.32",
"typedoc-plugin-markdown": "3.1.1", "typedoc-plugin-markdown": "^3.6.0",
"typescript": "4.0.5" "typescript": "^4.2.3"
}, },
"typesVersions": { "typesVersions": {
"*": { "*": {

19
tools/docs.postbump.js
View file

@ -2,29 +2,12 @@ require("./explode-exports");
const { execSync } = require("child_process"); const { execSync } = require("child_process");
const { readFileSync, writeFileSync } = require("fs"); const { readFileSync, writeFileSync } = require("fs");
const { version } = require("../package.json"); const { version } = require("../package.json");
const { sync: glob } = require("glob");
const readme = readFileSync("docs/README.md"); const readme = readFileSync("docs/README.md");
const tagName = `v${version}`; const tagName = `v${version}`;
execSync("git rm docs/**/*.md");
execSync('find docs -type d | grep "docs/" | xargs rm -rf'); execSync('find docs -type d | grep "docs/" | xargs rm -rf');
writeFileSync(
"node_modules/typedoc-plugin-markdown/dist/resources/partials/member.sources.hbs",
readFileSync("tools/member.sources.hbs")
);
writeFileSync(
"node_modules/typedoc-plugin-markdown/dist/resources/templates/reflection.hbs",
readFileSync("tools/reflection.hbs")
);
execSync(`npm run docs:generate -- --gitRevision ${tagName}`); execSync(`npm run docs:generate -- --gitRevision ${tagName}`);
glob("docs/**/*.md").forEach((md) => {
writeFileSync(
md,
readFileSync(md)
.toString()
.replace(/```\n\/\//g, "```js\n//")
.replace(/undefined \\\| /g, "")
);
});
writeFileSync("docs/README.md", readme); writeFileSync("docs/README.md", readme);
execSync("git add docs/**/*.md"); execSync("git add docs/**/*.md");

33
tools/member.sources.hbs
View file

@ -1,33 +0,0 @@
{{#if implementationOf}}
*Implementation of {{#with implementationOf}}{{typeAndParent}}{{/with}}*
{{/if}}
{{#if overwrites}}
*Overrides {{#with overwrites}}{{typeAndParent}}{{/with}}*
{{/if}}
{{#ifShowSources}}
{{#if sources}}
{{#each sources}}
{{#if url}}
*Defined in [{{fileName}}:{{line}}]({{url}})*
{{else}}
*Defined in {{fileName}}:{{line}}*
{{/if}}
{{/each}}
{{/if}}
{{/ifShowSources}}

83
tools/reflection.hbs
View file

@ -1,83 +0,0 @@
{{> header showTitle=true}}
{{#with model}}
{{#if hasComment}}
{{> comment}}
{{/if}}
{{/with}}
{{#if model.typeParameters}}
## Type parameters
{{#with model.typeParameters}}
{{{parameterTable 'typeParameters'}}}
{{/with}}
{{/if}}
{{#if model.implementedTypes}}
## Implements
{{#each model.implementedTypes}}
* {{{type false}}}
{{/each}}
{{/if}}
{{#if model.implementedBy}}
## Implemented by
{{#each model.implementedBy}}
* {{{type false}}}
{{/each}}
{{/if}}
{{#if model.signatures}}
## Callable
{{#with model}}
{{#each signatures}}
{{> member.signature }}
{{/each}}
{{/with}}
{{/if}}
{{#if model.indexSignature}}
## Indexable
{{#with model}}
{{#with indexSignature}}
{{{indexSignatureTitle}}}
{{> comment}}
{{/with}}
{{/with}}
{{/if}}
{{#with model}}
{{> main}}
{{/with}}