@epam/ai-dial-chat-hooks 1.3.0-dev.7 → 1.3.0-dev.79

package/oauth/useOAuthCallbackCompletion/useOAuthCallbackCompletion.d.ts

@@ -0,0 +1,54 @@
+import { ToolsetRedirectState } from '../models';
+import { ToolsetCredentialsLevel, ToolsetOAuthFailureReason } from '../types';
+/** Arguments handed to the host's exchange callback. */
+export 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;
+}
+/** Parameters for {@link useOAuthCallbackCompletion}. */
+export 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 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;
+}
+/**
+ * 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;
+//# sourceMappingURL=useOAuthCallbackCompletion.d.ts.map

package/oauth/useOAuthCallbackCompletion/useOAuthCallbackCompletion.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useOAuthCallbackCompletion.d.ts","sourceRoot":"","sources":["../../../src/oauth/useOAuthCallbackCompletion/useOAuthCallbackCompletion.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAGV,oBAAoB,EACrB,MAAM,WAAW,CAAC;AACnB,OAAO,EAEL,uBAAuB,EAGvB,yBAAyB,EAE1B,MAAM,UAAU,CAAC;AAIlB,wDAAwD;AACxD,MAAM,WAAW,mBAAmB;IAClC,yDAAyD;IACzD,IAAI,EAAE,MAAM,CAAC;IACb,kFAAkF;IAClF,WAAW,EAAE,MAAM,CAAC;IACpB,iEAAiE;IACjE,gBAAgB,EAAE,uBAAuB,CAAC;IAC1C,iFAAiF;IACjF,aAAa,EAAE,oBAAoB,CAAC;CACrC;AAED,yDAAyD;AACzD,MAAM,WAAW,gCAAgC;IAC/C;;;OAGG;IACH,YAAY,EAAE,eAAe,CAAC;IAC9B;;;;OAIG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;;;;OAKG;IACH,QAAQ,EAAE,CACR,MAAM,EAAE,mBAAmB,KACxB,OAAO,CAAC,yBAAyB,GAAG,IAAI,CAAC,CAAC;CAChD;AAED,oFAAoF;AACpF,MAAM,WAAW,gCAAgC;IAC/C,mDAAmD;IACnD,YAAY,EAAE,OAAO,CAAC;IACtB,yEAAyE;IACzE,aAAa,EAAE,yBAAyB,GAAG,IAAI,CAAC;CACjD;AAqFD;;;;;;;;;;GAUG;AACH,eAAO,MAAM,0BAA0B,GAAI,2CAIxC,gCAAgC,KAAG,gCAqGrC,CAAC"}

package/oauth/useOAuthCallbackCompletion/useOAuthCallbackCompletion.js

@@ -1,22 +1,27 @@
 import { TOOLSET_REDIRECT_STATE_KEY as e, ToolsetCredentialsLevel as t, ToolsetOAuthCallbackQuery as n, ToolsetOAuthChannelControlType as r, ToolsetOAuthFailureReason as i, ToolsetOAuthResultType as a } from "../types.js";
 import { getToolsetOAuthChannelName as o } from "../handshake.js";
-import { useEffect as s, useRef as c, useState as l } from "react";
+import { decodeJsonFromBase64 as s } from "@epam/ai-dial-chat-shared";
+import { useEffect as c, useRef as l, useState as u } from "react";
 //#region src/oauth/useOAuthCallbackCompletion/useOAuthCallbackCompletion.ts
-var u = 500, d = (e) => typeof e == "object" && !!e && "type" in e && e.type === r.ResultAcknowledged, f = () => {
+var d = 500, f = (e) => typeof e == "object" && !!e && "type" in e && e.type === r.ResultAcknowledged, p = () => {
 	let t = sessionStorage.getItem(e);
 	if (!t) return null;
 	try {
-		return JSON.parse(t);
+		return s(t);
 	} catch {
-		return null;
+		try {
+			return JSON.parse(t);
+		} catch {
+			return null;
+		}
 	}
-}, p = (e) => {
+}, m = (e) => {
 	try {
 		window.history.replaceState({}, document.title, `${e.pathname}${e.search}`);
 	} catch {}
-}, m = (e, t) => {
+}, h = (e, t) => {
 	let r = new URL(window.location.pathname, window.location.origin);
-	if (r.searchParams.set(n.Result, t.type), t.type === a.Failure && r.searchParams.set(n.FailureReason, t.reason), p(r), !e) {
+	if (r.searchParams.set(n.Result, t.type), t.type === a.Failure && r.searchParams.set(n.FailureReason, t.reason), m(r), !e) {
 		window.close();
 		return;
 	}
@@ -25,70 +30,67 @@ var u = 500, d = (e) => typeof e == "object" && !!e && "type" in e && e.type ===
 		n.postMessage(t);
 		let r = setInterval(() => {
 			n.postMessage(t);
-		}, u);
+		}, d);
 		n.onmessage = (e) => {
-			d(e.data) && (clearInterval(r), n.close(), window.close());
+			f(e.data) && (clearInterval(r), n.close(), window.close());
 		};
 	} catch {}
-}, h = ({ searchParams: n, callbackPath: r, exchange: o }) => {
-	let [u, d] = l(!0), [h, g] = l(null), _ = c(!1), v = c(o);
+}, g = ({ searchParams: n, callbackPath: r, exchange: o }) => {
+	let [s, d] = u(!0), [f, g] = u(null), _ = l(!1), v = l(o);
 	v.current = o;
-	let y = c(r);
-	return y.current = r, s(() => {
-		if (_.current) return;
-		_.current = !0;
-		let r = (e, t) => {
-			m(e, t), d(!1), g(t.type === a.Failure ? t.reason : null);
-		};
-		(async () => {
-			let o = n.get("code"), s = n.get("state"), c = f();
+	let y = l(r);
+	return y.current = r, c(() => {
+		_.current || (_.current = !0, (async () => {
+			let r = n.get("code"), o = n.get("state"), s = p();
 			sessionStorage.removeItem(e);
-			let l = c?.state ?? s ?? void 0;
-			if (p(new URL(window.location.pathname, window.location.origin)), !o || !c?.toolsetId) {
-				r(l, {
+			let c = s?.state ?? o ?? void 0, l = (e, t) => {
+				h(e, t), d(!1), g(t.type === a.Failure ? t.reason : null);
+			};
+			if (m(new URL(window.location.pathname, window.location.origin)), !r || !s?.toolsetId) {
+				l(c, {
 					type: a.Failure,
-					reason: c?.toolsetId ? i.MissingCode : i.MissingRedirectState
+					reason: s?.toolsetId ? i.MissingCode : i.MissingRedirectState
 				});
 				return;
 			}
-			if (c.state != null && c.state !== s) {
-				r(l, {
+			if (s.state != null && s.state !== o) {
+				l(c, {
 					type: a.Failure,
 					reason: i.StateMismatch
 				});
 				return;
 			}
-			let u = c.credentialsLevel ?? t.User, d = c.redirectUri ?? `${window.location.origin}${y.current}`;
+			let u = s.credentialsLevel ?? t.User, f = s.redirectUri ?? `${window.location.origin}${y.current}`;
 			try {
 				let e = await v.current({
-					code: o,
-					redirectUri: d,
+					code: r,
+					redirectUri: f,
 					credentialsLevel: u,
-					redirectState: c
+					redirectState: s
 				});
 				if (e != null) {
-					r(l, {
+					l(c, {
 						type: a.Failure,
 						reason: e
 					});
 					return;
 				}
-				r(l, {
+				l(c, {
 					type: a.Success,
-					toolsetId: c.toolsetId,
+					toolsetId: s.toolsetId,
 					credentialsLevel: u
 				});
 			} catch {
-				r(l, {
+				l(c, {
 					type: a.Failure,
 					reason: i.LoginRequestFailed
 				});
 			}
-		})();
+		})());
 	}, [n]), {
-		isInProgress: u,
-		failureReason: h
+		isInProgress: s,
+		failureReason: f
 	};
 };
 //#endregion
-export { h as useOAuthCallbackCompletion };
+export { g as useOAuthCallbackCompletion };

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"}