@nextlyhq/plugin-form-builder 0.0.2-alpha.62 → 0.0.2-alpha.65

package/README.md

@@ -1,6 +1,6 @@
 # @nextlyhq/plugin-form-builder
 
-Drag-and-drop form builder plugin for Nextly. Build forms visually, collect submissions, and filter them by form. _Coming soon in beta._
+Drag-and-drop form builder plugin for Nextly. Build forms visually, collect submissions, and filter them by form.
 
 <p align="center">
   <a href="https://www.npmjs.com/package/@nextlyhq/plugin-form-builder"><img alt="npm" src="https://img.shields.io/npm/v/@nextlyhq/plugin-form-builder?style=flat-square&label=npm&color=cb3837" /></a>
@@ -8,11 +8,10 @@ Drag-and-drop form builder plugin for Nextly. Build forms visually, collect subm
   <a href="https://nextlyhq.com/docs"><img alt="Status" src="https://img.shields.io/badge/status-alpha-orange?style=flat-square" /></a>
 </p>
 
-> [!WARNING]
-> **Coming soon in beta. Plugins are not ready for use yet.** Public plugin support, including stable APIs, the official plugin gallery, and documentation guarantees, lands at the Nextly **beta** release. This package is published for early exploration only. Surfaces, names, and behaviour will change without notice. Do not rely on plugins for production or serious development work. Wait for the beta release announcement before integrating plugins into your project.
-
 > [!IMPORTANT]
-> Nextly is in alpha. APIs may change before 1.0. Pin exact versions in production.
+> Nextly is in alpha. APIs may change before 1.0 — pin exact versions in production.
+> See the [plugin stability ladder](https://nextlyhq.com/docs/plugins/stability) for
+> which plugin surfaces are stable and which are experimental.
 
 ## What it is
 

package/dist/admin/index.d.ts

@@ -1,4 +1,4 @@
-import { ComponentPath } from '@nextlyhq/plugin-sdk/admin';
+import { DocumentLockGates, ComponentPath } from '@nextlyhq/plugin-sdk/admin';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { q as FormField, s as FormFieldTypeId, A as AnyFormField, b as FormSettings, v as FormNotification } from '../types-hLfLe81K.js';
 import { FormFieldCatalogType, FieldTypeCatalogEntry } from 'nextly/field-catalog';
@@ -25,8 +25,18 @@ interface FormBuilderViewProps {
     onSave?: (data: unknown) => void;
     onSuccess?: (entry?: Record<string, unknown>) => void;
     onCancel?: () => void;
+    /**
+     * What a colleague's claim on this form withholds, handed over by the admin
+     * page that renders this view.
+     *
+     * The strip above this builder says in words that unsaved changes cannot be
+     * saved while someone else holds the document. Committing anyway would make
+     * that sentence false and would overwrite the holder's row, so the save reads
+     * it too.
+     */
+    documentLock?: DocumentLockGates;
 }
-declare function FormBuilderView({ id, entryId, collection, collectionSlug, isCreating, initialData, onSave, onSuccess, onCancel, }: FormBuilderViewProps): react_jsx_runtime.JSX.Element;
+declare function FormBuilderView({ id, entryId, collection, collectionSlug, isCreating, initialData, onSave, onSuccess, onCancel, documentLock, }: FormBuilderViewProps): react_jsx_runtime.JSX.Element;
 
 interface SubmissionRow {
     id: string;
@@ -216,6 +226,17 @@ interface FormBuilderProviderProps {
     };
     /** Child components */
     children: ReactNode;
+    /**
+     * The document belongs to someone else right now, so nothing here may change
+     * it.
+     *
+     * Held here rather than at each control because the builder has dozens of
+     * them across four tabs, and a rule spelled at every one is a rule one new
+     * control forgets. Reading is untouched: the editor still browses fields,
+     * switches tabs and opens settings, which is exactly what the strip above
+     * offers them.
+     */
+    readOnly?: boolean;
 }
 /** Default form settings (the canonical defaults from the settings reader) */
 declare const DEFAULT_SETTINGS: FormSettings;
@@ -251,7 +272,7 @@ declare function createFieldFromType(type: FormFieldTypeId, existingNames?: read
  * </FormBuilderProvider>
  * ```
  */
-declare function FormBuilderProvider({ initialData, children, }: FormBuilderProviderProps): react_jsx_runtime.JSX.Element;
+declare function FormBuilderProvider({ initialData, children, readOnly, }: FormBuilderProviderProps): react_jsx_runtime.JSX.Element;
 /**
  * useFormBuilder - Access form builder context
  *

package/dist/admin/index.js

@@ -9,7 +9,7 @@ import {
   normalizeFormSettings,
   parseFieldRef,
   parseRedirectReference
-} from "../chunk-H5X3FKOZ.js";
+} from "../chunk-W6NLZFHH.js";
 
 // src/admin/index.ts
 import {
@@ -938,6 +938,7 @@ import {
   useState as useState3
 } from "react";
 import { jsx as jsx3 } from "react/jsx-runtime";
+var READS_ONLY = /* @__PURE__ */ new Set(["selectField", "setActiveTab", "markAsSaved"]);
 var DEFAULT_SETTINGS = DEFAULT_FORM_SETTINGS;
 function createNotification() {
   const id = `notif_${Date.now().toString(36)}_${Math.random().toString(36).substring(2, 6)}`;
@@ -1021,7 +1022,8 @@ function createFieldFromType(type, existingNames = []) {
 }
 function FormBuilderProvider({
   initialData,
-  children
+  children,
+  readOnly = false
 }) {
   const [fields, setFieldsState] = useState3(
     initialData?.fields || []
@@ -1225,7 +1227,15 @@ function FormBuilderProvider({
       markAsSaved
     ]
   );
-  return /* @__PURE__ */ jsx3(FormBuilderContext.Provider, { value, children });
+  const guarded = useMemo2(() => {
+    if (!readOnly) return value;
+    return Object.fromEntries(
+      Object.entries(value).map(
+        ([name, member]) => typeof member === "function" && !READS_ONLY.has(name) ? [name, () => void 0] : [name, member]
+      )
+    );
+  }, [value, readOnly]);
+  return /* @__PURE__ */ jsx3(FormBuilderContext.Provider, { value: guarded, children });
 }
 function useFormBuilder() {
   const context = useContext(FormBuilderContext);
@@ -4434,7 +4444,8 @@ function FormBuilderViewInner({
   entryId,
   onSave,
   onSuccess,
-  onCancel
+  onCancel,
+  documentLock
 }) {
   const {
     fields,
@@ -4521,6 +4532,7 @@ function FormBuilderViewInner({
     [fields, addField, selectField]
   );
   const handleSave = useCallback7(async () => {
+    if (documentLock?.actionsDisabled === true) return;
     if (fields.length === 0) {
       toast.error("Please add at least one field to the form");
       return;
@@ -4593,7 +4605,11 @@ function FormBuilderViewInner({
     collectionSlug,
     entryId,
     queryClient,
-    markAsSaved
+    markAsSaved,
+    // Read inside, so it belongs here. Without it the callback closes over the
+    // claim as it stood when the form mounted, and a colleague taking the
+    // document over mid-session would leave this still committing.
+    documentLock?.actionsDisabled
   ]);
   const handleCancel = useCallback7(() => {
     if (onCancel) onCancel();
@@ -4778,7 +4794,7 @@ function FormBuilderViewInner({
           onClick: () => {
             void handleSave();
           },
-          disabled: isSaving,
+          disabled: isSaving || documentLock?.actionsDisabled === true,
           className: "flex items-center gap-1.5",
           children: isSaving ? /* @__PURE__ */ jsxs11(Fragment6, { children: [
             /* @__PURE__ */ jsxs11(
@@ -4831,7 +4847,8 @@ function FormBuilderView({
   initialData,
   onSave,
   onSuccess,
-  onCancel
+  onCancel,
+  documentLock
 }) {
   const resolvedEntryId = entryId || id || initialData?.id;
   const resolvedCollectionSlug = collectionSlug || collection || "forms";
@@ -4840,6 +4857,7 @@ function FormBuilderView({
   return /* @__PURE__ */ jsx12(
     FormBuilderProvider,
     {
+      readOnly: documentLock?.readOnly === true,
       initialData: {
         id: resolvedEntryId,
         name: initialData?.name,
@@ -4859,7 +4877,8 @@ function FormBuilderView({
           entryId: resolvedEntryId,
           onSave,
           onSuccess,
-          onCancel
+          onCancel,
+          documentLock
         }
       )
     },