@shapesos/clay 0.10.0 → 0.12.0

package/dist/artifacts.d.ts

@@ -0,0 +1,89 @@
+import { e as ArtifactType, c as ArtifactService, b as ArtifactRecord, d as ArtifactServiceProps, j as TableArtifactRecord, f as ChartArtifactRecord } from './types-C5bFH4v3.js';
+export { A as ArtifactDataRow, a as ArtifactLabelsMap, B as BarChartConfig, C as ChartArtifactLabels, g as ChartConfig, h as ChartStats, D as DEFAULT_CHART_ARTIFACT_LABELS, i as DEFAULT_TABLE_ARTIFACT_LABELS, L as LineChartConfig, P as PieChartConfig, T as TableArtifactLabels, k as TableColumn, l as TableConfig, m as TableRow, n as TableStats, o as artifactTypes } from './types-C5bFH4v3.js';
+import { ReactNode } from 'react';
+export { C as ChartSeries, a as ChartVariant } from './types-B2aYk82c.js';
+
+/**
+ * Map of artifact services keyed by `artifact.type`.
+ *
+ * Adding a new artifact type = create a `*-service.ts` file (mirroring `block-services/`), then
+ * add one entry here. The block-level dispatcher (`ArtifactRefBlock`) consumes this map to
+ * render the concrete component; `artifactToClipboardText` consumes it for the clipboard contract.
+ */
+declare const ArtifactServices: Record<ArtifactType, ArtifactService>;
+/**
+ * Returns a clipboard-friendly string for an artifact, delegating to the registered service's
+ * `toClipboardText`. Falls back to `[Artifact: <title>]` when the artifact type has no registered
+ * service (unknown type) so copy never silently produces an empty string.
+ */
+declare function artifactToClipboardText(artifact: ArtifactRecord): string;
+
+/** Props for `ArtifactDownloadButton`. */
+interface ArtifactDownloadButtonProps {
+    /**
+     * URL to download the artifact's underlying bytes. The button is an `<a href download>` so the
+     * browser uses whatever filename the server supplies via `Content-Disposition`. No client-side
+     * filename invention.
+     *
+     * Renders nothing when the URL is not a safe `http(s):` scheme — guards against `javascript:` or
+     * `data:` URIs smuggled into `presignedUrl`.
+     */
+    href: string;
+    /**
+     * Tooltip text + `aria-label` for the button. Optional — defaults to `"Download CSV"` so direct
+     * consumers don't have to pass anything for the common case. Per-type artifact orchestrators
+     * (`<ChartArtifact>`, `<TableArtifact>`) pass a translated value via their own `labels` prop so
+     * the button reads in the user's language.
+     */
+    label?: string;
+    /**
+     * Optional callback fired on click — runs alongside the browser's native download navigation
+     * (no `preventDefault`). Used for analytics / observability hooks; per-type artifact
+     * orchestrators wire this from their `callbacks` prop.
+     */
+    onClick?: () => void;
+}
+/**
+ * Reusable download button for artifact headers. Anchor-based so the browser handles the download
+ * natively (respects `Content-Disposition`, falls back to URL basename). `rel="noopener noreferrer"`
+ * defends against `window.opener` leakage if the browser opens the URL instead of downloading.
+ *
+ * Drop this inside `<ArtifactActions>` in any per-type artifact orchestrator.
+ */
+declare function ArtifactDownloadButton({ href, label, onClick, }: ArtifactDownloadButtonProps): ReactNode;
+/**
+ * Returns `true` only for `http:` and `https:` URLs. Rejects `javascript:`, `data:`, and any
+ * other scheme that could execute code on click.
+ */
+declare function isSafeDownloadUrl(url: string): boolean;
+
+/**
+ * Orchestrator for the `table`-typed artifact.
+ *
+ * Composes the ai-elements chrome primitives (`Artifact`, `ArtifactHeader`, `ArtifactTitle`,
+ * `ArtifactActions`, `ArtifactContent`) directly around the table body (`TableArtifactContent`).
+ * Download is handled via `ArtifactDownloadButton` — a shared utility component that applies the
+ * safe-URL guard and renders nothing for non-http(s) schemes.
+ */
+declare function TableArtifact({ artifact, labels, callbacks }: ArtifactServiceProps<TableArtifactRecord>): ReactNode;
+
+/**
+ * Orchestrator for the `CHART`-typed artifact.
+ *
+ * Composes the ai-elements chrome primitives (`Artifact`, `ArtifactHeader`, `ArtifactTitle`,
+ * `ArtifactActions`, `ArtifactContent`) directly around the chart body (`ChartArtifactContent`),
+ * matching `TableArtifact`'s shape. Loading / error / unavailable / empty states render an inline
+ * `StatusMessage`; the ready state delegates to per-variant recharts trees inside
+ * `ChartArtifactContent`.
+ *
+ * The renderer is variant-agnostic at this level — it doesn't know about LINE vs BAR vs PIE.
+ * Variant dispatch lives inside `ChartArtifactContent` so the orchestrator can focus on the
+ * data lifecycle and the chrome.
+ *
+ * Labels for action buttons (download, future copy-as-PNG) are pulled from the optional `labels`
+ * prop with per-key fallback to `DEFAULT_CHART_ARTIFACT_LABELS`. Consumers translate via their
+ * own i18n layer and pass the bag; non-i18n consumers omit it and get English defaults.
+ */
+declare function ChartArtifact({ artifact, labels, callbacks }: ArtifactServiceProps<ChartArtifactRecord>): ReactNode;
+
+export { ArtifactDownloadButton, type ArtifactDownloadButtonProps, ArtifactRecord, ArtifactService, ArtifactServiceProps, ArtifactServices, ArtifactType, ChartArtifact, ChartArtifactRecord, TableArtifact, TableArtifactRecord, artifactToClipboardText, isSafeDownloadUrl };

package/dist/artifacts.js

@@ -0,0 +1,33 @@
+import "./chunk-AQEJRMRN.js";
+import {
+  ArtifactDownloadButton,
+  ArtifactServices,
+  ChartArtifact,
+  DEFAULT_CHART_ARTIFACT_LABELS,
+  DEFAULT_TABLE_ARTIFACT_LABELS,
+  TableArtifact,
+  artifactToClipboardText,
+  artifactTypes,
+  isSafeDownloadUrl
+} from "./chunk-Z5JWF24N.js";
+import "./chunk-QXGYMDIA.js";
+import "./chunk-C77QMQNT.js";
+import "./chunk-SV24ONND.js";
+import "./chunk-4MZZH3WX.js";
+import "./chunk-P6GUNIAE.js";
+import "./chunk-OBOXCBDL.js";
+import "./chunk-OLJIJYB5.js";
+import "./chunk-JF3P66JF.js";
+import "./chunk-5WRI5ZAA.js";
+export {
+  ArtifactDownloadButton,
+  ArtifactServices,
+  ChartArtifact,
+  DEFAULT_CHART_ARTIFACT_LABELS,
+  DEFAULT_TABLE_ARTIFACT_LABELS,
+  TableArtifact,
+  artifactToClipboardText,
+  artifactTypes,
+  isSafeDownloadUrl
+};
+//# sourceMappingURL=artifacts.js.map