From 66c5381bfa7439e3db40188d91e08e93c2548cca Mon Sep 17 00:00:00 2001 From: derekpierre Date: Mon, 7 Oct 2024 15:11:10 -0400 Subject: [PATCH 1/2] Include taco-auth in API documentation. At @ts-expect-error annotation so that docs can build. --- CONTRIBUTING.md | 4 ++-- packages/taco-auth/test/auth-provider.test.ts | 1 + typedoc.json | 2 +- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 693df9bda..c0888d438 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -24,8 +24,8 @@ pnpm fix Build and publish documentation with: ```bash -pnpm doc -pnpm doc:publish +pnpm typedoc +pnpm typedoc:publish ``` ## Publishing diff --git a/packages/taco-auth/test/auth-provider.test.ts b/packages/taco-auth/test/auth-provider.test.ts index b9157be0a..611cbb712 100644 --- a/packages/taco-auth/test/auth-provider.test.ts +++ b/packages/taco-auth/test/auth-provider.test.ts @@ -77,6 +77,7 @@ describe('auth provider caching', () => { it('caches auth signature, but regenerates when expired', async () => { const createAuthSignatureSpy = vi.spyOn( eip4361Provider, + // @ts-expect-error -- spying on private function 'createSIWEAuthMessage', ); diff --git a/typedoc.json b/typedoc.json index 14547f69c..ec18be54e 100644 --- a/typedoc.json +++ b/typedoc.json @@ -1,6 +1,6 @@ { "extends": ["./typedoc.base.json"], - "entryPoints": ["packages/pre", "packages/shared", "packages/taco"], + "entryPoints": ["packages/pre", "packages/shared", "packages/taco", "packages/taco-auth"], "entryPointStrategy": "packages", "name": "@nucypher/taco-web" } From 5d852dafc0f3245f8d9d56adfa511b352a113c65 Mon Sep 17 00:00:00 2001 From: derekpierre Date: Tue, 8 Oct 2024 08:22:04 -0400 Subject: [PATCH 2/2] Remove packages/pre from taco-web docs. --- typedoc.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/typedoc.json b/typedoc.json index ec18be54e..d2662cd5d 100644 --- a/typedoc.json +++ b/typedoc.json @@ -1,6 +1,6 @@ { "extends": ["./typedoc.base.json"], - "entryPoints": ["packages/pre", "packages/shared", "packages/taco", "packages/taco-auth"], + "entryPoints": ["packages/shared", "packages/taco", "packages/taco-auth"], "entryPointStrategy": "packages", "name": "@nucypher/taco-web" }