@clerk/shared 4.0.0-snapshot.v20251204175016 → 4.0.0-snapshot.v20251211120550

package/dist/runtime/react/index.d.ts

@@ -1,6 +1,6 @@
-import { $ as GetAPIKeysParams, $i as OrganizationMembershipResource, Ao as SessionVerificationLevel, Dd as BillingPaymentMethodResource, Fo as OrganizationInvitationResource, Gn as ClientResource, H as ClerkOptions, Ha as SignedInSessionResource, Hd as CheckoutFlowResource, Ja as GetUserOrganizationInvitationsParams, L as CheckoutSignalValue, Ld as BillingSubscriptionPlanPeriod, Mf as ClerkAPIResponseError, Nd as BillingStatementResource, Rd as BillingSubscriptionResource, T as APIKeyResource, X as CreateOrganizationParams, Xa as GetUserOrganizationSuggestionsParams, Ya as GetUserOrganizationMembershipParams, aa as GetDomainsParams, ca as GetMembershipRequestParams, g as UseSessionReturn, h as UseSessionListReturn, jd as BillingPlanResource, kd as BillingPaymentResource, lt as LoadedClerk, oa as GetInvitationsParams, pa as OrganizationResource, qd as ForPayerType, ro as UserOrganizationInvitationResource, ru as OrganizationDomainResource, sa as GetMembersParams, to as UserResource, ul as ClerkAPIResponseError$1, uo as OrganizationSuggestionResource, vd as BillingCheckoutResource, xf as ClerkPaginatedResponse, xt as SetActive, y as UseUserReturn, ya as OrganizationMembershipRequestResource } from "../index-046BvqQ_.js";
+import { $ as GetAPIKeysParams, $i as OrganizationMembershipResource, Ao as SessionVerificationLevel, Dd as BillingPaymentMethodResource, Fo as OrganizationInvitationResource, Gn as ClientResource, H as ClerkOptions, Ha as SignedInSessionResource, Hd as CheckoutFlowResource, Ja as GetUserOrganizationInvitationsParams, L as CheckoutSignalValue, Ld as BillingSubscriptionPlanPeriod, Mf as ClerkAPIResponseError, Nd as BillingStatementResource, Rd as BillingSubscriptionResource, T as APIKeyResource, X as CreateOrganizationParams, Xa as GetUserOrganizationSuggestionsParams, Ya as GetUserOrganizationMembershipParams, aa as GetDomainsParams, ca as GetMembershipRequestParams, g as UseSessionReturn, h as UseSessionListReturn, jd as BillingPlanResource, kd as BillingPaymentResource, lt as LoadedClerk, oa as GetInvitationsParams, pa as OrganizationResource, qd as ForPayerType, ro as UserOrganizationInvitationResource, ru as OrganizationDomainResource, sa as GetMembersParams, to as UserResource, ul as ClerkAPIResponseError$1, uo as OrganizationSuggestionResource, vd as BillingCheckoutResource, xf as ClerkPaginatedResponse, xt as SetActive, y as UseUserReturn, ya as OrganizationMembershipRequestResource } from "../index-D42gIYCP.js";
 import "../moduleManager-WB15hU3T.js";
-import "../error-CwbYlf2s.js";
+import "../error-Du4UdKtF.js";
 import React, { PropsWithChildren, ReactNode } from "react";
 import { dequal } from "dequal";
 
@@ -203,7 +203,7 @@ type UseOrganizationParams = {
    * If set to `true`, all default properties will be used.<br />
    * Otherwise, accepts an object with the following optional properties:
    * <ul>
-   *  <li>`enrollmentMode`: A string that filters the domains by the provided [enrollment mode](https://clerk.com/docs/guides/organizations/verified-domains#enable-verified-domains).</li>
+   *  <li>`enrollmentMode`: A string that filters the domains by the provided [enrollment mode](https://clerk.com/docs/guides/organizations/add-members/verified-domains#enable-verified-domains).</li>
    *  <li>Any of the properties described in [Shared properties](#shared-properties).</li>
    * </ul>
    */
@@ -246,27 +246,27 @@ type UseOrganizationReturn<T$1 extends UseOrganizationParams> = {
    */
   isLoaded: false;
   /**
-   * The currently active organization.
+   * The currently Active Organization.
    */
   organization: undefined;
   /**
-   * The current organization membership.
+   * The current Organization membership.
    */
   membership: undefined;
   /**
-   * Includes a paginated list of the organization's domains.
+   * Includes a paginated list of the Organization's domains.
    */
   domains: PaginatedResourcesWithDefault<OrganizationDomainResource>;
   /**
-   * Includes a paginated list of the organization's membership requests.
+   * Includes a paginated list of the Organization's membership requests.
    */
   membershipRequests: PaginatedResourcesWithDefault<OrganizationMembershipRequestResource>;
   /**
-   * Includes a paginated list of the organization's memberships.
+   * Includes a paginated list of the Organization's memberships.
    */
   memberships: PaginatedResourcesWithDefault<OrganizationMembershipResource>;
   /**
-   * Includes a paginated list of the organization's invitations.
+   * Includes a paginated list of the Organization's invitations.
    */
   invitations: PaginatedResourcesWithDefault<OrganizationInvitationResource>;
 } | {
@@ -295,7 +295,7 @@ type UseOrganizationReturn<T$1 extends UseOrganizationParams> = {
   } ? true : false> | null;
 };
 /**
- * The `useOrganization()` hook retrieves attributes of the currently active organization.
+ * The `useOrganization()` hook retrieves attributes of the currently Active Organization.
  *
  * @example
  * ### Expand and paginate attributes
@@ -330,7 +330,7 @@ type UseOrganizationReturn<T$1 extends UseOrganizationParams> = {
  * @example
  * ### Infinite pagination
  *
- * The following example demonstrates how to use the `infinite` property to fetch and append new data to the existing list. The `memberships` attribute will be populated with the first page of the organization's memberships. When the "Load more" button is clicked, the `fetchNext` helper function will be called to append the next page of memberships to the list.
+ * The following example demonstrates how to use the `infinite` property to fetch and append new data to the existing list. The `memberships` attribute will be populated with the first page of the Organization's memberships. When the "Load more" button is clicked, the `fetchNext` helper function will be called to append the next page of memberships to the list.
  *
  * ```tsx
  * import { useOrganization } from '@clerk/react'
@@ -374,7 +374,7 @@ type UseOrganizationReturn<T$1 extends UseOrganizationParams> = {
  * @example
  * ### Simple pagination
  *
- * The following example demonstrates how to use the `fetchPrevious` and `fetchNext` helper functions to paginate through the data. The `memberships` attribute will be populated with the first page of the organization's memberships. When the "Previous page" or "Next page" button is clicked, the `fetchPrevious` or `fetchNext` helper function will be called to fetch the previous or next page of memberships.
+ * The following example demonstrates how to use the `fetchPrevious` and `fetchNext` helper functions to paginate through the data. The `memberships` attribute will be populated with the first page of the Organization's memberships. When the "Previous page" or "Next page" button is clicked, the `fetchPrevious` or `fetchNext` helper function will be called to fetch the previous or next page of memberships.
  *
  * Notice the difference between this example's pagination and the infinite pagination example above.
  *
@@ -467,19 +467,19 @@ type UseOrganizationListReturn<T$1 extends UseOrganizationListParams> = {
    */
   createOrganization: undefined;
   /**
-   * A function that sets the active session and/or organization.
+   * A function that sets the active session and/or Organization.
    */
   setActive: undefined;
   /**
-   * Returns `PaginatedResources` which includes a list of the user's organization memberships.
+   * Returns `PaginatedResources` which includes a list of the user's Organization memberships.
    */
   userMemberships: PaginatedResourcesWithDefault<OrganizationMembershipResource>;
   /**
-   * Returns `PaginatedResources` which includes a list of the user's organization invitations.
+   * Returns `PaginatedResources` which includes a list of the user's Organization invitations.
    */
   userInvitations: PaginatedResourcesWithDefault<UserOrganizationInvitationResource>;
   /**
-   * Returns `PaginatedResources` which includes a list of suggestions for organizations that the user can join.
+   * Returns `PaginatedResources` which includes a list of suggestions for Organizations that the user can join.
    */
   userSuggestions: PaginatedResourcesWithDefault<OrganizationSuggestionResource>;
 } | {
@@ -532,7 +532,7 @@ type UseOrganizationListReturn<T$1 extends UseOrganizationListParams> = {
  * @example
  * ### Infinite pagination
  *
- * The following example demonstrates how to use the `infinite` property to fetch and append new data to the existing list. The `userMemberships` attribute will be populated with the first page of the user's organization memberships. When the "Load more" button is clicked, the `fetchNext` helper function will be called to append the next page of memberships to the list.
+ * The following example demonstrates how to use the `infinite` property to fetch and append new data to the existing list. The `userMemberships` attribute will be populated with the first page of the user's Organization memberships. When the "Load more" button is clicked, the `fetchNext` helper function will be called to append the next page of memberships to the list.
  *
  * ```tsx {{ filename: 'src/components/JoinedOrganizations.tsx' }}
  * import { useOrganizationList } from '@clerk/react'
@@ -1050,7 +1050,7 @@ interface HookParams extends PaginatedHookConfig<PagesOrInfiniteOptions & {
   __experimental_mode?: 'cache';
 }> {
   /**
-   * Specifies whether to fetch for the current user or organization.
+   * Specifies whether to fetch for the current user or Organization.
    *
    * @default 'user'
    */
@@ -1095,7 +1095,7 @@ declare const usePlans: <T extends HookParams>(params?: T | undefined) => Pagina
  */
 type UseSubscriptionParams = {
   /**
-   * Specifies whether to fetch the subscription for an organization or a user.
+   * Specifies whether to fetch the Subscription for an Organization or a user.
    *
    * @default 'user'
    */
@@ -1167,17 +1167,17 @@ declare const OptionsContext: React.Context<ClerkOptions>;
  */
 type UseCheckoutOptions = {
   /**
-   * Specifies if the checkout is for an organization.
+   * Specifies if the checkout is for an Organization.
    *
    * @default 'user'
    */
   for?: ForPayerType;
   /**
-   * The billing period for the plan.
+   * The billing period for the Plan.
    */
   planPeriod: BillingSubscriptionPlanPeriod;
   /**
-   * The ID of the subscription plan to check out (e.g. `cplan_xxx`).
+   * The ID of the Subscription Plan to check out (e.g. `cplan_xxx`).
    */
   planId: string;
 };
@@ -1436,7 +1436,7 @@ type PaymentElementProviderProps = {
    */
   stripeAppearance?: internalStripeAppearance;
   /**
-   * Specifies whether to fetch for the current user or organization.
+   * Specifies whether to fetch for the current user or Organization.
    *
    * @default 'user'
    */

package/dist/runtime/react/index.js

@@ -5,8 +5,8 @@ require('../isomorphicBtoa-oWNvIgSP.js');
 require('../keys-wr08qE7Y.js');
 const require_authorization_errors = require('../authorization-errors-B7aH39AU.js');
 const require_authorization = require('../authorization-R5uuaK2u.js');
-const require_error = require('../error-C4TyorFL.js');
-const require_organization = require('../organization-BzYWUtt4.js');
+const require_error = require('../error-CJmIhSJi.js');
+const require_organization = require('../organization-BOnxJJGM.js');
 require('../noop-DEV2Xnb4.js');
 require('../underscore-moIbQc1H.js');
 const require_telemetry = require('../telemetry-CXXDXYfo.js');
@@ -586,7 +586,7 @@ const undefinedPaginatedResource$1 = {
 	setData: void 0
 };
 /**
-* The `useOrganization()` hook retrieves attributes of the currently active organization.
+* The `useOrganization()` hook retrieves attributes of the currently Active Organization.
 *
 * @example
 * ### Expand and paginate attributes
@@ -621,7 +621,7 @@ const undefinedPaginatedResource$1 = {
 * @example
 * ### Infinite pagination
 *
-* The following example demonstrates how to use the `infinite` property to fetch and append new data to the existing list. The `memberships` attribute will be populated with the first page of the organization's memberships. When the "Load more" button is clicked, the `fetchNext` helper function will be called to append the next page of memberships to the list.
+* The following example demonstrates how to use the `infinite` property to fetch and append new data to the existing list. The `memberships` attribute will be populated with the first page of the Organization's memberships. When the "Load more" button is clicked, the `fetchNext` helper function will be called to append the next page of memberships to the list.
 *
 * ```tsx
 * import { useOrganization } from '@clerk/react'
@@ -665,7 +665,7 @@ const undefinedPaginatedResource$1 = {
 * @example
 * ### Simple pagination
 *
-* The following example demonstrates how to use the `fetchPrevious` and `fetchNext` helper functions to paginate through the data. The `memberships` attribute will be populated with the first page of the organization's memberships. When the "Previous page" or "Next page" button is clicked, the `fetchPrevious` or `fetchNext` helper function will be called to fetch the previous or next page of memberships.
+* The following example demonstrates how to use the `fetchPrevious` and `fetchNext` helper functions to paginate through the data. The `memberships` attribute will be populated with the first page of the Organization's memberships. When the "Previous page" or "Next page" button is clicked, the `fetchPrevious` or `fetchNext` helper function will be called to fetch the previous or next page of memberships.
 *
 * Notice the difference between this example's pagination and the infinite pagination example above.
 *
@@ -928,7 +928,7 @@ const undefinedPaginatedResource = {
 * @example
 * ### Infinite pagination
 *
-* The following example demonstrates how to use the `infinite` property to fetch and append new data to the existing list. The `userMemberships` attribute will be populated with the first page of the user's organization memberships. When the "Load more" button is clicked, the `fetchNext` helper function will be called to append the next page of memberships to the list.
+* The following example demonstrates how to use the `infinite` property to fetch and append new data to the existing list. The `userMemberships` attribute will be populated with the first page of the user's Organization memberships. When the "Load more" button is clicked, the `fetchNext` helper function will be called to append the next page of memberships to the list.
 *
 * ```tsx {{ filename: 'src/components/JoinedOrganizations.tsx' }}
 * import { useOrganizationList } from '@clerk/react'
@@ -1603,7 +1603,7 @@ function useBillingHookEnabled(params) {
 //#region src/react/hooks/createBillingPaginatedHook.tsx
 /**
 * A hook factory that creates paginated data fetching hooks for commerce-related resources.
-* It provides a standardized way to create hooks that can fetch either user or organization resources
+* It provides a standardized way to create hooks that can fetch either user or Organization resources
 * with built-in pagination support.
 *
 * The generated hooks handle: