@teamkeel/functions-runtime 0.411.0 → 0.412.0-next.2

package/dist/index.d.mts

@@ -0,0 +1,340 @@
+type IDWhereCondition = {
+    equals?: string | null;
+    notEquals?: string | null;
+    oneOf?: string[] | null;
+};
+type StringWhereCondition = {
+    startsWith?: string | null;
+    endsWith?: string | null;
+    oneOf?: string[] | null;
+    contains?: string | null;
+    equals?: string | null;
+    notEquals?: string | null;
+};
+type BooleanWhereCondition = {
+    equals?: boolean | null;
+    notEquals?: boolean | null;
+};
+type NumberWhereCondition = {
+    greaterThan?: number | null;
+    greaterThanOrEquals?: number | null;
+    lessThan?: number | null;
+    lessThanOrEquals?: number | null;
+    equals?: number | null;
+    notEquals?: number | null;
+};
+type DurationWhereCondition = {
+    greaterThan?: DurationString | null;
+    greaterThanOrEquals?: DurationString | null;
+    lessThan?: DurationString | null;
+    lessThanOrEquals?: DurationString | null;
+    equals?: DurationString | null;
+    notEquals?: DurationString | null;
+};
+type DateWhereCondition = {
+    equals?: Date | string | null;
+    equalsRelative?: RelativeDateString | null;
+    before?: Date | string | null;
+    beforeRelative?: RelativeDateString | null;
+    onOrBefore?: Date | string | null;
+    after?: Date | string | null;
+    afterRelative?: RelativeDateString | null;
+    onOrAfter?: Date | string | null;
+};
+type DateQueryInput = {
+    equals?: string | null;
+    before?: string | null;
+    onOrBefore?: string | null;
+    after?: string | null;
+    onOrAfter?: string | null;
+};
+type TimestampQueryInput = {
+    before: string | null;
+    after: string | null;
+    equalsRelative?: RelativeDateString | null;
+    beforeRelative?: RelativeDateString | null;
+    afterRelative?: RelativeDateString | null;
+};
+type StringArrayWhereCondition = {
+    equals?: string[] | null;
+    notEquals?: string[] | null;
+    any?: StringArrayQueryWhereCondition | null;
+    all?: StringArrayQueryWhereCondition | null;
+};
+type StringArrayQueryWhereCondition = {
+    equals?: string | null;
+    notEquals?: string | null;
+};
+type NumberArrayWhereCondition = {
+    equals?: number[] | null;
+    notEquals?: number[] | null;
+    any?: NumberArrayQueryWhereCondition | null;
+    all?: NumberArrayQueryWhereCondition | null;
+};
+type NumberArrayQueryWhereCondition = {
+    greaterThan?: number | null;
+    greaterThanOrEquals?: number | null;
+    lessThan?: number | null;
+    lessThanOrEquals?: number | null;
+    equals?: number | null;
+    notEquals?: number | null;
+};
+type BooleanArrayWhereCondition = {
+    equals?: boolean[] | null;
+    notEquals?: boolean[] | null;
+    any?: BooleanArrayQueryWhereCondition | null;
+    all?: BooleanArrayQueryWhereCondition | null;
+};
+type BooleanArrayQueryWhereCondition = {
+    equals?: boolean | null;
+    notEquals?: boolean | null;
+};
+type DateArrayWhereCondition = {
+    equals?: Date[] | null;
+    notEquals?: Date[] | null;
+    any?: DateArrayQueryWhereCondition | null;
+    all?: DateArrayQueryWhereCondition | null;
+};
+type DateArrayQueryWhereCondition = {
+    greaterThan?: Date | null;
+    greaterThanOrEquals?: Date | null;
+    lessThan?: Date | null;
+    lessThanOrEquals?: number | null;
+    equals?: Date | null;
+    notEquals?: Date | null;
+};
+type ContextAPI = {
+    headers: RequestHeaders;
+    response: Response;
+    isAuthenticated: boolean;
+    now(): Date;
+};
+type Response = {
+    headers: Headers;
+    status?: number;
+};
+type PageInfo = {
+    startCursor: string;
+    endCursor: string;
+    totalCount: number;
+    hasNextPage: boolean;
+    count: number;
+    pageNumber?: number;
+};
+type MimeType = "application/json" | "application/gzip" | "application/pdf" | "application/rtf" | "application/vnd.openxmlformats-officedocument.wordprocessingml.document" | "application/vnd.openxmlformats-officedocument.presentationml.presentation" | "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" | "application/vnd.ms-excel" | "application/vnd.ms-powerpoint" | "application/msword" | "application/zip" | "application/xml" | "application/x-7z-compressed" | "application/x-tar" | "image/gif" | "image/jpeg" | "image/svg+xml" | "image/png" | "text/html" | "text/csv" | "text/javascript" | "text/plain" | "text/calendar" | (string & {});
+type InlineFileConstructor = {
+    filename: string;
+    contentType: MimeType;
+};
+declare class InlineFile {
+    constructor(input: InlineFileConstructor);
+    static fromDataURL(url: string): InlineFile;
+    read(): Promise<Buffer>;
+    write(data: Buffer): void;
+    store(expires?: Date, isPublic?: boolean): Promise<File>;
+    get filename(): string;
+    get contentType(): string;
+    get size(): number;
+}
+declare class File extends InlineFile {
+    get key(): string;
+    get isPublic(): boolean;
+    getPresignedUrl(): Promise<URL>;
+    static fromDbRecord(input: FileDbRecord): File;
+    toDbRecord(): FileDbRecord;
+}
+type FileDbRecord = {
+    key: string;
+    filename: string;
+    contentType: string;
+    size: number;
+};
+declare class Duration {
+    constructor(postgresString: string);
+    static fromISOString(iso: DurationString): Duration;
+    toISOString(): DurationString;
+    toPostgres(): string;
+}
+type SortDirection = "asc" | "desc" | "ASC" | "DESC";
+type RequestHeaders = Omit<Headers, "append" | "delete" | "set">;
+declare class Permissions {
+    constructor();
+    allow(): void;
+    deny(): never;
+}
+declare class NotFoundError extends Error {
+}
+declare class BadRequestError extends Error {
+}
+declare class UnknownError extends Error {
+}
+type Errors = {
+    /**
+     * Returns a 404 HTTP status with an optional message.
+     * This error indicates that the requested resource could not be found.
+     */
+    NotFound: typeof NotFoundError;
+    /**
+     * Returns a 400 HTTP status with an optional message.
+     * This error indicates that the request made by the client is invalid or malformed.
+     */
+    BadRequest: typeof BadRequestError;
+    /**
+     * Returns a 500 HTTP status with an optional message.
+     * This error indicates that an unexpected condition was encountered, preventing the server from fulfilling the request.
+     */
+    Unknown: typeof UnknownError;
+};
+type FunctionConfig = {
+    /**
+     * All DB calls within the function will be executed within a transaction.
+     * The transaction is rolled back if the function throws an error.
+     */
+    dbTransaction?: boolean;
+};
+type FuncWithConfig<T> = T & {
+    config: FunctionConfig;
+};
+type unit = "year" | "years" | "month" | "months" | "day" | "days" | "hour" | "hours" | "minute" | "minutes" | "second" | "seconds";
+type direction = "next" | "last";
+type completed = "complete";
+type value = number;
+type RelativeDateString = "now" | "today" | "tomorrow" | "yesterday" | `this ${unit}` | `${direction} ${unit}` | `${direction} ${value} ${unit}` | `${direction} ${value} ${completed} ${unit}`;
+type dateDuration = `${number}Y${number}M${number}D` | `${number}Y${number}M` | `${number}Y${number}D` | `${number}M${number}D` | `${number}Y` | `${number}M` | `${number}D`;
+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}`;
+type FileWriteTypes = InlineFile | File;
+
+type ElementDataType$3 = string | number | boolean | Date;
+type UiElementSelectOne = <TValue extends ElementDataType$3, N extends string>(name: N, options?: BaseInputConfig<TValue> & {
+    options: ({
+        label: string;
+        value: TValue;
+    } | TValue)[];
+}) => InputElementResponse<N, TValue>;
+
+type ElementDataType$2 = string;
+type UiElementInputText = InputElement<ElementDataType$2, {
+    placeholder?: string;
+    multiline?: boolean;
+    maxLength?: number;
+    minLength?: number;
+}>;
+
+type ElementDataType$1 = number;
+type UiElementInputNumber = InputElement<ElementDataType$1, {
+    placeholder?: number;
+    min?: number;
+    max?: number;
+}>;
+
+type ElementDataType = boolean;
+type UiElementInputBoolean = InputElement<ElementDataType, {
+    mode?: "checkbox" | "switch";
+}>;
+
+type UiElementMarkdown = DisplayElement<{
+    content: string;
+}>;
+
+type UiElementTable = DisplayElement<{
+    data: any[];
+    columns: string[];
+}>;
+
+type UiElementDivider = DisplayElement<{}>;
+
+type UiPage<C extends FlowConfig> = <T extends UIElements, A extends PageActions[] = []>(options: {
+    stage?: ExtractStageKeys<C>;
+    title?: string;
+    description?: string;
+    content: T;
+    validate?: (data: ExtractFormData<T>) => Promise<true | string>;
+    actions?: A;
+}) => A["length"] extends 0 ? ExtractFormData<T> : {
+    data: ExtractFormData<T>;
+    action: ActionValue<A[number]>;
+};
+type PageActions = string | {
+    label: string;
+    value: string;
+    mode?: "primary" | "secondary" | "destructive";
+};
+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"];
+};
+type ExtractStageKeys<T extends FlowConfig> = T extends {
+    stages: infer S;
+} ? S extends ReadonlyArray<infer U> ? U extends string ? U : U extends {
+    key: infer K extends string;
+} ? K : never : never : never;
+
+interface UI<C extends FlowConfig> {
+    page: UiPage<C>;
+    display: UiDisplayElements;
+    inputs: UiInputsElements;
+    select: UiSelectElements;
+}
+type UiInputsElements = {
+    text: UiElementInputText;
+    number: UiElementInputNumber;
+    boolean: UiElementInputBoolean;
+};
+type UiSelectElements = {
+    single: UiElementSelectOne;
+};
+type UiDisplayElements = {
+    divider: UiElementDivider;
+    markdown: UiElementMarkdown;
+    table: UiElementTable;
+};
+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;
+type UIElements = (InputElementResponse<string, any> | DisplayElementResponse)[];
+interface UIElementBase {
+    _type: string;
+}
+interface InputElementResponse<N extends string, V> extends UIElementBase {
+    _type: "input";
+    name: N;
+    valueType: V;
+}
+interface DisplayElementResponse extends UIElementBase {
+    _type: "display";
+}
+interface BaseInputConfig<T> {
+    label?: string;
+    defaultValue?: T;
+    helpText?: string;
+    optional?: boolean;
+    disabled?: boolean;
+    validate?: (data: T) => Promise<boolean | string>;
+}
+
+interface StepContext<C extends FlowConfig> {
+    step: <R = any>(name: string, fn: () => Promise<R>, opts?: Opts) => Promise<R> & {
+        catch: (errorHandler: (err: Error) => Promise<void> | void) => Promise<any>;
+    };
+    ui: UI<C>;
+}
+interface FlowConfig {
+    stages?: StageConfig[];
+    title?: string;
+    description?: string;
+}
+type FlowFunction<C extends FlowConfig, I extends any = {}> = (ctx: StepContext<C>, inputs: I) => Promise<void>;
+type StageConfig = string | {
+    key: string;
+    name: string;
+    description?: string;
+    initiallyHidden?: boolean;
+};
+type Opts = {
+    maxRetries?: number;
+    timeoutInMs?: number;
+};
+
+export { type BooleanArrayQueryWhereCondition, type BooleanArrayWhereCondition, type BooleanWhereCondition, type ContextAPI, type DateArrayQueryWhereCondition, type DateArrayWhereCondition, type DateQueryInput, type DateWhereCondition, Duration, type DurationString, type DurationWhereCondition, type Errors, File, type FileDbRecord, type FileWriteTypes, type FlowConfig, type FlowFunction, type FuncWithConfig, type FunctionConfig, type IDWhereCondition, InlineFile, type InlineFileConstructor, type NumberArrayQueryWhereCondition, type NumberArrayWhereCondition, type NumberWhereCondition, type PageInfo, Permissions, type RelativeDateString, type RequestHeaders, type Response, type SortDirection, type StepContext, type StringArrayQueryWhereCondition, type StringArrayWhereCondition, type StringWhereCondition, type TimestampQueryInput, type UI };

package/dist/index.d.ts

@@ -0,0 +1,340 @@
+type IDWhereCondition = {
+    equals?: string | null;
+    notEquals?: string | null;
+    oneOf?: string[] | null;
+};
+type StringWhereCondition = {
+    startsWith?: string | null;
+    endsWith?: string | null;
+    oneOf?: string[] | null;
+    contains?: string | null;
+    equals?: string | null;
+    notEquals?: string | null;
+};
+type BooleanWhereCondition = {
+    equals?: boolean | null;
+    notEquals?: boolean | null;
+};
+type NumberWhereCondition = {
+    greaterThan?: number | null;
+    greaterThanOrEquals?: number | null;
+    lessThan?: number | null;
+    lessThanOrEquals?: number | null;
+    equals?: number | null;
+    notEquals?: number | null;
+};
+type DurationWhereCondition = {
+    greaterThan?: DurationString | null;
+    greaterThanOrEquals?: DurationString | null;
+    lessThan?: DurationString | null;
+    lessThanOrEquals?: DurationString | null;
+    equals?: DurationString | null;
+    notEquals?: DurationString | null;
+};
+type DateWhereCondition = {
+    equals?: Date | string | null;
+    equalsRelative?: RelativeDateString | null;
+    before?: Date | string | null;
+    beforeRelative?: RelativeDateString | null;
+    onOrBefore?: Date | string | null;
+    after?: Date | string | null;
+    afterRelative?: RelativeDateString | null;
+    onOrAfter?: Date | string | null;
+};
+type DateQueryInput = {
+    equals?: string | null;
+    before?: string | null;
+    onOrBefore?: string | null;
+    after?: string | null;
+    onOrAfter?: string | null;
+};
+type TimestampQueryInput = {
+    before: string | null;
+    after: string | null;
+    equalsRelative?: RelativeDateString | null;
+    beforeRelative?: RelativeDateString | null;
+    afterRelative?: RelativeDateString | null;
+};
+type StringArrayWhereCondition = {
+    equals?: string[] | null;
+    notEquals?: string[] | null;
+    any?: StringArrayQueryWhereCondition | null;
+    all?: StringArrayQueryWhereCondition | null;
+};
+type StringArrayQueryWhereCondition = {
+    equals?: string | null;
+    notEquals?: string | null;
+};
+type NumberArrayWhereCondition = {
+    equals?: number[] | null;
+    notEquals?: number[] | null;
+    any?: NumberArrayQueryWhereCondition | null;
+    all?: NumberArrayQueryWhereCondition | null;
+};
+type NumberArrayQueryWhereCondition = {
+    greaterThan?: number | null;
+    greaterThanOrEquals?: number | null;
+    lessThan?: number | null;
+    lessThanOrEquals?: number | null;
+    equals?: number | null;
+    notEquals?: number | null;
+};
+type BooleanArrayWhereCondition = {
+    equals?: boolean[] | null;
+    notEquals?: boolean[] | null;
+    any?: BooleanArrayQueryWhereCondition | null;
+    all?: BooleanArrayQueryWhereCondition | null;
+};
+type BooleanArrayQueryWhereCondition = {
+    equals?: boolean | null;
+    notEquals?: boolean | null;
+};
+type DateArrayWhereCondition = {
+    equals?: Date[] | null;
+    notEquals?: Date[] | null;
+    any?: DateArrayQueryWhereCondition | null;
+    all?: DateArrayQueryWhereCondition | null;
+};
+type DateArrayQueryWhereCondition = {
+    greaterThan?: Date | null;
+    greaterThanOrEquals?: Date | null;
+    lessThan?: Date | null;
+    lessThanOrEquals?: number | null;
+    equals?: Date | null;
+    notEquals?: Date | null;
+};
+type ContextAPI = {
+    headers: RequestHeaders;
+    response: Response;
+    isAuthenticated: boolean;
+    now(): Date;
+};
+type Response = {
+    headers: Headers;
+    status?: number;
+};
+type PageInfo = {
+    startCursor: string;
+    endCursor: string;
+    totalCount: number;
+    hasNextPage: boolean;
+    count: number;
+    pageNumber?: number;
+};
+type MimeType = "application/json" | "application/gzip" | "application/pdf" | "application/rtf" | "application/vnd.openxmlformats-officedocument.wordprocessingml.document" | "application/vnd.openxmlformats-officedocument.presentationml.presentation" | "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" | "application/vnd.ms-excel" | "application/vnd.ms-powerpoint" | "application/msword" | "application/zip" | "application/xml" | "application/x-7z-compressed" | "application/x-tar" | "image/gif" | "image/jpeg" | "image/svg+xml" | "image/png" | "text/html" | "text/csv" | "text/javascript" | "text/plain" | "text/calendar" | (string & {});
+type InlineFileConstructor = {
+    filename: string;
+    contentType: MimeType;
+};
+declare class InlineFile {
+    constructor(input: InlineFileConstructor);
+    static fromDataURL(url: string): InlineFile;
+    read(): Promise<Buffer>;
+    write(data: Buffer): void;
+    store(expires?: Date, isPublic?: boolean): Promise<File>;
+    get filename(): string;
+    get contentType(): string;
+    get size(): number;
+}
+declare class File extends InlineFile {
+    get key(): string;
+    get isPublic(): boolean;
+    getPresignedUrl(): Promise<URL>;
+    static fromDbRecord(input: FileDbRecord): File;
+    toDbRecord(): FileDbRecord;
+}
+type FileDbRecord = {
+    key: string;
+    filename: string;
+    contentType: string;
+    size: number;
+};
+declare class Duration {
+    constructor(postgresString: string);
+    static fromISOString(iso: DurationString): Duration;
+    toISOString(): DurationString;
+    toPostgres(): string;
+}
+type SortDirection = "asc" | "desc" | "ASC" | "DESC";
+type RequestHeaders = Omit<Headers, "append" | "delete" | "set">;
+declare class Permissions {
+    constructor();
+    allow(): void;
+    deny(): never;
+}
+declare class NotFoundError extends Error {
+}
+declare class BadRequestError extends Error {
+}
+declare class UnknownError extends Error {
+}
+type Errors = {
+    /**
+     * Returns a 404 HTTP status with an optional message.
+     * This error indicates that the requested resource could not be found.
+     */
+    NotFound: typeof NotFoundError;
+    /**
+     * Returns a 400 HTTP status with an optional message.
+     * This error indicates that the request made by the client is invalid or malformed.
+     */
+    BadRequest: typeof BadRequestError;
+    /**
+     * Returns a 500 HTTP status with an optional message.
+     * This error indicates that an unexpected condition was encountered, preventing the server from fulfilling the request.
+     */
+    Unknown: typeof UnknownError;
+};
+type FunctionConfig = {
+    /**
+     * All DB calls within the function will be executed within a transaction.
+     * The transaction is rolled back if the function throws an error.
+     */
+    dbTransaction?: boolean;
+};
+type FuncWithConfig<T> = T & {
+    config: FunctionConfig;
+};
+type unit = "year" | "years" | "month" | "months" | "day" | "days" | "hour" | "hours" | "minute" | "minutes" | "second" | "seconds";
+type direction = "next" | "last";
+type completed = "complete";
+type value = number;
+type RelativeDateString = "now" | "today" | "tomorrow" | "yesterday" | `this ${unit}` | `${direction} ${unit}` | `${direction} ${value} ${unit}` | `${direction} ${value} ${completed} ${unit}`;
+type dateDuration = `${number}Y${number}M${number}D` | `${number}Y${number}M` | `${number}Y${number}D` | `${number}M${number}D` | `${number}Y` | `${number}M` | `${number}D`;
+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}`;
+type FileWriteTypes = InlineFile | File;
+
+type ElementDataType$3 = string | number | boolean | Date;
+type UiElementSelectOne = <TValue extends ElementDataType$3, N extends string>(name: N, options?: BaseInputConfig<TValue> & {
+    options: ({
+        label: string;
+        value: TValue;
+    } | TValue)[];
+}) => InputElementResponse<N, TValue>;
+
+type ElementDataType$2 = string;
+type UiElementInputText = InputElement<ElementDataType$2, {
+    placeholder?: string;
+    multiline?: boolean;
+    maxLength?: number;
+    minLength?: number;
+}>;
+
+type ElementDataType$1 = number;
+type UiElementInputNumber = InputElement<ElementDataType$1, {
+    placeholder?: number;
+    min?: number;
+    max?: number;
+}>;
+
+type ElementDataType = boolean;
+type UiElementInputBoolean = InputElement<ElementDataType, {
+    mode?: "checkbox" | "switch";
+}>;
+
+type UiElementMarkdown = DisplayElement<{
+    content: string;
+}>;
+
+type UiElementTable = DisplayElement<{
+    data: any[];
+    columns: string[];
+}>;
+
+type UiElementDivider = DisplayElement<{}>;
+
+type UiPage<C extends FlowConfig> = <T extends UIElements, A extends PageActions[] = []>(options: {
+    stage?: ExtractStageKeys<C>;
+    title?: string;
+    description?: string;
+    content: T;
+    validate?: (data: ExtractFormData<T>) => Promise<true | string>;
+    actions?: A;
+}) => A["length"] extends 0 ? ExtractFormData<T> : {
+    data: ExtractFormData<T>;
+    action: ActionValue<A[number]>;
+};
+type PageActions = string | {
+    label: string;
+    value: string;
+    mode?: "primary" | "secondary" | "destructive";
+};
+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"];
+};
+type ExtractStageKeys<T extends FlowConfig> = T extends {
+    stages: infer S;
+} ? S extends ReadonlyArray<infer U> ? U extends string ? U : U extends {
+    key: infer K extends string;
+} ? K : never : never : never;
+
+interface UI<C extends FlowConfig> {
+    page: UiPage<C>;
+    display: UiDisplayElements;
+    inputs: UiInputsElements;
+    select: UiSelectElements;
+}
+type UiInputsElements = {
+    text: UiElementInputText;
+    number: UiElementInputNumber;
+    boolean: UiElementInputBoolean;
+};
+type UiSelectElements = {
+    single: UiElementSelectOne;
+};
+type UiDisplayElements = {
+    divider: UiElementDivider;
+    markdown: UiElementMarkdown;
+    table: UiElementTable;
+};
+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;
+type UIElements = (InputElementResponse<string, any> | DisplayElementResponse)[];
+interface UIElementBase {
+    _type: string;
+}
+interface InputElementResponse<N extends string, V> extends UIElementBase {
+    _type: "input";
+    name: N;
+    valueType: V;
+}
+interface DisplayElementResponse extends UIElementBase {
+    _type: "display";
+}
+interface BaseInputConfig<T> {
+    label?: string;
+    defaultValue?: T;
+    helpText?: string;
+    optional?: boolean;
+    disabled?: boolean;
+    validate?: (data: T) => Promise<boolean | string>;
+}
+
+interface StepContext<C extends FlowConfig> {
+    step: <R = any>(name: string, fn: () => Promise<R>, opts?: Opts) => Promise<R> & {
+        catch: (errorHandler: (err: Error) => Promise<void> | void) => Promise<any>;
+    };
+    ui: UI<C>;
+}
+interface FlowConfig {
+    stages?: StageConfig[];
+    title?: string;
+    description?: string;
+}
+type FlowFunction<C extends FlowConfig, I extends any = {}> = (ctx: StepContext<C>, inputs: I) => Promise<void>;
+type StageConfig = string | {
+    key: string;
+    name: string;
+    description?: string;
+    initiallyHidden?: boolean;
+};
+type Opts = {
+    maxRetries?: number;
+    timeoutInMs?: number;
+};
+
+export { type BooleanArrayQueryWhereCondition, type BooleanArrayWhereCondition, type BooleanWhereCondition, type ContextAPI, type DateArrayQueryWhereCondition, type DateArrayWhereCondition, type DateQueryInput, type DateWhereCondition, Duration, type DurationString, type DurationWhereCondition, type Errors, File, type FileDbRecord, type FileWriteTypes, type FlowConfig, type FlowFunction, type FuncWithConfig, type FunctionConfig, type IDWhereCondition, InlineFile, type InlineFileConstructor, type NumberArrayQueryWhereCondition, type NumberArrayWhereCondition, type NumberWhereCondition, type PageInfo, Permissions, type RelativeDateString, type RequestHeaders, type Response, type SortDirection, type StepContext, type StringArrayQueryWhereCondition, type StringArrayWhereCondition, type StringWhereCondition, type TimestampQueryInput, type UI };