@epam/ai-dial-chat-hooks 1.3.0-dev.5 → 1.3.0-dev.55

package/oauth/useToolsetLogin/useToolsetLogin.d.ts

@@ -0,0 +1,79 @@
+import { DialToolsetDto, ToolsetLoginBodyDto, ToolsetLogoutBodyDto } from '@epam/ai-dial-chat-api-client';
+import { ToolsetOAuthSettings } from '../models';
+import { ToolsetAuthTypes, ToolsetCredentialsLevel } from '../types';
+/** Terminal outcome kinds `login` can resolve. */
+export declare enum ToolsetLoginOutcomeType {
+    Success = "success",
+    Failure = "failure",
+    PopupBlocked = "popup-blocked",
+    Cancelled = "cancelled"
+}
+/** Discriminated outcome of one login attempt. */
+export interface ToolsetLoginOutcome {
+    /** Which terminal branch the attempt resolved through. */
+    type: ToolsetLoginOutcomeType;
+}
+/** Arguments for one `login` call. */
+export interface ToolsetLoginParams {
+    /** Already-encoded toolset id/url, as returned by `listToolsets`/`getToolset`. */
+    toolsetId: string;
+    /** Credentials level the submitted credentials apply to. */
+    credentialsLevel: ToolsetCredentialsLevel;
+    /** Authentication mechanism the toolset requires. */
+    authenticationType: ToolsetAuthTypes;
+    /** Required for `ToolsetAuthTypes.ApiKey`. */
+    apiKey?: string;
+    /** Required for `ToolsetAuthTypes.OAuth`. */
+    oauthSettings?: ToolsetOAuthSettings;
+    /**
+     * Whether the target level's cached status is currently `FAILED` — API key
+     * logins log that level out first when true. Ignored when `forceStale` is
+     * set, and never consulted for OAuth (OAuth does not log out before
+     * retrying).
+     */
+    isCurrentlyFailed?: boolean;
+    /**
+     * Always logs out the target level first (for both API key and OAuth)
+     * regardless of the cached status — set by callers reacting to a
+     * DIAL-Core-pushed `toolset/signin` event, which is proof the cached
+     * status may be stale even when it still reads `SIGNED_IN`.
+     */
+    forceStale?: boolean;
+    /**
+     * Whether the user agreed an application may use this credential while they
+     * are away. DIAL Core gates every on-behalf-of mint on it, so a toolset
+     * signed in without it works interactively and still fails with
+     * `consent-required` in the background. Absent means not granted.
+     */
+    offlineUsageConsent?: boolean;
+}
+/** Parameters for {@link useToolsetLogin}. */
+export interface UseToolsetLoginParams {
+    /**
+     * The host's OAuth callback route. Resolved against `window.location.origin`
+     * for the `redirect_uri`, and compared against the popup's pathname when
+     * reading a completion marker out of its URL.
+     */
+    callbackPath: string;
+    /** Submits credentials for one toolset at one credentials level. */
+    loginToolset: (toolsetId: string, body: ToolsetLoginBodyDto) => Promise<unknown>;
+    /** Clears stored credentials for one toolset at one credentials level. */
+    logoutToolset: (toolsetId: string, body: ToolsetLogoutBodyDto) => Promise<unknown>;
+    /** Re-reads a toolset so a reported cancellation can be checked against the backend. */
+    getToolset: (toolsetId: string) => Promise<DialToolsetDto>;
+}
+/** Result returned by {@link useToolsetLogin}. */
+export interface UseToolsetLoginResult {
+    /** Runs one API-key or OAuth login attempt and resolves its outcome. */
+    login: (params: ToolsetLoginParams) => Promise<ToolsetLoginOutcome>;
+}
+/**
+ * Shared toolset API-key/OAuth login orchestration, so no two surfaces fork
+ * the popup/`BroadcastChannel` handshake or the stale-credential-clearing
+ * rule. Every backend call arrives as an injected callback: the hook
+ * constructs no client instance and reads no app context. It resolves an
+ * outcome and shows nothing itself — mapping an outcome to notifications is
+ * the caller's job.
+ */
+export declare const useToolsetLogin: ({ callbackPath, loginToolset, logoutToolset, getToolset, }: UseToolsetLoginParams) => UseToolsetLoginResult;
+//# sourceMappingURL=useToolsetLogin.d.ts.map

package/oauth/useToolsetLogin/useToolsetLogin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useToolsetLogin.d.ts","sourceRoot":"","sources":["../../../src/oauth/useToolsetLogin/useToolsetLogin.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,cAAc,EACd,mBAAmB,EACnB,oBAAoB,EACrB,MAAM,+BAA+B,CAAC;AAIvC,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,WAAW,CAAC;AAOtD,OAAO,EAGL,gBAAgB,EAChB,uBAAuB,EAGxB,MAAM,UAAU,CAAC;AAElB,kDAAkD;AAClD,oBAAY,uBAAuB;IACjC,OAAO,YAAY;IACnB,OAAO,YAAY;IACnB,YAAY,kBAAkB;IAC9B,SAAS,cAAc;CACxB;AAED,kDAAkD;AAClD,MAAM,WAAW,mBAAmB;IAClC,0DAA0D;IAC1D,IAAI,EAAE,uBAAuB,CAAC;CAC/B;AAED,sCAAsC;AACtC,MAAM,WAAW,kBAAkB;IACjC,kFAAkF;IAClF,SAAS,EAAE,MAAM,CAAC;IAClB,4DAA4D;IAC5D,gBAAgB,EAAE,uBAAuB,CAAC;IAC1C,qDAAqD;IACrD,kBAAkB,EAAE,gBAAgB,CAAC;IACrC,8CAA8C;IAC9C,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,6CAA6C;IAC7C,aAAa,CAAC,EAAE,oBAAoB,CAAC;IACrC;;;;;OAKG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B;;;;;OAKG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B;AAED,8CAA8C;AAC9C,MAAM,WAAW,qBAAqB;IACpC;;;;OAIG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB,oEAAoE;IACpE,YAAY,EAAE,CACZ,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,mBAAmB,KACtB,OAAO,CAAC,OAAO,CAAC,CAAC;IACtB,0EAA0E;IAC1E,aAAa,EAAE,CACb,SAAS,EAAE,MAAM,EACjB,IAAI,EAAE,oBAAoB,KACvB,OAAO,CAAC,OAAO,CAAC,CAAC;IACtB,wFAAwF;IACxF,UAAU,EAAE,CAAC,SAAS,EAAE,MAAM,KAAK,OAAO,CAAC,cAAc,CAAC,CAAC;CAC5D;AAED,kDAAkD;AAClD,MAAM,WAAW,qBAAqB;IACpC,wEAAwE;IACxE,KAAK,EAAE,CAAC,MAAM,EAAE,kBAAkB,KAAK,OAAO,CAAC,mBAAmB,CAAC,CAAC;CACrE;AAED;;;;;;;GAOG;AACH,eAAO,MAAM,eAAe,GAAI,4DAK7B,qBAAqB,KAAG,qBAqL1B,CAAC"}

package/oauth.d.ts

@@ -1,472 +1,2 @@
-import { DialToolsetAuthSettingsDto } from '@epam/ai-dial-chat-api-client';
-import { DialToolsetDto } from '@epam/ai-dial-chat-api-client';
-import { ToolsetLoginBodyDto } from '@epam/ai-dial-chat-api-client';
-import { ToolsetLogoutBodyDto } from '@epam/ai-dial-chat-api-client';
-
-/**
- * Builds the OAuth authorize URL for a given, already-generated `state`
- * value. The caller owns what `state` carries — see `initiateOAuthLogin`.
- * Returns `null` rather than throwing for a configuration that cannot
- * produce a valid URL, including one whose authorization endpoint is not an
- * `http:`/`https:` URL.
- */
-export declare const buildToolsetAuthorizeUrl: (auth: ToolsetOAuthSettings, redirectUri: string, state: string) => string | null;
-
-/**
- * Inverse of `encodeToolsetId` — decodes each `/`-separated segment back to
- * its raw, human-readable form. A segment that isn't valid percent-encoding
- * is passed through unchanged rather than throwing, since this decodes
- * externally-sourced ids (broadcast toolset-login events).
- */
-export declare const decodeToolsetId: (id: string) => string;
-
-/**
- * Broadcasts a successful toolset login to any listener within the current
- * window — host-to-host, not `postMessage`, since this notifies other React
- * trees in the same document (e.g. a mounted `AppEditorIframe`), not an
- * embedded cross-origin iframe.
- */
-export declare const emitToolsetLoginSuccess: <T>(detail: ToolsetLoginSuccessDetail<T>) => void;
-
-/**
- * Percent-encodes each `/`-separated segment of a toolset id so it satisfies
- * the backend's `DEPLOYMENT_ID_PATTERN`/`TOOLSET_URL_PATTERN` (spaces and
- * other reserved characters must already be percent-encoded — e.g. `%20`,
- * not a real space — before this value is used against the toolsets API;
- * `/` stays a literal path separator). Externally-sourced ids — the raw,
- * human-readable id an embedded iframe sends over `postMessage`
- * (e.g. `toolsets/<bucket>/My Toolset__1.0`) — arrive unencoded, unlike the
- * already-encoded `id`/`toolset` field `listToolsets()`/`DialToolsetDto`
- * returns. Mirrors `encodeDeploymentId` (`deployment-id.ts`), which exists
- * for the identical reason on the applications side.
- */
-export declare const encodeToolsetId: (id: string) => string;
-
-/** Name of the same-origin `BroadcastChannel` shared by an OAuth flow's opener and its callback popup. */
-export declare const getToolsetOAuthChannelName: (flowId: string) => string;
-
-/**
- * Resolves the OAuth callback location against the current origin. The
- * callback path is supplied by the host: this module owns no application
- * route.
- */
-export declare const getToolsetRedirectUri: (callbackPath: string) => string;
-
-/**
- * Builds the OAuth authorize URL, opens a same-origin popup synchronously (so
- * a blocked popup can be reliably detected), writes the redirect state into
- * *that popup's own* `sessionStorage` while it is still same-origin
- * `about:blank`, then navigates it to the provider's authorization page.
- * `auth` must already be known synchronously here, so the config is validated
- * *before* opening the popup — unlike `navigateToolsetOAuthPopup`, used when
- * the auth config can only be fetched asynchronously after the popup is
- * already open.
- */
-export declare const initiateOAuthLogin: (auth: ToolsetOAuthSettings, toolsetId: string, callbackPath: string, credentialsLevel?: ToolsetCredentialsLevel, offlineUsageConsent?: boolean) => ToolsetOAuthInitiationResult;
-
-/** Whether a toolset id belongs to the `public` bucket (shared with all users), mirroring the legacy `isEntityIdPublic` check. */
-export declare const isPublicToolsetId: (toolsetId: string) => boolean;
-
-/**
- * Builds the OAuth authorize URL for an already-open popup and navigates it,
- * closing the popup and returning `InvalidConfig` if the auth config can't
- * produce a valid authorize URL. `callbackPath` is the host's own callback
- * route — this module owns no application route.
- */
-export declare const navigateToolsetOAuthPopup: (popup: Window, auth: ToolsetOAuthSettings, toolsetId: string, callbackPath: string, credentialsLevel?: ToolsetCredentialsLevel, resourceKind?: OAuthResourceKind, offlineUsageConsent?: boolean) => ToolsetOAuthInitiationResult;
-
-/**
- * Encodes a toolset id to its single-encoded form regardless of whether the
- * value received it in was already percent-encoded or the raw,
- * human-readable form — decoding first then re-encoding once is idempotent
- * either way, since `decodeToolsetId` on a raw (unencoded) id is a no-op.
- * Use this instead of `encodeToolsetId` at a boundary that cannot guarantee
- * which form it receives, such as a `postMessage` payload from an embedded
- * iframe: calling `encodeToolsetId` directly on a value the sender already
- * encoded escapes the existing `%` characters a second time (`%20` becomes
- * `%2520`), which the backend only ever undoes once and so 404s on.
- */
-export declare const normalizeToolsetId: (toolsetId: string) => string;
-
-/** Arguments handed to the host's exchange callback. */
-export declare interface OAuthExchangeParams {
-    /** One-time authorization code the provider returned. */
-    code: string;
-    /** Redirect URI the code was issued against, to be echoed back to the backend. */
-    redirectUri: string;
-    /** Credentials level resolved from the stored redirect state. */
-    credentialsLevel: ToolsetCredentialsLevel;
-    /** The full redirect state the flow stored before navigating to the provider. */
-    redirectState: ToolsetRedirectState;
-}
-
-/**
- * Which kind of resource an OAuth flow is authenticating. Three kinds share
- * the same popup/`BroadcastChannel` machinery, which is why this module is
- * named for the concern rather than for toolsets.
- */
-export declare enum OAuthResourceKind {
-    Toolset = "toolset",
-    ExternalService = "external-service",
-    /**
-     * Proactive Scheduled Tasks offline-credentials consent. Unlike
-     * `Toolset`/`ExternalService`, this kind has no natural per-resource id —
-     * the shared `ToolsetRedirectState.toolsetId` slot is repurposed as a
-     * fixed sentinel correlation id (`'offline-credentials'`) purely for the
-     * popup/`BroadcastChannel` handshake, never as a real toolset/
-     * external-service id.
-     */
-    OfflineCredentials = "offline-credentials"
-}
-
-/**
- * Opens a same-origin, blank popup synchronously — call this as the very
- * first thing in a click (or click-derived) handler so the browser still
- * treats it as user-triggered, before doing any `await`. A caller that needs
- * to fetch the OAuth config first (it isn't known synchronously) opens the
- * popup with this, then calls `navigateToolsetOAuthPopup` once the config has
- * been fetched.
- */
-export declare const openToolsetOAuthPopup: () => Window | null;
-
-/**
- * Resolves which credentials level a toolset's login applies to, per DIAL
- * Core's public/private toolset convention: a `public`-bucket toolset is
- * shared credentials-wise at `User` level, while a private/workspace toolset
- * is scoped at `Global` level. Every surface that drives a toolset login
- * (the sign-in-interrupt dialog, the QuickApps editor iframe bridge,
- * `useToolsetLogin`) must resolve the level this way rather than assuming one.
- */
-export declare const resolveToolsetCredentialsLevel: (toolsetId: string) => ToolsetCredentialsLevel.User | ToolsetCredentialsLevel.Global;
-
-/**
- * Picks the auth-status field matching one credentials level out of a
- * toolset's `authSettings` — DIAL Core reports `userLevelAuthStatus` and
- * `globalAuthStatus` as independent fields rather than one status keyed by
- * level.
- */
-export declare const selectToolsetAuthStatus: (authSettings: Pick<DialToolsetAuthSettingsDto, "userLevelAuthStatus" | "globalAuthStatus"> | undefined, credentialsLevel: ToolsetCredentialsLevel) => string | undefined;
-
-export declare const subscribeToolsetLoginSuccess: <T>(listener: (detail: ToolsetLoginSuccessDetail<T>) => void) => (() => void);
-
-/** `sessionStorage` key the flow writes its `ToolsetRedirectState` under, in the popup it opens. */
-export declare const TOOLSET_REDIRECT_STATE_KEY = "toolset-redirect-state";
-
-/** Sign-in state DIAL Core reports for one credentials level of a toolset. */
-export declare enum ToolsetAuthStatus {
-    SignedIn = "SIGNED_IN",
-    SignedOut = "SIGNED_OUT",
-    Failed = "FAILED"
-}
-
-/**
- * Enums and constants shared by the OAuth authorization-code popup flow and
- * every host that drives it. These declarations live here (rather than being
- * copied per host) because TypeScript string enums are nominal: a
- * structurally identical host-side copy would not type-check against a lib
- * signature that names the enum.
- */
-/** Authentication mechanism a toolset requires. */
-export declare enum ToolsetAuthTypes {
-    None = "NONE",
-    ApiKey = "API_KEY",
-    OAuth = "OAUTH"
-}
-
-/** Scope the credentials submitted by a login apply to. */
-export declare enum ToolsetCredentialsLevel {
-    Global = "GLOBAL",
-    User = "USER",
-    App = "APP"
-}
-
-/** Discriminated outcome of one login attempt. */
-export declare interface ToolsetLoginOutcome {
-    /** Which terminal branch the attempt resolved through. */
-    type: ToolsetLoginOutcomeType;
-}
-
-/** Terminal outcome kinds `login` can resolve. */
-export declare enum ToolsetLoginOutcomeType {
-    Success = "success",
-    Failure = "failure",
-    PopupBlocked = "popup-blocked",
-    Cancelled = "cancelled"
-}
-
-/** Arguments for one `login` call. */
-export declare interface ToolsetLoginParams {
-    /** Already-encoded toolset id/url, as returned by `listToolsets`/`getToolset`. */
-    toolsetId: string;
-    /** Credentials level the submitted credentials apply to. */
-    credentialsLevel: ToolsetCredentialsLevel;
-    /** Authentication mechanism the toolset requires. */
-    authenticationType: ToolsetAuthTypes;
-    /** Required for `ToolsetAuthTypes.ApiKey`. */
-    apiKey?: string;
-    /** Required for `ToolsetAuthTypes.OAuth`. */
-    oauthSettings?: ToolsetOAuthSettings;
-    /**
-     * Whether the target level's cached status is currently `FAILED` — API key
-     * logins log that level out first when true. Ignored when `forceStale` is
-     * set, and never consulted for OAuth (OAuth does not log out before
-     * retrying).
-     */
-    isCurrentlyFailed?: boolean;
-    /**
-     * Always logs out the target level first (for both API key and OAuth)
-     * regardless of the cached status — set by callers reacting to a
-     * DIAL-Core-pushed `toolset/signin` event, which is proof the cached
-     * status may be stale even when it still reads `SIGNED_IN`.
-     */
-    forceStale?: boolean;
-    /**
-     * Whether the user agreed an application may use this credential while they
-     * are away. DIAL Core gates every on-behalf-of mint on it, so a toolset
-     * signed in without it works interactively and still fails with
-     * `consent-required` in the background. Absent means not granted.
-     */
-    offlineUsageConsent?: boolean;
-}
-
-/** Detail payload for a successful toolset login, generic over the app's own credentials-level type. */
-export declare interface ToolsetLoginSuccessDetail<T> {
-    /** Already-encoded toolset id/url, as passed into `useToolsetLogin`'s `login`. */
-    toolsetId: string;
-    credentialsLevel: T;
-}
-
-/** Query parameters written into the callback popup URL after an OAuth flow completes. */
-export declare enum ToolsetOAuthCallbackQuery {
-    Result = "toolsetOAuthResult",
-    FailureReason = "toolsetOAuthFailureReason"
-}
-
-/** Control messages exchanged over a flow-scoped OAuth channel. */
-export declare enum ToolsetOAuthChannelControlType {
-    ResultAcknowledged = "result-acknowledged"
-}
-
-/**
- * Non-secret result reported by the OAuth callback popup for one flow. Used
- * unchanged by every resource kind — the callback branch only needs to signal
- * success/failure, not resource details, back through the channel.
- */
-export declare type ToolsetOAuthChannelMessage = ToolsetOAuthSuccessMessage | ToolsetOAuthFailureMessage;
-
-export declare interface ToolsetOAuthFailureMessage {
-    type: ToolsetOAuthResultType.Failure;
-    reason: ToolsetOAuthFailureReason;
-}
-
-/** Reason codes the callback popup can report for a failed OAuth login. */
-export declare enum ToolsetOAuthFailureReason {
-    MissingCode = "missing-code",
-    MissingRedirectState = "missing-redirect-state",
-    StateMismatch = "state-mismatch",
-    LoginRequestFailed = "login-request-failed"
-}
-
-export declare type ToolsetOAuthInitiationResult = {
-    type: ToolsetOAuthInitiationResultType.Started;
-    popup: Window;
-    flowId: string;
-} | {
-    type: ToolsetOAuthInitiationResultType.Blocked;
-} | {
-    type: ToolsetOAuthInitiationResultType.InvalidConfig;
-};
-
-/** Outcome of calling `initiateOAuthLogin`. */
-export declare enum ToolsetOAuthInitiationResultType {
-    /** The popup was opened and navigated to the provider's authorize URL. */
-    Started = "started",
-    /** The browser blocked the popup before it could be opened. */
-    Blocked = "blocked",
-    /** The toolset's OAuth configuration is missing required fields. */
-    InvalidConfig = "invalid-config"
-}
-
-/** Result resolved by `waitForToolsetOAuthResult` to the tab that initiated the login. */
-export declare type ToolsetOAuthResult = ToolsetOAuthSuccessMessage | ToolsetOAuthFailureMessage | {
-    type: ToolsetOAuthResultType.Cancelled;
-};
-
-/** Confirms that the initiating tab consumed the callback result. */
-export declare interface ToolsetOAuthResultAcknowledgement {
-    type: ToolsetOAuthChannelControlType.ResultAcknowledged;
-}
-
-/** Outcome reported back to the tab that initiated an OAuth login. */
-export declare enum ToolsetOAuthResultType {
-    Success = "success",
-    Failure = "failure",
-    /** The popup was closed and focus returned to its opener, or the flow timed out. */
-    Cancelled = "cancelled"
-}
-
-/**
- * OAuth client settings needed to build an authorize URL — the narrow subset
- * of a toolset's `authSettings` this module reads. Declared as its own shape
- * so hosts can keep their wider editor form models app-owned and still pass
- * them straight in.
- */
-export declare interface ToolsetOAuthSettings {
-    clientId?: string;
-    authorizationEndpoint?: string;
-    scopes?: string[];
-    codeChallenge?: string;
-    codeChallengeMethod?: string;
-}
-
-export declare interface ToolsetOAuthSuccessMessage {
-    type: ToolsetOAuthResultType.Success;
-    toolsetId: string;
-    credentialsLevel: ToolsetCredentialsLevel;
-}
-
-/**
- * Redirect state for an OAuth login flow. The flow writes this into the
- * *popup's own* `sessionStorage` before navigating it to the provider, since
- * the popup and its opener do not share a `sessionStorage` partition once
- * navigated cross-origin.
- */
-export declare interface ToolsetRedirectState {
-    toolsetId: string;
-    credentialsLevel?: ToolsetCredentialsLevel;
-    redirectUri?: string;
-    /** CSRF state token generated by the client before the OAuth redirect. */
-    state?: string;
-    /**
-     * Which sign-in endpoint the host's callback route should submit the
-     * authorization code to. Defaults to `Toolset` when absent so every
-     * existing redirect state (written before this field existed) keeps
-     * calling the toolset login unchanged. `ExternalService` reuses the same
-     * popup/BroadcastChannel machinery with `toolsetId` repurposed as an
-     * `{appId}::{serviceId}` composite key. `OfflineCredentials` reuses the
-     * same machinery again, with `toolsetId` repurposed as a fixed sentinel
-     * correlation id (`'offline-credentials'`) — the field carries no real
-     * toolset/external-service meaning there, only the opaque
-     * flow-correlation string the shared popup/`BroadcastChannel` utilities
-     * require structurally.
-     */
-    resourceKind?: OAuthResourceKind;
-    /**
-     * Whether the user agreed the application may use the resulting credential
-     * while they are away. Carried through the popup because the choice is made
-     * before the redirect and the code exchange happens after it — the callback
-     * route has no other way to learn it. Absent means "not granted".
-     */
-    offlineUsageConsent?: boolean;
-}
-
-/**
- * Completes an OAuth authorization-code flow from inside the callback popup:
- * reads and clears the redirect state written into this popup's own
- * `sessionStorage`, scrubs the authorization code from the visible URL before
- * any request, validates the returned `state`, performs the exchange through
- * the injected callback, then reports the outcome into the popup URL and over
- * the flow channel until acknowledged, closing the popup afterwards. Runs its
- * effect once per mount even under StrictMode double-invocation. Renders
- * nothing and produces no user-visible text — the host page presents and
- * announces the returned state in its own language.
- */
-export declare const useOAuthCallbackCompletion: ({ searchParams, callbackPath, exchange, }: UseOAuthCallbackCompletionParams) => UseOAuthCallbackCompletionResult;
-
-/** Parameters for {@link useOAuthCallbackCompletion}. */
-export declare interface UseOAuthCallbackCompletionParams {
-    /**
-     * Query parameters of the callback URL. Read once per mount; the hook takes
-     * `code` and `state` from it.
-     */
-    searchParams: URLSearchParams;
-    /**
-     * Path used to build the `redirect_uri` echoed back to the backend when the
-     * stored redirect state carries none — every state written by the current
-     * flow does, so this only covers states written before that field existed.
-     */
-    callbackPath: string;
-    /**
-     * Performs the code-for-credentials exchange. Resolving `null` reports
-     * success; resolving a failure reason reports that reason (for a host-side
-     * validation the hook cannot perform, such as an unparseable resource id);
-     * rejecting reports `LoginRequestFailed`.
-     */
-    exchange: (params: OAuthExchangeParams) => Promise<ToolsetOAuthFailureReason | null>;
-}
-
-/** State {@link useOAuthCallbackCompletion} exposes for the host page to render. */
-export declare interface UseOAuthCallbackCompletionResult {
-    /** True until the flow has reported an outcome. */
-    isInProgress: boolean;
-    /** Reason the flow failed, or `null` while in progress or on success. */
-    failureReason: ToolsetOAuthFailureReason | null;
-}
-
-/**
- * Shared toolset API-key/OAuth login orchestration, so no two surfaces fork
- * the popup/`BroadcastChannel` handshake or the stale-credential-clearing
- * rule. Every backend call arrives as an injected callback: the hook
- * constructs no client instance and reads no app context. It resolves an
- * outcome and shows nothing itself — mapping an outcome to notifications is
- * the caller's job.
- */
-export declare const useToolsetLogin: ({ callbackPath, loginToolset, logoutToolset, getToolset, }: UseToolsetLoginParams) => UseToolsetLoginResult;
-
-/** Parameters for {@link useToolsetLogin}. */
-export declare interface UseToolsetLoginParams {
-    /**
-     * The host's OAuth callback route. Resolved against `window.location.origin`
-     * for the `redirect_uri`, and compared against the popup's pathname when
-     * reading a completion marker out of its URL.
-     */
-    callbackPath: string;
-    /** Submits credentials for one toolset at one credentials level. */
-    loginToolset: (toolsetId: string, body: ToolsetLoginBodyDto) => Promise<unknown>;
-    /** Clears stored credentials for one toolset at one credentials level. */
-    logoutToolset: (toolsetId: string, body: ToolsetLogoutBodyDto) => Promise<unknown>;
-    /** Re-reads a toolset so a reported cancellation can be checked against the backend. */
-    getToolset: (toolsetId: string) => Promise<DialToolsetDto>;
-}
-
-/** Result returned by {@link useToolsetLogin}. */
-export declare interface UseToolsetLoginResult {
-    /** Runs one API-key or OAuth login attempt and resolves its outcome. */
-    login: (params: ToolsetLoginParams) => Promise<ToolsetLoginOutcome>;
-}
-
-/**
- * Waits for the OAuth callback popup to report a result over BroadcastChannel
- * or through the completion marker in its same-origin URL. A cross-origin
- * provider can make the retained WindowProxy look closed even while the popup
- * remains open, so cancellation is confirmed only when the initiating window
- * regains focus. Reported results are acknowledged so the callback can close
- * itself even when the retained WindowProxy was severed.
- */
-export declare const waitForToolsetOAuthResult: (popup: Window, flowId: string, { toolsetId, credentialsLevel, callbackPath, timeoutMs, pollIntervalMs, }: WaitForToolsetOAuthResultOptions) => Promise<ToolsetOAuthResult>;
-
-/** Options for {@link waitForToolsetOAuthResult}. */
-export declare interface WaitForToolsetOAuthResultOptions {
-    /** Resource id echoed back in a success result. */
-    toolsetId: string;
-    /** Credentials level echoed back in a success result. */
-    credentialsLevel: ToolsetCredentialsLevel;
-    /**
-     * The host's callback route — the same path the flow's popup was opened
-     * against. The popup-URL reader treats a same-origin URL as a result only
-     * when its pathname equals this value, so a host serving more than one
-     * callback route passes whichever one it actually opened.
-     */
-    callbackPath: string;
-    timeoutMs?: number;
-    pollIntervalMs?: number;
-}
-
-/** Whether a toolset authenticates interactively, and whether its client is manually configured. */
-export declare enum WithLogin {
-    WithLogin = "with-login",
-    WithoutLogin = "without-login",
-    WithConfig = "with-config"
-}
-
-export { }
+export * from './entry-points/oauth.js'
+export {}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@epam/ai-dial-chat-hooks",
   "description": "Framework-level React hooks extracted from AI DIAL Chat for building custom chat interfaces",
-  "version": "1.3.0-dev.5",
+  "version": "1.3.0-dev.55",
   "license": "Apache-2.0",
   "type": "module",
   "main": "./index.js",
@@ -104,6 +104,11 @@
       "import": "./usage.js",
       "default": "./usage.js"
     },
+    "./usage-limits": {
+      "types": "./usage-limits.d.ts",
+      "import": "./usage-limits.js",
+      "default": "./usage-limits.js"
+    },
     "./mcp-apps": {
       "types": "./mcp-apps.d.ts",
       "import": "./mcp-apps.js",
@@ -111,7 +116,7 @@
     }
   },
   "dependencies": {
-    "@epam/ai-dial-chat-api-client": "1.3.0-dev.5",
+    "@epam/ai-dial-chat-api-client": "1.3.0-dev.55",
     "dompurify": "3.4.16",
     "fflate": "^0.8.3",
     "lru-cache": "^10.4.3",
@@ -120,21 +125,22 @@
   },
   "peerDependencies": {
     "react": "^19.2.8",
-    "@epam/ai-dial-attachment-canvas": "1.3.0-dev.5",
-    "@epam/ai-dial-attachment-input": "1.3.0-dev.5",
-    "@epam/ai-dial-catalog": "1.3.0-dev.5",
-    "@epam/ai-dial-chat-overlay": "1.3.0-dev.5",
-    "@epam/ai-dial-chat-shared": "1.3.0-dev.5",
-    "@epam/ai-dial-mcp-apps": "1.3.0-dev.5",
-    "@epam/ai-dial-publish-panel": "1.3.0-dev.5",
-    "@epam/ai-dial-quotations": "1.3.0-dev.5",
-    "@epam/ai-dial-react-file-manager": "^0.3.0",
-    "@epam/ai-dial-scheduled-tasks": "1.3.0-dev.5",
-    "@epam/ai-dial-share": "1.3.0-dev.5",
-    "@epam/ai-dial-skill-editor": "1.3.0-dev.5",
-    "@epam/ai-dial-source-panel": "1.3.0-dev.5",
-    "@epam/ai-dial-ui-kit": "^0.15.0",
-    "@epam/ai-dial-usage-dashboard": "1.3.0-dev.5",
+    "@epam/ai-dial-attachment-canvas": "1.3.0-dev.55",
+    "@epam/ai-dial-attachment-input": "1.3.0-dev.55",
+    "@epam/ai-dial-catalog": "1.3.0-dev.55",
+    "@epam/ai-dial-chat-overlay": "1.3.0-dev.55",
+    "@epam/ai-dial-chat-shared": "1.3.0-dev.55",
+    "@epam/ai-dial-conversation-input": "1.3.0-dev.55",
+    "@epam/ai-dial-mcp-apps": "1.3.0-dev.55",
+    "@epam/ai-dial-publish-panel": "1.3.0-dev.55",
+    "@epam/ai-dial-quotations": "1.3.0-dev.55",
+    "@epam/ai-dial-react-file-manager": "^0.3.5",
+    "@epam/ai-dial-scheduled-tasks": "1.3.0-dev.55",
+    "@epam/ai-dial-share": "1.3.0-dev.55",
+    "@epam/ai-dial-skill-editor": "1.3.0-dev.55",
+    "@epam/ai-dial-source-panel": "1.3.0-dev.55",
+    "@epam/ai-dial-ui-kit": "^0.15.4",
+    "@epam/ai-dial-usage-dashboard": "1.3.0-dev.55",
     "@modelcontextprotocol/sdk": "^1.32.1",
     "@epam/pdf-highlighter-kit": "^0.0.19",
     "@mcp-ui/client": "^7.1.1"
@@ -155,6 +161,9 @@
     "@epam/ai-dial-chat-shared": {
       "optional": true
     },
+    "@epam/ai-dial-conversation-input": {
+      "optional": true
+    },
     "@epam/ai-dial-mcp-apps": {
       "optional": true
     },

package/prompt/export-prompt.d.ts

@@ -0,0 +1,31 @@
+import { PromptResponseDto } from '@epam/ai-dial-chat-api-client';
+import { ExportFolder } from '@epam/ai-dial-chat-shared';
+/** A prompt record as it appears inside a downloaded prompt file. */
+export interface ExportedPrompt {
+    /** Prompt path within the prompts namespace, doubling as its stable id. */
+    id: string;
+    /** Display name. */
+    name: string;
+    /** Description, empty when the prompt has none. */
+    description: string;
+    /** Prompt text, `{{variable}}` placeholders included verbatim. */
+    content: string;
+    /** Parent folder path; absent for a root-level prompt. */
+    folderId?: string;
+}
+/** Versioned JSON envelope produced by a prompt download. */
+export interface PromptExportFormat {
+    /** Format version discriminator, shared with the conversation export envelope. */
+    version: 5;
+    /** Exported prompts. */
+    prompts: ExportedPrompt[];
+    /** Folders the exported prompts belong to, outermost first. */
+    folders: ExportFolder[];
+}
+/** Builds the download envelope for a single prompt, including its folder chain. */
+export declare const buildPromptExportEnvelope: (prompt: PromptResponseDto) => PromptExportFormat;
+/** Serializes a prompt export envelope into a pretty-printed JSON blob. */
+export declare const serializePromptExport: (envelope: PromptExportFormat) => Blob;
+/** Builds a prompt's download file name, e.g. `2026-08-12_ai_dial_prompt_summarize.json`. */
+export declare const buildPromptExportFileName: (promptName: string, appName: string, date?: Date) => string;
+//# sourceMappingURL=export-prompt.d.ts.map

package/prompt/export-prompt.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"export-prompt.d.ts","sourceRoot":"","sources":["../../src/prompt/export-prompt.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AACvE,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAG9D,qEAAqE;AACrE,MAAM,WAAW,cAAc;IAC7B,2EAA2E;IAC3E,EAAE,EAAE,MAAM,CAAC;IACX,oBAAoB;IACpB,IAAI,EAAE,MAAM,CAAC;IACb,mDAAmD;IACnD,WAAW,EAAE,MAAM,CAAC;IACpB,kEAAkE;IAClE,OAAO,EAAE,MAAM,CAAC;IAChB,0DAA0D;IAC1D,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,6DAA6D;AAC7D,MAAM,WAAW,kBAAkB;IACjC,kFAAkF;IAClF,OAAO,EAAE,CAAC,CAAC;IACX,wBAAwB;IACxB,OAAO,EAAE,cAAc,EAAE,CAAC;IAC1B,+DAA+D;IAC/D,OAAO,EAAE,YAAY,EAAE,CAAC;CACzB;AAmBD,oFAAoF;AACpF,eAAO,MAAM,yBAAyB,GACpC,QAAQ,iBAAiB,KACxB,kBAYD,CAAC;AAEH,2EAA2E;AAC3E,eAAO,MAAM,qBAAqB,GAAI,UAAU,kBAAkB,KAAG,IACQ,CAAC;AAK9E,6FAA6F;AAC7F,eAAO,MAAM,yBAAyB,GACpC,YAAY,MAAM,EAClB,SAAS,MAAM,EACf,OAAM,IAAiB,KACtB,MAGF,CAAC"}