@object-ui/plugin-form 17.6.0 → 18.0.0

package/dist/uploadGate.d.ts

@@ -0,0 +1,35 @@
+import { default as React } from 'react';
+import { useUploadingScope } from '@object-ui/fields';
+export interface UploadGate {
+    /** True while at least one upload inside this form is still in flight. */
+    uploading: boolean;
+    /** Mount around the form body so its upload widgets report in. */
+    scope: ReturnType<typeof useUploadingScope>;
+    /** The Save button's label while `uploading`. */
+    busyLabel: string;
+    /** Why Save is unavailable — shown, and used as the refusal message. */
+    reason: string;
+}
+/**
+ * Own the gate for one record form. The host renders its form body inside
+ * {@link UploadGateProvider} with the returned `scope`.
+ */
+export declare function useUploadGate(): UploadGate;
+/** Re-exported under this package's own name so hosts import one module. */
+export declare function UploadGateProvider({ gate, children, }: {
+    gate: UploadGate;
+    children: React.ReactNode;
+}): React.ReactElement;
+/**
+ * The visible reason. Rendered beside the action row, not as a toast: the
+ * explanation has to be readable at the moment the user looks at the control
+ * that will not respond, and a toast is gone by then.
+ *
+ * `role="status"` (polite) rather than `alert`: nothing has gone wrong, an
+ * upload is simply still running, and an assertive live region would interrupt
+ * a screen-reader user mid-sentence every time a file is picked.
+ */
+export declare function UploadInFlightNotice({ gate }: {
+    gate: UploadGate;
+}): React.ReactElement | null;
+//# sourceMappingURL=uploadGate.d.ts.map

package/dist/uploadGate.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploadGate.d.ts","sourceRoot":"","sources":["../src/uploadGate.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAE,iBAAiB,EAA0B,MAAM,mBAAmB,CAAC;AAgD9E,MAAM,WAAW,UAAU;IACzB,0EAA0E;IAC1E,SAAS,EAAE,OAAO,CAAC;IACnB,kEAAkE;IAClE,KAAK,EAAE,UAAU,CAAC,OAAO,iBAAiB,CAAC,CAAC;IAC5C,iDAAiD;IACjD,SAAS,EAAE,MAAM,CAAC;IAClB,wEAAwE;IACxE,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;;GAGG;AACH,wBAAgB,aAAa,IAAI,UAAU,CAS1C;AAED,4EAA4E;AAC5E,wBAAgB,kBAAkB,CAAC,EACjC,IAAI,EACJ,QAAQ,GACT,EAAE;IACD,IAAI,EAAE,UAAU,CAAC;IACjB,QAAQ,EAAE,KAAK,CAAC,SAAS,CAAC;CAC3B,GAAG,KAAK,CAAC,YAAY,CAErB;AAED;;;;;;;;GAQG;AACH,wBAAgB,oBAAoB,CAAC,EAAE,IAAI,EAAE,EAAE;IAAE,IAAI,EAAE,UAAU,CAAA;CAAE,GAAG,KAAK,CAAC,YAAY,GAAG,IAAI,CAO9F"}

package/dist/writePayload.d.ts

@@ -0,0 +1,87 @@
+import { LoadedRecordSnapshot } from './sanitize.js';
+import { FieldWriteGate } from './fieldWriteGate.js';
+/** The facts of a form schema the outbound sequence reads. */
+export interface FormWriteTarget {
+    mode?: string;
+    objectName: string;
+    recordId?: string | number | null;
+    /** Inline field definitions (`object-form.customFields`). */
+    customFields?: readonly unknown[] | null;
+}
+/** Where the outbound sequence gets its answers from. */
+export interface FormWriteSources {
+    /** The object definition the form loaded, or `null` when it has none. */
+    objectSchema: {
+        fields?: Record<string, Record<string, unknown> | undefined>;
+    } | null | undefined;
+    /** The caller's field-level write verdict — {@link FieldWriteGate}. */
+    canEdit: FieldWriteGate | undefined;
+    /** The record this form read for the record it edits (objectui#10156). */
+    snapshot: LoadedRecordSnapshot | null | undefined;
+    /**
+     * On a create, the values the form OPENED with — its `seedCreateValues`
+     * result (objectui#12359). An owner the user picked against it is written,
+     * and one the form was seeded with and the user left alone is not. Ignored
+     * on an edit.
+     *
+     * Required, so a layout cannot forget it and silently drop a pick again —
+     * which is how every create writer behaved before. `null` says there is no
+     * opening value to judge against: no pick can then be told from a seed, so
+     * the owner stays off the wire.
+     */
+    createBaseline: Record<string, unknown> | null;
+}
+export interface FormWritePayloads {
+    /**
+     * Every value the form may write, as the form now holds it: stripped of what
+     * a form never writes and, on a create, of the fields the producer owns. On
+     * a create it also carries an owner the user picked (objectui#12359), since
+     * a create writes `payload` itself.
+     */
+    payload: Record<string, unknown>;
+    /**
+     * What the save sends — on BOTH routes, the host `submitHandler` and the
+     * form's own create / OCC-guarded update. On an edit, the fields of
+     * {@link FormWritePayloads.payload} that differ from the record the form
+     * read; otherwise `payload` itself.
+     */
+    writePayload: Record<string, unknown>;
+}
+/**
+ * The ONE outbound sequence of a record form: what a save writes, built from
+ * the values the form collected (objectui#10563).
+ *
+ * 1. `sanitizeFormData` drops what a form never writes — server-owned columns
+ *    (objectui#10108), computed / formula / read-only columns, keys the object
+ *    does not declare, and every field the caller's field-level security
+ *    refuses (`canEdit`, `80c54122e`).
+ * 2. On a create, `createOwnerPayload` adds back an owner the user picked
+ *    against {@link FormWriteSources.createBaseline} (objectui#12359), and then
+ *    `omitServerResolvedDefaults` drops an empty field whose runtime default
+ *    the producer resolves (#4069).
+ * 3. On an edit, `dirtyEditPayload` keeps only the fields that differ from the
+ *    record the form read (objectui#10156), and sends the whole of step 1's
+ *    result when it cannot settle that. It is handed the values too, so an
+ *    owner the user changed is written while an untouched one is not
+ *    (objectui#12205): on an edit only `writePayload` can carry it, never
+ *    `payload`.
+ *
+ * ## Why it is one function
+ *
+ * `ObjectForm` routes a record save through several layouts, and each layout
+ * owns its save handler. When the sequence was spelled inline in each handler,
+ * three of them — `TabbedForm`, `SplitForm` and `WizardForm` (which also renders
+ * a simple form's mobile `stepper`) — carried none of it and wrote every value
+ * they held, `id`, `owner_id`, the formula columns and the field-level-refused
+ * ones included. ⛔ Do not spell any step of it beside a call to this function.
+ *
+ * ## The inline-members rule
+ *
+ * With a non-empty `customFields` the object definition is NOT handed to steps
+ * 1 and 2: an inline member may name a field the object never declares (it is
+ * appended after the generated set, objectui#9778), and the unknown-key strip
+ * would drop the value the author asked for. The server-owned roster and the
+ * field-level verdict still apply, because neither needs a definition.
+ */
+export declare function formWritePayload(values: Record<string, unknown>, form: FormWriteTarget, { objectSchema, canEdit, snapshot, createBaseline }: FormWriteSources): FormWritePayloads;
+//# sourceMappingURL=writePayload.d.ts.map

package/dist/writePayload.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"writePayload.d.ts","sourceRoot":"","sources":["../src/writePayload.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,EAIL,KAAK,oBAAoB,EAC1B,MAAM,YAAY,CAAC;AAEpB,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAEvD,8DAA8D;AAC9D,MAAM,WAAW,eAAe;IAC9B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;IAClC,6DAA6D;IAC7D,YAAY,CAAC,EAAE,SAAS,OAAO,EAAE,GAAG,IAAI,CAAC;CAC1C;AAED,yDAAyD;AACzD,MAAM,WAAW,gBAAgB;IAC/B,yEAAyE;IACzE,YAAY,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC,CAAA;KAAE,GAAG,IAAI,GAAG,SAAS,CAAC;IAClG,uEAAuE;IACvE,OAAO,EAAE,cAAc,GAAG,SAAS,CAAC;IACpC,0EAA0E;IAC1E,QAAQ,EAAE,oBAAoB,GAAG,IAAI,GAAG,SAAS,CAAC;IAClD;;;;;;;;;;OAUG;IACH,cAAc,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;CAChD;AAED,MAAM,WAAW,iBAAiB;IAChC;;;;;OAKG;IACH,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjC;;;;;OAKG;IACH,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACvC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,wBAAgB,gBAAgB,CAC9B,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC/B,IAAI,EAAE,eAAe,EACrB,EAAE,YAAY,EAAE,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAE,EAAE,gBAAgB,GACpE,iBAAiB,CAmBnB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@object-ui/plugin-form",
-  "version": "17.6.0",
+  "version": "18.0.0",
   "type": "module",
   "license": "MIT",
   "description": "Form plugin for Object UI",
@@ -15,15 +15,15 @@
     }
   },
   "dependencies": {
-    "@objectstack/spec": "^17.0.0",
-    "lucide-react": "^1.31.0",
-    "@object-ui/components": "17.6.0",
-    "@object-ui/core": "17.6.0",
-    "@object-ui/fields": "17.6.0",
-    "@object-ui/i18n": "17.6.0",
-    "@object-ui/permissions": "17.6.0",
-    "@object-ui/react": "17.6.0",
-    "@object-ui/types": "17.6.0"
+    "@objectstack/spec": "^18.0.0",
+    "lucide-react": "^1.43.0",
+    "@object-ui/components": "18.0.0",
+    "@object-ui/core": "18.0.0",
+    "@object-ui/fields": "18.0.0",
+    "@object-ui/i18n": "18.0.0",
+    "@object-ui/permissions": "18.0.0",
+    "@object-ui/react": "18.0.0",
+    "@object-ui/types": "18.0.0"
   },
   "peerDependencies": {
     "react": "^18.0.0 || ^19.0.0",
@@ -35,7 +35,8 @@
     "typescript": "^6.0.3",
     "vite": "^8.2.1",
     "vite-plugin-dts": "^5.0.3",
-    "@object-ui/data-objectstack": "17.6.0"
+    "@object-ui/data-objectstack": "18.0.0",
+    "@object-ui/test-support": "17.4.0"
   },
   "keywords": [
     "objectui",
@@ -71,7 +72,7 @@
   ],
   "scripts": {
     "build": "vite build",
-    "test": "vitest run",
+    "test": "vitest run --root ../.. packages/plugin-form/",
     "type-check": "tsc --noEmit && tsc -p tsconfig.test.json",
     "lint": "eslint ."
   }