diff --git a/.changeset/better-ways-doubt.md b/.changeset/better-ways-doubt.md new file mode 100644 index 00000000000..a845151cc84 --- /dev/null +++ b/.changeset/better-ways-doubt.md @@ -0,0 +1,2 @@ +--- +--- diff --git a/.typedoc/custom-plugin.mjs b/.typedoc/custom-plugin.mjs index 937ceb8801f..aca8cc799fe 100644 --- a/.typedoc/custom-plugin.mjs +++ b/.typedoc/custom-plugin.mjs @@ -43,25 +43,25 @@ const FILES_WITHOUT_HEADINGS = [ * Ideally this is a temporary solution until every one of these files are published in production and can be linked to. */ const LINK_REPLACEMENTS = [ - ['set-active-params', '/docs/reference/javascript/types/set-active-params'], - ['clerk-paginated-response', '/docs/reference/javascript/types/clerk-paginated-response'], + ['set-active-params', '/docs/reference/types/set-active-params'], + ['clerk-paginated-response', '/docs/reference/types/clerk-paginated-response'], ['paginated-resources', '#paginated-resources'], ['use-checkout-options', '#use-checkout-options'], ['needs-reverification-parameters', '#needs-reverification-parameters'], ['create-organization-params', '#create-organization-params'], - ['session-resource', '/docs/reference/javascript/session'], - ['signed-in-session-resource', '/docs/reference/javascript/session'], - ['sign-in-resource', '/docs/reference/javascript/sign-in'], - ['sign-up-resource', '/docs/reference/javascript/sign-up'], - ['user-resource', '/docs/reference/javascript/user'], - ['session-status-claim', '/docs/reference/javascript/types/session-status'], - ['user-organization-invitation-resource', '/docs/reference/javascript/types/user-organization-invitation'], - ['organization-membership-resource', '/docs/reference/javascript/types/organization-membership'], - ['organization-suggestion-resource', '/docs/reference/javascript/types/organization-suggestion'], - ['organization-resource', '/docs/reference/javascript/organization'], - ['organization-domain-resource', '/docs/reference/javascript/types/organization-domain-resource'], - ['organization-invitation-resource', '/docs/reference/javascript/types/organization-invitation'], - ['organization-membership-request-resource', '/docs/reference/javascript/types/organization-membership-request'], + ['session-resource', '/docs/reference/objects/session'], + ['signed-in-session-resource', '/docs/reference/objects/session'], + ['sign-in-resource', '/docs/reference/objects/sign-in'], + ['sign-up-resource', '/docs/reference/objects/sign-up'], + ['user-resource', '/docs/reference/objects/user'], + ['session-status-claim', '/docs/reference/types/session-status'], + ['user-organization-invitation-resource', '/docs/reference/types/user-organization-invitation'], + ['organization-membership-resource', '/docs/reference/types/organization-membership'], + ['organization-suggestion-resource', '/docs/reference/types/organization-suggestion'], + ['organization-resource', '/docs/reference/objects/organization'], + ['organization-domain-resource', '/docs/reference/types/organization-domain-resource'], + ['organization-invitation-resource', '/docs/reference/types/organization-invitation'], + ['organization-membership-request-resource', '/docs/reference/types/organization-membership-request'], ['session', '/docs/reference/backend/types/backend-session'], ['session-activity', '/docs/reference/backend/types/backend-session-activity'], ['organization', '/docs/reference/backend/types/backend-organization'], @@ -77,22 +77,22 @@ const LINK_REPLACEMENTS = [ ['invitation', '/docs/reference/backend/types/backend-invitation'], ['verify-token-options', '#verify-token-options'], ['localization-resource', '/docs/guides/customizing-clerk/localization'], - ['confirm-checkout-params', '/docs/reference/javascript/types/billing-checkout-resource#parameters'], - ['billing-payment-method-resource', '/docs/reference/javascript/types/billing-payment-method-resource'], - ['billing-payer-resource', '/docs/reference/javascript/types/billing-payer-resource'], - ['billing-plan-resource', '/docs/reference/javascript/types/billing-plan-resource'], - ['billing-checkout-totals', '/docs/reference/javascript/types/billing-checkout-totals'], - ['billing-checkout-resource', '/docs/reference/javascript/types/billing-checkout-resource'], - ['billing-money-amount', '/docs/reference/javascript/types/billing-money-amount'], - ['billing-subscription-item-resource', '/docs/reference/javascript/types/billing-subscription-item-resource'], - ['feature-resource', '/docs/reference/javascript/types/feature-resource'], - ['billing-statement-group', '/docs/reference/javascript/types/billing-statement-group'], - ['billing-statement-resource', '/docs/reference/javascript/types/billing-statement-resource'], - ['billing-subscription-resource', '/docs/reference/javascript/types/billing-subscription-resource'], - ['clerk-api-response-error', '/docs/reference/javascript/types/clerk-api-response-error'], - ['billing-statement-totals', '/docs/reference/javascript/types/billing-statement-totals'], - ['billing-payment-resource', '/docs/reference/javascript/types/billing-payment-resource'], - ['deleted-object-resource', '/docs/reference/javascript/types/deleted-object-resource'], + ['confirm-checkout-params', '/docs/reference/types/billing-checkout-resource#parameters'], + ['billing-payment-method-resource', '/docs/reference/types/billing-payment-method-resource'], + ['billing-payer-resource', '/docs/reference/types/billing-payer-resource'], + ['billing-plan-resource', '/docs/reference/types/billing-plan-resource'], + ['billing-checkout-totals', '/docs/reference/types/billing-checkout-totals'], + ['billing-checkout-resource', '/docs/reference/types/billing-checkout-resource'], + ['billing-money-amount', '/docs/reference/types/billing-money-amount'], + ['billing-subscription-item-resource', '/docs/reference/types/billing-subscription-item-resource'], + ['feature-resource', '/docs/reference/types/feature-resource'], + ['billing-statement-group', '/docs/reference/types/billing-statement-group'], + ['billing-statement-resource', '/docs/reference/types/billing-statement-resource'], + ['billing-subscription-resource', '/docs/reference/types/billing-subscription-resource'], + ['clerk-api-response-error', '/docs/reference/types/clerk-api-response-error'], + ['billing-statement-totals', '/docs/reference/types/billing-statement-totals'], + ['billing-payment-resource', '/docs/reference/types/billing-payment-resource'], + ['deleted-object-resource', '/docs/reference/types/deleted-object-resource'], ['checkout-flow-resource', '/docs/reference/hooks/use-checkout#checkout-flow-resource'], ['organization-creation-defaults-resource', '#organization-creation-defaults-resource'], ]; @@ -133,7 +133,7 @@ function getCatchAllReplacements() { }, { pattern: /`LoadedClerk`/g, - replace: '[Clerk](/docs/reference/javascript/clerk)', + replace: '[Clerk](/docs/reference/objects/clerk)', }, { pattern: /(? | null, /** diff --git a/packages/backend/src/api/resources/Organization.ts b/packages/backend/src/api/resources/Organization.ts index b9802082c2f..e5b6c502c9f 100644 --- a/packages/backend/src/api/resources/Organization.ts +++ b/packages/backend/src/api/resources/Organization.ts @@ -1,7 +1,7 @@ import type { OrganizationJSON } from './JSON'; /** - * The Backend `Organization` object is similar to the [`Organization`](https://clerk.com/docs/reference/javascript/organization) object as it holds information about an Organization, as well as methods for managing it. However, the Backend `Organization` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/Organizations#operation/ListOrganizations){{ target: '_blank' }} and is not directly accessible from the Frontend API. + * The Backend `Organization` object is similar to the [`Organization`](https://clerk.com/docs/reference/objects/organization) object as it holds information about an Organization, as well as methods for managing it. However, the Backend `Organization` object is different in that it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/Organizations#operation/ListOrganizations){{ target: '_blank' }} and is not directly accessible from the Frontend API. */ export class Organization { private _raw: OrganizationJSON | null = null; diff --git a/packages/backend/src/api/resources/OrganizationInvitation.ts b/packages/backend/src/api/resources/OrganizationInvitation.ts index 171fd9cbeca..d4840576c07 100644 --- a/packages/backend/src/api/resources/OrganizationInvitation.ts +++ b/packages/backend/src/api/resources/OrganizationInvitation.ts @@ -2,7 +2,7 @@ import type { OrganizationInvitationStatus, OrganizationMembershipRole } from '. import type { OrganizationInvitationJSON, PublicOrganizationDataJSON } from './JSON'; /** - * The Backend `OrganizationInvitation` object is similar to the [`OrganizationInvitation`](https://clerk.com/docs/reference/javascript/types/organization-invitation) object as it's the model around an Organization invitation. However, the Backend `OrganizationInvitation` object is different in that it's used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/Organization-Invitations#operation/CreateOrganizationInvitation){{ target: '_blank' }} and is not directly accessible from the Frontend API. + * The Backend `OrganizationInvitation` object is similar to the [`OrganizationInvitation`](https://clerk.com/docs/reference/types/organization-invitation) object as it's the model around an Organization invitation. However, the Backend `OrganizationInvitation` object is different in that it's used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/Organization-Invitations#operation/CreateOrganizationInvitation){{ target: '_blank' }} and is not directly accessible from the Frontend API. */ export class OrganizationInvitation { private _raw: OrganizationInvitationJSON | null = null; diff --git a/packages/backend/src/api/resources/OrganizationMembership.ts b/packages/backend/src/api/resources/OrganizationMembership.ts index 7a78240b559..0ecc2af3d41 100644 --- a/packages/backend/src/api/resources/OrganizationMembership.ts +++ b/packages/backend/src/api/resources/OrganizationMembership.ts @@ -3,7 +3,7 @@ import type { OrganizationMembershipRole } from './Enums'; import type { OrganizationMembershipJSON, OrganizationMembershipPublicUserDataJSON } from './JSON'; /** - * The Backend `OrganizationMembership` object is similar to the [`OrganizationMembership`](https://clerk.com/docs/reference/javascript/types/organization-membership) object as it's the model around an Organization membership entity and describes the relationship between users and Organizations. However, the Backend `OrganizationMembership` object is different in that it's used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/Organization-Memberships#operation/CreateOrganizationMembership){{ target: '_blank' }} and is not directly accessible from the Frontend API. + * The Backend `OrganizationMembership` object is similar to the [`OrganizationMembership`](https://clerk.com/docs/reference/types/organization-membership) object as it's the model around an Organization membership entity and describes the relationship between users and Organizations. However, the Backend `OrganizationMembership` object is different in that it's used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/Organization-Memberships#operation/CreateOrganizationMembership){{ target: '_blank' }} and is not directly accessible from the Frontend API. */ export class OrganizationMembership { private _raw: OrganizationMembershipJSON | null = null; diff --git a/packages/backend/src/api/resources/SamlConnection.ts b/packages/backend/src/api/resources/SamlConnection.ts index 667305decc8..f5c277f0dba 100644 --- a/packages/backend/src/api/resources/SamlConnection.ts +++ b/packages/backend/src/api/resources/SamlConnection.ts @@ -87,7 +87,7 @@ export class SamlConnection { */ readonly updatedAt: number, /** - * Defines the attribute name mapping between the Identity Provider (IdP) and Clerk's [`User`](https://clerk.com/docs/reference/javascript/user) properties. + * Defines the attribute name mapping between the Identity Provider (IdP) and Clerk's [`User`](https://clerk.com/docs/reference/objects/user) properties. */ readonly attributeMapping: AttributeMapping, ) {} diff --git a/packages/backend/src/api/resources/Session.ts b/packages/backend/src/api/resources/Session.ts index 3334ab72c22..1878cb28b60 100644 --- a/packages/backend/src/api/resources/Session.ts +++ b/packages/backend/src/api/resources/Session.ts @@ -54,7 +54,7 @@ export class SessionActivity { } /** - * The Backend `Session` object is similar to the [`Session`](https://clerk.com/docs/reference/javascript/session) object as it is an abstraction over an HTTP session and models the period of information exchange between a user and the server. However, the Backend `Session` object is different as it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/Sessions#operation/GetSessionList) and is not directly accessible from the Frontend API. + * The Backend `Session` object is similar to the [`Session`](https://clerk.com/docs/reference/objects/session) object as it is an abstraction over an HTTP session and models the period of information exchange between a user and the server. However, the Backend `Session` object is different as it is used in the [Backend API](https://clerk.com/docs/reference/backend-api/tag/Sessions#operation/GetSessionList) and is not directly accessible from the Frontend API. */ export class Session { constructor( diff --git a/packages/react/src/components/controlComponents.tsx b/packages/react/src/components/controlComponents.tsx index 8fd33bc7a91..674a4cbf4f7 100644 --- a/packages/react/src/components/controlComponents.tsx +++ b/packages/react/src/components/controlComponents.tsx @@ -158,7 +158,7 @@ export const RedirectToTasks = withClerk(({ clerk, ...props }: WithClerkProp { React.useEffect(() => { @@ -171,7 +171,7 @@ export const RedirectToUserProfile = withClerk(({ clerk }) => { /** * @function - * @deprecated Use [`redirectToOrganizationProfile()`](https://clerk.com/docs/reference/javascript/clerk#redirect-to-organization-profile) instead. + * @deprecated Use [`redirectToOrganizationProfile()`](https://clerk.com/docs/reference/objects/clerk#redirect-to-organization-profile) instead. */ export const RedirectToOrganizationProfile = withClerk(({ clerk }) => { React.useEffect(() => { @@ -184,7 +184,7 @@ export const RedirectToOrganizationProfile = withClerk(({ clerk }) => { /** * @function - * @deprecated Use [`redirectToCreateOrganization()`](https://clerk.com/docs/reference/javascript/clerk#redirect-to-create-organization) instead. + * @deprecated Use [`redirectToCreateOrganization()`](https://clerk.com/docs/reference/objects/clerk#redirect-to-create-organization) instead. */ export const RedirectToCreateOrganization = withClerk(({ clerk }) => { React.useEffect(() => { diff --git a/packages/react/src/hooks/legacy/useSignIn.ts b/packages/react/src/hooks/legacy/useSignIn.ts index 1e2d39bba67..f0f47ec3e1e 100644 --- a/packages/react/src/hooks/legacy/useSignIn.ts +++ b/packages/react/src/hooks/legacy/useSignIn.ts @@ -6,7 +6,7 @@ import { useIsomorphicClerkContext } from '../../contexts/IsomorphicClerkContext import { useAssertWrappedByClerkProvider } from '../useAssertWrappedByClerkProvider'; /** - * The `useSignIn()` hook provides access to the [`SignIn`](https://clerk.com/docs/reference/javascript/sign-in) object, which allows you to check the current state of a sign-in attempt and manage the sign-in flow. You can use this to create a [custom sign-in flow](https://clerk.com/docs/guides/development/custom-flows/overview). + * The `useSignIn()` hook provides access to the [`SignIn`](https://clerk.com/docs/reference/objects/sign-in) object, which allows you to check the current state of a sign-in attempt and manage the sign-in flow. You can use this to create a [custom sign-in flow](https://clerk.com/docs/guides/development/custom-flows/overview). * * @unionReturnHeadings * ["Initialization", "Loaded"] @@ -14,7 +14,7 @@ import { useAssertWrappedByClerkProvider } from '../useAssertWrappedByClerkProvi * @example * ### Check the current state of a sign-in * - * The following example uses the `useSignIn()` hook to access the [`SignIn`](https://clerk.com/docs/reference/javascript/sign-in) object, which contains the current sign-in attempt status and methods to create a new sign-in attempt. The `isLoaded` property is used to handle the loading state. + * The following example uses the `useSignIn()` hook to access the [`SignIn`](https://clerk.com/docs/reference/objects/sign-in) object, which contains the current sign-in attempt status and methods to create a new sign-in attempt. The `isLoaded` property is used to handle the loading state. * * * diff --git a/packages/react/src/hooks/legacy/useSignUp.ts b/packages/react/src/hooks/legacy/useSignUp.ts index f29dbf795ce..b3d0887842f 100644 --- a/packages/react/src/hooks/legacy/useSignUp.ts +++ b/packages/react/src/hooks/legacy/useSignUp.ts @@ -6,7 +6,7 @@ import { useIsomorphicClerkContext } from '../../contexts/IsomorphicClerkContext import { useAssertWrappedByClerkProvider } from '../useAssertWrappedByClerkProvider'; /** - * The `useSignUp()` hook provides access to the [`SignUp`](https://clerk.com/docs/reference/javascript/sign-up) object, which allows you to check the current state of a sign-up attempt and manage the sign-up flow. You can use this to create a [custom sign-up flow](https://clerk.com/docs/guides/development/custom-flows/overview). + * The `useSignUp()` hook provides access to the [`SignUp`](https://clerk.com/docs/reference/objects/sign-up) object, which allows you to check the current state of a sign-up attempt and manage the sign-up flow. You can use this to create a [custom sign-up flow](https://clerk.com/docs/guides/development/custom-flows/overview). * * @unionReturnHeadings * ["Initialization", "Loaded"] @@ -14,7 +14,7 @@ import { useAssertWrappedByClerkProvider } from '../useAssertWrappedByClerkProvi * @example * ### Check the current state of a sign-up * - * The following example uses the `useSignUp()` hook to access the [`SignUp`](https://clerk.com/docs/reference/javascript/sign-up) object, which contains the current sign-up attempt status and methods to create a new sign-up attempt. The `isLoaded` property is used to handle the loading state. + * The following example uses the `useSignUp()` hook to access the [`SignUp`](https://clerk.com/docs/reference/objects/sign-up) object, which contains the current sign-up attempt status and methods to create a new sign-up attempt. The `isLoaded` property is used to handle the loading state. * * * diff --git a/packages/shared/src/react/hooks/useClerk.ts b/packages/shared/src/react/hooks/useClerk.ts index caa08b91683..a53e30911d8 100644 --- a/packages/shared/src/react/hooks/useClerk.ts +++ b/packages/shared/src/react/hooks/useClerk.ts @@ -5,15 +5,15 @@ import { useAssertWrappedByClerkProvider, useClerkInstanceContext } from '../con * > [!WARNING] * > This hook should only be used for advanced use cases, such as building a completely custom OAuth flow or as an escape hatch to access to the `Clerk` object. * - * The `useClerk()` hook provides access to the [`Clerk`](https://clerk.com/docs/reference/javascript/clerk) object, allowing you to build alternatives to any Clerk Component. + * The `useClerk()` hook provides access to the [`Clerk`](https://clerk.com/docs/reference/objects/clerk) object, allowing you to build alternatives to any Clerk Component. * * @function * - * @returns The `useClerk()` hook returns the `Clerk` object, which includes all the methods and properties listed in the [`Clerk` reference](https://clerk.com/docs/reference/javascript/clerk). + * @returns The `useClerk()` hook returns the `Clerk` object, which includes all the methods and properties listed in the [`Clerk` reference](https://clerk.com/docs/reference/objects/clerk). * * @example * - * The following example uses the `useClerk()` hook to access the `clerk` object. The `clerk` object is used to call the [`openSignIn()`](https://clerk.com/docs/reference/javascript/clerk#sign-in) method to open the sign-in modal. + * The following example uses the `useClerk()` hook to access the `clerk` object. The `clerk` object is used to call the [`openSignIn()`](https://clerk.com/docs/reference/objects/clerk#sign-in) method to open the sign-in modal. * * * diff --git a/packages/shared/src/react/hooks/useOrganization.tsx b/packages/shared/src/react/hooks/useOrganization.tsx index 02489902a77..9766524d52c 100644 --- a/packages/shared/src/react/hooks/useOrganization.tsx +++ b/packages/shared/src/react/hooks/useOrganization.tsx @@ -46,7 +46,7 @@ export type UseOrganizationParams = { * If set to `true`, all default properties will be used.
* Otherwise, accepts an object with the following optional properties: *
    - *
  • `role`: An array of [`OrganizationCustomRoleKey`](https://clerk.com/docs/reference/javascript/types/organization-custom-role-key).
    • + *
  • `role`: An array of [`OrganizationCustomRoleKey`](https://clerk.com/docs/reference/types/organization-custom-role-key).
    • *
  • `query`: A string that filters the memberships by the provided string.
    • *
  • Any of the properties described in [Shared properties](#shared-properties).
    • *
diff --git a/packages/shared/src/react/hooks/useSession.ts b/packages/shared/src/react/hooks/useSession.ts index 2d58cf1746f..ce795c7117e 100644 --- a/packages/shared/src/react/hooks/useSession.ts +++ b/packages/shared/src/react/hooks/useSession.ts @@ -7,7 +7,7 @@ type UseSession = () => UseSessionReturn; const hookName = `useSession`; /** - * The `useSession()` hook provides access to the current user's [`Session`](https://clerk.com/docs/reference/javascript/session) object, as well as helpers for setting the active session. + * The `useSession()` hook provides access to the current user's [`Session`](https://clerk.com/docs/reference/objects/session) object, as well as helpers for setting the active session. * * @unionReturnHeadings * ["Initialization", "Signed out", "Signed in"] diff --git a/packages/shared/src/react/hooks/useSessionList.ts b/packages/shared/src/react/hooks/useSessionList.ts index db3d743baf2..62fc6463107 100644 --- a/packages/shared/src/react/hooks/useSessionList.ts +++ b/packages/shared/src/react/hooks/useSessionList.ts @@ -5,7 +5,7 @@ import { useClientBase } from './base/useClientBase'; const hookName = 'useSessionList'; /** - * The `useSessionList()` hook returns an array of [`Session`](https://clerk.com/docs/reference/javascript/session) objects that have been registered on the client device. + * The `useSessionList()` hook returns an array of [`Session`](https://clerk.com/docs/reference/objects/session) objects that have been registered on the client device. * * @unionReturnHeadings * ["Initialization", "Loaded"] diff --git a/packages/shared/src/react/hooks/useUser.ts b/packages/shared/src/react/hooks/useUser.ts index dccd0df7e6c..4f6388f4986 100644 --- a/packages/shared/src/react/hooks/useUser.ts +++ b/packages/shared/src/react/hooks/useUser.ts @@ -5,7 +5,7 @@ import { useUserBase } from './base/useUserBase'; const hookName = 'useUser'; /** - * The `useUser()` hook provides access to the current user's [`User`](https://clerk.com/docs/reference/javascript/user) object, which contains all the data for a single user in your application and provides methods to manage their account. This hook also allows you to check if the user is signed in and if Clerk has loaded and initialized. + * The `useUser()` hook provides access to the current user's [`User`](https://clerk.com/docs/reference/objects/user) object, which contains all the data for a single user in your application and provides methods to manage their account. This hook also allows you to check if the user is signed in and if Clerk has loaded and initialized. * * @unionReturnHeadings * ["Initialization", "Signed out", "Signed in"] @@ -13,7 +13,7 @@ const hookName = 'useUser'; * @example * ### Get the current user * - * The following example uses the `useUser()` hook to access the [`User`](https://clerk.com/docs/reference/javascript/user) object, which contains the current user's data such as their full name. The `isLoaded` and `isSignedIn` properties are used to handle the loading state and to check if the user is signed in, respectively. + * The following example uses the `useUser()` hook to access the [`User`](https://clerk.com/docs/reference/objects/user) object, which contains the current user's data such as their full name. The `isLoaded` and `isSignedIn` properties are used to handle the loading state and to check if the user is signed in, respectively. * * ```tsx {{ filename: 'src/Example.tsx' }} * import { useUser } from '@clerk/react' @@ -36,7 +36,7 @@ const hookName = 'useUser'; * @example * ### Update user data * - * The following example uses the `useUser()` hook to access the [`User`](https://clerk.com/docs/reference/javascript/user) object, which calls the [`update()`](https://clerk.com/docs/reference/javascript/user#update) method to update the current user's information. + * The following example uses the `useUser()` hook to access the [`User`](https://clerk.com/docs/reference/objects/user) object, which calls the [`update()`](https://clerk.com/docs/reference/objects/user#update) method to update the current user's information. * * * @@ -81,7 +81,7 @@ const hookName = 'useUser'; * @example * ### Reload user data * - * The following example uses the `useUser()` hook to access the [`User`](https://clerk.com/docs/reference/javascript/user) object, which calls the [`reload()`](https://clerk.com/docs/reference/javascript/user#reload) method to get the latest user's information. + * The following example uses the `useUser()` hook to access the [`User`](https://clerk.com/docs/reference/objects/user) object, which calls the [`reload()`](https://clerk.com/docs/reference/objects/user#reload) method to get the latest user's information. * * * diff --git a/packages/shared/src/react/types.ts b/packages/shared/src/react/types.ts index 95f0c8e5f87..aea1557422e 100644 --- a/packages/shared/src/react/types.ts +++ b/packages/shared/src/react/types.ts @@ -12,7 +12,7 @@ export type CacheSetter = ( */ export type PaginatedResources = { /** - * An array that contains the fetched data. For example, for the `memberships` attribute, data will be an array of [`OrganizationMembership`](https://clerk.com/docs/reference/javascript/types/organization-membership) objects. + * An array that contains the fetched data. For example, for the `memberships` attribute, data will be an array of [`OrganizationMembership`](https://clerk.com/docs/reference/types/organization-membership) objects. */ data: T[]; /** diff --git a/packages/shared/src/types/hooks.ts b/packages/shared/src/types/hooks.ts index 622d588478b..8babc35277a 100644 --- a/packages/shared/src/types/hooks.ts +++ b/packages/shared/src/types/hooks.ts @@ -66,11 +66,11 @@ export type UseAuthReturn = */ has: CheckAuthorizationSignedOut; /** - * A function that signs out the current user. Returns a promise that resolves when complete. See the [reference doc](https://clerk.com/docs/reference/javascript/clerk#sign-out). + * A function that signs out the current user. Returns a promise that resolves when complete. See the [reference doc](https://clerk.com/docs/reference/objects/clerk#sign-out). */ signOut: SignOut; /** - * A function that retrieves the current user's session token or a custom JWT template. Returns a promise that resolves to the token. See the [reference doc](https://clerk.com/docs/reference/javascript/session#get-token). + * A function that retrieves the current user's session token or a custom JWT template. Returns a promise that resolves to the token. See the [reference doc](https://clerk.com/docs/reference/objects/session#get-token). */ getToken: GetToken; } @@ -131,7 +131,7 @@ export type UseSignInReturn = */ signIn: undefined; /** - * A function that sets the active session. See the [reference doc](https://clerk.com/docs/reference/javascript/clerk#set-active). + * A function that sets the active session. See the [reference doc](https://clerk.com/docs/reference/objects/clerk#set-active). */ setActive: undefined; } @@ -155,7 +155,7 @@ export type UseSignUpReturn = */ signUp: undefined; /** - * A function that sets the active session. See the [reference doc](https://clerk.com/docs/reference/javascript/clerk#set-active). + * A function that sets the active session. See the [reference doc](https://clerk.com/docs/reference/objects/clerk#set-active). */ setActive: undefined; } @@ -208,7 +208,7 @@ export type UseSessionListReturn = */ sessions: undefined; /** - * A function that sets the active session and/or Organization. See the [reference doc](https://clerk.com/docs/reference/javascript/clerk#set-active). + * A function that sets the active session and/or Organization. See the [reference doc](https://clerk.com/docs/reference/objects/clerk#set-active). */ setActive: undefined; } diff --git a/packages/shared/src/types/session.ts b/packages/shared/src/types/session.ts index 0fe363ec745..15767be6316 100644 --- a/packages/shared/src/types/session.ts +++ b/packages/shared/src/types/session.ts @@ -199,7 +199,7 @@ export type CheckAuthorizationParamsFromSessionClaims

{ }); /** - * @deprecated Use [`redirectToUserProfile()`](https://clerk.com/docs/reference/javascript/clerk/redirect-methods#redirect-to-user-profile) instead. + * @deprecated Use [`redirectToUserProfile()`](https://clerk.com/docs/reference/objects/clerk#redirect-to-user-profile) instead. */ export const RedirectToUserProfile = defineComponent(() => { useClerkLoaded(clerk => { @@ -69,7 +69,7 @@ export const RedirectToUserProfile = defineComponent(() => { }); /** - * @deprecated Use [`redirectToOrganizationProfile()`](https://clerk.com/docs/reference/javascript/clerk/redirect-methods#redirect-to-organization-profile) instead. + * @deprecated Use [`redirectToOrganizationProfile()`](https://clerk.com/docs/reference/objects/clerk#redirect-to-organization-profile) instead. */ export const RedirectToOrganizationProfile = defineComponent(() => { useClerkLoaded(clerk => { @@ -81,7 +81,7 @@ export const RedirectToOrganizationProfile = defineComponent(() => { }); /** - * @deprecated Use [`redirectToCreateOrganization()`](https://clerk.com/docs/reference/javascript/clerk/redirect-methods#redirect-to-create-organization) instead. + * @deprecated Use [`redirectToCreateOrganization()`](https://clerk.com/docs/reference/objects/clerk#redirect-to-create-organization) instead. */ export const RedirectToCreateOrganization = defineComponent(() => { useClerkLoaded(clerk => { diff --git a/packages/vue/src/composables/useClerk.ts b/packages/vue/src/composables/useClerk.ts index 77cfd69f262..08f6111108b 100644 --- a/packages/vue/src/composables/useClerk.ts +++ b/packages/vue/src/composables/useClerk.ts @@ -1,7 +1,7 @@ import { useClerkContext } from './useClerkContext'; /** - * Returns the [`Clerk`](https://clerk.com/docs/reference/javascript/clerk/clerk) instance which provides + * Returns the [`Clerk`](https://clerk.com/docs/reference/objects/clerk) instance which provides * low-level access to Clerk's functionality, enabling custom authentication UI and flows. * * @example diff --git a/packages/vue/src/composables/useOrganization.ts b/packages/vue/src/composables/useOrganization.ts index 1d53da1b5b4..64b9c4809e2 100644 --- a/packages/vue/src/composables/useOrganization.ts +++ b/packages/vue/src/composables/useOrganization.ts @@ -27,7 +27,7 @@ type UseOrganizationReturn = type UseOrganization = () => ToComputedRefs; /** - * Returns the current [`Organization`](https://clerk.com/docs/reference/javascript/organization/organization) object + * Returns the current [`Organization`](https://clerk.com/docs/reference/objects/organization) object * along with loading states and membership information. * * @example diff --git a/packages/vue/src/composables/useSession.ts b/packages/vue/src/composables/useSession.ts index 763f04b030a..ad00ff2e0b0 100644 --- a/packages/vue/src/composables/useSession.ts +++ b/packages/vue/src/composables/useSession.ts @@ -8,7 +8,7 @@ import { useClerkContext } from './useClerkContext'; type UseSession = () => ToComputedRefs; /** - * Returns the current [`Session`](https://clerk.com/docs/reference/javascript/session) object which provides + * Returns the current [`Session`](https://clerk.com/docs/reference/objects/session) object which provides * information about the active session and methods to manage it. * * @example diff --git a/packages/vue/src/composables/useSessionList.ts b/packages/vue/src/composables/useSessionList.ts index 86839f1d4bb..57528019e1f 100644 --- a/packages/vue/src/composables/useSessionList.ts +++ b/packages/vue/src/composables/useSessionList.ts @@ -8,7 +8,7 @@ import { useClerkContext } from './useClerkContext'; type UseSessionList = () => ToComputedRefs; /** - * Returns an array of [`Session`](https://clerk.com/docs/reference/javascript/session) objects that have been + * Returns an array of [`Session`](https://clerk.com/docs/reference/objects/session) objects that have been * registered on the client device. * * @example diff --git a/packages/vue/src/composables/useSignIn.ts b/packages/vue/src/composables/useSignIn.ts index b2af94dfa0a..e84c24ec5a9 100644 --- a/packages/vue/src/composables/useSignIn.ts +++ b/packages/vue/src/composables/useSignIn.ts @@ -9,7 +9,7 @@ import { useClerkContext } from './useClerkContext'; type UseSignIn = () => ToComputedRefs; /** - * Returns the current [`SignIn`](https://clerk.com/docs/reference/javascript/sign-in) object which provides + * Returns the current [`SignIn`](https://clerk.com/docs/reference/objects/sign-in) object which provides * methods and state for managing the sign-in flow. * * @example diff --git a/packages/vue/src/composables/useSignUp.ts b/packages/vue/src/composables/useSignUp.ts index 8596f990d1f..8ee5aa03101 100644 --- a/packages/vue/src/composables/useSignUp.ts +++ b/packages/vue/src/composables/useSignUp.ts @@ -9,7 +9,7 @@ import { useClerkContext } from './useClerkContext'; type UseSignUp = () => ToComputedRefs; /** - * Returns the current [`SignUp`](https://clerk.com/docs/reference/javascript/sign-up) object which provides + * Returns the current [`SignUp`](https://clerk.com/docs/reference/objects/sign-up) object which provides * methods and state for managing the sign-up flow. * * @example diff --git a/packages/vue/src/composables/useUser.ts b/packages/vue/src/composables/useUser.ts index d354fdf3c95..0b81a3ece87 100644 --- a/packages/vue/src/composables/useUser.ts +++ b/packages/vue/src/composables/useUser.ts @@ -8,7 +8,7 @@ import { useClerkContext } from './useClerkContext'; type UseUser = () => ToComputedRefs; /** - * Returns the current user's [`User`](https://clerk.com/docs/reference/javascript/user/user) object along with loading states. + * Returns the current user's [`User`](https://clerk.com/docs/reference/objects/user) object along with loading states. * * @example *