Skip to content
Merged
Show file tree
Hide file tree
Changes from 13 commits
Commits
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
2 changes: 2 additions & 0 deletions .changeset/bitter-books-drop.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
---
---
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ exports[`Typedoc output > should have a deliberate file structure 1`] = `
"types/confirm-checkout-params.mdx",
"types/create-checkout-params.mdx",
"types/create-organization-params.mdx",
"types/deleted-object-resource.mdx",
"types/element-object-key.mdx",
"types/elements-config.mdx",
"types/errors.mdx",
Expand Down
2 changes: 0 additions & 2 deletions .typedoc/custom-plugin.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,6 @@ const LINK_REPLACEMENTS = [
['web3-wallet', '/docs/references/backend/types/backend-web3-wallet'],
['verify-token-options', '#verify-token-options'],
['localization-resource', '/docs/customization/localization'],
['commerce-subscription-item-resource', '/docs/references/javascript/types/commerce-subscription-item-resource'],
['commerce-money-amount', '/docs/references/javascript/types/commerce-money-amount'],
];

/**
Expand Down
10 changes: 7 additions & 3 deletions .typedoc/custom-theme.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,7 @@ class ClerkMarkdownThemeContext extends MarkdownThemeContext {
return superPartials.member(model, options);
},
/**
* This hides the "Type parameters" section and the declaration title from the output
* This hides the "Type parameters" section, the declaration title, and the "Type declaration" heading from the output
* @param {import('typedoc').DeclarationReflection} model
* @param {{ headingLevel: number, nested?: boolean }} options
*/
Expand All @@ -309,7 +309,11 @@ class ClerkMarkdownThemeContext extends MarkdownThemeContext {
const output = superPartials.declaration(customizedModel, options);
this.partials = originalPartials;

return output;
// Remove the "Type declaration" heading from the output
// This heading is generated by the original declaration partial
const filteredOutput = output.replace(/^## Type declaration$/gm, '');

return filteredOutput;
},
/**
* This ensures that everything is wrapped in a single codeblock
Expand Down Expand Up @@ -452,7 +456,7 @@ class ClerkMarkdownThemeContext extends MarkdownThemeContext {
const items = headings.map(i => `'${i}'`).join(', ');
const tabs = md.map(i => `<Tab>${i}</Tab>`).join('\n');

return `This function returns a discriminated union type. There are multiple variants of this type available which you can select by clicking on one of the tabs.
return `There are multiple variants of this type available which you can select by clicking on one of the tabs.

<Tabs items={[${items}]}>
${tabs}
Expand Down
2 changes: 1 addition & 1 deletion packages/backend/src/api/resources/CommercePlan.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import { Feature } from './Feature';
import type { CommercePlanJSON } from './JSON';

/**
* The `CommercePlan` object is similar to the [`CommercePlanResource`](/docs/references/javascript/types/commerce-plan-resource) object as it holds information about a plan, as well as methods for managing it. However, the `CommercePlan` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/commerce/get/commerce/plans) and is not directly accessible from the Frontend API.
* The `CommercePlan` object is similar to the [`BillingPlanResource`](/docs/references/javascript/types/billing-plan-resource) object as it holds information about a plan, as well as methods for managing it. However, the `CommercePlan` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/commerce/get/commerce/plans) and is not directly accessible from the Frontend API.
*
* @experimental This is an experimental API for the Billing feature that is available under a public beta, and the API is subject to change. It is advised to [pin](https://clerk.com/docs/pinning) the SDK version and the clerk-js version to avoid breaking changes.
*/
Expand Down
8 changes: 4 additions & 4 deletions packages/types/src/clerk.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1577,9 +1577,9 @@ export type UserButtonProps = UserButtonProfileMode & {
/**
* If true the `<UserButton />` will only render the popover.
* Enables developers to implement a custom dialog.
* This API is experimental and may change at any moment.
* @experimental
*
* @default undefined
* @experimental This API is experimental and may change at any moment.
*/
__experimental_asStandalone?: boolean | ((opened: boolean) => void);

Expand Down Expand Up @@ -1647,9 +1647,9 @@ export type OrganizationSwitcherProps = CreateOrganizationMode &
/**
* If true, `<OrganizationSwitcher />` will only render the popover.
* Enables developers to implement a custom dialog.
* This API is experimental and may change at any moment.
* @experimental
*
* @default undefined
* @experimental This API is experimental and may change at any moment.
*/
__experimental_asStandalone?: boolean | ((opened: boolean) => void);

Expand Down
Loading