@marktiderman/genesis-forms 0.0.0-stage → 0.1.1

package/dist/validate-j8Z188mF.d.ts

@@ -0,0 +1,175 @@
+/**
+ * The form definition format. Everything here is plain JSON: a definition can
+ * be stored, diffed, versioned and evaluated identically in a browser, in
+ * React Native and on a server.
+ */
+type Json = string | number | boolean | null | Json[] | {
+    [key: string]: Json;
+};
+interface FieldBlock {
+    kind: "field";
+    /** Immutable. Answers are keyed by this. */
+    id: string;
+    /** Human / export name. Renamable. Used by recall and the builders. */
+    key: string;
+    /** Registry key: "rating", "short-text", "acme/signature". */
+    type: string;
+    /** Supports recall: `{{field:name|there}}`. */
+    label: string;
+    description?: string;
+    placeholder?: string;
+    required?: boolean;
+    /**
+     * Personal or secret data (an SSN, a health detail). Tools such as devtools
+     * mask it. `props.sensitive: true` is read as an alias; see `isSensitive`.
+     */
+    sensitive?: boolean;
+    /**
+     * Identifies the respondent (name, email, phone). When the form's
+     * `settings.anonymous` is true the field is treated as hidden: off the
+     * path, not validated, and its value is never stored.
+     */
+    identifying?: boolean;
+    props?: Record<string, Json>;
+}
+interface ContentBlock {
+    kind: "content";
+    id: string;
+    type: "heading" | "text";
+    text: string;
+}
+interface PageBreakBlock {
+    kind: "page-break";
+    id: string;
+    title?: string;
+}
+type Block = FieldBlock | ContentBlock | PageBreakBlock;
+/**
+ * A typed value that does not come from a question.
+ * - `url`: read from the query string. Untrusted.
+ * - `host`: passed by the app hosting the form. Untrusted.
+ * - `server`: resolved by the server when the form loads and again on
+ *   submit. Never read from the client.
+ */
+interface HiddenInput {
+    name: string;
+    type: "string" | "number" | "boolean";
+    source: "url" | "host" | "server";
+    /** Masked in devtools unless revealed, like a sensitive field. */
+    sensitive?: boolean;
+}
+type Operator = "eq" | "neq" | "lt" | "lte" | "gt" | "gte" | "in" | "contains" | "answered" | "empty";
+type Operand = {
+    field: string;
+} | {
+    hidden: string;
+} | {
+    value: Json;
+};
+type Condition = {
+    all: Condition[];
+} | {
+    any: Condition[];
+} | {
+    not: Condition;
+} | {
+    op: Operator;
+    left: Operand;
+    right?: Operand;
+};
+type LogicRule = {
+    id: string;
+    when: Condition;
+    effect: "show" | "hide";
+    target: string;
+} | {
+    id: string;
+    when: Condition;
+    effect: "jump";
+    from: string;
+    to: string | {
+        ending: string;
+    };
+};
+interface Ending {
+    id: string;
+    title: string;
+    description?: string;
+}
+interface FormSettings {
+    /**
+     * A per-form admin setting, off by default. When true, fields marked
+     * `identifying` are not asked or stored, events carry no timestamps, and
+     * the app's store keeps no identifying metadata with responses.
+     */
+    anonymous?: boolean;
+    /** Clear the values of fields hidden by logic on submit. Default true. */
+    clearHiddenValues?: boolean;
+}
+type FormLayout = {
+    mode: "classic";
+} | {
+    mode: "focus";
+};
+interface FormDefinition {
+    /** Version of the definition format itself. */
+    schemaVersion: 1;
+    id: string;
+    title: string;
+    description?: string;
+    layout?: FormLayout;
+    blocks: Block[];
+    hidden?: HiddenInput[];
+    logic?: LogicRule[];
+    endings?: Ending[];
+    settings?: FormSettings;
+    /** Free for apps and plugins; preserved round-trip. */
+    meta?: Record<string, Json>;
+}
+/** One thing a respondent did. A response is the replay of its events. */
+type FormEvent = {
+    type: "answer";
+    field: string;
+    value: Json | undefined;
+    at?: number;
+    /** `"prefill"`: set by `initialValues` when the form was created, not typed by the respondent. */
+    source?: "prefill";
+} | {
+    type: "next";
+    at?: number;
+} | {
+    type: "back";
+    at?: number;
+} | {
+    type: "submit";
+    at?: number;
+};
+
+/** The Standard Schema interface (standardschema.dev), as far as validation needs it. */
+interface StandardSchemaV1<T = unknown> {
+    readonly "~standard": {
+        readonly version: 1;
+        readonly vendor: string;
+        readonly validate: (value: unknown) => {
+            value: T;
+            issues?: undefined;
+        } | {
+            issues: ReadonlyArray<{
+                message: string;
+            }>;
+        } | Promise<unknown>;
+    };
+}
+/** A custom check for one field: a function, or any Standard Schema (Zod, Valibot, ArkType…). */
+type FieldValidator = ((value: Json) => string | null) | StandardSchemaV1;
+declare const REQUIRED_MESSAGE = "This question needs an answer.";
+/**
+ * Validate one field's value. `requireAnswers: false` (drafts) checks the
+ * format of what was answered without requiring the rest.
+ */
+declare function validateField(field: FieldBlock, value: Json | undefined, options?: {
+    requireAnswers?: boolean;
+    custom?: FieldValidator;
+}): string | null;
+
+export { type Block as B, type ContentBlock as C, type Ending as E, type FieldBlock as F, type HiddenInput as H, type Json as J, type LogicRule as L, type Operator as O, type PageBreakBlock as P, REQUIRED_MESSAGE as R, type StandardSchemaV1 as S, type FormDefinition as a, type FormLayout as b, type FormSettings as c, type Condition as d, type FieldValidator as e, type FormEvent as f, type Operand as g, validateField as v };

package/package.json

@@ -1,6 +1,82 @@
 {
   "name": "@marktiderman/genesis-forms",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "0.1.1",
+  "private": false,
+  "type": "module",
+  "sideEffects": [
+    "./dist/index.js",
+    "./dist/index.cjs",
+    "./dist/server.js",
+    "./dist/server.cjs",
+    "./dist/testing.js",
+    "./dist/testing.cjs"
+  ],
+  "description": "Genesis Forms engine: a serializable form definition, logic, navigation, validation and server-side checking. Zero dependencies; runs in browsers, React Native, Node and edge runtimes. Part of the Genesis framework.",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/marktiderman/genesis.git",
+    "directory": "packages/forms"
+  },
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public",
+    "provenance": false
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./server": {
+      "import": {
+        "types": "./dist/server.d.ts",
+        "default": "./dist/server.js"
+      },
+      "require": {
+        "types": "./dist/server.d.cts",
+        "default": "./dist/server.cjs"
+      }
+    },
+    "./testing": {
+      "import": {
+        "types": "./dist/testing.d.ts",
+        "default": "./dist/testing.js"
+      },
+      "require": {
+        "types": "./dist/testing.d.cts",
+        "default": "./dist/testing.cjs"
+      }
+    },
+    "./conformance/*": "./conformance/*"
+  },
+  "files": [
+    "dist",
+    "conformance",
+    "README.md"
+  ],
+  "devDependencies": {
+    "@fast-check/vitest": "^0.2.4",
+    "fast-check": "^4.10.2",
+    "tsup": "^8.3.0",
+    "typescript": "^5.9.3",
+    "vitest": "^4.1.12"
+  },
+  "scripts": {
+    "build": "tsup && node ../../scripts/check-exports-resolve.mjs && tsc -p type-tests",
+    "clean": "rm -rf dist",
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "conformance:build": "vite-node scripts/build-conformance.ts"
+  }
 }