@clickless/react 0.0.0-stage → 0.1.0

package/dist/core/defaultLayout.d.ts

@@ -0,0 +1,12 @@
+import { Layout, type Component, type LayoutItem, type Manifest } from "./schemas.gen.js";
+/** The layout shape this SDK writes and reads, as the schema states it. */
+export declare const LAYOUT_FORMAT_VERSION: 1;
+export declare function cloneLayoutItem(layoutItem: LayoutItem): LayoutItem;
+/** A width and a height for a layout item, leaving out whichever the component does not have. */
+export declare function withSize(width: number | undefined, height: number | undefined): Pick<LayoutItem, "w" | "h">;
+/** The values each of a component's list props offers, to record alongside a saved item. */
+export declare function offeredValuesOf(component: Component): LayoutItem["offeredValues"];
+export declare function defaultLayoutItem(component: Component): LayoutItem;
+export declare function defaultLayout(manifest: Manifest): Layout;
+/** True when the layout holds exactly the manifest's components, each once. */
+export declare function layoutMatchesManifest(manifest: Manifest, layout: Layout): boolean;

package/dist/core/index.d.ts

@@ -0,0 +1,8 @@
+export * from "./schemas.gen.js";
+export { defaultLayout, layoutMatchesManifest } from "./defaultLayout.js";
+export { validateOperations, type OperationError, type OperationErrorCode } from "./validateOperations.js";
+export { fileTypeAccepted, findActionsFailure, validateActionCalls, type ActionCallError, type ActionCallErrorCode, type AttachedFile, } from "./validateActionCalls.js";
+export { applyOperations, type ApplyOperationsOutcome } from "./applyOperations.js";
+export { MAX_OFF_SCREEN_COMPONENTS, reconcileLayout, reconcileLayoutItem, savedOrderOfKnownComponents, type LayoutChange, type ReconciledLayout, } from "./reconcileLayout.js";
+export { contrastRatio, ensureReadableTextColor, readableTextColor } from "./colorContrast.js";
+export { propAcceptsValue } from "./propValues.js";

package/dist/core/ownProperties.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Sets an entry that is the record's own, whatever it is called. Assigning to
+ * the name `__proto__` would change what the record inherits from instead of
+ * adding an entry, and components and props are named by developers.
+ */
+export declare function setOwnProperty<T>(record: Record<string, T>, propertyName: string, propertyValue: T): void;
+/**
+ * What a record holds under a property name, leaving out what every object inherits: a
+ * prop named "constructor" or "toString" is absent unless the record has it.
+ */
+export declare function ownPropertyValue<T>(record: Record<string, T> | undefined, propertyName: string): T | undefined;

package/dist/core/propValues.d.ts

@@ -0,0 +1,8 @@
+import type { PropCapabilities, PropValue } from "./schemas.gen.js";
+export declare function clonePropValue(propValue: PropValue): PropValue;
+/**
+ * Whether a prop declared this way may hold the value. Comparison is strict on
+ * purpose: "25" is not 25 and 1 is not true.
+ */
+export declare function propAcceptsValue(propCapabilities: PropCapabilities, propValue: PropValue): boolean;
+export declare function propValuesEqual(firstValue: PropValue | undefined, secondValue: PropValue | undefined): boolean;

package/dist/core/reconcileLayout.d.ts

@@ -0,0 +1,59 @@
+import type { Component, Layout, LayoutItem, Manifest } from "./schemas.gen.js";
+export interface LayoutChange {
+    /**
+     * `added`: the component is new in this version and was placed with its defaults.
+     * `removed`: something the layout held for a component was dropped for good.
+     * `adjusted`: a setting the manifest no longer allows was corrected.
+     */
+    type: "added" | "removed" | "adjusted";
+    id: string;
+}
+export interface ReconciledLayout {
+    layout: Layout;
+    changes: LayoutChange[];
+}
+/**
+ * The most components a layout keeps settings for while they are off screen.
+ * Nothing else ever drops them: a component a release deleted cannot be told
+ * from one that is not showing, and losing what a user set is worse than
+ * keeping an entry nobody sees. So without a limit, deleted components would
+ * pile up release after release, and a caller sending a different manifest
+ * with every change could grow the stored layout without end. It is the most
+ * one manifest may list, so a region whose every component is off screen at
+ * once still fits. Past it, the ones last in the order are dropped.
+ * Must equal the engine's own `MAX_OFF_SCREEN_COMPONENTS`, or the screen and
+ * the engine would disagree.
+ */
+export declare const MAX_OFF_SCREEN_COMPONENTS = 500;
+/**
+ * Carries a saved layout over to a manifest, keeping everything the manifest
+ * still allows. The result's `order` and `items` always hold exactly the
+ * manifest's components.
+ *
+ * A manifest lists what is on screen now, which may be only part of the region:
+ * one tab's content, say. A saved component it does not list is set aside in
+ * `offScreen` with its settings and its place, and takes them again when it is
+ * listed. It is kept however long it stays away, up to
+ * `MAX_OFF_SCREEN_COMPONENTS`, since a component a release deleted looks the
+ * same as one that is merely not showing.
+ *
+ * New components take their defaults and go after the nearest earlier manifest
+ * neighbour already in the layout, or first if there is none. They are reported
+ * as added only when the version changed: within one version, a component the
+ * layout has not met was simply not on screen when it was saved. Settings are
+ * corrected only where they break the manifest.
+ */
+export declare function reconcileLayout(manifest: Manifest, layout: Layout): ReconciledLayout;
+/**
+ * Every component the layout has settings and a place for, on screen or off,
+ * in one order. `offScreen.order` gives each its slot, but `order` may have
+ * been rearranged since it was written, so the slots of the components in
+ * `order` are filled in the sequence `order` now gives. Anything with no slot
+ * goes last.
+ */
+export declare function savedOrderOfKnownComponents(layout: Layout): string[];
+/**
+ * One component's saved settings, corrected the way `reconcileLayout` corrects them.
+ * For showing a saved item before the whole manifest is known.
+ */
+export declare function reconcileLayoutItem(component: Component, savedItem: LayoutItem, columnCount: number): LayoutItem;

package/dist/core/schemas.gen.d.ts

@@ -0,0 +1,427 @@
+import { z } from "zod";
+export declare const PropValue: z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodNumber, z.ZodBoolean, z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodNumber, z.ZodBoolean]>>]>;
+export type PropValue = z.infer<typeof PropValue>;
+export declare const ResizeCapabilities: z.ZodObject<{
+    minW: z.ZodNumber;
+    maxW: z.ZodNumber;
+    minH: z.ZodNumber;
+    maxH: z.ZodNumber;
+}, z.core.$strict>;
+export type ResizeCapabilities = z.infer<typeof ResizeCapabilities>;
+export declare const ChoiceCapabilities: z.ZodObject<{
+    values: z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodNumber, z.ZodBoolean]>>;
+    multiple: z.ZodOptional<z.ZodBoolean>;
+    min: z.ZodOptional<z.ZodNumber>;
+    required: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodNumber, z.ZodBoolean]>>>;
+}, z.core.$strict>;
+export type ChoiceCapabilities = z.infer<typeof ChoiceCapabilities>;
+export declare const ColorCapabilities: z.ZodObject<{
+    type: z.ZodLiteral<"color">;
+    suggested: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    textOn: z.ZodOptional<z.ZodObject<{
+        colorProp: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>>;
+    against: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+export type ColorCapabilities = z.infer<typeof ColorCapabilities>;
+export declare const NumberCapabilities: z.ZodObject<{
+    type: z.ZodLiteral<"number">;
+    min: z.ZodNumber;
+    max: z.ZodNumber;
+    integer: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strict>;
+export type NumberCapabilities = z.infer<typeof NumberCapabilities>;
+export declare const PropCapabilities: z.ZodUnion<readonly [z.ZodObject<{
+    values: z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodNumber, z.ZodBoolean]>>;
+    multiple: z.ZodOptional<z.ZodBoolean>;
+    min: z.ZodOptional<z.ZodNumber>;
+    required: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodNumber, z.ZodBoolean]>>>;
+}, z.core.$strict>, z.ZodObject<{
+    type: z.ZodLiteral<"color">;
+    suggested: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    textOn: z.ZodOptional<z.ZodObject<{
+        colorProp: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>>;
+    against: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>, z.ZodObject<{
+    type: z.ZodLiteral<"number">;
+    min: z.ZodNumber;
+    max: z.ZodNumber;
+    integer: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strict>]>;
+export type PropCapabilities = z.infer<typeof PropCapabilities>;
+export declare const Capabilities: z.ZodObject<{
+    move: z.ZodBoolean;
+    hide: z.ZodBoolean;
+    resize: z.ZodOptional<z.ZodObject<{
+        minW: z.ZodNumber;
+        maxW: z.ZodNumber;
+        minH: z.ZodNumber;
+        maxH: z.ZodNumber;
+    }, z.core.$strict>>;
+    props: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodObject<{
+        values: z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodNumber, z.ZodBoolean]>>;
+        multiple: z.ZodOptional<z.ZodBoolean>;
+        min: z.ZodOptional<z.ZodNumber>;
+        required: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodNumber, z.ZodBoolean]>>>;
+    }, z.core.$strict>, z.ZodObject<{
+        type: z.ZodLiteral<"color">;
+        suggested: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        textOn: z.ZodOptional<z.ZodObject<{
+            colorProp: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>>;
+        against: z.ZodOptional<z.ZodString>;
+    }, z.core.$strict>, z.ZodObject<{
+        type: z.ZodLiteral<"number">;
+        min: z.ZodNumber;
+        max: z.ZodNumber;
+        integer: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strict>]>>>;
+}, z.core.$strict>;
+export type Capabilities = z.infer<typeof Capabilities>;
+export declare const LayoutItem: z.ZodObject<{
+    w: z.ZodOptional<z.ZodNumber>;
+    h: z.ZodOptional<z.ZodNumber>;
+    hidden: z.ZodBoolean;
+    props: z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodNumber, z.ZodBoolean, z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodNumber, z.ZodBoolean]>>]>>;
+    offeredValues: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodNumber, z.ZodBoolean]>>>>;
+}, z.core.$strict>;
+export type LayoutItem = z.infer<typeof LayoutItem>;
+export declare const Component: z.ZodObject<{
+    id: z.ZodString;
+    kind: z.ZodString;
+    title: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    locked: z.ZodOptional<z.ZodBoolean>;
+    group: z.ZodOptional<z.ZodString>;
+    capabilities: z.ZodObject<{
+        move: z.ZodBoolean;
+        hide: z.ZodBoolean;
+        resize: z.ZodOptional<z.ZodObject<{
+            minW: z.ZodNumber;
+            maxW: z.ZodNumber;
+            minH: z.ZodNumber;
+            maxH: z.ZodNumber;
+        }, z.core.$strict>>;
+        props: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodObject<{
+            values: z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodNumber, z.ZodBoolean]>>;
+            multiple: z.ZodOptional<z.ZodBoolean>;
+            min: z.ZodOptional<z.ZodNumber>;
+            required: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodNumber, z.ZodBoolean]>>>;
+        }, z.core.$strict>, z.ZodObject<{
+            type: z.ZodLiteral<"color">;
+            suggested: z.ZodOptional<z.ZodArray<z.ZodString>>;
+            textOn: z.ZodOptional<z.ZodObject<{
+                colorProp: z.ZodOptional<z.ZodString>;
+            }, z.core.$strict>>;
+            against: z.ZodOptional<z.ZodString>;
+        }, z.core.$strict>, z.ZodObject<{
+            type: z.ZodLiteral<"number">;
+            min: z.ZodNumber;
+            max: z.ZodNumber;
+            integer: z.ZodOptional<z.ZodBoolean>;
+        }, z.core.$strict>]>>>;
+    }, z.core.$strict>;
+    defaults: z.ZodObject<{
+        w: z.ZodOptional<z.ZodNumber>;
+        h: z.ZodOptional<z.ZodNumber>;
+        hidden: z.ZodBoolean;
+        props: z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodNumber, z.ZodBoolean, z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodNumber, z.ZodBoolean]>>]>>;
+        offeredValues: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodNumber, z.ZodBoolean]>>>>;
+    }, z.core.$strict>;
+}, z.core.$strict>;
+export type Component = z.infer<typeof Component>;
+export declare const Manifest: z.ZodObject<{
+    regionId: z.ZodString;
+    version: z.ZodString;
+    columns: z.ZodNumber;
+    title: z.ZodOptional<z.ZodString>;
+    grid: z.ZodOptional<z.ZodBoolean>;
+    components: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        kind: z.ZodString;
+        title: z.ZodString;
+        description: z.ZodOptional<z.ZodString>;
+        locked: z.ZodOptional<z.ZodBoolean>;
+        group: z.ZodOptional<z.ZodString>;
+        capabilities: z.ZodObject<{
+            move: z.ZodBoolean;
+            hide: z.ZodBoolean;
+            resize: z.ZodOptional<z.ZodObject<{
+                minW: z.ZodNumber;
+                maxW: z.ZodNumber;
+                minH: z.ZodNumber;
+                maxH: z.ZodNumber;
+            }, z.core.$strict>>;
+            props: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodObject<{
+                values: z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodNumber, z.ZodBoolean]>>;
+                multiple: z.ZodOptional<z.ZodBoolean>;
+                min: z.ZodOptional<z.ZodNumber>;
+                required: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodNumber, z.ZodBoolean]>>>;
+            }, z.core.$strict>, z.ZodObject<{
+                type: z.ZodLiteral<"color">;
+                suggested: z.ZodOptional<z.ZodArray<z.ZodString>>;
+                textOn: z.ZodOptional<z.ZodObject<{
+                    colorProp: z.ZodOptional<z.ZodString>;
+                }, z.core.$strict>>;
+                against: z.ZodOptional<z.ZodString>;
+            }, z.core.$strict>, z.ZodObject<{
+                type: z.ZodLiteral<"number">;
+                min: z.ZodNumber;
+                max: z.ZodNumber;
+                integer: z.ZodOptional<z.ZodBoolean>;
+            }, z.core.$strict>]>>>;
+        }, z.core.$strict>;
+        defaults: z.ZodObject<{
+            w: z.ZodOptional<z.ZodNumber>;
+            h: z.ZodOptional<z.ZodNumber>;
+            hidden: z.ZodBoolean;
+            props: z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodNumber, z.ZodBoolean, z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodNumber, z.ZodBoolean]>>]>>;
+            offeredValues: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodNumber, z.ZodBoolean]>>>>;
+        }, z.core.$strict>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export type Manifest = z.infer<typeof Manifest>;
+export declare const OffScreen: z.ZodObject<{
+    order: z.ZodArray<z.ZodString>;
+    items: z.ZodRecord<z.ZodString, z.ZodObject<{
+        w: z.ZodOptional<z.ZodNumber>;
+        h: z.ZodOptional<z.ZodNumber>;
+        hidden: z.ZodBoolean;
+        props: z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodNumber, z.ZodBoolean, z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodNumber, z.ZodBoolean]>>]>>;
+        offeredValues: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodNumber, z.ZodBoolean]>>>>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export type OffScreen = z.infer<typeof OffScreen>;
+export declare const Layout: z.ZodObject<{
+    formatVersion: z.ZodLiteral<1>;
+    regionId: z.ZodString;
+    manifestVersion: z.ZodString;
+    order: z.ZodArray<z.ZodString>;
+    items: z.ZodRecord<z.ZodString, z.ZodObject<{
+        w: z.ZodOptional<z.ZodNumber>;
+        h: z.ZodOptional<z.ZodNumber>;
+        hidden: z.ZodBoolean;
+        props: z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodNumber, z.ZodBoolean, z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodNumber, z.ZodBoolean]>>]>>;
+        offeredValues: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodNumber, z.ZodBoolean]>>>>;
+    }, z.core.$strict>>;
+    offScreen: z.ZodOptional<z.ZodObject<{
+        order: z.ZodArray<z.ZodString>;
+        items: z.ZodRecord<z.ZodString, z.ZodObject<{
+            w: z.ZodOptional<z.ZodNumber>;
+            h: z.ZodOptional<z.ZodNumber>;
+            hidden: z.ZodBoolean;
+            props: z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodNumber, z.ZodBoolean, z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodNumber, z.ZodBoolean]>>]>>;
+            offeredValues: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodNumber, z.ZodBoolean]>>>>;
+        }, z.core.$strict>>;
+    }, z.core.$strict>>;
+}, z.core.$strict>;
+export type Layout = z.infer<typeof Layout>;
+export declare const MoveOperation: z.ZodObject<{
+    type: z.ZodLiteral<"move">;
+    id: z.ZodString;
+    position: z.ZodEnum<{
+        after: "after";
+        before: "before";
+        end: "end";
+        start: "start";
+    }>;
+    targetId: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+export type MoveOperation = z.infer<typeof MoveOperation>;
+export declare const ResizeOperation: z.ZodObject<{
+    type: z.ZodLiteral<"resize">;
+    id: z.ZodString;
+    w: z.ZodOptional<z.ZodNumber>;
+    h: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strict>;
+export type ResizeOperation = z.infer<typeof ResizeOperation>;
+export declare const HideOperation: z.ZodObject<{
+    type: z.ZodLiteral<"hide">;
+    id: z.ZodString;
+}, z.core.$strict>;
+export type HideOperation = z.infer<typeof HideOperation>;
+export declare const ShowOperation: z.ZodObject<{
+    type: z.ZodLiteral<"show">;
+    id: z.ZodString;
+}, z.core.$strict>;
+export type ShowOperation = z.infer<typeof ShowOperation>;
+export declare const SetPropOperation: z.ZodObject<{
+    type: z.ZodLiteral<"setProp">;
+    id: z.ZodString;
+    prop: z.ZodString;
+    value: z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodNumber, z.ZodBoolean, z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodNumber, z.ZodBoolean]>>]>;
+}, z.core.$strict>;
+export type SetPropOperation = z.infer<typeof SetPropOperation>;
+export declare const ReorderOperation: z.ZodObject<{
+    type: z.ZodLiteral<"reorder">;
+    ids: z.ZodArray<z.ZodString>;
+}, z.core.$strict>;
+export type ReorderOperation = z.infer<typeof ReorderOperation>;
+export declare const ResetOperation: z.ZodObject<{
+    type: z.ZodLiteral<"reset">;
+    id: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>;
+export type ResetOperation = z.infer<typeof ResetOperation>;
+export declare const Operation: z.ZodUnion<readonly [z.ZodObject<{
+    type: z.ZodLiteral<"move">;
+    id: z.ZodString;
+    position: z.ZodEnum<{
+        after: "after";
+        before: "before";
+        end: "end";
+        start: "start";
+    }>;
+    targetId: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>, z.ZodObject<{
+    type: z.ZodLiteral<"resize">;
+    id: z.ZodString;
+    w: z.ZodOptional<z.ZodNumber>;
+    h: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strict>, z.ZodObject<{
+    type: z.ZodLiteral<"hide">;
+    id: z.ZodString;
+}, z.core.$strict>, z.ZodObject<{
+    type: z.ZodLiteral<"show">;
+    id: z.ZodString;
+}, z.core.$strict>, z.ZodObject<{
+    type: z.ZodLiteral<"setProp">;
+    id: z.ZodString;
+    prop: z.ZodString;
+    value: z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodNumber, z.ZodBoolean, z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodNumber, z.ZodBoolean]>>]>;
+}, z.core.$strict>, z.ZodObject<{
+    type: z.ZodLiteral<"reorder">;
+    ids: z.ZodArray<z.ZodString>;
+}, z.core.$strict>, z.ZodObject<{
+    type: z.ZodLiteral<"reset">;
+    id: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>]>;
+export type Operation = z.infer<typeof Operation>;
+export declare const OperationList: z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
+    type: z.ZodLiteral<"move">;
+    id: z.ZodString;
+    position: z.ZodEnum<{
+        after: "after";
+        before: "before";
+        end: "end";
+        start: "start";
+    }>;
+    targetId: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>, z.ZodObject<{
+    type: z.ZodLiteral<"resize">;
+    id: z.ZodString;
+    w: z.ZodOptional<z.ZodNumber>;
+    h: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strict>, z.ZodObject<{
+    type: z.ZodLiteral<"hide">;
+    id: z.ZodString;
+}, z.core.$strict>, z.ZodObject<{
+    type: z.ZodLiteral<"show">;
+    id: z.ZodString;
+}, z.core.$strict>, z.ZodObject<{
+    type: z.ZodLiteral<"setProp">;
+    id: z.ZodString;
+    prop: z.ZodString;
+    value: z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodNumber, z.ZodBoolean, z.ZodArray<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodNumber, z.ZodBoolean]>>]>;
+}, z.core.$strict>, z.ZodObject<{
+    type: z.ZodLiteral<"reorder">;
+    ids: z.ZodArray<z.ZodString>;
+}, z.core.$strict>, z.ZodObject<{
+    type: z.ZodLiteral<"reset">;
+    id: z.ZodOptional<z.ZodString>;
+}, z.core.$strict>]>>;
+export type OperationList = z.infer<typeof OperationList>;
+export declare const TextParameter: z.ZodObject<{
+    type: z.ZodLiteral<"text">;
+    description: z.ZodOptional<z.ZodString>;
+    required: z.ZodOptional<z.ZodBoolean>;
+    values: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    maxLength: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strict>;
+export type TextParameter = z.infer<typeof TextParameter>;
+export declare const NumberParameter: z.ZodObject<{
+    type: z.ZodLiteral<"number">;
+    description: z.ZodOptional<z.ZodString>;
+    required: z.ZodOptional<z.ZodBoolean>;
+    min: z.ZodOptional<z.ZodNumber>;
+    max: z.ZodOptional<z.ZodNumber>;
+    integer: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strict>;
+export type NumberParameter = z.infer<typeof NumberParameter>;
+export declare const BooleanParameter: z.ZodObject<{
+    type: z.ZodLiteral<"boolean">;
+    description: z.ZodOptional<z.ZodString>;
+    required: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strict>;
+export type BooleanParameter = z.infer<typeof BooleanParameter>;
+export declare const FileParameter: z.ZodObject<{
+    type: z.ZodLiteral<"file">;
+    description: z.ZodOptional<z.ZodString>;
+    required: z.ZodOptional<z.ZodBoolean>;
+    accept: z.ZodOptional<z.ZodArray<z.ZodString>>;
+}, z.core.$strict>;
+export type FileParameter = z.infer<typeof FileParameter>;
+export declare const ActionParameter: z.ZodUnion<readonly [z.ZodObject<{
+    type: z.ZodLiteral<"text">;
+    description: z.ZodOptional<z.ZodString>;
+    required: z.ZodOptional<z.ZodBoolean>;
+    values: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    maxLength: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strict>, z.ZodObject<{
+    type: z.ZodLiteral<"number">;
+    description: z.ZodOptional<z.ZodString>;
+    required: z.ZodOptional<z.ZodBoolean>;
+    min: z.ZodOptional<z.ZodNumber>;
+    max: z.ZodOptional<z.ZodNumber>;
+    integer: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strict>, z.ZodObject<{
+    type: z.ZodLiteral<"boolean">;
+    description: z.ZodOptional<z.ZodString>;
+    required: z.ZodOptional<z.ZodBoolean>;
+}, z.core.$strict>, z.ZodObject<{
+    type: z.ZodLiteral<"file">;
+    description: z.ZodOptional<z.ZodString>;
+    required: z.ZodOptional<z.ZodBoolean>;
+    accept: z.ZodOptional<z.ZodArray<z.ZodString>>;
+}, z.core.$strict>]>;
+export type ActionParameter = z.infer<typeof ActionParameter>;
+export declare const Action: z.ZodObject<{
+    name: z.ZodString;
+    title: z.ZodString;
+    description: z.ZodOptional<z.ZodString>;
+    mode: z.ZodEnum<{
+        read: "read";
+        write: "write";
+    }>;
+    parameters: z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodObject<{
+        type: z.ZodLiteral<"text">;
+        description: z.ZodOptional<z.ZodString>;
+        required: z.ZodOptional<z.ZodBoolean>;
+        values: z.ZodOptional<z.ZodArray<z.ZodString>>;
+        maxLength: z.ZodOptional<z.ZodNumber>;
+    }, z.core.$strict>, z.ZodObject<{
+        type: z.ZodLiteral<"number">;
+        description: z.ZodOptional<z.ZodString>;
+        required: z.ZodOptional<z.ZodBoolean>;
+        min: z.ZodOptional<z.ZodNumber>;
+        max: z.ZodOptional<z.ZodNumber>;
+        integer: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strict>, z.ZodObject<{
+        type: z.ZodLiteral<"boolean">;
+        description: z.ZodOptional<z.ZodString>;
+        required: z.ZodOptional<z.ZodBoolean>;
+    }, z.core.$strict>, z.ZodObject<{
+        type: z.ZodLiteral<"file">;
+        description: z.ZodOptional<z.ZodString>;
+        required: z.ZodOptional<z.ZodBoolean>;
+        accept: z.ZodOptional<z.ZodArray<z.ZodString>>;
+    }, z.core.$strict>]>>;
+}, z.core.$strict>;
+export type Action = z.infer<typeof Action>;
+export declare const ActionArgument: z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>;
+export type ActionArgument = z.infer<typeof ActionArgument>;
+export declare const ActionCall: z.ZodObject<{
+    name: z.ZodString;
+    arguments: z.ZodRecord<z.ZodString, z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>;
+}, z.core.$strict>;
+export type ActionCall = z.infer<typeof ActionCall>;

package/dist/core/validateActionCalls.d.ts

@@ -0,0 +1,28 @@
+import type { Action, ActionCall } from "./schemas.gen.js";
+export type ActionCallErrorCode = "unknown_action" | "unknown_argument" | "missing_argument" | "invalid_argument";
+export interface ActionCallError {
+    /** Position of the offending call in the list. */
+    index: number;
+    code: ActionCallErrorCode;
+    message: string;
+}
+/** What a call is told about a file the user attached: only its media type, never its content. */
+export interface AttachedFile {
+    type: string;
+}
+/**
+ * Checks every call against the actions declared, and reports at most one error
+ * per call. The check order is part of the contract shared with the Python
+ * engine: the action exists, then each argument is one it declares (in the
+ * order the call gives them), then each required parameter is given and each
+ * value is one it accepts (in the order the action declares them).
+ */
+export declare function validateActionCalls(actions: readonly Action[], actionCalls: readonly ActionCall[], attachedFiles?: readonly AttachedFile[]): ActionCallError[];
+/** Whether a media type is one of `accept`, where `image/*` stands for every image type. */
+export declare function fileTypeAccepted(acceptedTypes: readonly string[] | undefined, fileType: string): boolean;
+/**
+ * Why a list of actions cannot be offered, or undefined if it can: two with one
+ * name, a parameter with a name a call could not use, or a number range that
+ * holds nothing. Worded as the engine words it.
+ */
+export declare function findActionsFailure(actions: readonly Action[]): string | undefined;

package/dist/core/validateManifest.d.ts

@@ -0,0 +1,11 @@
+import type { Manifest } from "./schemas.gen.js";
+/**
+ * Why a manifest that passes its schema still cannot be used, or undefined
+ * when it can: a component with half a default size, one that can be resized
+ * but has no default size, one resized between limits that contradict each
+ * other or its default size, or one with a list that must hold an entry it
+ * does not offer. The engine refuses the same manifests with the
+ * same messages (its `validate_manifest`), on top of the request limits it
+ * alone enforces.
+ */
+export declare function findManifestFailure(manifest: Manifest): string | undefined;

package/dist/core/validateOperations.d.ts

@@ -0,0 +1,15 @@
+import type { Manifest, Operation } from "./schemas.gen.js";
+export type OperationErrorCode = "unknown_component" | "locked" | "capability_not_allowed" | "invalid_target" | "invalid_operation" | "out_of_bounds" | "unknown_prop" | "invalid_value" | "empty_region";
+export interface OperationError {
+    /** Position of the offending operation in the list. */
+    index: number;
+    code: OperationErrorCode;
+    message: string;
+}
+/**
+ * Checks every operation against the manifest and reports at most one error per
+ * operation. The check order is part of the contract shared with the Python
+ * engine: component exists, not locked, capability declared, then the
+ * operation's own arguments.
+ */
+export declare function validateOperations(manifest: Manifest, operations: readonly Operation[]): OperationError[];