@shapesos/clay 0.11.0 → 0.12.0

package/dist/types-3Gzk7cRt.d.cts

@@ -1,121 +0,0 @@
-import { ComponentType } from 'react';
-
-/**
- * Artifact-domain types — wire-protocol shapes shared between artifact components, block-services, and
- * consumers. The block layer (`@/components/blocks`) imports these to define
- * `ArtifactRefBlockRecord`; the artifact components consume them directly.
- *
- * Mirrored from the agent / io-server contract — see the `chat-typed-content-blocks-and-artifacts`
- * plan, §6.4 (table contract).
- */
-
-/**
- * Artifact-type discriminator constants. Uppercase to match the server-side `artifactTypes`
- * constant — io-server stores `artifact.type === "TABLE"` (aligned with the GraphQL enum).
- */
-declare const artifactTypes: {
-    readonly TABLE: "TABLE";
-};
-/** Discriminator for artifact types. Additive — new types extend this union. */
-type ArtifactType = (typeof artifactTypes)[keyof typeof artifactTypes];
-/**
- * A single column descriptor for a `TableArtifact`. Carries the ORDER and LABEL for the
- * rendered table — `key` selects a column from the CSV header; `label` overrides the rendered
- * header text. The CSV is always the source of truth for the data shape; clay never coerces,
- * reformats, or interprets cell values.
- */
-interface TableColumn {
-    /** Matches a header in the CSV. Required. Used to project + order the CSV's columns. */
-    key: string;
-    /** Human-readable header text. Required. */
-    label: string;
-    /**
-     * Accepted in the wire payload but not consulted by the renderer — every cell is rendered as
-     * the raw CSV string (or empty for null). Format conversion is a server concern; if a column
-     * needs to be "Yes/No" instead of "true/false", the server should emit it that way in the CSV.
-     * Kept in the interface so callers that pass `type` (e.g. io-client) don't get a type error.
-     */
-    type?: "string" | "number" | "date" | "boolean";
-    /**
-     * Accepted in the wire payload but not consulted by the renderer — every column is left-aligned
-     * by design. Kept in the interface for forward-compat; restore per-column alignment by editing
-     * `table-artifact-content.tsx` if a future use case justifies it.
-     */
-    align?: "left" | "center" | "right";
-}
-/**
- * Optional stats embedded in `TableConfig` so clients can pre-render UI before fetching the
- * actual data payload (e.g. N loading shimmers sized to the eventual row count).
- *
- * Backward-compat: optional everywhere — older artifacts persisted before this field shipped
- * still validate. The renderer falls back to a single status-message line when `stats` is absent.
- */
-interface TableStats {
-    /** Total number of rows in the materialised CSV. Lets the loading branch render shimmers. */
-    rowCount: number;
-}
-/** Rendering config for a table artifact, stored at `artifact.config` (JSONB on the server). */
-interface TableConfig {
-    /** Column descriptors in render order. */
-    columns: TableColumn[];
-    /** Optional metadata describing the underlying data — used for loading-state UI. */
-    stats?: TableStats;
-}
-/**
- * A row inside a table artifact's parsed CSV. Every cell is the raw string from the CSV (or
- * `null` for the empty string). The renderer never coerces or interprets — type-aware formatting
- * is a server concern (the CSV's contents are what the user sees).
- */
-type TableRow = Record<string, string | null>;
-/** Common shape every artifact record carries. Discriminated by `type`. */
-interface ArtifactBase<TType extends ArtifactType, TConfig> {
-    /** Artifact-type discriminator. */
-    type: TType;
-    /** Human-readable label. Nullable when the artifact has no title. */
-    title: string | null;
-    /** Rendering config — shape varies per artifact type. */
-    config: TConfig;
-    /** Protected-asset metadata pointing to the underlying data payload. Null while the asset is unavailable. */
-    protectedAsset: {
-        /** Time-limited URL the renderer fetches the artifact's data from. */
-        presignedUrl: string;
-    } | null;
-}
-/** Concrete table artifact record. Future artifact types extend `ArtifactRecord` here. */
-type TableArtifactRecord = ArtifactBase<typeof artifactTypes.TABLE, TableConfig>;
-/**
- * Discriminated union of all supported artifacts. Single-member today; extension pattern:
- *
- *   export type ArtifactRecord = TableArtifactRecord | ChartArtifactRecord;
- *
- * Every consumer that narrows on `artifact.type` must add the new branch here AND in the
- * `ArtifactServices` map (single source of truth for the type→component mapping). Older clay
- * versions that don't know about a new type silently render nothing — see `ArtifactRefBlock` guard.
- */
-type ArtifactRecord = TableArtifactRecord;
-/** Props every concrete artifact component receives from the dispatcher. */
-interface ArtifactServiceProps<TArtifact extends ArtifactRecord = ArtifactRecord> {
-    /** The artifact metadata (config + presigned URL). */
-    artifact: TArtifact;
-}
-/** Per-artifact-type service — registry entry that pairs a discriminator with its concrete component. */
-interface ArtifactService<TArtifact extends ArtifactRecord = ArtifactRecord> {
-    /** Discriminator value this service handles. */
-    type: ArtifactType;
-    /** React component that renders an artifact of this type — composes ai-elements primitives
-     * (`Artifact`, `ArtifactHeader`, `ArtifactTitle`, `ArtifactActions`, `ArtifactContent`) directly. */
-    Component: ComponentType<ArtifactServiceProps<TArtifact>>;
-    /**
-     * Returns a plain-text / markdown string suitable for clipboard copy.
-     *
-     * Called by `ArtifactRefBlockService.toClipboardText` when the user copies a message that
-     * contains this artifact. Must be pure and synchronous.
-     *
-     * Implementation notes per type:
-     * - `table`: returns the artifact title as plain text (see `TableArtifactService`).
-     * - Future types implement their own representation in a co-located `*-service.ts` file.
-     */
-    toClipboardText: (artifact: TArtifact) => string;
-}
-
-export { type ArtifactRecord as A, type TableArtifactRecord as T, type ArtifactService as a, type ArtifactServiceProps as b, type ArtifactType as c, type TableColumn as d, type TableConfig as e, type TableRow as f, type TableStats as g, artifactTypes as h };

package/dist/types-3Gzk7cRt.d.ts

@@ -1,121 +0,0 @@
-import { ComponentType } from 'react';
-
-/**
- * Artifact-domain types — wire-protocol shapes shared between artifact components, block-services, and
- * consumers. The block layer (`@/components/blocks`) imports these to define
- * `ArtifactRefBlockRecord`; the artifact components consume them directly.
- *
- * Mirrored from the agent / io-server contract — see the `chat-typed-content-blocks-and-artifacts`
- * plan, §6.4 (table contract).
- */
-
-/**
- * Artifact-type discriminator constants. Uppercase to match the server-side `artifactTypes`
- * constant — io-server stores `artifact.type === "TABLE"` (aligned with the GraphQL enum).
- */
-declare const artifactTypes: {
-    readonly TABLE: "TABLE";
-};
-/** Discriminator for artifact types. Additive — new types extend this union. */
-type ArtifactType = (typeof artifactTypes)[keyof typeof artifactTypes];
-/**
- * A single column descriptor for a `TableArtifact`. Carries the ORDER and LABEL for the
- * rendered table — `key` selects a column from the CSV header; `label` overrides the rendered
- * header text. The CSV is always the source of truth for the data shape; clay never coerces,
- * reformats, or interprets cell values.
- */
-interface TableColumn {
-    /** Matches a header in the CSV. Required. Used to project + order the CSV's columns. */
-    key: string;
-    /** Human-readable header text. Required. */
-    label: string;
-    /**
-     * Accepted in the wire payload but not consulted by the renderer — every cell is rendered as
-     * the raw CSV string (or empty for null). Format conversion is a server concern; if a column
-     * needs to be "Yes/No" instead of "true/false", the server should emit it that way in the CSV.
-     * Kept in the interface so callers that pass `type` (e.g. io-client) don't get a type error.
-     */
-    type?: "string" | "number" | "date" | "boolean";
-    /**
-     * Accepted in the wire payload but not consulted by the renderer — every column is left-aligned
-     * by design. Kept in the interface for forward-compat; restore per-column alignment by editing
-     * `table-artifact-content.tsx` if a future use case justifies it.
-     */
-    align?: "left" | "center" | "right";
-}
-/**
- * Optional stats embedded in `TableConfig` so clients can pre-render UI before fetching the
- * actual data payload (e.g. N loading shimmers sized to the eventual row count).
- *
- * Backward-compat: optional everywhere — older artifacts persisted before this field shipped
- * still validate. The renderer falls back to a single status-message line when `stats` is absent.
- */
-interface TableStats {
-    /** Total number of rows in the materialised CSV. Lets the loading branch render shimmers. */
-    rowCount: number;
-}
-/** Rendering config for a table artifact, stored at `artifact.config` (JSONB on the server). */
-interface TableConfig {
-    /** Column descriptors in render order. */
-    columns: TableColumn[];
-    /** Optional metadata describing the underlying data — used for loading-state UI. */
-    stats?: TableStats;
-}
-/**
- * A row inside a table artifact's parsed CSV. Every cell is the raw string from the CSV (or
- * `null` for the empty string). The renderer never coerces or interprets — type-aware formatting
- * is a server concern (the CSV's contents are what the user sees).
- */
-type TableRow = Record<string, string | null>;
-/** Common shape every artifact record carries. Discriminated by `type`. */
-interface ArtifactBase<TType extends ArtifactType, TConfig> {
-    /** Artifact-type discriminator. */
-    type: TType;
-    /** Human-readable label. Nullable when the artifact has no title. */
-    title: string | null;
-    /** Rendering config — shape varies per artifact type. */
-    config: TConfig;
-    /** Protected-asset metadata pointing to the underlying data payload. Null while the asset is unavailable. */
-    protectedAsset: {
-        /** Time-limited URL the renderer fetches the artifact's data from. */
-        presignedUrl: string;
-    } | null;
-}
-/** Concrete table artifact record. Future artifact types extend `ArtifactRecord` here. */
-type TableArtifactRecord = ArtifactBase<typeof artifactTypes.TABLE, TableConfig>;
-/**
- * Discriminated union of all supported artifacts. Single-member today; extension pattern:
- *
- *   export type ArtifactRecord = TableArtifactRecord | ChartArtifactRecord;
- *
- * Every consumer that narrows on `artifact.type` must add the new branch here AND in the
- * `ArtifactServices` map (single source of truth for the type→component mapping). Older clay
- * versions that don't know about a new type silently render nothing — see `ArtifactRefBlock` guard.
- */
-type ArtifactRecord = TableArtifactRecord;
-/** Props every concrete artifact component receives from the dispatcher. */
-interface ArtifactServiceProps<TArtifact extends ArtifactRecord = ArtifactRecord> {
-    /** The artifact metadata (config + presigned URL). */
-    artifact: TArtifact;
-}
-/** Per-artifact-type service — registry entry that pairs a discriminator with its concrete component. */
-interface ArtifactService<TArtifact extends ArtifactRecord = ArtifactRecord> {
-    /** Discriminator value this service handles. */
-    type: ArtifactType;
-    /** React component that renders an artifact of this type — composes ai-elements primitives
-     * (`Artifact`, `ArtifactHeader`, `ArtifactTitle`, `ArtifactActions`, `ArtifactContent`) directly. */
-    Component: ComponentType<ArtifactServiceProps<TArtifact>>;
-    /**
-     * Returns a plain-text / markdown string suitable for clipboard copy.
-     *
-     * Called by `ArtifactRefBlockService.toClipboardText` when the user copies a message that
-     * contains this artifact. Must be pure and synchronous.
-     *
-     * Implementation notes per type:
-     * - `table`: returns the artifact title as plain text (see `TableArtifactService`).
-     * - Future types implement their own representation in a co-located `*-service.ts` file.
-     */
-    toClipboardText: (artifact: TArtifact) => string;
-}
-
-export { type ArtifactRecord as A, type TableArtifactRecord as T, type ArtifactService as a, type ArtifactServiceProps as b, type ArtifactType as c, type TableColumn as d, type TableConfig as e, type TableRow as f, type TableStats as g, artifactTypes as h };