@teamkeel/functions-runtime 0.416.0 → 0.416.2

package/dist/index.d.cts

@@ -745,6 +745,23 @@ declare const enum STEP_TYPE {
     DELAY = "DELAY",
     COMPLETE = "COMPLETE"
 }
+/** A function used to calculate the delay between attempting a retry. The returned value is the number of ms of delay. */
+type RetryPolicyFn = (retry: number) => number;
+/**
+ * Returns a linear backoff retry delay.
+ * @param intervalS duration in seconds before the first retry. The second retry will double it, the third triple it and so on.
+ */
+declare const RetryBackoffLinear: (intervalS: number) => RetryPolicyFn;
+/**
+ * Retuns a constant retry delay.
+ * @param intervalS duration in seconds between retries.
+ */
+declare const RetryConstant: (intervalS: number) => RetryPolicyFn;
+/**
+ * Returns an exponential backoff retry delay.
+ * @param intervalS the base duration in seconds.
+ */
+declare const RetryBackoffExponential: (intervalS: number) => RetryPolicyFn;
 interface FlowContext<C extends FlowConfig, E, S, Id> {
     step: Step<C>;
     ui: UI<C>;
@@ -761,6 +778,8 @@ type StepOptions<C extends FlowConfig> = {
     stage?: ExtractStageKeys<C>;
     /** Number of times to retry the step after it fails. Defaults to 4. */
     retries?: number;
+    /** Function to calculate the delay before retrying this step. By default steps will be retried immediately. */
+    retryPolicy?: RetryPolicyFn;
     /** Maximum time in milliseconds to wait for the step to complete. Defaults to 60000 (1 minute). */
     timeout?: number;
     /** A function to call if the step fails after it exhausts all retries. */
@@ -990,4 +1009,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, NonRetriableError, 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 };
+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, NonRetriableError, type NumberArrayQueryWhereCondition, type NumberArrayWhereCondition, type NumberWhereCondition, PERMISSION_STATE, type PageInfo, Permissions, type RelativeDateString, RequestHeaders, type Response, RetryBackoffExponential, RetryBackoffLinear, RetryConstant, 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

@@ -745,6 +745,23 @@ declare const enum STEP_TYPE {
     DELAY = "DELAY",
     COMPLETE = "COMPLETE"
 }
+/** A function used to calculate the delay between attempting a retry. The returned value is the number of ms of delay. */
+type RetryPolicyFn = (retry: number) => number;
+/**
+ * Returns a linear backoff retry delay.
+ * @param intervalS duration in seconds before the first retry. The second retry will double it, the third triple it and so on.
+ */
+declare const RetryBackoffLinear: (intervalS: number) => RetryPolicyFn;
+/**
+ * Retuns a constant retry delay.
+ * @param intervalS duration in seconds between retries.
+ */
+declare const RetryConstant: (intervalS: number) => RetryPolicyFn;
+/**
+ * Returns an exponential backoff retry delay.
+ * @param intervalS the base duration in seconds.
+ */
+declare const RetryBackoffExponential: (intervalS: number) => RetryPolicyFn;
 interface FlowContext<C extends FlowConfig, E, S, Id> {
     step: Step<C>;
     ui: UI<C>;
@@ -761,6 +778,8 @@ type StepOptions<C extends FlowConfig> = {
     stage?: ExtractStageKeys<C>;
     /** Number of times to retry the step after it fails. Defaults to 4. */
     retries?: number;
+    /** Function to calculate the delay before retrying this step. By default steps will be retried immediately. */
+    retryPolicy?: RetryPolicyFn;
     /** Maximum time in milliseconds to wait for the step to complete. Defaults to 60000 (1 minute). */
     timeout?: number;
     /** A function to call if the step fails after it exhausts all retries. */
@@ -990,4 +1009,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, NonRetriableError, 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 };
+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, NonRetriableError, type NumberArrayQueryWhereCondition, type NumberArrayWhereCondition, type NumberWhereCondition, PERMISSION_STATE, type PageInfo, Permissions, type RelativeDateString, RequestHeaders, type Response, RetryBackoffExponential, RetryBackoffLinear, RetryConstant, 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

@@ -2610,12 +2610,13 @@ var UIRenderDisrupt = class extends FlowDisrupt {
   }
 };
 var StepCreatedDisrupt = class extends FlowDisrupt {
+  constructor(executeAfter) {
+    super();
+    this.executeAfter = executeAfter;
+  }
   static {
     __name(this, "StepCreatedDisrupt");
   }
-  constructor() {
-    super();
-  }
 };
 var ExhuastedRetriesDisrupt = class extends FlowDisrupt {
   static {
@@ -2896,6 +2897,20 @@ var STEP_TYPE = /* @__PURE__ */ ((STEP_TYPE2) => {
   STEP_TYPE2["COMPLETE"] = "COMPLETE";
   return STEP_TYPE2;
 })(STEP_TYPE || {});
+var RetryBackoffLinear = /* @__PURE__ */ __name((intervalS) => {
+  return (retry) => retry * intervalS * 1e3;
+}, "RetryBackoffLinear");
+var RetryConstant = /* @__PURE__ */ __name((intervalS) => {
+  return (retry) => retry > 0 ? intervalS * 1e3 : 0;
+}, "RetryConstant");
+var RetryBackoffExponential = /* @__PURE__ */ __name((intervalS) => {
+  return (retry) => {
+    if (retry < 1) {
+      return 0;
+    }
+    return Math.pow(intervalS, retry) * 1e3;
+  };
+}, "RetryBackoffExponential");
 var defaultOpts = {
   retries: 4,
   timeout: 6e4
@@ -2986,7 +3001,11 @@ function createFlowContext(runId, data, action, spanId, ctx) {
             status: "NEW" /* NEW */,
             type: "FUNCTION" /* FUNCTION */
           }).returningAll().executeTakeFirst();
-          throw new StepCreatedDisrupt();
+          throw new StepCreatedDisrupt(
+            options.retryPolicy ? new Date(
+              Date.now() + options.retryPolicy(failedSteps.length + 1)
+            ) : void 0
+          );
         }
         await db.updateTable("keel.flow_step").set({
           status: "COMPLETED" /* COMPLETED */,
@@ -3206,7 +3225,8 @@ async function handleFlow(request, config) {
             return createJSONRPCSuccessResponse5(request.id, {
               runId,
               runCompleted: false,
-              config: flowConfig
+              config: flowConfig,
+              executeAfter: e.executeAfter
             });
           }
           if (e instanceof UIRenderDisrupt) {
@@ -3310,6 +3330,9 @@ export {
   PERMISSION_STATE,
   Permissions,
   RequestHeaders,
+  RetryBackoffExponential,
+  RetryBackoffLinear,
+  RetryConstant,
   STEP_STATUS,
   STEP_TYPE,
   checkBuiltInPermissions,