@echothink-ui/documents 0.1.0

package/README.md

@@ -0,0 +1,5 @@
+# @echothink-ui/documents
+
+Documents package for EchoThink app-domain websites.
+
+This package is part of the EchoThink-UI app-domain library. It is designed for normal website app domains rendered inside EchoThink Studio's Chromium shell, not for implementing the studio browser chrome itself.

package/dist/components/AgentLockedDocumentPanel.d.ts

@@ -0,0 +1,10 @@
+import type { DocumentComponentBaseProps, DocumentOwner, DocumentPendingChange, DocumentReference } from "./types";
+export interface AgentLockedDocumentPanelProps extends Omit<DocumentComponentBaseProps<HTMLElement>, "children" | "title"> {
+    documentRef: DocumentReference;
+    lockOwner?: DocumentOwner;
+    pendingChanges?: DocumentPendingChange[];
+    onTakeover?: () => void;
+    onRelease?: () => void;
+    onReviewChanges?: () => void;
+}
+export declare function AgentLockedDocumentPanel({ documentRef, lockOwner, pendingChanges, onTakeover, onRelease, onReviewChanges, density, className, ...props }: AgentLockedDocumentPanelProps): import("react/jsx-runtime").JSX.Element;

package/dist/components/DocumentEditorShell.d.ts

@@ -0,0 +1,14 @@
+import * as React from "react";
+import type { DocumentComponentBaseProps, DocumentLockState, DocumentMode, DocumentOwner, DocumentReference } from "./types";
+export interface DocumentEditorShellProps extends Omit<DocumentComponentBaseProps<HTMLElement>, "children"> {
+    title: React.ReactNode;
+    documentRef: DocumentReference;
+    mode?: DocumentMode;
+    lockState?: DocumentLockState;
+    lockOwner?: DocumentOwner;
+    toolbar?: React.ReactNode;
+    outline?: React.ReactNode;
+    inspector?: React.ReactNode;
+    children: React.ReactNode;
+}
+export declare function DocumentEditorShell({ title, documentRef, mode, lockState, lockOwner, toolbar, outline, inspector, children, density, className, ...props }: DocumentEditorShellProps): import("react/jsx-runtime").JSX.Element;

package/dist/components/DocumentLockBadge.d.ts

@@ -0,0 +1,7 @@
+import type { DocumentComponentBaseProps, DocumentLockState, DocumentOwner } from "./types";
+export interface DocumentLockBadgeProps extends Omit<DocumentComponentBaseProps<HTMLSpanElement>, "title"> {
+    lockState: DocumentLockState;
+    owner?: DocumentOwner;
+    since?: string;
+}
+export declare function DocumentLockBadge({ lockState, owner, since, density, className, ...props }: DocumentLockBadgeProps): import("react/jsx-runtime").JSX.Element;

package/dist/components/DocumentOutline.d.ts

@@ -0,0 +1,7 @@
+import type { DocumentComponentBaseProps, DocumentHeading } from "./types";
+export interface DocumentOutlineProps extends Omit<DocumentComponentBaseProps<HTMLElement>, "children" | "title"> {
+    headings: DocumentHeading[];
+    activeHeadingId?: string;
+    onSelect?: (id: string) => void;
+}
+export declare function DocumentOutline({ headings, activeHeadingId, onSelect, className, "aria-label": ariaLabel, ...props }: DocumentOutlineProps): import("react/jsx-runtime").JSX.Element;

package/dist/components/DocumentToolbar.d.ts

@@ -0,0 +1,10 @@
+import { type EthAction, type EthDensity } from "@echothink-ui/core";
+import type { DocumentComponentBaseProps, DocumentMode } from "./types";
+export interface DocumentToolbarProps extends Omit<DocumentComponentBaseProps<HTMLDivElement>, "children" | "title"> {
+    actions: EthAction[];
+    formattingActions?: EthAction[];
+    mode?: DocumentMode;
+    onModeChange?: (mode: DocumentMode) => void;
+    density?: EthDensity;
+}
+export declare function DocumentToolbar({ actions, formattingActions, mode, onModeChange, density, className, ...props }: DocumentToolbarProps): import("react/jsx-runtime").JSX.Element;

package/dist/components/DocumentViewer.d.ts

@@ -0,0 +1,10 @@
+import * as React from "react";
+import type { DocumentAnnotation, DocumentComponentBaseProps, DocumentMetadataItem } from "./types";
+export interface DocumentViewerProps extends Omit<DocumentComponentBaseProps<HTMLElement>, "children"> {
+    title: React.ReactNode;
+    content: React.ReactNode;
+    metadata?: DocumentMetadataItem[];
+    versionRef?: React.ReactNode;
+    annotations?: DocumentAnnotation[];
+}
+export declare function DocumentViewer({ title, content, metadata, versionRef, annotations, className, ...props }: DocumentViewerProps): import("react/jsx-runtime").JSX.Element;

package/dist/components/DocumentWorkspaceTemplate.d.ts

@@ -0,0 +1,24 @@
+import * as React from "react";
+import { type EthAction } from "@echothink-ui/core";
+import type { DocumentAnnotation, DocumentComponentBaseProps, DocumentHeading, DocumentLockState, DocumentMetadataItem, DocumentMode, DocumentOwner, DocumentReference } from "./types";
+export interface DocumentWorkspaceTemplateProps extends Omit<DocumentComponentBaseProps<HTMLElement>, "children"> {
+    title: React.ReactNode;
+    documentRef: DocumentReference;
+    mode?: DocumentMode;
+    lockState?: DocumentLockState;
+    lockOwner?: DocumentOwner;
+    actions?: EthAction[];
+    formattingActions?: EthAction[];
+    onModeChange?: (mode: DocumentMode) => void;
+    headings?: DocumentHeading[];
+    activeHeadingId?: string;
+    onSelectHeading?: (id: string) => void;
+    inspector?: React.ReactNode;
+    toolbar?: React.ReactNode;
+    metadata?: DocumentMetadataItem[];
+    versionRef?: React.ReactNode;
+    annotations?: DocumentAnnotation[];
+    content?: React.ReactNode;
+    children?: React.ReactNode;
+}
+export declare function DocumentWorkspaceTemplate({ title, documentRef, mode, lockState, lockOwner, actions, formattingActions, onModeChange, headings, activeHeadingId, onSelectHeading, inspector, toolbar, metadata, versionRef, annotations, content, children, density, ...props }: DocumentWorkspaceTemplateProps): import("react/jsx-runtime").JSX.Element;

package/dist/components/types.d.ts

@@ -0,0 +1,46 @@
+import type * as React from "react";
+import type { EthAction, EthDensity } from "@echothink-ui/core";
+export type DocumentMode = "edit" | "review" | "view";
+export type DocumentLockState = "unlocked" | "locked-by-user" | "locked-by-agent" | "locked-by-other";
+export interface DocumentOwner {
+    id: string;
+    label: string;
+}
+export type DocumentReference = string | {
+    id: string;
+    label?: React.ReactNode;
+    href?: string;
+    kind?: string;
+    version?: string;
+};
+export interface DocumentMetadataItem {
+    label: React.ReactNode;
+    value: React.ReactNode;
+}
+export interface DocumentHeading {
+    id: string;
+    level: 1 | 2 | 3 | 4;
+    text: React.ReactNode;
+    href?: string;
+}
+export interface DocumentAnnotation {
+    id: string;
+    range?: string;
+    comment: React.ReactNode;
+    author: React.ReactNode;
+    createdAt: string;
+}
+export interface DocumentPendingChange {
+    id: string;
+    summary: React.ReactNode;
+    diffSnippet?: React.ReactNode;
+}
+export interface DocumentComponentBaseProps<T extends HTMLElement = HTMLElement> extends Omit<React.HTMLAttributes<T>, "title" | "content" | "onSelect"> {
+    title?: React.ReactNode;
+    density?: EthDensity;
+    "data-eth-component"?: string;
+}
+export interface DocumentToolbarActionGroup {
+    actions: EthAction[];
+    formattingActions?: EthAction[];
+}

package/dist/components/utils.d.ts

@@ -0,0 +1,9 @@
+import * as React from "react";
+import type { EthAction } from "@echothink-ui/core";
+import type { DocumentMode, DocumentReference } from "./types";
+export declare function cx(...classes: Array<string | false | null | undefined>): string;
+export declare function documentRefLabel(documentRef: DocumentReference): string | number | bigint | true | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | Promise<string | number | bigint | boolean | React.ReactPortal | React.ReactElement<unknown, string | React.JSXElementConstructor<any>> | Iterable<React.ReactNode> | null | undefined>;
+export declare function documentRefId(documentRef: DocumentReference): string;
+export declare function formatDateTime(value?: string): string;
+export declare function modeLabel(mode: DocumentMode): string;
+export declare function actionIcon(action: EthAction): import("react/jsx-runtime").JSX.Element;