@teamkeel/functions-runtime 0.423.3 → 0.424.0

package/dist/index.d.cts

@@ -630,19 +630,51 @@ type UiElementPrint<H extends NullableHardware> = DisplayElementWithRequiredConf
     autoContinue?: boolean;
 }>;
 type PrintData<H extends NullableHardware> = {
-    type: "zpl";
-    printer?: H extends Hardware ? H["printers"][number]["name"] : never;
+    /** The name of the print job. */
     name?: string;
+    /** The printer to use for the print job. Printers are defined in keelconfig.yaml. */
+    printer?: H extends Hardware ? H["printers"][number]["name"] : never;
+} & (PrintDataZpl | PrintDataRawPdf);
+type PrintDataZpl = {
+    type: "zpl";
+} & ({
     data: string | string[];
+    url?: never;
+} | {
+    data?: never;
+    url: string;
+});
+type PrintDataRawPdf = {
+    type: "rawPdf";
+    url: string;
+    data?: never;
+    /** The DPI of the PDF
+     * @default 300
+     */
+    dpi?: number;
+    /** The width of the page in dots.
+     * e.g. 4" at 300 dpi is 1200 dots.
+     * @default 1200
+     */
+    pageWidth?: number;
+    /** The height of the page in dots.
+     * e.g. 6" at 300 dpi is 1800 dots.
+     * @default 1800
+     */
+    pageHeight?: number;
 };
 interface UiElementPrintApiResponse extends BaseUiDisplayResponse<"ui.interactive.print"> {
     title?: string;
     description?: string;
     data: {
-        type: "url" | "text" | "html" | "zpl";
+        type: "zpl" | "rawPdf";
+        name?: string;
         data?: string[];
         url?: string;
         printer?: string;
+        dpi?: number;
+        pageWidth?: number;
+        pageHeight?: number;
     }[];
     autoPrint: boolean;
     autoContinue: boolean;
@@ -835,7 +867,7 @@ interface BaseInputConfig<T, O extends boolean = boolean> {
     validate?: ValidateFn<T>;
     onLeave?: CallbackFn<T, T>;
 }
-type ValidateFn<T> = (data: T) => Promise<boolean | string> | boolean | string;
+type ValidateFn<T> = (data: T, action?: string) => Promise<boolean | string> | boolean | string;
 type CallbackFn<InputT, OutputT> = (data: InputT) => Promise<OutputT> | OutputT;
 interface BaseUiInputResponse<K, TData> {
     __type: K;

package/dist/index.d.ts

@@ -630,19 +630,51 @@ type UiElementPrint<H extends NullableHardware> = DisplayElementWithRequiredConf
     autoContinue?: boolean;
 }>;
 type PrintData<H extends NullableHardware> = {
-    type: "zpl";
-    printer?: H extends Hardware ? H["printers"][number]["name"] : never;
+    /** The name of the print job. */
     name?: string;
+    /** The printer to use for the print job. Printers are defined in keelconfig.yaml. */
+    printer?: H extends Hardware ? H["printers"][number]["name"] : never;
+} & (PrintDataZpl | PrintDataRawPdf);
+type PrintDataZpl = {
+    type: "zpl";
+} & ({
     data: string | string[];
+    url?: never;
+} | {
+    data?: never;
+    url: string;
+});
+type PrintDataRawPdf = {
+    type: "rawPdf";
+    url: string;
+    data?: never;
+    /** The DPI of the PDF
+     * @default 300
+     */
+    dpi?: number;
+    /** The width of the page in dots.
+     * e.g. 4" at 300 dpi is 1200 dots.
+     * @default 1200
+     */
+    pageWidth?: number;
+    /** The height of the page in dots.
+     * e.g. 6" at 300 dpi is 1800 dots.
+     * @default 1800
+     */
+    pageHeight?: number;
 };
 interface UiElementPrintApiResponse extends BaseUiDisplayResponse<"ui.interactive.print"> {
     title?: string;
     description?: string;
     data: {
-        type: "url" | "text" | "html" | "zpl";
+        type: "zpl" | "rawPdf";
+        name?: string;
         data?: string[];
         url?: string;
         printer?: string;
+        dpi?: number;
+        pageWidth?: number;
+        pageHeight?: number;
     }[];
     autoPrint: boolean;
     autoContinue: boolean;
@@ -835,7 +867,7 @@ interface BaseInputConfig<T, O extends boolean = boolean> {
     validate?: ValidateFn<T>;
     onLeave?: CallbackFn<T, T>;
 }
-type ValidateFn<T> = (data: T) => Promise<boolean | string> | boolean | string;
+type ValidateFn<T> = (data: T, action?: string) => Promise<boolean | string> | boolean | string;
 type CallbackFn<InputT, OutputT> = (data: InputT) => Promise<OutputT> | OutputT;
 interface BaseUiInputResponse<K, TData> {
     __type: K;

package/dist/index.js

@@ -875,9 +875,7 @@ var File = class _File extends InlineFile {
       const url = await getSignedUrl(s3Client, command, { expiresIn: 60 * 60 });
       return new URL(url);
     } else {
-      const contents = await this.read();
-      const dataurl = `data:${this.contentType};name=${this.filename};base64,${contents.toString("base64")}`;
-      return new URL(dataurl);
+      return new URL(`${process.env.KEEL_API_URL}/files/${this.key}`);
     }
   }
   // Persists the file
@@ -2489,14 +2487,15 @@ async function page(options, data, action) {
       const elementData = data && typeof data === "object" && resolvedC.uiConfig.name in data ? data[resolvedC.uiConfig.name] : void 0;
       const { uiConfig, validationErrors } = await recursivelyProcessElement(
         c,
-        elementData
+        elementData,
+        options.actions && options.actions.length > 0 ? action : null
       );
       if (validationErrors) hasValidationErrors = true;
       return uiConfig;
     })
   );
   if (data && options.validate) {
-    const validationResult = await options.validate(data);
+    const validationResult = options.actions && action !== null ? await options.validate(data, action) : await options.validate(data);
     if (typeof validationResult === "string") {
       hasValidationErrors = true;
       validationError = validationResult;
@@ -2526,19 +2525,21 @@ async function page(options, data, action) {
   };
 }
 __name(page, "page");
-var recursivelyProcessElement = /* @__PURE__ */ __name(async (c, data) => {
+var recursivelyProcessElement = /* @__PURE__ */ __name(async (c, data, action) => {
   const resolvedC = await c;
   const elementType = "__type" in resolvedC ? resolvedC.__type : null;
   switch (elementType) {
     case "input":
       return processInputElement(
         resolvedC,
-        data
+        data,
+        action
       );
     case "iterator":
       return processIteratorElement(
         resolvedC,
-        data
+        data,
+        action
       );
     default:
       return {
@@ -2547,7 +2548,7 @@ var recursivelyProcessElement = /* @__PURE__ */ __name(async (c, data) => {
       };
   }
 }, "recursivelyProcessElement");
-var processInputElement = /* @__PURE__ */ __name(async (element, data) => {
+var processInputElement = /* @__PURE__ */ __name(async (element, data, action) => {
   const hasData = data !== void 0 && data !== null;
   if (!hasData || !element.validate) {
     return {
@@ -2555,7 +2556,7 @@ var processInputElement = /* @__PURE__ */ __name(async (element, data) => {
       validationErrors: false
     };
   }
-  const validationError = await element.validate(data);
+  const validationError = action !== null ? await element.validate(data, action) : await element.validate(data);
   const hasValidationErrors = typeof validationError === "string";
   return {
     uiConfig: {
@@ -2565,19 +2566,23 @@ var processInputElement = /* @__PURE__ */ __name(async (element, data) => {
     validationErrors: hasValidationErrors
   };
 }, "processInputElement");
-var processIteratorElement = /* @__PURE__ */ __name(async (element, data) => {
+var processIteratorElement = /* @__PURE__ */ __name(async (element, data, action) => {
   const elements = element.uiConfig.content;
   const dataArr = data;
   const ui = [];
   for (const el of elements) {
-    const result = await recursivelyProcessElement(el, void 0);
+    const result = await recursivelyProcessElement(el, void 0, action);
     ui.push(result.uiConfig);
   }
-  const validationErrors = await validateIteratorData(elements, dataArr);
+  const validationErrors = await validateIteratorData(
+    elements,
+    dataArr,
+    action
+  );
   let hasValidationErrors = validationErrors.length > 0;
   let validationError = void 0;
   if (dataArr && element.validate) {
-    const v = await element.validate(dataArr);
+    const v = action !== null ? await element.validate(dataArr, action) : await element.validate(dataArr);
     if (typeof v === "string") {
       hasValidationErrors = true;
       validationError = v;
@@ -2593,7 +2598,7 @@ var processIteratorElement = /* @__PURE__ */ __name(async (element, data) => {
     validationErrors: hasValidationErrors
   };
 }, "processIteratorElement");
-var validateIteratorData = /* @__PURE__ */ __name(async (elements, dataArr) => {
+var validateIteratorData = /* @__PURE__ */ __name(async (elements, dataArr, action) => {
   const validationErrors = [];
   if (!dataArr || dataArr.length === 0) {
     return validationErrors;
@@ -2605,9 +2610,7 @@ var validateIteratorData = /* @__PURE__ */ __name(async (elements, dataArr) => {
       if ("__type" in resolvedEl && resolvedEl.__type === "input" && "validate" in resolvedEl && resolvedEl.validate && typeof resolvedEl.validate === "function") {
         const fieldName = resolvedEl.uiConfig.name;
         if (rowData && typeof rowData === "object" && fieldName in rowData) {
-          const validationError = await resolvedEl.validate(
-            rowData[fieldName]
-          );
+          const validationError = action !== null ? await resolvedEl.validate(rowData[fieldName], action) : await resolvedEl.validate(rowData[fieldName]);
           if (typeof validationError === "string") {
             validationErrors.push({
               index: i,
@@ -2876,17 +2879,22 @@ var iterator = /* @__PURE__ */ __name((name, options) => {
 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],
-        printer: d.printer
-      };
-    }
-    return null;
+    return {
+      type: d.type,
+      name: d.name,
+      data: "data" in d && d.data ? Array.isArray(d.data) ? d.data : [d.data] : void 0,
+      printer: d.printer,
+      url: "url" in d && d.url ? d.url : void 0,
+      ...d.type === "rawPdf" ? {
+        dpi: d.dpi,
+        pageWidth: d.pageWidth,
+        pageHeight: d.pageHeight
+      } : {}
+    };
   });
-  const data = (await Promise.all(dataPromises)).filter((x) => x !== null);
+  const data = (await Promise.all(dataPromises)).filter(
+    (x) => x !== null
+  );
   return {
     uiConfig: {
       __type: "ui.interactive.print",
@@ -2924,7 +2932,7 @@ var pickList = /* @__PURE__ */ __name((name, options) => {
         };
       })
     },
-    validate: /* @__PURE__ */ __name(async (data) => {
+    validate: /* @__PURE__ */ __name(async (data, action) => {
       if (!("items" in data)) {
         return "Missing items in response";
       }
@@ -2936,7 +2944,7 @@ var pickList = /* @__PURE__ */ __name((name, options) => {
       )) {
         return "Invalid data";
       }
-      return options?.validate?.(data) ?? true;
+      return options?.validate?.(data, action) ?? true;
     }, "validate"),
     getData: /* @__PURE__ */ __name((x) => x, "getData")
   };
@@ -2976,8 +2984,8 @@ var scan = /* @__PURE__ */ __name((name, options) => {
         autoContinue: options.autoContinue
       } : {}
     },
-    validate: /* @__PURE__ */ __name(async (data) => {
-      return options?.validate?.(data) ?? true;
+    validate: /* @__PURE__ */ __name(async (data, action) => {
+      return options?.validate?.(data, action) ?? true;
     }, "validate"),
     getData: /* @__PURE__ */ __name((x) => x, "getData")
   };
@@ -3148,7 +3156,7 @@ function createFlowContext(runId, data, action, callback, element, spanId, ctx)
       });
     }, "step"),
     ui: {
-      page: /* @__PURE__ */ __name(async (name, options) => {
+      page: /* @__PURE__ */ __name((async (name, options) => {
         return withSpan(`Page - ${name}`, async (span) => {
           const db = useDatabase();
           const isCallback = element && callback;
@@ -3244,7 +3252,7 @@ function createFlowContext(runId, data, action, callback, element, spanId, ctx)
           }
           return data;
         });
-      }, "page"),
+      }), "page"),
       inputs: {
         text: textInput,
         number: numberInput,