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

package/project/use-project-actions.js

@@ -0,0 +1,92 @@
+import { getApiErrorDetails as e } from "../api-error/api-error.js";
+import { sanitizeFileName as t } from "../files/file-name.js";
+import { ProjectCreateErrorCode as n } from "@epam/ai-dial-chat-api-client";
+import { useCallback as r, useMemo as i, useState as a } from "react";
+//#region src/project/use-project-actions.ts
+var o = /* @__PURE__ */ function(e) {
+	return e.Pin = "pin", e.Unpin = "unpin", e.Download = "download", e.Delete = "delete", e.ChangedElsewhere = "changed-elsewhere", e;
+}({}), s = (o, s, { isPinned: c, setPinned: l, saveFile: u, onArchiveDownloaded: d, onDeleted: f, onError: p, onReload: m, isDeleteOpen: h, onDeleteOpenChange: g }) => {
+	let [_, v] = a(!1), [y, b] = a(!1), [x, S] = a(!1), C = h != null, w = h ?? y, T = r((e) => {
+		C || b(e), g?.(e);
+	}, [C, g]), E = r(async (t, n) => {
+		let { traceId: r } = await e(t);
+		p(n, r);
+	}, [p]), D = r(async () => {
+		if (s != null) {
+			v(!0);
+			try {
+				await l(s.id, !c);
+			} catch (e) {
+				await E(e, c ? "unpin" : "pin");
+			} finally {
+				v(!1);
+			}
+		}
+	}, [
+		s,
+		c,
+		l,
+		E
+	]), O = r(async () => {
+		if (s != null) try {
+			let e = await u(await o.downloadProjectArchive(s.id), `${t(s.name)}.zip`);
+			d?.(e);
+		} catch (e) {
+			await E(e, "download");
+		}
+	}, [
+		o,
+		s,
+		u,
+		d,
+		E
+	]), k = r(() => T(!0), [T]), A = r(() => {
+		x || T(!1);
+	}, [x, T]), j = r(async () => {
+		if (s != null) {
+			S(!0);
+			try {
+				await o.deleteProject(s.id, s.contentVersion), T(!1), f(s);
+			} catch (t) {
+				let { code: r, traceId: i } = await e(t);
+				if (r === n.ProjectChanged) {
+					T(!1), p("changed-elsewhere", i), m();
+					return;
+				}
+				p("delete", i);
+			} finally {
+				S(!1);
+			}
+		}
+	}, [
+		o,
+		s,
+		T,
+		f,
+		p,
+		m
+	]);
+	return i(() => ({
+		isPinned: c,
+		isPinPending: _,
+		togglePin: D,
+		downloadArchive: O,
+		isDeleteOpen: w,
+		isDeleting: x,
+		requestDelete: k,
+		cancelDelete: A,
+		confirmDelete: j
+	}), [
+		c,
+		_,
+		D,
+		O,
+		w,
+		x,
+		k,
+		A,
+		j
+	]);
+};
+//#endregion
+export { o as ProjectActionError, s as useProjectActions };

package/project/use-project-artifacts.d.ts

@@ -0,0 +1,24 @@
+import { ProjectArtifactItemDto } from '@epam/ai-dial-chat-api-client';
+import { ProjectsApiClient } from './projects-api-client';
+/**
+ * Loads the files the agents of a project's chats saved under its
+ * `artifacts/` folder, for the project view's Outputs section, and keeps them
+ * in local state. The list is read once per project (and on retry), and
+ * `refresh` silently re-reads it for live updates, keeping the shown outputs
+ * when it fails. A `refresh` that arrives while a read is in flight is not
+ * dropped: that read lists once more before it settles. A retry keeps
+ * `hasError` until its read settles, so the host's error UI stays in place. A
+ * request is aborted by a newer one, a project change or unmount.
+ *
+ * @param client - Configured project requests, from `createProjectsApiClient`; it must be referentially stable, because a new object reloads the list.
+ * @param projectId - The project's DIAL id, or `null` while none is known.
+ */
+export declare const useProjectArtifacts: (client: Pick<ProjectsApiClient, "listProjectArtifacts">, projectId: string | null) => {
+    retry: () => void;
+    refresh: () => Promise<void>;
+    /** The project's outputs, newest first, as the BFF lists them. */
+    items: ProjectArtifactItemDto[];
+    isLoading: boolean;
+    hasError: boolean;
+};
+//# sourceMappingURL=use-project-artifacts.d.ts.map

package/project/use-project-artifacts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-project-artifacts.d.ts","sourceRoot":"","sources":["../../src/project/use-project-artifacts.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,+BAA+B,CAAC;AAE5E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAoB/D;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,mBAAmB,GAC9B,QAAQ,IAAI,CAAC,iBAAiB,EAAE,sBAAsB,CAAC,EACvD,WAAW,MAAM,GAAG,IAAI;;;IAhCxB,kEAAkE;WAC3D,sBAAsB,EAAE;eACpB,OAAO;cACR,OAAO;CAyGlB,CAAC"}

package/project/use-project-artifacts.js

@@ -0,0 +1,78 @@
+import { useCallback as e, useEffect as t, useRef as n, useState as r } from "react";
+//#region src/project/use-project-artifacts.ts
+var i = {
+	items: [],
+	isLoading: !0,
+	hasError: !1
+}, a = {
+	...i,
+	isLoading: !1
+}, o = (o, s) => {
+	let [c, l] = r(i), [u, d] = r(0), f = n(null), p = n(!1), m = n(null), h = n(c);
+	t(() => {
+		h.current = c;
+	}), t(() => {
+		let e = m.current === s;
+		if (m.current = s, s == null) {
+			l(a);
+			return;
+		}
+		let t = new AbortController();
+		return p.current = !1, (async () => {
+			l((t) => e ? {
+				...t,
+				isLoading: !0
+			} : i);
+			try {
+				let e;
+				do
+					if (p.current = !1, {items: e} = await o.listProjectArtifacts(s, t.signal), t.signal.aborted) return;
+				while (p.current);
+				l({
+					items: e,
+					isLoading: !1,
+					hasError: !1
+				});
+			} catch {
+				if (t.signal.aborted) return;
+				l({
+					...a,
+					hasError: !0
+				});
+			}
+		})(), () => {
+			t.abort(), f.current?.abort();
+		};
+	}, [
+		o,
+		s,
+		u
+	]);
+	let g = e(() => d((e) => e + 1), []), _ = e(async () => {
+		let e = h.current;
+		if (s == null) return;
+		if (e.isLoading) {
+			p.current = !0;
+			return;
+		}
+		if (e.hasError) return;
+		f.current?.abort();
+		let t = new AbortController();
+		f.current = t;
+		try {
+			let { items: e } = await o.listProjectArtifacts(s, t.signal);
+			if (t.signal.aborted) return;
+			l((t) => ({
+				...t,
+				items: e
+			}));
+		} catch {}
+	}, [o, s]);
+	return {
+		...c,
+		retry: g,
+		refresh: _
+	};
+};
+//#endregion
+export { o as useProjectArtifacts };

package/project/use-project-conversations.d.ts

@@ -0,0 +1,32 @@
+import { ProjectConversationListItem } from '@epam/ai-dial-projects';
+import { ProjectsApiClient } from './projects-api-client';
+/**
+ * Loads a project's conversations for its Chats list and keeps them in local
+ * state. DIAL Core cannot page them in display order, so the whole list is
+ * read once per project (and on retry) and paged here: the list shows the
+ * first 20, and `loadMore` shows 20 more after reading the titles the list
+ * left pending. `refresh` silently re-reads the whole list for live updates,
+ * and rename, delete and `markViewed` update it in place. Requests are
+ * aborted when the project changes or the view unmounts. Rename, delete and
+ * `loadMore` reject on failure for the caller's toast.
+ *
+ * @param client - Configured project requests, from `createProjectsApiClient`; it must be referentially stable, because a new object reloads the list.
+ * @param projectId - The project's DIAL id, or `null` while none is known.
+ */
+export declare const useProjectConversations: (client: Pick<ProjectsApiClient, "listProjectConversations" | "getProjectConversationTitles" | "renameProjectConversation" | "generateProjectConversationTitle" | "deleteProjectConversation" | "markProjectConversationViewed">, projectId: string | null) => {
+    items: ProjectConversationListItem[];
+    isLoading: boolean;
+    hasError: boolean;
+    /** More conversations exist after `items`. */
+    hasMore: boolean;
+    /** The titles of the next conversations are being read. */
+    isLoadingMore: boolean;
+    retry: () => void;
+    loadMore: () => Promise<void>;
+    rename: (id: string, newTitle: string) => Promise<void>;
+    generateTitle: (id: string) => Promise<string>;
+    remove: (id: string) => Promise<void>;
+    refresh: () => Promise<void>;
+    markViewed: (id: string) => void;
+};
+//# sourceMappingURL=use-project-conversations.d.ts.map

package/project/use-project-conversations.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-project-conversations.d.ts","sourceRoot":"","sources":["../../src/project/use-project-conversations.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,wBAAwB,CAAC;AAG1E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AA8E/D;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,uBAAuB,GAClC,QAAQ,IAAI,CACV,iBAAiB,EACf,0BAA0B,GAC1B,8BAA8B,GAC9B,2BAA2B,GAC3B,kCAAkC,GAClC,2BAA2B,GAC3B,+BAA+B,CAClC,EACD,WAAW,MAAM,GAAG,IAAI;;;;IAqOtB,8CAA8C;;IAE9C,2DAA2D;;;;iBAlDhD,MAAM,YAAY,MAAM;wBAaxB,MAAM;iBAQN,MAAM;;qBA1CZ,MAAM;CAiFd,CAAC"}

package/project/use-project-conversations.js

@@ -0,0 +1,200 @@
+import { applyViewedMark as e } from "./project-viewed-marks.js";
+import { useCallback as t, useEffect as n, useMemo as r, useRef as i, useState as a } from "react";
+//#region src/project/use-project-conversations.ts
+var o = 20, s = 100, c = {
+	rows: [],
+	visibleCount: o,
+	isLoading: !0,
+	hasError: !1,
+	isLoadingMore: !1
+}, l = {
+	...c,
+	isLoading: !1
+}, u = (t, n) => t.map((t) => {
+	let { id: r, name: i, title: a, author: o, isTitlePending: s } = t;
+	return {
+		id: r,
+		name: i,
+		title: a,
+		authorName: o,
+		isTitlePending: s === !0,
+		...e(n, t) ? { isUnread: !0 } : {}
+	};
+}), d = (e, t) => {
+	if (t.length === 0) return e;
+	let n = new Map(t.map((e) => [e.id, e]));
+	return e.map((e) => n.get(e.id) ?? e);
+}, f = ({ id: e, title: t, authorName: n, isUnread: r }) => ({
+	id: e,
+	title: t,
+	authorName: n,
+	...r ? { isUnread: !0 } : {}
+}), p = (e, p) => {
+	let [m, h] = a(c), [g, _] = a(0), v = i(null), y = i(null), b = i(!1), x = i(/* @__PURE__ */ new Map()), S = i(/* @__PURE__ */ new Map()), C = i(m);
+	n(() => {
+		C.current = m;
+	});
+	let w = t((e) => {
+		for (let { id: t, updatedAt: n } of e) S.current.set(t, n);
+	}, []), T = t(async (t, n) => {
+		if (p == null) return [];
+		let r = t.filter((e) => e.isTitlePending).map((e) => e.name), i = [];
+		for (let t = 0; t < r.length; t += s) {
+			let { items: a } = await e.getProjectConversationTitles(p, r.slice(t, t + s), n);
+			i.push(...a);
+		}
+		return w(i), u(i, x.current);
+	}, [
+		e,
+		p,
+		w
+	]), E = t(async (e, t, n) => {
+		try {
+			let r = await T(e.slice(0, t), n);
+			if (n.aborted) return;
+			h((e) => ({
+				...e,
+				rows: d(e.rows, r)
+			}));
+		} catch {}
+	}, [T]);
+	n(() => {
+		if (x.current = /* @__PURE__ */ new Map(), S.current = /* @__PURE__ */ new Map(), p == null) {
+			h(l);
+			return;
+		}
+		let t = new AbortController();
+		return v.current = t, (async () => {
+			h((e) => ({
+				...e,
+				isLoading: !0,
+				hasError: !1,
+				isLoadingMore: !1
+			}));
+			try {
+				let { items: n } = await e.listProjectConversations(p, t.signal);
+				if (t.signal.aborted) return;
+				w(n), h({
+					...l,
+					rows: u(n, x.current)
+				});
+			} catch {
+				if (t.signal.aborted) return;
+				h({
+					...l,
+					hasError: !0
+				});
+			}
+		})(), () => {
+			t.abort(), y.current?.abort();
+		};
+	}, [
+		e,
+		p,
+		g,
+		w
+	]);
+	let D = t(() => _((e) => e + 1), []), O = t(async () => {
+		let e = v.current, t = C.current;
+		if (p == null || e == null || b.current) return;
+		b.current = !0;
+		let n = t.visibleCount + o, r = t.rows.slice(t.visibleCount, n);
+		h((e) => ({
+			...e,
+			isLoadingMore: !0
+		}));
+		try {
+			let t = await T(r, e.signal);
+			if (e.signal.aborted) return;
+			h((e) => ({
+				...e,
+				rows: d(e.rows, t),
+				visibleCount: Math.max(e.visibleCount, n),
+				isLoadingMore: !1
+			}));
+		} catch (t) {
+			if (e.signal.aborted) return;
+			throw h((e) => ({
+				...e,
+				isLoadingMore: !1
+			})), t;
+		} finally {
+			b.current = !1;
+		}
+	}, [p, T]), k = t(async () => {
+		let t = C.current;
+		if (p == null || t.isLoading || t.hasError) return;
+		y.current?.abort();
+		let n = new AbortController();
+		y.current = n;
+		let r;
+		try {
+			let { items: t } = await e.listProjectConversations(p, n.signal);
+			if (n.signal.aborted) return;
+			w(t), r = u(t, x.current);
+		} catch {
+			return;
+		}
+		h((e) => ({
+			...e,
+			rows: r
+		})), await E(r, C.current.visibleCount, n.signal);
+	}, [
+		e,
+		E,
+		p,
+		w
+	]);
+	n(() => () => y.current?.abort(), []);
+	let A = t((t) => {
+		x.current.set(t, S.current.get(t)), h((e) => ({
+			...e,
+			rows: e.rows.map((e) => e.id === t && e.isUnread ? {
+				...e,
+				isUnread: !1
+			} : e)
+		})), (async () => {
+			try {
+				await e.markProjectConversationViewed?.(t);
+			} catch {}
+		})();
+	}, [e]), j = t(async (t, n) => {
+		let { name: r } = await e.renameProjectConversation(t, n);
+		h((e) => ({
+			...e,
+			rows: e.rows.map((e) => e.id === t ? {
+				...e,
+				title: r,
+				isTitlePending: !1
+			} : e)
+		}));
+	}, [e]), M = t(async (t) => {
+		let { name: n } = await e.generateProjectConversationTitle(t);
+		return n;
+	}, [e]), N = t(async (t) => {
+		await e.deleteProjectConversation(t);
+		let { rows: n, visibleCount: r } = C.current, i = n.filter((e) => e.id !== t);
+		h((e) => ({
+			...e,
+			rows: e.rows.filter((e) => e.id !== t)
+		}));
+		let a = v.current;
+		a != null && E(i, r, a.signal);
+	}, [e, E]), { rows: P, visibleCount: F, isLoading: I, hasError: L, isLoadingMore: R } = m;
+	return {
+		items: r(() => P.slice(0, F).map(f), [P, F]),
+		isLoading: I,
+		hasError: L,
+		hasMore: F < P.length,
+		isLoadingMore: R,
+		retry: D,
+		loadMore: O,
+		rename: j,
+		generateTitle: M,
+		remove: N,
+		refresh: k,
+		markViewed: A
+	};
+};
+//#endregion
+export { p as useProjectConversations };

package/project/use-project-draft.d.ts

@@ -0,0 +1,46 @@
+import { ProjectDetailsDto } from '@epam/ai-dial-chat-api-client';
+import { ProjectContextFile, ProjectCreateFormErrors, ProjectCreateFormValues } from '@epam/ai-dial-projects';
+import { Dispatch, SetStateAction } from 'react';
+/** Which project form a {@link useProjectDraft} draft backs. */
+export declare enum ProjectDraftMode {
+    /** The New project form: empty at the start, nothing stored yet. */
+    Create = "create",
+    /** The Edit project form: seeded from a loaded project. */
+    Edit = "edit"
+}
+/** Mode of a {@link useProjectDraft} draft, and the loaded project of an edit draft. */
+export type UseProjectDraftOptions = {
+    /** The New project form. */
+    mode: ProjectDraftMode.Create;
+} | {
+    /** The Edit project form. */
+    mode: ProjectDraftMode.Edit;
+    /** The loaded project, or `null` while none is; the draft is seeded once per its `contentVersion`. */
+    project: ProjectDetailsDto | null;
+};
+/** State and handlers of a project form draft. */
+export interface UseProjectDraftResult {
+    /** Name and instructions as typed. */
+    values: ProjectCreateFormValues;
+    /** The form's context file cards: stored files (edit mode) and files added in this session. */
+    contextFiles: ProjectContextFile[];
+    /** Field errors the host set, e.g. from a rejected request. */
+    errors: ProjectCreateFormErrors;
+    /** Sets the field errors, for a rejection the host maps to a field. */
+    setErrors: Dispatch<SetStateAction<ProjectCreateFormErrors>>;
+    /** Changes one text field; a change to the name clears its error. */
+    onFieldChange: <K extends keyof ProjectCreateFormValues>(field: K, value: ProjectCreateFormValues[K]) => void;
+    /** Replaces the context file cards and clears the context error. */
+    onContextFilesChange: (files: ProjectContextFile[]) => void;
+    /** Whether the draft is ready to submit: always in create mode, once seeded from the loaded project in edit mode. */
+    isSeeded: boolean;
+    /** Whether the draft holds edits that leaving would discard. */
+    isDirty: boolean;
+    /** Names of stored files the user removed (edit mode); empty in create mode. */
+    removedFileNames: string[];
+    /** Files added in this session, not yet stored. */
+    newFiles: File[];
+}
+/** Owns the form state of the New project and Edit project pages: values, context files, field errors, dirtiness, and the removed and new files a save sends. */
+export declare const useProjectDraft: (options: UseProjectDraftOptions) => UseProjectDraftResult;
+//# sourceMappingURL=use-project-draft.d.ts.map

package/project/use-project-draft.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-project-draft.d.ts","sourceRoot":"","sources":["../../src/project/use-project-draft.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AACvE,OAAO,EAEL,KAAK,kBAAkB,EACvB,KAAK,uBAAuB,EAC5B,KAAK,uBAAuB,EAC7B,MAAM,wBAAwB,CAAC;AAChC,OAAO,EAKL,KAAK,QAAQ,EACb,KAAK,cAAc,EACpB,MAAM,OAAO,CAAC;AAGf,gEAAgE;AAChE,oBAAY,gBAAgB;IAC1B,oEAAoE;IACpE,MAAM,WAAW;IACjB,2DAA2D;IAC3D,IAAI,SAAS;CACd;AAED,wFAAwF;AACxF,MAAM,MAAM,sBAAsB,GAC9B;IACE,4BAA4B;IAC5B,IAAI,EAAE,gBAAgB,CAAC,MAAM,CAAC;CAC/B,GACD;IACE,6BAA6B;IAC7B,IAAI,EAAE,gBAAgB,CAAC,IAAI,CAAC;IAC5B,sGAAsG;IACtG,OAAO,EAAE,iBAAiB,GAAG,IAAI,CAAC;CACnC,CAAC;AAEN,kDAAkD;AAClD,MAAM,WAAW,qBAAqB;IACpC,sCAAsC;IACtC,MAAM,EAAE,uBAAuB,CAAC;IAChC,+FAA+F;IAC/F,YAAY,EAAE,kBAAkB,EAAE,CAAC;IACnC,+DAA+D;IAC/D,MAAM,EAAE,uBAAuB,CAAC;IAChC,uEAAuE;IACvE,SAAS,EAAE,QAAQ,CAAC,cAAc,CAAC,uBAAuB,CAAC,CAAC,CAAC;IAC7D,qEAAqE;IACrE,aAAa,EAAE,CAAC,CAAC,SAAS,MAAM,uBAAuB,EACrD,KAAK,EAAE,CAAC,EACR,KAAK,EAAE,uBAAuB,CAAC,CAAC,CAAC,KAC9B,IAAI,CAAC;IACV,oEAAoE;IACpE,oBAAoB,EAAE,CAAC,KAAK,EAAE,kBAAkB,EAAE,KAAK,IAAI,CAAC;IAC5D,qHAAqH;IACrH,QAAQ,EAAE,OAAO,CAAC;IAClB,gEAAgE;IAChE,OAAO,EAAE,OAAO,CAAC;IACjB,gFAAgF;IAChF,gBAAgB,EAAE,MAAM,EAAE,CAAC;IAC3B,mDAAmD;IACnD,QAAQ,EAAE,IAAI,EAAE,CAAC;CAClB;AAKD,iKAAiK;AACjK,eAAO,MAAM,eAAe,GAC1B,SAAS,sBAAsB,KAC9B,qBA4FF,CAAC"}

package/project/use-project-draft.js

@@ -0,0 +1,54 @@
+import { mapStoredContextFiles as e } from "./project-mapping.js";
+import { useCallback as t, useEffect as n, useMemo as r, useState as i } from "react";
+import { isStoredContextFile as a } from "@epam/ai-dial-projects";
+//#region src/project/use-project-draft.ts
+var o = /* @__PURE__ */ function(e) {
+	return e.Create = "create", e.Edit = "edit", e;
+}({}), s = {
+	name: "",
+	instructions: ""
+}, c = [], l = (o) => {
+	let l = o.mode === "edit" ? o.project : null, u = o.mode === "edit", [d, f] = i(s), [p, m] = i(c), [h, g] = i({}), [_, v] = i(null);
+	n(() => {
+		u && l != null && l.contentVersion !== _ && (f({
+			name: l.name,
+			instructions: l.instructions
+		}), m(e(l)), g({}), v(l.contentVersion));
+	}, [
+		u,
+		l,
+		_
+	]);
+	let y = r(() => {
+		if (l == null) return [];
+		let e = new Set(p.filter(a).map((e) => e.name));
+		return l.contextFiles.map((e) => e.name).filter((t) => !e.has(t));
+	}, [l, p]), b = r(() => p.flatMap((e) => a(e) ? [] : [e.file]), [p]), x = !u || l != null && _ === l.contentVersion, S = u ? l != null && x && (d.name !== l.name || d.instructions !== l.instructions || y.length > 0 || b.length > 0) : d.name !== "" || d.instructions !== "" || p.length > 0;
+	return {
+		values: d,
+		contextFiles: p,
+		errors: h,
+		setErrors: g,
+		onFieldChange: t((e, t) => {
+			f((n) => ({
+				...n,
+				[e]: t
+			})), e === "name" && g((e) => e.name ? {
+				...e,
+				name: void 0
+			} : e);
+		}, []),
+		onContextFilesChange: t((e) => {
+			m(e), g((e) => e.context ? {
+				...e,
+				context: void 0
+			} : e);
+		}, []),
+		isSeeded: x,
+		isDirty: S,
+		removedFileNames: y,
+		newFiles: b
+	};
+};
+//#endregion
+export { o as ProjectDraftMode, l as useProjectDraft };

package/project/use-project-file-preview.d.ts

@@ -0,0 +1,47 @@
+import { DisplayAttachment } from '@epam/ai-dial-chat-shared';
+import { ProjectFileDownloadUrlResolver } from './project-file-preview';
+/** Tells whether the request that produced a result may still show it; `false` once a newer request superseded it. */
+export type ProjectPreviewCommitGuard = () => boolean;
+/** Opens an attachment in the host's canvas under a key, showing it only while the guard allows; the host's `openAttachmentCanvas` fits. */
+export type OpenProjectPreviewAttachment = (attachment: DisplayAttachment, canvasAttachmentId: string, shouldCommit: ProjectPreviewCommitGuard) => unknown;
+/** Host canvas operations and card lookups for the project file preview. */
+export interface UseProjectFilePreviewOptions {
+    /** Id of the project the page shows, or a fixed value before it exists; it keeps one file name in two projects apart. */
+    scope: string;
+    /** Id of the attachment the canvas holds now, or `undefined` when it is closed. */
+    attachmentId: string | undefined;
+    /** Opens an attachment in the canvas under a key. */
+    openAttachment: OpenProjectPreviewAttachment;
+    /** Closes the canvas. */
+    closeCanvas: () => void;
+    /** Starts a canvas request and returns the guard that says whether it is still the latest. */
+    startRequest: () => ProjectPreviewCommitGuard;
+    /** Returns the attachment to open for a context card id, or `undefined` for a card the page does not hold; it should keep its identity while the cards are unchanged. */
+    resolveContextAttachment: (cardId: string) => DisplayAttachment | undefined;
+    /** Returns the attachment to open for an output name; omit it where outputs are not shown. */
+    resolveOutputAttachment?: (name: string) => DisplayAttachment | undefined;
+    /** Resolves a stored file's locator to its download URL; when omitted, only files added in this session download. */
+    resolveDownloadUrl?: ProjectFileDownloadUrlResolver;
+}
+/** Selection state and stable card callbacks of the project file preview. */
+export interface UseProjectFilePreviewResult {
+    /** Card id of the open project file, an output's card id included, or `undefined` when none of this scope is open. */
+    selectedCardId: string | undefined;
+    /** Card id of the open context file; `undefined` while an output or nothing is open. */
+    selectedContextFileId: string | undefined;
+    /** Name of the open output; `undefined` while a context file or nothing is open. */
+    selectedOutputName: string | undefined;
+    /** Opens a context card, or closes the canvas when that card is already open. */
+    onContextFileClick: (cardId: string) => void;
+    /** Opens an output, or closes the canvas when that output is already open. */
+    onOutputClick: (name: string) => void;
+    /** Downloads a context card's file without opening it in the canvas. */
+    onContextFileDownload: (cardId: string) => void;
+    /** Closes the canvas when the open context card is no longer among the page's cards. */
+    closeIfRemoved: (cards: readonly {
+        id: string;
+    }[]) => void;
+}
+/** Opens project files in the host's attachment canvas for the New project, Edit project and project view pages, deriving the selected card from the canvas. */
+export declare const useProjectFilePreview: ({ scope, attachmentId, openAttachment, closeCanvas, startRequest, resolveContextAttachment, resolveOutputAttachment, resolveDownloadUrl, }: UseProjectFilePreviewOptions) => UseProjectFilePreviewResult;
+//# sourceMappingURL=use-project-file-preview.d.ts.map

package/project/use-project-file-preview.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-project-file-preview.d.ts","sourceRoot":"","sources":["../../src/project/use-project-file-preview.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAC;AAEnE,OAAO,EAIL,KAAK,8BAA8B,EAGpC,MAAM,wBAAwB,CAAC;AAEhC,sHAAsH;AACtH,MAAM,MAAM,yBAAyB,GAAG,MAAM,OAAO,CAAC;AAEtD,4IAA4I;AAC5I,MAAM,MAAM,4BAA4B,GAAG,CACzC,UAAU,EAAE,iBAAiB,EAC7B,kBAAkB,EAAE,MAAM,EAC1B,YAAY,EAAE,yBAAyB,KACpC,OAAO,CAAC;AAEb,4EAA4E;AAC5E,MAAM,WAAW,4BAA4B;IAC3C,yHAAyH;IACzH,KAAK,EAAE,MAAM,CAAC;IACd,mFAAmF;IACnF,YAAY,EAAE,MAAM,GAAG,SAAS,CAAC;IACjC,qDAAqD;IACrD,cAAc,EAAE,4BAA4B,CAAC;IAC7C,yBAAyB;IACzB,WAAW,EAAE,MAAM,IAAI,CAAC;IACxB,8FAA8F;IAC9F,YAAY,EAAE,MAAM,yBAAyB,CAAC;IAC9C,yKAAyK;IACzK,wBAAwB,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,iBAAiB,GAAG,SAAS,CAAC;IAC5E,8FAA8F;IAC9F,uBAAuB,CAAC,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,iBAAiB,GAAG,SAAS,CAAC;IAC1E,qHAAqH;IACrH,kBAAkB,CAAC,EAAE,8BAA8B,CAAC;CACrD;AAED,6EAA6E;AAC7E,MAAM,WAAW,2BAA2B;IAC1C,sHAAsH;IACtH,cAAc,EAAE,MAAM,GAAG,SAAS,CAAC;IACnC,wFAAwF;IACxF,qBAAqB,EAAE,MAAM,GAAG,SAAS,CAAC;IAC1C,oFAAoF;IACpF,kBAAkB,EAAE,MAAM,GAAG,SAAS,CAAC;IACvC,iFAAiF;IACjF,kBAAkB,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;IAC7C,8EAA8E;IAC9E,aAAa,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;IACtC,wEAAwE;IACxE,qBAAqB,EAAE,CAAC,MAAM,EAAE,MAAM,KAAK,IAAI,CAAC;IAChD,wFAAwF;IACxF,cAAc,EAAE,CAAC,KAAK,EAAE,SAAS;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,EAAE,KAAK,IAAI,CAAC;CAC5D;AAED,gKAAgK;AAChK,eAAO,MAAM,qBAAqB,GAAI,4IASnC,4BAA4B,KAAG,2BAuFjC,CAAC"}

package/project/use-project-file-preview.js

@@ -0,0 +1,50 @@
+import { downloadProjectFileAttachment as e, fromProjectOutputCardId as t, fromProjectPreviewKey as n, toProjectOutputCardId as r, toProjectPreviewKey as i } from "./project-file-preview.js";
+import { useCallback as a } from "react";
+//#region src/project/use-project-file-preview.ts
+var o = ({ scope: o, attachmentId: s, openAttachment: c, closeCanvas: l, startRequest: u, resolveContextAttachment: d, resolveOutputAttachment: f, resolveDownloadUrl: p }) => {
+	let m = n(o, s), h = t(m), g = h == null ? m : void 0;
+	return {
+		selectedCardId: m,
+		selectedContextFileId: g,
+		selectedOutputName: h,
+		onContextFileClick: a((e) => {
+			if (e === g) {
+				l();
+				return;
+			}
+			let t = d(e);
+			t && c(t, i(o, e), u());
+		}, [
+			l,
+			c,
+			d,
+			o,
+			g,
+			u
+		]),
+		onOutputClick: a((e) => {
+			if (e === h) {
+				l();
+				return;
+			}
+			let t = f?.(e);
+			t && c(t, i(o, r(e)), u());
+		}, [
+			l,
+			c,
+			f,
+			o,
+			h,
+			u
+		]),
+		onContextFileDownload: a((t) => {
+			let n = d(t);
+			n && e(n, p);
+		}, [d, p]),
+		closeIfRemoved: a((e) => {
+			g != null && !e.some((e) => e.id === g) && l();
+		}, [l, g])
+	};
+};
+//#endregion
+export { o as useProjectFilePreview };