diff --git a/.changeset/rename-clerk-rq-to-query.md b/.changeset/rename-clerk-rq-to-query.md new file mode 100644 index 00000000000..a845151cc84 --- /dev/null +++ b/.changeset/rename-clerk-rq-to-query.md @@ -0,0 +1,2 @@ +--- +--- diff --git a/packages/shared/src/keyless/nodeFileStorage.ts b/packages/shared/src/keyless/nodeFileStorage.ts index 512747018ba..afb4115a6c2 100644 --- a/packages/shared/src/keyless/nodeFileStorage.ts +++ b/packages/shared/src/keyless/nodeFileStorage.ts @@ -15,6 +15,7 @@ export interface NodeFileStorageOptions { /** * The framework name for the README message. + * * @example '@clerk/nextjs' */ frameworkPackageName?: string; diff --git a/packages/shared/src/organization.ts b/packages/shared/src/organization.ts index 04071635de4..ab48e025654 100644 --- a/packages/shared/src/organization.ts +++ b/packages/shared/src/organization.ts @@ -2,6 +2,7 @@ import type { OrganizationMembershipResource } from './types'; /** * Finds the Organization membership for a given Organization ID from a list of memberships + * * @param organizationMemberships - Array of Organization memberships to search through * @param organizationId - ID of the Organization to find the membership for * @returns The matching Organization membership or undefined if not found diff --git a/packages/shared/src/react/billing/useInitializePaymentMethod.tsx b/packages/shared/src/react/billing/useInitializePaymentMethod.tsx index 7842b28126e..ec52bbc64f7 100644 --- a/packages/shared/src/react/billing/useInitializePaymentMethod.tsx +++ b/packages/shared/src/react/billing/useInitializePaymentMethod.tsx @@ -1,13 +1,13 @@ import { useCallback, useMemo } from 'react'; import type { BillingInitializedPaymentMethodResource, ForPayerType } from '../../types'; -import { defineKeepPreviousDataFn } from '../clerk-rq/keep-previous-data'; -import { useClerkQueryClient } from '../clerk-rq/use-clerk-query-client'; -import { useClerkQuery } from '../clerk-rq/useQuery'; import { useOrganizationBase } from '../hooks/base/useOrganizationBase'; import { useUserBase } from '../hooks/base/useUserBase'; import { useBillingIsEnabled } from '../hooks/useBillingIsEnabled'; import { useClearQueriesOnSignOut } from '../hooks/useClearQueriesOnSignOut'; +import { defineKeepPreviousDataFn } from '../query/keep-previous-data'; +import { useClerkQueryClient } from '../query/use-clerk-query-client'; +import { useClerkQuery } from '../query/useQuery'; type InitializePaymentMethodOptions = { for?: ForPayerType; diff --git a/packages/shared/src/react/billing/useStripeClerkLibs.tsx b/packages/shared/src/react/billing/useStripeClerkLibs.tsx index 3a499ae36bc..8af382fb76d 100644 --- a/packages/shared/src/react/billing/useStripeClerkLibs.tsx +++ b/packages/shared/src/react/billing/useStripeClerkLibs.tsx @@ -1,8 +1,8 @@ import type { loadStripe } from '@stripe/stripe-js'; -import { defineKeepPreviousDataFn } from '../clerk-rq/keep-previous-data'; -import { useClerkQuery } from '../clerk-rq/useQuery'; import { useClerk } from '../hooks/useClerk'; +import { defineKeepPreviousDataFn } from '../query/keep-previous-data'; +import { useClerkQuery } from '../query/useQuery'; type LoadStripeFn = typeof loadStripe; diff --git a/packages/shared/src/react/billing/useStripeLoader.tsx b/packages/shared/src/react/billing/useStripeLoader.tsx index 7b6d9e097c7..58cfa779bac 100644 --- a/packages/shared/src/react/billing/useStripeLoader.tsx +++ b/packages/shared/src/react/billing/useStripeLoader.tsx @@ -1,9 +1,9 @@ import type { Stripe } from '@stripe/stripe-js'; import { useMemo } from 'react'; -import { defineKeepPreviousDataFn } from '../clerk-rq/keep-previous-data'; -import { useClerkQuery } from '../clerk-rq/useQuery'; import { useBillingIsEnabled } from '../hooks/useBillingIsEnabled'; +import { defineKeepPreviousDataFn } from '../query/keep-previous-data'; +import { useClerkQuery } from '../query/useQuery'; import type { UseStripeClerkLibsResult } from './useStripeClerkLibs'; type StripeLoaderOptions = { diff --git a/packages/shared/src/react/hooks/__tests__/mocks/clerk.ts b/packages/shared/src/react/hooks/__tests__/mocks/clerk.ts index fb03bc40cab..f7dccfc1acc 100644 --- a/packages/shared/src/react/hooks/__tests__/mocks/clerk.ts +++ b/packages/shared/src/react/hooks/__tests__/mocks/clerk.ts @@ -1,7 +1,7 @@ import { QueryClient } from '@tanstack/query-core'; import { vi } from 'vitest'; -import { __setClerkQueryClientForTest } from '@/react/clerk-rq/clerk-query-client'; +import { __setClerkQueryClientForTest } from '@/react/query/clerk-query-client'; /** * Builds a deterministic QueryClient and installs it as the shared singleton. @@ -28,7 +28,7 @@ export function createMockQueryClient() { } /** - * Simple mock Clerk factory with common properties. The clerk-rq query client + * Simple mock Clerk factory with common properties. The shared query client * is no longer attached to the Clerk instance — pass `queryClient: null` to * reset the shared singleton, or omit the option to install a fresh default. */ diff --git a/packages/shared/src/react/hooks/__tests__/useClearQueriesOnSignOut.spec.ts b/packages/shared/src/react/hooks/__tests__/useClearQueriesOnSignOut.spec.ts index 046d6e9c51a..e134f9cd4a0 100644 --- a/packages/shared/src/react/hooks/__tests__/useClearQueriesOnSignOut.spec.ts +++ b/packages/shared/src/react/hooks/__tests__/useClearQueriesOnSignOut.spec.ts @@ -6,7 +6,7 @@ import { createMockQueryClient } from './mocks/clerk'; const mockQueryClient = createMockQueryClient(); -vi.mock('../../clerk-rq/use-clerk-query-client', () => ({ +vi.mock('../../query/use-clerk-query-client', () => ({ useClerkQueryClient: () => [mockQueryClient.client], })); diff --git a/packages/shared/src/react/hooks/useClearQueriesOnSignOut.ts b/packages/shared/src/react/hooks/useClearQueriesOnSignOut.ts index ddf95198123..25ae0847e34 100644 --- a/packages/shared/src/react/hooks/useClearQueriesOnSignOut.ts +++ b/packages/shared/src/react/hooks/useClearQueriesOnSignOut.ts @@ -1,6 +1,6 @@ import { useEffect, useRef } from 'react'; -import { useClerkQueryClient } from '../clerk-rq/use-clerk-query-client'; +import { useClerkQueryClient } from '../query/use-clerk-query-client'; import { usePreviousValue } from './usePreviousValue'; export const withInfiniteKey = (key: T) => [key, `${key}-inf`] as const; diff --git a/packages/shared/src/react/hooks/useOAuthConsent.tsx b/packages/shared/src/react/hooks/useOAuthConsent.tsx index aba685682d9..b35da37dfd4 100644 --- a/packages/shared/src/react/hooks/useOAuthConsent.tsx +++ b/packages/shared/src/react/hooks/useOAuthConsent.tsx @@ -1,8 +1,8 @@ import { eventMethodCalled } from '../../telemetry/events/method-called'; import type { LoadedClerk } from '../../types/clerk'; -import { defineKeepPreviousDataFn } from '../clerk-rq/keep-previous-data'; -import { useClerkQuery } from '../clerk-rq/useQuery'; import { useAssertWrappedByClerkProvider, useClerkInstanceContext } from '../contexts'; +import { defineKeepPreviousDataFn } from '../query/keep-previous-data'; +import { useClerkQuery } from '../query/useQuery'; import { useUserBase } from './base/useUserBase'; import { useOAuthConsentCacheKeys } from './useOAuthConsent.shared'; import type { UseOAuthConsentParams, UseOAuthConsentReturn } from './useOAuthConsent.types'; diff --git a/packages/shared/src/react/hooks/useOrganizationCreationDefaults.tsx b/packages/shared/src/react/hooks/useOrganizationCreationDefaults.tsx index 2a39e5ae187..58a09eae8f7 100644 --- a/packages/shared/src/react/hooks/useOrganizationCreationDefaults.tsx +++ b/packages/shared/src/react/hooks/useOrganizationCreationDefaults.tsx @@ -1,8 +1,8 @@ import { eventMethodCalled } from '../../telemetry/events/method-called'; import type { EnvironmentResource } from '../../types/environment'; -import { defineKeepPreviousDataFn } from '../clerk-rq/keep-previous-data'; -import { useClerkQuery } from '../clerk-rq/useQuery'; import { useAssertWrappedByClerkProvider, useClerkInstanceContext } from '../contexts'; +import { defineKeepPreviousDataFn } from '../query/keep-previous-data'; +import { useClerkQuery } from '../query/useQuery'; import { useUserBase } from './base/useUserBase'; import { useOrganizationCreationDefaultsCacheKeys } from './useOrganizationCreationDefaults.shared'; import type { diff --git a/packages/shared/src/react/hooks/usePagesOrInfinite.tsx b/packages/shared/src/react/hooks/usePagesOrInfinite.tsx index 64b153227cf..9cd43da7f8e 100644 --- a/packages/shared/src/react/hooks/usePagesOrInfinite.tsx +++ b/packages/shared/src/react/hooks/usePagesOrInfinite.tsx @@ -1,10 +1,10 @@ import { useCallback, useMemo, useRef, useState } from 'react'; import type { ClerkPaginatedResponse } from '../../types'; -import { defineKeepPreviousDataFn } from '../clerk-rq/keep-previous-data'; -import { useClerkQueryClient } from '../clerk-rq/use-clerk-query-client'; -import { useClerkInfiniteQuery } from '../clerk-rq/useInfiniteQuery'; -import { useClerkQuery } from '../clerk-rq/useQuery'; +import { defineKeepPreviousDataFn } from '../query/keep-previous-data'; +import { useClerkQueryClient } from '../query/use-clerk-query-client'; +import { useClerkInfiniteQuery } from '../query/useInfiniteQuery'; +import { useClerkQuery } from '../query/useQuery'; import type { CacheSetter, ValueOrSetter } from '../types'; import { useClearQueriesOnSignOut, withInfiniteKey } from './useClearQueriesOnSignOut'; import type { UsePagesOrInfiniteSignature } from './usePageOrInfinite.types'; diff --git a/packages/shared/src/react/hooks/usePaymentAttemptQuery.tsx b/packages/shared/src/react/hooks/usePaymentAttemptQuery.tsx index 70644cbd1e7..5065eefc9a9 100644 --- a/packages/shared/src/react/hooks/usePaymentAttemptQuery.tsx +++ b/packages/shared/src/react/hooks/usePaymentAttemptQuery.tsx @@ -1,6 +1,6 @@ -import { defineKeepPreviousDataFn } from '../clerk-rq/keep-previous-data'; -import { useClerkQuery } from '../clerk-rq/useQuery'; import { useClerkInstanceContext } from '../contexts'; +import { defineKeepPreviousDataFn } from '../query/keep-previous-data'; +import { useClerkQuery } from '../query/useQuery'; import { useOrganizationBase } from './base/useOrganizationBase'; import { useUserBase } from './base/useUserBase'; import { useBillingIsEnabled } from './useBillingIsEnabled'; diff --git a/packages/shared/src/react/hooks/usePlanDetailsQuery.tsx b/packages/shared/src/react/hooks/usePlanDetailsQuery.tsx index 9bffbc0e578..414d5690c03 100644 --- a/packages/shared/src/react/hooks/usePlanDetailsQuery.tsx +++ b/packages/shared/src/react/hooks/usePlanDetailsQuery.tsx @@ -1,6 +1,6 @@ -import { defineKeepPreviousDataFn } from '../clerk-rq/keep-previous-data'; -import { useClerkQuery } from '../clerk-rq/useQuery'; import { useClerkInstanceContext } from '../contexts'; +import { defineKeepPreviousDataFn } from '../query/keep-previous-data'; +import { useClerkQuery } from '../query/useQuery'; import { useBillingIsEnabled } from './useBillingIsEnabled'; import { usePlanDetailsQueryCacheKeys } from './usePlanDetailsQuery.shared'; import type { PlanDetailsQueryResult, UsePlanDetailsQueryParams } from './usePlanDetailsQuery.types'; diff --git a/packages/shared/src/react/hooks/useStatementQuery.tsx b/packages/shared/src/react/hooks/useStatementQuery.tsx index 864bfd894e3..41950ff807b 100644 --- a/packages/shared/src/react/hooks/useStatementQuery.tsx +++ b/packages/shared/src/react/hooks/useStatementQuery.tsx @@ -1,6 +1,6 @@ -import { defineKeepPreviousDataFn } from '../clerk-rq/keep-previous-data'; -import { useClerkQuery } from '../clerk-rq/useQuery'; import { useClerkInstanceContext } from '../contexts'; +import { defineKeepPreviousDataFn } from '../query/keep-previous-data'; +import { useClerkQuery } from '../query/useQuery'; import { useOrganizationBase } from './base/useOrganizationBase'; import { useUserBase } from './base/useUserBase'; import { useBillingIsEnabled } from './useBillingIsEnabled'; diff --git a/packages/shared/src/react/hooks/useSubscription.tsx b/packages/shared/src/react/hooks/useSubscription.tsx index 62bbeff7c9a..c005020165e 100644 --- a/packages/shared/src/react/hooks/useSubscription.tsx +++ b/packages/shared/src/react/hooks/useSubscription.tsx @@ -1,10 +1,10 @@ import { useCallback, useEffect, useRef } from 'react'; import { eventMethodCalled } from '../../telemetry/events'; -import { defineKeepPreviousDataFn } from '../clerk-rq/keep-previous-data'; -import { useClerkQueryClient } from '../clerk-rq/use-clerk-query-client'; -import { useClerkQuery } from '../clerk-rq/useQuery'; import { useAssertWrappedByClerkProvider, useClerkInstanceContext } from '../contexts'; +import { defineKeepPreviousDataFn } from '../query/keep-previous-data'; +import { useClerkQueryClient } from '../query/use-clerk-query-client'; +import { useClerkQuery } from '../query/useQuery'; import { useOrganizationBase } from './base/useOrganizationBase'; import { useUserBase } from './base/useUserBase'; import { useBillingIsEnabled } from './useBillingIsEnabled'; diff --git a/packages/shared/src/react/hooks/useUserEnterpriseConnections.tsx b/packages/shared/src/react/hooks/useUserEnterpriseConnections.tsx index 101224a0ceb..a80e03213b1 100644 --- a/packages/shared/src/react/hooks/useUserEnterpriseConnections.tsx +++ b/packages/shared/src/react/hooks/useUserEnterpriseConnections.tsx @@ -6,10 +6,10 @@ import type { EnterpriseConnectionResource, UpdateMeEnterpriseConnectionParams, } from '../../types/enterpriseConnection'; -import { defineKeepPreviousDataFn } from '../clerk-rq/keep-previous-data'; -import { useClerkQueryClient } from '../clerk-rq/use-clerk-query-client'; -import { useClerkQuery } from '../clerk-rq/useQuery'; import { useClerkInstanceContext } from '../contexts'; +import { defineKeepPreviousDataFn } from '../query/keep-previous-data'; +import { useClerkQueryClient } from '../query/use-clerk-query-client'; +import { useClerkQuery } from '../query/useQuery'; import { useUserBase } from './base/useUserBase'; import { useClearQueriesOnSignOut } from './useClearQueriesOnSignOut'; import { useUserEnterpriseConnectionsCacheKeys } from './useUserEnterpriseConnections.shared'; diff --git a/packages/shared/src/react/index.ts b/packages/shared/src/react/index.ts index 01e2ce9b3ba..41788b66de4 100644 --- a/packages/shared/src/react/index.ts +++ b/packages/shared/src/react/index.ts @@ -24,4 +24,4 @@ export { __resetClerkQueryClientForTest, __setClerkQueryClientForTest, getClerkQueryClient, -} from './clerk-rq/clerk-query-client'; +} from './query/clerk-query-client'; diff --git a/packages/shared/src/react/clerk-rq/__tests__/clerk-query-client.spec.ts b/packages/shared/src/react/query/__tests__/clerk-query-client.spec.ts similarity index 100% rename from packages/shared/src/react/clerk-rq/__tests__/clerk-query-client.spec.ts rename to packages/shared/src/react/query/__tests__/clerk-query-client.spec.ts diff --git a/packages/shared/src/react/clerk-rq/__tests__/useBaseQuery.spec.tsx b/packages/shared/src/react/query/__tests__/useBaseQuery.spec.tsx similarity index 100% rename from packages/shared/src/react/clerk-rq/__tests__/useBaseQuery.spec.tsx rename to packages/shared/src/react/query/__tests__/useBaseQuery.spec.tsx diff --git a/packages/shared/src/react/clerk-rq/clerk-query-client.ts b/packages/shared/src/react/query/clerk-query-client.ts similarity index 96% rename from packages/shared/src/react/clerk-rq/clerk-query-client.ts rename to packages/shared/src/react/query/clerk-query-client.ts index 0648711868a..bb155d005f4 100644 --- a/packages/shared/src/react/clerk-rq/clerk-query-client.ts +++ b/packages/shared/src/react/query/clerk-query-client.ts @@ -1,7 +1,7 @@ import { QueryClient } from '@tanstack/query-core'; /** - * The QueryClient backing every clerk-rq hook. Owned by `@clerk/shared` so the + * The QueryClient backing every clerk-query hook. Owned by `@clerk/shared` so the * `QueryObserver` that observes it and the `Query` objects inside it always * resolve to the same `@tanstack/query-core` (no cross-bundle drift between * the consumer-side `@clerk/shared` and the production CDN `clerk-js` bundle). diff --git a/packages/shared/src/react/clerk-rq/infiniteQueryOptions.ts b/packages/shared/src/react/query/infiniteQueryOptions.ts similarity index 100% rename from packages/shared/src/react/clerk-rq/infiniteQueryOptions.ts rename to packages/shared/src/react/query/infiniteQueryOptions.ts diff --git a/packages/shared/src/react/clerk-rq/keep-previous-data.ts b/packages/shared/src/react/query/keep-previous-data.ts similarity index 100% rename from packages/shared/src/react/clerk-rq/keep-previous-data.ts rename to packages/shared/src/react/query/keep-previous-data.ts diff --git a/packages/shared/src/react/clerk-rq/queryOptions.ts b/packages/shared/src/react/query/queryOptions.ts similarity index 100% rename from packages/shared/src/react/clerk-rq/queryOptions.ts rename to packages/shared/src/react/query/queryOptions.ts diff --git a/packages/shared/src/react/clerk-rq/types.ts b/packages/shared/src/react/query/types.ts similarity index 100% rename from packages/shared/src/react/clerk-rq/types.ts rename to packages/shared/src/react/query/types.ts diff --git a/packages/shared/src/react/clerk-rq/use-clerk-query-client.ts b/packages/shared/src/react/query/use-clerk-query-client.ts similarity index 100% rename from packages/shared/src/react/clerk-rq/use-clerk-query-client.ts rename to packages/shared/src/react/query/use-clerk-query-client.ts diff --git a/packages/shared/src/react/clerk-rq/useBaseQuery.ts b/packages/shared/src/react/query/useBaseQuery.ts similarity index 100% rename from packages/shared/src/react/clerk-rq/useBaseQuery.ts rename to packages/shared/src/react/query/useBaseQuery.ts diff --git a/packages/shared/src/react/clerk-rq/useInfiniteQuery.ts b/packages/shared/src/react/query/useInfiniteQuery.ts similarity index 100% rename from packages/shared/src/react/clerk-rq/useInfiniteQuery.ts rename to packages/shared/src/react/query/useInfiniteQuery.ts diff --git a/packages/shared/src/react/clerk-rq/useQuery.ts b/packages/shared/src/react/query/useQuery.ts similarity index 100% rename from packages/shared/src/react/clerk-rq/useQuery.ts rename to packages/shared/src/react/query/useQuery.ts