@elytracms/forms 0.0.0-stage → 0.0.94

package/dist/studio/lens.d.ts

@@ -0,0 +1,68 @@
+import type { CmsDocument, CollectionDef, LocalizedString } from '@elytracms/core/cms-core';
+import type { SubmissionRecord, SubmissionStatus } from '../shared/kind.js';
+import type { FormDocument, FormSource } from '../shared/source.js';
+/**
+ * EC-613 — the inbox's LENS over the submission kind (pure — no React, so what a save writes
+ * is unit-tested on its own). The portable list/edit surfaces (AD-19) edit a lens document
+ * `{ collection, id, values }` over a `CollectionDef`; this module is the one place both
+ * directions are decided:
+ *
+ * - **read** ({@link submissionToLensDocument}): the row's columns for the list and the
+ *   edit form — the form's TITLE (from the form document) instead of its key;
+ * - **write** ({@link submissionEditorWrite}): ONLY the editor's columns (`status`,
+ *   `assignee`, `notes`) and only those the editor CHANGED — measured against the record AS
+ *   THE EDITOR OPENED IT (the edit shell's `save(doc, base)`, EC-616), never against the cached
+ *   record at save time, which may already hold another editor's change. Never the columns the
+ *   lens merely displays: the delivery writes its own columns at any time, and a save carrying
+ *   the editor's stale copy would put an old state back (and, moving the row into `pending`,
+ *   schedule a second delivery — measured in `convex/forms.convex.test.ts`). Two editors
+ *   changing different columns therefore merge per column (the record store keeps what a write
+ *   leaves out, EC-577); the same column is the last writer's.
+ *
+ *   Why not the generic `lensDocumentToRecordWrite(kind, doc, base)`: the inbox's lens shows
+ *   DISPLAY values under kind column names (`form` holds the form's title, not its key), so a
+ *   generic per-column diff could send a display value into a stored column; the whitelist
+ *   makes that unrepresentable, and a cleared note stays `null` (EC-577's clear), not `''`.
+ */
+/** The lens collection id (the kind's name). */
+export declare const SUBMISSION_LENS_ID: string;
+/** The inbox's lens: the list columns, then (in the edit form) the editor's notes and the page. */
+export declare function submissionLens(options_?: {
+    label?: LocalizedString;
+    detail?: boolean;
+}): CollectionDef;
+/** The form documents the inbox labels with, read once (the studio's stored values). */
+export interface InboxForms<V> {
+    source: FormSource<V>;
+    documents: readonly FormDocument<V>[];
+}
+/** The form a submission was sent to (by its key), if the project still has it. */
+export declare function formOf<V>(forms: InboxForms<V> | undefined, record: Pick<SubmissionRecord, 'form'>): FormDocument<V> | undefined;
+/** The form's display title, else its key. */
+export declare function formTitle<V>(forms: InboxForms<V> | undefined, record: Pick<SubmissionRecord, 'form'>): string;
+/** Who sent it: the reply-to address, else the first answer. */
+export declare function submissionSender<V>(forms: InboxForms<V> | undefined, record: Pick<SubmissionRecord, 'payload'>): string;
+/** A submission as the lens document the portable surfaces edit. */
+export declare function submissionToLensDocument<V>(record: SubmissionRecord, forms?: InboxForms<V>): CmsDocument;
+/** What an editor's save writes: the id, and only the editor's columns that changed. */
+export type SubmissionEditorWrite = {
+    id: string;
+    status?: SubmissionStatus;
+    assignee?: string | null;
+    notes?: string | null;
+};
+/**
+ * The write an edited lens document makes: the editor's columns that DIFFER from `base` — the
+ * lens document as the editor OPENED it — nothing else (see the module header). A cleared
+ * optional text is `null` (the record store clears it); an unchanged document writes nothing
+ * but its id.
+ */
+export declare function submissionEditorWrite(base: CmsDocument, doc: CmsDocument): SubmissionEditorWrite;
+/**
+ * The inbox's save: the write for an edited document, against `base` — the record as the
+ * editor opened it, which the edit shell passes (EC-616). Without one (a caller outside the
+ * shell) the cached record stands in, which is the record as of the last refetch.
+ */
+export declare function inboxSaveWrite<V>(doc: CmsDocument, base: CmsDocument | undefined, cached: SubmissionRecord, forms?: InboxForms<V>): ReturnType<typeof submissionEditorWrite>;
+/** The inbox's findings for the rail foot: every submission whose mail did not (fully) go out. */
+export declare function inboxIssueCount(records: readonly Pick<SubmissionRecord, 'deliveryState'>[]): number;

package/dist/studio/lens.js

@@ -0,0 +1,149 @@
+import { collectionDefSchema } from '@elytracms/core/cms-core';
+import { DELIVERY_STATES, SPAM_VERDICTS, SUBMISSION_EDITOR_COLUMNS, SUBMISSION_STATUSES, submissionRecordKind } from '../shared/kind.js';
+import { deliveryNeedsAttention } from '../shared/delivery.js';
+import { defaultReplyTo } from '../shared/source.js';
+import { formatFormValue } from '../shared/submission.js';
+/**
+ * EC-613 — the inbox's LENS over the submission kind (pure — no React, so what a save writes
+ * is unit-tested on its own). The portable list/edit surfaces (AD-19) edit a lens document
+ * `{ collection, id, values }` over a `CollectionDef`; this module is the one place both
+ * directions are decided:
+ *
+ * - **read** ({@link submissionToLensDocument}): the row's columns for the list and the
+ *   edit form — the form's TITLE (from the form document) instead of its key;
+ * - **write** ({@link submissionEditorWrite}): ONLY the editor's columns (`status`,
+ *   `assignee`, `notes`) and only those the editor CHANGED — measured against the record AS
+ *   THE EDITOR OPENED IT (the edit shell's `save(doc, base)`, EC-616), never against the cached
+ *   record at save time, which may already hold another editor's change. Never the columns the
+ *   lens merely displays: the delivery writes its own columns at any time, and a save carrying
+ *   the editor's stale copy would put an old state back (and, moving the row into `pending`,
+ *   schedule a second delivery — measured in `convex/forms.convex.test.ts`). Two editors
+ *   changing different columns therefore merge per column (the record store keeps what a write
+ *   leaves out, EC-577); the same column is the last writer's.
+ *
+ *   Why not the generic `lensDocumentToRecordWrite(kind, doc, base)`: the inbox's lens shows
+ *   DISPLAY values under kind column names (`form` holds the form's title, not its key), so a
+ *   generic per-column diff could send a display value into a stored column; the whitelist
+ *   makes that unrepresentable, and a cleared note stays `null` (EC-577's clear), not `''`.
+ */
+/** The lens collection id (the kind's name). */
+export const SUBMISSION_LENS_ID = submissionRecordKind.kind;
+const L = (en, de) => ({ en, de });
+const STATUS_LABELS = {
+    new: L('New', 'Neu'),
+    open: L('In progress', 'In Bearbeitung'),
+    done: L('Done', 'Erledigt'),
+    spam: L('Spam', 'Spam'),
+};
+const DELIVERY_LABELS = {
+    pending: L('Sending', 'Wird gesendet'),
+    sent: L('Sent', 'Gesendet'),
+    partial: L('Partly failed', 'Teilweise fehlgeschlagen'),
+    failed: L('Failed', 'Fehlgeschlagen'),
+    skipped: L('Not sent', 'Nicht gesendet'),
+};
+const SPAM_LABELS = {
+    clean: L('No', 'Nein'),
+    honeypot: L('Honeypot filled', 'Honeypot ausgefüllt'),
+};
+const options = (labels) => Object.entries(labels).map(([value, label]) => ({ value, label: label }));
+/** The inbox's lens: the list columns, then (in the edit form) the editor's notes and the page. */
+export function submissionLens(options_ = {}) {
+    const readOnly = (label, extra = {}) => ({ label, readOnly: true, ...extra });
+    // `from` leads: the list's link column and the edit shell's title (`titleField`).
+    const fields = [
+        { name: 'from', type: 'text', form: readOnly(L('From', 'Von')) },
+        { name: 'form', type: 'text', form: readOnly(L('Form', 'Formular'), { width: '50%' }) },
+        { name: 'submittedAt', type: 'date', form: readOnly(L('Received', 'Eingegangen'), { width: '50%' }) },
+        { name: 'status', type: 'select', options: options(STATUS_LABELS), form: { label: L('Status', 'Status'), width: '50%' } },
+        { name: 'assignee', type: 'text', form: { label: L('Assignee', 'Zuständig'), width: '50%' } },
+        { name: 'deliveryState', type: 'select', options: options(DELIVERY_LABELS), form: readOnly(L('Mail', 'E-Mail'), { width: '50%' }) },
+        { name: 'spam', type: 'select', options: options(SPAM_LABELS), form: readOnly(L('Spam check', 'Spam-Prüfung'), { width: '50%' }) },
+    ];
+    if (options_.detail) {
+        fields.push({ name: 'notes', type: 'text', form: { label: L('Notes', 'Notizen') } }, { name: 'sourceUrl', type: 'text', form: readOnly(L('Page', 'Seite')) });
+    }
+    return collectionDefSchema.parse({
+        id: SUBMISSION_LENS_ID,
+        kind: 'document',
+        titleField: 'from',
+        form: {
+            label: options_.label ?? L('Submissions', 'Einsendungen'),
+            labelSingular: L('Submission', 'Einsendung'),
+        },
+        fields,
+    });
+}
+/** The form a submission was sent to (by its key), if the project still has it. */
+export function formOf(forms, record) {
+    return forms ? forms.source.find(forms.documents, record.form) : undefined;
+}
+/** The form's display title, else its key. */
+export function formTitle(forms, record) {
+    const form = formOf(forms, record);
+    return (form && forms?.source.title?.(form.values)) || record.form;
+}
+/** Who sent it: the reply-to address, else the first answer. */
+export function submissionSender(forms, record) {
+    const replyTo = (forms?.source.replyTo ?? defaultReplyTo)(record.payload);
+    if (replyTo)
+        return replyTo;
+    const first = record.payload[0];
+    return first ? formatFormValue(first.value).slice(0, 80) : '';
+}
+/** A submission as the lens document the portable surfaces edit. */
+export function submissionToLensDocument(record, forms) {
+    const values = {
+        submittedAt: record.submittedAt,
+        form: formTitle(forms, record),
+        from: submissionSender(forms, record),
+        status: record.status,
+        deliveryState: record.deliveryState,
+        spam: record.spam,
+    };
+    if (record.assignee !== undefined)
+        values['assignee'] = record.assignee;
+    if (record.notes !== undefined)
+        values['notes'] = record.notes;
+    if (record.sourceUrl !== undefined)
+        values['sourceUrl'] = record.sourceUrl;
+    return { collection: SUBMISSION_LENS_ID, id: record.id, values };
+}
+/**
+ * The write an edited lens document makes: the editor's columns that DIFFER from `base` — the
+ * lens document as the editor OPENED it — nothing else (see the module header). A cleared
+ * optional text is `null` (the record store clears it); an unchanged document writes nothing
+ * but its id.
+ */
+export function submissionEditorWrite(base, doc) {
+    const values = doc.values ?? {};
+    const opened = base.values ?? {};
+    const write = { id: doc.id };
+    for (const column of SUBMISSION_EDITOR_COLUMNS) {
+        const edited = values[column];
+        const before = opened[column];
+        if (column === 'status') {
+            if (typeof edited === 'string' && edited !== before)
+                write[column] = edited;
+            continue;
+        }
+        const text = typeof edited === 'string' ? edited : '';
+        if (text === (before ?? ''))
+            continue;
+        write[column] = text.length > 0 ? text : null;
+    }
+    return write;
+}
+/**
+ * The inbox's save: the write for an edited document, against `base` — the record as the
+ * editor opened it, which the edit shell passes (EC-616). Without one (a caller outside the
+ * shell) the cached record stands in, which is the record as of the last refetch.
+ */
+export function inboxSaveWrite(doc, base, cached, forms) {
+    return submissionEditorWrite(base ?? submissionToLensDocument(cached, forms), doc);
+}
+/** The inbox's findings for the rail foot: every submission whose mail did not (fully) go out. */
+export function inboxIssueCount(records) {
+    return records.filter((record) => deliveryNeedsAttention(record.deliveryState)).length;
+}
+//# sourceMappingURL=lens.js.map

package/dist/studio/lens.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"lens.js","sourceRoot":"","sources":["../../src/studio/lens.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AAE9D,OAAO,EAAE,eAAe,EAAE,aAAa,EAAE,yBAAyB,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,MAAM,gBAAgB,CAAA;AAErI,OAAO,EAAE,sBAAsB,EAAE,MAAM,oBAAoB,CAAA;AAE3D,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AACjD,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAEtD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AAEH,gDAAgD;AAChD,MAAM,CAAC,MAAM,kBAAkB,GAAG,oBAAoB,CAAC,IAAI,CAAA;AAE3D,MAAM,CAAC,GAAG,CAAC,EAAU,EAAE,EAAU,EAAmB,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,CAAA;AAEnE,MAAM,aAAa,GAAkE;IACnF,GAAG,EAAE,CAAC,CAAC,KAAK,EAAE,KAAK,CAAC;IACpB,IAAI,EAAE,CAAC,CAAC,aAAa,EAAE,gBAAgB,CAAC;IACxC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,UAAU,CAAC;IAC3B,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,MAAM,CAAC;CACxB,CAAA;AACD,MAAM,eAAe,GAA8D;IACjF,OAAO,EAAE,CAAC,CAAC,SAAS,EAAE,eAAe,CAAC;IACtC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,UAAU,CAAC;IAC3B,OAAO,EAAE,CAAC,CAAC,eAAe,EAAE,0BAA0B,CAAC;IACvD,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE,gBAAgB,CAAC;IACrC,OAAO,EAAE,CAAC,CAAC,UAAU,EAAE,gBAAgB,CAAC;CACzC,CAAA;AACD,MAAM,WAAW,GAA4D;IAC3E,KAAK,EAAE,CAAC,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,CAAC,CAAC,iBAAiB,EAAE,qBAAqB,CAAC;CACtD,CAAA;AAED,MAAM,OAAO,GAAG,CAAmB,MAAkC,EAAE,EAAE,CACvE,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,KAAwB,EAAE,CAAC,CAAC,CAAA;AAE9F,mGAAmG;AACnG,MAAM,UAAU,cAAc,CAAC,WAA0D,EAAE;IACzF,MAAM,QAAQ,GAAG,CAAC,KAAsB,EAAE,QAAiC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,KAAK,EAAE,CAAC,CAAA;IACvH,kFAAkF;IAClF,MAAM,MAAM,GAA8B;QACxC,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,EAAE;QAChE,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,UAAU,CAAC,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,EAAE;QACvF,EAAE,IAAI,EAAE,aAAa,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,UAAU,EAAE,aAAa,CAAC,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,EAAE;QACrG,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,CAAC,aAAa,CAAC,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC,QAAQ,EAAE,QAAQ,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE;QACzH,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC,UAAU,EAAE,WAAW,CAAC,EAAE,KAAK,EAAE,KAAK,EAAE,EAAE;QAC7F,EAAE,IAAI,EAAE,eAAe,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,CAAC,eAAe,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,QAAQ,CAAC,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,EAAE;QACnI,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,CAAC,WAAW,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,YAAY,EAAE,cAAc,CAAC,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,EAAE;KACnI,CAAA;IACD,IAAI,QAAQ,CAAC,MAAM,EAAE,CAAC;QACpB,MAAM,CAAC,IAAI,CACT,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC,OAAO,EAAE,SAAS,CAAC,EAAE,EAAE,EACvE,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,EAAE,CACxE,CAAA;IACH,CAAC;IACD,OAAO,mBAAmB,CAAC,KAAK,CAAC;QAC/B,EAAE,EAAE,kBAAkB;QACtB,IAAI,EAAE,UAAU;QAChB,UAAU,EAAE,MAAM;QAClB,IAAI,EAAE;YACJ,KAAK,EAAE,QAAQ,CAAC,KAAK,IAAI,CAAC,CAAC,aAAa,EAAE,cAAc,CAAC;YACzD,aAAa,EAAE,CAAC,CAAC,YAAY,EAAE,YAAY,CAAC;SAC7C;QACD,MAAM;KACP,CAAC,CAAA;AACJ,CAAC;AAQD,mFAAmF;AACnF,MAAM,UAAU,MAAM,CAAI,KAAgC,EAAE,MAAsC;IAChG,OAAO,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;AAC5E,CAAC;AAED,8CAA8C;AAC9C,MAAM,UAAU,SAAS,CAAI,KAAgC,EAAE,MAAsC;IACnG,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,CAAA;IAClC,OAAO,CAAC,IAAI,IAAI,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,IAAI,MAAM,CAAC,IAAI,CAAA;AACpE,CAAC;AAED,gEAAgE;AAChE,MAAM,UAAU,gBAAgB,CAAI,KAAgC,EAAE,MAAyC;IAC7G,MAAM,OAAO,GAAG,CAAC,KAAK,EAAE,MAAM,CAAC,OAAO,IAAI,cAAc,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;IACzE,IAAI,OAAO;QAAE,OAAO,OAAO,CAAA;IAC3B,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,CAAA;IAC/B,OAAO,KAAK,CAAC,CAAC,CAAC,eAAe,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;AAC/D,CAAC;AAED,oEAAoE;AACpE,MAAM,UAAU,wBAAwB,CAAI,MAAwB,EAAE,KAAqB;IACzF,MAAM,MAAM,GAA4B;QACtC,WAAW,EAAE,MAAM,CAAC,WAAW;QAC/B,IAAI,EAAE,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC;QAC9B,IAAI,EAAE,gBAAgB,CAAC,KAAK,EAAE,MAAM,CAAC;QACrC,MAAM,EAAE,MAAM,CAAC,MAAM;QACrB,aAAa,EAAE,MAAM,CAAC,aAAa;QACnC,IAAI,EAAE,MAAM,CAAC,IAAI;KAClB,CAAA;IACD,IAAI,MAAM,CAAC,QAAQ,KAAK,SAAS;QAAE,MAAM,CAAC,UAAU,CAAC,GAAG,MAAM,CAAC,QAAQ,CAAA;IACvE,IAAI,MAAM,CAAC,KAAK,KAAK,SAAS;QAAE,MAAM,CAAC,OAAO,CAAC,GAAG,MAAM,CAAC,KAAK,CAAA;IAC9D,IAAI,MAAM,CAAC,SAAS,KAAK,SAAS;QAAE,MAAM,CAAC,WAAW,CAAC,GAAG,MAAM,CAAC,SAAS,CAAA;IAC1E,OAAO,EAAE,UAAU,EAAE,kBAAkB,EAAE,EAAE,EAAE,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,CAAA;AAClE,CAAC;AAUD;;;;;GAKG;AACH,MAAM,UAAU,qBAAqB,CACnC,IAAiB,EACjB,GAAgB;IAEhB,MAAM,MAAM,GAAG,GAAG,CAAC,MAAM,IAAI,EAAE,CAAA;IAC/B,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,EAAE,CAAA;IAChC,MAAM,KAAK,GAAmD,EAAE,EAAE,EAAE,GAAG,CAAC,EAAE,EAAE,CAAA;IAC5E,KAAK,MAAM,MAAM,IAAI,yBAAyB,EAAE,CAAC;QAC/C,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,CAAA;QAC7B,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAuB,CAAA;QACnD,IAAI,MAAM,KAAK,QAAQ,EAAE,CAAC;YACxB,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,MAAM,KAAK,MAAM;gBAAE,KAAK,CAAC,MAAM,CAAC,GAAG,MAAM,CAAA;YAC3E,SAAQ;QACV,CAAC;QACD,MAAM,IAAI,GAAG,OAAO,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,CAAA;QACrD,IAAI,IAAI,KAAK,CAAC,MAAM,IAAI,EAAE,CAAC;YAAE,SAAQ;QACrC,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAA;IAC/C,CAAC;IACD,OAAO,KAA8B,CAAA;AACvC,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAC5B,GAAgB,EAChB,IAA6B,EAC7B,MAAwB,EACxB,KAAqB;IAErB,OAAO,qBAAqB,CAAC,IAAI,IAAI,wBAAwB,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,GAAG,CAAC,CAAA;AACpF,CAAC;AAED,kGAAkG;AAClG,MAAM,UAAU,eAAe,CAAC,OAA2D;IACzF,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,sBAAsB,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,CAAC,MAAM,CAAA;AACxF,CAAC","sourcesContent":["import { collectionDefSchema } from '@elytracms/core/cms-core'\nimport type { CmsDocument, CollectionDef, LocalizedString } from '@elytracms/core/cms-core'\nimport { DELIVERY_STATES, SPAM_VERDICTS, SUBMISSION_EDITOR_COLUMNS, SUBMISSION_STATUSES, submissionRecordKind } from '../shared/kind'\nimport type { SubmissionRecord, SubmissionStatus } from '../shared/kind'\nimport { deliveryNeedsAttention } from '../shared/delivery'\nimport type { FormDocument, FormSource } from '../shared/source'\nimport { defaultReplyTo } from '../shared/source'\nimport { formatFormValue } from '../shared/submission'\n\n/**\n * EC-613 — the inbox's LENS over the submission kind (pure — no React, so what a save writes\n * is unit-tested on its own). The portable list/edit surfaces (AD-19) edit a lens document\n * `{ collection, id, values }` over a `CollectionDef`; this module is the one place both\n * directions are decided:\n *\n * - **read** ({@link submissionToLensDocument}): the row's columns for the list and the\n *   edit form — the form's TITLE (from the form document) instead of its key;\n * - **write** ({@link submissionEditorWrite}): ONLY the editor's columns (`status`,\n *   `assignee`, `notes`) and only those the editor CHANGED — measured against the record AS\n *   THE EDITOR OPENED IT (the edit shell's `save(doc, base)`, EC-616), never against the cached\n *   record at save time, which may already hold another editor's change. Never the columns the\n *   lens merely displays: the delivery writes its own columns at any time, and a save carrying\n *   the editor's stale copy would put an old state back (and, moving the row into `pending`,\n *   schedule a second delivery — measured in `convex/forms.convex.test.ts`). Two editors\n *   changing different columns therefore merge per column (the record store keeps what a write\n *   leaves out, EC-577); the same column is the last writer's.\n *\n *   Why not the generic `lensDocumentToRecordWrite(kind, doc, base)`: the inbox's lens shows\n *   DISPLAY values under kind column names (`form` holds the form's title, not its key), so a\n *   generic per-column diff could send a display value into a stored column; the whitelist\n *   makes that unrepresentable, and a cleared note stays `null` (EC-577's clear), not `''`.\n */\n\n/** The lens collection id (the kind's name). */\nexport const SUBMISSION_LENS_ID = submissionRecordKind.kind\n\nconst L = (en: string, de: string): LocalizedString => ({ en, de })\n\nconst STATUS_LABELS: Record<(typeof SUBMISSION_STATUSES)[number], LocalizedString> = {\n  new: L('New', 'Neu'),\n  open: L('In progress', 'In Bearbeitung'),\n  done: L('Done', 'Erledigt'),\n  spam: L('Spam', 'Spam'),\n}\nconst DELIVERY_LABELS: Record<(typeof DELIVERY_STATES)[number], LocalizedString> = {\n  pending: L('Sending', 'Wird gesendet'),\n  sent: L('Sent', 'Gesendet'),\n  partial: L('Partly failed', 'Teilweise fehlgeschlagen'),\n  failed: L('Failed', 'Fehlgeschlagen'),\n  skipped: L('Not sent', 'Nicht gesendet'),\n}\nconst SPAM_LABELS: Record<(typeof SPAM_VERDICTS)[number], LocalizedString> = {\n  clean: L('No', 'Nein'),\n  honeypot: L('Honeypot filled', 'Honeypot ausgefüllt'),\n}\n\nconst options = <T extends string>(labels: Record<T, LocalizedString>) =>\n  Object.entries(labels).map(([value, label]) => ({ value, label: label as LocalizedString }))\n\n/** The inbox's lens: the list columns, then (in the edit form) the editor's notes and the page. */\nexport function submissionLens(options_: { label?: LocalizedString; detail?: boolean } = {}): CollectionDef {\n  const readOnly = (label: LocalizedString, extra: Record<string, unknown> = {}) => ({ label, readOnly: true, ...extra })\n  // `from` leads: the list's link column and the edit shell's title (`titleField`).\n  const fields: Record<string, unknown>[] = [\n    { name: 'from', type: 'text', form: readOnly(L('From', 'Von')) },\n    { name: 'form', type: 'text', form: readOnly(L('Form', 'Formular'), { width: '50%' }) },\n    { name: 'submittedAt', type: 'date', form: readOnly(L('Received', 'Eingegangen'), { width: '50%' }) },\n    { name: 'status', type: 'select', options: options(STATUS_LABELS), form: { label: L('Status', 'Status'), width: '50%' } },\n    { name: 'assignee', type: 'text', form: { label: L('Assignee', 'Zuständig'), width: '50%' } },\n    { name: 'deliveryState', type: 'select', options: options(DELIVERY_LABELS), form: readOnly(L('Mail', 'E-Mail'), { width: '50%' }) },\n    { name: 'spam', type: 'select', options: options(SPAM_LABELS), form: readOnly(L('Spam check', 'Spam-Prüfung'), { width: '50%' }) },\n  ]\n  if (options_.detail) {\n    fields.push(\n      { name: 'notes', type: 'text', form: { label: L('Notes', 'Notizen') } },\n      { name: 'sourceUrl', type: 'text', form: readOnly(L('Page', 'Seite')) },\n    )\n  }\n  return collectionDefSchema.parse({\n    id: SUBMISSION_LENS_ID,\n    kind: 'document',\n    titleField: 'from',\n    form: {\n      label: options_.label ?? L('Submissions', 'Einsendungen'),\n      labelSingular: L('Submission', 'Einsendung'),\n    },\n    fields,\n  })\n}\n\n/** The form documents the inbox labels with, read once (the studio's stored values). */\nexport interface InboxForms<V> {\n  source: FormSource<V>\n  documents: readonly FormDocument<V>[]\n}\n\n/** The form a submission was sent to (by its key), if the project still has it. */\nexport function formOf<V>(forms: InboxForms<V> | undefined, record: Pick<SubmissionRecord, 'form'>): FormDocument<V> | undefined {\n  return forms ? forms.source.find(forms.documents, record.form) : undefined\n}\n\n/** The form's display title, else its key. */\nexport function formTitle<V>(forms: InboxForms<V> | undefined, record: Pick<SubmissionRecord, 'form'>): string {\n  const form = formOf(forms, record)\n  return (form && forms?.source.title?.(form.values)) || record.form\n}\n\n/** Who sent it: the reply-to address, else the first answer. */\nexport function submissionSender<V>(forms: InboxForms<V> | undefined, record: Pick<SubmissionRecord, 'payload'>): string {\n  const replyTo = (forms?.source.replyTo ?? defaultReplyTo)(record.payload)\n  if (replyTo) return replyTo\n  const first = record.payload[0]\n  return first ? formatFormValue(first.value).slice(0, 80) : ''\n}\n\n/** A submission as the lens document the portable surfaces edit. */\nexport function submissionToLensDocument<V>(record: SubmissionRecord, forms?: InboxForms<V>): CmsDocument {\n  const values: Record<string, unknown> = {\n    submittedAt: record.submittedAt,\n    form: formTitle(forms, record),\n    from: submissionSender(forms, record),\n    status: record.status,\n    deliveryState: record.deliveryState,\n    spam: record.spam,\n  }\n  if (record.assignee !== undefined) values['assignee'] = record.assignee\n  if (record.notes !== undefined) values['notes'] = record.notes\n  if (record.sourceUrl !== undefined) values['sourceUrl'] = record.sourceUrl\n  return { collection: SUBMISSION_LENS_ID, id: record.id, values }\n}\n\n/** What an editor's save writes: the id, and only the editor's columns that changed. */\nexport type SubmissionEditorWrite = {\n  id: string\n  status?: SubmissionStatus\n  assignee?: string | null\n  notes?: string | null\n}\n\n/**\n * The write an edited lens document makes: the editor's columns that DIFFER from `base` — the\n * lens document as the editor OPENED it — nothing else (see the module header). A cleared\n * optional text is `null` (the record store clears it); an unchanged document writes nothing\n * but its id.\n */\nexport function submissionEditorWrite(\n  base: CmsDocument,\n  doc: CmsDocument,\n): SubmissionEditorWrite {\n  const values = doc.values ?? {}\n  const opened = base.values ?? {}\n  const write: Record<string, string | null> & { id: string } = { id: doc.id }\n  for (const column of SUBMISSION_EDITOR_COLUMNS) {\n    const edited = values[column]\n    const before = opened[column] as string | undefined\n    if (column === 'status') {\n      if (typeof edited === 'string' && edited !== before) write[column] = edited\n      continue\n    }\n    const text = typeof edited === 'string' ? edited : ''\n    if (text === (before ?? '')) continue\n    write[column] = text.length > 0 ? text : null\n  }\n  return write as SubmissionEditorWrite\n}\n\n/**\n * The inbox's save: the write for an edited document, against `base` — the record as the\n * editor opened it, which the edit shell passes (EC-616). Without one (a caller outside the\n * shell) the cached record stands in, which is the record as of the last refetch.\n */\nexport function inboxSaveWrite<V>(\n  doc: CmsDocument,\n  base: CmsDocument | undefined,\n  cached: SubmissionRecord,\n  forms?: InboxForms<V>,\n): ReturnType<typeof submissionEditorWrite> {\n  return submissionEditorWrite(base ?? submissionToLensDocument(cached, forms), doc)\n}\n\n/** The inbox's findings for the rail foot: every submission whose mail did not (fully) go out. */\nexport function inboxIssueCount(records: readonly Pick<SubmissionRecord, 'deliveryState'>[]): number {\n  return records.filter((record) => deliveryNeedsAttention(record.deliveryState)).length\n}\n"]}

package/package.json

@@ -1,6 +1,78 @@
 {
   "name": "@elytracms/forms",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "author": "finaldream <hi@finaldream.de>",
+  "version": "0.0.94",
+  "engines": {
+    "node": ">=22.18.0"
+  },
+  "description": "Forms for Elytra — the first addon: every submission a record in the studio's inbox, delivery as a scheduled, logged action per row, uploads into storage through the public ingest seam.",
+  "license": "MIT",
+  "private": false,
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./studio": {
+      "types": "./dist/studio/index.d.ts",
+      "default": "./dist/studio/index.js"
+    },
+    "./next": {
+      "types": "./dist/next/index.d.ts",
+      "default": "./dist/next/index.js"
+    },
+    "./convex": "./src/convex/index.ts"
+  },
+  "dependencies": {
+    "lucide-react": "^1.23.0",
+    "zod": "^4.4.3",
+    "@elytracms/core": "^0.0.94"
+  },
+  "peerDependencies": {
+    "convex": "^1.42.1",
+    "react": "^19.0.0",
+    "@elytracms/next": "^0.0.94",
+    "@elytracms/studio": "^0.0.94"
+  },
+  "peerDependenciesMeta": {
+    "@elytracms/next": {
+      "optional": true
+    },
+    "@elytracms/studio": {
+      "optional": true
+    },
+    "convex": {
+      "optional": true
+    },
+    "react": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@types/node": "^26.1.0",
+    "@types/react": "^19.2.17",
+    "@types/react-dom": "^19.2.3",
+    "convex": "^1.42.1",
+    "convex-test": "^0.0.54",
+    "react": "^19.2.7",
+    "react-dom": "^19.2.7",
+    "typescript": "^6.0.3",
+    "@elytracms/next": "^0.0.94",
+    "@elytracms/studio": "^0.0.94"
+  },
+  "files": [
+    "dist",
+    "src/convex",
+    "src/shared"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "node -e \"require('fs').rmSync('dist',{recursive:true,force:true})\" && tsc -p tsconfig.build.json && node ../../scripts/fix-esm-extensions.mjs dist && node ../../scripts/check-esm-extensions.mjs dist",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint src"
+  }
 }