@ai-matrx/design-system 0.17.4 → 0.18.1

package/dist/content-transfer.d.ts

@@ -0,0 +1,208 @@
+import * as React from 'react';
+import { AgentPayloadInput, TransferOutcome, TransferCapabilities, Transport, PageAction, TransferPreferenceOverrides, Source, Payload, ExportProjection, Section, SurfaceHandle, TransferScope } from '@ai-matrx/kit/content-transfer';
+export { ALCHEMY_GLYPH_SVG } from './content-transfer/icon.js';
+
+type AlchemyOptionValues = Record<string, boolean | number>;
+type AlchemySourceOption = {
+    kind: "toggle";
+    key: string;
+    label: string;
+    hint?: string;
+    default: boolean;
+} | {
+    kind: "preset";
+    key: string;
+    label: string;
+    options: {
+        label: string;
+        value: number;
+    }[];
+    default: number;
+} | {
+    kind: "slider";
+    key: string;
+    label: string;
+    hint?: string;
+    stops: number[];
+    default: number;
+    formatValue: (value: number) => string;
+} | {
+    kind: "number";
+    key: string;
+    label: string;
+    hint?: string;
+    min?: number;
+    step?: number;
+    presets?: {
+        label: string;
+        value: number;
+    }[];
+    default: number;
+};
+interface AlchemyCustomSource {
+    label?: string;
+    hint?: string;
+    options: AlchemySourceOption[];
+    build(values: AlchemyOptionValues): {
+        text: string;
+        meta?: Record<string, string | number | boolean | undefined>;
+    };
+    wrap(text: string, values: AlchemyOptionValues, meta?: Record<string, string | number | boolean | undefined>): AgentPayloadInput;
+    dialogTitle?: string;
+    dialogDescription?: string;
+}
+type AlchemyDetail = "full" | "compact" | "brief";
+interface AlchemyGroomerSection {
+    id: string;
+    title: string;
+    description?: string;
+    cuttable?: boolean;
+    levelLabels?: Partial<Record<AlchemyDetail, string>>;
+    build(level: AlchemyDetail): unknown;
+    defaultSelection?: AlchemyDetail | "off";
+}
+interface AlchemyGroomerConfig {
+    label: string;
+    kind: string;
+    location: string;
+    description: string;
+    attributes?: AgentPayloadInput["attributes"];
+    context?: AgentPayloadInput["context"];
+    summary?: string;
+    sections: AlchemyGroomerSection[];
+}
+interface AlchemyCopyVariant {
+    id: string;
+    label: string;
+    hint?: string;
+    icon?: React.ComponentType<{
+        className?: string;
+    }>;
+    section?: "copy" | "ai";
+    ariaLabel?: string;
+    successMessage?: string;
+    build?: () => AgentPayloadInput | string | Promise<AgentPayloadInput | string>;
+    onSelect?: () => void | Promise<void>;
+    modal?: (props: {
+        open: boolean;
+        onOpenChange: (open: boolean) => void;
+    }) => React.ReactNode;
+}
+interface AlchemyExportItem {
+    id: string;
+    label: string;
+    build?: () => {
+        content: BlobPart;
+        extension: string;
+        mime: string;
+    };
+    onSelect?: () => void | Promise<void>;
+}
+type Resolvable<T> = T | (() => T);
+interface MatrxCopyMenuProps {
+    label: string;
+    /** Stable record identity when this mounted control can switch between records. */
+    sourceId?: string;
+    human?: Resolvable<string>;
+    json?: Resolvable<unknown>;
+    agent?: Resolvable<AgentPayloadInput | string>;
+    aiVariants?: AlchemyCopyVariant[];
+    aiCustom?: AlchemyCustomSource;
+    groomer?: () => AlchemyGroomerConfig;
+    agentVariant?: {
+        id?: string;
+        label?: string;
+        hint?: string;
+        position?: "first" | "last";
+    };
+    export?: {
+        items: AlchemyExportItem[];
+        sheetRows?: () => Array<Record<string, unknown>>;
+    };
+    /** Host-owned authenticated destination, not a second export serializer. */
+    sendToSheet?: (rows: Array<Record<string, unknown>>, label: string) => Promise<TransferOutcome>;
+    hide?: Array<"copy" | "ai" | "export">;
+    disabled?: boolean;
+    className?: string;
+    stopPropagation?: boolean;
+    size?: "xs" | "icon" | "sm";
+    appearance?: "bare" | "segmented";
+    unified?: boolean;
+    grouped?: boolean;
+}
+/** Opinionated bridge for Matrx's existing content builders, with one transfer UI. */
+declare function MatrxCopyMenu(props: MatrxCopyMenuProps): React.JSX.Element;
+type AlchemyGroomerPreset = "everything" | "balanced" | "minimal";
+declare const GROOMER_LEVELS: AlchemyDetail[];
+declare function applyGroomerPreset(preset: AlchemyGroomerPreset, sections: AlchemyGroomerSection[]): Record<string, AlchemyDetail | "off">;
+declare function defaultGroomerSelections(sections: AlchemyGroomerSection[]): Record<string, AlchemyDetail | "off">;
+declare function buildGroomerPresetPayload(config: AlchemyGroomerConfig, preset: AlchemyGroomerPreset): AgentPayloadInput;
+declare function groomerPresetVariants(getConfig: () => AlchemyGroomerConfig): AlchemyCopyVariant[];
+
+declare function AlchemyGlyph(props: React.SVGAttributes<SVGSVGElement>): React.JSX.Element;
+type ContentTransferCapabilities = TransferCapabilities & {
+    transport?: Transport;
+    actions?: PageAction[];
+    preferences?: TransferPreferenceOverrides;
+    onOutcome?: (outcome: TransferOutcome) => void;
+};
+declare function ContentTransferCapabilitiesProvider({ value, children }: {
+    value: ContentTransferCapabilities;
+    children: React.ReactNode;
+}): React.JSX.Element;
+declare const useContentTransferCapabilities: () => ContentTransferCapabilities;
+declare function ContentTransferSurfaceProvider({ handle, children }: {
+    handle: SurfaceHandle;
+    children: React.ReactNode;
+}): React.JSX.Element;
+declare const useContentTransferSurface: () => SurfaceHandle | null;
+type SerializableFormat = "plain" | "markdown" | "html" | "json" | "compact-json" | "csv" | "tsv";
+interface TransferMenuPresentation {
+    hint?: string;
+    icon?: React.ComponentType<{
+        className?: string;
+    }>;
+    ariaLabel?: string;
+}
+interface TransferMenuVariant extends TransferMenuPresentation {
+    id: string;
+    label: string;
+    source: Source | Payload;
+    copyLabel?: string;
+    section?: "copy" | "ai";
+    successMessage?: string;
+}
+interface ContentTransferMenuProps {
+    source?: Payload | Source;
+    projection?: ExportProjection;
+    sections?: Section[];
+    preferences?: TransferPreferenceOverrides;
+    enabled?: boolean;
+    surface?: SurfaceHandle;
+    label?: string;
+    table?: {
+        availableScopes: TransferScope[];
+        initialScope: TransferScope;
+    };
+    /** A quick format may explicitly capture a different representation. */
+    formatSources?: Partial<Record<SerializableFormat, Source | Payload>>;
+    /** Named alternate sources open this same preparation workspace. */
+    variants?: readonly TransferMenuVariant[];
+    actions?: (PageAction & TransferMenuPresentation)[];
+    capabilities?: ContentTransferCapabilities;
+    disabled?: boolean;
+    className?: string;
+    stopPropagation?: boolean;
+    hide?: readonly ("copy" | "prepare" | "download")[];
+    controllerRef?: React.Ref<ContentTransferController>;
+}
+interface ContentTransferController {
+    focusTrigger(): void;
+    prepare(source: Source | Payload, options?: {
+        id?: string;
+        label?: string;
+    }): Promise<void>;
+}
+declare function ContentTransferMenu({ source, surface, label, projection, sections, preferences, table, formatSources, variants, actions, capabilities: local, disabled, enabled, className, stopPropagation, hide, controllerRef }: ContentTransferMenuProps): React.JSX.Element | null;
+
+export { type AlchemyCopyVariant, type AlchemyCustomSource, type AlchemyDetail, type AlchemyExportItem, AlchemyGlyph, type AlchemyGroomerConfig, type AlchemyGroomerPreset, type AlchemyGroomerSection, type AlchemyOptionValues, type AlchemySourceOption, type ContentTransferCapabilities, ContentTransferCapabilitiesProvider, type ContentTransferController, ContentTransferMenu, type ContentTransferMenuProps, ContentTransferSurfaceProvider, GROOMER_LEVELS, MatrxCopyMenu, type MatrxCopyMenuProps, type SerializableFormat, type TransferMenuPresentation, type TransferMenuVariant, applyGroomerPreset, buildGroomerPresetPayload, defaultGroomerSelections, groomerPresetVariants, useContentTransferCapabilities, useContentTransferSurface };