Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add web5/crypto to docs ci check #363

Closed
wants to merge 7 commits into from
Closed

Add web5/crypto to docs ci check #363

wants to merge 7 commits into from

Conversation

leordev
Copy link
Contributor

@leordev leordev commented Jan 4, 2024

wip.. we need to fix all the docs errors

Copy link

codesandbox bot commented Jan 4, 2024

Review or Edit in CodeSandbox

Open the branch in Web EditorVS CodeInsiders

Open Preview

Copy link
Contributor

github-actions bot commented Jan 4, 2024

TBDocs Report

🛑 Errors: 0
⚠️ Warnings: 15

@web5/api

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

@web5/crypto

  • Project entry file: packages/crypto/src/index.ts
📄 File: packages/crypto/src/jose/jwe.ts
⚠️ extractor:ae-undocumented: Missing documentation for "JweHeaderParams". #L3
⚠️ extractor:ae-undocumented: Missing documentation for "apu". #L53
⚠️ extractor:ae-undocumented: Missing documentation for "apv". #L55
⚠️ extractor:ae-undocumented: Missing documentation for "epk". #L101
⚠️ extractor:ae-undocumented: Missing documentation for "iv". #L103
⚠️ extractor:ae-undocumented: Missing documentation for "p2c". #L105
⚠️ extractor:ae-undocumented: Missing documentation for "p2s". #L107
📄 File: packages/crypto/src/jose/jws.ts
⚠️ extractor:ae-undocumented: Missing documentation for "JoseHeaderParams". #L3
⚠️ extractor:ae-undocumented: Missing documentation for "JwsHeaderParams". #L29
📄 File: packages/crypto/src/local-kms-crypto.ts
⚠️ extractor:ae-undocumented: Missing documentation for "LocalKmsCrypto". #L105
📄 File: packages/crypto/src/primitives/concat-kdf.ts
⚠️ extractor:ae-undocumented: Missing documentation for "ConcatKdfOtherInfo". #L5
📄 File: packages/crypto/src/types/params-kms.ts
⚠️ extractor:ae-undocumented: Missing documentation for "KmsUnwrapKeyParams". #L145

@web5/crypto-aws-kms

  • Project entry file: packages/crypto-aws-kms/src/index.ts
📄 File: packages/crypto-aws-kms/src/api.ts
⚠️ extractor:ae-undocumented: Missing documentation for "AwsKmsCrypto". #L100
📄 File: packages/crypto-aws-kms/src/ecdsa.ts
⚠️ extractor:ae-undocumented: Missing documentation for "EcdsaAlgorithm". #L50
📄 File: packages/crypto-aws-kms/src/utils.ts
⚠️ extractor:ae-undocumented: Missing documentation for "getKeySpec". #L97

TBDocs Report Updated at 2024-01-05T22:42:20Z 2ca3e0c

Copy link

codecov bot commented Jan 4, 2024

Codecov Report

Merging #363 (2ca3e0c) into main (dbe2708) will not change coverage.
The diff coverage is 100.00%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #363   +/-   ##
=======================================
  Coverage   91.69%   91.69%           
=======================================
  Files          67       67           
  Lines       18176    18176           
  Branches     1534     1534           
=======================================
  Hits        16667    16667           
  Misses       1487     1487           
  Partials       22       22           
Components Coverage Δ
agent 88.08% <ø> (ø)
api 96.93% <ø> (ø)
common 98.57% <ø> (ø)
credentials ∅ <ø> (∅)
crypto 94.54% <100.00%> (ø)
dids 92.24% <ø> (ø)
identity-agent 56.81% <ø> (ø)
crypto-aws-kms 100.00% <100.00%> (ø)
proxy-agent 58.43% <ø> (ø)
user-agent 55.22% <ø> (ø)

Comment on lines -3 to +4
export * as utils from './utils.js';
import * as utils from './utils.js';
export { utils };
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you switch this back? there's nothing wrong with this syntax

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can't, unfortunately it's a constraint with api-extractor...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@leordev
Copy link
Contributor Author

leordev commented Feb 7, 2024

Closing in favor of #402

@leordev leordev closed this Feb 7, 2024
@leordev leordev deleted the leordev/crypto-docs branch February 12, 2024 18:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants