@arbidocs/blocks 0.4.3 → 0.4.5

package/README.md

@@ -65,6 +65,8 @@ Every capability is its own entry, so a bundler only loads what you use:
 | `@arbidocs/blocks` | Light root: theme, primitives, chat, shell, auth, retrieval, agents, citations, collaboration, site blocks | none (zustand, dompurify) |
 | `/chat`, `/shell`, `/auth`, `/retrieval`, `/citations`, `/collaboration`, `/agents`, `/timeline`, `/site` | one capability each | none |
 | `/files`, `/facts` | document grid, facts table | `ag-grid-*` |
+| `/artifacts` | artifact editor, version bar, track changes | none |
+| `/artifacts/editor` | rich-text (markdown) editing surface | `@mdxeditor/editor` (optional peer) |
 | `/home`, `/workspaces` | dashboard, workspace cards and forms | `@dnd-kit/*` |
 | `/settings` | settings, billing, modals | `cmdk` |
 | `/connect` | demo/live connection layer | `@tanstack/react-query` |
@@ -112,6 +114,29 @@ const { isDockAvailable } = useChatSurface()
 ```
 
 Theme the user bubble with `--chat-user-bubble` and `--chat-user-bubble-foreground` (HSL triplets).
+## Edit an artifact, save versions, compare
+
+`/artifacts` is the surface for an AI-drafted document the user may edit: a toolbar (Edit, Cancel,
+Compare, Save as a new version), a version bar ("Version 2 of 3", a list, Compare with previous),
+and Word-style track changes between two versions with a per-change undo. It is presentational:
+state comes from `useArtifactSession` in `@arbidocs/react/artifacts`, and the editor and redline are
+slots.
+
+```tsx
+import { ArtifactEditor, ArtifactRedlineView } from '@arbidocs/blocks/artifacts'
+import { ArtifactMarkdownEditor } from '@arbidocs/blocks/artifacts/editor'
+import { renderArtifactMarkdown, useArtifactSession } from '@arbidocs/react/artifacts'
+import '@mdxeditor/editor/style.css'
+
+const s = useArtifactSession({ workspaceId, docId, onSaved: ({ docId: next }) => next && open(next) })
+<ArtifactEditor {...s.view} onOpenVersion={open} renderMarkdown={renderArtifactMarkdown}
+  editor={<ArtifactMarkdownEditor {...s.editorProps} />}
+  redline={<ArtifactRedlineView {...s.redlineProps} renderMarkdown={renderArtifactMarkdown} />} />
+```
+
+Every part takes `labels` and `testIds`; Mod+S saves while editing; touch targets are 44px. The
+editor needs `@mdxeditor/editor` (optional peer) and is heavy (mount it behind `lazy`) and needs the global `Prism` defined before it loads (`@lexical/code` reads it while it evaluates): in the module that lazily imports the editor, import first a side-effect module with `import Prism from 'prismjs'; globalThis.Prism = Prism`. A library cannot order that reliably across bundlers.
+See `examples/custom-ui/ArtifactPage.tsx` for a custom editing surface on in-memory data.
 
 ## Editorial site parts
 

package/dist/agents/definitions/AgentCreator.d.ts

@@ -52,6 +52,8 @@ export interface AgentCreatorLabels {
     workspaceAccess: string;
     workspaceAccessHint: string;
     workspaceAlready: string;
+    /** Accessible name of the revoke button next to an already-granted workspace. */
+    revokeWorkspace: (workspaceName: string) => string;
     noWorkspacesToGrant: string;
     name: string;
     nameHint: string;
@@ -94,8 +96,15 @@ export interface AgentCreatorProps {
         id: string;
         name: string;
     }>;
-    /** Workspaces the agent can already read: shown ticked and fixed (revoking is not available). */
+    /**
+     * Workspaces the agent can already read: shown ticked and fixed. Without `onRevokeWorkspace`
+     * they cannot be undone here; with it each gets a remove button.
+     */
     grantedWorkspaceIds?: string[];
+    /** Take back a granted workspace (the host revokes, then refreshes `grantedWorkspaceIds`). */
+    onRevokeWorkspace?: (workspaceId: string) => void;
+    /** The workspace whose revoke is in flight; its button is disabled. */
+    revokingWorkspaceId?: string;
     /** One-click avatar (or anything that sits beside the name). */
     avatar?: ReactNode | ((values: AgentCreatorValues) => ReactNode);
     types?: AgentTypeOption<string>[];
@@ -115,4 +124,4 @@ export interface AgentCreatorProps {
  * capabilities, a live sentence says what the agent can and cannot do, and the knobs (capability
  * toggles, model, type, avatar, pickers) are folded under Advanced.
  */
-export declare function AgentCreator({ open, onOpenChange, isEdit, agentName, capabilities, templates, models, workspaces, grantedWorkspaceIds, avatar, types, values: valuesProp, initialValues, onValuesChange, advanced, isSaving, onSubmit, labels, testId, }: AgentCreatorProps): import("react").JSX.Element;
+export declare function AgentCreator({ open, onOpenChange, isEdit, agentName, capabilities, templates, models, workspaces, grantedWorkspaceIds, onRevokeWorkspace, revokingWorkspaceId, avatar, types, values: valuesProp, initialValues, onValuesChange, advanced, isSaving, onSubmit, labels, testId, }: AgentCreatorProps): import("react").JSX.Element;

package/dist/agents/definitions/index.d.ts

@@ -2,3 +2,4 @@ export { AgentCard, DEFAULT_AGENT_CARD_LABELS, type AgentCardProps, type AgentCa
 export { AgentGallery, DEFAULT_AGENT_GALLERY_LABELS, type AgentGalleryProps, type AgentGalleryLabels, type AgentGalleryTestIds, } from './AgentGallery';
 export { CapabilityTile, CapabilityGrid, AgentTypeSelector, AgentAvatarField, DEFAULT_AGENT_TYPE_SELECTOR_LABELS, DEFAULT_AGENT_AVATAR_FIELD_LABELS, type AgentTypeSelectorLabels, type AgentAvatarFieldLabels, type AgentAvatarFieldTestIds, type CapabilityTileProps, type AgentTypeOption, type AgentTypeSelectorProps, type AgentAvatarFieldProps, } from './AgentEditorParts';
 export { AgentCreator, DEFAULT_AGENT_CREATOR_LABELS, deriveAgentName, isValidAgentName, summarizeCapabilities, summarizeAgent, type AgentCreatorProps, type AgentCreatorLabels, type AgentCreatorValues, type AgentCapability, type AgentTemplate, } from './AgentCreator';
+export { composePersona, stripPersonaPreamble, agentCreatorToConfigSection, agentConfigSectionToValues, } from './persona';

package/dist/agents/definitions/persona.d.ts

@@ -0,0 +1,16 @@
+import type { AgentCreatorValues } from './AgentCreator';
+/**
+ * The saved persona tells the agent its own name: "You are Reviewer, an AI agent. <description>".
+ * {@link stripPersonaPreamble} takes the preamble off again so the editor shows only what the user wrote.
+ */
+export declare function composePersona(name: string, description: string): string;
+/** The description the user wrote, without the preamble {@link composePersona} adds. */
+export declare function stripPersonaPreamble(persona: string): string;
+/**
+ * The `Agents` config section an {@link AgentCreatorValues} form stands for: the persona, the model
+ * when one is picked, and one boolean per capability key. Pass it as `sections.Agents` to
+ * `useSaveAgentConfig` from `@arbidocs/react`.
+ */
+export declare function agentCreatorToConfigSection(values: Pick<AgentCreatorValues, 'name' | 'persona' | 'modelName' | 'capabilities'>, capabilityKeys: string[]): Record<string, unknown>;
+/** The form values an existing agent's `Agents` config section opens as (edit mode). */
+export declare function agentConfigSectionToValues(section: Record<string, unknown> | undefined, capabilityKeys: string[]): Pick<AgentCreatorValues, 'persona' | 'modelName' | 'capabilities'>;