@bpmnkit/core 0.0.8

package/dist/form/form-serializer.js

@@ -0,0 +1,240 @@
+/** Serializes a FormDefinition to a JSON string. */
+export function exportForm(form) {
+    const obj = {};
+    if (form.executionPlatform !== undefined) {
+        obj.executionPlatform = form.executionPlatform;
+    }
+    if (form.executionPlatformVersion !== undefined) {
+        obj.executionPlatformVersion = form.executionPlatformVersion;
+    }
+    if (form.exporter !== undefined) {
+        obj.exporter = { name: form.exporter.name, version: form.exporter.version };
+    }
+    if (form.schemaVersion !== undefined) {
+        obj.schemaVersion = form.schemaVersion;
+    }
+    obj.id = form.id;
+    obj.components = form.components.map(serializeComponent);
+    if (form.generated !== undefined) {
+        obj.generated = form.generated;
+    }
+    obj.type = form.type;
+    return JSON.stringify(obj, null, 2);
+}
+function serializeComponent(component) {
+    // Use the type discriminant, casting where TypeScript can't narrow through FormUnknownComponent
+    const type = component.type;
+    switch (type) {
+        case "text":
+            return buildObj(component, ["text", "label", "type", "layout", "id"]);
+        case "textfield":
+        case "textarea":
+            return buildObj(component, [
+                "label",
+                "type",
+                "layout",
+                "id",
+                "key",
+                "validate",
+                "defaultValue",
+            ]);
+        case "select":
+            return buildObj(component, [
+                "label",
+                "values",
+                "valuesKey",
+                "type",
+                "layout",
+                "id",
+                "key",
+                "validate",
+                "searchable",
+                "defaultValue",
+            ]);
+        case "radio":
+            return buildObj(component, [
+                "label",
+                "values",
+                "type",
+                "layout",
+                "id",
+                "key",
+                "validate",
+                "defaultValue",
+            ]);
+        case "checkbox":
+            return buildObj(component, [
+                "label",
+                "type",
+                "id",
+                "defaultValue",
+                "validate",
+                "key",
+                "layout",
+            ]);
+        case "checklist":
+            return buildObj(component, ["label", "values", "type", "layout", "id", "key", "validate"]);
+        case "group":
+            return buildGroupObj(component);
+        case "number":
+            return buildObj(component, [
+                "label",
+                "type",
+                "layout",
+                "id",
+                "key",
+                "validate",
+                "defaultValue",
+            ]);
+        case "datetime":
+            return buildObj(component, [
+                "subtype",
+                "dateLabel",
+                "timeLabel",
+                "type",
+                "layout",
+                "id",
+                "key",
+                "validate",
+            ]);
+        case "button":
+            return buildObj(component, ["label", "action", "type", "layout", "id"]);
+        case "taglist":
+            return buildObj(component, [
+                "label",
+                "values",
+                "valuesKey",
+                "type",
+                "layout",
+                "id",
+                "key",
+                "validate",
+            ]);
+        case "table":
+            return buildTableObj(component);
+        case "image":
+            return buildObj(component, ["source", "alt", "type", "layout", "id"]);
+        case "dynamiclist":
+            return buildDynamicListObj(component);
+        case "iframe":
+            return buildIframeObj(component);
+        case "separator":
+            return buildObj(component, ["type", "layout", "id"]);
+        case "spacer":
+            return buildObj(component, ["height", "type", "layout", "id"]);
+        case "documentPreview":
+            return buildObj(component, ["label", "type", "layout", "id"]);
+        case "html":
+            return buildObj(component, ["content", "type", "layout", "id"]);
+        case "expression":
+            return buildObj(component, ["computeOn", "type", "layout", "id", "key", "expression"]);
+        case "filepicker":
+            return buildObj(component, ["label", "type", "layout", "id", "key", "multiple"]);
+        default:
+            return buildUnknownObj(component);
+    }
+}
+function buildObj(component, keys) {
+    const src = component;
+    const out = {};
+    for (const key of keys) {
+        const value = src[key];
+        if (value === undefined)
+            continue;
+        if (key === "layout") {
+            out.layout = serializeLayout(value);
+        }
+        else if (key === "validate") {
+            out.validate = { ...value };
+        }
+        else if (key === "values") {
+            out.values = value.map((v) => ({
+                label: v.label,
+                value: v.value,
+            }));
+        }
+        else {
+            out[key] = value;
+        }
+    }
+    return out;
+}
+function buildGroupObj(component) {
+    const out = {};
+    out.label = component.label;
+    out.components = component.components.map(serializeComponent);
+    if (component.showOutline !== undefined)
+        out.showOutline = component.showOutline;
+    out.type = "group";
+    if (component.layout !== undefined)
+        out.layout = serializeLayout(component.layout);
+    out.id = component.id;
+    return out;
+}
+function serializeLayout(layout) {
+    const out = {};
+    if (layout.row !== undefined)
+        out.row = layout.row;
+    if (layout.columns !== undefined) {
+        out.columns = layout.columns;
+    }
+    else {
+        out.columns = null;
+    }
+    return out;
+}
+function buildTableObj(component) {
+    const out = { type: "table", id: component.id };
+    if (component.label !== undefined)
+        out.label = component.label;
+    if (component.dataSource !== undefined)
+        out.dataSource = component.dataSource;
+    if (component.rowCount !== undefined)
+        out.rowCount = component.rowCount;
+    if (component.columns !== undefined && component.columns !== null) {
+        out.columns = component.columns.map((c) => ({ label: c.label, key: c.key }));
+    }
+    if (component.layout !== undefined)
+        out.layout = serializeLayout(component.layout);
+    return out;
+}
+function buildDynamicListObj(component) {
+    const out = { type: "dynamiclist", id: component.id };
+    if (component.label !== undefined)
+        out.label = component.label;
+    out.components = component.components.map(serializeComponent);
+    if (component.path !== undefined)
+        out.path = component.path;
+    if (component.isRepeating !== undefined)
+        out.isRepeating = component.isRepeating;
+    if (component.allowAddRemove !== undefined)
+        out.allowAddRemove = component.allowAddRemove;
+    if (component.defaultRepetitions !== undefined)
+        out.defaultRepetitions = component.defaultRepetitions;
+    if (component.showOutline !== undefined)
+        out.showOutline = component.showOutline;
+    if (component.layout !== undefined)
+        out.layout = serializeLayout(component.layout);
+    return out;
+}
+function buildIframeObj(component) {
+    const out = { type: "iframe", id: component.id };
+    if (component.label !== undefined)
+        out.label = component.label;
+    if (component.url !== undefined)
+        out.url = component.url;
+    if (component.height !== undefined)
+        out.height = component.height;
+    if (component.security !== undefined)
+        out.security = { ...component.security };
+    if (component.layout !== undefined)
+        out.layout = serializeLayout(component.layout);
+    return out;
+}
+function buildUnknownObj(component) {
+    const out = { ...component };
+    if (component.layout !== undefined)
+        out.layout = serializeLayout(component.layout);
+    return out;
+}
+//# sourceMappingURL=form-serializer.js.map

package/dist/form/index.d.ts

@@ -0,0 +1,27 @@
+export type { FormComponent, FormButtonComponent, FormCheckboxComponent, FormChecklistComponent, FormDatetimeComponent, FormDefinition, FormDocumentPreviewComponent, FormDynamicListComponent, FormExporter, FormExpressionComponent, FormFilepickerComponent, FormGroupComponent, FormHtmlComponent, FormIframeComponent, FormImageComponent, FormLayout, FormNumberComponent, FormRadioComponent, FormSelectComponent, FormSeparatorComponent, FormSpacerComponent, FormTableComponent, FormTaglistComponent, FormTextAreaComponent, FormTextComponent, FormTextFieldComponent, FormUnknownComponent, FormValidation, FormValueOption, } from "./form-model.js";
+export { parseForm } from "./form-parser.js";
+export { exportForm } from "./form-serializer.js";
+export { FormBuilder, GroupBuilder } from "./form-builder.js";
+export type { TextFieldOptions, SelectOptions, RadioOptions, CheckboxOptions, ChecklistOptions, GroupOptions, } from "./form-builder.js";
+export { compactifyForm, expandForm } from "./compact.js";
+export type { CompactForm, CompactFormField } from "./compact.js";
+import { compactifyForm } from "./compact.js";
+import type { CompactForm } from "./compact.js";
+import { FormBuilder } from "./form-builder.js";
+import type { FormDefinition } from "./form-model.js";
+/** Top-level Form namespace providing create, parse, and export entry points. */
+export declare const Form: {
+    /** Creates a new form using a fluent builder. */
+    readonly create: (id?: string) => FormBuilder;
+    /** Returns a minimal empty FormDefinition. Useful for "New Form" actions. */
+    readonly makeEmpty: (id?: string) => FormDefinition;
+    /** Parses a JSON string into a FormDefinition. */
+    readonly parse: (json: string) => FormDefinition;
+    /** Exports a FormDefinition to a JSON string. */
+    readonly export: (form: FormDefinition) => string;
+    /** Convert a FormDefinition to a token-efficient compact representation. */
+    readonly compactify: (form: FormDefinition) => ReturnType<typeof compactifyForm>;
+    /** Convert a compact form representation back to a FormDefinition. */
+    readonly expand: (compact: CompactForm) => FormDefinition;
+};
+//# sourceMappingURL=index.d.ts.map

package/dist/form/index.js

@@ -0,0 +1,43 @@
+export { parseForm } from "./form-parser.js";
+export { exportForm } from "./form-serializer.js";
+export { FormBuilder, GroupBuilder } from "./form-builder.js";
+export { compactifyForm, expandForm } from "./compact.js";
+import { generateId } from "../types/id-generator.js";
+import { compactifyForm, expandForm } from "./compact.js";
+import { FormBuilder } from "./form-builder.js";
+import { parseForm } from "./form-parser.js";
+import { exportForm } from "./form-serializer.js";
+/** Top-level Form namespace providing create, parse, and export entry points. */
+export const Form = {
+    /** Creates a new form using a fluent builder. */
+    create(id) {
+        return new FormBuilder(id);
+    },
+    /** Returns a minimal empty FormDefinition. Useful for "New Form" actions. */
+    makeEmpty(id) {
+        const formId = id ?? generateId("Form");
+        return {
+            id: formId,
+            type: "default",
+            schemaVersion: 16,
+            components: [{ type: "button", id: generateId("submit"), label: "Submit" }],
+        };
+    },
+    /** Parses a JSON string into a FormDefinition. */
+    parse(json) {
+        return parseForm(json);
+    },
+    /** Exports a FormDefinition to a JSON string. */
+    export(form) {
+        return exportForm(form);
+    },
+    /** Convert a FormDefinition to a token-efficient compact representation. */
+    compactify(form) {
+        return compactifyForm(form);
+    },
+    /** Convert a compact form representation back to a FormDefinition. */
+    expand(compact) {
+        return expandForm(compact);
+    },
+};
+//# sourceMappingURL=index.js.map

package/dist/index.d.ts

@@ -0,0 +1,37 @@
+export { BpmnSdkError, ParseError, ValidationError } from "./errors.js";
+export type { ErrorCode } from "./errors.js";
+export { isBpmnActivity, isBpmnAdHocSubProcess, isBpmnBoundaryEvent, isBpmnBusinessRuleTask, isBpmnCallActivity, isBpmnComplexGateway, isBpmnEndEvent, isBpmnEvent, isBpmnEventBasedGateway, isBpmnEventSubProcess, isBpmnExclusiveGateway, isBpmnGateway, isBpmnInclusiveGateway, isBpmnIntermediateCatchEvent, isBpmnIntermediateThrowEvent, isBpmnManualTask, isBpmnParallelGateway, isBpmnReceiveTask, isBpmnScriptTask, isBpmnSendTask, isBpmnServiceTask, isBpmnStartEvent, isBpmnSubProcess, isBpmnTask, isBpmnTransaction, isBpmnUserTask, } from "./bpmn/type-guards.js";
+export { findElement, findElementInProcess, findProcess, findSequenceFlow, getAllElements, getElementType, getZeebeExtensions, } from "./bpmn/utils.js";
+export { Bpmn, SAMPLE_BPMN_XML } from "./bpmn/index.js";
+export { applyAutoLayout } from "./bpmn/auto-layout.js";
+export type { ProcessBuilder, BranchBuilder, SubProcessContentBuilder, ServiceTaskOptions, ScriptTaskOptions, UserTaskOptions, CallActivityOptions, BusinessRuleTaskOptions, ElementOptions, GatewayOptions, MultiInstanceOptions, SubProcessOptions, StartEventOptions, IntermediateCatchEventOptions, IntermediateThrowEventOptions, BoundaryEventOptions, AdHocSubProcessOptions, } from "./bpmn/bpmn-builder.js";
+export type { BpmnDefinitions, BpmnProcess, BpmnFlowNode, BpmnFlowElement, BpmnSequenceFlow, BpmnBoundaryEvent, BpmnElementType, BpmnStartEvent, BpmnEndEvent, BpmnIntermediateCatchEvent, BpmnIntermediateThrowEvent, BpmnTask, BpmnServiceTask, BpmnScriptTask, BpmnUserTask, BpmnSendTask, BpmnReceiveTask, BpmnBusinessRuleTask, BpmnManualTask, BpmnCallActivity, BpmnSubProcess, BpmnAdHocSubProcess, BpmnEventSubProcess, BpmnTransaction, BpmnExclusiveGateway, BpmnParallelGateway, BpmnInclusiveGateway, BpmnEventBasedGateway, BpmnComplexGateway, BpmnCollaboration, BpmnParticipant, BpmnMessageFlow, BpmnLane, BpmnLaneSet, BpmnError, BpmnEscalation, BpmnMessage, BpmnTextAnnotation, BpmnAssociation, BpmnConditionExpression, BpmnEventDefinition, BpmnTimerEventDefinition, BpmnErrorEventDefinition, BpmnEscalationEventDefinition, BpmnMessageEventDefinition, BpmnSignalEventDefinition, BpmnConditionalEventDefinition, BpmnLinkEventDefinition, BpmnCancelEventDefinition, BpmnTerminateEventDefinition, BpmnCompensateEventDefinition, BpmnMultiInstanceLoopCharacteristics, BpmnDiagram, BpmnDiPlane, BpmnDiShape, BpmnDiEdge, BpmnDiLabel, BpmnBounds, BpmnWaypoint, } from "./bpmn/bpmn-model.js";
+export type { RestConnectorConfig, RestAuthentication, HttpMethod, } from "./bpmn/rest-connector.js";
+export type { ZeebeExtensions, ZeebeTaskDefinition, ZeebeIoMapping, ZeebeIoMappingEntry, ZeebeTaskHeaders, ZeebeTaskHeaderEntry, ZeebeProperties, ZeebePropertyEntry, ZeebeFormDefinition, ZeebeCalledDecision, } from "./bpmn/zeebe-extensions.js";
+export { zeebeExtensionsToXmlElements } from "./bpmn/zeebe-extensions.js";
+export { Dmn, layoutDmn, benchmarkDmnLayout, compactifyDmn, expandDmn } from "./dmn/index.js";
+export type { DmnBenchmarkResult, DmnElementPosition, CompactDmn, CompactDmnDecision, CompactDmnInput, CompactDmnOutput, CompactDmnRule, } from "./dmn/index.js";
+export { Form, compactifyForm, expandForm } from "./form/index.js";
+export type { CompactForm, CompactFormField } from "./form/index.js";
+export { FormBuilder, GroupBuilder } from "./form/form-builder.js";
+export type { TextFieldOptions, SelectOptions, RadioOptions, CheckboxOptions, ChecklistOptions, GroupOptions, } from "./form/form-builder.js";
+export type { FormComponent, FormCheckboxComponent, FormChecklistComponent, FormDefinition, FormExporter, FormGroupComponent, FormLayout, FormRadioComponent, FormSelectComponent, FormTextAreaComponent, FormTextComponent, FormTextFieldComponent, FormValidation, FormValueOption, FormNumberComponent, FormDatetimeComponent, FormButtonComponent, FormTaglistComponent, FormTableComponent, FormImageComponent, FormDynamicListComponent, FormIframeComponent, FormSeparatorComponent, FormSpacerComponent, FormDocumentPreviewComponent, FormHtmlComponent, FormExpressionComponent, FormFilepickerComponent, FormUnknownComponent, } from "./form/form-model.js";
+export type { DecisionTableBuilder, InputOptions, OutputOptions, RuleOptions, } from "./dmn/dmn-builder.js";
+export type { DmnDefinitions, DmnDecision, DmnDecisionTable, DmnInput, DmnOutput, DmnRule, DmnInputEntry, DmnOutputEntry, DmnDiagram, DmnDiagramShape, DmnDiagramEdge, DmnWaypoint, DmnTypeRef, DmnAggregation, HitPolicy, DmnInformationRequirement, DmnKnowledgeRequirement, DmnAuthorityRequirement, DmnInputData, DmnKnowledgeSource, DmnBusinessKnowledgeModel, DmnTextAnnotation, DmnAssociation, } from "./dmn/dmn-model.js";
+export type { XmlElement } from "./types/xml-element.js";
+export { generateId, resetIdCounter } from "./types/id-generator.js";
+export { parseXml, serializeXml } from "./xml/index.js";
+export { readDiColor, writeDiColor, BIOC_NS, COLOR_NS } from "./bpmn/di-color.js";
+export type { DiColor } from "./bpmn/di-color.js";
+export { optimize } from "./bpmn/optimize/index.js";
+export type { OptimizationReport, OptimizationFinding, OptimizationSeverity, OptimizationCategory, ApplyFixResult, OptimizeOptions, } from "./bpmn/optimize/types.js";
+export { layoutProcess, layoutFlowNodes } from "./layout/index.js";
+export { benchmarkLayout, compareLayouts, formatBenchmarkResult, generateAutoLayout, parseReferenceLayout, } from "./layout/index.js";
+export type { BenchmarkResult, BoundingBox, ElementComparison, ElementPosition, FlowOrderViolation, } from "./layout/index.js";
+export type { Bounds, LayoutEdge, LayoutNode, LayoutResult, Waypoint } from "./layout/index.js";
+export { ELEMENT_SIZES } from "./layout/index.js";
+export { compactify, expand } from "./bpmn/compact.js";
+export { exportSvg } from "./bpmn/svg.js";
+export type { SvgExportOptions } from "./bpmn/svg.js";
+export type { CompactDiagram, CompactElement, CompactFlow, CompactProcess, } from "./bpmn/compact.js";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -0,0 +1,19 @@
+export { BpmnSdkError, ParseError, ValidationError } from "./errors.js";
+export { isBpmnActivity, isBpmnAdHocSubProcess, isBpmnBoundaryEvent, isBpmnBusinessRuleTask, isBpmnCallActivity, isBpmnComplexGateway, isBpmnEndEvent, isBpmnEvent, isBpmnEventBasedGateway, isBpmnEventSubProcess, isBpmnExclusiveGateway, isBpmnGateway, isBpmnInclusiveGateway, isBpmnIntermediateCatchEvent, isBpmnIntermediateThrowEvent, isBpmnManualTask, isBpmnParallelGateway, isBpmnReceiveTask, isBpmnScriptTask, isBpmnSendTask, isBpmnServiceTask, isBpmnStartEvent, isBpmnSubProcess, isBpmnTask, isBpmnTransaction, isBpmnUserTask, } from "./bpmn/type-guards.js";
+export { findElement, findElementInProcess, findProcess, findSequenceFlow, getAllElements, getElementType, getZeebeExtensions, } from "./bpmn/utils.js";
+export { Bpmn, SAMPLE_BPMN_XML } from "./bpmn/index.js";
+export { applyAutoLayout } from "./bpmn/auto-layout.js";
+export { zeebeExtensionsToXmlElements } from "./bpmn/zeebe-extensions.js";
+export { Dmn, layoutDmn, benchmarkDmnLayout, compactifyDmn, expandDmn } from "./dmn/index.js";
+export { Form, compactifyForm, expandForm } from "./form/index.js";
+export { FormBuilder, GroupBuilder } from "./form/form-builder.js";
+export { generateId, resetIdCounter } from "./types/id-generator.js";
+export { parseXml, serializeXml } from "./xml/index.js";
+export { readDiColor, writeDiColor, BIOC_NS, COLOR_NS } from "./bpmn/di-color.js";
+export { optimize } from "./bpmn/optimize/index.js";
+export { layoutProcess, layoutFlowNodes } from "./layout/index.js";
+export { benchmarkLayout, compareLayouts, formatBenchmarkResult, generateAutoLayout, parseReferenceLayout, } from "./layout/index.js";
+export { ELEMENT_SIZES } from "./layout/index.js";
+export { compactify, expand } from "./bpmn/compact.js";
+export { exportSvg } from "./bpmn/svg.js";
+//# sourceMappingURL=index.js.map

package/dist/layout/bench.d.ts

@@ -0,0 +1,86 @@
+import type { BpmnDefinitions } from "../bpmn/bpmn-model.js";
+export interface ElementPosition {
+    id: string;
+    type: string;
+    name?: string;
+    cx: number;
+    cy: number;
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
+export interface ElementComparison {
+    id: string;
+    type: string;
+    name?: string;
+    ref: {
+        cx: number;
+        cy: number;
+    };
+    auto: {
+        cx: number;
+        cy: number;
+    };
+    /** Signed displacement: auto − ref. */
+    delta: {
+        dx: number;
+        dy: number;
+    };
+    /** Euclidean distance between centres. */
+    distance: number;
+}
+/** An edge whose auto-layout X order contradicts the flow direction. */
+export interface FlowOrderViolation {
+    sourceId: string;
+    targetId: string;
+    sourceName?: string;
+    targetName?: string;
+    description: string;
+}
+export interface BenchmarkResult {
+    /** Original file name (for reporting). */
+    fileName: string;
+    elementCount: number;
+    flowCount: number;
+    /** Elements present in both reference and auto-layout. */
+    matchedCount: number;
+    elements: ElementComparison[];
+    orderViolations: FlowOrderViolation[];
+    avgDistance: number;
+    maxDistance: number;
+    /** 90th-percentile distance (more robust than max). */
+    p90Distance: number;
+    ref: BoundingBox;
+    auto: BoundingBox;
+    /** auto.width / ref.width  (1.0 = same width). */
+    widthRatio: number;
+    /** auto.height / ref.height  (1.0 = same height). */
+    heightRatio: number;
+}
+export interface BoundingBox {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
+/**
+ * Extracts element positions from the BPMN DI data (the hand-crafted or
+ * tool-generated layout stored in the XML file).
+ */
+export declare function parseReferenceLayout(defs: BpmnDefinitions): ElementPosition[];
+/**
+ * Runs the auto-layout engine on the process and returns element positions.
+ */
+export declare function generateAutoLayout(defs: BpmnDefinitions): ElementPosition[];
+/**
+ * Compares a reference layout (from XML DI) with an auto-generated layout.
+ */
+export declare function compareLayouts(defs: BpmnDefinitions, ref: ElementPosition[], auto: ElementPosition[], fileName?: string): BenchmarkResult;
+/**
+ * Full benchmark pipeline: parse → extract reference layout → auto-layout → compare.
+ */
+export declare function benchmarkLayout(xml: string, fileName?: string): BenchmarkResult;
+/** Format a BenchmarkResult as a human-readable report string. */
+export declare function formatBenchmarkResult(r: BenchmarkResult): string;
+//# sourceMappingURL=bench.d.ts.map