@epam/ai-dial-publish-panel 1.1.0-dev.55

package/models/publish.d.ts

@@ -0,0 +1,90 @@
+/** A single folder in the "publish to folder" destination tree. */
+export interface PublishFolderNode {
+    /** Full path segments to this folder, outermost first. Also serves as the unique key. */
+    path: string[];
+    /** Display name of this folder (its last path segment). */
+    name: string;
+    /** Child folders, if any. */
+    children?: PublishFolderNode[];
+}
+/**
+ * A previously published version of a catalog entity, or a previous
+ * publication of an unversioned resource (e.g. a conversation).
+ */
+export interface PublishHistoryEntry {
+    /**
+     * Semantic version string, e.g. "4.0.0". `undefined` for unversioned
+     * resources (e.g. a conversation), where a folder having any entry at all
+     * already means "already published here" — see `usePublishFlow`.
+     */
+    version?: string;
+    /** Unix timestamp (ms) when this version was published. */
+    publishedAt: number;
+    /** Display name of the user who published this version. */
+    publishedBy: string;
+    /** Folder path segments this version was published to, outermost first. */
+    folderPath: string[];
+}
+/**
+ * Minimal display data for the Publish flow's entity-summary row and for
+ * version-derived behavior (the replace-warning callout, the publish-history
+ * section's visibility), covering both versioned entities and unversioned
+ * resources (e.g. a conversation). `PublishPanel` renders a title-only row
+ * from this by default; a host needing a richer summary (icon, type badge)
+ * passes `renderSummary` alongside this instead.
+ */
+export interface PublishResourceSummary {
+    /** Display title/name shown in the summary row. */
+    title: string;
+    /** Icon URL, if any. */
+    iconUrl?: string;
+    /** Version, when the resource is versioned. `undefined` for conversations. */
+    version?: string;
+}
+/** Which callout (if any) the publish panel should show below the folder picker. */
+export declare enum PublishCalloutKind {
+    /** No callout — no folder selected, or a request is in flight. */
+    None = "none",
+    /** Informational callout describing who gets access once published. */
+    Info = "info",
+    /** Warning callout — publishing will replace an existing version in this folder. */
+    ReplaceWarning = "replaceWarning",
+    /** Error callout — the user lacks write access to the selected folder. */
+    NoAccess = "noAccess",
+    /** Error callout — the most recent submit attempt failed. */
+    SubmitError = "submitError"
+}
+/** Inputs used to derive the publish panel's callout and submit-button state. */
+export interface PublishDerivationInput {
+    /** Whether a destination folder is currently selected. */
+    hasSelectedFolder: boolean;
+    /**
+     * Whether the selected folder already has this publication — this exact
+     * version, for a versioned catalog entity, or any prior publication at
+     * all, for an unversioned resource (e.g. a conversation).
+     */
+    hasExistingPublicationInFolder: boolean;
+    /** Whether the current user can publish to the selected folder. */
+    hasWriteAccess: boolean;
+    /** Whether a publish request is currently in flight. */
+    isSubmitting: boolean;
+    /** Whether the most recent submit attempt failed. */
+    hasSubmitError: boolean;
+    /**
+     * Whether resubmitting when `hasExistingPublicationInFolder` is true is
+     * allowed (catalog: republishing replaces the existing version) or
+     * blocked entirely (conversations have no update/replace semantics —
+     * publishing again to the same folder is not supported). Default `true`.
+     */
+    allowReplace?: boolean;
+}
+/** Derived, render-ready state for the publish panel. */
+export interface PublishDerivedState {
+    /** Which callout (if any) to show below the folder picker. */
+    calloutKind: PublishCalloutKind;
+    /** Whether the submit button is disabled. */
+    isSubmitDisabled: boolean;
+    /** Whether the submit button should show its loading/spinner state. */
+    isSubmitLoading: boolean;
+}
+//# sourceMappingURL=publish.d.ts.map

package/models/publish.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"publish.d.ts","sourceRoot":"","sources":["../../src/models/publish.ts"],"names":[],"mappings":"AAAA,mEAAmE;AACnE,MAAM,WAAW,iBAAiB;IAChC,yFAAyF;IACzF,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,2DAA2D;IAC3D,IAAI,EAAE,MAAM,CAAC;IACb,6BAA6B;IAC7B,QAAQ,CAAC,EAAE,iBAAiB,EAAE,CAAC;CAChC;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;;OAIG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,2DAA2D;IAC3D,WAAW,EAAE,MAAM,CAAC;IACpB,2DAA2D;IAC3D,WAAW,EAAE,MAAM,CAAC;IACpB,2EAA2E;IAC3E,UAAU,EAAE,MAAM,EAAE,CAAC;CACtB;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,sBAAsB;IACrC,mDAAmD;IACnD,KAAK,EAAE,MAAM,CAAC;IACd,wBAAwB;IACxB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,8EAA8E;IAC9E,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,oFAAoF;AACpF,oBAAY,kBAAkB;IAC5B,kEAAkE;IAClE,IAAI,SAAS;IACb,uEAAuE;IACvE,IAAI,SAAS;IACb,oFAAoF;IACpF,cAAc,mBAAmB;IACjC,0EAA0E;IAC1E,QAAQ,aAAa;IACrB,6DAA6D;IAC7D,WAAW,gBAAgB;CAC5B;AAED,iFAAiF;AACjF,MAAM,WAAW,sBAAsB;IACrC,0DAA0D;IAC1D,iBAAiB,EAAE,OAAO,CAAC;IAC3B;;;;OAIG;IACH,8BAA8B,EAAE,OAAO,CAAC;IACxC,mEAAmE;IACnE,cAAc,EAAE,OAAO,CAAC;IACxB,wDAAwD;IACxD,YAAY,EAAE,OAAO,CAAC;IACtB,qDAAqD;IACrD,cAAc,EAAE,OAAO,CAAC;IACxB;;;;;OAKG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAED,yDAAyD;AACzD,MAAM,WAAW,mBAAmB;IAClC,8DAA8D;IAC9D,WAAW,EAAE,kBAAkB,CAAC;IAChC,6CAA6C;IAC7C,gBAAgB,EAAE,OAAO,CAAC;IAC1B,uEAAuE;IACvE,eAAe,EAAE,OAAO,CAAC;CAC1B"}

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@epam/ai-dial-publish-panel",
+  "description": "Publish-to-folder UI and state flow shared by catalog entity publish and conversation publish",
+  "version": "1.1.0-dev.55",
+  "license": "Apache-2.0",
+  "type": "module",
+  "main": "./index.js",
+  "module": "./index.js",
+  "types": "./index.d.ts",
+  "exports": {
+    "./package.json": "./package.json",
+    "./styles.css": "./style.css",
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./index.js",
+      "default": "./index.js"
+    }
+  },
+  "peerDependencies": {
+    "react": "^19.0.0",
+    "@tabler/icons-react": "^3.0.0",
+    "@epam/ai-dial-kit": "1.1.0-dev.55",
+    "@epam/ai-dial-sidebar": "1.1.0-dev.55",
+    "@epam/ai-dial-chat-shared": "1.1.0-dev.55",
+    "@epam/ai-dial-ui-kit": "^0.13.0-dev.17"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/epam/ai-dial-chat.git",
+    "directory": "libs/publish-panel"
+  }
+}

package/test-setup.d.ts

@@ -0,0 +1 @@
+//# sourceMappingURL=test-setup.d.ts.map

package/test-setup.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-setup.d.ts","sourceRoot":"","sources":["../src/test-setup.ts"],"names":[],"mappings":""}

package/utils/format-published-date.d.ts

@@ -0,0 +1,8 @@
+/**
+ * Formats a publish timestamp for display: a relative phrase ("Today",
+ * "Yesterday", "N days ago") within the last week, and an exact date
+ * (e.g. "Nov 20, 2024") once it's a week old or more. The exact date uses
+ * `locale` (default: the browser/runtime locale) rather than a fixed one.
+ */
+export declare const formatPublishedDate: (publishedAt: number, now?: number, locale?: string) => string;
+//# sourceMappingURL=format-published-date.d.ts.map

package/utils/format-published-date.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"format-published-date.d.ts","sourceRoot":"","sources":["../../src/utils/format-published-date.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,eAAO,MAAM,mBAAmB,GAC9B,aAAa,MAAM,EACnB,MAAK,MAAmB,EACxB,SAAS,MAAM,KACd,MAkBF,CAAC"}

package/utils/publish-folder-tree.d.ts

@@ -0,0 +1,32 @@
+import { DialFile } from '@epam/ai-dial-ui-kit';
+import { PublishFolderNode } from '../models/publish';
+/**
+ * Returns the subset of `items` whose name matches `query`, or that contain a
+ * descendant whose name matches. Matched branches keep only their matching
+ * descendants. Matching is case-insensitive substring matching.
+ */
+export declare const filterFolderTree: (items: PublishFolderNode[], query: string) => PublishFolderNode[];
+/** Returns every folder path (joined by "/") in `items`, recursively. */
+export declare const collectFolderKeys: (items: PublishFolderNode[]) => string[];
+/** Joins folder path segments into the string path key used by `DialFile`/`DialFoldersTree`. */
+export declare const toFolderPathKey: (path: string[]) => string;
+/** Splits a `DialFile`/`DialFoldersTree` string path back into folder path segments. */
+export declare const fromFolderPathKey: (pathKey: string) => string[];
+/** Converts `PublishFolderNode[]` to the `DialFile[]` shape `DialFoldersTree` requires. */
+export declare const toDialFileTree: (items: PublishFolderNode[]) => DialFile[];
+/** Error messages returned by {@link validateFolderName} for each rejection reason. */
+export interface FolderNameValidationMessages {
+    /** Shown when the trimmed name is empty. */
+    empty: string;
+    /** Shown when the name contains `..` or a forbidden character. */
+    invalid: string;
+    /** Shown when a sibling folder already has this name (case-insensitive). */
+    duplicate: string;
+}
+/** Returns an error message from `messages`, or `null` when `rawValue` is a valid non-duplicate folder name for the publish destination tree. */
+export declare const validateFolderName: (rawValue: string, siblingNames: string[], messages: FolderNameValidationMessages) => string | null;
+/** Returns `baseName` if no sibling already has that name, otherwise appends a number suffix (`2`, `3`, …) until the name is free. */
+export declare const getUniqueFolderName: (baseName: string, siblingNames: string[]) => string;
+/** Names of the direct children of the folder at `parentPath` (root siblings when empty). */
+export declare const getSiblingFolderNames: (items: PublishFolderNode[], parentPath: string[]) => string[];
+//# sourceMappingURL=publish-folder-tree.d.ts.map

package/utils/publish-folder-tree.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"publish-folder-tree.d.ts","sourceRoot":"","sources":["../../src/utils/publish-folder-tree.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAoB,MAAM,sBAAsB,CAAC;AAClE,OAAO,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAC;AAEtD;;;;GAIG;AACH,eAAO,MAAM,gBAAgB,GAC3B,OAAO,iBAAiB,EAAE,EAC1B,OAAO,MAAM,KACZ,iBAAiB,EAoBnB,CAAC;AAEF,yEAAyE;AACzE,eAAO,MAAM,iBAAiB,GAAI,OAAO,iBAAiB,EAAE,KAAG,MAAM,EAIjE,CAAC;AAEL,gGAAgG;AAChG,eAAO,MAAM,eAAe,GAAI,MAAM,MAAM,EAAE,KAAG,MAAwB,CAAC;AAE1E,wFAAwF;AACxF,eAAO,MAAM,iBAAiB,GAAI,SAAS,MAAM,KAAG,MAAM,EACtB,CAAC;AAErC,2FAA2F;AAC3F,eAAO,MAAM,cAAc,GAAI,OAAO,iBAAiB,EAAE,KAAG,QAAQ,EAUhE,CAAC;AAKL,uFAAuF;AACvF,MAAM,WAAW,4BAA4B;IAC3C,4CAA4C;IAC5C,KAAK,EAAE,MAAM,CAAC;IACd,kEAAkE;IAClE,OAAO,EAAE,MAAM,CAAC;IAChB,4EAA4E;IAC5E,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,iJAAiJ;AACjJ,eAAO,MAAM,kBAAkB,GAC7B,UAAU,MAAM,EAChB,cAAc,MAAM,EAAE,EACtB,UAAU,4BAA4B,KACrC,MAAM,GAAG,IAcX,CAAC;AAEF,sIAAsI;AACtI,eAAO,MAAM,mBAAmB,GAC9B,UAAU,MAAM,EAChB,cAAc,MAAM,EAAE,KACrB,MAYF,CAAC;AAEF,6FAA6F;AAC7F,eAAO,MAAM,qBAAqB,GAChC,OAAO,iBAAiB,EAAE,EAC1B,YAAY,MAAM,EAAE,KACnB,MAAM,EAoBR,CAAC"}

package/utils/publish-state.d.ts

@@ -0,0 +1,4 @@
+import { PublishDerivationInput, PublishDerivedState } from '../models/publish';
+/** Derives the callout kind and submit-button state for the publish panel from the current folder context. */
+export declare const derivePublishState: (input: PublishDerivationInput) => PublishDerivedState;
+//# sourceMappingURL=publish-state.d.ts.map

package/utils/publish-state.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"publish-state.d.ts","sourceRoot":"","sources":["../../src/utils/publish-state.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,sBAAsB,EACtB,mBAAmB,EACpB,MAAM,mBAAmB,CAAC;AAE3B,8GAA8G;AAC9G,eAAO,MAAM,kBAAkB,GAC7B,OAAO,sBAAsB,KAC5B,mBA8CF,CAAC"}

package/utils/use-publish-flow.d.ts

@@ -0,0 +1,70 @@
+import { PublishFolderNode, PublishHistoryEntry } from '../models/publish';
+/** An item publishable through {@link usePublishFlow} — versioned or not (e.g. a conversation). */
+export interface PublishFlowItem {
+    /** Version, when the item is versioned. `undefined` for unversioned resources. */
+    version?: string;
+}
+/** Options for {@link usePublishFlow}. */
+export interface UsePublishFlowOptions<TItem extends PublishFlowItem> {
+    /** The item being published — versioned, or an unversioned resource (e.g. a conversation). */
+    item: TItem;
+    /** Previously published entries for this item. */
+    history: PublishHistoryEntry[];
+    /** Root-level destination folder nodes, as currently known to the host. */
+    folderItems: PublishFolderNode[];
+    /**
+     * Resolves whether the current user can publish to a given folder path.
+     * Defaults to always allowing (`() => true`) when omitted.
+     */
+    hasWriteAccess?: (folderPath: string[]) => boolean;
+    /**
+     * Called when the user confirms a new folder name. The host owns
+     * persisting the folder; the hook also adds it locally so it is
+     * immediately selectable within this session. If the returned promise
+     * rejects, the optimistically added folder is rolled back and the submit-
+     * error callout is surfaced.
+     */
+    onCreateFolder?: (parentPath: string[], name: string) => void | Promise<void>;
+    /** Called with the destination folder path when the user confirms publish/update. */
+    onPublish: (item: TItem, folderPath: string[]) => Promise<void>;
+    /** Called after a successful publish; the host surfaces its own success notification. */
+    onPublishSuccess?: (item: TItem, folderPath: string[]) => void;
+}
+/** State and handlers returned by {@link usePublishFlow}. */
+export interface UsePublishFlowResult {
+    /** Folder tree, including any folders created (but not yet persisted) during this session. */
+    folderItems: PublishFolderNode[];
+    /**
+     * Currently selected destination folder path. `undefined` means nothing
+     * is selected; `[]` means the bucket root itself is selected (a distinct,
+     * valid destination).
+     */
+    selectedFolderPath?: string[];
+    /** Selects a destination folder or the root (`[]`); pass `undefined` to deselect. */
+    setSelectedFolderPath: (path: string[] | undefined) => void;
+    /** Confirms a new folder name: adds it locally and reports it to the host, rolling back and surfacing an error if the host rejects. */
+    handleCreateFolder: (parentPath: string[], name: string) => Promise<void>;
+    /**
+     * Whether `selectedFolderPath` already has this publication — this exact
+     * version, for a versioned item, or any prior entry at all, for an
+     * unversioned item (whose `version` is `undefined`).
+     */
+    hasExistingPublicationInFolder: boolean;
+    /** Whether the current user can publish to `selectedFolderPath`. */
+    hasWriteAccess: boolean;
+    /** Whether a publish request is currently in flight. */
+    isSubmitting: boolean;
+    /** Whether the most recent submit attempt failed. */
+    hasSubmitError: boolean;
+    /**
+     * Submits the publish/update request for the selected folder. Resolves to
+     * `true` on success and `false` if `onPublish` rejected, so the caller can
+     * decide whether to close the flow.
+     */
+    handleSubmit: () => Promise<boolean>;
+    /** Resets folder selection, any locally-created folders, and the submit error back to their initial state. */
+    reset: () => void;
+}
+/** Manages all state for the Publish flow: folder selection, local folder creation, existing-publication detection, and submit handling. */
+export declare const usePublishFlow: <TItem extends PublishFlowItem = PublishFlowItem>({ item, history, folderItems: initialFolderItems, hasWriteAccess: resolveWriteAccess, onCreateFolder, onPublish, onPublishSuccess, }: UsePublishFlowOptions<TItem>) => UsePublishFlowResult;
+//# sourceMappingURL=use-publish-flow.d.ts.map

package/utils/use-publish-flow.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"use-publish-flow.d.ts","sourceRoot":"","sources":["../../src/utils/use-publish-flow.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AAE3E,mGAAmG;AACnG,MAAM,WAAW,eAAe;IAC9B,kFAAkF;IAClF,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AA2DD,0CAA0C;AAC1C,MAAM,WAAW,qBAAqB,CAAC,KAAK,SAAS,eAAe;IAClE,8FAA8F;IAC9F,IAAI,EAAE,KAAK,CAAC;IACZ,kDAAkD;IAClD,OAAO,EAAE,mBAAmB,EAAE,CAAC;IAC/B,2EAA2E;IAC3E,WAAW,EAAE,iBAAiB,EAAE,CAAC;IACjC;;;OAGG;IACH,cAAc,CAAC,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,KAAK,OAAO,CAAC;IACnD;;;;;;OAMG;IACH,cAAc,CAAC,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,MAAM,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC9E,qFAAqF;IACrF,SAAS,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAChE,yFAAyF;IACzF,gBAAgB,CAAC,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,KAAK,IAAI,CAAC;CAChE;AAED,6DAA6D;AAC7D,MAAM,WAAW,oBAAoB;IACnC,8FAA8F;IAC9F,WAAW,EAAE,iBAAiB,EAAE,CAAC;IACjC;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,EAAE,CAAC;IAC9B,qFAAqF;IACrF,qBAAqB,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,GAAG,SAAS,KAAK,IAAI,CAAC;IAC5D,uIAAuI;IACvI,kBAAkB,EAAE,CAAC,UAAU,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1E;;;;OAIG;IACH,8BAA8B,EAAE,OAAO,CAAC;IACxC,oEAAoE;IACpE,cAAc,EAAE,OAAO,CAAC;IACxB,wDAAwD;IACxD,YAAY,EAAE,OAAO,CAAC;IACtB,qDAAqD;IACrD,cAAc,EAAE,OAAO,CAAC;IACxB;;;;OAIG;IACH,YAAY,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,CAAC;IACrC,8GAA8G;IAC9G,KAAK,EAAE,MAAM,IAAI,CAAC;CACnB;AAED,4IAA4I;AAC5I,eAAO,MAAM,cAAc,GACzB,KAAK,SAAS,eAAe,GAAG,eAAe,EAC/C,sIAQC,qBAAqB,CAAC,KAAK,CAAC,KAAG,oBAyEjC,CAAC"}