@surveystudio/node-registery 1.0.0

package/README.md

@@ -0,0 +1,25 @@
+# @survey-studio/node-registery
+
+Typed survey question node registry with separate entrypoints for pure logic, runner UI, and builder UI.
+
+This package is currently in early migration. It exports the first migrated node, `plainText`, while the remaining SurveyChamp question nodes are being moved into the registry.
+
+## Entrypoints
+
+```ts
+import { logicRegistry } from "@survey-studio/node-registery/logic";
+import { runnerRegistry } from "@survey-studio/node-registery/runner";
+import { builderRegistry } from "@survey-studio/node-registery/builder";
+```
+
+Use `/logic` for Worker, export, and server runtimes. It is intentionally React-free.
+
+Use `/runner` and `/builder` only in React runtimes. React is a peer dependency and is not bundled.
+
+## Current Status
+
+Migrated nodes:
+
+- `plainText`
+
+The registry contract test intentionally fails until all planned question nodes are migrated.

package/dist/builder.d.mts

@@ -0,0 +1,65 @@
+import * as react from 'react';
+import { CSSProperties } from 'react';
+import { i as NodeBuilderProps, P as PlainTextData, j as NodeCanvasProps, J as JsonValue } from './types-DJePy6HU.mjs';
+export { B as BuilderRegistry, k as CompleteBuilderRegistry, l as NodeBuilder, m as NodeManifest, n as PropertyField, o as PropertyFieldType, Q as QuestionNodeDefinition, S as SelectOption, p as defineBuilderRegistry, c as defineQuestionNode } from './types-DJePy6HU.mjs';
+
+declare function PlainTextBuilderPreview({ data }: NodeCanvasProps<PlainTextData>): react.DetailedReactHTMLElement<{
+    style: CSSProperties;
+}, HTMLElement>;
+declare function PlainTextSettings(_props: NodeBuilderProps<PlainTextData>): null;
+declare const plainTextBuilder: {
+    type: "plainText";
+    label: string;
+    SettingsComponent: typeof PlainTextSettings;
+    CanvasComponent: typeof PlainTextBuilderPreview;
+};
+
+declare const plainTextManifest: {
+    type: "plainText";
+    label: string;
+    description: string;
+    category: "media";
+    dataType: "none";
+    defaultData: PlainTextData;
+    properties: ({
+        name: string;
+        label: string;
+        type: "text";
+        placeholder: string;
+        defaultValue?: never;
+    } | {
+        name: string;
+        label: string;
+        type: "textarea";
+        placeholder: string;
+        defaultValue: string;
+    } | {
+        name: string;
+        label: string;
+        type: "text";
+        defaultValue: string;
+        placeholder?: never;
+    } | {
+        name: string;
+        label: string;
+        type: "condition";
+        defaultValue: {
+            id: string;
+            type: "group";
+            logicType: "AND" | "OR";
+            children: JsonValue[];
+        };
+        placeholder?: never;
+    })[];
+};
+
+declare const builderRegistry: {
+    readonly plainText: {
+        type: "plainText";
+        label: string;
+        SettingsComponent: typeof PlainTextSettings;
+        CanvasComponent: typeof PlainTextBuilderPreview;
+    };
+};
+
+export { NodeBuilderProps, NodeCanvasProps, builderRegistry, plainTextBuilder, plainTextManifest };

package/dist/builder.mjs

@@ -0,0 +1,122 @@
+// src/types.ts
+function defineQuestionNode(definition) {
+  return definition;
+}
+function defineBuilderRegistry(registry) {
+  return registry;
+}
+
+// src/nodes/plainText/builder.ts
+import { createElement } from "react";
+var shellStyle = {
+  display: "grid",
+  gap: "12px",
+  minWidth: "220px"
+};
+var titleStyle = {
+  color: "#111827",
+  fontSize: "14px",
+  fontWeight: 600,
+  lineHeight: 1.3,
+  margin: 0
+};
+var descriptionStyle = {
+  background: "#f3f4f6",
+  borderRadius: "6px",
+  color: "#4b5563",
+  fontSize: "12px",
+  lineHeight: 1.45,
+  margin: 0,
+  maxHeight: "96px",
+  overflow: "hidden",
+  padding: "8px",
+  whiteSpace: "pre-wrap"
+};
+var footerStyle = {
+  display: "flex",
+  justifyContent: "flex-end"
+};
+var buttonStyle = {
+  background: "#111827",
+  border: 0,
+  borderRadius: "6px",
+  color: "#ffffff",
+  fontSize: "12px",
+  fontWeight: 500,
+  padding: "4px 10px"
+};
+function PlainTextBuilderPreview({ data }) {
+  const label = data.label || "Info Screen";
+  const description = data.description || "No content provided...";
+  const buttonLabel = data.buttonLabel || "Continue";
+  return createElement(
+    "div",
+    { style: shellStyle },
+    createElement("p", { style: titleStyle }, label),
+    createElement("p", { style: descriptionStyle }, description),
+    createElement(
+      "div",
+      { style: footerStyle },
+      createElement("button", { disabled: true, style: buttonStyle, type: "button" }, buttonLabel)
+    )
+  );
+}
+function PlainTextSettings(_props) {
+  return null;
+}
+var plainTextBuilder = {
+  type: "plainText",
+  label: "Info / Text",
+  SettingsComponent: PlainTextSettings,
+  CanvasComponent: PlainTextBuilderPreview
+};
+
+// src/nodes/plainText/manifest.ts
+var plainTextDefaultData = {
+  label: "Info / Text",
+  description: "",
+  buttonLabel: "Continue",
+  condition: {
+    id: "root",
+    type: "group",
+    logicType: "AND",
+    children: []
+  }
+};
+var plainTextManifest = {
+  type: "plainText",
+  label: "Info / Text",
+  description: "Display text with a continue button",
+  category: "media",
+  dataType: "none",
+  defaultData: plainTextDefaultData,
+  properties: [
+    { name: "label", label: "Field Label", type: "text", placeholder: "Info Screen" },
+    {
+      name: "description",
+      label: "Content",
+      type: "textarea",
+      placeholder: "Enter your message here...",
+      defaultValue: ""
+    },
+    { name: "buttonLabel", label: "Button Label", type: "text", defaultValue: "Continue" },
+    {
+      name: "condition",
+      label: "Logic Rule",
+      type: "condition",
+      defaultValue: plainTextDefaultData.condition
+    }
+  ]
+};
+
+// src/builder/index.ts
+var builderRegistry = defineBuilderRegistry({
+  plainText: plainTextBuilder
+});
+export {
+  builderRegistry,
+  defineBuilderRegistry,
+  defineQuestionNode,
+  plainTextBuilder,
+  plainTextManifest
+};

package/dist/logic.d.mts

@@ -0,0 +1,41 @@
+import { P as PlainTextData, a as PlainTextValue } from './types-DJePy6HU.mjs';
+export { C as CompleteLogicRegistry, D as DataType, E as ExtractedValue, b as ExtractionContext, L as LogicRegistry, N as NodeLogic, Q as QuestionNodeDefinition, V as ValidationResult, d as defineLogicRegistry, c as defineQuestionNode } from './types-DJePy6HU.mjs';
+import 'react';
+
+declare const plainTextLogic: {
+    type: "plainText";
+    dataType: "none";
+    defaultData: PlainTextData;
+    defaultValue: {
+        viewed: false;
+    };
+    validate: () => {
+        valid: true;
+    };
+    extractValue: (value: PlainTextValue) => {
+        columnKey: string;
+        columnLabel: string;
+        booleanValue: boolean;
+    }[];
+};
+
+declare const logicRegistry: {
+    readonly plainText: {
+        type: "plainText";
+        dataType: "none";
+        defaultData: PlainTextData;
+        defaultValue: {
+            viewed: false;
+        };
+        validate: () => {
+            valid: true;
+        };
+        extractValue: (value: PlainTextValue) => {
+            columnKey: string;
+            columnLabel: string;
+            booleanValue: boolean;
+        }[];
+    };
+};
+
+export { logicRegistry, plainTextLogic };

package/dist/logic.mjs

@@ -0,0 +1,72 @@
+// src/types.ts
+function defineQuestionNode(definition) {
+  return definition;
+}
+function defineLogicRegistry(registry) {
+  return registry;
+}
+
+// src/nodes/plainText/manifest.ts
+var plainTextDefaultData = {
+  label: "Info / Text",
+  description: "",
+  buttonLabel: "Continue",
+  condition: {
+    id: "root",
+    type: "group",
+    logicType: "AND",
+    children: []
+  }
+};
+var plainTextManifest = {
+  type: "plainText",
+  label: "Info / Text",
+  description: "Display text with a continue button",
+  category: "media",
+  dataType: "none",
+  defaultData: plainTextDefaultData,
+  properties: [
+    { name: "label", label: "Field Label", type: "text", placeholder: "Info Screen" },
+    {
+      name: "description",
+      label: "Content",
+      type: "textarea",
+      placeholder: "Enter your message here...",
+      defaultValue: ""
+    },
+    { name: "buttonLabel", label: "Button Label", type: "text", defaultValue: "Continue" },
+    {
+      name: "condition",
+      label: "Logic Rule",
+      type: "condition",
+      defaultValue: plainTextDefaultData.condition
+    }
+  ]
+};
+
+// src/nodes/plainText/logic.ts
+var plainTextLogic = {
+  type: "plainText",
+  dataType: "none",
+  defaultData: plainTextDefaultData,
+  defaultValue: { viewed: false },
+  validate: () => ({ valid: true }),
+  extractValue: (value) => [
+    {
+      columnKey: "viewed",
+      columnLabel: "Viewed",
+      booleanValue: Boolean(value?.viewed)
+    }
+  ]
+};
+
+// src/logic/index.ts
+var logicRegistry = defineLogicRegistry({
+  plainText: plainTextLogic
+});
+export {
+  defineLogicRegistry,
+  defineQuestionNode,
+  logicRegistry,
+  plainTextLogic
+};

package/dist/runner.d.mts

@@ -0,0 +1,21 @@
+import * as react from 'react';
+import { CSSProperties } from 'react';
+import { e as NodeRunnerProps, P as PlainTextData, a as PlainTextValue } from './types-DJePy6HU.mjs';
+export { f as CompleteRunnerRegistry, g as NodeRunner, Q as QuestionNodeDefinition, R as RunnerRegistry, c as defineQuestionNode, h as defineRunnerRegistry } from './types-DJePy6HU.mjs';
+
+declare function PlainTextRunnerView({ data, onChange, onNext, isActive, }: NodeRunnerProps<PlainTextData, PlainTextValue>): react.DetailedReactHTMLElement<{
+    style: CSSProperties;
+}, HTMLElement>;
+declare const plainTextRunner: {
+    type: "plainText";
+    Component: typeof PlainTextRunnerView;
+};
+
+declare const runnerRegistry: {
+    readonly plainText: {
+        type: "plainText";
+        Component: typeof PlainTextRunnerView;
+    };
+};
+
+export { NodeRunnerProps, plainTextRunner, runnerRegistry };

package/dist/runner.mjs

@@ -0,0 +1,82 @@
+// src/types.ts
+function defineQuestionNode(definition) {
+  return definition;
+}
+function defineRunnerRegistry(registry) {
+  return registry;
+}
+
+// src/nodes/plainText/runner.ts
+import { createElement } from "react";
+var shellStyle = {
+  display: "grid",
+  gap: "24px",
+  maxWidth: "576px",
+  padding: "16px 0",
+  width: "100%"
+};
+var descriptionStyle = {
+  color: "#334155",
+  fontSize: "18px",
+  lineHeight: 1.65,
+  margin: 0,
+  whiteSpace: "pre-wrap"
+};
+var buttonStyle = {
+  alignItems: "center",
+  background: "#111827",
+  border: 0,
+  borderRadius: "999px",
+  color: "#ffffff",
+  cursor: "pointer",
+  display: "inline-flex",
+  fontSize: "15px",
+  fontWeight: 600,
+  gap: "8px",
+  justifySelf: "start",
+  padding: "12px 24px"
+};
+function PlainTextRunnerView({
+  data,
+  onChange,
+  onNext,
+  isActive
+}) {
+  const description = data.description || "No description provided...";
+  const buttonLabel = data.buttonLabel || "Continue";
+  const children = [createElement("p", { key: "description", style: descriptionStyle }, description)];
+  if (isActive) {
+    children.push(
+      createElement(
+        "button",
+        {
+          key: "button",
+          onClick: () => {
+            onChange({ viewed: true });
+            onNext?.();
+          },
+          style: buttonStyle,
+          type: "button"
+        },
+        buttonLabel,
+        " ->"
+      )
+    );
+  }
+  return createElement("div", { style: shellStyle }, children);
+}
+var plainTextRunner = {
+  type: "plainText",
+  Component: PlainTextRunnerView
+};
+
+// src/runner/index.ts
+var runnerRegistry = defineRunnerRegistry({
+  plainText: plainTextRunner
+});
+export {
+  defineQuestionNode,
+  defineRunnerRegistry,
+  plainTextRunner,
+  runnerRegistry
+};

package/dist/types-DJePy6HU.d.mts

@@ -0,0 +1,140 @@
+import { ReactNode, ComponentType } from 'react';
+
+declare const QUESTION_NODE_TYPES: readonly ["textInput", "numberInput", "emailInput", "dateInput", "multiInput", "zipCodeInput", "singleChoice", "multipleChoice", "dropdown", "ranking", "cascadingChoice", "matrixChoice", "rating", "slider", "consent", "captcha", "image", "video", "audio", "plainText", "emojiRating"];
+declare const FLOW_NODE_TYPES: readonly ["start", "end", "branch", "validation"];
+type QuestionNodeType = (typeof QUESTION_NODE_TYPES)[number];
+type FlowNodeType = (typeof FLOW_NODE_TYPES)[number];
+type SurveyNodeType = QuestionNodeType | FlowNodeType;
+type NodeCategory = "input" | "choice" | "logic" | "media" | "flow";
+type PrimitiveValue = string | number | boolean | null;
+type JsonValue = PrimitiveValue | JsonValue[] | {
+    [key: string]: JsonValue;
+};
+type NodeData = Record<string, JsonValue | undefined>;
+type NodeValue = JsonValue | undefined;
+type DataType = "text" | "number" | "boolean" | "option" | "array" | "object" | "none";
+type PropertyFieldType = "text" | "textarea" | "number" | "switch" | "select" | "color" | "options" | "condition" | "stepBuilder" | "fileTextarea" | "file" | "files" | "emojiOptions";
+interface SelectOption {
+    readonly label: string;
+    readonly value: string;
+}
+interface PropertyField<TData extends NodeData = NodeData> {
+    readonly name: keyof TData & string;
+    readonly label: string;
+    readonly type: PropertyFieldType;
+    readonly placeholder?: string;
+    readonly helperText?: string;
+    readonly defaultValue?: JsonValue;
+    readonly options?: readonly SelectOption[];
+    readonly visible?: (data: Readonly<TData>) => boolean;
+    readonly min?: number;
+    readonly max?: number;
+}
+interface NodeManifest<TType extends SurveyNodeType = SurveyNodeType, TData extends NodeData = NodeData> {
+    readonly type: TType;
+    readonly label: string;
+    readonly description: string;
+    readonly category: NodeCategory;
+    readonly dataType: DataType;
+    readonly defaultData: Readonly<TData>;
+    readonly properties: readonly PropertyField<TData>[];
+}
+interface ValidationResult {
+    readonly valid: boolean;
+    readonly error?: string;
+}
+interface ExtractedValue {
+    readonly questionId?: string;
+    readonly columnKey?: string;
+    readonly columnLabel?: string;
+    readonly textValue?: string;
+    readonly numberValue?: number;
+    readonly booleanValue?: boolean;
+    readonly optionUuid?: string;
+    readonly optionText?: string;
+    readonly arrayValue?: readonly JsonValue[];
+    readonly objectValue?: Readonly<Record<string, JsonValue>>;
+    readonly metadata?: Readonly<Record<string, JsonValue>>;
+}
+interface ExtractionContext<TType extends SurveyNodeType = SurveyNodeType> {
+    readonly nodeId: string;
+    readonly nodeType: TType;
+    readonly questionLabel?: string;
+}
+interface NodeLogic<TType extends SurveyNodeType = SurveyNodeType, TData extends NodeData = NodeData, TValue extends NodeValue = NodeValue> {
+    readonly type: TType;
+    readonly dataType: DataType;
+    readonly defaultData: Readonly<TData>;
+    readonly defaultValue?: TValue;
+    validate(value: TValue, nodeData: Readonly<TData>): ValidationResult;
+    extractValue(value: TValue, nodeData: Readonly<TData>, context: ExtractionContext<TType>): readonly ExtractedValue[];
+}
+interface NodeRunnerProps<TData extends NodeData = NodeData, TValue extends NodeValue = NodeValue> {
+    readonly data: Readonly<TData>;
+    readonly value: TValue;
+    readonly onChange: (newValue: TValue) => void;
+    readonly onNext?: () => void;
+    readonly error?: string;
+    readonly isActive?: boolean;
+}
+interface NodeRunner<TType extends SurveyNodeType = SurveyNodeType, TData extends NodeData = NodeData, TValue extends NodeValue = NodeValue> {
+    readonly type: TType;
+    readonly Component: ComponentType<NodeRunnerProps<TData, TValue>>;
+}
+interface NodeBuilderProps<TData extends NodeData = NodeData> {
+    readonly data: Readonly<TData>;
+    readonly onChange: (newData: TData) => void;
+}
+interface NodeCanvasProps<TData extends NodeData = NodeData> {
+    readonly id: string;
+    readonly type: SurveyNodeType;
+    readonly data: Readonly<TData>;
+    readonly selected?: boolean;
+}
+interface NodeBuilder<TType extends SurveyNodeType = SurveyNodeType, TData extends NodeData = NodeData> {
+    readonly type: TType;
+    readonly label: string;
+    readonly icon?: ReactNode;
+    readonly SettingsComponent?: ComponentType<NodeBuilderProps<TData>>;
+    readonly CanvasComponent?: ComponentType<NodeCanvasProps<TData>>;
+}
+interface QuestionNodeDefinition<TType extends QuestionNodeType = QuestionNodeType, TData extends NodeData = NodeData, TValue extends NodeValue = NodeValue> {
+    readonly manifest: NodeManifest<TType, TData>;
+    readonly logic: NodeLogic<TType, TData, TValue>;
+    readonly builder: NodeBuilder<TType, TData>;
+    readonly runner: NodeRunner<TType, TData, TValue>;
+}
+type CompleteLogicRegistry<TType extends QuestionNodeType = QuestionNodeType> = Readonly<Record<TType, NodeLogic<TType, NodeData, NodeValue>>>;
+type CompleteBuilderRegistry<TType extends QuestionNodeType = QuestionNodeType> = Readonly<Record<TType, NodeBuilder<TType, NodeData>>>;
+type CompleteRunnerRegistry<TType extends QuestionNodeType = QuestionNodeType> = Readonly<Record<TType, NodeRunner<TType, NodeData, NodeValue>>>;
+type LogicRegistry<TType extends SurveyNodeType = SurveyNodeType> = Readonly<Partial<{
+    [K in TType]: NodeLogic<K, NodeData, NodeValue>;
+}>>;
+type BuilderRegistry<TType extends SurveyNodeType = SurveyNodeType> = Readonly<Partial<{
+    [K in TType]: NodeBuilder<K, NodeData>;
+}>>;
+type RunnerRegistry<TType extends SurveyNodeType = SurveyNodeType> = Readonly<Partial<{
+    [K in TType]: NodeRunner<K, NodeData, NodeValue>;
+}>>;
+declare function defineQuestionNode<const TType extends QuestionNodeType, TData extends NodeData, TValue extends NodeValue>(definition: QuestionNodeDefinition<TType, TData, TValue>): QuestionNodeDefinition<TType, TData, TValue>;
+type RegistryKeySet = Readonly<Partial<Record<SurveyNodeType, unknown>>>;
+declare function defineLogicRegistry<const TRegistry extends RegistryKeySet>(registry: TRegistry): TRegistry;
+declare function defineBuilderRegistry<const TRegistry extends RegistryKeySet>(registry: TRegistry): TRegistry;
+declare function defineRunnerRegistry<const TRegistry extends RegistryKeySet>(registry: TRegistry): TRegistry;
+
+type PlainTextData = NodeData & {
+    label: string;
+    description: string;
+    buttonLabel: string;
+    condition: {
+        id: string;
+        type: "group";
+        logicType: "AND" | "OR";
+        children: JsonValue[];
+    };
+};
+type PlainTextValue = {
+    viewed: boolean;
+};
+
+export { type BuilderRegistry as B, type CompleteLogicRegistry as C, type DataType as D, type ExtractedValue as E, type JsonValue as J, type LogicRegistry as L, type NodeLogic as N, type PlainTextData as P, type QuestionNodeDefinition as Q, type RunnerRegistry as R, type SelectOption as S, type ValidationResult as V, type PlainTextValue as a, type ExtractionContext as b, defineQuestionNode as c, defineLogicRegistry as d, type NodeRunnerProps as e, type CompleteRunnerRegistry as f, type NodeRunner as g, defineRunnerRegistry as h, type NodeBuilderProps as i, type NodeCanvasProps as j, type CompleteBuilderRegistry as k, type NodeBuilder as l, type NodeManifest as m, type PropertyField as n, type PropertyFieldType as o, defineBuilderRegistry as p };

package/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "@surveystudio/node-registery",
+  "version": "1.0.0",
+  "description": "Typed survey question node registry with split builder, runner, and logic entrypoints.",
+  "main": "./dist/logic.mjs",
+  "types": "./dist/logic.d.mts",
+  "exports": {
+    ".": {
+      "import": "./dist/logic.mjs",
+      "types": "./dist/logic.d.mts"
+    },
+    "./logic": {
+      "import": "./dist/logic.mjs",
+      "types": "./dist/logic.d.mts"
+    },
+    "./runner": {
+      "import": "./dist/runner.mjs",
+      "types": "./dist/runner.d.mts"
+    },
+    "./builder": {
+      "import": "./dist/builder.mjs",
+      "types": "./dist/builder.d.mts"
+    },
+    "./package.json": "./package.json"
+  },
+  "keywords": [
+    "survey",
+    "questionnaire",
+    "registry",
+    "nodes",
+    "react"
+  ],
+  "author": "",
+  "license": "ISC",
+  "packageManager": "pnpm@10.28.2",
+  "devDependencies": {
+    "@types/node": "^25.2.2",
+    "@types/react": "^19.2.13",
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3",
+    "react": "^19.2.3",
+    "react-dom": "^19.2.3"
+  },
+  "scripts": {
+    "test": "node --test test/*.test.mjs",
+    "typecheck": "tsc --noEmit",
+    "build": "tsup",
+    "prepack": "pnpm build",
+    "pack:dry-run": "pnpm pack --dry-run"
+  },
+  "peerDependencies": {
+    "react": ">=18",
+    "react-dom": ">=18"
+  },
+  "peerDependenciesMeta": {
+    "react": {
+      "optional": true
+    },
+    "react-dom": {
+      "optional": true
+    }
+  },
+  "sideEffects": false,
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "publishConfig": {
+    "access": "public"
+  }
+}