@bpmnkit/core 0.0.8

package/dist/form/form-builder.d.ts

@@ -0,0 +1,111 @@
+import type { FormComponent, FormDefinition, FormLayout, FormValidation, FormValueOption } from "./form-model.js";
+/** Builder for constructing Camunda Forms programmatically. */
+export declare class FormBuilder {
+    private _id;
+    private _type;
+    private _executionPlatform;
+    private _executionPlatformVersion;
+    private _exporter?;
+    private _schemaVersion?;
+    private _generated?;
+    private readonly _components;
+    constructor(id?: string);
+    /** Sets the form ID. */
+    id(id: string): this;
+    /** Sets the execution platform. */
+    executionPlatform(platform: string): this;
+    /** Sets the execution platform version. */
+    executionPlatformVersion(version: string): this;
+    /** Sets the exporter metadata. */
+    exporter(name: string, version: string): this;
+    /** Sets the schema version. */
+    schemaVersion(version: number): this;
+    /** Marks this form as generated. */
+    generated(value: boolean): this;
+    /** Adds a static text component. */
+    text(text: string, options?: {
+        id?: string;
+        label?: string;
+        layout?: FormLayout;
+    }): this;
+    /** Adds a text field component. */
+    textfield(label: string, key: string, options?: TextFieldOptions): this;
+    /** Adds a textarea component. */
+    textarea(label: string, key: string, options?: TextFieldOptions): this;
+    /** Adds a select dropdown component. */
+    select(label: string, key: string, options?: SelectOptions): this;
+    /** Adds a radio button group component. */
+    radio(label: string, key: string, values: FormValueOption[], options?: RadioOptions): this;
+    /** Adds a checkbox component. */
+    checkbox(label: string, key: string, options?: CheckboxOptions): this;
+    /** Adds a checklist component. */
+    checklist(label: string, key: string, values: FormValueOption[], options?: ChecklistOptions): this;
+    /** Adds a group component with nested children built via a callback. */
+    group(label: string, builder: (group: GroupBuilder) => void, options?: GroupOptions): this;
+    /** Builds the final FormDefinition. */
+    build(): FormDefinition;
+}
+/** Sub-builder for group components. Supports the same component methods as FormBuilder. */
+export declare class GroupBuilder {
+    /** @internal */
+    readonly _id: string;
+    /** @internal */
+    readonly _components: FormComponent[];
+    constructor(id?: string);
+    text(text: string, options?: {
+        id?: string;
+        label?: string;
+        layout?: FormLayout;
+    }): this;
+    textfield(label: string, key: string, options?: TextFieldOptions): this;
+    textarea(label: string, key: string, options?: TextFieldOptions): this;
+    select(label: string, key: string, options?: SelectOptions): this;
+    radio(label: string, key: string, values: FormValueOption[], options?: RadioOptions): this;
+    checkbox(label: string, key: string, options?: CheckboxOptions): this;
+    checklist(label: string, key: string, values: FormValueOption[], options?: ChecklistOptions): this;
+    group(label: string, builder: (group: GroupBuilder) => void, options?: GroupOptions): this;
+}
+/** Options for textfield/textarea components. */
+export interface TextFieldOptions {
+    id?: string;
+    validate?: FormValidation;
+    defaultValue?: string;
+    layout?: FormLayout;
+}
+/** Options for select components. */
+export interface SelectOptions {
+    id?: string;
+    values?: FormValueOption[];
+    valuesKey?: string;
+    validate?: FormValidation;
+    searchable?: boolean;
+    defaultValue?: string;
+    layout?: FormLayout;
+}
+/** Options for radio components. */
+export interface RadioOptions {
+    id?: string;
+    validate?: FormValidation;
+    defaultValue?: string;
+    layout?: FormLayout;
+}
+/** Options for checkbox components. */
+export interface CheckboxOptions {
+    id?: string;
+    validate?: FormValidation;
+    defaultValue?: boolean;
+    layout?: FormLayout;
+}
+/** Options for checklist components. */
+export interface ChecklistOptions {
+    id?: string;
+    validate?: FormValidation;
+    layout?: FormLayout;
+}
+/** Options for group components. */
+export interface GroupOptions {
+    id?: string;
+    showOutline?: boolean;
+    layout?: FormLayout;
+}
+//# sourceMappingURL=form-builder.d.ts.map

package/dist/form/form-builder.js

@@ -0,0 +1,347 @@
+import { generateId } from "../types/id-generator.js";
+/** Builder for constructing Camunda Forms programmatically. */
+export class FormBuilder {
+    _id;
+    _type = "default";
+    _executionPlatform = "Camunda Cloud";
+    _executionPlatformVersion = "8.7.0";
+    _exporter;
+    _schemaVersion;
+    _generated;
+    _components = [];
+    constructor(id) {
+        this._id = id ?? generateId("Form");
+    }
+    /** Sets the form ID. */
+    id(id) {
+        this._id = id;
+        return this;
+    }
+    /** Sets the execution platform. */
+    executionPlatform(platform) {
+        this._executionPlatform = platform;
+        return this;
+    }
+    /** Sets the execution platform version. */
+    executionPlatformVersion(version) {
+        this._executionPlatformVersion = version;
+        return this;
+    }
+    /** Sets the exporter metadata. */
+    exporter(name, version) {
+        this._exporter = { name, version };
+        return this;
+    }
+    /** Sets the schema version. */
+    schemaVersion(version) {
+        this._schemaVersion = version;
+        return this;
+    }
+    /** Marks this form as generated. */
+    generated(value) {
+        this._generated = value;
+        return this;
+    }
+    /** Adds a static text component. */
+    text(text, options) {
+        const component = {
+            type: "text",
+            id: options?.id ?? generateId("Field"),
+            text,
+        };
+        if (options?.label !== undefined)
+            component.label = options.label;
+        if (options?.layout !== undefined)
+            component.layout = options.layout;
+        this._components.push(component);
+        return this;
+    }
+    /** Adds a text field component. */
+    textfield(label, key, options) {
+        const component = {
+            type: "textfield",
+            id: options?.id ?? generateId("Field"),
+            label,
+            key,
+        };
+        if (options?.validate !== undefined)
+            component.validate = options.validate;
+        if (options?.defaultValue !== undefined)
+            component.defaultValue = options.defaultValue;
+        if (options?.layout !== undefined)
+            component.layout = options.layout;
+        this._components.push(component);
+        return this;
+    }
+    /** Adds a textarea component. */
+    textarea(label, key, options) {
+        const component = {
+            type: "textarea",
+            id: options?.id ?? generateId("Field"),
+            label,
+            key,
+        };
+        if (options?.validate !== undefined)
+            component.validate = options.validate;
+        if (options?.defaultValue !== undefined)
+            component.defaultValue = options.defaultValue;
+        if (options?.layout !== undefined)
+            component.layout = options.layout;
+        this._components.push(component);
+        return this;
+    }
+    /** Adds a select dropdown component. */
+    select(label, key, options) {
+        const component = {
+            type: "select",
+            id: options?.id ?? generateId("Field"),
+            label,
+            key,
+        };
+        if (options?.values !== undefined)
+            component.values = options.values;
+        if (options?.valuesKey !== undefined)
+            component.valuesKey = options.valuesKey;
+        if (options?.validate !== undefined)
+            component.validate = options.validate;
+        if (options?.searchable !== undefined)
+            component.searchable = options.searchable;
+        if (options?.defaultValue !== undefined)
+            component.defaultValue = options.defaultValue;
+        if (options?.layout !== undefined)
+            component.layout = options.layout;
+        this._components.push(component);
+        return this;
+    }
+    /** Adds a radio button group component. */
+    radio(label, key, values, options) {
+        const component = {
+            type: "radio",
+            id: options?.id ?? generateId("Field"),
+            label,
+            key,
+            values,
+        };
+        if (options?.validate !== undefined)
+            component.validate = options.validate;
+        if (options?.defaultValue !== undefined)
+            component.defaultValue = options.defaultValue;
+        if (options?.layout !== undefined)
+            component.layout = options.layout;
+        this._components.push(component);
+        return this;
+    }
+    /** Adds a checkbox component. */
+    checkbox(label, key, options) {
+        const component = {
+            type: "checkbox",
+            id: options?.id ?? generateId("Field"),
+            label,
+            key,
+        };
+        if (options?.validate !== undefined)
+            component.validate = options.validate;
+        if (options?.defaultValue !== undefined)
+            component.defaultValue = options.defaultValue;
+        if (options?.layout !== undefined)
+            component.layout = options.layout;
+        this._components.push(component);
+        return this;
+    }
+    /** Adds a checklist component. */
+    checklist(label, key, values, options) {
+        const component = {
+            type: "checklist",
+            id: options?.id ?? generateId("Field"),
+            label,
+            key,
+            values,
+        };
+        if (options?.validate !== undefined)
+            component.validate = options.validate;
+        if (options?.layout !== undefined)
+            component.layout = options.layout;
+        this._components.push(component);
+        return this;
+    }
+    /** Adds a group component with nested children built via a callback. */
+    group(label, builder, options) {
+        const groupBuilder = new GroupBuilder(options?.id);
+        builder(groupBuilder);
+        const component = {
+            type: "group",
+            id: groupBuilder._id,
+            label,
+            components: groupBuilder._components,
+        };
+        if (options?.showOutline !== undefined)
+            component.showOutline = options.showOutline;
+        if (options?.layout !== undefined)
+            component.layout = options.layout;
+        this._components.push(component);
+        return this;
+    }
+    /** Builds the final FormDefinition. */
+    build() {
+        const definition = {
+            id: this._id,
+            type: this._type,
+            components: this._components,
+        };
+        if (this._executionPlatform !== undefined) {
+            definition.executionPlatform = this._executionPlatform;
+        }
+        if (this._executionPlatformVersion !== undefined) {
+            definition.executionPlatformVersion = this._executionPlatformVersion;
+        }
+        if (this._exporter !== undefined)
+            definition.exporter = this._exporter;
+        if (this._schemaVersion !== undefined)
+            definition.schemaVersion = this._schemaVersion;
+        if (this._generated !== undefined)
+            definition.generated = this._generated;
+        return definition;
+    }
+}
+/** Sub-builder for group components. Supports the same component methods as FormBuilder. */
+export class GroupBuilder {
+    /** @internal */
+    _id;
+    /** @internal */
+    _components = [];
+    constructor(id) {
+        this._id = id ?? generateId("Field");
+    }
+    text(text, options) {
+        const component = {
+            type: "text",
+            id: options?.id ?? generateId("Field"),
+            text,
+        };
+        if (options?.label !== undefined)
+            component.label = options.label;
+        if (options?.layout !== undefined)
+            component.layout = options.layout;
+        this._components.push(component);
+        return this;
+    }
+    textfield(label, key, options) {
+        const component = {
+            type: "textfield",
+            id: options?.id ?? generateId("Field"),
+            label,
+            key,
+        };
+        if (options?.validate !== undefined)
+            component.validate = options.validate;
+        if (options?.defaultValue !== undefined)
+            component.defaultValue = options.defaultValue;
+        if (options?.layout !== undefined)
+            component.layout = options.layout;
+        this._components.push(component);
+        return this;
+    }
+    textarea(label, key, options) {
+        const component = {
+            type: "textarea",
+            id: options?.id ?? generateId("Field"),
+            label,
+            key,
+        };
+        if (options?.validate !== undefined)
+            component.validate = options.validate;
+        if (options?.defaultValue !== undefined)
+            component.defaultValue = options.defaultValue;
+        if (options?.layout !== undefined)
+            component.layout = options.layout;
+        this._components.push(component);
+        return this;
+    }
+    select(label, key, options) {
+        const component = {
+            type: "select",
+            id: options?.id ?? generateId("Field"),
+            label,
+            key,
+        };
+        if (options?.values !== undefined)
+            component.values = options.values;
+        if (options?.valuesKey !== undefined)
+            component.valuesKey = options.valuesKey;
+        if (options?.validate !== undefined)
+            component.validate = options.validate;
+        if (options?.searchable !== undefined)
+            component.searchable = options.searchable;
+        if (options?.defaultValue !== undefined)
+            component.defaultValue = options.defaultValue;
+        if (options?.layout !== undefined)
+            component.layout = options.layout;
+        this._components.push(component);
+        return this;
+    }
+    radio(label, key, values, options) {
+        const component = {
+            type: "radio",
+            id: options?.id ?? generateId("Field"),
+            label,
+            key,
+            values,
+        };
+        if (options?.validate !== undefined)
+            component.validate = options.validate;
+        if (options?.defaultValue !== undefined)
+            component.defaultValue = options.defaultValue;
+        if (options?.layout !== undefined)
+            component.layout = options.layout;
+        this._components.push(component);
+        return this;
+    }
+    checkbox(label, key, options) {
+        const component = {
+            type: "checkbox",
+            id: options?.id ?? generateId("Field"),
+            label,
+            key,
+        };
+        if (options?.validate !== undefined)
+            component.validate = options.validate;
+        if (options?.defaultValue !== undefined)
+            component.defaultValue = options.defaultValue;
+        if (options?.layout !== undefined)
+            component.layout = options.layout;
+        this._components.push(component);
+        return this;
+    }
+    checklist(label, key, values, options) {
+        const component = {
+            type: "checklist",
+            id: options?.id ?? generateId("Field"),
+            label,
+            key,
+            values,
+        };
+        if (options?.validate !== undefined)
+            component.validate = options.validate;
+        if (options?.layout !== undefined)
+            component.layout = options.layout;
+        this._components.push(component);
+        return this;
+    }
+    group(label, builder, options) {
+        const groupBuilder = new GroupBuilder(options?.id);
+        builder(groupBuilder);
+        const component = {
+            type: "group",
+            id: groupBuilder._id,
+            label,
+            components: groupBuilder._components,
+        };
+        if (options?.showOutline !== undefined)
+            component.showOutline = options.showOutline;
+        if (options?.layout !== undefined)
+            component.layout = options.layout;
+        this._components.push(component);
+        return this;
+    }
+}
+//# sourceMappingURL=form-builder.js.map

package/dist/form/form-model.d.ts

@@ -0,0 +1,221 @@
+/** Layout positioning for a form component. */
+export interface FormLayout {
+    row?: string;
+    columns?: number | null;
+}
+/** Validation constraints for a form field. */
+export interface FormValidation {
+    required?: boolean;
+    minLength?: number;
+    maxLength?: number;
+}
+/** A label/value option used by select, radio, and checklist components. */
+export interface FormValueOption {
+    label: string;
+    value: string;
+}
+/** Base properties shared by all form components. */
+interface FormComponentBase {
+    id: string;
+    type: string;
+    layout?: FormLayout;
+}
+/** Static text/markdown display component. */
+export interface FormTextComponent extends FormComponentBase {
+    type: "text";
+    text: string;
+    label?: string;
+}
+/** Single-line text input. */
+export interface FormTextFieldComponent extends FormComponentBase {
+    type: "textfield";
+    label: string;
+    key: string;
+    validate?: FormValidation;
+    defaultValue?: string;
+}
+/** Multi-line text input. */
+export interface FormTextAreaComponent extends FormComponentBase {
+    type: "textarea";
+    label: string;
+    key: string;
+    validate?: FormValidation;
+    defaultValue?: string;
+}
+/** Dropdown select input. */
+export interface FormSelectComponent extends FormComponentBase {
+    type: "select";
+    label: string;
+    key: string;
+    values?: FormValueOption[];
+    valuesKey?: string;
+    validate?: FormValidation;
+    searchable?: boolean;
+    defaultValue?: string;
+}
+/** Radio button group. */
+export interface FormRadioComponent extends FormComponentBase {
+    type: "radio";
+    label: string;
+    key: string;
+    values?: FormValueOption[];
+    valuesExpression?: string;
+    validate?: FormValidation;
+    defaultValue?: string;
+}
+/** Single checkbox. */
+export interface FormCheckboxComponent extends FormComponentBase {
+    type: "checkbox";
+    label: string;
+    key: string;
+    validate?: FormValidation;
+    defaultValue?: boolean;
+}
+/** Multi-select checklist. */
+export interface FormChecklistComponent extends FormComponentBase {
+    type: "checklist";
+    label: string;
+    key: string;
+    values?: FormValueOption[];
+    valuesExpression?: string;
+    validate?: FormValidation;
+}
+/** Container that groups nested components. */
+export interface FormGroupComponent extends FormComponentBase {
+    type: "group";
+    label: string;
+    components: FormComponent[];
+    showOutline?: boolean;
+}
+/** Numeric input field. */
+export interface FormNumberComponent extends FormComponentBase {
+    type: "number";
+    label: string;
+    key: string;
+    validate?: FormValidation;
+    defaultValue?: number;
+}
+/** Date and/or time picker. */
+export interface FormDatetimeComponent extends FormComponentBase {
+    type: "datetime";
+    key: string;
+    /** Subtype: "date", "time", or "datetime". */
+    subtype?: string;
+    dateLabel?: string;
+    timeLabel?: string;
+    validate?: FormValidation;
+}
+/** Submit or action button. */
+export interface FormButtonComponent extends FormComponentBase {
+    type: "button";
+    label: string;
+    /** Button action: "submit" or "reset". */
+    action?: string;
+}
+/** Multi-value tag list input. */
+export interface FormTaglistComponent extends FormComponentBase {
+    type: "taglist";
+    label: string;
+    key: string;
+    values?: FormValueOption[];
+    valuesKey?: string;
+    validate?: FormValidation;
+}
+/** Read-only data table. */
+export interface FormTableComponent extends FormComponentBase {
+    type: "table";
+    label?: string;
+    dataSource?: string;
+    rowCount?: number;
+    columns?: Array<{
+        label: string;
+        key: string;
+    }>;
+}
+/** Image display component. */
+export interface FormImageComponent extends FormComponentBase {
+    type: "image";
+    /** URL or FEEL expression for the image source. */
+    source?: string;
+    alt?: string;
+}
+/** Repeating list of sub-components. */
+export interface FormDynamicListComponent extends FormComponentBase {
+    type: "dynamiclist";
+    label?: string;
+    path?: string;
+    components: FormComponent[];
+    isRepeating?: boolean;
+    allowAddRemove?: boolean;
+    defaultRepetitions?: number;
+    showOutline?: boolean;
+}
+/** Embedded iframe component. */
+export interface FormIframeComponent extends FormComponentBase {
+    type: "iframe";
+    label?: string;
+    url?: string;
+    height?: number;
+    security?: {
+        allowScripts?: boolean;
+    };
+}
+/** Visual separator line. */
+export interface FormSeparatorComponent extends FormComponentBase {
+    type: "separator";
+}
+/** Blank spacer. */
+export interface FormSpacerComponent extends FormComponentBase {
+    type: "spacer";
+    height?: number;
+}
+/** Document preview component. */
+export interface FormDocumentPreviewComponent extends FormComponentBase {
+    type: "documentPreview";
+    label?: string;
+}
+/** Raw HTML content component. */
+export interface FormHtmlComponent extends FormComponentBase {
+    type: "html";
+    content?: string;
+}
+/** FEEL expression component. */
+export interface FormExpressionComponent extends FormComponentBase {
+    type: "expression";
+    key?: string;
+    expression?: string;
+    /** When to evaluate: "change" or "submit". */
+    computeOn?: string;
+}
+/** File upload picker component. */
+export interface FormFilepickerComponent extends FormComponentBase {
+    type: "filepicker";
+    label?: string;
+    key?: string;
+    multiple?: boolean;
+}
+/** Passthrough for unknown/future component types — preserves roundtrip fidelity. */
+export interface FormUnknownComponent extends FormComponentBase {
+    type: string;
+    [key: string]: unknown;
+}
+/** Discriminated union of all form component types. */
+export type FormComponent = FormTextComponent | FormTextFieldComponent | FormTextAreaComponent | FormSelectComponent | FormRadioComponent | FormCheckboxComponent | FormChecklistComponent | FormGroupComponent | FormNumberComponent | FormDatetimeComponent | FormButtonComponent | FormTaglistComponent | FormTableComponent | FormImageComponent | FormDynamicListComponent | FormIframeComponent | FormSeparatorComponent | FormSpacerComponent | FormDocumentPreviewComponent | FormHtmlComponent | FormExpressionComponent | FormFilepickerComponent | FormUnknownComponent;
+/** Exporter metadata. */
+export interface FormExporter {
+    name: string;
+    version: string;
+}
+/** Root form definition model. */
+export interface FormDefinition {
+    id: string;
+    type: string;
+    executionPlatform?: string;
+    executionPlatformVersion?: string;
+    exporter?: FormExporter;
+    schemaVersion?: number;
+    components: FormComponent[];
+    generated?: boolean;
+}
+export {};
+//# sourceMappingURL=form-model.d.ts.map

package/dist/form/form-model.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=form-model.js.map

package/dist/form/form-parser.d.ts

@@ -0,0 +1,4 @@
+import type { FormDefinition } from "./form-model.js";
+/** Parses a Camunda Form JSON string into a typed FormDefinition. */
+export declare function parseForm(json: string): FormDefinition;
+//# sourceMappingURL=form-parser.d.ts.map