@krizaka/ui 3.20.0 → 3.22.0

package/dist/force-update-screen.d.ts

@@ -0,0 +1,80 @@
+import * as tailwind_variants from 'tailwind-variants';
+import * as React from 'react';
+
+declare const forceUpdateScreen: tailwind_variants.TVReturnType<{
+    [key: string]: {
+        [key: string]: tailwind_variants.ClassValue | {
+            mark?: tailwind_variants.ClassValue;
+            title?: tailwind_variants.ClassValue;
+            version?: tailwind_variants.ClassValue;
+            root?: tailwind_variants.ClassValue;
+            message?: tailwind_variants.ClassValue;
+            actions?: tailwind_variants.ClassValue;
+        };
+    };
+} | {
+    [x: string]: {
+        [x: string]: tailwind_variants.ClassValue | {
+            mark?: tailwind_variants.ClassValue;
+            title?: tailwind_variants.ClassValue;
+            version?: tailwind_variants.ClassValue;
+            root?: tailwind_variants.ClassValue;
+            message?: tailwind_variants.ClassValue;
+            actions?: tailwind_variants.ClassValue;
+        };
+    };
+} | {}, {
+    root: string;
+    mark: string;
+    title: string;
+    message: string;
+    version: string;
+    actions: string;
+}, undefined, {
+    [key: string]: {
+        [key: string]: tailwind_variants.ClassValue | {
+            mark?: tailwind_variants.ClassValue;
+            title?: tailwind_variants.ClassValue;
+            version?: tailwind_variants.ClassValue;
+            root?: tailwind_variants.ClassValue;
+            message?: tailwind_variants.ClassValue;
+            actions?: tailwind_variants.ClassValue;
+        };
+    };
+} | {}, {
+    root: string;
+    mark: string;
+    title: string;
+    message: string;
+    version: string;
+    actions: string;
+}, tailwind_variants.TVReturnTypeLike<unknown, {
+    root: string;
+    mark: string;
+    title: string;
+    message: string;
+    version: string;
+    actions: string;
+}>>;
+type ForceUpdateScreenProps = Omit<React.ComponentProps<"main">, "title"> & {
+    /** The headline (“Update to keep going”). */
+    title: React.ReactNode;
+    /** Why, in a sentence — the backend's localized `message`. */
+    message?: React.ReactNode;
+    /** The versions, in words and mono (“You have 1.1.0 · 1.2.0 or later is required”). */
+    versionLabel?: React.ReactNode;
+    /** The product's mark or mascot (decorative). */
+    mark?: React.ReactNode;
+    /** The button that updates (“Update the app”). */
+    updateLabel: string;
+    /** Opens the store page. */
+    onUpdate: () => void;
+    /** A secondary way (“Check again”) once the update is installed — optional. */
+    retryLabel?: string;
+    /** Checks the backend again. */
+    onRetry?: () => void;
+};
+/** The forced update: one thing to do, and the way to do it. */
+declare function ForceUpdateScreen({ title, message, versionLabel, mark, updateLabel, onUpdate, retryLabel, onRetry, className, ...props }: ForceUpdateScreenProps): React.JSX.Element;
+
+export { ForceUpdateScreen, type ForceUpdateScreenProps, forceUpdateScreen };

package/dist/force-update-screen.js

@@ -0,0 +1,38 @@
+import "./chunk-TDG7ED2W.js";
+import {
+  Button
+} from "./chunk-3IN6TOPM.js";
+import "./chunk-43PTCDTL.js";
+import "./chunk-2VNYHG4E.js";
+
+// src/force-update-screen/force-update-screen.tsx
+import { tv } from "tailwind-variants";
+import { jsx, jsxs } from "react/jsx-runtime";
+var forceUpdateScreen = tv({
+  slots: {
+    root: "mx-auto flex min-h-dvh w-full max-w-md flex-col items-center justify-center gap-4 px-6 py-12 text-center text-fg",
+    mark: "flex h-24 w-24 items-center justify-center [&>svg]:h-24 [&>svg]:w-24",
+    title: "text-2xl font-semibold text-fg",
+    message: "text-fg-secondary",
+    version: "font-mono text-xs text-fg-tertiary",
+    actions: "mt-2 flex w-full flex-col gap-2"
+  }
+});
+function ForceUpdateScreen({ title, message, versionLabel, mark, updateLabel, onUpdate, retryLabel, onRetry, className, ...props }) {
+  const s = forceUpdateScreen();
+  return /* @__PURE__ */ jsxs("main", { "data-kind": "update-force", className: s.root({ className }), ...props, children: [
+    mark && /* @__PURE__ */ jsx("div", { "aria-hidden": true, className: s.mark(), children: mark }),
+    /* @__PURE__ */ jsx("h1", { className: s.title(), children: title }),
+    message && /* @__PURE__ */ jsx("p", { className: s.message(), children: message }),
+    versionLabel && /* @__PURE__ */ jsx("p", { className: s.version(), children: versionLabel }),
+    /* @__PURE__ */ jsxs("div", { className: s.actions(), children: [
+      /* @__PURE__ */ jsx(Button, { variant: "primary", size: "lg", shape: "cut", shimmer: true, autoFocus: true, onClick: onUpdate, children: updateLabel }),
+      retryLabel && onRetry && /* @__PURE__ */ jsx(Button, { variant: "ghost", onClick: onRetry, children: retryLabel })
+    ] })
+  ] });
+}
+export {
+  ForceUpdateScreen,
+  forceUpdateScreen
+};
+//# sourceMappingURL=force-update-screen.js.map

package/dist/force-update-screen.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/force-update-screen/force-update-screen.tsx"],"sourcesContent":["// Server-safe. The blocking screen: this version can no longer run. It replaces the app, it is not laid over it —\n// nothing behind it is reachable. Every word is a prop; the store URL and the versions come from the backend.\nimport { Button } from \"@krizaka/ui/button\";\nimport type * as React from \"react\";\nimport { tv } from \"tailwind-variants\";\n\nexport const forceUpdateScreen = tv({\n  slots: {\n    root: \"mx-auto flex min-h-dvh w-full max-w-md flex-col items-center justify-center gap-4 px-6 py-12 text-center text-fg\",\n    mark: \"flex h-24 w-24 items-center justify-center [&>svg]:h-24 [&>svg]:w-24\",\n    title: \"text-2xl font-semibold text-fg\",\n    message: \"text-fg-secondary\",\n    version: \"font-mono text-xs text-fg-tertiary\",\n    actions: \"mt-2 flex w-full flex-col gap-2\",\n  },\n});\n\nexport type ForceUpdateScreenProps = Omit<React.ComponentProps<\"main\">, \"title\"> & {\n  /** The headline (“Update to keep going”). */\n  title: React.ReactNode;\n  /** Why, in a sentence — the backend's localized `message`. */\n  message?: React.ReactNode;\n  /** The versions, in words and mono (“You have 1.1.0 · 1.2.0 or later is required”). */\n  versionLabel?: React.ReactNode;\n  /** The product's mark or mascot (decorative). */\n  mark?: React.ReactNode;\n  /** The button that updates (“Update the app”). */\n  updateLabel: string;\n  /** Opens the store page. */\n  onUpdate: () => void;\n  /** A secondary way (“Check again”) once the update is installed — optional. */\n  retryLabel?: string;\n  /** Checks the backend again. */\n  onRetry?: () => void;\n};\n\n/** The forced update: one thing to do, and the way to do it. */\nexport function ForceUpdateScreen({ title, message, versionLabel, mark, updateLabel, onUpdate, retryLabel, onRetry, className, ...props }: ForceUpdateScreenProps) {\n  const s = forceUpdateScreen();\n  return (\n    <main data-kind=\"update-force\" className={s.root({ className })} {...props}>\n      {mark && (\n        <div aria-hidden className={s.mark()}>\n          {mark}\n        </div>\n      )}\n      <h1 className={s.title()}>{title}</h1>\n      {message && <p className={s.message()}>{message}</p>}\n      {versionLabel && <p className={s.version()}>{versionLabel}</p>}\n      <div className={s.actions()}>\n        <Button variant=\"primary\" size=\"lg\" shape=\"cut\" shimmer autoFocus onClick={onUpdate}>\n          {updateLabel}\n        </Button>\n        {retryLabel && onRetry && (\n          <Button variant=\"ghost\" onClick={onRetry}>\n            {retryLabel}\n          </Button>\n        )}\n      </div>\n    </main>\n  );\n}\n"],"mappings":";;;;;;;;AAIA,SAAS,UAAU;AAsCX,cAOF,YAPE;AApCD,IAAM,oBAAoB,GAAG;AAAA,EAClC,OAAO;AAAA,IACL,MAAM;AAAA,IACN,MAAM;AAAA,IACN,OAAO;AAAA,IACP,SAAS;AAAA,IACT,SAAS;AAAA,IACT,SAAS;AAAA,EACX;AACF,CAAC;AAsBM,SAAS,kBAAkB,EAAE,OAAO,SAAS,cAAc,MAAM,aAAa,UAAU,YAAY,SAAS,WAAW,GAAG,MAAM,GAA2B;AACjK,QAAM,IAAI,kBAAkB;AAC5B,SACE,qBAAC,UAAK,aAAU,gBAAe,WAAW,EAAE,KAAK,EAAE,UAAU,CAAC,GAAI,GAAG,OAClE;AAAA,YACC,oBAAC,SAAI,eAAW,MAAC,WAAW,EAAE,KAAK,GAChC,gBACH;AAAA,IAEF,oBAAC,QAAG,WAAW,EAAE,MAAM,GAAI,iBAAM;AAAA,IAChC,WAAW,oBAAC,OAAE,WAAW,EAAE,QAAQ,GAAI,mBAAQ;AAAA,IAC/C,gBAAgB,oBAAC,OAAE,WAAW,EAAE,QAAQ,GAAI,wBAAa;AAAA,IAC1D,qBAAC,SAAI,WAAW,EAAE,QAAQ,GACxB;AAAA,0BAAC,UAAO,SAAQ,WAAU,MAAK,MAAK,OAAM,OAAM,SAAO,MAAC,WAAS,MAAC,SAAS,UACxE,uBACH;AAAA,MACC,cAAc,WACb,oBAAC,UAAO,SAAQ,SAAQ,SAAS,SAC9B,sBACH;AAAA,OAEJ;AAAA,KACF;AAEJ;","names":[]}

package/dist/genui.d.ts

@@ -0,0 +1,219 @@
+import * as React from 'react';
+
+/** The protocol version every message carries. */
+declare const GENUI_VERSION = "v0.9";
+/** The catalog a surface must name: the Krizaka components, version 1. */
+declare const GENUI_CATALOG_ID = "krizaka:genui/v1";
+/** The bounds of a surface — what a model may ask for, at most. */
+declare const GENUI_LIMITS: {
+    /** Components per surface. */
+    readonly components: 300;
+    /** Nesting depth from the root. */
+    readonly depth: 12;
+    /** Characters in one string. */
+    readonly string: 4000;
+    /** Items in one array of the data model. */
+    readonly array: 1000;
+    /** Nesting depth of a data model value. */
+    readonly dataDepth: 12;
+    /** Values (objects, arrays, scalars) in one data model update. */
+    readonly dataNodes: 50000;
+    /** Segments of a data path. */
+    readonly pathSegments: 16;
+};
+/** One component as the model writes it: an id, the catalog name, its properties. */
+type GenUiComponent = {
+    readonly id: string;
+    readonly component: string;
+} & Readonly<Record<string, unknown>>;
+/** A value bound to the data model: `{ "path": "/rows" }`. */
+type GenUiBinding = {
+    readonly path: string;
+};
+/** The four messages of A2UI v0.9. */
+type GenUiMessage = {
+    readonly version: typeof GENUI_VERSION;
+    readonly createSurface: {
+        readonly surfaceId: string;
+        readonly catalogId: string;
+    };
+} | {
+    readonly version: typeof GENUI_VERSION;
+    readonly updateComponents: {
+        readonly surfaceId: string;
+        readonly components: readonly GenUiComponent[];
+    };
+} | {
+    readonly version: typeof GENUI_VERSION;
+    readonly updateDataModel: {
+        readonly surfaceId: string;
+        readonly path: string;
+        readonly value?: unknown;
+    };
+} | {
+    readonly version: typeof GENUI_VERSION;
+    readonly deleteSurface: {
+        readonly surfaceId: string;
+    };
+};
+/** What validating a message says. */
+type GenUiResult<T> = {
+    readonly ok: true;
+    readonly value: T;
+} | {
+    readonly ok: false;
+    readonly error: string;
+};
+/** How a catalog entry checks a component's own properties: `null` when they are fine, else why not. */
+type GenUiPropsCheck = (component: GenUiComponent) => string | null;
+/** An id of a surface or a component, or why not. */
+declare function checkId(value: unknown, where: string): string | null;
+/** The segments of a JSON pointer (`/a/b/0`), or why it is refused — `__proto__` and friends never pass. */
+declare function parsePath(path: unknown): GenUiResult<readonly string[]>;
+/** `true` when the value is a binding `{ path }` (and only that). */
+declare function isBinding(value: unknown): value is GenUiBinding;
+/**
+ * A copy of a data model value that is plain JSON within the limits — strings, finite numbers, booleans, null, arrays
+ * and plain objects — or why it is refused. The copy has a null prototype for every object: nothing it holds can
+ * reach `Object.prototype`.
+ */
+declare function sanitizeData(value: unknown): GenUiResult<unknown>;
+/**
+ * A message as the model sent it — parsed and checked against the spec and the catalog, or why it is refused. A
+ * component's own properties are checked by its catalog entry; a component the catalog does not hold is refused.
+ */
+declare function validateMessage(input: unknown, catalog: Readonly<Record<string, {
+    readonly check: GenUiPropsCheck;
+}>>): GenUiResult<GenUiMessage>;
+/** Why the component's keys are refused, or null: only `id`, `component` and the entry's own keys. */
+declare function allowKeys(component: GenUiComponent, keys: readonly string[]): string | null;
+/** A short text (or a binding to one), required or not. */
+declare function checkText(value: unknown, name: string, required: boolean): string | null;
+/** A value among a closed list. */
+declare function checkEnum(value: unknown, name: string, allowed: readonly string[], required?: boolean): string | null;
+/** A list of child ids. */
+declare function checkChildren(value: unknown, name?: string): string | null;
+/** A binding to the data model (required). */
+declare function checkBinding(value: unknown, name: string): string | null;
+/** A number, or a binding to one. */
+declare function checkNumber(value: unknown, name: string, required: boolean): string | null;
+/** The value formats a model may name. */
+declare const GENUI_FORMATS: readonly ["number", "integer", "compact", "percent", "money"];
+type GenUiFormat = (typeof GENUI_FORMATS)[number];
+/** A three-letter currency code. */
+declare function checkCurrency(value: unknown, required: boolean): string | null;
+
+/** One surface: its components by id, and its data model. */
+type GenUiSurfaceState = {
+    readonly id: string;
+    readonly components: ReadonlyMap<string, GenUiComponent>;
+    readonly data: unknown;
+};
+/** Every surface of a stream, and what was refused on the way. */
+type GenUiState = {
+    readonly surfaces: ReadonlyMap<string, GenUiSurfaceState>;
+    /** The order surfaces were created in. */
+    readonly order: readonly string[];
+    /** Why messages were dropped, in order (a dropped message leaves the rest of the surface as it was). */
+    readonly errors: readonly string[];
+};
+declare const emptyGenUiState: GenUiState;
+/** The value at a JSON pointer of the data model, `undefined` when there is none. */
+declare function readPath(data: unknown, path: string): unknown;
+/** The state after one validated message. */
+declare function applyMessage(state: GenUiState, message: GenUiMessage): GenUiState;
+/** The state after a line of JSON (one message), the line refused with its reason when it is not valid. */
+declare function applyLine(state: GenUiState, line: string, catalog: Readonly<Record<string, {
+    readonly check: GenUiPropsCheck;
+}>>): GenUiState;
+/** Where a fenced `a2ui` block sits in a text: its JSON Lines so far, whether it is closed, and the prose around it. */
+type GenUiExtract = {
+    readonly lines: readonly string[];
+    readonly closed: boolean;
+    readonly prose: string;
+    readonly found: boolean;
+};
+/**
+ * Splits a model's answer — complete or still arriving — into its prose and the complete lines of its `a2ui` fence.
+ * A line still being written (no newline yet, the fence open) is left for the next call: the surface grows message by
+ * message as the answer streams.
+ */
+declare function extractGenUi(text: string): GenUiExtract;
+/** The state of every surface a model's answer describes so far. */
+declare function readStream(text: string, catalog: Readonly<Record<string, {
+    readonly check: GenUiPropsCheck;
+}>>): GenUiState & {
+    readonly prose: string;
+    readonly found: boolean;
+};
+
+/** What an entry gets to draw a component. */
+type GenUiRenderContext = {
+    /** A child by id: drawn, a skeleton while it has not arrived, nothing when refused. */
+    child: (id: unknown) => React.ReactNode;
+    /** Children by id, in order. */
+    children: (ids: unknown) => React.ReactNode[];
+    /** A literal, or the value a binding `{ path }` points at in the data model. */
+    resolve: (value: unknown) => unknown;
+    /** The words of the surface. */
+    labels: GenUiLabels;
+    /** The locale numbers and dates are written in. */
+    locale: string;
+};
+/** One component of a catalog: how its properties are checked, how it is drawn. */
+type GenUiEntry = {
+    /** `null` when the component's own properties are fine, else why not (the message is refused). */
+    readonly check: GenUiPropsCheck;
+    /** Draws the component. */
+    readonly render: (component: GenUiComponent, context: GenUiRenderContext) => React.ReactNode;
+};
+/** The components a model may use, by name: `baseGenUiCatalog`, merged with `chartsGenUiCatalog` of @krizaka/charts. */
+type GenUiCatalog = Readonly<Record<string, GenUiEntry>>;
+/** The surface's own words (passed translated). */
+type GenUiLabels = {
+    /** Announced while the surface is still arriving. */
+    loading: string;
+    /** The accessible name of the surface. */
+    surface: string;
+    /** Under a table whose data has not arrived or is not a list. */
+    noData: string;
+};
+declare const genUiLabels: GenUiLabels;
+type GenUiSurfaceProps = {
+    /** The surface to draw (from `readStream` or `applyMessage`). */
+    surface: GenUiSurfaceState;
+    /** The components it may use. */
+    catalog: GenUiCatalog;
+    /** The answer is still arriving: missing children are skeletons and the surface is busy. */
+    streaming?: boolean;
+    /** The surface's words. */
+    labels?: Partial<GenUiLabels>;
+    /** The locale numbers are written in. Default `en`. */
+    locale?: string;
+    /** Called with what could not be drawn (a cycle, a missing child once the answer is complete). */
+    onError?: (error: string) => void;
+    /** Extra classes on the frame. */
+    className?: string;
+};
+/** One surface, drawn from its root. */
+declare function GenUiSurface({ surface, catalog, streaming, labels, locale, onError, className }: GenUiSurfaceProps): React.JSX.Element;
+type GenUiStreamProps = Omit<GenUiSurfaceProps, "surface"> & {
+    /** A model's answer, complete or still arriving: its prose and its `a2ui` fence. */
+    text: string;
+    /** Draws the prose (markdown in a chat); default: paragraphs of text. */
+    renderProse?: (prose: string) => React.ReactNode;
+    /** What to show when the answer holds no valid surface: the answer itself, as text (the fallback). */
+    fallback?: (text: string) => React.ReactNode;
+};
+/**
+ * A model's answer with its generated view: the prose, then every surface of its `a2ui` fence, growing as the answer
+ * streams. An answer without a valid surface falls back to its text.
+ */
+declare function GenUiStream({ text, catalog, streaming, renderProse, fallback, onError, ...rest }: GenUiStreamProps): React.JSX.Element;
+
+/** A number written in one of the closed formats. */
+declare function formatGenUiValue(value: unknown, format: GenUiFormat | undefined, locale: string, currency?: string): string;
+/** `Column`, `Row`, `Text`, `Card`, `Callout`, `Table` — the catalog @krizaka/ui draws on its own. */
+declare const baseGenUiCatalog: GenUiCatalog;
+
+export { GENUI_CATALOG_ID, GENUI_FORMATS, GENUI_LIMITS, GENUI_VERSION, type GenUiBinding, type GenUiCatalog, type GenUiComponent, type GenUiEntry, type GenUiExtract, type GenUiFormat, type GenUiLabels, type GenUiMessage, type GenUiPropsCheck, type GenUiRenderContext, type GenUiResult, type GenUiState, GenUiStream, type GenUiStreamProps, GenUiSurface, type GenUiSurfaceProps, type GenUiSurfaceState, allowKeys, applyLine, applyMessage, baseGenUiCatalog, checkBinding, checkChildren, checkCurrency, checkEnum, checkId, checkNumber, checkText, emptyGenUiState, extractGenUi, formatGenUiValue, genUiLabels, isBinding, parsePath, readPath, readStream, sanitizeData, validateMessage };