@teamkeel/functions-runtime 0.414.6 → 0.415.0

package/dist/index.d.cts

@@ -353,7 +353,7 @@ type PageOptions<C extends FlowConfig, A extends PageActions[], T extends UIElem
     title?: string;
     description?: string;
     content: T;
-    validate?: (data: ExtractFormData<T>) => Promise<null | string | void> | string | null | void;
+    validate?: ValidateFn<ExtractFormData<T>>;
     actions?: A;
 };
 type UiPage<C extends FlowConfig> = <T extends UIElements, const A extends PageActions[] = []>(name: string, options: PageOptions<C, A, T>) => Promise<A["length"] extends 0 ? ExtractFormData<T> : {
@@ -454,16 +454,17 @@ type ImageConfig = {
     alt?: string;
     fit?: "cover" | "contain";
 };
+
 type ListItem = {
     title?: string;
     description?: string;
     image?: ImageConfig;
 };
-type ListOptions<T> = {
+type ListOptions$1<T> = {
     data: T[];
     render: (data: T) => ListItem;
 };
-type UiElementList = <T extends any>(options: ListOptions<T>) => DisplayElementResponse;
+type UiElementList = <T extends any>(options: ListOptions$1<T>) => DisplayElementResponse;
 interface UiElementListApiResponse extends BaseUiDisplayResponse<"ui.display.list"> {
     data: ListItem[];
 }
@@ -544,11 +545,62 @@ type DataGridColumn = {
     editable: boolean;
 };
 
+type UiElementPrint = DisplayElementWithRequiredConfig<{
+    jobs: PrintData[] | PrintData;
+    title?: string;
+    description?: string;
+    /** If true, the jobs will be automatically printed. */
+    autoPrint?: boolean;
+    /** If true, the flow will continue after the jobs are complete. */
+    autoContinue?: boolean;
+}>;
+type PrintData = {
+    type: "zpl";
+    name?: string;
+    data: string | string[];
+};
+interface UiElementPrintApiResponse extends BaseUiDisplayResponse<"ui.interactive.print"> {
+    title?: string;
+    description?: string;
+    data: {
+        type: "url" | "text" | "html" | "zpl";
+        data?: string[];
+        url?: string;
+    }[];
+    autoPrint: boolean;
+}
+
+type UiElementPickList = <N extends string, T extends Record<string, any>>(name: N, options: ListOptions<T>) => InputElementResponse<N, {
+    items: PickListResponseItem[];
+}>;
+type PickListResponseItem = {
+    id: string;
+    quantity: number;
+    targetQuantity: number;
+};
+type PickListItem = {
+    id: string;
+    targetQuantity: number;
+    title?: string;
+    description?: string;
+    image?: ImageConfig;
+    barcodes?: string[];
+};
+type ListOptions<T> = {
+    data: T[];
+    render: (data: T) => PickListItem;
+    validate?: ValidateFn<PickListResponseItem>;
+};
+interface UiElementPickListApiResponse extends BaseUiMinimalInputResponse<"ui.interactive.pickList"> {
+    data: PickListItem[];
+}
+
 interface UI<C extends FlowConfig> {
     page: UiPage<C>;
     display: UiDisplayElements;
     inputs: UiInputsElements;
     select: UiSelectElements;
+    interactive: UiInteractiveElements;
 }
 type UiInputsElements = {
     text: UiElementInputText;
@@ -572,8 +624,13 @@ type UiDisplayElements = {
     table: UiElementTable;
     keyValue: UiElementKeyValue;
 };
+type UiInteractiveElements = {
+    print: UiElementPrint;
+    pickList: UiElementPickList;
+};
 type InputElement<TValueType, TConfig extends any = never> = <N extends string>(name: N, options?: BaseInputConfig<TValueType> & TConfig) => InputElementResponse<N, TValueType>;
 type DisplayElement<TConfig extends any = never> = (options?: TConfig) => DisplayElementResponse;
+type DisplayElementWithRequiredConfig<TConfig extends any = never> = (options: TConfig) => DisplayElementResponse;
 type UIElements = (InputElementResponse<string, any> | DisplayElementResponse)[];
 interface UIElementBase {
     _type: string;
@@ -592,8 +649,9 @@ interface BaseInputConfig<T> {
     helpText?: string;
     optional?: boolean;
     disabled?: boolean;
-    validate?: (data: T) => Promise<null | string | void> | string | null | void;
+    validate?: ValidateFn<T>;
 }
+type ValidateFn<T> = (data: T) => Promise<boolean | string> | boolean | string;
 interface BaseUiInputResponse<K, TData> {
     __type: K;
     name: string;
@@ -604,6 +662,11 @@ interface BaseUiInputResponse<K, TData> {
     helpText?: string;
     validationError?: string;
 }
+interface BaseUiMinimalInputResponse<K> {
+    __type: K;
+    name: string;
+    validationError?: string;
+}
 interface BaseUiDisplayResponse<K> {
     __type: K;
 }
@@ -630,6 +693,10 @@ type UIApiResponses = {
         one: UiElementSelectOneApiResponse;
         table: UiElementSelectTableApiResponse;
     };
+    interactive: {
+        print: UiElementPrintApiResponse;
+        pickList: UiElementPickListApiResponse;
+    };
 };
 
 declare class NonRetriableError extends Error {

package/dist/index.d.ts

@@ -353,7 +353,7 @@ type PageOptions<C extends FlowConfig, A extends PageActions[], T extends UIElem
     title?: string;
     description?: string;
     content: T;
-    validate?: (data: ExtractFormData<T>) => Promise<null | string | void> | string | null | void;
+    validate?: ValidateFn<ExtractFormData<T>>;
     actions?: A;
 };
 type UiPage<C extends FlowConfig> = <T extends UIElements, const A extends PageActions[] = []>(name: string, options: PageOptions<C, A, T>) => Promise<A["length"] extends 0 ? ExtractFormData<T> : {
@@ -454,16 +454,17 @@ type ImageConfig = {
     alt?: string;
     fit?: "cover" | "contain";
 };
+
 type ListItem = {
     title?: string;
     description?: string;
     image?: ImageConfig;
 };
-type ListOptions<T> = {
+type ListOptions$1<T> = {
     data: T[];
     render: (data: T) => ListItem;
 };
-type UiElementList = <T extends any>(options: ListOptions<T>) => DisplayElementResponse;
+type UiElementList = <T extends any>(options: ListOptions$1<T>) => DisplayElementResponse;
 interface UiElementListApiResponse extends BaseUiDisplayResponse<"ui.display.list"> {
     data: ListItem[];
 }
@@ -544,11 +545,62 @@ type DataGridColumn = {
     editable: boolean;
 };
 
+type UiElementPrint = DisplayElementWithRequiredConfig<{
+    jobs: PrintData[] | PrintData;
+    title?: string;
+    description?: string;
+    /** If true, the jobs will be automatically printed. */
+    autoPrint?: boolean;
+    /** If true, the flow will continue after the jobs are complete. */
+    autoContinue?: boolean;
+}>;
+type PrintData = {
+    type: "zpl";
+    name?: string;
+    data: string | string[];
+};
+interface UiElementPrintApiResponse extends BaseUiDisplayResponse<"ui.interactive.print"> {
+    title?: string;
+    description?: string;
+    data: {
+        type: "url" | "text" | "html" | "zpl";
+        data?: string[];
+        url?: string;
+    }[];
+    autoPrint: boolean;
+}
+
+type UiElementPickList = <N extends string, T extends Record<string, any>>(name: N, options: ListOptions<T>) => InputElementResponse<N, {
+    items: PickListResponseItem[];
+}>;
+type PickListResponseItem = {
+    id: string;
+    quantity: number;
+    targetQuantity: number;
+};
+type PickListItem = {
+    id: string;
+    targetQuantity: number;
+    title?: string;
+    description?: string;
+    image?: ImageConfig;
+    barcodes?: string[];
+};
+type ListOptions<T> = {
+    data: T[];
+    render: (data: T) => PickListItem;
+    validate?: ValidateFn<PickListResponseItem>;
+};
+interface UiElementPickListApiResponse extends BaseUiMinimalInputResponse<"ui.interactive.pickList"> {
+    data: PickListItem[];
+}
+
 interface UI<C extends FlowConfig> {
     page: UiPage<C>;
     display: UiDisplayElements;
     inputs: UiInputsElements;
     select: UiSelectElements;
+    interactive: UiInteractiveElements;
 }
 type UiInputsElements = {
     text: UiElementInputText;
@@ -572,8 +624,13 @@ type UiDisplayElements = {
     table: UiElementTable;
     keyValue: UiElementKeyValue;
 };
+type UiInteractiveElements = {
+    print: UiElementPrint;
+    pickList: UiElementPickList;
+};
 type InputElement<TValueType, TConfig extends any = never> = <N extends string>(name: N, options?: BaseInputConfig<TValueType> & TConfig) => InputElementResponse<N, TValueType>;
 type DisplayElement<TConfig extends any = never> = (options?: TConfig) => DisplayElementResponse;
+type DisplayElementWithRequiredConfig<TConfig extends any = never> = (options: TConfig) => DisplayElementResponse;
 type UIElements = (InputElementResponse<string, any> | DisplayElementResponse)[];
 interface UIElementBase {
     _type: string;
@@ -592,8 +649,9 @@ interface BaseInputConfig<T> {
     helpText?: string;
     optional?: boolean;
     disabled?: boolean;
-    validate?: (data: T) => Promise<null | string | void> | string | null | void;
+    validate?: ValidateFn<T>;
 }
+type ValidateFn<T> = (data: T) => Promise<boolean | string> | boolean | string;
 interface BaseUiInputResponse<K, TData> {
     __type: K;
     name: string;
@@ -604,6 +662,11 @@ interface BaseUiInputResponse<K, TData> {
     helpText?: string;
     validationError?: string;
 }
+interface BaseUiMinimalInputResponse<K> {
+    __type: K;
+    name: string;
+    validationError?: string;
+}
 interface BaseUiDisplayResponse<K> {
     __type: K;
 }
@@ -630,6 +693,10 @@ type UIApiResponses = {
         one: UiElementSelectOneApiResponse;
         table: UiElementSelectTableApiResponse;
     };
+    interactive: {
+        print: UiElementPrintApiResponse;
+        pickList: UiElementPickListApiResponse;
+    };
 };
 
 declare class NonRetriableError extends Error {

package/dist/index.js

@@ -2455,10 +2455,11 @@ async function page(options, data, action) {
     }
   }
   const contentUiConfig = await Promise.all(
-    content.map(async (c) => {
+    content.map(async (content2) => {
+      let c = await content2;
       const isInput = "__type" in c && c.__type == "input";
       const hasData = data && c.uiConfig.name in data;
-      if (isInput && hasData && c.validate) {
+      if (isInput && hasData && "validate" in c && c.validate) {
         const validationError2 = await c.validate(data[c.uiConfig.name]);
         if (typeof validationError2 === "string") {
           hasValidationErrors = true;
@@ -2702,6 +2703,68 @@ var dataGridInput = /* @__PURE__ */ __name((name, options) => {
   };
 }, "dataGridInput");
 
+// src/flows/ui/elements/interactive/print.ts
+var print = /* @__PURE__ */ __name(async (options) => {
+  const dataConfig = Array.isArray(options.jobs) ? options.jobs : [options.jobs];
+  const dataPromises = dataConfig.map(async (d) => {
+    if ("type" in d && d.type) {
+      return {
+        type: d.type,
+        name: d.name,
+        data: Array.isArray(d.data) ? d.data : [d.data]
+      };
+    }
+    return null;
+  });
+  const data = (await Promise.all(dataPromises)).filter((x) => x !== null);
+  return {
+    uiConfig: {
+      __type: "ui.interactive.print",
+      title: options.title,
+      description: options.description,
+      data,
+      autoPrint: options.autoPrint ?? false
+    }
+  };
+}, "print");
+
+// src/flows/ui/elements/interactive/pickList.ts
+var pickList = /* @__PURE__ */ __name((name, options) => {
+  return {
+    __type: "input",
+    uiConfig: {
+      __type: "ui.interactive.pickList",
+      name,
+      data: options.data.map((item) => {
+        const rendered = options.render(item);
+        return {
+          id: rendered.id,
+          targetQuantity: rendered.targetQuantity,
+          title: rendered.title,
+          description: rendered.description,
+          image: rendered.image ?? void 0,
+          barcodes: rendered.barcodes ?? void 0
+        };
+      })
+    },
+    validate: /* @__PURE__ */ __name(async (data) => {
+      if (!("items" in data)) {
+        return "Missing items in response";
+      }
+      if (!Array.isArray(data.items)) {
+        return "Items must be an array";
+      }
+      if (data.items.some(
+        (item) => typeof item !== "object" || typeof item.id !== "string" || typeof item.qty !== "number"
+      )) {
+        return "Invalid data";
+      }
+      return options?.validate?.(data) ?? true;
+    }, "validate"),
+    getData: /* @__PURE__ */ __name((x) => x, "getData")
+  };
+}, "pickList");
+
 // src/flows/errors.ts
 var NonRetriableError = class extends Error {
   static {
@@ -2928,6 +2991,10 @@ function createFlowContext(runId, data, action, spanId, ctx) {
       select: {
         one: selectOne,
         table: selectTable
+      },
+      interactive: {
+        print,
+        pickList
       }
     }
   };
@@ -2952,7 +3019,7 @@ async function complete(options) {
   const content = options.content || [];
   const contentUiConfig = await Promise.all(
     content.map(async (c) => {
-      return c.uiConfig;
+      return (await c).uiConfig;
     })
   );
   return {