@stacksjs/forms 0.72.8 → 0.72.10

package/dist/create.d.ts

@@ -0,0 +1,50 @@
+import type { FormDefinition, FormFieldDefinition, FormFieldType, FormSettings } from './types';
+/**
+ * Create or update a form and its fields for one site.
+ *
+ * Fields are REPLACED rather than merged: a form's fields are a single
+ * document in every editor that exists, and merging them by name would leave
+ * a removed field behind on the next provision.
+ */
+export declare function createForm(siteId: number | null, input: CreateFormInput): Promise<CreatedForm>;
+/** Load a form by its site-scoped handle, the way app code refers to one. */
+export declare function loadFormByHandle(siteId: number | null, handle: string): Promise<FormDefinition | null>;
+/** The field list as `createForm` takes it, for a definition already loaded. */
+export declare function toCreateFields(fields: FormFieldDefinition[]): CreateFormFieldInput[];
+/**
+ * Creating a form.
+ *
+ * The package could read a form, validate a submission against it, notify on
+ * it and export it - but not make one. Every app that wanted a form in code
+ * (a seeder, an onboarding step, a "give this tenant the standard enquiry
+ * form" button) had to write the Form + FormField inserts itself, which means
+ * every app also had to know that `options` and `conditions` are JSON columns
+ * and that fields carry their own `position`.
+ *
+ * `handle` is the identity, scoped to the site (there is a unique index on
+ * `site_id, handle`), so this is idempotent: provisioning the same form twice
+ * updates the one that exists rather than failing on the constraint or
+ * quietly making a second.
+ */
+export declare interface CreateFormFieldInput {
+  name: string
+  label: string
+  type: FormFieldType
+  required?: boolean
+  width?: 'full' | 'half'
+  options?: Record<string, unknown>
+  conditions?: Record<string, unknown> | null
+}
+export declare interface CreateFormInput {
+  handle: string
+  name: string
+  status?: 'draft' | 'active' | 'closed'
+  settings?: FormSettings
+  fields: CreateFormFieldInput[]
+}
+export declare interface CreatedForm {
+  id: number
+  uuid: string
+  handle: string
+  created: boolean
+}

package/dist/create.js

@@ -0,0 +1 @@
+import{db}from"@stacksjs/database";import{loadFormByUuid}from"./definition";export async function createForm(siteId,input){const existing=await db.selectFrom("forms").select(["id","uuid"]).where("handle","=",input.handle).where("site_id",siteId===null?"is":"=",siteId).executeTakeFirst(),settings=JSON.stringify(input.settings??{});let formId,uuid,created=!1;if(existing){formId=Number(existing.id);uuid=String(existing.uuid);await db.updateTable("forms").set({name:input.name,status:input.status??"active",settings}).where("id","=",formId).execute()}else{uuid=crypto.randomUUID();await db.insertInto("forms").values({uuid,site_id:siteId,name:input.name,handle:input.handle,status:input.status??"active",settings}).execute();const row=await db.selectFrom("forms").select(["id"]).where("uuid","=",uuid).executeTakeFirst();formId=Number(row?.id);created=!0}await db.deleteFrom("form_fields").where("form_id","=",formId).execute();let position=0;for(const field of input.fields)await db.insertInto("form_fields").values({form_id:formId,name:field.name,label:field.label,type:field.type,required:field.required??!1,position:position++,width:field.width??"full",options:JSON.stringify(field.options??{}),conditions:field.conditions?JSON.stringify(field.conditions):null}).execute();return{id:formId,uuid,handle:input.handle,created}}export async function loadFormByHandle(siteId,handle){const row=await db.selectFrom("forms").select(["uuid"]).where("handle","=",handle).where("site_id",siteId===null?"is":"=",siteId).executeTakeFirst();if(!row)return null;return await loadFormByUuid(String(row.uuid),siteId)}export function toCreateFields(fields){return fields.map((field)=>({name:field.name,label:field.label,type:field.type,required:field.required,width:field.width,options:field.options,conditions:field.conditions}))}

package/dist/index.d.ts

@@ -1,3 +1,4 @@
+export type { CreatedForm, CreateFormFieldInput, CreateFormInput } from './create';
 export type { SubmissionListRow, SubmitOptions, SubmitResult } from './submissions';
 export type {
   FieldChoice,
@@ -11,6 +12,7 @@ export type {
   ValidateSubmissionResult,
 } from './types';
 export { evaluateConditions, visibleFields } from './conditions';
+export { createForm, loadFormByHandle, toCreateFields } from './create';
 export { loadFormByUuid, publicDefinition } from './definition';
 export { dispatchSubmissionNotifications } from './notifications';
 export {

package/dist/index.js

@@ -1 +1 @@
-export{evaluateConditions,visibleFields}from"./conditions";export{loadFormByUuid,publicDefinition}from"./definition";export{dispatchSubmissionNotifications}from"./notifications";export{completeSubmissionPayment,exportSubmissionsCsv,fetchSubmissions,submitForm}from"./submissions";export{computeAmountCents,validateSubmission}from"./validate";
+export{evaluateConditions,visibleFields}from"./conditions";export{createForm,loadFormByHandle,toCreateFields}from"./create";export{loadFormByUuid,publicDefinition}from"./definition";export{dispatchSubmissionNotifications}from"./notifications";export{completeSubmissionPayment,exportSubmissionsCsv,fetchSubmissions,submitForm}from"./submissions";export{computeAmountCents,validateSubmission}from"./validate";

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stacksjs/forms",
   "type": "module",
-  "version": "0.72.8",
+  "version": "0.72.10",
   "description": "The Stacks form-builder functionality.",
   "author": "Chris Breuer",
   "contributors": [
@@ -56,11 +56,11 @@
     "prepublishOnly": "bun run build"
   },
   "devDependencies": {
-    "@stacksjs/config": "0.72.8",
-    "@stacksjs/database": "0.72.8",
-    "@stacksjs/notifications": "0.72.8",
-    "@stacksjs/storage": "0.72.8",
-    "@stacksjs/validation": "0.72.8",
+    "@stacksjs/config": "0.72.10",
+    "@stacksjs/database": "0.72.10",
+    "@stacksjs/notifications": "0.72.10",
+    "@stacksjs/storage": "0.72.10",
+    "@stacksjs/validation": "0.72.10",
     "better-dx": "^0.2.23"
   },
   "sideEffects": false