@teamkeel/functions-runtime 0.414.1 → 0.414.2

package/dist/index.d.cts

@@ -546,12 +546,36 @@ type UIApiResponses = {
     };
 };
 
-interface FlowContext<C extends FlowConfig, E = any, S = any> {
+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",
+    PENDING = "PENDING",
+    COMPLETED = "COMPLETED",
+    FAILED = "FAILED"
+}
+declare const enum STEP_TYPE {
+    FUNCTION = "FUNCTION",
+    UI = "UI",
+    DELAY = "DELAY",
+    COMPLETE = "COMPLETE"
+}
+interface FlowContext<C extends FlowConfig, E = any, S = any, Id = any> {
     step: Step<C>;
     ui: UI<C>;
+    complete: Complete<C>;
     env: E;
     now: Date;
     secrets: S;
+    identity: Id;
 }
 type JsonSerializable = string | number | boolean | null | JsonSerializable[] | {
     [key: string]: JsonSerializable;
@@ -590,7 +614,7 @@ interface FlowConfigAPI {
     title: string;
     description?: string;
 }
-type FlowFunction<C extends FlowConfig, E extends any = {}, S extends any = {}, I extends any = {}> = (ctx: FlowContext<C, E, S>, inputs: I) => Promise<void>;
+type FlowFunction<C extends FlowConfig, E extends any = {}, S extends any = {}, Id extends any = {}, I extends any = {}> = (ctx: FlowContext<C, E, S, Id>, inputs: I) => Promise<CompleteOptions<C> | any | void>;
 type ExtractStageKeys<T extends FlowConfig> = T extends {
     stages: infer S;
 } ? S extends ReadonlyArray<infer U> ? U extends string ? U : U extends {
@@ -607,11 +631,12 @@ type StageConfigObject = {
     initiallyHidden?: boolean;
 };
 type StageConfig = string | StageConfigObject;
-declare function createFlowContext<C extends FlowConfig, E = any, S = any>(runId: string, data: any, action: string | null, spanId: string, ctx: {
+declare function createFlowContext<C extends FlowConfig, E = any, S = any, I = any>(runId: string, data: any, action: string | null, spanId: string, ctx: {
     env: E;
     now: Date;
     secrets: S;
-}): FlowContext<C, E, S>;
+    identity: I;
+}): FlowContext<C, E, S, I>;
 
 declare function ksuid(): string;
 
@@ -781,4 +806,4 @@ type dateDuration = `${number}Y${number}M${number}D` | `${number}Y${number}M` |
 type timeDuration = `${number}H${number}M${number}S` | `${number}H${number}M` | `${number}M${number}S` | `${number}H${number}S` | `${number}H` | `${number}M` | `${number}S`;
 type DurationString = `P${dateDuration}T${timeDuration}` | `P${dateDuration}` | `PT${timeDuration}`;
 
-export { type BooleanArrayQueryWhereCondition, type BooleanArrayWhereCondition, type BooleanWhereCondition, type ContextAPI, type DateArrayQueryWhereCondition, type DateArrayWhereCondition, type DateQueryInput, type DateWhereCondition, Duration, type DurationString, type DurationWhereCondition, ErrorPresets, type Errors, type ExtractStageKeys, File, type FlowConfig, type FlowConfigAPI, type FlowContext, type FlowFunction, type FuncWithConfig, type FunctionConfig, type IDWhereCondition, InlineFile, ModelAPI, type NumberArrayQueryWhereCondition, type NumberArrayWhereCondition, type NumberWhereCondition, PERMISSION_STATE, type PageInfo, Permissions, type RelativeDateString, RequestHeaders, type Response, type SortDirection, type Step, type StringArrayQueryWhereCondition, type StringArrayWhereCondition, type StringWhereCondition, type TimestampQueryInput, type UI, type UIApiResponses, checkBuiltInPermissions, createFlowContext, handleFlow, handleJob, handleRequest, handleRoute, handleSubscriber, ksuid, tracing, useDatabase };
+export { type BooleanArrayQueryWhereCondition, type BooleanArrayWhereCondition, type BooleanWhereCondition, type ContextAPI, type DateArrayQueryWhereCondition, type DateArrayWhereCondition, type DateQueryInput, type DateWhereCondition, Duration, type DurationString, type DurationWhereCondition, ErrorPresets, type Errors, type ExtractStageKeys, File, type FlowConfig, type FlowConfigAPI, type FlowContext, type FlowFunction, type FuncWithConfig, type FunctionConfig, type IDWhereCondition, InlineFile, ModelAPI, type NumberArrayQueryWhereCondition, type NumberArrayWhereCondition, type NumberWhereCondition, PERMISSION_STATE, type PageInfo, Permissions, type RelativeDateString, RequestHeaders, type Response, STEP_STATUS, STEP_TYPE, type SortDirection, type Step, type StringArrayQueryWhereCondition, type StringArrayWhereCondition, type StringWhereCondition, type TimestampQueryInput, type UI, type UIApiResponses, checkBuiltInPermissions, createFlowContext, handleFlow, handleJob, handleRequest, handleRoute, handleSubscriber, ksuid, tracing, useDatabase };

package/dist/index.d.ts

@@ -546,12 +546,36 @@ type UIApiResponses = {
     };
 };
 
-interface FlowContext<C extends FlowConfig, E = any, S = any> {
+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",
+    PENDING = "PENDING",
+    COMPLETED = "COMPLETED",
+    FAILED = "FAILED"
+}
+declare const enum STEP_TYPE {
+    FUNCTION = "FUNCTION",
+    UI = "UI",
+    DELAY = "DELAY",
+    COMPLETE = "COMPLETE"
+}
+interface FlowContext<C extends FlowConfig, E = any, S = any, Id = any> {
     step: Step<C>;
     ui: UI<C>;
+    complete: Complete<C>;
     env: E;
     now: Date;
     secrets: S;
+    identity: Id;
 }
 type JsonSerializable = string | number | boolean | null | JsonSerializable[] | {
     [key: string]: JsonSerializable;
@@ -590,7 +614,7 @@ interface FlowConfigAPI {
     title: string;
     description?: string;
 }
-type FlowFunction<C extends FlowConfig, E extends any = {}, S extends any = {}, I extends any = {}> = (ctx: FlowContext<C, E, S>, inputs: I) => Promise<void>;
+type FlowFunction<C extends FlowConfig, E extends any = {}, S extends any = {}, Id extends any = {}, I extends any = {}> = (ctx: FlowContext<C, E, S, Id>, inputs: I) => Promise<CompleteOptions<C> | any | void>;
 type ExtractStageKeys<T extends FlowConfig> = T extends {
     stages: infer S;
 } ? S extends ReadonlyArray<infer U> ? U extends string ? U : U extends {
@@ -607,11 +631,12 @@ type StageConfigObject = {
     initiallyHidden?: boolean;
 };
 type StageConfig = string | StageConfigObject;
-declare function createFlowContext<C extends FlowConfig, E = any, S = any>(runId: string, data: any, action: string | null, spanId: string, ctx: {
+declare function createFlowContext<C extends FlowConfig, E = any, S = any, I = any>(runId: string, data: any, action: string | null, spanId: string, ctx: {
     env: E;
     now: Date;
     secrets: S;
-}): FlowContext<C, E, S>;
+    identity: I;
+}): FlowContext<C, E, S, I>;
 
 declare function ksuid(): string;
 
@@ -781,4 +806,4 @@ type dateDuration = `${number}Y${number}M${number}D` | `${number}Y${number}M` |
 type timeDuration = `${number}H${number}M${number}S` | `${number}H${number}M` | `${number}M${number}S` | `${number}H${number}S` | `${number}H` | `${number}M` | `${number}S`;
 type DurationString = `P${dateDuration}T${timeDuration}` | `P${dateDuration}` | `PT${timeDuration}`;
 
-export { type BooleanArrayQueryWhereCondition, type BooleanArrayWhereCondition, type BooleanWhereCondition, type ContextAPI, type DateArrayQueryWhereCondition, type DateArrayWhereCondition, type DateQueryInput, type DateWhereCondition, Duration, type DurationString, type DurationWhereCondition, ErrorPresets, type Errors, type ExtractStageKeys, File, type FlowConfig, type FlowConfigAPI, type FlowContext, type FlowFunction, type FuncWithConfig, type FunctionConfig, type IDWhereCondition, InlineFile, ModelAPI, type NumberArrayQueryWhereCondition, type NumberArrayWhereCondition, type NumberWhereCondition, PERMISSION_STATE, type PageInfo, Permissions, type RelativeDateString, RequestHeaders, type Response, type SortDirection, type Step, type StringArrayQueryWhereCondition, type StringArrayWhereCondition, type StringWhereCondition, type TimestampQueryInput, type UI, type UIApiResponses, checkBuiltInPermissions, createFlowContext, handleFlow, handleJob, handleRequest, handleRoute, handleSubscriber, ksuid, tracing, useDatabase };
+export { type BooleanArrayQueryWhereCondition, type BooleanArrayWhereCondition, type BooleanWhereCondition, type ContextAPI, type DateArrayQueryWhereCondition, type DateArrayWhereCondition, type DateQueryInput, type DateWhereCondition, Duration, type DurationString, type DurationWhereCondition, ErrorPresets, type Errors, type ExtractStageKeys, File, type FlowConfig, type FlowConfigAPI, type FlowContext, type FlowFunction, type FuncWithConfig, type FunctionConfig, type IDWhereCondition, InlineFile, ModelAPI, type NumberArrayQueryWhereCondition, type NumberArrayWhereCondition, type NumberWhereCondition, PERMISSION_STATE, type PageInfo, Permissions, type RelativeDateString, RequestHeaders, type Response, STEP_STATUS, STEP_TYPE, type SortDirection, type Step, type StringArrayQueryWhereCondition, type StringArrayWhereCondition, type StringWhereCondition, type TimestampQueryInput, type UI, type UIApiResponses, checkBuiltInPermissions, createFlowContext, handleFlow, handleJob, handleRequest, handleRoute, handleSubscriber, ksuid, tracing, useDatabase };

package/dist/index.js

@@ -1075,11 +1075,11 @@ var TimePeriod = class _TimePeriod {
   static {
     __name(this, "TimePeriod");
   }
-  constructor(period = "", value = 0, offset = 0, complete = false) {
+  constructor(period = "", value = 0, offset = 0, complete2 = false) {
     this.period = period;
     this.value = value;
     this.offset = offset;
-    this.complete = complete;
+    this.complete = complete2;
   }
   static fromExpression(expression) {
     const pattern = /^(this|next|last)?\s*(\d+)?\s*(complete)?\s*(second|minute|hour|day|week|month|year|seconds|minutes|hours|days|weeks|months|years)?$/i;
@@ -1105,15 +1105,15 @@ var TimePeriod = class _TimePeriod {
     const [, direction, rawValue, isComplete, rawPeriod] = match;
     let period = rawPeriod ? rawPeriod.toLowerCase().replace(/s$/, "") : "";
     let value = rawValue ? parseInt(rawValue, 10) : 1;
-    let complete = Boolean(isComplete);
+    let complete2 = Boolean(isComplete);
     let offset = 0;
     switch (direction?.toLowerCase()) {
       case "this":
         offset = 0;
-        complete = true;
+        complete2 = true;
         break;
       case "next":
-        offset = complete ? 1 : 0;
+        offset = complete2 ? 1 : 0;
         break;
       case "last":
         offset = -value;
@@ -1123,7 +1123,7 @@ var TimePeriod = class _TimePeriod {
           "Time period expression must start with this, next, or last"
         );
     }
-    return new _TimePeriod(period, value, offset, complete);
+    return new _TimePeriod(period, value, offset, complete2);
   }
   periodStartSQL() {
     let sql4 = "NOW()";
@@ -2596,6 +2596,21 @@ var header = /* @__PURE__ */ __name((options) => {
 }, "header");
 
 // src/flows/index.ts
+var STEP_STATUS = /* @__PURE__ */ ((STEP_STATUS2) => {
+  STEP_STATUS2["NEW"] = "NEW";
+  STEP_STATUS2["RUNNING"] = "RUNNING";
+  STEP_STATUS2["PENDING"] = "PENDING";
+  STEP_STATUS2["COMPLETED"] = "COMPLETED";
+  STEP_STATUS2["FAILED"] = "FAILED";
+  return STEP_STATUS2;
+})(STEP_STATUS || {});
+var STEP_TYPE = /* @__PURE__ */ ((STEP_TYPE2) => {
+  STEP_TYPE2["FUNCTION"] = "FUNCTION";
+  STEP_TYPE2["UI"] = "UI";
+  STEP_TYPE2["DELAY"] = "DELAY";
+  STEP_TYPE2["COMPLETE"] = "COMPLETE";
+  return STEP_TYPE2;
+})(STEP_TYPE || {});
 var defaultOpts = {
   retries: 5,
   timeout: 6e4
@@ -2603,9 +2618,11 @@ var defaultOpts = {
 function createFlowContext(runId, data, action, spanId, ctx) {
   const usedNames = /* @__PURE__ */ new Set();
   return {
+    identity: ctx.identity,
     env: ctx.env,
     now: ctx.now,
     secrets: ctx.secrets,
+    complete: /* @__PURE__ */ __name((options) => options, "complete"),
     step: /* @__PURE__ */ __name(async (name, optionsOrFn, fn) => {
       const options = typeof optionsOrFn === "function" ? {} : optionsOrFn;
       const actualFn = typeof optionsOrFn === "function" ? optionsOrFn : fn;
@@ -2786,6 +2803,26 @@ function withTimeout(promiseFn, timeout) {
 }
 __name(withTimeout, "withTimeout");
 
+// src/flows/ui/complete.ts
+async function complete(options) {
+  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
+    }
+  };
+}
+__name(complete, "complete");
+
 // src/handleFlow.ts
 import { sentenceCase } from "change-case";
 async function handleFlow(request, config) {
@@ -2843,8 +2880,9 @@ async function handleFlow(request, config) {
           })
         };
         const inputs = parseInputs(request.meta?.inputs);
+        let response = void 0;
         try {
-          await tryExecuteFlow(db, async () => {
+          response = await tryExecuteFlow(db, async () => {
             return flowFunction(ctx, inputs);
           });
         } catch (e) {
@@ -2883,10 +2921,32 @@ async function handleFlow(request, config) {
             config: flowConfig
           });
         }
+        let ui = null;
+        let data = null;
+        if (response && typeof response == "object" && "content" in 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({
+              run_id: runId,
+              name: "",
+              stage: response.stage,
+              status: "COMPLETED" /* COMPLETED */,
+              type: "COMPLETE" /* COMPLETE */,
+              startTime: /* @__PURE__ */ new Date(),
+              endTime: /* @__PURE__ */ new Date()
+            }).returningAll().executeTakeFirst();
+          }
+          ui = (await complete(response)).complete;
+          data = response.data;
+        } else if (response) {
+          data = response;
+        }
         return createJSONRPCSuccessResponse5(request.id, {
           runId,
           runCompleted: true,
-          config: flowConfig
+          data,
+          config: flowConfig,
+          ui
         });
       } catch (e) {
         if (e instanceof Error) {
@@ -2933,6 +2993,8 @@ export {
   PERMISSION_STATE,
   Permissions,
   RequestHeaders,
+  STEP_STATUS,
+  STEP_TYPE,
   checkBuiltInPermissions,
   createFlowContext,
   handleFlow,