@automagik/omni 2.260731.3 → 2.260803.2

package/dist/sdk/index.js

@@ -2290,12 +2290,216 @@ function createOmniClient(config) {
     raw: client
   };
 }
+// src/flow-builder.ts
+class FlowBuilderError extends Error {
+  constructor(message) {
+    super(message);
+    this.name = "FlowBuilderError";
+  }
+}
+
+class FormBuilder {
+  components = [];
+  footerSet = false;
+  textInput(name, label, opts = {}) {
+    const { inputType, ...rest } = opts;
+    this.components.push({ type: "TextInput", name, label, "input-type": inputType ?? "text", ...rest });
+    return this;
+  }
+  textArea(name, label, opts = {}) {
+    this.components.push({ type: "TextArea", name, label, ...opts });
+    return this;
+  }
+  datePicker(name, label, opts = {}) {
+    this.components.push({ type: "DatePicker", name, label, ...opts });
+    return this;
+  }
+  optIn(name, label, opts = {}) {
+    this.components.push({ type: "OptIn", name, label, ...opts });
+    return this;
+  }
+  dropdown(name, label, dataSource, opts = {}) {
+    this.components.push({ type: "Dropdown", name, label, "data-source": dataSource, ...opts });
+    return this;
+  }
+  radioButtons(name, label, dataSource, opts = {}) {
+    this.components.push({ type: "RadioButtonsGroup", name, label, "data-source": dataSource, ...opts });
+    return this;
+  }
+  checkboxGroup(name, label, dataSource, opts = {}) {
+    this.components.push({ type: "CheckboxGroup", name, label, "data-source": dataSource, ...opts });
+    return this;
+  }
+  footerComplete(label, payload) {
+    this.footer(label, { name: "complete", payload });
+    return this;
+  }
+  footerDataExchange(label, payload = {}) {
+    this.footer(label, { name: "data_exchange", payload });
+    return this;
+  }
+  footerNavigate(label, nextScreen, payload = {}) {
+    this.footer(label, { name: "navigate", next: { type: "screen", name: nextScreen }, payload });
+    return this;
+  }
+  raw(component) {
+    this.components.push(component);
+    return this;
+  }
+  footer(label, action) {
+    if (this.footerSet)
+      throw new FlowBuilderError("a Form can only have one Footer");
+    this.footerSet = true;
+    this.components.push({ type: "Footer", label, "on-click-action": action });
+  }
+}
+
+class ScreenBuilder {
+  id;
+  components = [];
+  constructor(id) {
+    this.id = id;
+  }
+  heading(text) {
+    this.components.push({ type: "TextHeading", text });
+    return this;
+  }
+  subheading(text) {
+    this.components.push({ type: "TextSubheading", text });
+    return this;
+  }
+  body(text) {
+    this.components.push({ type: "TextBody", text });
+    return this;
+  }
+  caption(text) {
+    this.components.push({ type: "TextCaption", text });
+    return this;
+  }
+  richText(text) {
+    this.components.push({ type: "RichText", text });
+    return this;
+  }
+  image(src, opts = {}) {
+    this.components.push({
+      type: "Image",
+      src,
+      ...opts.height !== undefined ? { height: opts.height } : {},
+      ...opts.scaleType ? { "scale-type": opts.scaleType } : {},
+      ...opts.altText ? { "alt-text": opts.altText } : {}
+    });
+    return this;
+  }
+  form(name, define) {
+    const builder = new FormBuilder;
+    define(builder);
+    this.components.push({ type: "Form", name, children: builder.components });
+    return this;
+  }
+  footerNavigate(label, nextScreen, payload = {}) {
+    this.components.push({
+      type: "Footer",
+      label,
+      "on-click-action": { name: "navigate", next: { type: "screen", name: nextScreen }, payload }
+    });
+    return this;
+  }
+  footerComplete(label, payload) {
+    this.components.push({ type: "Footer", label, "on-click-action": { name: "complete", payload } });
+    return this;
+  }
+  footerDataExchange(label, payload = {}) {
+    this.components.push({ type: "Footer", label, "on-click-action": { name: "data_exchange", payload } });
+    return this;
+  }
+  raw(component) {
+    this.components.push(component);
+    return this;
+  }
+}
+
+class FlowBuilder {
+  options;
+  screens = [];
+  constructor(options = {}) {
+    this.options = options;
+  }
+  screen(id, optionsOrDefine, maybeDefine) {
+    const options = typeof optionsOrDefine === "function" ? {} : optionsOrDefine;
+    const define = typeof optionsOrDefine === "function" ? optionsOrDefine : maybeDefine;
+    if (!define)
+      throw new FlowBuilderError(`screen '${id}' needs a definition callback`);
+    if (this.screens.some((s) => s.id === id))
+      throw new FlowBuilderError(`duplicate screen id '${id}'`);
+    const builder = new ScreenBuilder(id);
+    define(builder);
+    this.screens.push({ id, options, components: builder.components });
+    return this;
+  }
+  build() {
+    if (this.screens.length === 0)
+      throw new FlowBuilderError("a flow needs at least one screen");
+    const ids = new Set(this.screens.map((s) => s.id));
+    if (!this.screens.some((s) => s.options.terminal)) {
+      throw new FlowBuilderError("at least one screen must be terminal: true");
+    }
+    const routingModel = {};
+    for (const screen of this.screens) {
+      const hasRichText = screen.components.some((c) => c.type === "RichText");
+      if (hasRichText && screen.components.some((c) => c.type !== "RichText" && c.type !== "Footer")) {
+        throw new FlowBuilderError(`screen '${screen.id}': RichText must be the only component on the screen (Footer excepted)`);
+      }
+      const targets = [];
+      const visit = (component) => {
+        const action = component["on-click-action"];
+        if (action?.name === "navigate") {
+          const next = action.next;
+          if (next?.type === "screen" && next.name) {
+            if (!ids.has(next.name)) {
+              throw new FlowBuilderError(`screen '${screen.id}': navigate targets unknown screen '${next.name}'`);
+            }
+            targets.push(next.name);
+          }
+        }
+        const children = component.children;
+        if (Array.isArray(children))
+          for (const child of children)
+            visit(child);
+      };
+      for (const component of screen.components)
+        visit(component);
+      routingModel[screen.id] = targets;
+    }
+    const json = {
+      version: this.options.version ?? "6.3",
+      ...this.options.dynamic ? { data_api_version: "3.0" } : {},
+      routing_model: routingModel,
+      screens: this.screens.map((screen) => ({
+        id: screen.id,
+        ...screen.options.title ? { title: screen.options.title } : {},
+        ...screen.options.terminal ? { terminal: true } : {},
+        ...screen.options.data ? { data: screen.options.data } : {},
+        ...screen.options.refreshOnBack ? { refresh_on_back: true } : {},
+        layout: { type: "SingleColumnLayout", children: screen.components }
+      }))
+    };
+    return { json, flowJson: JSON.stringify(json) };
+  }
+}
+function flow(options = {}) {
+  return new FlowBuilder(options);
+}
 
 // src/index.ts
 var VERSION = "0.0.1";
 export {
+  flow,
   createOmniClient,
   VERSION,
+  ScreenBuilder,
   OmniConfigError,
-  OmniApiError
+  OmniApiError,
+  FormBuilder,
+  FlowBuilderError,
+  FlowBuilder
 };