@btst/plugin-form-builder 0.0.0-stage → 1.0.0

package/dist/db.cjs

@@ -0,0 +1,99 @@
+'use strict';
+
+const db = require('@btst/db');
+
+const formBuilderSchema = db.createDbPlugin("form-builder", {
+  form: {
+    modelName: "form",
+    fields: {
+      name: {
+        type: "string",
+        required: true
+      },
+      slug: {
+        type: "string",
+        required: true,
+        unique: true
+      },
+      description: {
+        type: "string",
+        required: false
+      },
+      // JSON Schema stored as string (includes steps, fieldType, stepGroup, etc.)
+      schema: {
+        type: "string",
+        required: true
+      },
+      // Optional custom success message after submission
+      successMessage: {
+        type: "string",
+        required: false
+      },
+      // Optional redirect URL after submission
+      redirectUrl: {
+        type: "string",
+        required: false
+      },
+      // Form status: active, inactive, archived
+      status: {
+        type: "string",
+        defaultValue: "active"
+      },
+      // User who created the form
+      createdBy: {
+        type: "string",
+        required: false
+      },
+      createdAt: {
+        type: "date",
+        defaultValue: () => /* @__PURE__ */ new Date()
+      },
+      updatedAt: {
+        type: "date",
+        defaultValue: () => /* @__PURE__ */ new Date()
+      }
+    }
+  },
+  formSubmission: {
+    modelName: "formSubmission",
+    fields: {
+      formId: {
+        type: "string",
+        required: true,
+        // Database reference for efficient joins
+        references: {
+          model: "form",
+          field: "id",
+          onDelete: "cascade"
+        }
+      },
+      // Submitted data as JSON string
+      data: {
+        type: "string",
+        required: true
+      },
+      // Submission timestamp
+      submittedAt: {
+        type: "date",
+        defaultValue: () => /* @__PURE__ */ new Date()
+      },
+      // Optional user ID if authenticated
+      submittedBy: {
+        type: "string",
+        required: false
+      },
+      // IP address for rate limiting and spam protection
+      ipAddress: {
+        type: "string",
+        required: false
+      },
+      // User agent for analytics
+      userAgent: {
+        type: "string",
+        required: false
+      }
+    }
+  }
+});
+
+exports.formBuilderSchema = formBuilderSchema;

package/dist/db.mjs

@@ -0,0 +1,97 @@
+import { createDbPlugin } from '@btst/db';
+
+const formBuilderSchema = createDbPlugin("form-builder", {
+  form: {
+    modelName: "form",
+    fields: {
+      name: {
+        type: "string",
+        required: true
+      },
+      slug: {
+        type: "string",
+        required: true,
+        unique: true
+      },
+      description: {
+        type: "string",
+        required: false
+      },
+      // JSON Schema stored as string (includes steps, fieldType, stepGroup, etc.)
+      schema: {
+        type: "string",
+        required: true
+      },
+      // Optional custom success message after submission
+      successMessage: {
+        type: "string",
+        required: false
+      },
+      // Optional redirect URL after submission
+      redirectUrl: {
+        type: "string",
+        required: false
+      },
+      // Form status: active, inactive, archived
+      status: {
+        type: "string",
+        defaultValue: "active"
+      },
+      // User who created the form
+      createdBy: {
+        type: "string",
+        required: false
+      },
+      createdAt: {
+        type: "date",
+        defaultValue: () => /* @__PURE__ */ new Date()
+      },
+      updatedAt: {
+        type: "date",
+        defaultValue: () => /* @__PURE__ */ new Date()
+      }
+    }
+  },
+  formSubmission: {
+    modelName: "formSubmission",
+    fields: {
+      formId: {
+        type: "string",
+        required: true,
+        // Database reference for efficient joins
+        references: {
+          model: "form",
+          field: "id",
+          onDelete: "cascade"
+        }
+      },
+      // Submitted data as JSON string
+      data: {
+        type: "string",
+        required: true
+      },
+      // Submission timestamp
+      submittedAt: {
+        type: "date",
+        defaultValue: () => /* @__PURE__ */ new Date()
+      },
+      // Optional user ID if authenticated
+      submittedBy: {
+        type: "string",
+        required: false
+      },
+      // IP address for rate limiting and spam protection
+      ipAddress: {
+        type: "string",
+        required: false
+      },
+      // User agent for analytics
+      userAgent: {
+        type: "string",
+        required: false
+      }
+    }
+  }
+});
+
+export { formBuilderSchema };

package/dist/permissions.cjs

@@ -0,0 +1,95 @@
+'use strict';
+
+const authorization = require('@btst/stack/authorization');
+const z = require('zod');
+
+const formStatusSchema = z.z.enum(["active", "inactive", "archived"]);
+const resolvedFormFacts = {
+  formId: z.z.string(),
+  ownerId: z.z.string().optional(),
+  status: formStatusSchema
+};
+const formBuilderPermissions = authorization.definePermissions("forms", {
+  form: {
+    /** Read the admin collection or one admin record. */
+    read: authorization.permission(
+      z.z.discriminatedUnion("scope", [
+        z.z.object({ scope: z.z.literal("collection") }),
+        z.z.object({
+          scope: z.z.literal("record"),
+          formId: z.z.string(),
+          exists: z.z.boolean(),
+          ownerId: z.z.string().optional(),
+          status: formStatusSchema.optional()
+        })
+      ])
+    ),
+    /** Render one public form resolved by slug. */
+    render: authorization.permission(
+      z.z.object({
+        slug: z.z.string(),
+        exists: z.z.boolean(),
+        formId: z.z.string().optional(),
+        ownerId: z.z.string().optional(),
+        status: formStatusSchema.optional()
+      })
+    ),
+    /** Create a form. */
+    create: authorization.permission(),
+    /** Update a server-resolved form. */
+    update: authorization.permission(
+      z.z.object({
+        ...resolvedFormFacts
+      })
+    ),
+    /** Delete a server-resolved form and its submissions. */
+    delete: authorization.permission(
+      z.z.object({
+        ...resolvedFormFacts
+      })
+    )
+  },
+  submission: {
+    /** Submit to a public, server-resolved form. */
+    create: authorization.permission(
+      z.z.object({
+        slug: z.z.string(),
+        exists: z.z.boolean(),
+        formId: z.z.string().optional(),
+        ownerId: z.z.string().optional(),
+        status: formStatusSchema.optional()
+      })
+    ),
+    /** Read a form's collection or one server-resolved submission. */
+    read: authorization.permission(
+      z.z.discriminatedUnion("scope", [
+        z.z.object({
+          scope: z.z.literal("collection"),
+          formId: z.z.string(),
+          formExists: z.z.boolean(),
+          ownerId: z.z.string().optional()
+        }),
+        z.z.object({
+          scope: z.z.literal("record"),
+          formId: z.z.string(),
+          submissionId: z.z.string(),
+          exists: z.z.boolean(),
+          ownerId: z.z.string().optional(),
+          submittedBy: z.z.string().optional()
+        })
+      ])
+    ),
+    /** Delete a server-resolved submission. */
+    delete: authorization.permission(
+      z.z.object({
+        formId: z.z.string(),
+        submissionId: z.z.string(),
+        exists: z.z.boolean(),
+        ownerId: z.z.string().optional(),
+        submittedBy: z.z.string().optional()
+      })
+    )
+  }
+});
+
+exports.formBuilderPermissions = formBuilderPermissions;

package/dist/permissions.d.cts

@@ -0,0 +1,94 @@
+import * as _btst_stack_authorization from '@btst/stack/authorization';
+import { z } from 'zod';
+
+/** Browser-safe, schema-backed permissions published by Form Builder. */
+declare const formBuilderPermissions: _btst_stack_authorization.PermissionCatalog<"forms", {
+    readonly form: {
+        /** Read the admin collection or one admin record. */
+        readonly read: _btst_stack_authorization.PermissionSeed<z.ZodDiscriminatedUnion<[z.ZodObject<{
+            scope: z.ZodLiteral<"collection">;
+        }, z.core.$strip>, z.ZodObject<{
+            scope: z.ZodLiteral<"record">;
+            formId: z.ZodString;
+            exists: z.ZodBoolean;
+            ownerId: z.ZodOptional<z.ZodString>;
+            status: z.ZodOptional<z.ZodEnum<{
+                active: "active";
+                inactive: "inactive";
+                archived: "archived";
+            }>>;
+        }, z.core.$strip>], "scope">>;
+        /** Render one public form resolved by slug. */
+        readonly render: _btst_stack_authorization.PermissionSeed<z.ZodObject<{
+            slug: z.ZodString;
+            exists: z.ZodBoolean;
+            formId: z.ZodOptional<z.ZodString>;
+            ownerId: z.ZodOptional<z.ZodString>;
+            status: z.ZodOptional<z.ZodEnum<{
+                active: "active";
+                inactive: "inactive";
+                archived: "archived";
+            }>>;
+        }, z.core.$strip>>;
+        /** Create a form. */
+        readonly create: _btst_stack_authorization.PermissionSeed<undefined>;
+        /** Update a server-resolved form. */
+        readonly update: _btst_stack_authorization.PermissionSeed<z.ZodObject<{
+            formId: z.ZodString;
+            ownerId: z.ZodOptional<z.ZodString>;
+            status: z.ZodEnum<{
+                active: "active";
+                inactive: "inactive";
+                archived: "archived";
+            }>;
+        }, z.core.$strip>>;
+        /** Delete a server-resolved form and its submissions. */
+        readonly delete: _btst_stack_authorization.PermissionSeed<z.ZodObject<{
+            formId: z.ZodString;
+            ownerId: z.ZodOptional<z.ZodString>;
+            status: z.ZodEnum<{
+                active: "active";
+                inactive: "inactive";
+                archived: "archived";
+            }>;
+        }, z.core.$strip>>;
+    };
+    readonly submission: {
+        /** Submit to a public, server-resolved form. */
+        readonly create: _btst_stack_authorization.PermissionSeed<z.ZodObject<{
+            slug: z.ZodString;
+            exists: z.ZodBoolean;
+            formId: z.ZodOptional<z.ZodString>;
+            ownerId: z.ZodOptional<z.ZodString>;
+            status: z.ZodOptional<z.ZodEnum<{
+                active: "active";
+                inactive: "inactive";
+                archived: "archived";
+            }>>;
+        }, z.core.$strip>>;
+        /** Read a form's collection or one server-resolved submission. */
+        readonly read: _btst_stack_authorization.PermissionSeed<z.ZodDiscriminatedUnion<[z.ZodObject<{
+            scope: z.ZodLiteral<"collection">;
+            formId: z.ZodString;
+            formExists: z.ZodBoolean;
+            ownerId: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>, z.ZodObject<{
+            scope: z.ZodLiteral<"record">;
+            formId: z.ZodString;
+            submissionId: z.ZodString;
+            exists: z.ZodBoolean;
+            ownerId: z.ZodOptional<z.ZodString>;
+            submittedBy: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>], "scope">>;
+        /** Delete a server-resolved submission. */
+        readonly delete: _btst_stack_authorization.PermissionSeed<z.ZodObject<{
+            formId: z.ZodString;
+            submissionId: z.ZodString;
+            exists: z.ZodBoolean;
+            ownerId: z.ZodOptional<z.ZodString>;
+            submittedBy: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>;
+    };
+}>;
+
+export { formBuilderPermissions };

package/dist/permissions.d.mts

@@ -0,0 +1,94 @@
+import * as _btst_stack_authorization from '@btst/stack/authorization';
+import { z } from 'zod';
+
+/** Browser-safe, schema-backed permissions published by Form Builder. */
+declare const formBuilderPermissions: _btst_stack_authorization.PermissionCatalog<"forms", {
+    readonly form: {
+        /** Read the admin collection or one admin record. */
+        readonly read: _btst_stack_authorization.PermissionSeed<z.ZodDiscriminatedUnion<[z.ZodObject<{
+            scope: z.ZodLiteral<"collection">;
+        }, z.core.$strip>, z.ZodObject<{
+            scope: z.ZodLiteral<"record">;
+            formId: z.ZodString;
+            exists: z.ZodBoolean;
+            ownerId: z.ZodOptional<z.ZodString>;
+            status: z.ZodOptional<z.ZodEnum<{
+                active: "active";
+                inactive: "inactive";
+                archived: "archived";
+            }>>;
+        }, z.core.$strip>], "scope">>;
+        /** Render one public form resolved by slug. */
+        readonly render: _btst_stack_authorization.PermissionSeed<z.ZodObject<{
+            slug: z.ZodString;
+            exists: z.ZodBoolean;
+            formId: z.ZodOptional<z.ZodString>;
+            ownerId: z.ZodOptional<z.ZodString>;
+            status: z.ZodOptional<z.ZodEnum<{
+                active: "active";
+                inactive: "inactive";
+                archived: "archived";
+            }>>;
+        }, z.core.$strip>>;
+        /** Create a form. */
+        readonly create: _btst_stack_authorization.PermissionSeed<undefined>;
+        /** Update a server-resolved form. */
+        readonly update: _btst_stack_authorization.PermissionSeed<z.ZodObject<{
+            formId: z.ZodString;
+            ownerId: z.ZodOptional<z.ZodString>;
+            status: z.ZodEnum<{
+                active: "active";
+                inactive: "inactive";
+                archived: "archived";
+            }>;
+        }, z.core.$strip>>;
+        /** Delete a server-resolved form and its submissions. */
+        readonly delete: _btst_stack_authorization.PermissionSeed<z.ZodObject<{
+            formId: z.ZodString;
+            ownerId: z.ZodOptional<z.ZodString>;
+            status: z.ZodEnum<{
+                active: "active";
+                inactive: "inactive";
+                archived: "archived";
+            }>;
+        }, z.core.$strip>>;
+    };
+    readonly submission: {
+        /** Submit to a public, server-resolved form. */
+        readonly create: _btst_stack_authorization.PermissionSeed<z.ZodObject<{
+            slug: z.ZodString;
+            exists: z.ZodBoolean;
+            formId: z.ZodOptional<z.ZodString>;
+            ownerId: z.ZodOptional<z.ZodString>;
+            status: z.ZodOptional<z.ZodEnum<{
+                active: "active";
+                inactive: "inactive";
+                archived: "archived";
+            }>>;
+        }, z.core.$strip>>;
+        /** Read a form's collection or one server-resolved submission. */
+        readonly read: _btst_stack_authorization.PermissionSeed<z.ZodDiscriminatedUnion<[z.ZodObject<{
+            scope: z.ZodLiteral<"collection">;
+            formId: z.ZodString;
+            formExists: z.ZodBoolean;
+            ownerId: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>, z.ZodObject<{
+            scope: z.ZodLiteral<"record">;
+            formId: z.ZodString;
+            submissionId: z.ZodString;
+            exists: z.ZodBoolean;
+            ownerId: z.ZodOptional<z.ZodString>;
+            submittedBy: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>], "scope">>;
+        /** Delete a server-resolved submission. */
+        readonly delete: _btst_stack_authorization.PermissionSeed<z.ZodObject<{
+            formId: z.ZodString;
+            submissionId: z.ZodString;
+            exists: z.ZodBoolean;
+            ownerId: z.ZodOptional<z.ZodString>;
+            submittedBy: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>;
+    };
+}>;
+
+export { formBuilderPermissions };

package/dist/permissions.d.ts

@@ -0,0 +1,94 @@
+import * as _btst_stack_authorization from '@btst/stack/authorization';
+import { z } from 'zod';
+
+/** Browser-safe, schema-backed permissions published by Form Builder. */
+declare const formBuilderPermissions: _btst_stack_authorization.PermissionCatalog<"forms", {
+    readonly form: {
+        /** Read the admin collection or one admin record. */
+        readonly read: _btst_stack_authorization.PermissionSeed<z.ZodDiscriminatedUnion<[z.ZodObject<{
+            scope: z.ZodLiteral<"collection">;
+        }, z.core.$strip>, z.ZodObject<{
+            scope: z.ZodLiteral<"record">;
+            formId: z.ZodString;
+            exists: z.ZodBoolean;
+            ownerId: z.ZodOptional<z.ZodString>;
+            status: z.ZodOptional<z.ZodEnum<{
+                active: "active";
+                inactive: "inactive";
+                archived: "archived";
+            }>>;
+        }, z.core.$strip>], "scope">>;
+        /** Render one public form resolved by slug. */
+        readonly render: _btst_stack_authorization.PermissionSeed<z.ZodObject<{
+            slug: z.ZodString;
+            exists: z.ZodBoolean;
+            formId: z.ZodOptional<z.ZodString>;
+            ownerId: z.ZodOptional<z.ZodString>;
+            status: z.ZodOptional<z.ZodEnum<{
+                active: "active";
+                inactive: "inactive";
+                archived: "archived";
+            }>>;
+        }, z.core.$strip>>;
+        /** Create a form. */
+        readonly create: _btst_stack_authorization.PermissionSeed<undefined>;
+        /** Update a server-resolved form. */
+        readonly update: _btst_stack_authorization.PermissionSeed<z.ZodObject<{
+            formId: z.ZodString;
+            ownerId: z.ZodOptional<z.ZodString>;
+            status: z.ZodEnum<{
+                active: "active";
+                inactive: "inactive";
+                archived: "archived";
+            }>;
+        }, z.core.$strip>>;
+        /** Delete a server-resolved form and its submissions. */
+        readonly delete: _btst_stack_authorization.PermissionSeed<z.ZodObject<{
+            formId: z.ZodString;
+            ownerId: z.ZodOptional<z.ZodString>;
+            status: z.ZodEnum<{
+                active: "active";
+                inactive: "inactive";
+                archived: "archived";
+            }>;
+        }, z.core.$strip>>;
+    };
+    readonly submission: {
+        /** Submit to a public, server-resolved form. */
+        readonly create: _btst_stack_authorization.PermissionSeed<z.ZodObject<{
+            slug: z.ZodString;
+            exists: z.ZodBoolean;
+            formId: z.ZodOptional<z.ZodString>;
+            ownerId: z.ZodOptional<z.ZodString>;
+            status: z.ZodOptional<z.ZodEnum<{
+                active: "active";
+                inactive: "inactive";
+                archived: "archived";
+            }>>;
+        }, z.core.$strip>>;
+        /** Read a form's collection or one server-resolved submission. */
+        readonly read: _btst_stack_authorization.PermissionSeed<z.ZodDiscriminatedUnion<[z.ZodObject<{
+            scope: z.ZodLiteral<"collection">;
+            formId: z.ZodString;
+            formExists: z.ZodBoolean;
+            ownerId: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>, z.ZodObject<{
+            scope: z.ZodLiteral<"record">;
+            formId: z.ZodString;
+            submissionId: z.ZodString;
+            exists: z.ZodBoolean;
+            ownerId: z.ZodOptional<z.ZodString>;
+            submittedBy: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>], "scope">>;
+        /** Delete a server-resolved submission. */
+        readonly delete: _btst_stack_authorization.PermissionSeed<z.ZodObject<{
+            formId: z.ZodString;
+            submissionId: z.ZodString;
+            exists: z.ZodBoolean;
+            ownerId: z.ZodOptional<z.ZodString>;
+            submittedBy: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>>;
+    };
+}>;
+
+export { formBuilderPermissions };

package/dist/permissions.mjs

@@ -0,0 +1,93 @@
+import { definePermissions, permission } from '@btst/stack/authorization';
+import { z } from 'zod';
+
+const formStatusSchema = z.enum(["active", "inactive", "archived"]);
+const resolvedFormFacts = {
+  formId: z.string(),
+  ownerId: z.string().optional(),
+  status: formStatusSchema
+};
+const formBuilderPermissions = definePermissions("forms", {
+  form: {
+    /** Read the admin collection or one admin record. */
+    read: permission(
+      z.discriminatedUnion("scope", [
+        z.object({ scope: z.literal("collection") }),
+        z.object({
+          scope: z.literal("record"),
+          formId: z.string(),
+          exists: z.boolean(),
+          ownerId: z.string().optional(),
+          status: formStatusSchema.optional()
+        })
+      ])
+    ),
+    /** Render one public form resolved by slug. */
+    render: permission(
+      z.object({
+        slug: z.string(),
+        exists: z.boolean(),
+        formId: z.string().optional(),
+        ownerId: z.string().optional(),
+        status: formStatusSchema.optional()
+      })
+    ),
+    /** Create a form. */
+    create: permission(),
+    /** Update a server-resolved form. */
+    update: permission(
+      z.object({
+        ...resolvedFormFacts
+      })
+    ),
+    /** Delete a server-resolved form and its submissions. */
+    delete: permission(
+      z.object({
+        ...resolvedFormFacts
+      })
+    )
+  },
+  submission: {
+    /** Submit to a public, server-resolved form. */
+    create: permission(
+      z.object({
+        slug: z.string(),
+        exists: z.boolean(),
+        formId: z.string().optional(),
+        ownerId: z.string().optional(),
+        status: formStatusSchema.optional()
+      })
+    ),
+    /** Read a form's collection or one server-resolved submission. */
+    read: permission(
+      z.discriminatedUnion("scope", [
+        z.object({
+          scope: z.literal("collection"),
+          formId: z.string(),
+          formExists: z.boolean(),
+          ownerId: z.string().optional()
+        }),
+        z.object({
+          scope: z.literal("record"),
+          formId: z.string(),
+          submissionId: z.string(),
+          exists: z.boolean(),
+          ownerId: z.string().optional(),
+          submittedBy: z.string().optional()
+        })
+      ])
+    ),
+    /** Delete a server-resolved submission. */
+    delete: permission(
+      z.object({
+        formId: z.string(),
+        submissionId: z.string(),
+        exists: z.boolean(),
+        ownerId: z.string().optional(),
+        submittedBy: z.string().optional()
+      })
+    )
+  }
+});
+
+export { formBuilderPermissions };