export vp #423

nitro-neal · 2024-02-22T16:09:47Z

Exporting Verifiable Presentation

github-actions · 2024-02-22T16:13:38Z

TBDocs Report

🛑 Errors: 0
⚠️ Warnings: 130

@web5/api

Project entry file: packages/api/src/index.ts

📄 File: ./packages/api/src/protocol.ts
⚠️ `extractor:typedoc:missing-reference`: ProtocolMetadata is referenced by Protocol._metadata but not included in the documentation.
⚠️ `extractor:typedoc:missing-docs`: Protocol._agent (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Protocol._metadata (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Protocol._protocolsConfigureMessage (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Protocol.send.__type.status (Property) does not have any documentation.

📄 File: ./packages/api/src/send-cache.ts
⚠️ `extractor:typedoc:missing-reference`: SendCache is referenced by Record._sendCache but not included in the documentation.

📄 File: ./packages/api/src/web5.ts
⚠️ `extractor:typedoc:missing-reference`: Web5Options is referenced by Web5.constructor.new Web5.options but not included in the documentation.
⚠️ `extractor:typedoc:missing-docs`: TechPreviewOptions.__type.dwnEndpoints (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Web5ConnectOptions.__type.connectedDid (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Web5.connect.__type.web5 (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Web5.connect.__type.did (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Web5.connectedDid (Property) does not have any documentation.

📄 File: ./packages/api/src/utils.ts
⚠️ `extractor:typedoc:missing-docs`: utils.dataToBlob.__type.dataBlob (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: utils.dataToBlob.__type.dataFormat (Property) does not have any documentation.

📄 File: ./packages/api/src/did-api.ts
⚠️ `extractor:typedoc:missing-docs`: DidApi.agent (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: DidApi.connectedDid (Property) does not have any documentation.

📄 File: ./packages/api/src/dwn-api.ts
⚠️ `extractor:typedoc:missing-docs`: ResponseStatus.__type.status (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: ResponseStatus.__type.status.__type.code (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: ResponseStatus.__type.status.__type.detail (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: ProtocolsConfigureRequest.__type.message (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: ProtocolsConfigureResponse.__type.protocol (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: ProtocolsQueryReplyEntry.__type.descriptor (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: ProtocolsQueryRequest.__type.from (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: ProtocolsQueryRequest.__type.message (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: ProtocolsQueryResponse.__type.protocols (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordsCreateFromRequest.__type.author (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordsCreateFromRequest.__type.data (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordsCreateFromRequest.__type.message (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordsCreateFromRequest.__type.record (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordsDeleteRequest.__type.from (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordsDeleteRequest.__type.message (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordsQueryRequest.__type.message (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordsQueryResponse.__type.records (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordsReadRequest.__type.message (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordsReadResponse.__type.record (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordsWriteRequest.__type.data (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordsWriteRequest.__type.message (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordsWriteRequest.__type.store (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordsWriteResponse.__type.record (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: DwnApi.agent (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: DwnApi.connectedDid (Property) does not have any documentation.

📄 File: ./packages/api/src/record.ts
⚠️ `extractor:typedoc:missing-docs`: RecordOptions.__type.author (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordOptions.__type.connectedDid (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordOptions.__type.encodedData (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordOptions.__type.data (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordOptions.__type.initialWrite (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordOptions.__type.protocolRole (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordOptions.__type.remoteOrigin (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordModel.__type.author (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordModel.__type.protocolRole (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordModel.__type.recordId (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordUpdateOptions.__type.data (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordUpdateOptions.__type.dataCid (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordUpdateOptions.__type.dataSize (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordUpdateOptions.__type.dateModified (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordUpdateOptions.__type.datePublished (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordUpdateOptions.__type.published (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: RecordUpdateOptions.__type.protocolRole (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record._sendCache (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record._agent (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record._connectedDid (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record._encodedData (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record._readableStream (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record._remoteOrigin (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record._author (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record._attestation (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record._authorization (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record._contextId (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record._descriptor (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record._encryption (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record._initialWrite (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record._initialWriteStored (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record._initialWriteSigned (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record._recordId (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record._protocolRole (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record.data.__type.then (CallSignature) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record.data.__type.catch (CallSignature) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Record.processRecord (CallSignature) does not have any documentation.

📄 File: ./packages/api/src/vc-api.ts
⚠️ `extractor:typedoc:missing-docs`: VcApi.agent (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: VcApi.connectedDid (Property) does not have any documentation.

🔀 Misc.
⚠️ `extractor:typedoc:invalid-link`: Failed to resolve link to "@web5/agent#Web5Agent" in comment for Web5ConnectOptions.__type.agent. You may have wanted "@web5/agent!Web5Agent"
⚠️ `extractor:typedoc:invalid-link`: Failed to resolve link to "@web5/user-agent#Web5UserAgent" in comment for Web5ConnectOptions.__type.agent. You may have wanted "@web5/user-agent!Web5UserAgent"
⚠️ `extractor:typedoc:invalid-link`: Failed to resolve link to "@web5/agent#AppDataStore" in comment for Web5ConnectOptions.__type.appData. You may have wanted "@web5/agent!AppDataStore"
⚠️ `extractor:typedoc:invalid-link`: Failed to resolve link to "@web5/agent#AppDataStore" in comment for Web5ConnectOptions.__type.appData. You may have wanted "@web5/agent!AppDataStore"
⚠️ `extractor:typedoc:invalid-link`: Failed to resolve link to "@web5/agent#Web5Agent" in comment for Web5.connect. You may have wanted "@web5/agent!Web5Agent"
⚠️ `extractor:typedoc:invalid-link`: Failed to resolve link to "@web5/user-agent#Web5UserAgent" in comment for Web5.connect. You may have wanted "@web5/user-agent!Web5UserAgent"

@web5/crypto

Project entry file: packages/crypto/src/index.ts

@web5/crypto-aws-kms

Project entry file: packages/crypto-aws-kms/src/index.ts

📄 File: ./packages/crypto-aws-kms/src/ecdsa.ts
⚠️ `extractor:typedoc:missing-docs`: EcdsaAlgorithm (Class) does not have any documentation.

📄 File: ./packages/crypto-aws-kms/src/key-manager.ts
⚠️ `extractor:typedoc:missing-docs`: AwsKeyManager (Class) does not have any documentation.

📄 File: ./packages/crypto-aws-kms/src/utils.ts
⚠️ `extractor:typedoc:missing-docs`: getKeySpec (CallSignature) does not have any documentation.

🔀 Misc.
⚠️ `extractor:typedoc:invalid-link`: Failed to resolve link to "@web5/crypto#Secp256k1.adjustSignatureToLowS \| here" in comment for EcdsaAlgorithm.sign. You may have wanted "@web5/crypto!Secp256k1.adjustSignatureToLowS \| here"

@web5/dids

Project entry file: packages/dids/src/index.ts

@web5/credentials

Project entry file: packages/credentials/src/index.ts

📄 File: ./packages/credentials/src/jwt.ts
⚠️ `extractor:typedoc:missing-docs`: JwtParseResult.__type.decoded (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: JwtParseResult.__type.encoded (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: JwtParseResult.__type.encoded.__type.header (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: JwtParseResult.__type.encoded.__type.payload (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: JwtParseResult.__type.encoded.__type.signature (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: ParseJwtOptions.__type.jwt (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: SignJwtOptions.__type.signerDid (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: SignJwtOptions.__type.payload (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: VerifyJwtOptions.__type.jwt (Property) does not have any documentation.

📄 File: ./packages/credentials/src/presentation-exchange.ts
⚠️ `extractor:typedoc:missing-docs`: PresentationDefinitionV2 (Interface) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: Validated (TypeAlias) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: PresentationExchange (Class) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: PresentationExchange.resetPex (CallSignature) does not have any documentation.

📄 File: ./packages/credentials/src/verifiable-credential.ts
⚠️ `extractor:typedoc:missing-docs`: DEFAULT_VC_CONTEXT (Variable) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: DEFAULT_VC_TYPE (Variable) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: VerifiableCredentialCreateOptions.__type.type (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: VerifiableCredentialCreateOptions.__type.issuer (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: VerifiableCredentialCreateOptions.__type.subject (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: VerifiableCredentialCreateOptions.__type.data (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: VerifiableCredentialCreateOptions.__type.issuanceDate (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: VerifiableCredentialCreateOptions.__type.expirationDate (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: VerifiableCredentialSignOptions.__type.did (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: VerifiableCredential.verify.__type.issuer (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: VerifiableCredential.verify.__type.subject (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: VerifiableCredential.verify.__type.vc (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: VerifiableCredential.type (GetSignature) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: VerifiableCredential.issuer (GetSignature) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: VerifiableCredential.subject (GetSignature) does not have any documentation.

📄 File: ./packages/credentials/src/verifiable-presentation.ts
⚠️ `extractor:typedoc:missing-docs`: DEFAULT_VP_TYPE (Variable) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: VerifiablePresentationCreateOptions.__type.holder (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: VerifiablePresentationCreateOptions.__type.vcJwts (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: VerifiablePresentationCreateOptions.__type.type (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: VerifiablePresentationCreateOptions.__type.additionalData (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: VerifiablePresentationSignOptions.__type.did (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: VerifiablePresentation.verify.__type.issuer (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: VerifiablePresentation.verify.__type.subject (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: VerifiablePresentation.verify.__type.vc (Property) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: VerifiablePresentation.type (GetSignature) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: VerifiablePresentation.holder (GetSignature) does not have any documentation.
⚠️ `extractor:typedoc:missing-docs`: VerifiablePresentation.verifiableCredential (GetSignature) does not have any documentation.

TBDocs Report Updated at 2024-02-26T22:17:14Z 20b0578

codecov · 2024-02-22T16:24:13Z

Codecov Report

Merging #423 (20b0578) into main (60411c9) will increase coverage by 0.01%.
The diff coverage is 100.00%.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #423      +/-   ##
==========================================
+ Coverage   93.33%   93.34%   +0.01%     
==========================================
  Files          80       80              
  Lines       23804    23804              
  Branches     1890     1890              
==========================================
+ Hits        22217    22220       +3     
+ Misses       1547     1544       -3     
  Partials       40       40

Components	Coverage Δ
agent	`88.72% <ø> (ø)`
api	`97.30% <ø> (+0.18%)`	⬆️
common	`98.68% <ø> (ø)`
credentials	`94.77% <100.00%> (ø)`
crypto	`93.76% <ø> (ø)`
dids	`97.52% <ø> (ø)`
identity-agent	`56.81% <ø> (ø)`
crypto-aws-kms	`100.00% <ø> (ø)`
proxy-agent	`58.43% <ø> (ø)`
user-agent	`55.22% <ø> (ø)`

* export vp * fix unit test * fix test

export vp

f247f40

nitro-neal requested review from frankhinek, csuwildcat and mistermoe as code owners February 22, 2024 16:09

nitro-neal added 2 commits February 22, 2024 10:17

fix unit test

08a74dd

fix test

405c176

blackgirlbytes approved these changes Feb 22, 2024

View reviewed changes

mistermoe approved these changes Feb 22, 2024

View reviewed changes

Merge branch 'main' into export-vp

20b0578

nitro-neal requested review from jiyoonie9 and diehuxx as code owners February 26, 2024 22:13

frankhinek approved these changes Feb 26, 2024

View reviewed changes

nitro-neal merged commit ea9c48a into main Feb 27, 2024
34 checks passed

nitro-neal deleted the export-vp branch February 27, 2024 18:32

finn-block pushed a commit that referenced this pull request Mar 19, 2024

export vp (#423)

31f72dc

* export vp * fix unit test * fix test

finn-block pushed a commit that referenced this pull request Mar 19, 2024

export vp (#423)

836b89b

* export vp * fix unit test * fix test

finn-block pushed a commit that referenced this pull request Mar 19, 2024

export vp (#423)

6da41c7

* export vp * fix unit test * fix test

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

export vp #423

export vp #423

nitro-neal commented Feb 22, 2024

github-actions bot commented Feb 22, 2024 •

edited

Loading

codecov bot commented Feb 22, 2024 •

edited

Loading

export vp #423

export vp #423

Conversation

nitro-neal commented Feb 22, 2024

github-actions bot commented Feb 22, 2024 • edited Loading

@web5/api

@web5/crypto

@web5/crypto-aws-kms

@web5/dids

@web5/credentials

codecov bot commented Feb 22, 2024 • edited Loading

Codecov Report

github-actions bot commented Feb 22, 2024 •

edited

Loading

codecov bot commented Feb 22, 2024 •

edited

Loading