From 74ac6113bfe106f79fa1ca481ef5a64b7e21db3a Mon Sep 17 00:00:00 2001 From: Sarah Soutoul Date: Fri, 30 Jan 2026 10:49:31 -0600 Subject: [PATCH 1/2] Add types --- .typedoc/custom-plugin.mjs | 3 +++ .../react/hooks/useOrganizationCreationDefaults.types.ts | 6 ++++++ packages/shared/src/types/organizationCreationDefaults.ts | 3 +++ 3 files changed, 12 insertions(+) diff --git a/.typedoc/custom-plugin.mjs b/.typedoc/custom-plugin.mjs index dbfca8f057f..5b137e740de 100644 --- a/.typedoc/custom-plugin.mjs +++ b/.typedoc/custom-plugin.mjs @@ -33,6 +33,8 @@ const FILES_WITHOUT_HEADINGS = [ 'use-reverification-params.mdx', 'payment-element-provider-props.mdx', 'payment-element-props.mdx', + 'use-organization-creation-defaults-return.mdx', + 'use-organization-creation-defaults-params.mdx', ]; /** @@ -90,6 +92,7 @@ const LINK_REPLACEMENTS = [ ['billing-payment-resource', '/docs/reference/javascript/types/billing-payment-resource'], ['deleted-object-resource', '/docs/reference/javascript/types/deleted-object-resource'], ['use-checkout-return', '/docs/reference/hooks/use-checkout#returns'], + ['organization-creation-defaults-resource', '#organization-creation-defaults-resource'], ]; /** diff --git a/packages/shared/src/react/hooks/useOrganizationCreationDefaults.types.ts b/packages/shared/src/react/hooks/useOrganizationCreationDefaults.types.ts index 38af7290d7d..63575b3e1d0 100644 --- a/packages/shared/src/react/hooks/useOrganizationCreationDefaults.types.ts +++ b/packages/shared/src/react/hooks/useOrganizationCreationDefaults.types.ts @@ -1,6 +1,9 @@ import type { ClerkAPIResponseError } from '../../errors/clerkApiResponseError'; import type { OrganizationCreationDefaultsResource } from '../../types'; +/** + * @interface + */ export type UseOrganizationCreationDefaultsParams = { /** * If true, the previous data will be kept in the cache until new data is fetched. @@ -16,6 +19,9 @@ export type UseOrganizationCreationDefaultsParams = { enabled?: boolean; }; +/** + * @interface + */ export type UseOrganizationCreationDefaultsReturn = { /** * The organization creation defaults resource, `undefined` before the first fetch, or `null` if not available. diff --git a/packages/shared/src/types/organizationCreationDefaults.ts b/packages/shared/src/types/organizationCreationDefaults.ts index 95d3211110a..7e56bb3e509 100644 --- a/packages/shared/src/types/organizationCreationDefaults.ts +++ b/packages/shared/src/types/organizationCreationDefaults.ts @@ -19,6 +19,9 @@ export interface OrganizationCreationDefaultsJSON extends ClerkResourceJSON { }; } +/** + * @interface + */ export interface OrganizationCreationDefaultsResource extends ClerkResource { advisory: { code: OrganizationCreationAdvisoryType; From 79a3a250ba428235fb3bbd594a2d79a3824dfa2f Mon Sep 17 00:00:00 2001 From: Sarah Soutoul Date: Fri, 30 Jan 2026 11:21:10 -0600 Subject: [PATCH 2/2] Add changeset --- .changeset/busy-buttons-camp.md | 2 ++ 1 file changed, 2 insertions(+) create mode 100644 .changeset/busy-buttons-camp.md diff --git a/.changeset/busy-buttons-camp.md b/.changeset/busy-buttons-camp.md new file mode 100644 index 00000000000..a845151cc84 --- /dev/null +++ b/.changeset/busy-buttons-camp.md @@ -0,0 +1,2 @@ +--- +---