@assistant-ui/react-generative-ui 0.0.23 → 0.1.0

package/src/a2ui/reducer.ts

@@ -1,363 +0,0 @@
-import {
-  A2UI_SURFACE_ID,
-  type A2uiOperationResult,
-  type A2uiState,
-  type A2uiSurfaceState,
-  type A2uiVersion,
-} from "./types";
-
-const OPERATION_KEYS = new Set([
-  "createSurface",
-  "updateComponents",
-  "updateDataModel",
-  "deleteSurface",
-]);
-// This defensive ceiling is well above the renderer's displayed-item limit.
-export const MAX_AUTO_VIVIFY_ARRAY_INDEX = 10_000;
-const INVALID_POINTER = Symbol("invalidPointer");
-
-const isRecord = (value: unknown): value is Record<string, unknown> =>
-  typeof value === "object" && value !== null && !Array.isArray(value);
-
-const isVersion = (value: unknown): value is A2uiVersion =>
-  value === "v0.9" || value === "v0.9.1" || value === "v1.0";
-
-const surfaceIdOf = (payload: Record<string, unknown>): string | undefined => {
-  const surfaceId = payload["surfaceId"];
-  return typeof surfaceId === "string" && surfaceId.length > 0
-    ? surfaceId
-    : undefined;
-};
-
-const catalogIdOf = (payload: Record<string, unknown>): string | undefined => {
-  if (typeof payload["catalogId"] === "string") {
-    return payload["catalogId"];
-  }
-  const surfaceProperties = payload["surfaceProperties"];
-  return isRecord(surfaceProperties) &&
-    typeof surfaceProperties["catalogId"] === "string"
-    ? surfaceProperties["catalogId"]
-    : undefined;
-};
-
-const withSurfaceId = (
-  surface: A2uiSurfaceState,
-  surfaceId: string,
-): A2uiSurfaceState => {
-  Object.defineProperty(surface, A2UI_SURFACE_ID, {
-    value: surfaceId,
-    enumerable: false,
-  });
-  return surface;
-};
-
-const getSurfaceId = (surface: A2uiSurfaceState): string | undefined =>
-  (surface as A2uiSurfaceState & { [A2UI_SURFACE_ID]?: string })[
-    A2UI_SURFACE_ID
-  ];
-
-const cloneSurface = (
-  surface: A2uiSurfaceState,
-  surfaceId: string,
-): A2uiSurfaceState =>
-  withSurfaceId(
-    {
-      ...(surface.catalogId !== undefined
-        ? { catalogId: surface.catalogId }
-        : {}),
-      components: new Map(surface.components),
-      dataModel: surface.dataModel,
-    },
-    getSurfaceId(surface) ?? surfaceId,
-  );
-
-const upsertComponents = (
-  surface: A2uiSurfaceState,
-  components: unknown,
-  warnings: string[],
-  operationIndex: number,
-): void => {
-  if (!Array.isArray(components)) {
-    warnings.push(
-      `Operation at index ${operationIndex} has malformed components.`,
-    );
-    return;
-  }
-
-  for (
-    let componentIndex = 0;
-    componentIndex < components.length;
-    componentIndex++
-  ) {
-    const component = components[componentIndex];
-    if (
-      !isRecord(component) ||
-      typeof component["id"] !== "string" ||
-      component["id"].length === 0 ||
-      typeof component["component"] !== "string" ||
-      component["component"].length === 0
-    ) {
-      warnings.push(
-        `Component at index ${componentIndex} in operation ${operationIndex} is malformed.`,
-      );
-      continue;
-    }
-    surface.components.set(component["id"], { ...component });
-  }
-};
-
-const decodePointer = (path: string): string[] | undefined => {
-  if (path === "" || path === "/") return [];
-  if (!path.startsWith("/")) return undefined;
-  return path
-    .slice(1)
-    .split("/")
-    .map((segment) => segment.replaceAll("~1", "/").replaceAll("~0", "~"));
-};
-
-const isArrayIndex = (segment: string): boolean =>
-  segment === "0" || /^[1-9]\d*$/.test(segment);
-
-export const setAtPointer = (
-  model: unknown,
-  path: string,
-  value: unknown,
-  nullDeletes: boolean,
-): { readonly ok: boolean; readonly value: unknown } => {
-  const segments = decodePointer(path);
-  if (!segments) return { ok: false, value: model };
-  if (segments.length === 0) return { ok: true, value };
-
-  const remove = (current: unknown, index: number): unknown => {
-    const segment = segments[index]!;
-    const isLast = index === segments.length - 1;
-
-    if (Array.isArray(current)) {
-      if (segment !== "-" && !isArrayIndex(segment)) return current;
-      const targetIndex = segment === "-" ? current.length : Number(segment);
-      if (isLast) {
-        if (
-          segment === "-" ||
-          !Object.prototype.hasOwnProperty.call(current, targetIndex)
-        ) {
-          return current;
-        }
-        const clone = current.slice();
-        // Preserve indices referenced by other JSON Pointers.
-        delete clone[targetIndex];
-        return clone;
-      }
-      const child = current[targetIndex];
-      if (!Array.isArray(child) && !isRecord(child)) return current;
-      const next = remove(child, index + 1);
-      if (next === child) return current;
-      const clone = current.slice();
-      clone[targetIndex] = next;
-      return clone;
-    }
-
-    if (!isRecord(current)) return current;
-    if (!Object.prototype.hasOwnProperty.call(current, segment)) return current;
-    if (isLast) {
-      const clone = { ...current };
-      delete clone[segment];
-      return clone;
-    }
-    const child = current[segment];
-    if (!Array.isArray(child) && !isRecord(child)) return current;
-    const next = remove(child, index + 1);
-    if (next === child) return current;
-    return { ...current, [segment]: next };
-  };
-
-  if (nullDeletes && value === null) {
-    return { ok: true, value: remove(model, 0) };
-  }
-
-  const update = (current: unknown, index: number): unknown => {
-    const segment = segments[index]!;
-    const isLast = index === segments.length - 1;
-
-    if (Array.isArray(current)) {
-      if (segment !== "-" && !isArrayIndex(segment)) return current;
-      const targetIndex = segment === "-" ? current.length : Number(segment);
-      if (
-        segment !== "-" &&
-        targetIndex >= current.length &&
-        targetIndex > MAX_AUTO_VIVIFY_ARRAY_INDEX
-      ) {
-        return INVALID_POINTER;
-      }
-      const next = isLast ? value : update(current[targetIndex], index + 1);
-      if (next === INVALID_POINTER) return INVALID_POINTER;
-      const clone = current.slice();
-      clone[targetIndex] = next;
-      return clone;
-    }
-
-    const record: Record<string, unknown> = isRecord(current) ? current : {};
-    const child = Object.hasOwn(record, segment) ? record[segment] : undefined;
-    const next = isLast
-      ? value
-      : update(
-          child ??
-            (isArrayIndex(segments[index + 1] ?? "") ||
-            segments[index + 1] === "-"
-              ? []
-              : {}),
-          index + 1,
-        );
-    if (next === INVALID_POINTER) return INVALID_POINTER;
-    return { ...record, [segment]: next };
-  };
-
-  const result = update(model, 0);
-  return result === INVALID_POINTER
-    ? { ok: false, value: model }
-    : { ok: true, value: result };
-};
-
-const dataModelValue = (
-  payload: Record<string, unknown>,
-): { readonly found: boolean; readonly value: unknown } => {
-  for (const key of ["contents", "value", "data"] as const) {
-    if (payload[key] !== undefined) {
-      return { found: true, value: payload[key] };
-    }
-  }
-  return { found: false, value: undefined };
-};
-
-export function applyA2uiOperations(
-  state: A2uiState,
-  operations: unknown,
-): A2uiOperationResult {
-  const nextState = new Map(state);
-  const warnings: string[] = [];
-
-  if (!Array.isArray(operations)) {
-    return {
-      state: nextState,
-      warnings: ["A2UI operations must be an array."],
-    };
-  }
-
-  for (let index = 0; index < operations.length; index++) {
-    try {
-      const entry = operations[index];
-      if (!isRecord(entry)) {
-        warnings.push(`Operation at index ${index} is malformed.`);
-        continue;
-      }
-
-      const version = entry["version"];
-      if (!isVersion(version)) {
-        warnings.push(
-          `Operation at index ${index} has an unsupported version.`,
-        );
-        continue;
-      }
-
-      const operationKeys = Object.keys(entry).filter(
-        (key) => key !== "version",
-      );
-      if (operationKeys.length !== 1) {
-        warnings.push(
-          `Operation at index ${index} must contain exactly one operation key.`,
-        );
-        continue;
-      }
-
-      const operationKey = operationKeys[0]!;
-      if (!OPERATION_KEYS.has(operationKey)) {
-        warnings.push(
-          `Unknown A2UI operation "${operationKey}" at index ${index}.`,
-        );
-        continue;
-      }
-
-      const payload = entry[operationKey];
-      if (!isRecord(payload)) {
-        warnings.push(`Operation at index ${index} has a malformed payload.`);
-        continue;
-      }
-
-      const surfaceId = surfaceIdOf(payload);
-      if (!surfaceId) {
-        warnings.push(`Operation at index ${index} has no valid surfaceId.`);
-        continue;
-      }
-
-      if (operationKey === "createSurface") {
-        const catalogId = catalogIdOf(payload);
-        const surface = withSurfaceId(
-          {
-            ...(catalogId !== undefined ? { catalogId } : {}),
-            components: new Map(),
-            dataModel:
-              version === "v1.0" && payload["dataModel"] !== undefined
-                ? payload["dataModel"]
-                : undefined,
-          },
-          surfaceId,
-        );
-        if (version === "v1.0" && payload["components"] !== undefined) {
-          upsertComponents(surface, payload["components"], warnings, index);
-        }
-        nextState.set(surfaceId, surface);
-        continue;
-      }
-
-      if (operationKey === "deleteSurface") {
-        nextState.delete(surfaceId);
-        continue;
-      }
-
-      const currentSurface = nextState.get(surfaceId);
-      if (!currentSurface) {
-        warnings.push(
-          `Operation at index ${index} references missing surface "${surfaceId}".`,
-        );
-        continue;
-      }
-      const surface = cloneSurface(currentSurface, surfaceId);
-
-      if (operationKey === "updateComponents") {
-        upsertComponents(surface, payload["components"], warnings, index);
-        nextState.set(surfaceId, surface);
-        continue;
-      }
-
-      const update = dataModelValue(payload);
-      if (!update.found) {
-        warnings.push(`Operation at index ${index} has no data model value.`);
-        continue;
-      }
-      const path = payload["path"] ?? "/";
-      if (typeof path !== "string") {
-        warnings.push(
-          `Operation at index ${index} has a malformed data model path.`,
-        );
-        continue;
-      }
-      const result = setAtPointer(
-        surface.dataModel,
-        path,
-        update.value,
-        version === "v1.0",
-      );
-      if (!result.ok) {
-        warnings.push(
-          `Operation at index ${index} has an invalid JSON Pointer path.`,
-        );
-        continue;
-      }
-      surface.dataModel = result.value;
-      nextState.set(surfaceId, surface);
-    } catch {
-      warnings.push(`Operation at index ${index} is malformed.`);
-    }
-  }
-
-  return { state: nextState, warnings };
-}

package/src/a2ui/snapshot.test.ts

@@ -1,52 +0,0 @@
-import { describe, expect, it } from "vitest";
-import { surfaceToOperations } from "./snapshot";
-import { A2UI_SURFACE_ID, type A2uiSurfaceState } from "./types";
-
-const surface = (dataModel: unknown): A2uiSurfaceState => ({
-  components: new Map([["root", { id: "root", component: "Text" }]]),
-  dataModel,
-});
-
-describe("surfaceToOperations", () => {
-  it("uses an explicit surface id and omits an undefined data model", () => {
-    const value = Object.defineProperty(surface(undefined), A2UI_SURFACE_ID, {
-      value: "stored",
-    });
-
-    expect(surfaceToOperations(value, "provided")).toEqual([
-      {
-        version: "v0.9",
-        createSurface: { surfaceId: "provided" },
-      },
-      {
-        version: "v0.9",
-        updateComponents: {
-          surfaceId: "provided",
-          components: [{ id: "root", component: "Text" }],
-        },
-      },
-    ]);
-  });
-
-  it("uses the reducer surface id when no explicit id is supplied", () => {
-    const value = Object.defineProperty(surface(null), A2UI_SURFACE_ID, {
-      value: "stored",
-    });
-
-    expect(surfaceToOperations(value)).toMatchObject([
-      { createSurface: { surfaceId: "stored" } },
-      { updateComponents: { surfaceId: "stored" } },
-      { updateDataModel: { surfaceId: "stored", contents: null } },
-    ]);
-  });
-
-  it("requires either an explicit or reducer surface id", () => {
-    expect(() => surfaceToOperations(surface({}))).toThrow(
-      "A2UI surfaces must have a surface id to be replayed.",
-    );
-  });
-  it("rejects an empty surface id", () => {
-    const value = { components: new Map(), dataModel: undefined };
-    expect(() => surfaceToOperations(value, "")).toThrow();
-  });
-});

package/src/a2ui/snapshot.ts

@@ -1,52 +0,0 @@
-import {
-  A2UI_SURFACE_ID,
-  type A2uiSurfaceState,
-  type A2uiSurfaceSnapshotOperation,
-  type ComponentNode,
-} from "./types";
-
-const surfaceIdOf = (surface: A2uiSurfaceState): string | undefined =>
-  (surface as A2uiSurfaceState & { [A2UI_SURFACE_ID]?: string })[
-    A2UI_SURFACE_ID
-  ];
-
-export function surfaceToOperations(
-  surface: A2uiSurfaceState,
-  surfaceId?: string,
-): readonly A2uiSurfaceSnapshotOperation[] {
-  const resolvedSurfaceId = surfaceId ?? surfaceIdOf(surface);
-  if (!resolvedSurfaceId) {
-    throw new Error("A2UI surfaces must have a surface id to be replayed.");
-  }
-  const operations: A2uiSurfaceSnapshotOperation[] = [
-    {
-      version: "v0.9",
-      createSurface: {
-        surfaceId: resolvedSurfaceId,
-        ...(surface.catalogId !== undefined
-          ? { catalogId: surface.catalogId }
-          : {}),
-      },
-    },
-    {
-      version: "v0.9",
-      updateComponents: {
-        surfaceId: resolvedSurfaceId,
-        components: [...surface.components.values()].map((component) => ({
-          ...component,
-        })) as ComponentNode[],
-      },
-    },
-  ];
-  if (surface.dataModel !== undefined) {
-    operations.push({
-      version: "v0.9",
-      updateDataModel: {
-        surfaceId: resolvedSurfaceId,
-        path: "/",
-        contents: surface.dataModel,
-      },
-    });
-  }
-  return operations;
-}

package/src/a2ui/types.ts

@@ -1,114 +0,0 @@
-export const A2UI_SURFACE_ID = Symbol("a2uiSurfaceId");
-
-export type A2uiVersion = "v0.9" | "v0.9.1" | "v1.0";
-
-export interface A2uiTemplateChildren {
-  readonly template: {
-    readonly componentId: string;
-    readonly path: string;
-  };
-}
-
-export interface ComponentNode extends Record<string, unknown> {
-  readonly id: string;
-  readonly component: string;
-  readonly children?:
-    | readonly string[]
-    | { readonly componentId: string; readonly path: string }
-    | A2uiTemplateChildren;
-}
-
-export interface A2uiCreateSurfaceV09Payload {
-  readonly surfaceId: string;
-  readonly catalogId?: string;
-  readonly theme?: unknown;
-  readonly attachDataModel?: unknown;
-}
-
-export interface A2uiCreateSurfaceV10Payload {
-  readonly surfaceId: string;
-  readonly catalogId?: string;
-  readonly surfaceProperties?: unknown;
-  readonly sendDataModel?: unknown;
-  readonly components?: readonly ComponentNode[];
-  readonly dataModel?: unknown;
-}
-
-export interface A2uiUpdateComponentsPayload {
-  readonly surfaceId: string;
-  readonly components: readonly ComponentNode[];
-}
-
-export interface A2uiUpdateDataModelPayload {
-  readonly surfaceId: string;
-  readonly path?: string;
-  readonly contents?: unknown;
-  readonly value?: unknown;
-  readonly data?: unknown;
-}
-
-export interface A2uiDeleteSurfacePayload {
-  readonly surfaceId: string;
-}
-
-export type A2uiCreateSurfaceOperation =
-  | {
-      readonly version: "v0.9";
-      readonly createSurface: A2uiCreateSurfaceV09Payload;
-    }
-  | {
-      readonly version: "v0.9.1";
-      readonly createSurface: A2uiCreateSurfaceV09Payload;
-    }
-  | {
-      readonly version: "v1.0";
-      readonly createSurface: A2uiCreateSurfaceV10Payload;
-    };
-
-export interface A2uiUpdateComponentsOperation {
-  readonly version: A2uiVersion;
-  readonly updateComponents: A2uiUpdateComponentsPayload;
-}
-
-export interface A2uiUpdateDataModelOperation {
-  readonly version: A2uiVersion;
-  readonly updateDataModel: A2uiUpdateDataModelPayload;
-}
-
-export interface A2uiDeleteSurfaceOperation {
-  readonly version: A2uiVersion;
-  readonly deleteSurface: A2uiDeleteSurfacePayload;
-}
-
-export type A2uiOperation =
-  | A2uiCreateSurfaceOperation
-  | A2uiUpdateComponentsOperation
-  | A2uiUpdateDataModelOperation
-  | A2uiDeleteSurfaceOperation;
-
-export type A2uiSurfaceSnapshotOperation =
-  | {
-      readonly version: "v0.9";
-      readonly createSurface: A2uiCreateSurfaceV09Payload;
-    }
-  | {
-      readonly version: "v0.9";
-      readonly updateComponents: A2uiUpdateComponentsPayload;
-    }
-  | {
-      readonly version: "v0.9";
-      readonly updateDataModel: A2uiUpdateDataModelPayload;
-    };
-
-export type A2uiSurfaceState = {
-  catalogId?: string;
-  components: Map<string, Record<string, unknown>>;
-  dataModel: unknown;
-};
-
-export type A2uiState = ReadonlyMap<string, A2uiSurfaceState>;
-
-export interface A2uiOperationResult {
-  readonly state: A2uiState;
-  readonly warnings: string[];
-}