@teamkeel/functions-runtime 0.414.3 → 0.414.5

package/dist/index.d.cts

@@ -335,9 +335,13 @@ type TableData<T extends Record<string, any>> = {
     columns?: Array<Extract<keyof T, string>>;
 };
 type UiElementTable = <const T extends Record<string, any>>(options: TableData<T>) => DisplayElementResponse;
+type TableColumn = {
+    name: string;
+    index: number;
+};
 interface UiElementTableApiResponse extends BaseUiDisplayResponse<"ui.display.table"> {
     data: any[];
-    columns?: string[];
+    columns: TableColumn[];
 }
 
 type UiElementDivider = DisplayElement<{}>;
@@ -464,6 +468,82 @@ interface UiElementListApiResponse extends BaseUiDisplayResponse<"ui.display.lis
     data: ListItem[];
 }
 
+type KeyValueMode = "list" | "grid" | "card";
+type KeyValueData = {
+    key: string;
+    value: string | number | Date | boolean;
+};
+type UiElementKeyValue = DisplayElement<{
+    data: KeyValueData[];
+    mode?: KeyValueMode;
+}>;
+interface UiElementKeyValueApiResponse extends BaseUiDisplayResponse<"ui.display.keyValue"> {
+    data: KeyValueData[];
+    mode: KeyValueMode;
+}
+
+type CompleteOptions<C extends FlowConfig> = {
+    stage?: ExtractStageKeys<C>;
+    title?: string;
+    description?: string;
+    /** Automatically close the flow once complete.
+     * If set, the title and description will be shown in a notification.
+     * If set, you cannot return content as this will not be shown. */
+    autoClose?: boolean;
+    data?: any;
+} & ({
+    autoClose: true;
+    content?: never;
+} | {
+    autoClose?: false;
+    content?: DisplayElementResponse[];
+});
+type Complete<C extends FlowConfig> = (options: CompleteOptions<C>) => CompleteOptions<C> & {
+    __type: "ui.complete";
+};
+
+type SelectMode = "single" | "multi";
+type UiElementSelectTable = <const T extends Record<string, any>, N extends string, const M extends SelectMode = "multi">(name: N, options: TableOptions<T, M>) => InputElementResponse<N, M extends "single" ? T : T[]>;
+type TableOptions<T extends Record<string, any>, M extends SelectMode = "multi"> = Omit<BaseInputConfig<T>, "defaultValue" | "label"> & TableData<T> & {
+    mode?: M;
+};
+interface UiElementSelectTableApiResponse extends Omit<BaseUiInputResponse<"ui.select.table", any>, "defaultValue" | "label"> {
+    data: any[];
+    columns: TableColumn[];
+    mode: SelectMode;
+}
+
+type UiElementInputDataGrid = <N extends string, T extends Record<string, any>, const Cols extends Extract<keyof T, string>[], C extends ColumnConfig<Cols>[] | undefined = undefined>(name: N, options: DataGridOptions<T, C>) => InputElementResponse<N, C extends ColumnConfig<Cols>[] ? {
+    [K in C[number] as K["key"]]: MapDataType<K["type"], T[K["key"]]>;
+}[] : T[]>;
+type MapDataType<U, Fallback> = U extends "text" ? string : U extends "number" ? number : U extends "boolean" ? boolean : U extends "id" ? string : U extends "hidden" ? Fallback : Fallback;
+type ColumnConfig<Cols extends string[]> = {
+    key: Cols[number];
+    label?: string;
+    type?: DataGridDataTypes;
+    editable?: boolean;
+};
+type DataGridOptions<T extends Record<string, any>, C> = Omit<BaseInputConfig<T>, "defaultValue" | "label" | "optional" | "disabled"> & {
+    data: T[];
+    columns?: C;
+    allowAddRows?: boolean;
+    allowDeleteRows?: boolean;
+};
+interface UiElementInputDataGridApiResponse extends Omit<BaseUiInputResponse<"ui.input.dataGrid", any>, "defaultValue" | "label" | "optional" | "disabled"> {
+    data: any[];
+    columns: DataGridColumn[];
+    allowAddRows: boolean;
+    allowDeleteRows: boolean;
+}
+type DataGridDataTypes = "text" | "number" | "boolean" | "id" | "hidden";
+type DataGridColumn = {
+    key: string;
+    label: string;
+    index: number;
+    type: DataGridDataTypes;
+    editable: boolean;
+};
+
 interface UI<C extends FlowConfig> {
     page: UiPage<C>;
     display: UiDisplayElements;
@@ -474,9 +554,11 @@ type UiInputsElements = {
     text: UiElementInputText;
     number: UiElementInputNumber;
     boolean: UiElementInputBoolean;
+    dataGrid: UiElementInputDataGrid;
 };
 type UiSelectElements = {
     one: UiElementSelectOne;
+    table: UiElementSelectTable;
 };
 type UiDisplayElements = {
     divider: UiElementDivider;
@@ -488,6 +570,7 @@ type UiDisplayElements = {
     grid: UiElementGrid;
     list: UiElementList;
     table: UiElementTable;
+    keyValue: UiElementKeyValue;
 };
 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;
@@ -535,26 +618,20 @@ type UIApiResponses = {
         grid: UiElementGridApiResponse;
         list: UiElementListApiResponse;
         table: UiElementTableApiResponse;
+        keyValue: UiElementKeyValueApiResponse;
     };
     input: {
         text: UiElementInputTextApiResponse;
         number: UiElementInputNumberApiResponse;
         boolean: UiElementInputBooleanApiResponse;
+        dataGrid: UiElementInputDataGridApiResponse;
     };
     select: {
         one: UiElementSelectOneApiResponse;
+        table: UiElementSelectTableApiResponse;
     };
 };
 
-type CompleteOptions<C extends FlowConfig> = {
-    stage?: ExtractStageKeys<C>;
-    title?: string;
-    description?: string;
-    content: DisplayElementResponse[];
-    data?: any;
-};
-type Complete<C extends FlowConfig> = (options: CompleteOptions<C>) => CompleteOptions<C>;
-
 declare const enum STEP_STATUS {
     NEW = "NEW",
     RUNNING = "RUNNING",

package/dist/index.d.ts

@@ -335,9 +335,13 @@ type TableData<T extends Record<string, any>> = {
     columns?: Array<Extract<keyof T, string>>;
 };
 type UiElementTable = <const T extends Record<string, any>>(options: TableData<T>) => DisplayElementResponse;
+type TableColumn = {
+    name: string;
+    index: number;
+};
 interface UiElementTableApiResponse extends BaseUiDisplayResponse<"ui.display.table"> {
     data: any[];
-    columns?: string[];
+    columns: TableColumn[];
 }
 
 type UiElementDivider = DisplayElement<{}>;
@@ -464,6 +468,82 @@ interface UiElementListApiResponse extends BaseUiDisplayResponse<"ui.display.lis
     data: ListItem[];
 }
 
+type KeyValueMode = "list" | "grid" | "card";
+type KeyValueData = {
+    key: string;
+    value: string | number | Date | boolean;
+};
+type UiElementKeyValue = DisplayElement<{
+    data: KeyValueData[];
+    mode?: KeyValueMode;
+}>;
+interface UiElementKeyValueApiResponse extends BaseUiDisplayResponse<"ui.display.keyValue"> {
+    data: KeyValueData[];
+    mode: KeyValueMode;
+}
+
+type CompleteOptions<C extends FlowConfig> = {
+    stage?: ExtractStageKeys<C>;
+    title?: string;
+    description?: string;
+    /** Automatically close the flow once complete.
+     * If set, the title and description will be shown in a notification.
+     * If set, you cannot return content as this will not be shown. */
+    autoClose?: boolean;
+    data?: any;
+} & ({
+    autoClose: true;
+    content?: never;
+} | {
+    autoClose?: false;
+    content?: DisplayElementResponse[];
+});
+type Complete<C extends FlowConfig> = (options: CompleteOptions<C>) => CompleteOptions<C> & {
+    __type: "ui.complete";
+};
+
+type SelectMode = "single" | "multi";
+type UiElementSelectTable = <const T extends Record<string, any>, N extends string, const M extends SelectMode = "multi">(name: N, options: TableOptions<T, M>) => InputElementResponse<N, M extends "single" ? T : T[]>;
+type TableOptions<T extends Record<string, any>, M extends SelectMode = "multi"> = Omit<BaseInputConfig<T>, "defaultValue" | "label"> & TableData<T> & {
+    mode?: M;
+};
+interface UiElementSelectTableApiResponse extends Omit<BaseUiInputResponse<"ui.select.table", any>, "defaultValue" | "label"> {
+    data: any[];
+    columns: TableColumn[];
+    mode: SelectMode;
+}
+
+type UiElementInputDataGrid = <N extends string, T extends Record<string, any>, const Cols extends Extract<keyof T, string>[], C extends ColumnConfig<Cols>[] | undefined = undefined>(name: N, options: DataGridOptions<T, C>) => InputElementResponse<N, C extends ColumnConfig<Cols>[] ? {
+    [K in C[number] as K["key"]]: MapDataType<K["type"], T[K["key"]]>;
+}[] : T[]>;
+type MapDataType<U, Fallback> = U extends "text" ? string : U extends "number" ? number : U extends "boolean" ? boolean : U extends "id" ? string : U extends "hidden" ? Fallback : Fallback;
+type ColumnConfig<Cols extends string[]> = {
+    key: Cols[number];
+    label?: string;
+    type?: DataGridDataTypes;
+    editable?: boolean;
+};
+type DataGridOptions<T extends Record<string, any>, C> = Omit<BaseInputConfig<T>, "defaultValue" | "label" | "optional" | "disabled"> & {
+    data: T[];
+    columns?: C;
+    allowAddRows?: boolean;
+    allowDeleteRows?: boolean;
+};
+interface UiElementInputDataGridApiResponse extends Omit<BaseUiInputResponse<"ui.input.dataGrid", any>, "defaultValue" | "label" | "optional" | "disabled"> {
+    data: any[];
+    columns: DataGridColumn[];
+    allowAddRows: boolean;
+    allowDeleteRows: boolean;
+}
+type DataGridDataTypes = "text" | "number" | "boolean" | "id" | "hidden";
+type DataGridColumn = {
+    key: string;
+    label: string;
+    index: number;
+    type: DataGridDataTypes;
+    editable: boolean;
+};
+
 interface UI<C extends FlowConfig> {
     page: UiPage<C>;
     display: UiDisplayElements;
@@ -474,9 +554,11 @@ type UiInputsElements = {
     text: UiElementInputText;
     number: UiElementInputNumber;
     boolean: UiElementInputBoolean;
+    dataGrid: UiElementInputDataGrid;
 };
 type UiSelectElements = {
     one: UiElementSelectOne;
+    table: UiElementSelectTable;
 };
 type UiDisplayElements = {
     divider: UiElementDivider;
@@ -488,6 +570,7 @@ type UiDisplayElements = {
     grid: UiElementGrid;
     list: UiElementList;
     table: UiElementTable;
+    keyValue: UiElementKeyValue;
 };
 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;
@@ -535,26 +618,20 @@ type UIApiResponses = {
         grid: UiElementGridApiResponse;
         list: UiElementListApiResponse;
         table: UiElementTableApiResponse;
+        keyValue: UiElementKeyValueApiResponse;
     };
     input: {
         text: UiElementInputTextApiResponse;
         number: UiElementInputNumberApiResponse;
         boolean: UiElementInputBooleanApiResponse;
+        dataGrid: UiElementInputDataGridApiResponse;
     };
     select: {
         one: UiElementSelectOneApiResponse;
+        table: UiElementSelectTableApiResponse;
     };
 };
 
-type CompleteOptions<C extends FlowConfig> = {
-    stage?: ExtractStageKeys<C>;
-    title?: string;
-    description?: string;
-    content: DisplayElementResponse[];
-    data?: any;
-};
-type Complete<C extends FlowConfig> = (options: CompleteOptions<C>) => CompleteOptions<C>;
-
 declare const enum STEP_STATUS {
     NEW = "NEW",
     RUNNING = "RUNNING",

package/dist/index.js

@@ -2395,20 +2395,30 @@ var markdown = /* @__PURE__ */ __name((options) => {
 
 // src/flows/ui/elements/display/table.ts
 var table = /* @__PURE__ */ __name((options) => {
-  const filteredData = options.columns ? options.data.map((item) => {
-    return Object.fromEntries(
-      Object.entries(item).filter(
-        ([key]) => options.columns?.includes(key)
-      )
-    );
-  }) : options.data;
+  const { data, columns } = processTableData(options.data, options.columns);
   return {
     uiConfig: {
       __type: "ui.display.table",
-      data: filteredData || []
+      data: data || [],
+      columns: columns || []
     }
   };
 }, "table");
+var processTableData = /* @__PURE__ */ __name((data, columnsConfig) => {
+  const filteredData = columnsConfig ? data.map((item) => {
+    return Object.fromEntries(
+      Object.entries(item).filter(
+        ([key]) => columnsConfig?.includes(key)
+      )
+    );
+  }) : data;
+  const cols = Object.keys(filteredData[0] || {});
+  const columns = cols.map((column, index) => ({
+    name: column,
+    index
+  }));
+  return { data: filteredData, columns };
+}, "processTableData");
 
 // src/flows/ui/elements/select/one.ts
 var selectOne = /* @__PURE__ */ __name((name, options) => {
@@ -2433,24 +2443,28 @@ var selectOne = /* @__PURE__ */ __name((name, options) => {
 async function page(options, data, action) {
   const content = options.content;
   let hasValidationErrors = false;
-  if (options.actions) {
+  let validationError;
+  if (options.actions && action !== null) {
     const isValidAction = options.actions.some((a) => {
       if (typeof a === "string") return a === action;
       return a && typeof a === "object" && "value" in a && a.value === action;
     });
-    hasValidationErrors = !isValidAction;
+    if (!isValidAction) {
+      hasValidationErrors = true;
+      validationError = "invalid action";
+    }
   }
   const contentUiConfig = await Promise.all(
     content.map(async (c) => {
       const isInput = "__type" in c && c.__type == "input";
       const hasData = data && c.uiConfig.name in data;
       if (isInput && hasData && c.validate) {
-        const validationError = await c.validate(data[c.uiConfig.name]);
-        if (typeof validationError === "string") {
+        const validationError2 = await c.validate(data[c.uiConfig.name]);
+        if (typeof validationError2 === "string") {
           hasValidationErrors = true;
           return {
             ...c.uiConfig,
-            validationError
+            validationError: validationError2
           };
         }
       }
@@ -2471,7 +2485,9 @@ async function page(options, data, action) {
           a.mode = a.mode || "primary";
         }
         return a;
-      })
+      }),
+      hasValidationErrors,
+      validationError
     },
     hasValidationErrors
   };
@@ -2595,6 +2611,90 @@ var header = /* @__PURE__ */ __name((options) => {
   };
 }, "header");
 
+// src/flows/ui/elements/display/keyValue.ts
+var keyValue = /* @__PURE__ */ __name((options) => {
+  return {
+    uiConfig: {
+      __type: "ui.display.keyValue",
+      data: options?.data || [],
+      mode: options?.mode || "list"
+    }
+  };
+}, "keyValue");
+
+// src/flows/ui/elements/select/table.ts
+var selectTable = /* @__PURE__ */ __name((name, options) => {
+  const { data, columns } = processTableData(options.data, options.columns);
+  return {
+    __type: "input",
+    uiConfig: {
+      __type: "ui.select.table",
+      name,
+      data,
+      columns,
+      mode: options?.mode || "multi",
+      optional: options?.optional || false,
+      disabled: options?.disabled || false,
+      helpText: options?.helpText
+    },
+    validate: options?.validate,
+    getData: /* @__PURE__ */ __name((x) => x, "getData")
+  };
+}, "selectTable");
+
+// src/flows/ui/elements/input/dataGrid.ts
+import { sentenceCase } from "change-case";
+var dataGridInput = /* @__PURE__ */ __name((name, options) => {
+  const { data } = processTableData(
+    options.data,
+    options.columns?.map((c) => c.key)
+  );
+  const inferType = /* @__PURE__ */ __name((key) => {
+    const inferredTypeRaw = typeof data[0][key];
+    const inferredTypeMap = {
+      string: "text",
+      number: "number",
+      boolean: "boolean",
+      bigint: "number",
+      symbol: "text",
+      undefined: "text",
+      object: "text",
+      function: "text"
+    };
+    return inferredTypeMap[inferredTypeRaw] ?? "text";
+  }, "inferType");
+  const columns = options.columns ? options.columns?.map((column, idx) => ({
+    key: column.key,
+    label: column.label || column.key,
+    index: idx,
+    type: column.type || inferType(column.key),
+    editable: column.editable === void 0 ? column.type === "id" ? false : true : column.editable
+  })) : Object.keys(data[0]).map((key, idx) => {
+    return {
+      index: idx,
+      key,
+      label: sentenceCase(key),
+      type: inferType(key),
+      editable: true
+    };
+  });
+  return {
+    __type: "input",
+    uiConfig: {
+      __type: "ui.input.dataGrid",
+      name,
+      data,
+      columns,
+      helpText: options?.helpText,
+      allowAddRows: options?.allowAddRows ?? false,
+      allowDeleteRows: options?.allowDeleteRows ?? false
+    },
+    validate: options?.validate,
+    // TODO have some built in validation that checks the types of the response
+    getData: /* @__PURE__ */ __name((x) => x, "getData")
+  };
+}, "dataGridInput");
+
 // src/flows/index.ts
 var STEP_STATUS = /* @__PURE__ */ ((STEP_STATUS2) => {
   STEP_STATUS2["NEW"] = "NEW";
@@ -2622,7 +2722,12 @@ function createFlowContext(runId, data, action, spanId, ctx) {
     env: ctx.env,
     now: ctx.now,
     secrets: ctx.secrets,
-    complete: /* @__PURE__ */ __name((options) => options, "complete"),
+    complete: /* @__PURE__ */ __name((options) => {
+      return {
+        __type: "ui.complete",
+        ...options
+      };
+    }, "complete"),
     step: /* @__PURE__ */ __name(async (name, optionsOrFn, fn) => {
       const options = typeof optionsOrFn === "function" ? {} : optionsOrFn;
       const actualFn = typeof optionsOrFn === "function" ? optionsOrFn : fn;
@@ -2769,7 +2874,8 @@ function createFlowContext(runId, data, action, spanId, ctx) {
       inputs: {
         text: textInput,
         number: numberInput,
-        boolean: booleanInput
+        boolean: booleanInput,
+        dataGrid: dataGridInput
       },
       display: {
         divider,
@@ -2780,10 +2886,12 @@ function createFlowContext(runId, data, action, spanId, ctx) {
         image,
         code,
         grid,
-        list
+        list,
+        keyValue
       },
       select: {
-        one: selectOne
+        one: selectOne,
+        table: selectTable
       }
     }
   };
@@ -2805,26 +2913,25 @@ __name(withTimeout, "withTimeout");
 
 // src/flows/ui/complete.ts
 async function complete(options) {
-  const content = options.content;
+  const content = options.content || [];
   const contentUiConfig = await Promise.all(
     content.map(async (c) => {
       return c.uiConfig;
     })
   );
   return {
-    complete: {
-      __type: "ui.complete",
-      stage: options.stage,
-      title: options.title,
-      description: options.description,
-      content: contentUiConfig
-    }
+    __type: "ui.complete",
+    stage: options.stage,
+    title: options.title,
+    description: options.description,
+    content: contentUiConfig || [],
+    autoClose: options.autoClose
   };
 }
 __name(complete, "complete");
 
 // src/handleFlow.ts
-import { sentenceCase } from "change-case";
+import { sentenceCase as sentenceCase2 } from "change-case";
 async function handleFlow(request, config) {
   const activeContext = opentelemetry6.propagation.extract(
     opentelemetry6.context.active(),
@@ -2868,7 +2975,7 @@ async function handleFlow(request, config) {
         const rawFlowConfig = flows[request.method].config;
         flowConfig = {
           ...rawFlowConfig,
-          title: rawFlowConfig.title || sentenceCase(request.method || "flow"),
+          title: rawFlowConfig.title || sentenceCase2(request.method || "flow"),
           stages: rawFlowConfig.stages?.map((stage) => {
             if (typeof stage === "string") {
               return {
@@ -2923,7 +3030,8 @@ async function handleFlow(request, config) {
         }
         let ui = null;
         let data = null;
-        if (response && typeof response == "object" && "content" in response) {
+        if (response && typeof response == "object" && "__type" in response && response.__type === "ui.complete") {
+          ui = await complete(response);
           const completeStep = await db.selectFrom("keel.flow_step").where("run_id", "=", runId).where("type", "=", "COMPLETE" /* COMPLETE */).selectAll().executeTakeFirst();
           if (!completeStep) {
             await db.insertInto("keel.flow_step").values({
@@ -2933,10 +3041,10 @@ async function handleFlow(request, config) {
               status: "COMPLETED" /* COMPLETED */,
               type: "COMPLETE" /* COMPLETE */,
               startTime: /* @__PURE__ */ new Date(),
-              endTime: /* @__PURE__ */ new Date()
+              endTime: /* @__PURE__ */ new Date(),
+              ui: JSON.stringify(ui)
             }).returningAll().executeTakeFirst();
           }
-          ui = (await complete(response)).complete;
           data = response.data;
         } else if (response) {
           data = response;
@@ -2945,8 +3053,7 @@ async function handleFlow(request, config) {
           runId,
           runCompleted: true,
           data,
-          config: flowConfig,
-          ui
+          config: flowConfig
         });
       } catch (e) {
         if (e instanceof Error) {