@keboola/api-client-react 27.0.0 → 32.0.0

package/dist/index.d.cts

@@ -1,177 +1,188 @@
-import * as _keboola_api_client_storage_types from '@keboola/api-client/storage/types';
-import * as _keboola_api_client from '@keboola/api-client';
-import { KeboolaApi, BearerSession, LegacySession } from '@keboola/api-client';
-import * as react_jsx_runtime from 'react/jsx-runtime';
-import { ReactNode } from 'react';
-
+import { BearerSession, KeboolaApi, LegacySession } from "@keboola/api-client";
+import { ReactNode } from "react";
+//#region src/context.d.ts
 declare const useApiClient: () => KeboolaApi;
 declare const useProject: () => {
-    hasFeature: (...feature: string[]) => boolean;
-    hasAdminFeature: (...feature: string[]) => boolean;
-    hasBackend: (backend: _keboola_api_client_storage_types.Backend) => boolean;
-    sapiToken: _keboola_api_client_storage_types.StorageToken;
+  hasFeature: (...feature: string[]) => boolean;
+  hasAdminFeature: (...feature: string[]) => boolean;
+  hasBackend: (backend: import("@keboola/api-client/constants").Backend) => boolean;
+  sapiToken: import("@keboola/api-client/storage/types").StorageToken;
 };
 declare const useStack: () => {
-    services: _keboola_api_client_storage_types.Service[];
-    features: string[];
-    components: _keboola_api_client_storage_types.StackComponent[];
-    hasFeature: (...feature: string[]) => boolean;
-    getServiceUrl: (serviceId: _keboola_api_client_storage_types.ServiceId) => string | null;
-    hasService: (serviceId: _keboola_api_client_storage_types.ServiceId) => boolean;
-    getComponent: (componentId: string) => _keboola_api_client_storage_types.StackComponent | null;
-    hasComponent: (...componentId: string[]) => boolean;
-    api: string;
-    documentation: string;
-    host: string;
-    revision: string;
-    stack: string;
-    urlTemplates: {
-        orchestrationJob: string;
-    };
-    version: string;
+  api: string;
+  documentation: string;
+  host: string;
+  revision: string;
+  stack: string;
+  urlTemplates: {
+    orchestrationJob: string;
+  };
+  version: string;
+  services: import("@keboola/api-client/storage/types").Service[];
+  features: string[];
+  components: import("@keboola/api-client/storage/types").StackComponent[];
+  hasFeature: (...feature: string[]) => boolean;
+  getServiceUrl: (serviceId: import("@keboola/api-client/constants").ServiceId) => string | null;
+  hasService: (serviceId: import("@keboola/api-client/constants").ServiceId) => boolean;
+  getComponent: (componentId: string) => import("@keboola/api-client/storage/types").StackComponent | null;
+  hasComponent: (...componentId: string[]) => boolean;
 };
 /** The bearer (OAuth) lifecycle session. Throws outside `<AuthProvider />`. */
 declare const useAuth: () => {
-    hasPersistedValue: () => boolean;
-    setBaseUrl: (baseUrl: string) => void;
-    isStorageReady: () => boolean;
-    authenticate: (tokens: {
+  hasPersistedValue: () => boolean;
+  setBaseUrl: (baseUrl: string) => void;
+  isStorageReady: () => boolean;
+  authenticate: (tokens: {
+    accessToken: string;
+    refreshToken: string;
+    expiresIn: number;
+  }) => void;
+  setProject: (projectId: number) => void;
+  setProjectAsync: (projectId: number) => Promise<void>;
+  clearProject: () => void;
+  reset: () => void;
+  debugForceRefresh: () => void;
+  getAuthHeaders: () => Promise<Record<string, string>>;
+  restore: () => Promise<{
+    status: 'empty' | 'restored' | 'expired';
+  }>;
+  subscribe: (listener: (snapshot: {
+    type: 'Bearer';
+    config: {
+      status: 'anonymous';
+      baseUrl: string | null;
+    } | {
+      status: 'authenticated';
+      baseUrl: string;
+      credential: {
+        accessToken: string;
+        refreshToken: string;
+        expiresIn: number;
+      } & {
+        issuedAt: number;
+      };
+    } | {
+      status: 'scoped';
+      baseUrl: string;
+      credential: {
+        accessToken: string;
+        refreshToken: string;
+        expiresIn: number;
+      } & {
+        issuedAt: number;
+      };
+      projectId: number;
+    };
+    authReady: boolean;
+    managementReady: boolean;
+    storage: import("@keboola/api-client").AsyncState<unknown>['state'];
+  }) => void) => () => void;
+  debug: () => {
+    type: 'Bearer';
+    config: {
+      status: 'anonymous';
+      baseUrl: string | null;
+    } | {
+      status: 'authenticated';
+      baseUrl: string;
+      credential: {
+        accessToken: string;
+        refreshToken: string;
+        expiresIn: number;
+      } & {
+        issuedAt: number;
+      };
+    } | {
+      status: 'scoped';
+      baseUrl: string;
+      credential: {
         accessToken: string;
         refreshToken: string;
         expiresIn: number;
-    }) => void;
-    setProject: (projectId: number) => void;
-    setProjectAsync: (projectId: number) => Promise<void>;
-    clearProject: () => void;
-    reset: () => void;
-    debugForceRefresh: () => void;
-    restore: () => Promise<{
-        status: "empty" | "restored" | "expired";
-    }>;
-    subscribe: (listener: (snapshot: {
-        type: "Bearer";
-        config: {
-            status: "anonymous";
-            baseUrl: string | null;
-        } | {
-            status: "authenticated";
-            baseUrl: string;
-            credential: {
-                accessToken: string;
-                refreshToken: string;
-                expiresIn: number;
-            } & {
-                issuedAt: number;
-            };
-        } | {
-            status: "scoped";
-            baseUrl: string;
-            credential: {
-                accessToken: string;
-                refreshToken: string;
-                expiresIn: number;
-            } & {
-                issuedAt: number;
-            };
-            projectId: number;
-        };
-        authReady: boolean;
-        managementReady: boolean;
-        storage: _keboola_api_client.AsyncState<unknown>["state"];
-    }) => void) => () => void;
-    debug: () => {
-        type: "Bearer";
-        config: {
-            status: "anonymous";
-            baseUrl: string | null;
-        } | {
-            status: "authenticated";
-            baseUrl: string;
-            credential: {
-                accessToken: string;
-                refreshToken: string;
-                expiresIn: number;
-            } & {
-                issuedAt: number;
-            };
-        } | {
-            status: "scoped";
-            baseUrl: string;
-            credential: {
-                accessToken: string;
-                refreshToken: string;
-                expiresIn: number;
-            } & {
-                issuedAt: number;
-            };
-            projectId: number;
-        };
-        authReady: boolean;
-        managementReady: boolean;
-        storage: _keboola_api_client.AsyncState<unknown>["state"];
+      } & {
+        issuedAt: number;
+      };
+      projectId: number;
     };
+    authReady: boolean;
+    managementReady: boolean;
+    storage: import("@keboola/api-client").AsyncState<unknown>['state'];
+  };
 };
 /** The legacy (SAPI) lifecycle session. Throws outside `<LegacyAuthProvider />`. */
 declare const useLegacyAuth: () => {
-    setBaseUrl: (baseUrl: string) => void;
-    isStorageReady: () => boolean;
-    authenticateStorage: (sapiToken: string) => void;
-    authenticateStorageAsync: (sapiToken: string) => Promise<void>;
-    authenticateManagement: (managementToken: string) => void;
-    subscribe: (listener: (snapshot: {
-        type: "Sapi";
-        config: {
-            baseUrl: string | null;
-            sapiToken: string | null;
-            managementToken: string | null;
-        };
-        authReady: boolean;
-        managementReady: boolean;
-        storage: _keboola_api_client.AsyncState<unknown>["state"];
-    }) => void) => () => void;
-    debug: () => {
-        type: "Sapi";
-        config: {
-            baseUrl: string | null;
-            sapiToken: string | null;
-            managementToken: string | null;
-        };
-        authReady: boolean;
-        managementReady: boolean;
-        storage: _keboola_api_client.AsyncState<unknown>["state"];
+  setBaseUrl: (baseUrl: string) => void;
+  isStorageReady: () => boolean;
+  authenticateStorage: (sapiToken: string) => void;
+  authenticateStorageAsync: (sapiToken: string) => Promise<void>;
+  authenticateManagement: (managementToken: string) => void;
+  subscribe: (listener: (snapshot: {
+    type: 'Sapi';
+    config: {
+      baseUrl: string | null;
+      sapiToken: string | null;
+      managementToken: string | null;
+    };
+    authReady: boolean;
+    managementReady: boolean;
+    storage: import("@keboola/api-client").AsyncState<unknown>['state'];
+  }) => void) => () => void;
+  debug: () => {
+    type: 'Sapi';
+    config: {
+      baseUrl: string | null;
+      sapiToken: string | null;
+      managementToken: string | null;
     };
+    authReady: boolean;
+    managementReady: boolean;
+    storage: import("@keboola/api-client").AsyncState<unknown>['state'];
+  };
 };
-
+//#endregion
+//#region src/ApiClientProvider.d.ts
 type Props$2 = {
-    /** The flow-agnostic product API — the `api` half of a keboola client. */
-    api: KeboolaApi;
-    children: ReactNode;
+  /** The flow-agnostic product API — the `api` half of a keboola client. */
+  api: KeboolaApi;
+  children: ReactNode;
 };
 /**
  * Provides the product API to `useApiClient()`. A pure pass-through: the auth lifecycle (driving
  * to ready, gating on a fallback) belongs to `AuthProvider` / `LegacyAuthProvider`, which mount
  * this provider once their session is ready.
  */
-declare const ApiClientProvider: ({ api, children }: Props$2) => react_jsx_runtime.JSX.Element;
-
+declare const ApiClientProvider: ({ api, children }: Props$2) => import("react/jsx-runtime").JSX.Element;
+//#endregion
+//#region src/AuthProvider.d.ts
 type BearerCredential = Parameters<BearerSession['authenticate']>[0];
+type RestoreResult = Awaited<ReturnType<BearerSession['restore']>>;
 /** The session state guaranteed to exist once the storage build is ready. */
 type ScopedState = {
-    projectId: number;
-    baseUrl: string;
+  projectId: number;
+  baseUrl: string;
 };
 type BaseProps = {
-    session: BearerSession;
-    onAccessTokenChange?: (accessToken: string) => void;
-    /** Rendered while a persisted session is being restored, or the bootstrap is in flight. */
-    loadingFallback?: ReactNode;
-    /** Rendered when the storage build fails. */
-    errorFallback?: ReactNode;
-    /**
-     * Rendered only once the session is scoped and the storage build is ready. Pass a function to
-     * receive the scoped state (the project the session settled on) without re-narrowing it yourself.
-     */
-    children: ReactNode | ((scoped: ScopedState) => ReactNode);
+  session: BearerSession;
+  onAccessTokenChange?: (accessToken: string) => void;
+  /**
+   * Fires once with the outcome of the boot `restore()`.
+   *
+   * - `empty`, `restored` and `expired` are three different things to say to a user, and the slot
+   *   that renders cannot tell them apart: `expired` and `empty` both land in `anonymousFallback`,
+   *   and so does a `restored` session that carried no project.
+   * - A `restore()` that throws (offline, a 5xx) reports `empty` — the same value the provider acts
+   *   on — so a caller never reads a transport failure as an expiry.
+   */
+  onRestore?: (result: RestoreResult) => void;
+  /** Rendered while a persisted session is being restored, or the bootstrap is in flight. */
+  loadingFallback?: ReactNode;
+  /** Rendered when the storage build fails. */
+  errorFallback?: ReactNode;
+  /**
+   * Rendered only once the session is scoped and the storage build is ready. Pass a function to
+   * receive the scoped state (the project the session settled on) without re-narrowing it yourself.
+   */
+  children: ReactNode | ((scoped: ScopedState) => ReactNode);
 };
 /**
  * Two mutually exclusive bootstrap modes, discriminated by whether a credential is supplied:
@@ -182,31 +193,32 @@ type BaseProps = {
  *   here (a missing login UI would leave the app on a permanently blank screen).
  */
 type Props$1 = BaseProps & ({
-    credential: BearerCredential;
-    projectId: number;
-    baseUrl: string;
-    anonymousFallback?: never;
+  credential: BearerCredential;
+  projectId: number;
+  baseUrl: string;
+  anonymousFallback?: never;
 } | {
-    credential?: undefined;
-    projectId?: undefined;
-    baseUrl?: never;
-    anonymousFallback: ReactNode;
+  credential?: undefined;
+  projectId?: undefined;
+  baseUrl?: never;
+  anonymousFallback: ReactNode;
 });
-declare const AuthProvider: ({ session, baseUrl, credential, projectId, onAccessTokenChange, loadingFallback, errorFallback, anonymousFallback, children, }: Props$1) => react_jsx_runtime.JSX.Element;
-
+declare const AuthProvider: ({ session, baseUrl, credential, projectId, onAccessTokenChange, onRestore, loadingFallback, errorFallback, anonymousFallback, children }: Props$1) => import("react/jsx-runtime").JSX.Element;
+//#endregion
+//#region src/LegacyAuthProvider.d.ts
 type Props = {
-    session: LegacySession;
-    /** Stack base URL. */
-    baseUrl: string;
-    /** SAPI token — drives the storage build to ready. */
-    storageToken: string;
-    /** Optional manage-api token — unlocks `api.management`. */
-    managementToken?: string;
-    /** Rendered until the storage build reaches ready. */
-    fallback?: ReactNode;
-    /** Rendered when the storage build fails — e.g. the SAPI token is expired or revoked. */
-    errorFallback?: ReactNode;
-    children: ReactNode;
+  session: LegacySession;
+  /** Stack base URL. */
+  baseUrl: string;
+  /** SAPI token — drives the storage build to ready. */
+  storageToken: string;
+  /** Optional manage-api token — unlocks `api.management`. */
+  managementToken?: string;
+  /** Rendered until the storage build reaches ready. */
+  fallback?: ReactNode;
+  /** Rendered when the storage build fails — e.g. the SAPI token is expired or revoked. */
+  errorFallback?: ReactNode;
+  children: ReactNode;
 };
 /**
  * Owns the legacy (SAPI) lifecycle: on mount it configures the stack and drives the session to
@@ -214,6 +226,7 @@ type Props = {
  * known up front, so this drives itself (unlike the interactive bearer `AuthProvider`). Exposes the
  * session via `useLegacyAuth()` and gates `children` behind readiness.
  */
-declare const LegacyAuthProvider: ({ session, baseUrl, storageToken, managementToken, fallback, errorFallback, children, }: Props) => react_jsx_runtime.JSX.Element;
-
+declare const LegacyAuthProvider: ({ session, baseUrl, storageToken, managementToken, fallback, errorFallback, children }: Props) => import("react/jsx-runtime").JSX.Element;
+//#endregion
 export { ApiClientProvider, AuthProvider, LegacyAuthProvider, useApiClient, useAuth, useLegacyAuth, useProject, useStack };
+//# sourceMappingURL=index.d.cts.map