From 729ae895fefc825670c404011558a369a0388672 Mon Sep 17 00:00:00 2001 From: Tim Shamilov Date: Wed, 14 Aug 2024 01:36:43 +0800 Subject: [PATCH] renable typedoc --- .github/workflows/docs-ci.yml | 4 ++-- packages/crypto/src/utils.ts | 7 +++++++ 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/.github/workflows/docs-ci.yml b/.github/workflows/docs-ci.yml index e45b31040..078073e42 100644 --- a/.github/workflows/docs-ci.yml +++ b/.github/workflows/docs-ci.yml @@ -36,8 +36,8 @@ jobs: with: token: ${{ secrets.GITHUB_TOKEN }} report_changed_scope_only: false - fail_on_warnings: false - fail_on_error: false + fail_on_warnings: true + fail_on_error: true group_docs: true entry_points: | - file: packages/api/src/index.ts diff --git a/packages/crypto/src/utils.ts b/packages/crypto/src/utils.ts index bdb4085c1..51f90d160 100644 --- a/packages/crypto/src/utils.ts +++ b/packages/crypto/src/utils.ts @@ -273,11 +273,18 @@ export function randomPin({ length }: { length: number }): string { /** Utility functions for cryptographic operations. */ export const CryptoUtils = { + /** Generates a secure random PIN (Personal Identification Number) of a specified length. */ randomPin, + /** Generates a UUID following the version 4 format, as specified in RFC 4122. */ randomUuid, + /** Generates secure pseudorandom values of the specified length using `crypto.getRandomValues`, which defers to the operating system. */ randomBytes, + /** Checks if the Web Crypto API is supported in the current runtime environment. */ isWebCryptoSupported, + /** Determines the JOSE algorithm identifier of the digital signature algorithm based on the `alg` or `crv` property of a {@link Jwk | JWK}. */ getJoseSignatureAlgorithmFromPublicKey, + /** Checks whether the property specified is a member of the list of valid properties. */ checkValidProperty, + /** Checks whether the properties object provided contains the specified property. */ checkRequiredProperty }; \ No newline at end of file