@teamkeel/functions-runtime 0.418.0 → 0.420.0

package/dist/index.d.cts

@@ -355,6 +355,7 @@ type PageOptions<C extends FlowConfig, A extends PageActions[], T extends UIElem
     content: T;
     validate?: ValidateFn<ExtractFormData<T>>;
     actions?: A;
+    allowBack?: boolean;
 };
 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> : {
     data: ExtractFormData<T>;
@@ -639,15 +640,8 @@ interface UiElementPickListApiResponse extends BaseUiMinimalInputResponse<"ui.in
     data: PickListItem[];
 }
 
-type UiElementBulkScan = {
-    <N extends string>(name: N): InputElementResponse<N, {
-        scans: string[];
-    }>;
-    <N extends string, const M extends BulkScanDuplicateMode>(name: N, options?: BulkScanOptions<M>): InputElementResponse<N, {
-        scans: BulkScanResponseItem<M>[];
-    }>;
-};
-type BulkScanResponseItem<M> = M extends "trackQuantity" ? {
+type UiElementScan = <N extends string, const M extends scanMode = "single", const D extends ScanDuplicateMode = "none">(name: N, options?: ScanOptions<M, D>) => InputElementResponse<N, M extends "single" ? string : ScanResponseItem<D>[]>;
+type ScanResponseItem<D> = D extends "trackQuantity" ? {
     value: string;
     quantity: number;
 } : string;
@@ -655,33 +649,56 @@ type BulkScanResponseItem<M> = M extends "trackQuantity" ? {
  * Defines how duplicate scans should be handled.
  * @default "none"
  */
-type BulkScanDuplicateMode = 
+type ScanDuplicateMode = 
 /** No duplicate handling - all scans are accepted as separate entries */
 "none"
 /** Track quantity when duplicates are scanned */
  | "trackQuantity"
 /** Reject duplicate scans with an error message */
  | "rejectDuplicates";
-type BulkScanOptions<M> = {
-    /** The singular unit of the item being scanned. E.g. "box", "bottle", "product" etc */
-    unit?: string;
+type scanMode = "single" | "multi";
+type ScanOptions<M, D> = {
     /** The title of the input block
      * @default "Scan {unit plural | 'items'}"
      */
     title?: string;
     description?: string;
+    /** The singular unit of the item being scanned. E.g. "box", "bottle", "product" etc */
+    unit?: string;
+    /** The mode of the scan input
+     * @default "single"
+     */
+    mode: M | scanMode;
+    validate?: ValidateFn<ScanResponseItem<D>>;
+} & (M extends "multi" ? {
     max?: number;
     min?: number;
-    duplicateHandling?: M;
-    validate?: ValidateFn<BulkScanResponseItem<M>>;
-};
-interface UiElementBulkScanApiResponse extends BaseUiMinimalInputResponse<"ui.interactive.bulkScan"> {
+    duplicateHandling?: D | ScanDuplicateMode;
+} : {
+    /** Whether to automatically continue to the next step when the user scans an item
+     * @default false
+     */
+    autoContinue?: boolean;
+});
+interface UiElementInputScanApiResponse extends BaseUiMinimalInputResponse<"ui.input.scan"> {
+    mode: "single" | "multi";
     title?: string;
     description?: string;
     unit?: string;
     max?: number;
     min?: number;
-    duplicateHandling: BulkScanDuplicateMode;
+    duplicateHandling: ScanDuplicateMode;
+}
+
+type UiElementFile = DisplayElementWithRequiredConfig<{
+    title?: string;
+    file: File;
+}>;
+interface UiElementFileApiResponse extends BaseUiDisplayResponse<"ui.display.file"> {
+    title: string;
+    file?: FileDbRecord & {
+        url: string;
+    };
 }
 
 interface UI<C extends FlowConfig> {
@@ -697,6 +714,7 @@ type UiInputsElements = {
     number: UiElementInputNumber;
     boolean: UiElementInputBoolean;
     dataGrid: UiElementInputDataGrid;
+    scan: UiElementScan;
 };
 type UiSelectElements = {
     one: UiElementSelectOne;
@@ -713,11 +731,11 @@ type UiDisplayElements = {
     list: UiElementList;
     table: UiElementTable;
     keyValue: UiElementKeyValue;
+    file: UiElementFile;
 };
 type UiInteractiveElements = {
     print: UiElementPrint;
     pickList: UiElementPickList;
-    bulkScan: UiElementBulkScan;
 };
 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;
@@ -747,8 +765,10 @@ interface BaseInputConfig<T, O extends boolean = boolean> {
     optional?: O;
     disabled?: boolean;
     validate?: ValidateFn<T>;
+    onLeave?: CallbackFn<T, T>;
 }
 type ValidateFn<T> = (data: T) => Promise<boolean | string> | boolean | string;
+type CallbackFn<InputT, OutputT> = (data: InputT) => Promise<OutputT> | OutputT;
 interface BaseUiInputResponse<K, TData> {
     __type: K;
     name: string;
@@ -779,12 +799,14 @@ type UIApiResponses = {
         list: UiElementListApiResponse;
         table: UiElementTableApiResponse;
         keyValue: UiElementKeyValueApiResponse;
+        file: UiElementFileApiResponse;
     };
     input: {
         text: UiElementInputTextApiResponse;
         number: UiElementInputNumberApiResponse;
         boolean: UiElementInputBooleanApiResponse;
         dataGrid: UiElementInputDataGridApiResponse;
+        scan: UiElementInputScanApiResponse;
     };
     select: {
         one: UiElementSelectOneApiResponse;
@@ -794,10 +816,9 @@ type UIApiResponses = {
     interactive: {
         print: UiElementPrintApiResponse;
         pickList: UiElementPickListApiResponse;
-        bulkScan: UiElementBulkScanApiResponse;
     };
 };
-type UiElementApiResponse = UiElementDividerApiResponse | UiElementMarkdownApiResponse | UiElementHeaderApiResponse | UiElementBannerApiResponse | UiElementImageApiResponse | UiElementCodeApiResponse | UiElementGridApiResponse | UiElementListApiResponse | UiElementTableApiResponse | UiElementKeyValueApiResponse | UiElementInputTextApiResponse | UiElementInputNumberApiResponse | UiElementInputBooleanApiResponse | UiElementInputDataGridApiResponse | UiElementSelectOneApiResponse | UiElementSelectTableApiResponse | UiElementIteratorApiResponse | UiElementPrintApiResponse | UiElementPickListApiResponse | UiElementBulkScanApiResponse;
+type UiElementApiResponse = UiElementDividerApiResponse | UiElementMarkdownApiResponse | UiElementHeaderApiResponse | UiElementBannerApiResponse | UiElementImageApiResponse | UiElementCodeApiResponse | UiElementGridApiResponse | UiElementListApiResponse | UiElementTableApiResponse | UiElementKeyValueApiResponse | UiElementFileApiResponse | UiElementInputTextApiResponse | UiElementInputNumberApiResponse | UiElementInputBooleanApiResponse | UiElementInputDataGridApiResponse | UiElementInputScanApiResponse | UiElementSelectOneApiResponse | UiElementSelectTableApiResponse | UiElementIteratorApiResponse | UiElementPrintApiResponse | UiElementPickListApiResponse;
 type UiElementApiResponses = UiElementApiResponse[];
 
 declare class NonRetriableError extends Error {
@@ -906,7 +927,7 @@ type StageConfigObject = {
     initiallyHidden?: boolean;
 };
 type StageConfig = string | StageConfigObject;
-declare function createFlowContext<C extends FlowConfig, E, S, Id, I>(runId: string, data: any, action: string | null, spanId: string, ctx: {
+declare function createFlowContext<C extends FlowConfig, E, S, Id, I>(runId: string, data: any, action: string | null, callback: string | null, element: string | null, spanId: string, ctx: {
     env: E;
     now: Date;
     secrets: S;

package/dist/index.d.ts

@@ -355,6 +355,7 @@ type PageOptions<C extends FlowConfig, A extends PageActions[], T extends UIElem
     content: T;
     validate?: ValidateFn<ExtractFormData<T>>;
     actions?: A;
+    allowBack?: boolean;
 };
 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> : {
     data: ExtractFormData<T>;
@@ -639,15 +640,8 @@ interface UiElementPickListApiResponse extends BaseUiMinimalInputResponse<"ui.in
     data: PickListItem[];
 }
 
-type UiElementBulkScan = {
-    <N extends string>(name: N): InputElementResponse<N, {
-        scans: string[];
-    }>;
-    <N extends string, const M extends BulkScanDuplicateMode>(name: N, options?: BulkScanOptions<M>): InputElementResponse<N, {
-        scans: BulkScanResponseItem<M>[];
-    }>;
-};
-type BulkScanResponseItem<M> = M extends "trackQuantity" ? {
+type UiElementScan = <N extends string, const M extends scanMode = "single", const D extends ScanDuplicateMode = "none">(name: N, options?: ScanOptions<M, D>) => InputElementResponse<N, M extends "single" ? string : ScanResponseItem<D>[]>;
+type ScanResponseItem<D> = D extends "trackQuantity" ? {
     value: string;
     quantity: number;
 } : string;
@@ -655,33 +649,56 @@ type BulkScanResponseItem<M> = M extends "trackQuantity" ? {
  * Defines how duplicate scans should be handled.
  * @default "none"
  */
-type BulkScanDuplicateMode = 
+type ScanDuplicateMode = 
 /** No duplicate handling - all scans are accepted as separate entries */
 "none"
 /** Track quantity when duplicates are scanned */
  | "trackQuantity"
 /** Reject duplicate scans with an error message */
  | "rejectDuplicates";
-type BulkScanOptions<M> = {
-    /** The singular unit of the item being scanned. E.g. "box", "bottle", "product" etc */
-    unit?: string;
+type scanMode = "single" | "multi";
+type ScanOptions<M, D> = {
     /** The title of the input block
      * @default "Scan {unit plural | 'items'}"
      */
     title?: string;
     description?: string;
+    /** The singular unit of the item being scanned. E.g. "box", "bottle", "product" etc */
+    unit?: string;
+    /** The mode of the scan input
+     * @default "single"
+     */
+    mode: M | scanMode;
+    validate?: ValidateFn<ScanResponseItem<D>>;
+} & (M extends "multi" ? {
     max?: number;
     min?: number;
-    duplicateHandling?: M;
-    validate?: ValidateFn<BulkScanResponseItem<M>>;
-};
-interface UiElementBulkScanApiResponse extends BaseUiMinimalInputResponse<"ui.interactive.bulkScan"> {
+    duplicateHandling?: D | ScanDuplicateMode;
+} : {
+    /** Whether to automatically continue to the next step when the user scans an item
+     * @default false
+     */
+    autoContinue?: boolean;
+});
+interface UiElementInputScanApiResponse extends BaseUiMinimalInputResponse<"ui.input.scan"> {
+    mode: "single" | "multi";
     title?: string;
     description?: string;
     unit?: string;
     max?: number;
     min?: number;
-    duplicateHandling: BulkScanDuplicateMode;
+    duplicateHandling: ScanDuplicateMode;
+}
+
+type UiElementFile = DisplayElementWithRequiredConfig<{
+    title?: string;
+    file: File;
+}>;
+interface UiElementFileApiResponse extends BaseUiDisplayResponse<"ui.display.file"> {
+    title: string;
+    file?: FileDbRecord & {
+        url: string;
+    };
 }
 
 interface UI<C extends FlowConfig> {
@@ -697,6 +714,7 @@ type UiInputsElements = {
     number: UiElementInputNumber;
     boolean: UiElementInputBoolean;
     dataGrid: UiElementInputDataGrid;
+    scan: UiElementScan;
 };
 type UiSelectElements = {
     one: UiElementSelectOne;
@@ -713,11 +731,11 @@ type UiDisplayElements = {
     list: UiElementList;
     table: UiElementTable;
     keyValue: UiElementKeyValue;
+    file: UiElementFile;
 };
 type UiInteractiveElements = {
     print: UiElementPrint;
     pickList: UiElementPickList;
-    bulkScan: UiElementBulkScan;
 };
 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;
@@ -747,8 +765,10 @@ interface BaseInputConfig<T, O extends boolean = boolean> {
     optional?: O;
     disabled?: boolean;
     validate?: ValidateFn<T>;
+    onLeave?: CallbackFn<T, T>;
 }
 type ValidateFn<T> = (data: T) => Promise<boolean | string> | boolean | string;
+type CallbackFn<InputT, OutputT> = (data: InputT) => Promise<OutputT> | OutputT;
 interface BaseUiInputResponse<K, TData> {
     __type: K;
     name: string;
@@ -779,12 +799,14 @@ type UIApiResponses = {
         list: UiElementListApiResponse;
         table: UiElementTableApiResponse;
         keyValue: UiElementKeyValueApiResponse;
+        file: UiElementFileApiResponse;
     };
     input: {
         text: UiElementInputTextApiResponse;
         number: UiElementInputNumberApiResponse;
         boolean: UiElementInputBooleanApiResponse;
         dataGrid: UiElementInputDataGridApiResponse;
+        scan: UiElementInputScanApiResponse;
     };
     select: {
         one: UiElementSelectOneApiResponse;
@@ -794,10 +816,9 @@ type UIApiResponses = {
     interactive: {
         print: UiElementPrintApiResponse;
         pickList: UiElementPickListApiResponse;
-        bulkScan: UiElementBulkScanApiResponse;
     };
 };
-type UiElementApiResponse = UiElementDividerApiResponse | UiElementMarkdownApiResponse | UiElementHeaderApiResponse | UiElementBannerApiResponse | UiElementImageApiResponse | UiElementCodeApiResponse | UiElementGridApiResponse | UiElementListApiResponse | UiElementTableApiResponse | UiElementKeyValueApiResponse | UiElementInputTextApiResponse | UiElementInputNumberApiResponse | UiElementInputBooleanApiResponse | UiElementInputDataGridApiResponse | UiElementSelectOneApiResponse | UiElementSelectTableApiResponse | UiElementIteratorApiResponse | UiElementPrintApiResponse | UiElementPickListApiResponse | UiElementBulkScanApiResponse;
+type UiElementApiResponse = UiElementDividerApiResponse | UiElementMarkdownApiResponse | UiElementHeaderApiResponse | UiElementBannerApiResponse | UiElementImageApiResponse | UiElementCodeApiResponse | UiElementGridApiResponse | UiElementListApiResponse | UiElementTableApiResponse | UiElementKeyValueApiResponse | UiElementFileApiResponse | UiElementInputTextApiResponse | UiElementInputNumberApiResponse | UiElementInputBooleanApiResponse | UiElementInputDataGridApiResponse | UiElementInputScanApiResponse | UiElementSelectOneApiResponse | UiElementSelectTableApiResponse | UiElementIteratorApiResponse | UiElementPrintApiResponse | UiElementPickListApiResponse;
 type UiElementApiResponses = UiElementApiResponse[];
 
 declare class NonRetriableError extends Error {
@@ -906,7 +927,7 @@ type StageConfigObject = {
     initiallyHidden?: boolean;
 };
 type StageConfig = string | StageConfigObject;
-declare function createFlowContext<C extends FlowConfig, E, S, Id, I>(runId: string, data: any, action: string | null, spanId: string, ctx: {
+declare function createFlowContext<C extends FlowConfig, E, S, Id, I>(runId: string, data: any, action: string | null, callback: string | null, element: string | null, spanId: string, ctx: {
     env: E;
     now: Date;
     secrets: S;

package/dist/index.js

@@ -736,9 +736,9 @@ var InlineFile = class _InlineFile {
     const mime = info.split(";")[0];
     const name = info.split(";")[1].split("=")[1];
     const buffer = Buffer.from(data, "base64");
-    const file = new _InlineFile({ filename: name, contentType: mime });
-    file.write(buffer);
-    return file;
+    const file2 = new _InlineFile({ filename: name, contentType: mime });
+    file2.write(buffer);
+    return file2;
   }
   // Gets size of the file's contents in bytes
   get size() {
@@ -2332,6 +2332,7 @@ var textInput = /* @__PURE__ */ __name((name, options) => {
       minLength: options?.minLength
     },
     validate: options?.validate,
+    onLeave: options?.onLeave,
     getData: /* @__PURE__ */ __name((x) => x, "getData")
   };
 }, "textInput");
@@ -2353,6 +2354,7 @@ var numberInput = /* @__PURE__ */ __name((name, options) => {
       max: options?.max
     },
     validate: options?.validate,
+    onLeave: options?.onLeave,
     getData: /* @__PURE__ */ __name((x) => x, "getData")
   };
 }, "numberInput");
@@ -2381,6 +2383,7 @@ var booleanInput = /* @__PURE__ */ __name((name, options) => {
       mode: options?.mode || "checkbox"
     },
     validate: options?.validate,
+    onLeave: options?.onLeave,
     getData: /* @__PURE__ */ __name((x) => x, "getData")
   };
 }, "booleanInput");
@@ -2442,6 +2445,22 @@ var selectOne = /* @__PURE__ */ __name((name, options) => {
 }, "selectOne");
 
 // src/flows/ui/page.ts
+async function callbackFn(elements, elementName, callbackName, data) {
+  const element = elements.find(
+    (el) => el.uiConfig && el.uiConfig.name === elementName
+  );
+  if (!element) {
+    throw new Error(`Element with name ${elementName} not found`);
+  }
+  const cb = element[callbackName];
+  if (typeof cb !== "function") {
+    throw new Error(
+      `Callback ${callbackName} not found on element ${elementName}`
+    );
+  }
+  return await cb(data);
+}
+__name(callbackFn, "callbackFn");
 async function page(options, data, action) {
   const content = options.content;
   let hasValidationErrors = false;
@@ -2491,7 +2510,8 @@ async function page(options, data, action) {
         return a;
       }),
       hasValidationErrors,
-      validationError
+      validationError,
+      allowBack: options.allowBack
     },
     hasValidationErrors
   };
@@ -2628,6 +2648,16 @@ var ExhuastedRetriesDisrupt = class extends FlowDisrupt {
     super();
   }
 };
+var CallbackDisrupt = class extends FlowDisrupt {
+  constructor(response, error) {
+    super();
+    this.response = response;
+    this.error = error;
+  }
+  static {
+    __name(this, "CallbackDisrupt");
+  }
+};
 
 // src/flows/ui/elements/display/banner.ts
 var banner = /* @__PURE__ */ __name((options) => {
@@ -2883,32 +2913,48 @@ var NonRetriableError = class extends Error {
   }
 };
 
-// src/flows/ui/elements/interactive/bulkScan.ts
-var bulkScan = /* @__PURE__ */ __name((name, options) => {
+// src/flows/ui/elements/input/scan.ts
+var isMultiMode = /* @__PURE__ */ __name((opts) => opts && opts.mode === "multi", "isMultiMode");
+var scan = /* @__PURE__ */ __name((name, options) => {
   return {
     __type: "input",
     uiConfig: {
-      __type: "ui.interactive.bulkScan",
+      __type: "ui.input.scan",
       name,
       title: options?.title ?? void 0,
       description: options?.description ?? void 0,
       unit: options?.unit ?? void 0,
-      max: options?.max ?? void 0,
-      min: options?.min ?? void 0,
-      duplicateHandling: options?.duplicateHandling ?? "none"
+      mode: options?.mode ?? "single",
+      duplicateHandling: "none",
+      ...isMultiMode(options) ? {
+        max: options.max ?? void 0,
+        min: options.min ?? void 0,
+        duplicateHandling: options.duplicateHandling ?? "none"
+      } : {}
     },
     validate: /* @__PURE__ */ __name(async (data) => {
-      if (!("scans" in data)) {
-        return "Missing scans in response";
-      }
-      if (!Array.isArray(data.scans)) {
-        return "Scans must be an array";
-      }
       return options?.validate?.(data) ?? true;
     }, "validate"),
     getData: /* @__PURE__ */ __name((x) => x, "getData")
   };
-}, "bulkScan");
+}, "scan");
+
+// src/flows/ui/elements/display/file.ts
+var file = /* @__PURE__ */ __name(async (options) => {
+  const title = options.title || options.file.filename;
+  const url = await options.file.getPresignedUrl();
+  const metadata = await options.file.toJSON();
+  return {
+    uiConfig: {
+      __type: "ui.display.file",
+      title,
+      file: metadata ? {
+        url: url?.toString() || "",
+        ...metadata
+      } : void 0
+    }
+  };
+}, "file");
 
 // src/flows/index.ts
 var STEP_STATUS = /* @__PURE__ */ ((STEP_STATUS2) => {
@@ -2944,7 +2990,7 @@ var defaultOpts = {
   retries: 4,
   timeout: 6e4
 };
-function createFlowContext(runId, data, action, spanId, ctx) {
+function createFlowContext(runId, data, action, callback, element, spanId, ctx) {
   const usedNames = /* @__PURE__ */ new Set();
   return {
     identity: ctx.identity,
@@ -3056,6 +3102,7 @@ function createFlowContext(runId, data, action, spanId, ctx) {
     ui: {
       page: /* @__PURE__ */ __name(async (name, options) => {
         const db = useDatabase();
+        const isCallback = element && callback;
         if (usedNames.has(name)) {
           await db.insertInto("keel.flow_step").values({
             run_id: runId,
@@ -3091,6 +3138,25 @@ function createFlowContext(runId, data, action, spanId, ctx) {
             (await page(options, null, null)).page
           );
         }
+        if (isCallback) {
+          try {
+            const response = await callbackFn(
+              options.content,
+              element,
+              callback,
+              data
+            );
+            throw new CallbackDisrupt(response, false);
+          } catch (e) {
+            if (e instanceof CallbackDisrupt) {
+              throw e;
+            }
+            throw new CallbackDisrupt(
+              e instanceof Error ? e.message : `An error occurred`,
+              true
+            );
+          }
+        }
         if (!data) {
           throw new UIRenderDisrupt(
             step?.id,
@@ -3127,7 +3193,8 @@ function createFlowContext(runId, data, action, spanId, ctx) {
         text: textInput,
         number: numberInput,
         boolean: booleanInput,
-        dataGrid: dataGridInput
+        dataGrid: dataGridInput,
+        scan
       },
       display: {
         divider,
@@ -3139,7 +3206,8 @@ function createFlowContext(runId, data, action, spanId, ctx) {
         code,
         grid,
         list,
-        keyValue
+        keyValue,
+        file
       },
       select: {
         one: selectOne,
@@ -3148,8 +3216,7 @@ function createFlowContext(runId, data, action, spanId, ctx) {
       iterator,
       interactive: {
         print,
-        pickList,
-        bulkScan
+        pickList
       }
     }
   };
@@ -3225,6 +3292,8 @@ async function handleFlow(request, config) {
           request.meta.runId,
           request.meta.data,
           request.meta.action,
+          request.meta.callback,
+          request.meta.element,
           span.spanContext().spanId,
           createFlowContextAPI({
             meta: request.meta
@@ -3260,6 +3329,12 @@ async function handleFlow(request, config) {
               executeAfter: e.executeAfter
             });
           }
+          if (e instanceof CallbackDisrupt) {
+            if (e.error) {
+              return createJSONRPCErrorResponse6(request.id, 500, e.response);
+            }
+            return createJSONRPCSuccessResponse5(request.id, e.response);
+          }
           if (e instanceof UIRenderDisrupt) {
             return createJSONRPCSuccessResponse5(request.id, {
               runId,