@teamkeel/functions-runtime 0.459.0 → 0.460.1

package/dist/index.d.cts

@@ -6,6 +6,46 @@ import { StandardSchemaV1 } from '@standard-schema/spec';
 import { LanguageModel } from 'ai';
 export { z } from 'zod';
 
+interface RecipientUser {
+    id: string;
+    email?: string | null;
+}
+interface RecipientIdentity {
+    id: string;
+    email?: string | null;
+}
+interface EmailActionButton {
+    label: string;
+    url: string;
+}
+interface StructuredEmailContent {
+    title?: string;
+    body: string;
+    actions?: EmailActionButton[];
+}
+type EmailContent = string | StructuredEmailContent;
+interface EmailRecipientGroup {
+    emails?: string | string[];
+    users?: string | RecipientUser | Array<string | RecipientUser>;
+    identities?: string | RecipientIdentity | Array<string | RecipientIdentity>;
+    teams?: string | string[];
+}
+interface EmailRecipients {
+    to: EmailRecipientGroup;
+    cc?: EmailRecipientGroup;
+    bcc?: EmailRecipientGroup;
+}
+interface EmailInput {
+    recipients: EmailRecipients;
+    subject: string;
+    content: EmailContent;
+}
+
+interface NotifyApi {
+    email(input: EmailInput): Promise<string>;
+}
+declare function createNotifier(): NotifyApi;
+
 declare namespace ErrorPresets {
     export { NotFoundError$1 as NotFound };
     export { BadRequestError as BadRequest };
@@ -169,13 +209,14 @@ declare class ModelAPI {
      * @param {Function} _ Used to be a function that returns the default values for a row in this table. No longer used.
      * @param {TableConfigMap} tableConfigMap
      */
-    constructor(tableName: string, _: Function, tableConfigMap?: TableConfigMap);
+    constructor(tableName: string, _: Function, tableConfigMap?: TableConfigMap, fileFieldsMap?: {});
     _tableName: string;
     _tableConfigMap: {
         [x: string]: {
             [x: string]: RelationshipConfig;
         };
     };
+    _fileFields: any;
     _modelName: any;
     create(values: any): Promise<any>;
     findOne(where?: {}): Promise<any>;
@@ -183,6 +224,8 @@ declare class ModelAPI {
     update(where: any, values: any): Promise<any>;
     delete(where: any): Promise<any>;
     where(where: any): QueryBuilder;
+    _selectExistingFileValues(where: any, fileColumns: any): Promise<{}[]>;
+    _deferReplacedFiles(existingRows: any, fileColumns: any, newRow: any): void;
 }
 
 /**
@@ -449,6 +492,10 @@ declare class FlowRun$1 {
     cancel(): Promise<FlowRun$1>;
 }
 
+declare function createIntegrationServer(name: any, identity: any): {
+    do: (request: any) => Promise<unknown>;
+};
+
 interface RequestHeadersMap {
     [key: string]: string;
 }
@@ -564,7 +611,10 @@ declare class File extends InlineFile {
     get isPublic(): boolean;
     read(): Promise<Buffer>;
     store(expires?: Date | null): Promise<File>;
-    getPresignedUrl(): Promise<URL>;
+    getPresignedUrl(options?: {
+        contentDisposition?: "inline" | "attachment";
+        filename?: string;
+    }): Promise<URL>;
     getPresignedUploadUrl(): Promise<URL>;
     toDbRecord(): FileDbRecord;
     toJSON(): FileDbRecord;
@@ -1468,6 +1518,22 @@ interface FlowContext<C extends FlowConfig, E, S, Id, I, H extends NullableHardw
     secrets: S;
     identity: Id;
     trace: TraceAPI;
+    module(name: string): {
+        secret(key: string): string;
+        server: {
+            do(request: {
+                method?: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
+                path: string;
+                query?: Record<string, string | string[]>;
+                headers?: Record<string, string>;
+                body?: unknown;
+            }): Promise<{
+                status: number;
+                headers: Record<string, string[]>;
+                body: unknown;
+            }>;
+        };
+    };
 }
 type NullableHardware = Hardware | undefined;
 type Hardware = {
@@ -1476,9 +1542,13 @@ type Hardware = {
 interface Printer {
     name: string;
 }
-type JsonSerializable = string | number | boolean | null | JsonSerializable[] | {
-    [key: string]: JsonSerializable;
+type JsonValue$1<T> = T extends string | number | boolean | null ? T : T extends (...args: any[]) => any ? never : T extends (infer E)[] ? JsonValue$1<E>[] : T extends object ? keyof T extends never ? never : {
+    [K in keyof T]: JsonValue$1<T[K]>;
+} : never;
+type Serializable<T> = string | number | boolean | null | void | {
+    [K in keyof T]: JsonValue$1<T[K]>;
 };
+type StepReturn<R> = [R] extends [JsonValue$1<R> | void] ? R : JsonValue$1<R>;
 type StepOptions<C extends FlowConfig> = {
     stage?: ExtractStageKeys<C>;
     /** Number of times to retry the step after it fails. Defaults to 4. */
@@ -1491,18 +1561,18 @@ type StepOptions<C extends FlowConfig> = {
     onFailure?: () => Promise<void> | void;
 };
 type Step<C extends FlowConfig> = {
-    <R extends JsonSerializable | void>(
+    <R extends Serializable<R>>(
     /** The unique name of this step. */
     name: string, 
     /** Configuration options for the step. */
     options: StepOptions<C>, 
     /** The step function to execute. */
-    fn: StepFunction<C, R>): Promise<R>;
-    <R extends JsonSerializable | void>(
+    fn: StepFunction<C, StepReturn<R>>): Promise<R>;
+    <R extends Serializable<R>>(
     /** The unique name of this step. */
     name: string, 
     /** The step function to execute. */
-    fn: StepFunction<C, R>): Promise<R>;
+    fn: StepFunction<C, StepReturn<R>>): Promise<R>;
 };
 type StepArgs<C extends FlowConfig> = {
     attempt: number;
@@ -1540,6 +1610,7 @@ type StageConfigObject = {
     initiallyHidden?: boolean;
 };
 type StageConfig = string | StageConfigObject;
+declare function insertNewStep(db: Kysely<any>, runId: string, name: string, stage: string | undefined): Promise<void>;
 declare function createFlowContext<C extends FlowConfig, E, S, Id, I, H extends NullableHardware>(runId: string, data: any, action: string | null, callback: string | null, element: string | null, spanId: string, ctx: {
     env: E;
     now: () => Date;
@@ -1547,6 +1618,7 @@ declare function createFlowContext<C extends FlowConfig, E, S, Id, I, H extends
     identity: Id;
     trace: TraceAPI;
     engine?: TurnEngine;
+    module: FlowContext<C, E, S, Id, I, H>["module"];
 }): FlowContext<C, E, S, Id, I, H>;
 
 type JsonValue = string | number | boolean | null | JsonValue[] | {
@@ -1677,6 +1749,8 @@ declare namespace experimental {
 declare const createTraceAPI: typeof createTraceAPI$1;
 declare function ksuid(): string;
 
+declare const notify: NotifyApi;
+
 type IDWhereCondition = {
     equals?: string | null;
     notEquals?: string | null;
@@ -1929,4 +2003,4 @@ type SignedLinkResult = {
     };
 };
 
-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 FlowListOptions, type FlowListResult, type FlowRun, type FlowRunStatus, type FlowRunStep, FlowsAPI, type FuncWithConfig, type FunctionConfig, type Hardware, type IDWhereCondition, InlineFile, type ListResult, ModelAPI, NonRetriableError, type NullableHardware, type NumberArrayQueryWhereCondition, type NumberArrayWhereCondition, type NumberWhereCondition, PERMISSION_STATE, type PageInfo, type PartialPageInfo, Permissions, type Printer, type RelativeDateString, RequestHeaders, type Response, RetryBackoffExponential, RetryBackoffLinear, RetryConstant, STEP_STATUS, STEP_TYPE, Signature, type SignedLinkOptions, type SignedLinkResult, type SortDirection, type Step, type StringArrayQueryWhereCondition, type StringArrayWhereCondition, type StringWhereCondition, type Task, TaskAPI, type TaskCreateOptions, type TaskFlowFunction, type TaskStatus, type TimestampQueryInput, type TraceAPI, type TraceAttributeValue, type TraceAttributes, type UI, type UIApiResponses, checkBuiltInPermissions, createFlowContext, createTraceAPI, experimental, 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, type EmailContent, type EmailInput, type EmailRecipientGroup, type EmailRecipients, ErrorPresets, type Errors, type ExtractStageKeys, File, type FlowConfig, type FlowConfigAPI, type FlowContext, type FlowFunction, type FlowListOptions, type FlowListResult, type FlowRun, type FlowRunStatus, type FlowRunStep, FlowsAPI, type FuncWithConfig, type FunctionConfig, type Hardware, type IDWhereCondition, InlineFile, type ListResult, ModelAPI, NonRetriableError, type NotifyApi, type NullableHardware, type NumberArrayQueryWhereCondition, type NumberArrayWhereCondition, type NumberWhereCondition, PERMISSION_STATE, type PageInfo, type PartialPageInfo, Permissions, type Printer, type RecipientIdentity, type RecipientUser, type RelativeDateString, RequestHeaders, type Response, RetryBackoffExponential, RetryBackoffLinear, RetryConstant, STEP_STATUS, STEP_TYPE, Signature, type SignedLinkOptions, type SignedLinkResult, type SortDirection, type Step, type StringArrayQueryWhereCondition, type StringArrayWhereCondition, type StringWhereCondition, type Task, TaskAPI, type TaskCreateOptions, type TaskFlowFunction, type TaskStatus, type TimestampQueryInput, type TraceAPI, type TraceAttributeValue, type TraceAttributes, type UI, type UIApiResponses, checkBuiltInPermissions, createFlowContext, createIntegrationServer, createNotifier, createTraceAPI, experimental, handleFlow, handleJob, handleRequest, handleRoute, handleSubscriber, insertNewStep, ksuid, notify, tracing, useDatabase };

package/dist/index.d.ts

@@ -6,6 +6,46 @@ import { StandardSchemaV1 } from '@standard-schema/spec';
 import { LanguageModel } from 'ai';
 export { z } from 'zod';
 
+interface RecipientUser {
+    id: string;
+    email?: string | null;
+}
+interface RecipientIdentity {
+    id: string;
+    email?: string | null;
+}
+interface EmailActionButton {
+    label: string;
+    url: string;
+}
+interface StructuredEmailContent {
+    title?: string;
+    body: string;
+    actions?: EmailActionButton[];
+}
+type EmailContent = string | StructuredEmailContent;
+interface EmailRecipientGroup {
+    emails?: string | string[];
+    users?: string | RecipientUser | Array<string | RecipientUser>;
+    identities?: string | RecipientIdentity | Array<string | RecipientIdentity>;
+    teams?: string | string[];
+}
+interface EmailRecipients {
+    to: EmailRecipientGroup;
+    cc?: EmailRecipientGroup;
+    bcc?: EmailRecipientGroup;
+}
+interface EmailInput {
+    recipients: EmailRecipients;
+    subject: string;
+    content: EmailContent;
+}
+
+interface NotifyApi {
+    email(input: EmailInput): Promise<string>;
+}
+declare function createNotifier(): NotifyApi;
+
 declare namespace ErrorPresets {
     export { NotFoundError$1 as NotFound };
     export { BadRequestError as BadRequest };
@@ -169,13 +209,14 @@ declare class ModelAPI {
      * @param {Function} _ Used to be a function that returns the default values for a row in this table. No longer used.
      * @param {TableConfigMap} tableConfigMap
      */
-    constructor(tableName: string, _: Function, tableConfigMap?: TableConfigMap);
+    constructor(tableName: string, _: Function, tableConfigMap?: TableConfigMap, fileFieldsMap?: {});
     _tableName: string;
     _tableConfigMap: {
         [x: string]: {
             [x: string]: RelationshipConfig;
         };
     };
+    _fileFields: any;
     _modelName: any;
     create(values: any): Promise<any>;
     findOne(where?: {}): Promise<any>;
@@ -183,6 +224,8 @@ declare class ModelAPI {
     update(where: any, values: any): Promise<any>;
     delete(where: any): Promise<any>;
     where(where: any): QueryBuilder;
+    _selectExistingFileValues(where: any, fileColumns: any): Promise<{}[]>;
+    _deferReplacedFiles(existingRows: any, fileColumns: any, newRow: any): void;
 }
 
 /**
@@ -449,6 +492,10 @@ declare class FlowRun$1 {
     cancel(): Promise<FlowRun$1>;
 }
 
+declare function createIntegrationServer(name: any, identity: any): {
+    do: (request: any) => Promise<unknown>;
+};
+
 interface RequestHeadersMap {
     [key: string]: string;
 }
@@ -564,7 +611,10 @@ declare class File extends InlineFile {
     get isPublic(): boolean;
     read(): Promise<Buffer>;
     store(expires?: Date | null): Promise<File>;
-    getPresignedUrl(): Promise<URL>;
+    getPresignedUrl(options?: {
+        contentDisposition?: "inline" | "attachment";
+        filename?: string;
+    }): Promise<URL>;
     getPresignedUploadUrl(): Promise<URL>;
     toDbRecord(): FileDbRecord;
     toJSON(): FileDbRecord;
@@ -1468,6 +1518,22 @@ interface FlowContext<C extends FlowConfig, E, S, Id, I, H extends NullableHardw
     secrets: S;
     identity: Id;
     trace: TraceAPI;
+    module(name: string): {
+        secret(key: string): string;
+        server: {
+            do(request: {
+                method?: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
+                path: string;
+                query?: Record<string, string | string[]>;
+                headers?: Record<string, string>;
+                body?: unknown;
+            }): Promise<{
+                status: number;
+                headers: Record<string, string[]>;
+                body: unknown;
+            }>;
+        };
+    };
 }
 type NullableHardware = Hardware | undefined;
 type Hardware = {
@@ -1476,9 +1542,13 @@ type Hardware = {
 interface Printer {
     name: string;
 }
-type JsonSerializable = string | number | boolean | null | JsonSerializable[] | {
-    [key: string]: JsonSerializable;
+type JsonValue$1<T> = T extends string | number | boolean | null ? T : T extends (...args: any[]) => any ? never : T extends (infer E)[] ? JsonValue$1<E>[] : T extends object ? keyof T extends never ? never : {
+    [K in keyof T]: JsonValue$1<T[K]>;
+} : never;
+type Serializable<T> = string | number | boolean | null | void | {
+    [K in keyof T]: JsonValue$1<T[K]>;
 };
+type StepReturn<R> = [R] extends [JsonValue$1<R> | void] ? R : JsonValue$1<R>;
 type StepOptions<C extends FlowConfig> = {
     stage?: ExtractStageKeys<C>;
     /** Number of times to retry the step after it fails. Defaults to 4. */
@@ -1491,18 +1561,18 @@ type StepOptions<C extends FlowConfig> = {
     onFailure?: () => Promise<void> | void;
 };
 type Step<C extends FlowConfig> = {
-    <R extends JsonSerializable | void>(
+    <R extends Serializable<R>>(
     /** The unique name of this step. */
     name: string, 
     /** Configuration options for the step. */
     options: StepOptions<C>, 
     /** The step function to execute. */
-    fn: StepFunction<C, R>): Promise<R>;
-    <R extends JsonSerializable | void>(
+    fn: StepFunction<C, StepReturn<R>>): Promise<R>;
+    <R extends Serializable<R>>(
     /** The unique name of this step. */
     name: string, 
     /** The step function to execute. */
-    fn: StepFunction<C, R>): Promise<R>;
+    fn: StepFunction<C, StepReturn<R>>): Promise<R>;
 };
 type StepArgs<C extends FlowConfig> = {
     attempt: number;
@@ -1540,6 +1610,7 @@ type StageConfigObject = {
     initiallyHidden?: boolean;
 };
 type StageConfig = string | StageConfigObject;
+declare function insertNewStep(db: Kysely<any>, runId: string, name: string, stage: string | undefined): Promise<void>;
 declare function createFlowContext<C extends FlowConfig, E, S, Id, I, H extends NullableHardware>(runId: string, data: any, action: string | null, callback: string | null, element: string | null, spanId: string, ctx: {
     env: E;
     now: () => Date;
@@ -1547,6 +1618,7 @@ declare function createFlowContext<C extends FlowConfig, E, S, Id, I, H extends
     identity: Id;
     trace: TraceAPI;
     engine?: TurnEngine;
+    module: FlowContext<C, E, S, Id, I, H>["module"];
 }): FlowContext<C, E, S, Id, I, H>;
 
 type JsonValue = string | number | boolean | null | JsonValue[] | {
@@ -1677,6 +1749,8 @@ declare namespace experimental {
 declare const createTraceAPI: typeof createTraceAPI$1;
 declare function ksuid(): string;
 
+declare const notify: NotifyApi;
+
 type IDWhereCondition = {
     equals?: string | null;
     notEquals?: string | null;
@@ -1929,4 +2003,4 @@ type SignedLinkResult = {
     };
 };
 
-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 FlowListOptions, type FlowListResult, type FlowRun, type FlowRunStatus, type FlowRunStep, FlowsAPI, type FuncWithConfig, type FunctionConfig, type Hardware, type IDWhereCondition, InlineFile, type ListResult, ModelAPI, NonRetriableError, type NullableHardware, type NumberArrayQueryWhereCondition, type NumberArrayWhereCondition, type NumberWhereCondition, PERMISSION_STATE, type PageInfo, type PartialPageInfo, Permissions, type Printer, type RelativeDateString, RequestHeaders, type Response, RetryBackoffExponential, RetryBackoffLinear, RetryConstant, STEP_STATUS, STEP_TYPE, Signature, type SignedLinkOptions, type SignedLinkResult, type SortDirection, type Step, type StringArrayQueryWhereCondition, type StringArrayWhereCondition, type StringWhereCondition, type Task, TaskAPI, type TaskCreateOptions, type TaskFlowFunction, type TaskStatus, type TimestampQueryInput, type TraceAPI, type TraceAttributeValue, type TraceAttributes, type UI, type UIApiResponses, checkBuiltInPermissions, createFlowContext, createTraceAPI, experimental, 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, type EmailContent, type EmailInput, type EmailRecipientGroup, type EmailRecipients, ErrorPresets, type Errors, type ExtractStageKeys, File, type FlowConfig, type FlowConfigAPI, type FlowContext, type FlowFunction, type FlowListOptions, type FlowListResult, type FlowRun, type FlowRunStatus, type FlowRunStep, FlowsAPI, type FuncWithConfig, type FunctionConfig, type Hardware, type IDWhereCondition, InlineFile, type ListResult, ModelAPI, NonRetriableError, type NotifyApi, type NullableHardware, type NumberArrayQueryWhereCondition, type NumberArrayWhereCondition, type NumberWhereCondition, PERMISSION_STATE, type PageInfo, type PartialPageInfo, Permissions, type Printer, type RecipientIdentity, type RecipientUser, type RelativeDateString, RequestHeaders, type Response, RetryBackoffExponential, RetryBackoffLinear, RetryConstant, STEP_STATUS, STEP_TYPE, Signature, type SignedLinkOptions, type SignedLinkResult, type SortDirection, type Step, type StringArrayQueryWhereCondition, type StringArrayWhereCondition, type StringWhereCondition, type Task, TaskAPI, type TaskCreateOptions, type TaskFlowFunction, type TaskStatus, type TimestampQueryInput, type TraceAPI, type TraceAttributeValue, type TraceAttributes, type UI, type UIApiResponses, checkBuiltInPermissions, createFlowContext, createIntegrationServer, createNotifier, createTraceAPI, experimental, handleFlow, handleJob, handleRequest, handleRoute, handleSubscriber, insertNewStep, ksuid, notify, tracing, useDatabase };