Skip to content

fix(shared): Hide billing types not needed in Typedoc #7315

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Nov 25, 2025
Merged

fix(shared): Hide billing types not needed in Typedoc #7315

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
895b011
Hide billing types not needed in Typedoc
SarahSoutoul Nov 25, 2025
5fe543c
Add changeset
SarahSoutoul Nov 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/gold-wasps-dress.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@clerk/shared': minor
---

Hide billing types through @internal tag
6 changes: 4 additions & 2 deletions packages/shared/src/react/hooks/useAPIKeys.rq.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import { createCacheKeys } from './createCacheKeys';
import { usePagesOrInfinite, useWithSafeValues } from './usePagesOrInfinite';

/**
* @interface
* @internal
*/
export type UseAPIKeysParams = PaginatedHookConfig<
GetAPIKeysParams & {
Expand All @@ -21,14 +21,16 @@ export type UseAPIKeysParams = PaginatedHookConfig<
>;

/**
* @interface
* @internal
*/
export type UseAPIKeysReturn<T extends UseAPIKeysParams> = PaginatedResources<
APIKeyResource,
T extends { infinite: true } ? true : false
>;

/**
* @internal
*
* The `useAPIKeys()` hook provides access to paginated API keys for the current user or organization.
*
* @example
Expand Down
6 changes: 4 additions & 2 deletions packages/shared/src/react/hooks/useAPIKeys.swr.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import { createCacheKeys } from './createCacheKeys';
import { usePagesOrInfinite, useWithSafeValues } from './usePagesOrInfinite';

/**
* @interface
* @internal
*/
export type UseAPIKeysParams = PaginatedHookConfig<
GetAPIKeysParams & {
Expand All @@ -24,14 +24,16 @@ export type UseAPIKeysParams = PaginatedHookConfig<
>;

/**
* @interface
* @internal
*/
export type UseAPIKeysReturn<T extends UseAPIKeysParams> = PaginatedResources<
APIKeyResource,
T extends { infinite: true } ? true : false
>;

/**
* @internal
*
* The `useAPIKeys()` hook provides access to paginated API keys for the current user or organization.
*
* @example
Expand Down
4 changes: 2 additions & 2 deletions packages/shared/src/react/hooks/usePaymentAttemptQuery.types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import type { ClerkAPIResponseError } from '../../error';
import type { BillingPaymentResource, ForPayerType } from '../../types';

/**
* @interface
* @internal
*/
export type UsePaymentAttemptQueryParams = {
/**
Expand Down Expand Up @@ -30,7 +30,7 @@ export type UsePaymentAttemptQueryParams = {
};

/**
* @interface
* @internal
*/
export type PaymentAttemptQueryResult = {
/**
Expand Down
4 changes: 2 additions & 2 deletions packages/shared/src/react/hooks/usePlanDetailsQuery.types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import type { ClerkAPIResponseError } from '../../errors/clerkApiResponseError';
import type { BillingPlanResource } from '../../types';

/**
* @interface
* @internal
*/
export type UsePlanDetailsQueryParams = {
/**
Expand All @@ -28,7 +28,7 @@ export type UsePlanDetailsQueryParams = {
};

/**
* @interface
* @internal
*/
export type PlanDetailsQueryResult = {
/**
Expand Down
4 changes: 2 additions & 2 deletions packages/shared/src/react/hooks/useStatementQuery.types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import type { BillingStatementResource, ClerkAPIResponseError, ForPayerType } from '../../types';

/**
* @interface
* @internal
*/
export type UseStatementQueryParams = {
/**
Expand Down Expand Up @@ -29,7 +29,7 @@ export type UseStatementQueryParams = {
};

/**
* @interface
* @internal
*/
export type StatementQueryResult = {
/**
Expand Down
Loading