@ketvietlab/ketsuite 0.1.17 → 0.1.19

package/dist/modules/backend/design/content.css

@@ -597,6 +597,11 @@
     }
   }
 
+  /* A record modal island's host holds no content until the island opens it. */
+  [data-ui="record-modal-host"] {
+    display: none;
+  }
+
   @media (max-width: 47.9375rem) {
     /* A button sits in a row with the fields it submits, so it is the height of
        one. The 2.75rem touch target this used to take stood half again as tall

package/dist/scaffold/index.js

@@ -1,6 +1,6 @@
 import { existsSync, mkdirSync, readFileSync, writeFileSync } from 'node:fs';
 import { join } from 'node:path';
-const VERSION = '0.1.17';
+const VERSION = '0.1.19';
 const TEMPLATES = new URL('./templates/', import.meta.url);
 const LAYOUT = [
     ['package.json.tmpl', 'package.json'],

package/dist/ui/client/record-modal.d.ts

@@ -0,0 +1,150 @@
+import type { IslandController, JSXChild, TemplateResult } from '@ketvietlab/ketjs-view';
+import { RECORD_PARAM, RECORD_TAB_PARAM, readRecordModalTarget, recordModalClosedHref, recordModalHref } from '../record-modal.tsx';
+export type RecordIssue = {
+    field: string | null;
+    code: string;
+    message: string | null;
+    params: Record<string, unknown>;
+};
+export type RecordCallResult<Value = unknown> = {
+    ok: true;
+    value: Value;
+} | {
+    ok: false;
+    issues: RecordIssue[];
+    message: string | null;
+    status: number;
+};
+/**
+ * Call a server function as the signed-in viewer.
+ *
+ * A domain refusal (`{ ok: false, errors }` inside the value) and a transport or
+ * permission refusal (`ok: false` on the envelope) come back in one shape, so a
+ * view never has to know which layer said no.
+ */
+export declare const callRecordFunction: <Value = unknown>(name: string, input: Record<string, unknown>, options?: {
+    signal?: AbortSignal;
+    idempotencyKey?: string;
+}) => Promise<RecordCallResult<Value>>;
+/** What every record context read must return next to its data. */
+export type RecordContextEnvelope<Data> = {
+    data: Data;
+    /** Translated strings this record's views use, including `recordModal.*` runtime labels. */
+    messages: Record<string, string>;
+};
+export type RecordModalContext<Data> = {
+    kind: string;
+    id: string;
+    tab: string;
+    data: Data;
+    /** Translate a key the context shipped, interpolating `{name}` params. */
+    t: (key: string, params?: Record<string, unknown>) => string;
+    /** The refusal for one field of the last submit, translated. */
+    fieldError: (name: string) => string | null;
+    /** What was typed into a field before a refused submit, or the fallback. */
+    draft: (name: string, fallback?: string) => string;
+    /** A submit is in flight. */
+    busy: boolean;
+    dialog: {
+        name: string;
+        params: Record<string, string>;
+    } | null;
+    href: (tab: string) => string;
+    /** View-local state, set by `data-record-state` controls (click, or change for inputs). */
+    state: (key: string, fallback?: string) => string;
+};
+/** Attachments a command uploaded before its function ran, by form field. */
+export type RecordUploads = Record<string, {
+    id: string;
+    name: string | null;
+}>;
+export type RecordModalCommand<Data> = {
+    fn: string;
+    /** Map the submitted form to the function's input. */
+    input: (form: FormData, context: RecordModalContext<Data>, uploads: RecordUploads) => Record<string, unknown>;
+    /**
+     * File fields stored through `/files` before the function runs, each mapped to
+     * the attachment's metadata (`resModel`, `resId`, `resField`, `public`). The
+     * stored attachment ids reach `input` as its third argument.
+     */
+    upload?: Record<string, (form: FormData, context: RecordModalContext<Data>) => Record<string, string>>;
+    /**
+     * What happens after success. Defaults to `close`. `reload` reads the record
+     * again behind a loading state and closes a dialog; `refresh` reads it again in
+     * place, keeping the tab, the open dialog and any islands mounted in them.
+     */
+    after?: 'close' | 'reload' | 'refresh' | 'stay' | {
+        tab: string;
+    } | {
+        dialog: string | null;
+    };
+};
+export type RecordModalTab<Data> = {
+    id: string;
+    label: (context: RecordModalContext<Data>) => string;
+    visible?: (context: RecordModalContext<Data>) => boolean;
+    view: (context: RecordModalContext<Data>) => JSXChild;
+};
+export type RecordModalDialog<Data> = {
+    title: (context: RecordModalContext<Data>) => string;
+    size?: 'default' | 'large';
+    view: (context: RecordModalContext<Data>) => JSXChild;
+};
+export type RecordModalDefinition<Data> = {
+    kind: string;
+    size?: 'default' | 'large';
+    /** A permission-checked read returning `{ data, messages }`. */
+    context: {
+        fn: string;
+        input?: (id: string) => Record<string, unknown>;
+    };
+    title: (context: RecordModalContext<Data>) => string;
+    description?: (context: RecordModalContext<Data>) => string | null;
+    header?: (context: RecordModalContext<Data>) => JSXChild;
+    tabs?: readonly RecordModalTab<Data>[];
+    /** The body of a record without tabs. */
+    body?: (context: RecordModalContext<Data>) => JSXChild;
+    dialogs?: Record<string, RecordModalDialog<Data>>;
+    commands?: Record<string, RecordModalCommand<Data>>;
+    /**
+     * Runtime labels (`recordModal.*`) in the page's language, available before the
+     * record's context has loaded. Without them the loading state has only the
+     * built-in English defaults, because `messages` arrive with the context.
+     */
+    labels?: Record<string, string> | (() => Record<string, string>);
+};
+/**
+ * English defaults for every label the runtime itself shows. A module passes its
+ * own language through `labels`; these only guarantee a reader never sees a key.
+ */
+export declare const RECORD_MODAL_LABELS: Readonly<Record<string, string>>;
+/**
+ * The text for a key: the loaded context's messages, then the messages of the
+ * last record this modal opened, then the module's labels, then the defaults.
+ * Only an unknown key falls through to itself.
+ */
+export declare const resolveRecordModalLabel: (key: string, sources: {
+    messages?: Record<string, string> | null;
+    previous?: Record<string, string> | null;
+    labels?: Record<string, string> | null;
+}) => string;
+/** Field a form (or its submitter) uses to name the command it runs. */
+export declare const RECORD_COMMAND_FIELD = "__command";
+/** Field a link or button uses to open a dialog of the same record. */
+export declare const RECORD_DIALOG_ATTRIBUTE = "data-record-dialog";
+/** Whether anything in a layer was typed into since it rendered. Same rule as route modals. */
+export declare const recordLayerHasDraft: (layer: HTMLElement) => boolean;
+/**
+ * Create the island controller for one record kind.
+ *
+ * The returned factory is what a module exports as its island client:
+ * `export const followupModal = createRecordModal(definition)`.
+ */
+export declare const createRecordModal: <Data>(definition: RecordModalDefinition<Data>) => () => IslandController;
+/**
+ * Place an island inside a record view. The runtime starts it when the host
+ * appears and disposes it when the host leaves; props must be JSON.
+ */
+export declare const recordIsland: (name: string, props: Record<string, unknown>) => TemplateResult;
+export { RECORD_PARAM, RECORD_TAB_PARAM, recordModalHref, recordModalClosedHref, readRecordModalTarget };
+//# sourceMappingURL=record-modal.d.ts.map

package/dist/ui/client/record-modal.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"record-modal.d.ts","sourceRoot":"","sources":["../../../../../../packages/ketsuite/src/ui/client/record-modal.tsx"],"names":[],"mappings":"AAaA,OAAO,KAAK,EAAE,gBAAgB,EAAE,QAAQ,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAA;AAExF,OAAO,EACL,YAAY,EACZ,gBAAgB,EAChB,qBAAqB,EACrB,qBAAqB,EAErB,eAAe,EAChB,MAAM,qBAAqB,CAAA;AAI5B,MAAM,MAAM,WAAW,GAAG;IACxB,KAAK,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;IACtB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAChC,CAAA;AAED,MAAM,MAAM,gBAAgB,CAAC,KAAK,GAAG,OAAO,IACxC;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,KAAK,EAAE,KAAK,CAAA;CAAE,GAC1B;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,MAAM,EAAE,WAAW,EAAE,CAAC;IAAC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAAA;AAqBhF;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB,GAAU,KAAK,GAAG,OAAO,QAChD,MAAM,SACL,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,YACrB;IAAE,MAAM,CAAC,EAAE,WAAW,CAAC;IAAC,cAAc,CAAC,EAAE,MAAM,CAAA;CAAE,KACzD,OAAO,CAAC,gBAAgB,CAAC,KAAK,CAAC,CA4BjC,CAAA;AAID,mEAAmE;AACnE,MAAM,MAAM,qBAAqB,CAAC,IAAI,IAAI;IACxC,IAAI,EAAE,IAAI,CAAA;IACV,4FAA4F;IAC5F,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CACjC,CAAA;AAED,MAAM,MAAM,kBAAkB,CAAC,IAAI,IAAI;IACrC,IAAI,EAAE,MAAM,CAAA;IACZ,EAAE,EAAE,MAAM,CAAA;IACV,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,IAAI,CAAA;IACV,0EAA0E;IAC1E,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAK,MAAM,CAAA;IAC5D,gEAAgE;IAChE,UAAU,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,GAAG,IAAI,CAAA;IAC3C,4EAA4E;IAC5E,KAAK,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,MAAM,CAAA;IAClD,6BAA6B;IAC7B,IAAI,EAAE,OAAO,CAAA;IACb,MAAM,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KAAE,GAAG,IAAI,CAAA;IAC/D,IAAI,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,MAAM,CAAA;IAC7B,2FAA2F;IAC3F,KAAK,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,KAAK,MAAM,CAAA;CAClD,CAAA;AAED,6EAA6E;AAC7E,MAAM,MAAM,aAAa,GAAG,MAAM,CAAC,MAAM,EAAE;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;CAAE,CAAC,CAAA;AAE/E,MAAM,MAAM,kBAAkB,CAAC,IAAI,IAAI;IACrC,EAAE,EAAE,MAAM,CAAA;IACV,sDAAsD;IACtD,KAAK,EAAE,CACL,IAAI,EAAE,QAAQ,EACd,OAAO,EAAE,kBAAkB,CAAC,IAAI,CAAC,EACjC,OAAO,EAAE,aAAa,KACnB,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC5B;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,kBAAkB,CAAC,IAAI,CAAC,KAAK,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA;IACtG;;;;OAIG;IACH,KAAK,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,SAAS,GAAG,MAAM,GAAG;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,GAAG;QAAE,MAAM,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,CAAA;CAC9F,CAAA;AAED,MAAM,MAAM,cAAc,CAAC,IAAI,IAAI;IACjC,EAAE,EAAE,MAAM,CAAA;IACV,KAAK,EAAE,CAAC,OAAO,EAAE,kBAAkB,CAAC,IAAI,CAAC,KAAK,MAAM,CAAA;IACpD,OAAO,CAAC,EAAE,CAAC,OAAO,EAAE,kBAAkB,CAAC,IAAI,CAAC,KAAK,OAAO,CAAA;IACxD,IAAI,EAAE,CAAC,OAAO,EAAE,kBAAkB,CAAC,IAAI,CAAC,KAAK,QAAQ,CAAA;CACtD,CAAA;AAED,MAAM,MAAM,iBAAiB,CAAC,IAAI,IAAI;IACpC,KAAK,EAAE,CAAC,OAAO,EAAE,kBAAkB,CAAC,IAAI,CAAC,KAAK,MAAM,CAAA;IACpD,IAAI,CAAC,EAAE,SAAS,GAAG,OAAO,CAAA;IAC1B,IAAI,EAAE,CAAC,OAAO,EAAE,kBAAkB,CAAC,IAAI,CAAC,KAAK,QAAQ,CAAA;CACtD,CAAA;AAED,MAAM,MAAM,qBAAqB,CAAC,IAAI,IAAI;IACxC,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,SAAS,GAAG,OAAO,CAAA;IAC1B,gEAAgE;IAChE,OAAO,EAAE;QAAE,EAAE,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAAE,CAAA;IACxE,KAAK,EAAE,CAAC,OAAO,EAAE,kBAAkB,CAAC,IAAI,CAAC,KAAK,MAAM,CAAA;IACpD,WAAW,CAAC,EAAE,CAAC,OAAO,EAAE,kBAAkB,CAAC,IAAI,CAAC,KAAK,MAAM,GAAG,IAAI,CAAA;IAClE,MAAM,CAAC,EAAE,CAAC,OAAO,EAAE,kBAAkB,CAAC,IAAI,CAAC,KAAK,QAAQ,CAAA;IACxD,IAAI,CAAC,EAAE,SAAS,cAAc,CAAC,IAAI,CAAC,EAAE,CAAA;IACtC,yCAAyC;IACzC,IAAI,CAAC,EAAE,CAAC,OAAO,EAAE,kBAAkB,CAAC,IAAI,CAAC,KAAK,QAAQ,CAAA;IACtD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAA;IACjD,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAA;IACnD;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,MAAM,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAA;CACjE,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,mBAAmB,EAAE,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAU/D,CAAA;AAEF;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,QAC7B,MAAM,WACF;IACP,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI,CAAA;IACxC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI,CAAA;IACxC,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,IAAI,CAAA;CACvC,KACA,MAKE,CAAA;AAEL,wEAAwE;AACxE,eAAO,MAAM,oBAAoB,cAAc,CAAA;AAC/C,uEAAuE;AACvE,eAAO,MAAM,uBAAuB,uBAAuB,CAAA;AA0B3D,+FAA+F;AAC/F,eAAO,MAAM,mBAAmB,UAAW,WAAW,KAAG,OAcxD,CAAA;AA4BD;;;;;GAKG;AACH,eAAO,MAAM,iBAAiB,GAC3B,IAAI,cAAe,qBAAqB,CAAC,IAAI,CAAC,WAC3C,gBA8mBH,CAAA;AAEH;;;GAGG;AACH,eAAO,MAAM,YAAY,SAAU,MAAM,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,KAAG,cAE3E,CAAA;AAED,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,eAAe,EAAE,qBAAqB,EAAE,qBAAqB,EAAE,CAAA"}