@teamkeel/functions-runtime 0.425.1 → 0.426.0

package/dist/index.d.cts

@@ -265,6 +265,7 @@ declare class File extends InlineFile {
     read(): Promise<Buffer>;
     store(expires?: Date | null): Promise<File>;
     getPresignedUrl(): Promise<URL>;
+    getPresignedUploadUrl(): Promise<URL>;
     toDbRecord(): FileDbRecord;
     toJSON(): FileDbRecord;
 }
@@ -279,55 +280,55 @@ declare class Duration {
     toPostgres(): string;
 }
 
-type ElementDataType$4 = string | number | boolean | Date;
-type UiElementSelectOne = <const TValue extends ElementDataType$4, N extends string, O extends boolean = false>(name: N, options?: BaseInputConfig<TValue, O> & {
+type ElementDataType$5 = string | number | boolean | Date;
+type UiElementSelectOne = <const TValue extends ElementDataType$5, N extends string, O extends boolean = false>(name: N, options?: BaseInputConfig<TValue, O> & {
     options: ({
         label: string;
         value: TValue;
     } | TValue)[];
 }) => InputElementResponse<N, O extends true ? TValue | undefined : TValue>;
-interface UiElementSelectOneApiResponse extends BaseUiInputResponse<"ui.select.one", ElementDataType$4> {
+interface UiElementSelectOneApiResponse extends BaseUiInputResponse<"ui.select.one", ElementDataType$5> {
     options: ({
         label: string;
-        value: ElementDataType$4;
-    } | ElementDataType$4)[];
+        value: ElementDataType$5;
+    } | ElementDataType$5)[];
 }
 
-type ElementDataType$3 = string;
-type UiElementInputText = InputElement<ElementDataType$3, {
+type ElementDataType$4 = string;
+type UiElementInputText = InputElement<ElementDataType$4, {
     placeholder?: string;
     multiline?: boolean;
     maxLength?: number;
     minLength?: number;
 }>;
-interface UiElementInputTextApiResponse extends BaseUiInputResponse<"ui.input.text", ElementDataType$3> {
+interface UiElementInputTextApiResponse extends BaseUiInputResponse<"ui.input.text", ElementDataType$4> {
     placeholder?: string;
     multiline?: boolean;
     maxLength?: number;
     minLength?: number;
 }
 
-type ElementDataType$2 = number;
-type UiElementInputNumber = InputElement<ElementDataType$2, {
+type ElementDataType$3 = number;
+type UiElementInputNumber = InputElement<ElementDataType$3, {
     placeholder?: string;
     min?: number;
     max?: number;
 }>;
-interface UiElementInputNumberApiResponse extends BaseUiInputResponse<"ui.input.number", ElementDataType$2> {
+interface UiElementInputNumberApiResponse extends BaseUiInputResponse<"ui.input.number", ElementDataType$3> {
     placeholder?: string;
     min?: number;
     max?: number;
 }
 
-type ElementDataType$1 = boolean;
-type UiElementInputBoolean = InputElement<ElementDataType$1, {
+type ElementDataType$2 = boolean;
+type UiElementInputBoolean = InputElement<ElementDataType$2, {
     mode?: "checkbox" | "switch";
 }>;
-interface UiElementInputBooleanApiResponse extends BaseUiInputResponse<"ui.input.boolean", ElementDataType$1> {
+interface UiElementInputBooleanApiResponse extends BaseUiInputResponse<"ui.input.boolean", ElementDataType$2> {
     mode: "checkbox" | "switch";
 }
 
-type ElementDataType = string;
+type ElementDataType$1 = string;
 /**
  * Defines what type of datepicker should we use.
  * @default "dateTime"
@@ -337,19 +338,24 @@ type DatePickerMode =
 "dateTime"
 /** Pick only a date */
  | "date";
-type UiElementInputDatePicker = InputElement<ElementDataType, {
+type UiElementInputDatePicker = InputElement<ElementDataType$1, {
     mode?: DatePickerMode;
     /** Allows selecting only dates/datetimes past this given date. */
     min?: string;
     /** Allows selecting only dates/datetimes before this given date. */
     max?: string;
 }>;
-interface UiElementInputDatePickerApiResponse extends BaseUiInputResponse<"ui.input.datePicker", ElementDataType> {
+interface UiElementInputDatePickerApiResponse extends BaseUiInputResponse<"ui.input.datePicker", ElementDataType$1> {
     mode?: DatePickerMode;
     min?: string;
     max?: string;
 }
 
+type ElementDataType = Partial<FileDbRecord>;
+type UiElementInputFile = InputElement<ElementDataType, {}, File>;
+interface UiElementInputFileApiResponse extends BaseUiInputResponse<"ui.input.file", ElementDataType> {
+}
+
 type UiElementMarkdown = DisplayElement<{
     content: string;
 }>;
@@ -399,7 +405,7 @@ type ActionValue<T> = T extends string ? T : T extends {
     value: infer V;
 } ? V : never;
 type ExtractFormData<T extends UIElements> = {
-    [K in Extract<T[number], InputElementResponse<string, any>>["name"]]: Extract<T[number], InputElementResponse<K, any>>["valueType"];
+    [K in Extract<T[number], InputElementResponse<string, any>>["name"]]: Extract<T[number], InputElementResponse<K, any>>["returnType"];
 };
 
 type UiElementImage = DisplayElement<{
@@ -815,6 +821,7 @@ type UiInputsElements = {
     dataGrid: UiElementInputDataGrid;
     datePicker: UiElementInputDatePicker;
     scan: UiElementScan;
+    file: UiElementInputFile;
 };
 type UiSelectElements = {
     one: UiElementSelectOne;
@@ -837,18 +844,28 @@ type UiInteractiveElements<H extends NullableHardware> = {
     print: UiElementPrint<H>;
     pickList: UiElementPickList;
 };
-type InputElement<TValueType, TConfig extends any = never> = <N extends string>(name: N, options?: BaseInputConfig<TValueType> & TConfig) => InputElementResponse<N, TValueType>;
+type InputElement<TValueType, TConfig extends any = never, TReturnType = TValueType> = <N extends string>(name: N, options?: BaseInputConfig<TValueType> & TConfig) => InputElementResponse<N, TValueType, TReturnType>;
 type DisplayElement<TConfig extends any = never> = (options?: TConfig) => DisplayElementResponse;
 type DisplayElementWithRequiredConfig<TConfig extends any = never> = (options: TConfig) => DisplayElementResponse;
-type UIElement = InputElementResponse<string, any> | DisplayElementResponse | IteratorElementResponse<string, any>;
+type UIElement = InputElementResponse<string, any, any> | DisplayElementResponse | IteratorElementResponse<string, any>;
 type UIElements = UIElement[];
 interface UIElementBase {
     _type: string;
 }
-interface InputElementResponse<N extends string, V> extends UIElementBase {
+/**
+ * Type for the input element; name, data type, return data type
+ * InputElementResponse<"ui.input.text", string>
+ * InputElementResponse<"ui.input.file", Partial<FileDBRecord>, File>
+ */
+interface InputElementResponse<N extends string, V, RV = V> extends UIElementBase {
     _type: "input";
     name: N;
     valueType: V;
+    /**
+     * The type of the value returned from the step (page). Rich field types will operate on a json serialisable object
+     * but will return a complex type to be used in subsequent steps
+     */
+    returnType: RV;
 }
 interface DisplayElementResponse extends UIElementBase {
     _type: "display";
@@ -908,6 +925,7 @@ type UIApiResponses = {
         dataGrid: UiElementInputDataGridApiResponse;
         datePicker: UiElementInputDatePickerApiResponse;
         scan: UiElementInputScanApiResponse;
+        file: UiElementInputFileApiResponse;
     };
     select: {
         one: UiElementSelectOneApiResponse;
@@ -919,7 +937,7 @@ type UIApiResponses = {
         pickList: UiElementPickListApiResponse;
     };
 };
-type UiElementApiResponse = UiElementDividerApiResponse | UiElementMarkdownApiResponse | UiElementHeaderApiResponse | UiElementBannerApiResponse | UiElementImageApiResponse | UiElementCodeApiResponse | UiElementGridApiResponse | UiElementListApiResponse | UiElementTableApiResponse | UiElementKeyValueApiResponse | UiElementFileApiResponse | UiElementInputTextApiResponse | UiElementInputNumberApiResponse | UiElementInputBooleanApiResponse | UiElementInputDataGridApiResponse | UiElementInputScanApiResponse | UiElementInputDatePickerApiResponse | UiElementSelectOneApiResponse | UiElementSelectTableApiResponse | UiElementIteratorApiResponse | UiElementPrintApiResponse | UiElementPickListApiResponse;
+type UiElementApiResponse = UiElementDividerApiResponse | UiElementMarkdownApiResponse | UiElementHeaderApiResponse | UiElementBannerApiResponse | UiElementImageApiResponse | UiElementCodeApiResponse | UiElementGridApiResponse | UiElementListApiResponse | UiElementTableApiResponse | UiElementKeyValueApiResponse | UiElementFileApiResponse | UiElementInputTextApiResponse | UiElementInputNumberApiResponse | UiElementInputBooleanApiResponse | UiElementInputDataGridApiResponse | UiElementInputScanApiResponse | UiElementInputDatePickerApiResponse | UiElementInputFileApiResponse | UiElementSelectOneApiResponse | UiElementSelectTableApiResponse | UiElementIteratorApiResponse | UiElementPrintApiResponse | UiElementPickListApiResponse;
 type UiElementApiResponses = UiElementApiResponse[];
 
 declare class NonRetriableError extends Error {

package/dist/index.d.ts

@@ -265,6 +265,7 @@ declare class File extends InlineFile {
     read(): Promise<Buffer>;
     store(expires?: Date | null): Promise<File>;
     getPresignedUrl(): Promise<URL>;
+    getPresignedUploadUrl(): Promise<URL>;
     toDbRecord(): FileDbRecord;
     toJSON(): FileDbRecord;
 }
@@ -279,55 +280,55 @@ declare class Duration {
     toPostgres(): string;
 }
 
-type ElementDataType$4 = string | number | boolean | Date;
-type UiElementSelectOne = <const TValue extends ElementDataType$4, N extends string, O extends boolean = false>(name: N, options?: BaseInputConfig<TValue, O> & {
+type ElementDataType$5 = string | number | boolean | Date;
+type UiElementSelectOne = <const TValue extends ElementDataType$5, N extends string, O extends boolean = false>(name: N, options?: BaseInputConfig<TValue, O> & {
     options: ({
         label: string;
         value: TValue;
     } | TValue)[];
 }) => InputElementResponse<N, O extends true ? TValue | undefined : TValue>;
-interface UiElementSelectOneApiResponse extends BaseUiInputResponse<"ui.select.one", ElementDataType$4> {
+interface UiElementSelectOneApiResponse extends BaseUiInputResponse<"ui.select.one", ElementDataType$5> {
     options: ({
         label: string;
-        value: ElementDataType$4;
-    } | ElementDataType$4)[];
+        value: ElementDataType$5;
+    } | ElementDataType$5)[];
 }
 
-type ElementDataType$3 = string;
-type UiElementInputText = InputElement<ElementDataType$3, {
+type ElementDataType$4 = string;
+type UiElementInputText = InputElement<ElementDataType$4, {
     placeholder?: string;
     multiline?: boolean;
     maxLength?: number;
     minLength?: number;
 }>;
-interface UiElementInputTextApiResponse extends BaseUiInputResponse<"ui.input.text", ElementDataType$3> {
+interface UiElementInputTextApiResponse extends BaseUiInputResponse<"ui.input.text", ElementDataType$4> {
     placeholder?: string;
     multiline?: boolean;
     maxLength?: number;
     minLength?: number;
 }
 
-type ElementDataType$2 = number;
-type UiElementInputNumber = InputElement<ElementDataType$2, {
+type ElementDataType$3 = number;
+type UiElementInputNumber = InputElement<ElementDataType$3, {
     placeholder?: string;
     min?: number;
     max?: number;
 }>;
-interface UiElementInputNumberApiResponse extends BaseUiInputResponse<"ui.input.number", ElementDataType$2> {
+interface UiElementInputNumberApiResponse extends BaseUiInputResponse<"ui.input.number", ElementDataType$3> {
     placeholder?: string;
     min?: number;
     max?: number;
 }
 
-type ElementDataType$1 = boolean;
-type UiElementInputBoolean = InputElement<ElementDataType$1, {
+type ElementDataType$2 = boolean;
+type UiElementInputBoolean = InputElement<ElementDataType$2, {
     mode?: "checkbox" | "switch";
 }>;
-interface UiElementInputBooleanApiResponse extends BaseUiInputResponse<"ui.input.boolean", ElementDataType$1> {
+interface UiElementInputBooleanApiResponse extends BaseUiInputResponse<"ui.input.boolean", ElementDataType$2> {
     mode: "checkbox" | "switch";
 }
 
-type ElementDataType = string;
+type ElementDataType$1 = string;
 /**
  * Defines what type of datepicker should we use.
  * @default "dateTime"
@@ -337,19 +338,24 @@ type DatePickerMode =
 "dateTime"
 /** Pick only a date */
  | "date";
-type UiElementInputDatePicker = InputElement<ElementDataType, {
+type UiElementInputDatePicker = InputElement<ElementDataType$1, {
     mode?: DatePickerMode;
     /** Allows selecting only dates/datetimes past this given date. */
     min?: string;
     /** Allows selecting only dates/datetimes before this given date. */
     max?: string;
 }>;
-interface UiElementInputDatePickerApiResponse extends BaseUiInputResponse<"ui.input.datePicker", ElementDataType> {
+interface UiElementInputDatePickerApiResponse extends BaseUiInputResponse<"ui.input.datePicker", ElementDataType$1> {
     mode?: DatePickerMode;
     min?: string;
     max?: string;
 }
 
+type ElementDataType = Partial<FileDbRecord>;
+type UiElementInputFile = InputElement<ElementDataType, {}, File>;
+interface UiElementInputFileApiResponse extends BaseUiInputResponse<"ui.input.file", ElementDataType> {
+}
+
 type UiElementMarkdown = DisplayElement<{
     content: string;
 }>;
@@ -399,7 +405,7 @@ type ActionValue<T> = T extends string ? T : T extends {
     value: infer V;
 } ? V : never;
 type ExtractFormData<T extends UIElements> = {
-    [K in Extract<T[number], InputElementResponse<string, any>>["name"]]: Extract<T[number], InputElementResponse<K, any>>["valueType"];
+    [K in Extract<T[number], InputElementResponse<string, any>>["name"]]: Extract<T[number], InputElementResponse<K, any>>["returnType"];
 };
 
 type UiElementImage = DisplayElement<{
@@ -815,6 +821,7 @@ type UiInputsElements = {
     dataGrid: UiElementInputDataGrid;
     datePicker: UiElementInputDatePicker;
     scan: UiElementScan;
+    file: UiElementInputFile;
 };
 type UiSelectElements = {
     one: UiElementSelectOne;
@@ -837,18 +844,28 @@ type UiInteractiveElements<H extends NullableHardware> = {
     print: UiElementPrint<H>;
     pickList: UiElementPickList;
 };
-type InputElement<TValueType, TConfig extends any = never> = <N extends string>(name: N, options?: BaseInputConfig<TValueType> & TConfig) => InputElementResponse<N, TValueType>;
+type InputElement<TValueType, TConfig extends any = never, TReturnType = TValueType> = <N extends string>(name: N, options?: BaseInputConfig<TValueType> & TConfig) => InputElementResponse<N, TValueType, TReturnType>;
 type DisplayElement<TConfig extends any = never> = (options?: TConfig) => DisplayElementResponse;
 type DisplayElementWithRequiredConfig<TConfig extends any = never> = (options: TConfig) => DisplayElementResponse;
-type UIElement = InputElementResponse<string, any> | DisplayElementResponse | IteratorElementResponse<string, any>;
+type UIElement = InputElementResponse<string, any, any> | DisplayElementResponse | IteratorElementResponse<string, any>;
 type UIElements = UIElement[];
 interface UIElementBase {
     _type: string;
 }
-interface InputElementResponse<N extends string, V> extends UIElementBase {
+/**
+ * Type for the input element; name, data type, return data type
+ * InputElementResponse<"ui.input.text", string>
+ * InputElementResponse<"ui.input.file", Partial<FileDBRecord>, File>
+ */
+interface InputElementResponse<N extends string, V, RV = V> extends UIElementBase {
     _type: "input";
     name: N;
     valueType: V;
+    /**
+     * The type of the value returned from the step (page). Rich field types will operate on a json serialisable object
+     * but will return a complex type to be used in subsequent steps
+     */
+    returnType: RV;
 }
 interface DisplayElementResponse extends UIElementBase {
     _type: "display";
@@ -908,6 +925,7 @@ type UIApiResponses = {
         dataGrid: UiElementInputDataGridApiResponse;
         datePicker: UiElementInputDatePickerApiResponse;
         scan: UiElementInputScanApiResponse;
+        file: UiElementInputFileApiResponse;
     };
     select: {
         one: UiElementSelectOneApiResponse;
@@ -919,7 +937,7 @@ type UIApiResponses = {
         pickList: UiElementPickListApiResponse;
     };
 };
-type UiElementApiResponse = UiElementDividerApiResponse | UiElementMarkdownApiResponse | UiElementHeaderApiResponse | UiElementBannerApiResponse | UiElementImageApiResponse | UiElementCodeApiResponse | UiElementGridApiResponse | UiElementListApiResponse | UiElementTableApiResponse | UiElementKeyValueApiResponse | UiElementFileApiResponse | UiElementInputTextApiResponse | UiElementInputNumberApiResponse | UiElementInputBooleanApiResponse | UiElementInputDataGridApiResponse | UiElementInputScanApiResponse | UiElementInputDatePickerApiResponse | UiElementSelectOneApiResponse | UiElementSelectTableApiResponse | UiElementIteratorApiResponse | UiElementPrintApiResponse | UiElementPickListApiResponse;
+type UiElementApiResponse = UiElementDividerApiResponse | UiElementMarkdownApiResponse | UiElementHeaderApiResponse | UiElementBannerApiResponse | UiElementImageApiResponse | UiElementCodeApiResponse | UiElementGridApiResponse | UiElementListApiResponse | UiElementTableApiResponse | UiElementKeyValueApiResponse | UiElementFileApiResponse | UiElementInputTextApiResponse | UiElementInputNumberApiResponse | UiElementInputBooleanApiResponse | UiElementInputDataGridApiResponse | UiElementInputScanApiResponse | UiElementInputDatePickerApiResponse | UiElementInputFileApiResponse | UiElementSelectOneApiResponse | UiElementSelectTableApiResponse | UiElementIteratorApiResponse | UiElementPrintApiResponse | UiElementPickListApiResponse;
 type UiElementApiResponses = UiElementApiResponse[];
 
 declare class NonRetriableError extends Error {

package/dist/index.js

@@ -735,6 +735,21 @@ var File = class _File extends InlineFile {
     const url = await getSignedUrl(s3Client, command, { expiresIn: 60 * 60 });
     return new URL(url);
   }
+  // Generates a presigned upload URL. If the file doesn't have a key, a new one will be generated
+  async getPresignedUploadUrl() {
+    if (!s3Client) {
+      throw new Error("S3 client is required");
+    }
+    if (!this.key) {
+      this._key = KSUID.randomSync().string;
+    }
+    const command = new PutObjectCommand({
+      Bucket: process.env.KEEL_FILES_BUCKET_NAME,
+      Key: "files/" + this.key
+    });
+    const url = await getSignedUrl(s3Client, command, { expiresIn: 60 * 60 });
+    return new URL(url);
+  }
   // Persists the file
   toDbRecord() {
     return {
@@ -2865,6 +2880,31 @@ var datePickerInput = /* @__PURE__ */ __name((name, options) => {
   };
 }, "datePickerInput");
 
+// src/flows/ui/elements/input/file.ts
+var fileInput = /* @__PURE__ */ __name((name, options) => {
+  return {
+    __type: "input",
+    uiConfig: {
+      __type: "ui.input.file",
+      name,
+      label: options?.label || name,
+      optional: options?.optional || false,
+      disabled: options?.disabled || false,
+      helpText: options?.helpText
+    },
+    validate: options?.validate,
+    getData: /* @__PURE__ */ __name((x) => x, "getData"),
+    getPresignedUploadURL: /* @__PURE__ */ __name((async (input) => {
+      const file2 = new File(input);
+      const url = await file2.getPresignedUploadUrl();
+      return {
+        url: url.toString(),
+        key: file2.key
+      };
+    }), "getPresignedUploadURL")
+  };
+}, "fileInput");
+
 // src/flows/ui/elements/iterator.ts
 var iterator = /* @__PURE__ */ __name((name, options) => {
   return {
@@ -3183,10 +3223,11 @@ function createFlowContext(runId, data, action, callback, element, spanId, ctx)
           let step = await db.selectFrom("keel.flow_step").where("run_id", "=", runId).where("name", "=", name).selectAll().executeTakeFirst();
           if (step && step.status === "COMPLETED" /* COMPLETED */) {
             span.setAttribute(KEEL_INTERNAL_ATTR, KEEL_INTERNAL_CHILDREN);
+            const parsedData2 = transformRichDataTypes(step.value);
             if (step.action) {
-              return { data: step.value, action: step.action };
+              return { data: parsedData2, action: step.action };
             }
-            return step.value;
+            return parsedData2;
           }
           if (!step) {
             step = await db.insertInto("keel.flow_step").values({
@@ -3253,10 +3294,11 @@ function createFlowContext(runId, data, action, callback, element, spanId, ctx)
             spanId,
             endTime: /* @__PURE__ */ new Date()
           }).where("id", "=", step.id).returningAll().executeTakeFirst();
+          const parsedData = transformRichDataTypes(data);
           if (action) {
-            return { data, action };
+            return { data: parsedData, action };
           }
-          return data;
+          return parsedData;
         });
       }), "page"),
       inputs: {
@@ -3265,7 +3307,8 @@ function createFlowContext(runId, data, action, callback, element, spanId, ctx)
         boolean: booleanInput,
         dataGrid: dataGridInput,
         datePicker: datePickerInput,
-        scan
+        scan,
+        file: fileInput
       },
       display: {
         divider,