@xylex-group/athena 3.1.0 → 3.5.1

package/dist/react.d.cts

@@ -1,13 +1,14 @@
-import { u as AthenaGatewayHookConfig, v as AthenaGatewayHookResult } from './types-Bltx6iL6.cjs';
-export { w as AthenaDeletePayload, x as AthenaFetchPayload, a as AthenaGatewayCallOptions, d as AthenaGatewayErrorCode, e as AthenaGatewayErrorDetails, s as AthenaGatewayResponse, y as AthenaInsertPayload, f as AthenaJsonArray, g as AthenaJsonObject, h as AthenaJsonPrimitive, i as AthenaJsonValue, j as AthenaRpcCallOptions, k as AthenaRpcFilter, l as AthenaRpcFilterOperator, m as AthenaRpcOrder, n as AthenaRpcPayload, z as AthenaUpdatePayload } from './types-Bltx6iL6.cjs';
-import { a as AthenaReadQueryClient, c as AthenaReadQueryDefinition, e as AthenaReadQueryExecutionResult, i as AthenaReadQueryFlatRow } from './model-form-BhWWsA-7.cjs';
-export { A as AthenaGatewayError, M as ModelFormAdapter, D as ModelFormDefaults, E as ModelFormNullishMode, G as ModelFormValues, T as ToModelFormDefaultsOptions, H as ToModelPayloadOptions, _ as createModelFormAdapter, a3 as isAthenaGatewayError, a6 as toModelFormDefaults, a7 as toModelPayload } from './model-form-BhWWsA-7.cjs';
+import { y as AthenaGatewayHookConfig, z as AthenaGatewayHookResult } from './types-B2RZPivM.cjs';
+export { v as AthenaDeletePayload, u as AthenaFetchPayload, a as AthenaGatewayCallOptions, d as AthenaGatewayErrorCode, e as AthenaGatewayErrorDetails, s as AthenaGatewayResponse, w as AthenaInsertPayload, f as AthenaJsonArray, g as AthenaJsonObject, h as AthenaJsonPrimitive, i as AthenaJsonValue, j as AthenaRpcCallOptions, k as AthenaRpcFilter, l as AthenaRpcFilterOperator, m as AthenaRpcOrder, n as AthenaRpcPayload, x as AthenaUpdatePayload } from './types-B2RZPivM.cjs';
+import { a as AthenaReadQueryClient, c as AthenaReadQueryDefinition, e as AthenaReadQueryExecutionResult, i as AthenaReadQueryFlatRow } from './model-form-D0ykVVOs.cjs';
+export { A as AthenaGatewayError, M as ModelFormAdapter, D as ModelFormDefaults, E as ModelFormNullishMode, G as ModelFormValues, T as ToModelFormDefaultsOptions, H as ToModelPayloadOptions, _ as createModelFormAdapter, a3 as isAthenaGatewayError, a7 as toModelFormDefaults, a8 as toModelPayload } from './model-form-D0ykVVOs.cjs';
 import * as react from 'react';
 import { ReactNode } from 'react';
-import { aE as AthenaAuthFetchCompatibleInput, E as AthenaAuthCallOptions, ad as AthenaAuthSessionResponse, R as AthenaAuthErrorDetails, aa as AthenaAuthResult } from './types-AOY-GLu8.cjs';
-export { D as AthenaAuthBindings, aC as AuthBindings } from './types-AOY-GLu8.cjs';
-import { ax as AthenaRequestContext, b5 as AthenaStorageFileUploadInput, bp as AthenaStorageUploadSource, bb as AthenaStorageModule, bo as AthenaStorageUploadProgressHandler, bn as AthenaStorageUploadProgress, b8 as AthenaStorageFileUploadResult, aP as AthenaStorageCallOptions, b2 as AthenaStorageFileListInput, ck as StorageListFilesResponse, cf as StorageFileMutationResponse } from './v3-client-CWfZHcKL.cjs';
-import './types-CgCv5o6R.cjs';
+import { aE as AthenaAuthFetchCompatibleInput, E as AthenaAuthCallOptions, ad as AthenaAuthSessionResponse, R as AthenaAuthErrorDetails, aa as AthenaAuthResult, aD as AthenaAdminHasPermissionRequest } from './types-BVKpQmfY.cjs';
+export { D as AthenaAuthBindings, aC as AuthBindings } from './types-BVKpQmfY.cjs';
+import { AthenaAdminSessionLike, AthenaAdminPermissionCheckInput } from './admin.cjs';
+import { aA as AthenaRequestContext, b8 as AthenaStorageFileUploadInput, bs as AthenaStorageUploadSource, be as AthenaStorageModule, br as AthenaStorageUploadProgressHandler, bq as AthenaStorageUploadProgress, bb as AthenaStorageFileUploadResult, aS as AthenaStorageCallOptions, b5 as AthenaStorageFileListInput, cn as StorageListFilesResponse, ci as StorageFileMutationResponse } from './v3-client-DP-qg82X.cjs';
+import './types-D5dj1v5Z.cjs';
 import './module-C_ab-MM1.cjs';
 
 declare function useAthenaGateway(config?: AthenaGatewayHookConfig): AthenaGatewayHookResult;
@@ -230,9 +231,9 @@ declare function createAthenaQueryClient(config?: AthenaQueryClientConfig): Athe
 declare function attachStateAdapter(client: AthenaQueryClient, adapter: AthenaStateAdapter): AthenaUnsubscribe;
 
 interface AthenaQueryClientProviderProps {
+    children: ReactNode;
     client?: AthenaQueryClient;
     config?: AthenaQueryClientConfig;
-    children: ReactNode;
 }
 declare function AthenaQueryClientProvider(props: AthenaQueryClientProviderProps): react.FunctionComponentElement<react.ProviderProps<AthenaQueryClient | null>>;
 declare function useAthenaQueryClient(): AthenaQueryClient;
@@ -354,6 +355,55 @@ type InferSessionData$1<TClient> = TClient extends {
  */
 declare function useSession<TClient extends UseSessionAuthClient>(authClient: TClient, options?: UseSessionOptions): UseSessionResult<InferSessionData$1<TClient>>;
 
+interface UseAdminPermissionOptions {
+    /**
+     * Permission set checked via `client.auth.admin.hasPermission`.
+     * Defaults to `["admin:read"]`.
+     */
+    permissions?: AthenaAdminHasPermissionRequest['permissions'];
+    permission?: AthenaAdminHasPermissionRequest['permission'];
+    /**
+     * When provided, skips the internal session fetch.
+     * Pass `null` to force a denied result without calling getSession.
+     */
+    session?: AthenaAdminSessionLike | null;
+    allowRoleBypass?: boolean;
+    enabled?: boolean;
+    fetchOptions?: AthenaAdminPermissionCheckInput['fetchOptions'];
+    requestOptions?: AthenaAdminPermissionCheckInput['requestOptions'];
+    /** Forwarded to the internal `useSession` when `session` is omitted. */
+    sessionOptions?: Omit<UseSessionOptions, 'enabled'>;
+}
+interface UseAdminPermissionResult {
+    allowed: boolean;
+    isPending: boolean;
+    error: Error | null;
+    session: AthenaAdminSessionLike | null;
+    refetch: () => Promise<boolean>;
+}
+type AdminPermissionAuthClient = UseSessionAuthClient & {
+    auth?: {
+        admin?: unknown;
+    };
+    admin?: unknown;
+};
+/**
+ * React gate for Athena admin permissions.
+ *
+ * Uses {@link hasAdminPermission} from `@xylex-group/athena/admin` with an
+ * optional local `admin` role short-circuit. When `session` is omitted, loads
+ * the current session through {@link useSession}.
+ *
+ * @example
+ * ```tsx
+ * const athena = createClient({ url, key, auth: { url: "/api/auth" } })
+ * const { allowed, isPending } = useAdminPermission(athena, {
+ *   permissions: ["admin:read"],
+ * })
+ * ```
+ */
+declare function useAdminPermission(client: AdminPermissionAuthClient | null | undefined, options?: UseAdminPermissionOptions): UseAdminPermissionResult;
+
 type SessionGetter<TSessionData extends AthenaAuthSessionResponse> = (input?: AthenaAuthFetchCompatibleInput, options?: AthenaAuthCallOptions) => Promise<AthenaAuthResult<TSessionData>>;
 type AthenaContextScopedClient<TSessionData extends AthenaAuthSessionResponse = AthenaAuthSessionResponse> = {
     auth: {
@@ -400,14 +450,14 @@ interface UseStorageUploadResult {
 declare function useStorageUpload(options: UseStorageUploadOptions): UseStorageUploadResult;
 
 interface UseStorageFilesOptions {
-    storage: Pick<AthenaStorageModule, 'file'>;
+    storage: Pick<AthenaStorageModule, "file">;
     input: AthenaStorageFileListInput | null | undefined;
     enabled?: boolean;
     callOptions?: AthenaStorageCallOptions;
     refreshIntervalMs?: number;
 }
 interface UseStorageFilesResult {
-    files: StorageListFilesResponse['files'];
+    files: StorageListFilesResponse["files"];
     count: number;
     loading: boolean;
     error: unknown;
@@ -429,4 +479,4 @@ interface UseStorageFileDeleteResult {
 }
 declare function useStorageFileDelete(options: UseStorageFileDeleteOptions): UseStorageFileDeleteResult;
 
-export { type AthenaCacheMode, type AthenaCachePolicy, AthenaGatewayHookConfig, AthenaGatewayHookResult, type AthenaMutationDefaults, type AthenaMutationEvent, type AthenaMutationRequestLog, type AthenaMutationResultData, type AthenaMutationState, AthenaQueryClient, type AthenaQueryClientConfig, AthenaQueryClientProvider, type AthenaQueryDefaults, type AthenaQueryError, type AthenaQueryEvent, type AthenaQueryRequestLog, type AthenaQueryResult, type AthenaQueryState, type AthenaResponseLike, type AthenaRetryCount, type AthenaRetryDelay, type AthenaRuntimeBaseEvent, type AthenaRuntimeEvent, type AthenaRuntimeEventType, type AthenaStateAdapter, type AthenaUnsubscribe, type QueryKey, type QueryStatus, type UseAthenaReadQueryOptions, type UseAthenaReadQueryResult, type UseAthenaSessionClientOptions, type UseAthenaSessionClientResult, type UseMutationOptions, type UseMutationResult, type UseQueryOptions, type UseQueryResult, type UseSessionAuthClient, type UseSessionOptions, type UseSessionResult, type UseStorageFileDeleteOptions, type UseStorageFileDeleteResult, type UseStorageFilesOptions, type UseStorageFilesResult, type UseStorageUploadInput, type UseStorageUploadOptions, type UseStorageUploadResult, attachStateAdapter, createAthenaQueryClient, useAthenaGateway, useAthenaQueryClient, useAthenaReadQuery, useAthenaSessionClient, useMutation, useQuery, useSession, useStorageFileDelete, useStorageFiles, useStorageUpload };
+export { type AthenaCacheMode, type AthenaCachePolicy, AthenaGatewayHookConfig, AthenaGatewayHookResult, type AthenaMutationDefaults, type AthenaMutationEvent, type AthenaMutationRequestLog, type AthenaMutationResultData, type AthenaMutationState, AthenaQueryClient, type AthenaQueryClientConfig, AthenaQueryClientProvider, type AthenaQueryDefaults, type AthenaQueryError, type AthenaQueryEvent, type AthenaQueryRequestLog, type AthenaQueryResult, type AthenaQueryState, type AthenaResponseLike, type AthenaRetryCount, type AthenaRetryDelay, type AthenaRuntimeBaseEvent, type AthenaRuntimeEvent, type AthenaRuntimeEventType, type AthenaStateAdapter, type AthenaUnsubscribe, type QueryKey, type QueryStatus, type UseAdminPermissionOptions, type UseAdminPermissionResult, type UseAthenaReadQueryOptions, type UseAthenaReadQueryResult, type UseAthenaSessionClientOptions, type UseAthenaSessionClientResult, type UseMutationOptions, type UseMutationResult, type UseQueryOptions, type UseQueryResult, type UseSessionAuthClient, type UseSessionOptions, type UseSessionResult, type UseStorageFileDeleteOptions, type UseStorageFileDeleteResult, type UseStorageFilesOptions, type UseStorageFilesResult, type UseStorageUploadInput, type UseStorageUploadOptions, type UseStorageUploadResult, attachStateAdapter, createAthenaQueryClient, useAdminPermission, useAthenaGateway, useAthenaQueryClient, useAthenaReadQuery, useAthenaSessionClient, useMutation, useQuery, useSession, useStorageFileDelete, useStorageFiles, useStorageUpload };

package/dist/react.d.ts

@@ -1,13 +1,14 @@
-import { u as AthenaGatewayHookConfig, v as AthenaGatewayHookResult } from './types-Bltx6iL6.js';
-export { w as AthenaDeletePayload, x as AthenaFetchPayload, a as AthenaGatewayCallOptions, d as AthenaGatewayErrorCode, e as AthenaGatewayErrorDetails, s as AthenaGatewayResponse, y as AthenaInsertPayload, f as AthenaJsonArray, g as AthenaJsonObject, h as AthenaJsonPrimitive, i as AthenaJsonValue, j as AthenaRpcCallOptions, k as AthenaRpcFilter, l as AthenaRpcFilterOperator, m as AthenaRpcOrder, n as AthenaRpcPayload, z as AthenaUpdatePayload } from './types-Bltx6iL6.js';
-import { a as AthenaReadQueryClient, c as AthenaReadQueryDefinition, e as AthenaReadQueryExecutionResult, i as AthenaReadQueryFlatRow } from './model-form-BbdzJ9Uh.js';
-export { A as AthenaGatewayError, M as ModelFormAdapter, D as ModelFormDefaults, E as ModelFormNullishMode, G as ModelFormValues, T as ToModelFormDefaultsOptions, H as ToModelPayloadOptions, _ as createModelFormAdapter, a3 as isAthenaGatewayError, a6 as toModelFormDefaults, a7 as toModelPayload } from './model-form-BbdzJ9Uh.js';
+import { y as AthenaGatewayHookConfig, z as AthenaGatewayHookResult } from './types-B2RZPivM.js';
+export { v as AthenaDeletePayload, u as AthenaFetchPayload, a as AthenaGatewayCallOptions, d as AthenaGatewayErrorCode, e as AthenaGatewayErrorDetails, s as AthenaGatewayResponse, w as AthenaInsertPayload, f as AthenaJsonArray, g as AthenaJsonObject, h as AthenaJsonPrimitive, i as AthenaJsonValue, j as AthenaRpcCallOptions, k as AthenaRpcFilter, l as AthenaRpcFilterOperator, m as AthenaRpcOrder, n as AthenaRpcPayload, x as AthenaUpdatePayload } from './types-B2RZPivM.js';
+import { a as AthenaReadQueryClient, c as AthenaReadQueryDefinition, e as AthenaReadQueryExecutionResult, i as AthenaReadQueryFlatRow } from './model-form-U8NVtfSA.js';
+export { A as AthenaGatewayError, M as ModelFormAdapter, D as ModelFormDefaults, E as ModelFormNullishMode, G as ModelFormValues, T as ToModelFormDefaultsOptions, H as ToModelPayloadOptions, _ as createModelFormAdapter, a3 as isAthenaGatewayError, a7 as toModelFormDefaults, a8 as toModelPayload } from './model-form-U8NVtfSA.js';
 import * as react from 'react';
 import { ReactNode } from 'react';
-import { aE as AthenaAuthFetchCompatibleInput, E as AthenaAuthCallOptions, ad as AthenaAuthSessionResponse, R as AthenaAuthErrorDetails, aa as AthenaAuthResult } from './types-AOY-GLu8.js';
-export { D as AthenaAuthBindings, aC as AuthBindings } from './types-AOY-GLu8.js';
-import { ax as AthenaRequestContext, b5 as AthenaStorageFileUploadInput, bp as AthenaStorageUploadSource, bb as AthenaStorageModule, bo as AthenaStorageUploadProgressHandler, bn as AthenaStorageUploadProgress, b8 as AthenaStorageFileUploadResult, aP as AthenaStorageCallOptions, b2 as AthenaStorageFileListInput, ck as StorageListFilesResponse, cf as StorageFileMutationResponse } from './v3-client-DZp2NEhK.js';
-import './types-B75PdABb.js';
+import { aE as AthenaAuthFetchCompatibleInput, E as AthenaAuthCallOptions, ad as AthenaAuthSessionResponse, R as AthenaAuthErrorDetails, aa as AthenaAuthResult, aD as AthenaAdminHasPermissionRequest } from './types-BVKpQmfY.js';
+export { D as AthenaAuthBindings, aC as AuthBindings } from './types-BVKpQmfY.js';
+import { AthenaAdminSessionLike, AthenaAdminPermissionCheckInput } from './admin.js';
+import { aA as AthenaRequestContext, b8 as AthenaStorageFileUploadInput, bs as AthenaStorageUploadSource, be as AthenaStorageModule, br as AthenaStorageUploadProgressHandler, bq as AthenaStorageUploadProgress, bb as AthenaStorageFileUploadResult, aS as AthenaStorageCallOptions, b5 as AthenaStorageFileListInput, cn as StorageListFilesResponse, ci as StorageFileMutationResponse } from './v3-client-OAai_JNs.js';
+import './types-S-bTMPiM.js';
 import './module-C_ab-MM1.js';
 
 declare function useAthenaGateway(config?: AthenaGatewayHookConfig): AthenaGatewayHookResult;
@@ -230,9 +231,9 @@ declare function createAthenaQueryClient(config?: AthenaQueryClientConfig): Athe
 declare function attachStateAdapter(client: AthenaQueryClient, adapter: AthenaStateAdapter): AthenaUnsubscribe;
 
 interface AthenaQueryClientProviderProps {
+    children: ReactNode;
     client?: AthenaQueryClient;
     config?: AthenaQueryClientConfig;
-    children: ReactNode;
 }
 declare function AthenaQueryClientProvider(props: AthenaQueryClientProviderProps): react.FunctionComponentElement<react.ProviderProps<AthenaQueryClient | null>>;
 declare function useAthenaQueryClient(): AthenaQueryClient;
@@ -354,6 +355,55 @@ type InferSessionData$1<TClient> = TClient extends {
  */
 declare function useSession<TClient extends UseSessionAuthClient>(authClient: TClient, options?: UseSessionOptions): UseSessionResult<InferSessionData$1<TClient>>;
 
+interface UseAdminPermissionOptions {
+    /**
+     * Permission set checked via `client.auth.admin.hasPermission`.
+     * Defaults to `["admin:read"]`.
+     */
+    permissions?: AthenaAdminHasPermissionRequest['permissions'];
+    permission?: AthenaAdminHasPermissionRequest['permission'];
+    /**
+     * When provided, skips the internal session fetch.
+     * Pass `null` to force a denied result without calling getSession.
+     */
+    session?: AthenaAdminSessionLike | null;
+    allowRoleBypass?: boolean;
+    enabled?: boolean;
+    fetchOptions?: AthenaAdminPermissionCheckInput['fetchOptions'];
+    requestOptions?: AthenaAdminPermissionCheckInput['requestOptions'];
+    /** Forwarded to the internal `useSession` when `session` is omitted. */
+    sessionOptions?: Omit<UseSessionOptions, 'enabled'>;
+}
+interface UseAdminPermissionResult {
+    allowed: boolean;
+    isPending: boolean;
+    error: Error | null;
+    session: AthenaAdminSessionLike | null;
+    refetch: () => Promise<boolean>;
+}
+type AdminPermissionAuthClient = UseSessionAuthClient & {
+    auth?: {
+        admin?: unknown;
+    };
+    admin?: unknown;
+};
+/**
+ * React gate for Athena admin permissions.
+ *
+ * Uses {@link hasAdminPermission} from `@xylex-group/athena/admin` with an
+ * optional local `admin` role short-circuit. When `session` is omitted, loads
+ * the current session through {@link useSession}.
+ *
+ * @example
+ * ```tsx
+ * const athena = createClient({ url, key, auth: { url: "/api/auth" } })
+ * const { allowed, isPending } = useAdminPermission(athena, {
+ *   permissions: ["admin:read"],
+ * })
+ * ```
+ */
+declare function useAdminPermission(client: AdminPermissionAuthClient | null | undefined, options?: UseAdminPermissionOptions): UseAdminPermissionResult;
+
 type SessionGetter<TSessionData extends AthenaAuthSessionResponse> = (input?: AthenaAuthFetchCompatibleInput, options?: AthenaAuthCallOptions) => Promise<AthenaAuthResult<TSessionData>>;
 type AthenaContextScopedClient<TSessionData extends AthenaAuthSessionResponse = AthenaAuthSessionResponse> = {
     auth: {
@@ -400,14 +450,14 @@ interface UseStorageUploadResult {
 declare function useStorageUpload(options: UseStorageUploadOptions): UseStorageUploadResult;
 
 interface UseStorageFilesOptions {
-    storage: Pick<AthenaStorageModule, 'file'>;
+    storage: Pick<AthenaStorageModule, "file">;
     input: AthenaStorageFileListInput | null | undefined;
     enabled?: boolean;
     callOptions?: AthenaStorageCallOptions;
     refreshIntervalMs?: number;
 }
 interface UseStorageFilesResult {
-    files: StorageListFilesResponse['files'];
+    files: StorageListFilesResponse["files"];
     count: number;
     loading: boolean;
     error: unknown;
@@ -429,4 +479,4 @@ interface UseStorageFileDeleteResult {
 }
 declare function useStorageFileDelete(options: UseStorageFileDeleteOptions): UseStorageFileDeleteResult;
 
-export { type AthenaCacheMode, type AthenaCachePolicy, AthenaGatewayHookConfig, AthenaGatewayHookResult, type AthenaMutationDefaults, type AthenaMutationEvent, type AthenaMutationRequestLog, type AthenaMutationResultData, type AthenaMutationState, AthenaQueryClient, type AthenaQueryClientConfig, AthenaQueryClientProvider, type AthenaQueryDefaults, type AthenaQueryError, type AthenaQueryEvent, type AthenaQueryRequestLog, type AthenaQueryResult, type AthenaQueryState, type AthenaResponseLike, type AthenaRetryCount, type AthenaRetryDelay, type AthenaRuntimeBaseEvent, type AthenaRuntimeEvent, type AthenaRuntimeEventType, type AthenaStateAdapter, type AthenaUnsubscribe, type QueryKey, type QueryStatus, type UseAthenaReadQueryOptions, type UseAthenaReadQueryResult, type UseAthenaSessionClientOptions, type UseAthenaSessionClientResult, type UseMutationOptions, type UseMutationResult, type UseQueryOptions, type UseQueryResult, type UseSessionAuthClient, type UseSessionOptions, type UseSessionResult, type UseStorageFileDeleteOptions, type UseStorageFileDeleteResult, type UseStorageFilesOptions, type UseStorageFilesResult, type UseStorageUploadInput, type UseStorageUploadOptions, type UseStorageUploadResult, attachStateAdapter, createAthenaQueryClient, useAthenaGateway, useAthenaQueryClient, useAthenaReadQuery, useAthenaSessionClient, useMutation, useQuery, useSession, useStorageFileDelete, useStorageFiles, useStorageUpload };
+export { type AthenaCacheMode, type AthenaCachePolicy, AthenaGatewayHookConfig, AthenaGatewayHookResult, type AthenaMutationDefaults, type AthenaMutationEvent, type AthenaMutationRequestLog, type AthenaMutationResultData, type AthenaMutationState, AthenaQueryClient, type AthenaQueryClientConfig, AthenaQueryClientProvider, type AthenaQueryDefaults, type AthenaQueryError, type AthenaQueryEvent, type AthenaQueryRequestLog, type AthenaQueryResult, type AthenaQueryState, type AthenaResponseLike, type AthenaRetryCount, type AthenaRetryDelay, type AthenaRuntimeBaseEvent, type AthenaRuntimeEvent, type AthenaRuntimeEventType, type AthenaStateAdapter, type AthenaUnsubscribe, type QueryKey, type QueryStatus, type UseAdminPermissionOptions, type UseAdminPermissionResult, type UseAthenaReadQueryOptions, type UseAthenaReadQueryResult, type UseAthenaSessionClientOptions, type UseAthenaSessionClientResult, type UseMutationOptions, type UseMutationResult, type UseQueryOptions, type UseQueryResult, type UseSessionAuthClient, type UseSessionOptions, type UseSessionResult, type UseStorageFileDeleteOptions, type UseStorageFileDeleteResult, type UseStorageFilesOptions, type UseStorageFilesResult, type UseStorageUploadInput, type UseStorageUploadOptions, type UseStorageUploadResult, attachStateAdapter, createAthenaQueryClient, useAdminPermission, useAthenaGateway, useAthenaQueryClient, useAthenaReadQuery, useAthenaSessionClient, useMutation, useQuery, useSession, useStorageFileDelete, useStorageFiles, useStorageUpload };