@datalayer/core 1.0.20 → 1.0.22

package/lib/hooks/useCache.d.ts

@@ -1,10 +1,8 @@
 /**
  * TanStack Query-based cache hook for Datalayer API
+ * for automatic cache management, background refetching,
+ * and optimistic updates.
  *
- * This is a modernized replacement for useCache.tsx that leverages TanStack Query
- * for automatic cache management, background refetching, and optimistic updates.
- *
- * Key improvements over useCache:
  * - Automatic cache management (no manual Map objects)
  * - Built-in loading/error states
  * - Automatic refetching and deduplication
@@ -64,7 +62,9 @@ export declare const queryKeys: {
         readonly details: () => readonly ["users", "detail"];
         readonly detail: (id: string) => readonly ["users", "detail", string];
         readonly byHandle: (handle: string) => readonly ["users", "handle", string];
+        readonly publicProfileByHandle: (handle: string) => readonly ["users", "public-profile", string];
         readonly search: (pattern: string) => readonly ["users", "search", string];
+        readonly bulk: (userIdsKey: string) => readonly ["users", "bulk", string];
         readonly settings: (userId: string) => readonly ["users", "detail", string, "settings"];
         readonly onboarding: (userId: string) => readonly ["users", "detail", string, "onboarding"];
         readonly surveys: (userId: string) => readonly ["users", "detail", string, "surveys"];
@@ -76,6 +76,7 @@ export declare const queryKeys: {
         readonly details: () => readonly ["organizations", "detail"];
         readonly detail: (id: string) => readonly ["organizations", "detail", string];
         readonly byHandle: (handle: string) => readonly ["organizations", "handle", string];
+        readonly publicProfileByHandle: (handle: string) => readonly ["organizations", "public-profile", string];
         readonly userOrgs: () => readonly ["organizations", "user"];
         readonly members: (orgId: string) => readonly ["organizations", "detail", string, "members"];
     };
@@ -220,6 +221,12 @@ export declare const queryKeys: {
         readonly userById: (userId: string) => readonly ["usages", "user", string];
         readonly platform: () => readonly ["usages", "platform"];
     };
+    readonly credits: {
+        readonly organizationOverview: (organizationUid: string) => readonly ["credits", "allocations", "organization", string];
+        readonly organizationHistory: (organizationUid: string) => readonly ["credits", "allocations", "organization", string, "history"];
+        readonly teamOverview: (teamUid: string) => readonly ["credits", "allocations", "team", string];
+        readonly teamHistory: (teamUid: string) => readonly ["credits", "allocations", "team", string, "history"];
+    };
     readonly prices: {
         readonly stripe: () => readonly ["prices", "stripe"];
     };
@@ -342,7 +349,9 @@ export declare const useCache: ({ loginRoute }?: CacheProps) => {
     }, unknown>;
     useUser: (userId: string) => import("@tanstack/react-query").UseQueryResult<IUser | undefined, Error>;
     useUserByHandle: (handle: string) => import("@tanstack/react-query").UseQueryResult<any, Error>;
+    useUserPublicProfileByHandle: (handle: string) => import("@tanstack/react-query").UseQueryResult<any, Error>;
     useSearchUsers: (namingPattern: string) => import("@tanstack/react-query").UseQueryResult<IUser[], Error>;
+    useUsersByUids: (userIds: string[]) => import("@tanstack/react-query").UseQueryResult<IUser[], Error>;
     useUpdateUserOnboarding: () => import("@tanstack/react-query").UseMutationResult<any, Error, IUserOnboarding, unknown>;
     useUpdateUserSettings: () => import("@tanstack/react-query").UseMutationResult<any, Error, {
         userId: string;
@@ -363,15 +372,42 @@ export declare const useCache: ({ loginRoute }?: CacheProps) => {
         userId: string;
         roleName: string;
     }, unknown>;
+    useOrganizationAllocationOverview: (organizationUid: string) => import("@tanstack/react-query").UseQueryResult<any, Error>;
+    useOrganizationAllocationHistory: (organizationUid: string) => import("@tanstack/react-query").UseQueryResult<any, Error>;
+    useTeamAllocationOverview: (teamUid: string) => import("@tanstack/react-query").UseQueryResult<any, Error>;
+    useTeamAllocationHistory: (teamUid: string) => import("@tanstack/react-query").UseQueryResult<any, Error>;
+    useAllocateOrganizationCreditsToTeam: () => import("@tanstack/react-query").UseMutationResult<any, Error, {
+        organizationUid: string;
+        teamUid: string;
+        amount: number;
+    }, unknown>;
+    useAllocateTeamCreditsToMember: () => import("@tanstack/react-query").UseMutationResult<any, Error, {
+        teamUid: string;
+        memberUid: string;
+        amount: number;
+    }, unknown>;
+    useRevokeOrganizationCreditsFromTeam: () => import("@tanstack/react-query").UseMutationResult<any, Error, {
+        organizationUid: string;
+        teamUid: string;
+        amount: number;
+    }, unknown>;
+    useRevokeTeamCreditsFromMember: () => import("@tanstack/react-query").UseMutationResult<any, Error, {
+        teamUid: string;
+        memberUid: string;
+        amount: number;
+    }, unknown>;
     useUpdateUserCreditsQuota: () => import("@tanstack/react-query").UseMutationResult<any, Error, {
         userId: string;
         quota?: number;
     }, unknown>;
-    useUsages: (options?: Omit<UseQueryOptions<unknown[]>, "queryKey" | "queryFn">) => import("@tanstack/react-query").UseQueryResult<unknown[], Error>;
+    useUsages: (scopeOrOptions?: {
+        accountUid?: string;
+    } | Omit<UseQueryOptions<unknown[]>, "queryKey" | "queryFn">, options?: Omit<UseQueryOptions<unknown[]>, "queryKey" | "queryFn">) => import("@tanstack/react-query").UseQueryResult<unknown[], Error>;
     useUsagesForUser: (userId: string, options?: Omit<UseQueryOptions<unknown[]>, "queryKey" | "queryFn">) => import("@tanstack/react-query").UseQueryResult<unknown[], Error>;
     usePlatformUsages: (options?: Omit<UseQueryOptions<unknown[]>, "queryKey" | "queryFn">) => import("@tanstack/react-query").UseQueryResult<unknown[], Error>;
     useOrganization: (organizationId: string) => import("@tanstack/react-query").UseQueryResult<IOrganization, Error>;
     useOrganizationByHandle: (handle: string) => import("@tanstack/react-query").UseQueryResult<IOrganization | null, Error>;
+    useOrganizationPublicProfileByHandle: (handle: string) => import("@tanstack/react-query").UseQueryResult<any, Error>;
     useUserOrganizations: () => import("@tanstack/react-query").UseQueryResult<any, Error>;
     useCreateOrganization: () => import("@tanstack/react-query").UseMutationResult<any, Error, Partial<IOrganization>, unknown>;
     useUpdateOrganization: () => import("@tanstack/react-query").UseMutationResult<any, Error, Partial<IAnyOrganization>, unknown>;
@@ -437,10 +473,17 @@ export declare const useCache: ({ loginRoute }?: CacheProps) => {
     useOrganizationSpaces: (organizationId: string) => import("@tanstack/react-query").UseQueryResult<any, Error>;
     useUserSpace: (spaceId: string) => import("@tanstack/react-query").UseQueryResult<IAnySpace | null, Error>;
     useUserSpaceByHandle: (handle: string) => import("@tanstack/react-query").UseQueryResult<{} | null, Error>;
-    useUserSpaces: () => import("@tanstack/react-query").UseQueryResult<any, Error>;
+    useUserSpaces: (scope?: {
+        selectedPrincipalUid?: string;
+        selectedPrincipalKind?: "user" | "organization" | "team";
+    }) => import("@tanstack/react-query").UseQueryResult<any, Error>;
     useCreateSpace: () => import("@tanstack/react-query").UseMutationResult<any, Error, {
         space: Partial<IAnySpace>;
         organization?: IAnyOrganization;
+        team?: {
+            id?: string;
+            handle?: string;
+        };
     }, unknown>;
     useUpdateSpace: () => import("@tanstack/react-query").UseMutationResult<any, Error, Partial<IAnySpace> & Record<string, unknown>, unknown>;
     useDeleteSpace: () => import("@tanstack/react-query").UseMutationResult<any, Error, string, unknown>;
@@ -659,24 +702,53 @@ export declare const useCache: ({ loginRoute }?: CacheProps) => {
     useClearCachedPublicItems: (options?: UseMutationOptions<void, Error, void>) => import("@tanstack/react-query").UseMutationResult<void, Error, void, unknown>;
     useClearCachedItems: (options?: UseMutationOptions<void, Error, void>) => import("@tanstack/react-query").UseMutationResult<void, Error, void, unknown>;
     usePage: (pageId: string) => import("@tanstack/react-query").UseQueryResult<IPage | undefined, Error>;
-    usePages: () => import("@tanstack/react-query").UseQueryResult<any, Error>;
+    usePages: (scope?: {
+        selectedPrincipalUid?: string;
+        selectedPrincipalKind?: "user" | "organization" | "team";
+    }) => import("@tanstack/react-query").UseQueryResult<any, Error>;
     useCreatePage: () => import("@tanstack/react-query").UseMutationResult<any, Error, Omit<IPage, "id">, unknown>;
     useUpdatePage: () => import("@tanstack/react-query").UseMutationResult<any, Error, Pick<IPage, "id" | "name" | "tags" | "description">, unknown>;
     useDeletePage: () => import("@tanstack/react-query").UseMutationResult<any, Error, string, unknown>;
-    useDatasource: (datasourceId: string) => import("@tanstack/react-query").UseQueryResult<IDatasource | null | undefined, Error>;
-    useDatasources: () => import("@tanstack/react-query").UseQueryResult<any, Error>;
-    useCreateDatasource: () => import("@tanstack/react-query").UseMutationResult<any, Error, Omit<IDatasource, "id">, unknown>;
-    useUpdateDatasource: () => import("@tanstack/react-query").UseMutationResult<any, Error, IDatasource, unknown>;
+    useDatasource: (datasourceId: string, options?: {
+        principalUid?: string;
+        principalKind?: "user" | "organization" | "team";
+    }) => import("@tanstack/react-query").UseQueryResult<IDatasource | null | undefined, Error>;
+    useDatasources: (options?: {
+        principalUid?: string;
+        principalKind?: "user" | "organization" | "team";
+    }) => import("@tanstack/react-query").UseQueryResult<any, Error>;
+    useCreateDatasource: (options?: {
+        principalUid?: string;
+        principalKind?: "user" | "organization" | "team";
+    }) => import("@tanstack/react-query").UseMutationResult<any, Error, Omit<IDatasource, "id">, unknown>;
+    useUpdateDatasource: (options?: {
+        principalUid?: string;
+        principalKind?: "user" | "organization" | "team";
+    }) => import("@tanstack/react-query").UseMutationResult<any, Error, IDatasource, unknown>;
     useSecret: (secretId: string, options?: {
+        principalUid?: string;
+        principalKind?: "user" | "organization" | "team";
         enabled?: boolean;
         refetchOnMount?: boolean | "always";
         staleTime?: number;
         gcTime?: number;
     }) => import("@tanstack/react-query").UseQueryResult<ISecret | null | undefined, Error>;
-    useSecrets: () => import("@tanstack/react-query").UseQueryResult<any, Error>;
-    useCreateSecret: () => import("@tanstack/react-query").UseMutationResult<any, Error, Omit<ISecret, "id">, unknown>;
-    useUpdateSecret: () => import("@tanstack/react-query").UseMutationResult<any, Error, ISecret, unknown>;
-    useDeleteSecret: () => import("@tanstack/react-query").UseMutationResult<any, Error, string, unknown>;
+    useSecrets: (options?: {
+        principalUid?: string;
+        principalKind?: "user" | "organization" | "team";
+    }) => import("@tanstack/react-query").UseQueryResult<any, Error>;
+    useCreateSecret: (options?: {
+        principalUid?: string;
+        principalKind?: "user" | "organization" | "team";
+    }) => import("@tanstack/react-query").UseMutationResult<any, Error, Omit<ISecret, "id">, unknown>;
+    useUpdateSecret: (options?: {
+        principalUid?: string;
+        principalKind?: "user" | "organization" | "team";
+    }) => import("@tanstack/react-query").UseMutationResult<any, Error, ISecret, unknown>;
+    useDeleteSecret: (options?: {
+        principalUid?: string;
+        principalKind?: "user" | "organization" | "team";
+    }) => import("@tanstack/react-query").UseMutationResult<any, Error, string, unknown>;
     useToken: (tokenId: string) => import("@tanstack/react-query").UseQueryResult<IIAMToken | null | undefined, Error>;
     useTokens: () => import("@tanstack/react-query").UseQueryResult<any, Error>;
     useCreateToken: () => import("@tanstack/react-query").UseMutationResult<any, Error, Omit<IIAMToken, "id" | "value">, unknown>;
@@ -780,12 +852,37 @@ export declare const useCache: ({ loginRoute }?: CacheProps) => {
         userUid: string;
         code: string;
     }, unknown>;
-    useCreateCheckoutSession: () => import("@tanstack/react-query").UseMutationResult<any, Error, {
+    useCreateTopUpPaymentIntent: (scope?: {
+        accountUid?: string;
+    }) => import("@tanstack/react-query").UseMutationResult<any, Error, {
         product: any;
-        location: Location;
     }, unknown>;
+    useCreateSubscriptionPaymentIntent: (scope?: {
+        accountUid?: string;
+    }) => import("@tanstack/react-query").UseMutationResult<any, Error, {
+        plan: any;
+    }, unknown>;
+    useCreateResumeSetupIntent: (scope?: {
+        accountUid?: string;
+    }) => import("@tanstack/react-query").UseMutationResult<any, Error, void, unknown>;
+    useSubscriptionStatus: (scope?: {
+        accountUid?: string;
+    }, options?: Omit<UseQueryOptions<any>, "queryKey" | "queryFn">) => import("@tanstack/react-query").UseQueryResult<any, Error>;
+    useSubscriptionPlans: (scope?: {
+        accountUid?: string;
+    }, options?: Omit<UseQueryOptions<unknown[]>, "queryKey" | "queryFn">) => import("@tanstack/react-query").UseQueryResult<unknown[], Error>;
+    useEligibleSubscriptionAccounts: (options?: Omit<UseQueryOptions<any[]>, "queryKey" | "queryFn">) => import("@tanstack/react-query").UseQueryResult<any[], Error>;
+    useSubscriptionAccountsDetails: (accountUids: string[], options?: Omit<UseQueryOptions<any[]>, "queryKey" | "queryFn" | "enabled">) => import("@tanstack/react-query").UseQueryResult<any[], Error>;
+    useCancelSubscription: (scope?: {
+        accountUid?: string;
+    }) => import("@tanstack/react-query").UseMutationResult<any, Error, void, unknown>;
+    useResumeSubscription: (scope?: {
+        accountUid?: string;
+    }) => import("@tanstack/react-query").UseMutationResult<any, Error, void, unknown>;
+    useUserSubscription: (userId: string | undefined, options?: Omit<UseQueryOptions<any>, "queryKey" | "queryFn">) => import("@tanstack/react-query").UseQueryResult<any, Error>;
+    useResetUserSubscription: () => import("@tanstack/react-query").UseMutationResult<any, Error, string, unknown>;
     useBurnCredit: () => import("@tanstack/react-query").UseMutationResult<any, Error, number, unknown>;
-    useStripePrices: (options?: Omit<UseQueryOptions<unknown[]>, "queryKey" | "queryFn">) => import("@tanstack/react-query").UseQueryResult<unknown[], Error>;
+    useTopUpPrices: (options?: Omit<UseQueryOptions<unknown[]>, "queryKey" | "queryFn">) => import("@tanstack/react-query").UseQueryResult<unknown[], Error>;
     useRequestPlatformSupport: () => import("@tanstack/react-query").UseMutationResult<any, Error, {
         subject: string;
         message: string;
@@ -801,6 +898,7 @@ export declare const useCache: ({ loginRoute }?: CacheProps) => {
     }, unknown>;
     useUserSurveys: (userId: string, options?: Omit<UseQueryOptions<unknown>, "queryKey" | "queryFn">) => import("@tanstack/react-query").UseQueryResult<unknown, Error>;
     useGrowthKPI: (options?: Omit<UseQueryOptions<unknown>, "queryKey" | "queryFn">) => import("@tanstack/react-query").UseQueryResult<unknown, Error>;
+    useGrowthContactsKPI: (options?: Omit<UseQueryOptions<unknown>, "queryKey" | "queryFn">) => import("@tanstack/react-query").UseQueryResult<unknown, Error>;
     queryKeys: {
         readonly auth: {
             readonly me: () => readonly ["auth", "me"];
@@ -815,7 +913,9 @@ export declare const useCache: ({ loginRoute }?: CacheProps) => {
             readonly details: () => readonly ["users", "detail"];
             readonly detail: (id: string) => readonly ["users", "detail", string];
             readonly byHandle: (handle: string) => readonly ["users", "handle", string];
+            readonly publicProfileByHandle: (handle: string) => readonly ["users", "public-profile", string];
             readonly search: (pattern: string) => readonly ["users", "search", string];
+            readonly bulk: (userIdsKey: string) => readonly ["users", "bulk", string];
             readonly settings: (userId: string) => readonly ["users", "detail", string, "settings"];
             readonly onboarding: (userId: string) => readonly ["users", "detail", string, "onboarding"];
             readonly surveys: (userId: string) => readonly ["users", "detail", string, "surveys"];
@@ -827,6 +927,7 @@ export declare const useCache: ({ loginRoute }?: CacheProps) => {
             readonly details: () => readonly ["organizations", "detail"];
             readonly detail: (id: string) => readonly ["organizations", "detail", string];
             readonly byHandle: (handle: string) => readonly ["organizations", "handle", string];
+            readonly publicProfileByHandle: (handle: string) => readonly ["organizations", "public-profile", string];
             readonly userOrgs: () => readonly ["organizations", "user"];
             readonly members: (orgId: string) => readonly ["organizations", "detail", string, "members"];
         };
@@ -971,6 +1072,12 @@ export declare const useCache: ({ loginRoute }?: CacheProps) => {
             readonly userById: (userId: string) => readonly ["usages", "user", string];
             readonly platform: () => readonly ["usages", "platform"];
         };
+        readonly credits: {
+            readonly organizationOverview: (organizationUid: string) => readonly ["credits", "allocations", "organization", string];
+            readonly organizationHistory: (organizationUid: string) => readonly ["credits", "allocations", "organization", string, "history"];
+            readonly teamOverview: (teamUid: string) => readonly ["credits", "allocations", "team", string];
+            readonly teamHistory: (teamUid: string) => readonly ["credits", "allocations", "team", string, "history"];
+        };
         readonly prices: {
             readonly stripe: () => readonly ["prices", "stripe"];
         };