Skip to content

Commit

Permalink
fixed some broken links in autogenerated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
juanelas committed Apr 16, 2023
1 parent a844236 commit 786358b
Show file tree
Hide file tree
Showing 47 changed files with 310 additions and 377 deletions.
77 changes: 0 additions & 77 deletions .github/workflows/automatic-publication.yml

This file was deleted.

3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
[![License: EUPL-1.2](https://img.shields.io/badge/license-EUPL--1.2-green.svg)](LICENSE)
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE_OF_CONDUCT.md)
[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
[![Node.js CI](https://github.com/i3-Market-V2-Public-Repository/SP3-SCGBSSW-CR-NonRepudiationLibrary/actions/workflows/build-and-test.yml/badge.svg)](https://github.com/i3-Market-V2-Public-Repository/SP3-SCGBSSW-CR-NonRepudiationLibrary/actions/workflows/build-and-test.yml)

# @i3m/non-repudiation-library

Expand Down Expand Up @@ -37,7 +38,7 @@ import * as nonRepudiationLibrary from '@i3m/non-repudiation-library'

The appropriate version for browser or node is automatically exported.

You can also download the [IIFE bundle](https://raw.githubusercontent.com/i3-Market-V2-Public-Repository/SP3-SCGBSSW-CR-NonRepudiationLibrary/main/dist/bundle.iife.js), the [ESM bundle](https://raw.githubusercontent.com/i3-Market-V2-Public-Repository/SP3-SCGBSSW-CR-NonRepudiationLibrary/main/dist/bundle.esm.min.js) or the [UMD bundle](https://raw.githubusercontent.com/i3-Market-V2-Public-Repository/SP3-SCGBSSW-CR-NonRepudiationLibrary/main/dist/bundle.umd.js) and manually add it to your project, or, if you have already installed `@i3m/non-repudiation-library` in your project, just get the bundles from `node_modules/@i3m/non-repudiation-library/dist/bundles/`.
You can also download the [IIFE bundle](https://raw.githubusercontent.com/i3-Market-V2-Public-Repository/SP3-SCGBSSW-CR-NonRepudiationLibrary/public/dist/bundle.iife.js), the [ESM bundle](https://raw.githubusercontent.com/i3-Market-V2-Public-Repository/SP3-SCGBSSW-CR-NonRepudiationLibrary/public/dist/bundle.esm.min.js) or the [UMD bundle](https://raw.githubusercontent.com/i3-Market-V2-Public-Repository/SP3-SCGBSSW-CR-NonRepudiationLibrary/public/dist/bundle.umd.js) and manually add it to your project, or, if you have already installed `@i3m/non-repudiation-library` in your project, just get the bundles from `node_modules/@i3m/non-repudiation-library/dist/bundles/`.

### Example for an i3-MARKET Provider running the Non-Repudiation Protocol

Expand Down
64 changes: 32 additions & 32 deletions docs/API.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ ___

#### Defined in

[src/ts/types.ts:13](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/58c6997/src/ts/types.ts#L13)
[src/ts/types.ts:13](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/a844236/src/ts/types.ts#L13)

___

Expand All @@ -125,7 +125,7 @@ ___

#### Defined in

[src/ts/types.ts:11](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/58c6997/src/ts/types.ts#L11)
[src/ts/types.ts:11](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/a844236/src/ts/types.ts#L11)

___

Expand All @@ -135,7 +135,7 @@ ___

#### Defined in

[src/ts/types.ts:9](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/58c6997/src/ts/types.ts#L9)
[src/ts/types.ts:9](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/a844236/src/ts/types.ts#L9)

___

Expand Down Expand Up @@ -188,7 +188,7 @@ ___

#### Defined in

[src/ts/types.ts:177](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/58c6997/src/ts/types.ts#L177)
[src/ts/types.ts:177](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/a844236/src/ts/types.ts#L177)

___

Expand All @@ -198,7 +198,7 @@ ___

#### Defined in

[src/ts/types.ts:10](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/58c6997/src/ts/types.ts#L10)
[src/ts/types.ts:10](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/a844236/src/ts/types.ts#L10)

___

Expand Down Expand Up @@ -229,7 +229,7 @@ ___

#### Defined in

[src/ts/types.ts:175](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/58c6997/src/ts/types.ts#L175)
[src/ts/types.ts:175](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/a844236/src/ts/types.ts#L175)

## Variables

Expand All @@ -239,7 +239,7 @@ ___

#### Defined in

[src/ts/constants.ts:3](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/58c6997/src/ts/constants.ts#L3)
[src/ts/constants.ts:3](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/a844236/src/ts/constants.ts#L3)

___

Expand All @@ -249,7 +249,7 @@ ___

#### Defined in

[src/ts/constants.ts:1](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/58c6997/src/ts/constants.ts#L1)
[src/ts/constants.ts:1](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/a844236/src/ts/constants.ts#L1)

___

Expand All @@ -259,7 +259,7 @@ ___

#### Defined in

[src/ts/constants.ts:4](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/58c6997/src/ts/constants.ts#L4)
[src/ts/constants.ts:4](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/a844236/src/ts/constants.ts#L4)

___

Expand All @@ -269,7 +269,7 @@ ___

#### Defined in

[src/ts/constants.ts:2](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/58c6997/src/ts/constants.ts#L2)
[src/ts/constants.ts:2](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/a844236/src/ts/constants.ts#L2)

___

Expand All @@ -279,7 +279,7 @@ ___

#### Defined in

[src/ts/dlt/defaultDltConfig.ts:3](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/58c6997/src/ts/dlt/defaultDltConfig.ts#L3)
[src/ts/dlt/defaultDltConfig.ts:3](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/a844236/src/ts/dlt/defaultDltConfig.ts#L3)

## Functions

Expand All @@ -302,7 +302,7 @@ ___

#### Defined in

[src/ts/utils/timestamps.ts:3](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/58c6997/src/ts/utils/timestamps.ts#L3)
[src/ts/utils/timestamps.ts:3](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/a844236/src/ts/utils/timestamps.ts#L3)

___

Expand Down Expand Up @@ -333,7 +333,7 @@ a proof as a compact JWS formatted JWT string

#### Defined in

[src/ts/proofs/createProof.ts:13](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/58c6997/src/ts/proofs/createProof.ts#L13)
[src/ts/proofs/createProof.ts:13](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/a844236/src/ts/proofs/createProof.ts#L13)

___

Expand All @@ -359,7 +359,7 @@ the exchange id in hexadecimal

#### Defined in

[src/ts/exchange/exchangeId.ts:13](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/58c6997/src/ts/exchange/exchangeId.ts#L13)
[src/ts/exchange/exchangeId.ts:13](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/a844236/src/ts/exchange/exchangeId.ts#L13)

___

Expand All @@ -383,7 +383,7 @@ Generates a pair of JWK signing/verification keys

#### Defined in

[src/ts/crypto/generateKeys.ts:18](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/58c6997/src/ts/crypto/generateKeys.ts#L18)
[src/ts/crypto/generateKeys.ts:18](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/a844236/src/ts/crypto/generateKeys.ts#L18)

___

Expand All @@ -403,7 +403,7 @@ ___

#### Defined in

[src/ts/utils/getDltAddress.ts:4](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/58c6997/src/ts/utils/getDltAddress.ts#L4)
[src/ts/utils/getDltAddress.ts:4](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/a844236/src/ts/utils/getDltAddress.ts#L4)

___

Expand All @@ -424,7 +424,7 @@ ___

#### Defined in

[src/ts/crypto/importJwk.ts:6](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/58c6997/src/ts/crypto/importJwk.ts#L6)
[src/ts/crypto/importJwk.ts:6](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/a844236/src/ts/crypto/importJwk.ts#L6)

___

Expand All @@ -444,7 +444,7 @@ ___

#### Defined in

[src/ts/utils/jsonSort.ts:5](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/58c6997/src/ts/utils/jsonSort.ts#L5)
[src/ts/utils/jsonSort.ts:5](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/a844236/src/ts/utils/jsonSort.ts#L5)

___

Expand All @@ -469,7 +469,7 @@ the plaintext

#### Defined in

[src/ts/crypto/jwe.ts:56](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/58c6997/src/ts/crypto/jwe.ts#L56)
[src/ts/crypto/jwe.ts:56](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/a844236/src/ts/crypto/jwe.ts#L56)

___

Expand All @@ -495,7 +495,7 @@ a Compact JWE

#### Defined in

[src/ts/crypto/jwe.ts:15](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/58c6997/src/ts/crypto/jwe.ts#L15)
[src/ts/crypto/jwe.ts:15](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/a844236/src/ts/crypto/jwe.ts#L15)

___

Expand Down Expand Up @@ -524,7 +524,7 @@ Decodes and optionally verifies a JWS, and returns the decoded header, payload.

#### Defined in

[src/ts/crypto/jwsDecode.ts:12](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/58c6997/src/ts/crypto/jwsDecode.ts#L12)
[src/ts/crypto/jwsDecode.ts:12](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/a844236/src/ts/crypto/jwsDecode.ts#L12)

___

Expand All @@ -550,7 +550,7 @@ a promise that resolves to the secret in JWK and raw hex string

#### Defined in

[src/ts/crypto/oneTimeSecret.ts:19](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/58c6997/src/ts/crypto/oneTimeSecret.ts#L19)
[src/ts/crypto/oneTimeSecret.ts:19](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/a844236/src/ts/crypto/oneTimeSecret.ts#L19)

___

Expand All @@ -572,7 +572,7 @@ Verifies and returns the ethereum address in EIP-55 format

#### Defined in

[src/ts/utils/parseAddress.ts:9](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/58c6997/src/ts/utils/parseAddress.ts#L9)
[src/ts/utils/parseAddress.ts:9](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/a844236/src/ts/utils/parseAddress.ts#L9)

___

Expand All @@ -594,7 +594,7 @@ ___

#### Defined in

[src/ts/utils/parseHex.ts:4](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/58c6997/src/ts/utils/parseHex.ts#L4)
[src/ts/utils/parseHex.ts:4](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/a844236/src/ts/utils/parseHex.ts#L4)

___

Expand All @@ -615,7 +615,7 @@ ___

#### Defined in

[src/ts/utils/parseJwk.ts:6](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/58c6997/src/ts/utils/parseJwk.ts#L6)
[src/ts/utils/parseJwk.ts:6](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/a844236/src/ts/utils/parseJwk.ts#L6)

**parseJwk**(`jwk`, `stringify`): `Promise`<[`JWK`](interfaces/JWK.md)\>

Expand All @@ -632,7 +632,7 @@ ___

#### Defined in

[src/ts/utils/parseJwk.ts:7](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/58c6997/src/ts/utils/parseJwk.ts#L7)
[src/ts/utils/parseJwk.ts:7](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/a844236/src/ts/utils/parseJwk.ts#L7)

___

Expand All @@ -653,7 +653,7 @@ ___

#### Defined in

[src/ts/utils/sha.ts:5](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/58c6997/src/ts/utils/sha.ts#L5)
[src/ts/utils/sha.ts:5](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/a844236/src/ts/utils/sha.ts#L5)

___

Expand All @@ -673,7 +673,7 @@ ___

#### Defined in

[src/ts/exchange/checkAgreement.ts:52](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/58c6997/src/ts/exchange/checkAgreement.ts#L52)
[src/ts/exchange/checkAgreement.ts:52](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/a844236/src/ts/exchange/checkAgreement.ts#L52)

___

Expand All @@ -693,7 +693,7 @@ ___

#### Defined in

[src/ts/exchange/checkAgreement.ts:73](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/58c6997/src/ts/exchange/checkAgreement.ts#L73)
[src/ts/exchange/checkAgreement.ts:73](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/a844236/src/ts/exchange/checkAgreement.ts#L73)

___

Expand All @@ -713,7 +713,7 @@ ___

#### Defined in

[src/ts/exchange/checkAgreement.ts:20](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/58c6997/src/ts/exchange/checkAgreement.ts#L20)
[src/ts/exchange/checkAgreement.ts:20](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/a844236/src/ts/exchange/checkAgreement.ts#L20)

___

Expand All @@ -734,7 +734,7 @@ ___

#### Defined in

[src/ts/crypto/verifyKeyPair.ts:7](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/58c6997/src/ts/crypto/verifyKeyPair.ts#L7)
[src/ts/crypto/verifyKeyPair.ts:7](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/a844236/src/ts/crypto/verifyKeyPair.ts#L7)

___

Expand Down Expand Up @@ -766,4 +766,4 @@ The JWT protected header and payload if the proof is validated

#### Defined in

[src/ts/proofs/verifyProof.ts:29](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/58c6997/src/ts/proofs/verifyProof.ts#L29)
[src/ts/proofs/verifyProof.ts:29](https://gitlab.com/i3-market/code/wp3/t3.2/conflict-resolution/non-repudiation-library/-/blob/a844236/src/ts/proofs/verifyProof.ts#L29)
Loading

0 comments on commit 786358b

Please sign in to comment.