@clerk/shared 4.0.0-snapshot.v20251208202852 → 4.0.0-snapshot.v20251211120550
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/runtime/alternativePhoneCode.d.mts +1 -1
- package/dist/runtime/alternativePhoneCode.d.ts +1 -1
- package/dist/runtime/authorization-errors.d.mts +1 -1
- package/dist/runtime/authorization-errors.d.ts +1 -1
- package/dist/runtime/authorization.d.mts +1 -1
- package/dist/runtime/authorization.d.ts +1 -1
- package/dist/runtime/clerkEventBus.d.mts +1 -1
- package/dist/runtime/clerkEventBus.d.ts +1 -1
- package/dist/runtime/color.d.mts +1 -1
- package/dist/runtime/color.d.ts +1 -1
- package/dist/runtime/deriveState.d.mts +1 -1
- package/dist/runtime/deriveState.d.ts +1 -1
- package/dist/runtime/{error-D6MGXq-n.mjs → error--xlRIO4Z.mjs} +42 -2
- package/dist/runtime/error--xlRIO4Z.mjs.map +1 -0
- package/dist/runtime/{error-DSsmf214.d.ts → error-Bar-OO4s.d.mts} +40 -3
- package/dist/runtime/error-Bar-OO4s.d.mts.map +1 -0
- package/dist/runtime/{error-C4TyorFL.js → error-CJmIhSJi.js} +47 -1
- package/dist/runtime/error-CJmIhSJi.js.map +1 -0
- package/dist/runtime/{error-CWA4ukvl.d.mts → error-Du4UdKtF.d.ts} +40 -3
- package/dist/runtime/error-Du4UdKtF.d.ts.map +1 -0
- package/dist/runtime/error.d.mts +3 -3
- package/dist/runtime/error.d.ts +3 -3
- package/dist/runtime/error.js +2 -1
- package/dist/runtime/error.mjs +2 -2
- package/dist/runtime/{index-CBjE4nAT.d.mts → index-CPEYkfCA.d.mts} +145 -136
- package/dist/runtime/{index-CBjE4nAT.d.mts.map → index-CPEYkfCA.d.mts.map} +1 -1
- package/dist/runtime/{index-eJWs3zJx.d.ts → index-D42gIYCP.d.ts} +145 -136
- package/dist/runtime/index-D42gIYCP.d.ts.map +1 -0
- package/dist/runtime/internal/clerk-js/completeSignUpFlow.d.mts +1 -1
- package/dist/runtime/internal/clerk-js/completeSignUpFlow.d.ts +1 -1
- package/dist/runtime/internal/clerk-js/componentGuards.d.mts +1 -1
- package/dist/runtime/internal/clerk-js/componentGuards.d.ts +1 -1
- package/dist/runtime/internal/clerk-js/injectedWeb3Providers.d.mts +1 -1
- package/dist/runtime/internal/clerk-js/injectedWeb3Providers.d.ts +1 -1
- package/dist/runtime/internal/clerk-js/organization.d.mts +1 -1
- package/dist/runtime/internal/clerk-js/organization.d.ts +1 -1
- package/dist/runtime/internal/clerk-js/organization.js +1 -1
- package/dist/runtime/internal/clerk-js/organization.js.map +1 -1
- package/dist/runtime/internal/clerk-js/organization.mjs +1 -1
- package/dist/runtime/internal/clerk-js/organization.mjs.map +1 -1
- package/dist/runtime/internal/clerk-js/passkeys.d.mts +2 -2
- package/dist/runtime/internal/clerk-js/passkeys.d.ts +2 -2
- package/dist/runtime/internal/clerk-js/passkeys.js +1 -1
- package/dist/runtime/internal/clerk-js/passkeys.mjs +1 -1
- package/dist/runtime/internal/clerk-js/passwords/complexity.d.mts +1 -1
- package/dist/runtime/internal/clerk-js/passwords/complexity.d.ts +1 -1
- package/dist/runtime/internal/clerk-js/passwords/loadZxcvbn.d.mts +1 -1
- package/dist/runtime/internal/clerk-js/passwords/loadZxcvbn.d.ts +1 -1
- package/dist/runtime/internal/clerk-js/passwords/password.d.mts +1 -1
- package/dist/runtime/internal/clerk-js/passwords/password.d.ts +1 -1
- package/dist/runtime/internal/clerk-js/passwords/strength.d.mts +1 -1
- package/dist/runtime/internal/clerk-js/passwords/strength.d.ts +1 -1
- package/dist/runtime/internal/clerk-js/queryParams.d.mts +2 -2
- package/dist/runtime/internal/clerk-js/queryParams.d.ts +2 -2
- package/dist/runtime/internal/clerk-js/redirectUrls.d.mts +1 -1
- package/dist/runtime/internal/clerk-js/redirectUrls.d.ts +1 -1
- package/dist/runtime/internal/clerk-js/sessionTasks.d.mts +2 -2
- package/dist/runtime/internal/clerk-js/sessionTasks.d.ts +2 -2
- package/dist/runtime/internal/clerk-js/url.d.mts +2 -2
- package/dist/runtime/internal/clerk-js/url.d.ts +2 -2
- package/dist/runtime/internal/clerk-js/user.d.mts +1 -1
- package/dist/runtime/internal/clerk-js/user.d.ts +1 -1
- package/dist/runtime/internal/clerk-js/web3.d.mts +1 -1
- package/dist/runtime/internal/clerk-js/web3.d.ts +1 -1
- package/dist/runtime/jwtPayloadParser.d.mts +1 -1
- package/dist/runtime/jwtPayloadParser.d.ts +1 -1
- package/dist/runtime/keys.d.mts +1 -1
- package/dist/runtime/keys.d.ts +1 -1
- package/dist/runtime/loadClerkJsScript.d.mts +1 -1
- package/dist/runtime/loadClerkJsScript.d.ts +1 -1
- package/dist/runtime/loadClerkJsScript.js +3 -3
- package/dist/runtime/loadClerkJsScript.js.map +1 -1
- package/dist/runtime/loadClerkJsScript.mjs +3 -3
- package/dist/runtime/loadClerkJsScript.mjs.map +1 -1
- package/dist/runtime/oauth.d.mts +1 -1
- package/dist/runtime/oauth.d.ts +1 -1
- package/dist/runtime/{organization-BzYWUtt4.js → organization-BOnxJJGM.js} +5 -6
- package/dist/runtime/organization-BOnxJJGM.js.map +1 -0
- package/dist/runtime/{organization-JwY1zGRo.mjs → organization-CDNOZNzF.mjs} +5 -6
- package/dist/runtime/organization-CDNOZNzF.mjs.map +1 -0
- package/dist/runtime/organization.d.mts +5 -6
- package/dist/runtime/organization.d.mts.map +1 -1
- package/dist/runtime/organization.d.ts +5 -6
- package/dist/runtime/organization.d.ts.map +1 -1
- package/dist/runtime/organization.js +1 -1
- package/dist/runtime/organization.mjs +1 -1
- package/dist/runtime/pathMatcher.d.mts +1 -1
- package/dist/runtime/pathMatcher.d.ts +1 -1
- package/dist/runtime/react/index.d.mts +23 -23
- package/dist/runtime/react/index.d.ts +23 -23
- package/dist/runtime/react/index.js +7 -7
- package/dist/runtime/react/index.js.map +1 -1
- package/dist/runtime/react/index.mjs +7 -7
- package/dist/runtime/react/index.mjs.map +1 -1
- package/dist/runtime/router.d.mts +1 -1
- package/dist/runtime/router.d.mts.map +1 -1
- package/dist/runtime/router.d.ts +1 -1
- package/dist/runtime/router.d.ts.map +1 -1
- package/dist/runtime/saml.d.mts +1 -1
- package/dist/runtime/saml.d.ts +1 -1
- package/dist/runtime/telemetry.d.mts +1 -1
- package/dist/runtime/telemetry.d.ts +1 -1
- package/dist/runtime/types/index.d.mts +1 -1
- package/dist/runtime/types/index.d.ts +1 -1
- package/dist/runtime/ui/index.d.mts +1 -1
- package/dist/runtime/ui/index.d.ts +1 -1
- package/dist/runtime/{url-CeALciQG.d.ts → url-B0fryQyT.d.ts} +2 -2
- package/dist/runtime/{url-CeALciQG.d.ts.map → url-B0fryQyT.d.ts.map} +1 -1
- package/dist/runtime/{url-BQX5m-Ax.d.mts → url-BXe3Tvsn.d.mts} +2 -2
- package/dist/runtime/{url-BQX5m-Ax.d.mts.map → url-BXe3Tvsn.d.mts.map} +1 -1
- package/dist/runtime/{versionSelector-CwoA_vh7.js → versionSelector-BMFwS2IR.js} +3 -3
- package/dist/runtime/{versionSelector-CwoA_vh7.js.map → versionSelector-BMFwS2IR.js.map} +1 -1
- package/dist/runtime/{versionSelector-BCQasG48.mjs → versionSelector-v6LvGO6I.mjs} +3 -3
- package/dist/runtime/{versionSelector-BCQasG48.mjs.map → versionSelector-v6LvGO6I.mjs.map} +1 -1
- package/dist/runtime/versionSelector.js +1 -1
- package/dist/runtime/versionSelector.mjs +1 -1
- package/dist/runtime/web3.d.mts +1 -1
- package/dist/runtime/web3.d.ts +1 -1
- package/dist/types/index.d.mts +144 -135
- package/dist/types/index.d.mts.map +1 -1
- package/dist/types/index.d.ts +144 -135
- package/dist/types/index.d.ts.map +1 -1
- package/package.json +1 -1
- package/dist/runtime/error-C4TyorFL.js.map +0 -1
- package/dist/runtime/error-CWA4ukvl.d.mts.map +0 -1
- package/dist/runtime/error-D6MGXq-n.mjs.map +0 -1
- package/dist/runtime/error-DSsmf214.d.ts.map +0 -1
- package/dist/runtime/index-eJWs3zJx.d.ts.map +0 -1
- package/dist/runtime/organization-BzYWUtt4.js.map +0 -1
- package/dist/runtime/organization-JwY1zGRo.mjs.map +0 -1
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
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-
|
|
1
|
+
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-CPEYkfCA.mjs";
|
|
2
2
|
import "../moduleManager-pxNnXwxv.mjs";
|
|
3
|
-
import "../error-
|
|
3
|
+
import "../error-Bar-OO4s.mjs";
|
|
4
4
|
import React, { PropsWithChildren, ReactNode } from "react";
|
|
5
5
|
import { dequal } from "dequal";
|
|
6
6
|
|
|
@@ -203,7 +203,7 @@ type UseOrganizationParams = {
|
|
|
203
203
|
* If set to `true`, all default properties will be used.<br />
|
|
204
204
|
* Otherwise, accepts an object with the following optional properties:
|
|
205
205
|
* <ul>
|
|
206
|
-
* <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>
|
|
206
|
+
* <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>
|
|
207
207
|
* <li>Any of the properties described in [Shared properties](#shared-properties).</li>
|
|
208
208
|
* </ul>
|
|
209
209
|
*/
|
|
@@ -246,27 +246,27 @@ type UseOrganizationReturn<T$1 extends UseOrganizationParams> = {
|
|
|
246
246
|
*/
|
|
247
247
|
isLoaded: false;
|
|
248
248
|
/**
|
|
249
|
-
* The currently
|
|
249
|
+
* The currently Active Organization.
|
|
250
250
|
*/
|
|
251
251
|
organization: undefined;
|
|
252
252
|
/**
|
|
253
|
-
* The current
|
|
253
|
+
* The current Organization membership.
|
|
254
254
|
*/
|
|
255
255
|
membership: undefined;
|
|
256
256
|
/**
|
|
257
|
-
* Includes a paginated list of the
|
|
257
|
+
* Includes a paginated list of the Organization's domains.
|
|
258
258
|
*/
|
|
259
259
|
domains: PaginatedResourcesWithDefault<OrganizationDomainResource>;
|
|
260
260
|
/**
|
|
261
|
-
* Includes a paginated list of the
|
|
261
|
+
* Includes a paginated list of the Organization's membership requests.
|
|
262
262
|
*/
|
|
263
263
|
membershipRequests: PaginatedResourcesWithDefault<OrganizationMembershipRequestResource>;
|
|
264
264
|
/**
|
|
265
|
-
* Includes a paginated list of the
|
|
265
|
+
* Includes a paginated list of the Organization's memberships.
|
|
266
266
|
*/
|
|
267
267
|
memberships: PaginatedResourcesWithDefault<OrganizationMembershipResource>;
|
|
268
268
|
/**
|
|
269
|
-
* Includes a paginated list of the
|
|
269
|
+
* Includes a paginated list of the Organization's invitations.
|
|
270
270
|
*/
|
|
271
271
|
invitations: PaginatedResourcesWithDefault<OrganizationInvitationResource>;
|
|
272
272
|
} | {
|
|
@@ -295,7 +295,7 @@ type UseOrganizationReturn<T$1 extends UseOrganizationParams> = {
|
|
|
295
295
|
} ? true : false> | null;
|
|
296
296
|
};
|
|
297
297
|
/**
|
|
298
|
-
* The `useOrganization()` hook retrieves attributes of the currently
|
|
298
|
+
* The `useOrganization()` hook retrieves attributes of the currently Active Organization.
|
|
299
299
|
*
|
|
300
300
|
* @example
|
|
301
301
|
* ### Expand and paginate attributes
|
|
@@ -330,7 +330,7 @@ type UseOrganizationReturn<T$1 extends UseOrganizationParams> = {
|
|
|
330
330
|
* @example
|
|
331
331
|
* ### Infinite pagination
|
|
332
332
|
*
|
|
333
|
-
* 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
|
|
333
|
+
* 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.
|
|
334
334
|
*
|
|
335
335
|
* ```tsx
|
|
336
336
|
* import { useOrganization } from '@clerk/react'
|
|
@@ -374,7 +374,7 @@ type UseOrganizationReturn<T$1 extends UseOrganizationParams> = {
|
|
|
374
374
|
* @example
|
|
375
375
|
* ### Simple pagination
|
|
376
376
|
*
|
|
377
|
-
* 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
|
|
377
|
+
* 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.
|
|
378
378
|
*
|
|
379
379
|
* Notice the difference between this example's pagination and the infinite pagination example above.
|
|
380
380
|
*
|
|
@@ -467,19 +467,19 @@ type UseOrganizationListReturn<T$1 extends UseOrganizationListParams> = {
|
|
|
467
467
|
*/
|
|
468
468
|
createOrganization: undefined;
|
|
469
469
|
/**
|
|
470
|
-
* A function that sets the active session and/or
|
|
470
|
+
* A function that sets the active session and/or Organization.
|
|
471
471
|
*/
|
|
472
472
|
setActive: undefined;
|
|
473
473
|
/**
|
|
474
|
-
* Returns `PaginatedResources` which includes a list of the user's
|
|
474
|
+
* Returns `PaginatedResources` which includes a list of the user's Organization memberships.
|
|
475
475
|
*/
|
|
476
476
|
userMemberships: PaginatedResourcesWithDefault<OrganizationMembershipResource>;
|
|
477
477
|
/**
|
|
478
|
-
* Returns `PaginatedResources` which includes a list of the user's
|
|
478
|
+
* Returns `PaginatedResources` which includes a list of the user's Organization invitations.
|
|
479
479
|
*/
|
|
480
480
|
userInvitations: PaginatedResourcesWithDefault<UserOrganizationInvitationResource>;
|
|
481
481
|
/**
|
|
482
|
-
* Returns `PaginatedResources` which includes a list of suggestions for
|
|
482
|
+
* Returns `PaginatedResources` which includes a list of suggestions for Organizations that the user can join.
|
|
483
483
|
*/
|
|
484
484
|
userSuggestions: PaginatedResourcesWithDefault<OrganizationSuggestionResource>;
|
|
485
485
|
} | {
|
|
@@ -532,7 +532,7 @@ type UseOrganizationListReturn<T$1 extends UseOrganizationListParams> = {
|
|
|
532
532
|
* @example
|
|
533
533
|
* ### Infinite pagination
|
|
534
534
|
*
|
|
535
|
-
* 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
|
|
535
|
+
* 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.
|
|
536
536
|
*
|
|
537
537
|
* ```tsx {{ filename: 'src/components/JoinedOrganizations.tsx' }}
|
|
538
538
|
* import { useOrganizationList } from '@clerk/react'
|
|
@@ -1050,7 +1050,7 @@ interface HookParams extends PaginatedHookConfig<PagesOrInfiniteOptions & {
|
|
|
1050
1050
|
__experimental_mode?: 'cache';
|
|
1051
1051
|
}> {
|
|
1052
1052
|
/**
|
|
1053
|
-
* Specifies whether to fetch for the current user or
|
|
1053
|
+
* Specifies whether to fetch for the current user or Organization.
|
|
1054
1054
|
*
|
|
1055
1055
|
* @default 'user'
|
|
1056
1056
|
*/
|
|
@@ -1095,7 +1095,7 @@ declare const usePlans: <T extends HookParams>(params?: T | undefined) => Pagina
|
|
|
1095
1095
|
*/
|
|
1096
1096
|
type UseSubscriptionParams = {
|
|
1097
1097
|
/**
|
|
1098
|
-
* Specifies whether to fetch the
|
|
1098
|
+
* Specifies whether to fetch the Subscription for an Organization or a user.
|
|
1099
1099
|
*
|
|
1100
1100
|
* @default 'user'
|
|
1101
1101
|
*/
|
|
@@ -1167,17 +1167,17 @@ declare const OptionsContext: React.Context<ClerkOptions>;
|
|
|
1167
1167
|
*/
|
|
1168
1168
|
type UseCheckoutOptions = {
|
|
1169
1169
|
/**
|
|
1170
|
-
* Specifies if the checkout is for an
|
|
1170
|
+
* Specifies if the checkout is for an Organization.
|
|
1171
1171
|
*
|
|
1172
1172
|
* @default 'user'
|
|
1173
1173
|
*/
|
|
1174
1174
|
for?: ForPayerType;
|
|
1175
1175
|
/**
|
|
1176
|
-
* The billing period for the
|
|
1176
|
+
* The billing period for the Plan.
|
|
1177
1177
|
*/
|
|
1178
1178
|
planPeriod: BillingSubscriptionPlanPeriod;
|
|
1179
1179
|
/**
|
|
1180
|
-
* The ID of the
|
|
1180
|
+
* The ID of the Subscription Plan to check out (e.g. `cplan_xxx`).
|
|
1181
1181
|
*/
|
|
1182
1182
|
planId: string;
|
|
1183
1183
|
};
|
|
@@ -1436,7 +1436,7 @@ type PaymentElementProviderProps = {
|
|
|
1436
1436
|
*/
|
|
1437
1437
|
stripeAppearance?: internalStripeAppearance;
|
|
1438
1438
|
/**
|
|
1439
|
-
* Specifies whether to fetch for the current user or
|
|
1439
|
+
* Specifies whether to fetch for the current user or Organization.
|
|
1440
1440
|
*
|
|
1441
1441
|
* @default 'user'
|
|
1442
1442
|
*/
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
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-
|
|
1
|
+
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";
|
|
2
2
|
import "../moduleManager-WB15hU3T.js";
|
|
3
|
-
import "../error-
|
|
3
|
+
import "../error-Du4UdKtF.js";
|
|
4
4
|
import React, { PropsWithChildren, ReactNode } from "react";
|
|
5
5
|
import { dequal } from "dequal";
|
|
6
6
|
|
|
@@ -203,7 +203,7 @@ type UseOrganizationParams = {
|
|
|
203
203
|
* If set to `true`, all default properties will be used.<br />
|
|
204
204
|
* Otherwise, accepts an object with the following optional properties:
|
|
205
205
|
* <ul>
|
|
206
|
-
* <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>
|
|
206
|
+
* <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>
|
|
207
207
|
* <li>Any of the properties described in [Shared properties](#shared-properties).</li>
|
|
208
208
|
* </ul>
|
|
209
209
|
*/
|
|
@@ -246,27 +246,27 @@ type UseOrganizationReturn<T$1 extends UseOrganizationParams> = {
|
|
|
246
246
|
*/
|
|
247
247
|
isLoaded: false;
|
|
248
248
|
/**
|
|
249
|
-
* The currently
|
|
249
|
+
* The currently Active Organization.
|
|
250
250
|
*/
|
|
251
251
|
organization: undefined;
|
|
252
252
|
/**
|
|
253
|
-
* The current
|
|
253
|
+
* The current Organization membership.
|
|
254
254
|
*/
|
|
255
255
|
membership: undefined;
|
|
256
256
|
/**
|
|
257
|
-
* Includes a paginated list of the
|
|
257
|
+
* Includes a paginated list of the Organization's domains.
|
|
258
258
|
*/
|
|
259
259
|
domains: PaginatedResourcesWithDefault<OrganizationDomainResource>;
|
|
260
260
|
/**
|
|
261
|
-
* Includes a paginated list of the
|
|
261
|
+
* Includes a paginated list of the Organization's membership requests.
|
|
262
262
|
*/
|
|
263
263
|
membershipRequests: PaginatedResourcesWithDefault<OrganizationMembershipRequestResource>;
|
|
264
264
|
/**
|
|
265
|
-
* Includes a paginated list of the
|
|
265
|
+
* Includes a paginated list of the Organization's memberships.
|
|
266
266
|
*/
|
|
267
267
|
memberships: PaginatedResourcesWithDefault<OrganizationMembershipResource>;
|
|
268
268
|
/**
|
|
269
|
-
* Includes a paginated list of the
|
|
269
|
+
* Includes a paginated list of the Organization's invitations.
|
|
270
270
|
*/
|
|
271
271
|
invitations: PaginatedResourcesWithDefault<OrganizationInvitationResource>;
|
|
272
272
|
} | {
|
|
@@ -295,7 +295,7 @@ type UseOrganizationReturn<T$1 extends UseOrganizationParams> = {
|
|
|
295
295
|
} ? true : false> | null;
|
|
296
296
|
};
|
|
297
297
|
/**
|
|
298
|
-
* The `useOrganization()` hook retrieves attributes of the currently
|
|
298
|
+
* The `useOrganization()` hook retrieves attributes of the currently Active Organization.
|
|
299
299
|
*
|
|
300
300
|
* @example
|
|
301
301
|
* ### Expand and paginate attributes
|
|
@@ -330,7 +330,7 @@ type UseOrganizationReturn<T$1 extends UseOrganizationParams> = {
|
|
|
330
330
|
* @example
|
|
331
331
|
* ### Infinite pagination
|
|
332
332
|
*
|
|
333
|
-
* 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
|
|
333
|
+
* 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.
|
|
334
334
|
*
|
|
335
335
|
* ```tsx
|
|
336
336
|
* import { useOrganization } from '@clerk/react'
|
|
@@ -374,7 +374,7 @@ type UseOrganizationReturn<T$1 extends UseOrganizationParams> = {
|
|
|
374
374
|
* @example
|
|
375
375
|
* ### Simple pagination
|
|
376
376
|
*
|
|
377
|
-
* 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
|
|
377
|
+
* 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.
|
|
378
378
|
*
|
|
379
379
|
* Notice the difference between this example's pagination and the infinite pagination example above.
|
|
380
380
|
*
|
|
@@ -467,19 +467,19 @@ type UseOrganizationListReturn<T$1 extends UseOrganizationListParams> = {
|
|
|
467
467
|
*/
|
|
468
468
|
createOrganization: undefined;
|
|
469
469
|
/**
|
|
470
|
-
* A function that sets the active session and/or
|
|
470
|
+
* A function that sets the active session and/or Organization.
|
|
471
471
|
*/
|
|
472
472
|
setActive: undefined;
|
|
473
473
|
/**
|
|
474
|
-
* Returns `PaginatedResources` which includes a list of the user's
|
|
474
|
+
* Returns `PaginatedResources` which includes a list of the user's Organization memberships.
|
|
475
475
|
*/
|
|
476
476
|
userMemberships: PaginatedResourcesWithDefault<OrganizationMembershipResource>;
|
|
477
477
|
/**
|
|
478
|
-
* Returns `PaginatedResources` which includes a list of the user's
|
|
478
|
+
* Returns `PaginatedResources` which includes a list of the user's Organization invitations.
|
|
479
479
|
*/
|
|
480
480
|
userInvitations: PaginatedResourcesWithDefault<UserOrganizationInvitationResource>;
|
|
481
481
|
/**
|
|
482
|
-
* Returns `PaginatedResources` which includes a list of suggestions for
|
|
482
|
+
* Returns `PaginatedResources` which includes a list of suggestions for Organizations that the user can join.
|
|
483
483
|
*/
|
|
484
484
|
userSuggestions: PaginatedResourcesWithDefault<OrganizationSuggestionResource>;
|
|
485
485
|
} | {
|
|
@@ -532,7 +532,7 @@ type UseOrganizationListReturn<T$1 extends UseOrganizationListParams> = {
|
|
|
532
532
|
* @example
|
|
533
533
|
* ### Infinite pagination
|
|
534
534
|
*
|
|
535
|
-
* 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
|
|
535
|
+
* 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.
|
|
536
536
|
*
|
|
537
537
|
* ```tsx {{ filename: 'src/components/JoinedOrganizations.tsx' }}
|
|
538
538
|
* import { useOrganizationList } from '@clerk/react'
|
|
@@ -1050,7 +1050,7 @@ interface HookParams extends PaginatedHookConfig<PagesOrInfiniteOptions & {
|
|
|
1050
1050
|
__experimental_mode?: 'cache';
|
|
1051
1051
|
}> {
|
|
1052
1052
|
/**
|
|
1053
|
-
* Specifies whether to fetch for the current user or
|
|
1053
|
+
* Specifies whether to fetch for the current user or Organization.
|
|
1054
1054
|
*
|
|
1055
1055
|
* @default 'user'
|
|
1056
1056
|
*/
|
|
@@ -1095,7 +1095,7 @@ declare const usePlans: <T extends HookParams>(params?: T | undefined) => Pagina
|
|
|
1095
1095
|
*/
|
|
1096
1096
|
type UseSubscriptionParams = {
|
|
1097
1097
|
/**
|
|
1098
|
-
* Specifies whether to fetch the
|
|
1098
|
+
* Specifies whether to fetch the Subscription for an Organization or a user.
|
|
1099
1099
|
*
|
|
1100
1100
|
* @default 'user'
|
|
1101
1101
|
*/
|
|
@@ -1167,17 +1167,17 @@ declare const OptionsContext: React.Context<ClerkOptions>;
|
|
|
1167
1167
|
*/
|
|
1168
1168
|
type UseCheckoutOptions = {
|
|
1169
1169
|
/**
|
|
1170
|
-
* Specifies if the checkout is for an
|
|
1170
|
+
* Specifies if the checkout is for an Organization.
|
|
1171
1171
|
*
|
|
1172
1172
|
* @default 'user'
|
|
1173
1173
|
*/
|
|
1174
1174
|
for?: ForPayerType;
|
|
1175
1175
|
/**
|
|
1176
|
-
* The billing period for the
|
|
1176
|
+
* The billing period for the Plan.
|
|
1177
1177
|
*/
|
|
1178
1178
|
planPeriod: BillingSubscriptionPlanPeriod;
|
|
1179
1179
|
/**
|
|
1180
|
-
* The ID of the
|
|
1180
|
+
* The ID of the Subscription Plan to check out (e.g. `cplan_xxx`).
|
|
1181
1181
|
*/
|
|
1182
1182
|
planId: string;
|
|
1183
1183
|
};
|
|
@@ -1436,7 +1436,7 @@ type PaymentElementProviderProps = {
|
|
|
1436
1436
|
*/
|
|
1437
1437
|
stripeAppearance?: internalStripeAppearance;
|
|
1438
1438
|
/**
|
|
1439
|
-
* Specifies whether to fetch for the current user or
|
|
1439
|
+
* Specifies whether to fetch for the current user or Organization.
|
|
1440
1440
|
*
|
|
1441
1441
|
* @default 'user'
|
|
1442
1442
|
*/
|
|
@@ -5,8 +5,8 @@ require('../isomorphicBtoa-oWNvIgSP.js');
|
|
|
5
5
|
require('../keys-wr08qE7Y.js');
|
|
6
6
|
const require_authorization_errors = require('../authorization-errors-B7aH39AU.js');
|
|
7
7
|
const require_authorization = require('../authorization-R5uuaK2u.js');
|
|
8
|
-
const require_error = require('../error-
|
|
9
|
-
const require_organization = require('../organization-
|
|
8
|
+
const require_error = require('../error-CJmIhSJi.js');
|
|
9
|
+
const require_organization = require('../organization-BOnxJJGM.js');
|
|
10
10
|
require('../noop-DEV2Xnb4.js');
|
|
11
11
|
require('../underscore-moIbQc1H.js');
|
|
12
12
|
const require_telemetry = require('../telemetry-CXXDXYfo.js');
|
|
@@ -586,7 +586,7 @@ const undefinedPaginatedResource$1 = {
|
|
|
586
586
|
setData: void 0
|
|
587
587
|
};
|
|
588
588
|
/**
|
|
589
|
-
* The `useOrganization()` hook retrieves attributes of the currently
|
|
589
|
+
* The `useOrganization()` hook retrieves attributes of the currently Active Organization.
|
|
590
590
|
*
|
|
591
591
|
* @example
|
|
592
592
|
* ### Expand and paginate attributes
|
|
@@ -621,7 +621,7 @@ const undefinedPaginatedResource$1 = {
|
|
|
621
621
|
* @example
|
|
622
622
|
* ### Infinite pagination
|
|
623
623
|
*
|
|
624
|
-
* 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
|
|
624
|
+
* 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.
|
|
625
625
|
*
|
|
626
626
|
* ```tsx
|
|
627
627
|
* import { useOrganization } from '@clerk/react'
|
|
@@ -665,7 +665,7 @@ const undefinedPaginatedResource$1 = {
|
|
|
665
665
|
* @example
|
|
666
666
|
* ### Simple pagination
|
|
667
667
|
*
|
|
668
|
-
* 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
|
|
668
|
+
* 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.
|
|
669
669
|
*
|
|
670
670
|
* Notice the difference between this example's pagination and the infinite pagination example above.
|
|
671
671
|
*
|
|
@@ -928,7 +928,7 @@ const undefinedPaginatedResource = {
|
|
|
928
928
|
* @example
|
|
929
929
|
* ### Infinite pagination
|
|
930
930
|
*
|
|
931
|
-
* 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
|
|
931
|
+
* 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.
|
|
932
932
|
*
|
|
933
933
|
* ```tsx {{ filename: 'src/components/JoinedOrganizations.tsx' }}
|
|
934
934
|
* import { useOrganizationList } from '@clerk/react'
|
|
@@ -1603,7 +1603,7 @@ function useBillingHookEnabled(params) {
|
|
|
1603
1603
|
//#region src/react/hooks/createBillingPaginatedHook.tsx
|
|
1604
1604
|
/**
|
|
1605
1605
|
* A hook factory that creates paginated data fetching hooks for commerce-related resources.
|
|
1606
|
-
* It provides a standardized way to create hooks that can fetch either user or
|
|
1606
|
+
* It provides a standardized way to create hooks that can fetch either user or Organization resources
|
|
1607
1607
|
* with built-in pagination support.
|
|
1608
1608
|
*
|
|
1609
1609
|
* The generated hooks handle:
|