@botpress/runtime 1.0.1

package/dist/primitives/table.d.ts

@@ -0,0 +1,153 @@
+import { Definitions } from "./definition";
+import { z } from "@bpinternal/zui";
+import { Table } from "@botpress/client";
+import { ZuiObjectSchema } from "@botpress/sdk";
+import { TableDefinitions } from "../_types/tables";
+export declare namespace Typings {
+    type ColumnDefinition<TName extends string = string> = {
+        computed?: boolean;
+        searchable?: boolean;
+        schema: z.ZodTypeAny;
+        dependencies?: ReadonlyArray<keyof TableDefinitions[TName]["Output"]>;
+        value?: (row: any) => Promise<any>;
+    };
+    type Props<TName extends string = string> = {
+        name: TName;
+        description?: string;
+        factor?: number;
+        columns: Record<string, z.ZodTypeAny | ColumnDefinition<TName>>;
+    };
+    const Primitive: "table";
+}
+type NestedKeyOf<T> = T extends object ? {
+    [K in keyof T & string]: K | (T[K] extends (infer U)[] ? K | `${K}.${number}` | (U extends object ? `${K}.${number}.${NestedKeyOf<U>}` : never) : T[K] extends object ? K | `${K}.${NestedKeyOf<T[K]>}` : K);
+}[keyof T & string] : never;
+export type PrimitiveFilter<T> = {
+    $eq?: T;
+    $gt?: T;
+    $gte?: T;
+    $lt?: T;
+    $lte?: T;
+    $ne?: T;
+    $in?: T[];
+    $nin?: T[];
+    $exists?: boolean;
+    $regex?: string;
+    $options?: "i" | "c";
+};
+export type LogicalFilter<TColumns, TName extends string = string> = {
+    $and?: TableFilter<TColumns, TName>[];
+    $or?: TableFilter<TColumns, TName>[];
+    $not?: TableFilter<TColumns, TName>;
+};
+export type TableFilter<TColumns, TName extends string = string> = {
+    [K in keyof TColumns]?: TColumns[K] | PrimitiveFilter<TColumns[K]>;
+} & {
+    [K in NestedKeyOf<TColumns>]?: any | PrimitiveFilter<any>;
+} & LogicalFilter<TColumns, TName>;
+export type OrderDirection = "asc" | "desc";
+type NumberAggregations = "key" | "count" | "sum" | "avg" | "max" | "min" | "unique";
+type StringAggregations = "key" | "count" | "max" | "min" | "unique";
+type DateAggregations = "key" | "count" | "max" | "min" | "unique";
+type BooleanAggregations = "key" | "count" | "unique";
+type ArrayAggregations = "key" | "count" | "unique";
+type ObjectAggregations = "key" | "count" | "unique";
+type GetAggregations<T> = T extends number ? NumberAggregations : T extends string ? StringAggregations : T extends Date ? DateAggregations : T extends boolean ? BooleanAggregations : T extends any[] ? ArrayAggregations : T extends object ? ObjectAggregations : "key" | "count" | "unique";
+type GetTypeAtPath<T, Path> = Path extends `${infer K}.${infer Rest}` ? K extends keyof T ? GetTypeAtPath<T[K], Rest> : any : Path extends keyof T ? T[Path] : any;
+export type TableGroup<TColumns> = {
+    [K in NestedKeyOf<TColumns>]?: GetAggregations<GetTypeAtPath<TColumns, K>> | GetAggregations<GetTypeAtPath<TColumns, K>>[];
+};
+type CamelCasePath<S extends string> = S extends `${infer A}.${infer B}` ? `${A}${Capitalize<CamelCasePath<B>>}` : S;
+type AggregatedFieldName<Path extends string, Op extends string> = Op extends "key" ? `${CamelCasePath<Path>}Key` : `${CamelCasePath<Path>}${Capitalize<Op>}`;
+type AggregationResultType<T, Op extends string> = Op extends "count" ? number : Op extends "sum" ? number : Op extends "avg" ? number : Op extends "max" ? T : Op extends "min" ? T : Op extends "unique" ? T[] : Op extends "key" ? T : never;
+type GroupResultShape<TColumns, TGroup> = TGroup extends TableGroup<TColumns> ? {
+    [K in keyof TGroup as TGroup[K] extends string ? AggregatedFieldName<K & string, TGroup[K]> : TGroup[K] extends readonly string[] ? TGroup[K][number] extends string ? AggregatedFieldName<K & string, TGroup[K][number]> : never : never]: TGroup[K] extends string ? AggregationResultType<GetTypeAtPath<TColumns, K & string>, TGroup[K]> : TGroup[K] extends readonly string[] ? TGroup[K][number] extends string ? AggregationResultType<GetTypeAtPath<TColumns, K & string>, TGroup[K][number]> : never : never;
+} : never;
+export interface FindRowsOptions<TName extends string> {
+    filter?: TableFilter<TableDefinitions[TName]["Input"], TName>;
+    orderBy?: keyof TableDefinitions[TName]["Output"];
+    orderDirection?: OrderDirection;
+    limit?: number;
+    offset?: number;
+    search?: string;
+    group?: TableGroup<TableDefinitions[TName]["Output"]>;
+}
+type Row<Shape> = {
+    id: number;
+    createdAt: string;
+    updatedAt: string;
+} & Shape;
+type SearchResult<Shape> = {
+    id: number;
+    createdAt: string;
+    updatedAt: string;
+    similarity: number;
+} & Shape;
+export declare class BaseTable<TName extends string = string> implements Definitions.Primitive {
+    readonly name: TName;
+    readonly description?: string;
+    readonly factor: number;
+    readonly columns: Record<string, Typings.ColumnDefinition<TName>>;
+    readonly schema: ZuiObjectSchema;
+    readonly nullableColumns: Set<string>;
+    readonly searchableColumns: Set<string>;
+    readonly computedColumns: Set<string>;
+    private get client();
+    constructor(props: Typings.Props<TName>);
+    getRow(props: {
+        id: number;
+    }): Promise<Row<TableDefinitions[TName]["Output"]>>;
+    findRows<TOptions extends FindRowsOptions<TName>>(options?: TOptions): Promise<{
+        rows: TOptions["group"] extends TableGroup<TableDefinitions[TName]["Output"]> ? GroupResultShape<TableDefinitions[TName]["Output"], TOptions["group"]>[] : SearchResult<TableDefinitions[TName]["Output"]>[];
+        hasMore: boolean;
+        limit: number;
+        offset: number;
+    }>;
+    createRows({ rows, waitComputed, }: {
+        rows: TableDefinitions[TName]["Input"][];
+        waitComputed?: boolean;
+    }): Promise<{
+        rows: Row<TableDefinitions[TName]["Output"]>[];
+        errors?: string[];
+        warnings?: string[];
+    }>;
+    deleteAllRows(): Promise<{
+        deletedRows: number;
+    }>;
+    deleteRowIds(ids: number[]): Promise<{
+        deletedRows: number;
+    }>;
+    deleteRows(filter: FindRowsOptions<TName>["filter"]): Promise<{
+        deletedRows: number;
+    }>;
+    updateRows(props: {
+        rows: (Partial<TableDefinitions[TName]["Input"]> & {
+            id: number;
+        })[];
+        waitComputed?: boolean;
+    }): Promise<{
+        rows: Row<TableDefinitions[TName]["Output"]>[];
+        errors?: string[];
+        warnings?: string[];
+    }>;
+    upsertRows(props: {
+        rows: (Partial<TableDefinitions[TName]["Input"]> & {
+            id?: number;
+        })[];
+        waitComputed?: boolean;
+        keyColumn?: keyof TableDefinitions[TName]["Input"];
+    }): Promise<{
+        updated: Row<TableDefinitions[TName]["Output"]>[];
+        inserted: Row<TableDefinitions[TName]["Output"]>[];
+        errors?: string[];
+        warnings?: string[];
+    }>;
+    getTable(): Promise<{
+        rows: number;
+        stale: number;
+        indexing: number;
+        table: Table;
+    }>;
+}
+export { BaseTable as Table };
+//# sourceMappingURL=table.d.ts.map

package/dist/primitives/table.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"table.d.ts","sourceRoot":"","sources":["../../src/primitives/table.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAC3C,OAAO,EAAc,CAAC,EAAE,MAAM,iBAAiB,CAAC;AAChD,OAAO,EAAU,KAAK,EAAE,MAAM,kBAAkB,CAAC;AAEjD,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAEhD,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAEpD,yBAAiB,OAAO,CAAC;IACvB,KAAY,gBAAgB,CAAC,KAAK,SAAS,MAAM,GAAG,MAAM,IAAI;QAC5D,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,UAAU,CAAC,EAAE,OAAO,CAAC;QACrB,MAAM,EAAE,CAAC,CAAC,UAAU,CAAC;QACrB,YAAY,CAAC,EAAE,aAAa,CAAC,MAAM,gBAAgB,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;QACtE,KAAK,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,OAAO,CAAC,GAAG,CAAC,CAAC;KACpC,CAAC;IAEF,KAAY,KAAK,CAAC,KAAK,SAAS,MAAM,GAAG,MAAM,IAAI;QACjD,IAAI,EAAE,KAAK,CAAC;QACZ,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,UAAU,GAAG,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC;KACjE,CAAC;IAEK,MAAM,SAAS,EAAG,OAAgB,CAAC;CAC3C;AAGD,KAAK,WAAW,CAAC,CAAC,IAAI,CAAC,SAAS,MAAM,GAClC;KACG,CAAC,IAAI,MAAM,CAAC,GAAG,MAAM,GAClB,CAAC,GACD,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,GAEjB,CAAC,GACD,GAAG,CAAC,IAAI,MAAM,EAAE,GAChB,CAAC,CAAC,SAAS,MAAM,GACb,GAAG,CAAC,IAAI,MAAM,IAAI,WAAW,CAAC,CAAC,CAAC,EAAE,GAClC,KAAK,CAAC,GACd,CAAC,CAAC,CAAC,CAAC,SAAS,MAAM,GACjB,CAAC,GAAG,GAAG,CAAC,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,GAC/B,CAAC,CAAC;CACb,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,GACnB,KAAK,CAAC;AAGV,MAAM,MAAM,eAAe,CAAC,CAAC,IAAI;IAC/B,GAAG,CAAC,EAAE,CAAC,CAAC;IACR,GAAG,CAAC,EAAE,CAAC,CAAC;IACR,IAAI,CAAC,EAAE,CAAC,CAAC;IACT,GAAG,CAAC,EAAE,CAAC,CAAC;IACR,IAAI,CAAC,EAAE,CAAC,CAAC;IACT,GAAG,CAAC,EAAE,CAAC,CAAC;IACR,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC;IACV,IAAI,CAAC,EAAE,CAAC,EAAE,CAAC;IACX,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,GAAG,GAAG,GAAG,CAAC;CACtB,CAAC;AAEF,MAAM,MAAM,aAAa,CAAC,QAAQ,EAAE,KAAK,SAAS,MAAM,GAAG,MAAM,IAAI;IACnE,IAAI,CAAC,EAAE,WAAW,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAE,CAAC;IACtC,GAAG,CAAC,EAAE,WAAW,CAAC,QAAQ,EAAE,KAAK,CAAC,EAAE,CAAC;IACrC,IAAI,CAAC,EAAE,WAAW,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;CACrC,CAAC;AAGF,MAAM,MAAM,WAAW,CAAC,QAAQ,EAAE,KAAK,SAAS,MAAM,GAAG,MAAM,IAAI;KAChE,CAAC,IAAI,MAAM,QAAQ,CAAC,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,eAAe,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;CACnE,GAAG;KACD,CAAC,IAAI,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,GAAG,GAAG,eAAe,CAAC,GAAG,CAAC;CAC1D,GAAG,aAAa,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;AAEnC,MAAM,MAAM,cAAc,GAAG,KAAK,GAAG,MAAM,CAAC;AAG5C,KAAK,kBAAkB,GACnB,KAAK,GACL,OAAO,GACP,KAAK,GACL,KAAK,GACL,KAAK,GACL,KAAK,GACL,QAAQ,CAAC;AACb,KAAK,kBAAkB,GAAG,KAAK,GAAG,OAAO,GAAG,KAAK,GAAG,KAAK,GAAG,QAAQ,CAAC;AACrE,KAAK,gBAAgB,GAAG,KAAK,GAAG,OAAO,GAAG,KAAK,GAAG,KAAK,GAAG,QAAQ,CAAC;AACnE,KAAK,mBAAmB,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,CAAC;AACtD,KAAK,iBAAiB,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,CAAC;AACpD,KAAK,kBAAkB,GAAG,KAAK,GAAG,OAAO,GAAG,QAAQ,CAAC;AAGrD,KAAK,eAAe,CAAC,CAAC,IAAI,CAAC,SAAS,MAAM,GACtC,kBAAkB,GAClB,CAAC,SAAS,MAAM,GACd,kBAAkB,GAClB,CAAC,SAAS,IAAI,GACZ,gBAAgB,GAChB,CAAC,SAAS,OAAO,GACf,mBAAmB,GACnB,CAAC,SAAS,GAAG,EAAE,GACb,iBAAiB,GACjB,CAAC,SAAS,MAAM,GACd,kBAAkB,GAClB,KAAK,GAAG,OAAO,GAAG,QAAQ,CAAC;AAGzC,KAAK,aAAa,CAAC,CAAC,EAAE,IAAI,IAAI,IAAI,SAAS,GAAG,MAAM,CAAC,IAAI,MAAM,IAAI,EAAE,GACjE,CAAC,SAAS,MAAM,CAAC,GACf,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,GACzB,GAAG,GACL,IAAI,SAAS,MAAM,CAAC,GAClB,CAAC,CAAC,IAAI,CAAC,GACP,GAAG,CAAC;AAGV,MAAM,MAAM,UAAU,CAAC,QAAQ,IAAI;KAChC,CAAC,IAAI,WAAW,CAAC,QAAQ,CAAC,CAAC,CAAC,EACzB,eAAe,CAAC,aAAa,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,GAC3C,eAAe,CAAC,aAAa,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE;CAClD,CAAC;AAGF,KAAK,aAAa,CAAC,CAAC,SAAS,MAAM,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,IAAI,MAAM,CAAC,EAAE,GACpE,GAAG,CAAC,GAAG,UAAU,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,EAAE,GACrC,CAAC,CAAC;AAGN,KAAK,mBAAmB,CACtB,IAAI,SAAS,MAAM,EACnB,EAAE,SAAS,MAAM,IACf,EAAE,SAAS,KAAK,GAChB,GAAG,aAAa,CAAC,IAAI,CAAC,KAAK,GAC3B,GAAG,aAAa,CAAC,IAAI,CAAC,GAAG,UAAU,CAAC,EAAE,CAAC,EAAE,CAAC;AAG9C,KAAK,qBAAqB,CAAC,CAAC,EAAE,EAAE,SAAS,MAAM,IAAI,EAAE,SAAS,OAAO,GACjE,MAAM,GACN,EAAE,SAAS,KAAK,GACd,MAAM,GACN,EAAE,SAAS,KAAK,GACd,MAAM,GACN,EAAE,SAAS,KAAK,GACd,CAAC,GACD,EAAE,SAAS,KAAK,GACd,CAAC,GACD,EAAE,SAAS,QAAQ,GACjB,CAAC,EAAE,GACH,EAAE,SAAS,KAAK,GACd,CAAC,GACD,KAAK,CAAC;AAGtB,KAAK,gBAAgB,CAAC,QAAQ,EAAE,MAAM,IACpC,MAAM,SAAS,UAAU,CAAC,QAAQ,CAAC,GAC/B;KACG,CAAC,IAAI,MAAM,MAAM,IAAI,MAAM,CAAC,CAAC,CAAC,SAAS,MAAM,GAC1C,mBAAmB,CAAC,CAAC,GAAG,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,GAC1C,MAAM,CAAC,CAAC,CAAC,SAAS,SAAS,MAAM,EAAE,GACjC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,MAAM,GAC9B,mBAAmB,CAAC,CAAC,GAAG,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,GAClD,KAAK,GACP,KAAK,GAAG,MAAM,CAAC,CAAC,CAAC,SAAS,MAAM,GAClC,qBAAqB,CACnB,aAAa,CAAC,QAAQ,EAAE,CAAC,GAAG,MAAM,CAAC,EACnC,MAAM,CAAC,CAAC,CAAC,CACV,GACD,MAAM,CAAC,CAAC,CAAC,SAAS,SAAS,MAAM,EAAE,GACjC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,SAAS,MAAM,GAC9B,qBAAqB,CACnB,aAAa,CAAC,QAAQ,EAAE,CAAC,GAAG,MAAM,CAAC,EACnC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAClB,GACD,KAAK,GACP,KAAK;CACZ,GACD,KAAK,CAAC;AAEZ,MAAM,WAAW,eAAe,CAAC,KAAK,SAAS,MAAM;IACnD,MAAM,CAAC,EAAE,WAAW,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,EAAE,KAAK,CAAC,CAAC;IAC9D,OAAO,CAAC,EAAE,MAAM,gBAAgB,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,CAAC;IAClD,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,UAAU,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;CACvD;AAED,KAAK,GAAG,CAAC,KAAK,IAAI;IAChB,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB,GAAG,KAAK,CAAC;AAEV,KAAK,YAAY,CAAC,KAAK,IAAI;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;CACpB,GAAG,KAAK,CAAC;AAEV,qBAAa,SAAS,CAAC,KAAK,SAAS,MAAM,GAAG,MAAM,CAClD,YAAW,WAAW,CAAC,SAAS;IAEhC,SAAgB,IAAI,EAAE,KAAK,CAAC;IAC5B,SAAgB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrC,SAAgB,MAAM,EAAE,MAAM,CAAC;IAC/B,SAAgB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,CAAC;IACzE,SAAgB,MAAM,EAAE,eAAe,CAAC;IAExC,SAAgB,eAAe,EAAE,GAAG,CAAC,MAAM,CAAC,CAAa;IACzD,SAAgB,iBAAiB,EAAE,GAAG,CAAC,MAAM,CAAC,CAAa;IAC3D,SAAgB,eAAe,EAAE,GAAG,CAAC,MAAM,CAAC,CAAa;IAEzD,OAAO,KAAK,MAAM,GAEjB;gBAEW,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC;IAwGjC,MAAM,CAAC,KAAK,EAAE;QAClB,EAAE,EAAE,MAAM,CAAC;KACZ,GAAG,OAAO,CAAC,GAAG,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;IAS7C,QAAQ,CAAC,QAAQ,SAAS,eAAe,CAAC,KAAK,CAAC,EACpD,OAAO,GAAE,QAAyB,GACjC,OAAO,CAAC;QACT,IAAI,EAAE,QAAQ,CAAC,OAAO,CAAC,SAAS,UAAU,CACxC,gBAAgB,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,CAClC,GACG,gBAAgB,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC,EAAE,GACxE,YAAY,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC;QACtD,OAAO,EAAE,OAAO,CAAC;QACjB,KAAK,EAAE,MAAM,CAAC;QACd,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;IA8BI,UAAU,CAAC,EACf,IAAI,EACJ,YAAY,GACb,EAAE;QACD,IAAI,EAAE,gBAAgB,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC;QACzC,YAAY,CAAC,EAAE,OAAO,CAAC;KACxB,GAAG,OAAO,CAAC;QACV,IAAI,EAAE,GAAG,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC;QAC/C,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;QAClB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;KACrB,CAAC;IAaI,aAAa,IAAI,OAAO,CAAC;QAAE,WAAW,EAAE,MAAM,CAAA;KAAE,CAAC;IAOjD,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC;QAAE,WAAW,EAAE,MAAM,CAAA;KAAE,CAAC;IAO7D,UAAU,CACd,MAAM,EAAE,eAAe,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,GACvC,OAAO,CAAC;QAAE,WAAW,EAAE,MAAM,CAAA;KAAE,CAAC;IAO7B,UAAU,CAAC,KAAK,EAAE;QACtB,IAAI,EAAE,CAAC,OAAO,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG;YAAE,EAAE,EAAE,MAAM,CAAA;SAAE,CAAC,EAAE,CAAC;QACrE,YAAY,CAAC,EAAE,OAAO,CAAC;KACxB,GAAG,OAAO,CAAC;QACV,IAAI,EAAE,GAAG,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC;QAC/C,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;QAClB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;KACrB,CAAC;IAcI,UAAU,CAAC,KAAK,EAAE;QACtB,IAAI,EAAE,CAAC,OAAO,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG;YACjD,EAAE,CAAC,EAAE,MAAM,CAAC;SACb,CAAC,EAAE,CAAC;QACL,YAAY,CAAC,EAAE,OAAO,CAAC;QACvB,SAAS,CAAC,EAAE,MAAM,gBAAgB,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC;KACpD,GAAG,OAAO,CAAC;QACV,OAAO,EAAE,GAAG,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC;QAClD,QAAQ,EAAE,GAAG,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC;QACnD,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;QAClB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;KACrB,CAAC;IAgBI,QAAQ,IAAI,OAAO,CAAC;QACxB,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;QACd,QAAQ,EAAE,MAAM,CAAC;QACjB,KAAK,EAAE,KAAK,CAAC;KACd,CAAC;CAWH;AAGD,OAAO,EAAE,SAAS,IAAI,KAAK,EAAE,CAAC"}

package/dist/primitives/trigger.d.ts

@@ -0,0 +1,26 @@
+import { Definitions } from "./definition";
+import { EventName } from "../_types/events";
+import { Triggers } from "../_types/triggers";
+export declare namespace Typings {
+    type TriggerHandlerProps<TName extends keyof Triggers> = {
+        event: TName extends keyof Triggers ? Triggers[TName]["event"] : any;
+    };
+    type Props<TName extends keyof Triggers = keyof Triggers> = {
+        name: TName;
+        description?: string;
+        events: EventName[];
+        /**
+         * Handler function that receives the matched event
+         */
+        handler: (props: TriggerHandlerProps<TName>) => Promise<void> | void;
+    };
+    const Primitive: "trigger";
+}
+export declare class Trigger<TName extends keyof Triggers> implements Definitions.Primitive {
+    readonly name: TName;
+    readonly description: string | undefined;
+    readonly events: EventName[];
+    readonly handler: Typings.Props<TName>["handler"];
+    constructor(props: Typings.Props<TName>);
+}
+//# sourceMappingURL=trigger.d.ts.map

package/dist/primitives/trigger.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"trigger.d.ts","sourceRoot":"","sources":["../../src/primitives/trigger.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,WAAW,EAAE,MAAM,cAAc,CAAC;AAG3C,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAE9C,yBAAiB,OAAO,CAAC;IACvB,KAAY,mBAAmB,CAAC,KAAK,SAAS,MAAM,QAAQ,IAAI;QAC9D,KAAK,EAAE,KAAK,SAAS,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,GAAG,GAAG,CAAC;KACtE,CAAC;IAEF,KAAY,KAAK,CAAC,KAAK,SAAS,MAAM,QAAQ,GAAG,MAAM,QAAQ,IAAI;QACjE,IAAI,EAAE,KAAK,CAAC;QACZ,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,MAAM,EAAE,SAAS,EAAE,CAAC;QACpB;;WAEG;QACH,OAAO,EAAE,CAAC,KAAK,EAAE,mBAAmB,CAAC,KAAK,CAAC,KAAK,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI,CAAC;KACtE,CAAC;IAEK,MAAM,SAAS,EAAG,SAAkB,CAAC;CAC7C;AAmBD,qBAAa,OAAO,CAAC,KAAK,SAAS,MAAM,QAAQ,CAC/C,YAAW,WAAW,CAAC,SAAS;IAEhC,SAAgB,IAAI,EAAE,KAAK,CAAC;IAC5B,SAAgB,WAAW,EAAE,MAAM,GAAG,SAAS,CAAC;IAChD,SAAgB,MAAM,EAAE,SAAS,EAAE,CAAC;IACpC,SAAgB,OAAO,EAAE,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,CAAC;gBAE7C,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC;CAwBxC"}

package/dist/primitives/workflow-instance.d.ts

@@ -0,0 +1,80 @@
+import { Workflow, type Client } from "@botpress/client";
+import { z } from "@botpress/sdk";
+import { BotClient } from "@botpress/sdk/dist/bot";
+import { WorkflowDefinitions } from "../_types/workflows";
+import { Autonomous } from "../runtime/autonomous";
+import { TrackedState } from "../runtime/index";
+export type WorkflowStepContext = {
+    output?: unknown;
+    attempts: number;
+    startedAt: string;
+    finishedAt?: string;
+    steps?: Record<string, WorkflowStepContext>;
+};
+declare const StepSymbol: unique symbol;
+type StepExecutionSignal = {
+    [StepSymbol]: true;
+};
+export declare function isStepSignal(e: unknown): e is StepExecutionSignal;
+export declare function createStepSignal(): StepExecutionSignal;
+/**
+ * Base class for all workflow instances
+ */
+export declare class BaseWorkflowInstance<TName extends keyof WorkflowDefinitions> {
+    readonly id: string;
+    readonly name: TName;
+    readonly key?: string | undefined;
+    readonly input: WorkflowDefinitions[TName]["input"];
+    readonly createdAt: Date;
+    readonly updatedAt: Date;
+    readonly client: BotClient<any>;
+    readonly status: string;
+    readonly workflow: Workflow;
+    set state(state: WorkflowDefinitions[TName]["state"]);
+    get state(): WorkflowDefinitions[TName]["state"];
+    constructor(workflow: Workflow, client: BotClient<any>);
+    static readonly Primitive: "workflow_instance";
+    static load<TName extends keyof WorkflowDefinitions>(props: {
+        id: string;
+        workflow?: Workflow;
+    }): Promise<BaseWorkflowInstance<TName>>;
+    /**
+     * Executes the workflow with the provided autonomous engine configuration.
+     * Workflows always run in "worker" mode (no chat capabilities).
+     */
+    execute(props: Autonomous.Props): Promise<import("llmz").ExecutionResult>;
+    /**
+     * Provide data in response to a workflow data request (instance method).
+     * Call this method from a conversation handler when you receive a WorkflowDataRequestEvent.
+     * @param request - The name of the request being responded to
+     * @param data - The data to provide to the workflow
+     * @example
+     * if (type === 'workflow_request') {
+     *   await workflow.provide('topic', { topic: "Hello" });
+     * }
+     */
+    provide<TRequest extends keyof WorkflowDefinitions[TName]["requests"] & string>(request: TRequest, data: WorkflowDefinitions[TName]["requests"][TRequest]): Promise<void>;
+    /**
+     * Returns a string representation for console.log
+     */
+    toString(): string;
+    /**
+     * Returns a JSON representation for serialization
+     */
+    toJSON(): any;
+}
+export declare function createWorkflowExecutionState(client: Client, workflowId: string): TrackedState<import("@bpinternal/zui").ZodDefault<import("@bpinternal/zui").ZodObject<{
+    executionCount: import("@bpinternal/zui").ZodDefault<import("@bpinternal/zui").ZodNumber>;
+    revision: import("@bpinternal/zui").ZodDefault<import("@bpinternal/zui").ZodNumber>;
+    steps: import("@bpinternal/zui").ZodRecord<import("@bpinternal/zui").ZodString, z.ZodType<WorkflowStepContext>>;
+}, "strip", {
+    executionCount: number;
+    revision: number;
+    steps: Record<string, WorkflowStepContext>;
+}, {
+    steps: Record<string, WorkflowStepContext>;
+    executionCount?: number | undefined;
+    revision?: number | undefined;
+}>>>;
+export {};
+//# sourceMappingURL=workflow-instance.d.ts.map

package/dist/primitives/workflow-instance.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflow-instance.d.ts","sourceRoot":"","sources":["../../src/primitives/workflow-instance.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,KAAK,MAAM,EAAE,MAAM,kBAAkB,CAAC;AACzD,OAAO,EAAE,CAAC,EAAE,MAAM,eAAe,CAAC;AAClC,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAEnD,OAAO,EAAE,mBAAmB,EAAmB,MAAM,qBAAqB,CAAC;AAG3E,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAEL,YAAY,EAGb,MAAM,kBAAkB,CAAC;AAK1B,MAAM,MAAM,mBAAmB,GAAG;IAChC,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;CAC7C,CAAC;AAwBF,QAAA,MAAM,UAAU,eAA2B,CAAC;AAE5C,KAAK,mBAAmB,GAAG;IACzB,CAAC,UAAU,CAAC,EAAE,IAAI,CAAC;CACpB,CAAC;AAEF,wBAAgB,YAAY,CAAC,CAAC,EAAE,OAAO,GAAG,CAAC,IAAI,mBAAmB,CAEjE;AAED,wBAAgB,gBAAgB,IAAI,mBAAmB,CAItD;AAED;;GAEG;AACH,qBAAa,oBAAoB,CAAC,KAAK,SAAS,MAAM,mBAAmB;IACvE,SAAgB,EAAE,EAAE,MAAM,CAAC;IAC3B,SAAgB,IAAI,EAAE,KAAK,CAAC;IAC5B,SAAgB,GAAG,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IACzC,SAAgB,KAAK,EAAE,mBAAmB,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC;IAC3D,SAAgB,SAAS,EAAE,IAAI,CAAC;IAChC,SAAgB,SAAS,EAAE,IAAI,CAAC;IAChC,SAAgB,MAAM,EAAE,SAAS,CAAC,GAAG,CAAC,CAAC;IACvC,SAAgB,MAAM,EAAE,MAAM,CAAC;IAC/B,SAAgB,QAAQ,EAAE,QAAQ,CAAC;IAKnC,IAAI,KAAK,CAAC,KAAK,EAAE,mBAAmB,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,EAEnD;IAED,IAAI,KAAK,IAAI,mBAAmB,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAE/C;gBAEW,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,SAAS,CAAC,GAAG,CAAC;IAwBtD,MAAM,CAAC,QAAQ,CAAC,SAAS,EAAG,mBAAmB,CAAU;WAE5C,IAAI,CAAC,KAAK,SAAS,MAAM,mBAAmB,EAAE,KAAK,EAAE;QAChE,EAAE,EAAE,MAAM,CAAC;QACX,QAAQ,CAAC,EAAE,QAAQ,CAAC;KACrB,GAAG,OAAO,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;IAgBxC;;;OAGG;IACG,OAAO,CAAC,KAAK,EAAE,UAAU,CAAC,KAAK;IAQrC;;;;;;;;;OASG;IACG,OAAO,CAAC,QAAQ,SAAS,MAAM,mBAAmB,CAAC,KAAK,CAAC,CAAC,UAAU,CAAC,GAAG,MAAM,EAClF,OAAO,EAAE,QAAQ,EACjB,IAAI,EAAE,mBAAmB,CAAC,KAAK,CAAC,CAAC,UAAU,CAAC,CAAC,QAAQ,CAAC,GACrD,OAAO,CAAC,IAAI,CAAC;IAyKhB;;OAEG;IACH,QAAQ,IAAI,MAAM;IAKlB;;OAEG;IACH,MAAM,IAAI,GAAG;CAkBd;AAED,wBAAgB,4BAA4B,CAC1C,MAAM,EAAE,MAAM,EACd,UAAU,EAAE,MAAM;;;;;;;;;;;;KASnB"}

package/dist/primitives/workflow-step.d.ts

@@ -0,0 +1,184 @@
+import type { Workflow } from "@botpress/client";
+import type { BaseWorkflow } from "./workflow";
+import type { ZuiType } from "../types";
+import { z, type ZodType } from "@botpress/sdk";
+type WorkflowStepOptions = {
+    maxAttempts?: number;
+};
+type MapOptions = {
+    maxAttempts?: number;
+    concurrency?: number;
+};
+/**
+ * Workflow step execution API. Steps are the building blocks of workflows with automatic retry logic and state persistence.
+ */
+export interface WorkflowStep {
+    /**
+     * Execute a workflow step with automatic retry logic and state persistence.
+     * Steps are idempotent and resumable - if a step has already been executed, its cached result is returned immediately.
+     * @param name - Unique identifier for this step within the workflow
+     * @param run - Function to execute, receives the current attempt number
+     * @param options - Configuration options
+     * @param options.maxAttempts - Maximum number of retry attempts (default: 5)
+     * @returns The result of the step execution
+     * @example
+     * const data = await step("fetch-user", async () => {
+     *   return await fetchUser(userId);
+     * });
+     */
+    <T>(name: string, run: ({ attempt }: {
+        attempt: number;
+    }) => T | Promise<T>, options?: WorkflowStepOptions): Promise<T>;
+    /**
+     * Put the workflow into listening mode, waiting for external events to resume.
+     * The workflow will pause at this step and can be resumed by triggering it with an event.
+     * @param name - The name of the step
+     * @example
+     * await step.listen("wait-for-approval");
+     * // Workflow pauses here until an event triggers it to continue
+     */
+    listen(name: string): Promise<void>;
+    /**
+     * Mark the workflow as failed with a specific reason and stop execution.
+     * This immediately terminates the workflow and sets its status to "failed".
+     * @param reason - Description of why the workflow failed
+     * @example
+     * if (!user.isVerified) {
+     *   await step.fail("User verification required");
+     * }
+     */
+    fail(reason: string): Promise<void>;
+    /**
+     * Record a progress checkpoint in the workflow without performing any action.
+     * Useful for tracking workflow execution stages and creating audit trails.
+     * @param name - The name of the progress checkpoint
+     * @example
+     * await step.progress("Started processing");
+     * // ... do work ...
+     * await step.progress("Finished processing");
+     */
+    progress(name: string): Promise<void>;
+    /**
+     * Immediately abort the workflow execution without marking it as failed.
+     * The workflow status remains unchanged and can potentially be resumed later.
+     * This is different from step.fail() which marks the workflow as failed.
+     * @example
+     * if (shouldPause) {
+     *   step.abort(); // Stop execution but keep workflow in current state
+     * }
+     */
+    abort(): void;
+    /**
+     * Pause workflow execution for the specified duration in milliseconds.
+     * For delays >= 10 seconds, the workflow enters listening mode to save resources.
+     * For shorter delays, uses an in-memory timeout.
+     * @param name - The name of the step
+     * @param ms - Duration to sleep in milliseconds
+     * @example
+     * await step.sleep("wait-5-min", 5 * 60 * 1000);
+     * await step.sleep("short-delay", 1000);
+     */
+    sleep(name: string, ms: number): Promise<void>;
+    /**
+     * Sleep until the specified date, minus a buffer to ensure the step can complete before the workflow times out.
+     * If the date is in the past, the step will return immediately.
+     * @param name - The name of the step
+     * @param date - The date to sleep until
+     * @example
+     * await step.sleepUntil("wait-until-noon", new Date("2025-01-15T12:00:00Z"));
+     */
+    sleepUntil(name: string, date: Date | string): Promise<void>;
+    /**
+     * Wait for another workflow to complete before continuing.
+     * The current workflow will pause and poll until the target workflow finishes.
+     * @param name - The name of the step
+     * @param workflowId - ID of the workflow to wait for
+     * @returns The completed workflow object
+     * @throws Error if attempting to wait for the same workflow (would cause deadlock)
+     * @example
+     * const childWorkflow = await childWorkflowInstance.start({});
+     * const result = await step.waitForWorkflow("wait-for-child", childWorkflow.id);
+     */
+    waitForWorkflow(name: string, workflowId: string): Promise<Workflow>;
+    /**
+     * Start another workflow and wait for it to complete, returning its output.
+     * This is a convenience method that combines workflow.start() and step.waitForWorkflow().
+     * @param name - The name of the step
+     * @param workflow - The workflow instance to execute
+     * @returns The output of the completed workflow
+     * @example
+     * const processedData = await step.executeWorkflow(
+     *   "process-data",
+     *   dataProcessingWorkflow
+     * );
+     */
+    executeWorkflow<TName extends string, TInput extends ZuiType, TOutput extends ZodType>(name: string, workflow: BaseWorkflow<TName, TInput, TOutput>, input?: z.infer<TInput>): Promise<z.infer<TOutput>>;
+    /**
+     * Process an array of items in parallel with controlled concurrency, collecting results.
+     * Each item is processed in its own step with automatic retry logic.
+     * @param name - The name of the map operation
+     * @param items - Array of items to process
+     * @param run - Function to process each item, receives the item and its index
+     * @param opts - Configuration options
+     * @param opts.maxAttempts - Maximum retry attempts per item (default: 5)
+     * @param opts.concurrency - Maximum number of concurrent operations (default: 1)
+     * @returns Array of results in the same order as input items
+     * @example
+     * const results = await step.map(
+     *   "process-users",
+     *   users,
+     *   async (user, { i }) => processUser(user),
+     *   { concurrency: 5 }
+     * );
+     */
+    map<T, U>(name: string, items: T[], run: (input: T, opts: {
+        i: number;
+    }) => Promise<U>, opts?: MapOptions): Promise<U[]>;
+    /**
+     * Process an array of items in parallel without collecting results.
+     * Similar to step.map but doesn't return an array of results (for side effects only).
+     * @param name - The name of the forEach operation
+     * @param items - Array of items to process
+     * @param run - Function to process each item, receives the item and its index
+     * @param opts - Configuration options
+     * @param opts.maxAttempts - Maximum retry attempts per item (default: 5)
+     * @param opts.concurrency - Maximum number of concurrent operations (default: 1)
+     * @example
+     * await step.forEach(
+     *   "notify-users",
+     *   users,
+     *   async (user) => sendNotification(user),
+     *   { concurrency: 10 }
+     * );
+     */
+    forEach<T>(name: string, items: T[], run: (input: T, opts: {
+        i: number;
+    }) => Promise<void>, opts?: MapOptions): Promise<void>;
+    /**
+     * Process an array of items in sequential batches.
+     * Items are grouped into batches and each batch is processed as a single step.
+     * Useful for bulk operations with external APIs that accept multiple items.
+     * @param name - The name of the batch operation
+     * @param items - Array of items to process
+     * @param run - Function to process each batch, receives the batch array and starting index
+     * @param opts - Configuration options
+     * @param opts.batchSize - Number of items per batch (default: 20)
+     * @param opts.maxAttempts - Maximum retry attempts per batch (default: 5)
+     * @example
+     * await step.batch(
+     *   "bulk-insert",
+     *   records,
+     *   async (batch) => database.bulkInsert(batch),
+     *   { batchSize: 100 }
+     * );
+     */
+    batch<T>(name: string, items: T[], run: (input: T[], opts: {
+        i: number;
+    }) => Promise<void>, opts?: {
+        batchSize?: number;
+        maxAttempts?: number;
+    }): Promise<void>;
+}
+export declare const step: WorkflowStep;
+export {};
+//# sourceMappingURL=workflow-step.d.ts.map

package/dist/primitives/workflow-step.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflow-step.d.ts","sourceRoot":"","sources":["../../src/primitives/workflow-step.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAU,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAezD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,YAAY,CAAC;AAE/C,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AACxC,OAAO,EAAc,CAAC,EAAE,KAAK,OAAO,EAAE,MAAM,eAAe,CAAC;AAM5D,KAAK,mBAAmB,GAAG;IACzB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF,KAAK,UAAU,GAAG;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;;;;;;;;;;;OAYG;IACH,CAAC,CAAC,EACA,IAAI,EAAE,MAAM,EACZ,GAAG,EAAE,CAAC,EAAE,OAAO,EAAE,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,KAAK,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,EACzD,OAAO,CAAC,EAAE,mBAAmB,GAC5B,OAAO,CAAC,CAAC,CAAC,CAAC;IAEd;;;;;;;OAOG;IACH,MAAM,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpC;;;;;;;;OAQG;IACH,IAAI,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEpC;;;;;;;;OAQG;IACH,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEtC;;;;;;;;OAQG;IACH,KAAK,IAAI,IAAI,CAAC;IAEd;;;;;;;;;OASG;IACH,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/C;;;;;;;OAOG;IACH,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,GAAG,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE7D;;;;;;;;;;OAUG;IACH,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC;IAErE;;;;;;;;;;;OAWG;IACH,eAAe,CACb,KAAK,SAAS,MAAM,EACpB,MAAM,SAAS,OAAO,EACtB,OAAO,SAAS,OAAO,EAEvB,IAAI,EAAE,MAAM,EACZ,QAAQ,EAAE,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,CAAC,EAC9C,KAAK,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,GACtB,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC;IAE7B;;;;;;;;;;;;;;;;;OAiBG;IACH,GAAG,CAAC,CAAC,EAAE,CAAC,EACN,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,CAAC,EAAE,EACV,GAAG,EAAE,CAAC,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE;QAAE,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,CAAC,CAAC,CAAC,EAClD,IAAI,CAAC,EAAE,UAAU,GAChB,OAAO,CAAC,CAAC,EAAE,CAAC,CAAC;IAEhB;;;;;;;;;;;;;;;;OAgBG;IACH,OAAO,CAAC,CAAC,EACP,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,CAAC,EAAE,EACV,GAAG,EAAE,CAAC,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE;QAAE,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,CAAC,IAAI,CAAC,EACrD,IAAI,CAAC,EAAE,UAAU,GAChB,OAAO,CAAC,IAAI,CAAC,CAAC;IAEjB;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,CAAC,EACL,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,CAAC,EAAE,EACV,GAAG,EAAE,CAAC,KAAK,EAAE,CAAC,EAAE,EAAE,IAAI,EAAE;QAAE,CAAC,EAAE,MAAM,CAAA;KAAE,KAAK,OAAO,CAAC,IAAI,CAAC,EACvD,IAAI,CAAC,EAAE;QAAE,SAAS,CAAC,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAA;KAAE,GAClD,OAAO,CAAC,IAAI,CAAC,CAAC;CAQlB;AAgKD,eAAO,MAAM,IAAI,EAMX,YAAY,CAAC"}

package/dist/primitives/workflow-utils.d.ts

@@ -0,0 +1,36 @@
+import { Client } from "@botpress/client";
+import { z } from "../library";
+import { WorkflowDataRequestEvent } from "../runtime";
+type UpdateWorkflowInput = Client["updateWorkflow"];
+export declare const updateWorkflow: UpdateWorkflowInput;
+/**
+ * Type guard to check if an event is a workflow data request.
+ * Use this in conversation handlers to detect when a workflow needs data.
+ * @param event - The event to check
+ * @returns True if the event is a WorkflowDataRequestEvent
+ * @example
+ * if (isWorkflowDataRequest(event)) {
+ *   await MyWorkflow.provide(event, { orderId: "12345" });
+ * }
+ */
+export declare function isWorkflowDataRequest(event: unknown): event is {
+    type: typeof WorkflowDataRequestEvent.name;
+    payload: z.infer<typeof WorkflowDataRequestEvent.schema>;
+};
+/**
+ * Type guard to narrow workflow instance by name.
+ * Use this in conversation handlers to get properly typed workflow instances.
+ * @param workflow - The workflow instance to check
+ * @param name - The workflow name to check against
+ * @returns True if the workflow matches the given name
+ * @example
+ * if (type === 'workflow_request' && isWorkflow(workflow, 'test3')) {
+ *   // workflow is now typed as BaseWorkflowInstance<'test3'>
+ *   await workflow.provide('topic', { topic: "Hello" });
+ * }
+ */
+export declare function isWorkflow<TName extends string>(workflow: {
+    name: string;
+} | undefined, name: TName): workflow is import("./workflow-instance").BaseWorkflowInstance<TName extends keyof import("../_types/workflows").WorkflowDefinitions ? TName : never>;
+export {};
+//# sourceMappingURL=workflow-utils.d.ts.map

package/dist/primitives/workflow-utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflow-utils.d.ts","sourceRoot":"","sources":["../../src/primitives/workflow-utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAY,MAAM,kBAAkB,CAAC;AACpD,OAAO,EAAW,CAAC,EAAE,MAAM,YAAY,CAAC;AACxC,OAAO,EAAE,wBAAwB,EAAE,MAAM,YAAY,CAAC;AAGtD,KAAK,mBAAmB,GAAG,MAAM,CAAC,gBAAgB,CAAC,CAAC;AACpD,eAAO,MAAM,cAAc,EAAE,mBAqC5B,CAAC;AAEF;;;;;;;;;GASG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI;IAC9D,IAAI,EAAE,OAAO,wBAAwB,CAAC,IAAI,CAAC;IAC3C,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,MAAM,CAAC,CAAC;CAC1D,CAEA;AAED;;;;;;;;;;;GAWG;AACH,wBAAgB,UAAU,CAAC,KAAK,SAAS,MAAM,EAC7C,QAAQ,EAAE;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,GAAG,SAAS,EACtC,IAAI,EAAE,KAAK,GACV,QAAQ,IAAI,OAAO,qBAAqB,EAAE,oBAAoB,CAAC,KAAK,SAAS,MAAM,OAAO,qBAAqB,EAAE,mBAAmB,GAAG,KAAK,GAAG,KAAK,CAAC,CAEvJ"}

package/dist/primitives/workflow.d.ts

@@ -0,0 +1,86 @@
+import { z, ZodType } from "@botpress/sdk";
+import { ZuiType } from "../types";
+import { WorkflowDefinitions } from "../_types/workflows";
+import { BaseWorkflowInstance } from "./workflow-instance";
+import type { WorkflowStep } from "./workflow-step";
+import type { BaseBot, BotClient } from "@botpress/sdk/dist/bot";
+import { Workflow } from "@botpress/client";
+import { Autonomous, WorkflowDataRequestEvent } from "../runtime";
+export declare namespace Typings {
+    type StepCallSignature = <T>(name: string, run: ({ attempt }: {
+        attempt: number;
+    }) => T | Promise<T>, options?: {
+        maxAttempts?: number;
+    }) => Promise<T>;
+    type StepMethods = Pick<WorkflowStep, "listen" | "fail" | "progress" | "abort" | "sleep" | "sleepUntil" | "waitForWorkflow" | "executeWorkflow" | "map" | "forEach" | "batch">;
+    export type TypedWorkflowStep<Requests extends Record<string, ZuiType>> = StepCallSignature & StepMethods & {
+        /**
+         * Request data from the conversation and wait for a response.
+         * The workflow will pause and send a data request event to the conversation.
+         * Use WorkflowInstance.provide() in the conversation handler to respond.
+         * @param request - The name of the request (must be defined in workflow requests)
+         * @param message - Message to display to the user describing what data is needed
+         * @param stepName - Optional custom name for the step (defaults to request)
+         * @returns The provided data validated against the request schema
+         * @throws Error if workflow has no conversationId or request not found
+         */
+        request<TRequest extends keyof Requests & string>(request: TRequest, message: string, stepName?: string): Promise<z.infer<Requests[TRequest]>>;
+    };
+    export type HandlerProps<Input extends ZuiType = ZuiType, _Output extends ZuiType = ZuiType, State extends ZuiType = ZuiType, Requests extends Record<string, ZuiType> = Record<string, ZuiType>, TBot extends BaseBot = BaseBot> = {
+        input: z.infer<Input>;
+        state: z.infer<State>;
+        step: TypedWorkflowStep<Requests>;
+        client: BotClient<TBot>;
+        execute: Autonomous.ExecuteFn;
+    };
+    export type Handler<TName extends string = string, Input extends ZuiType = ZuiType, Output extends ZuiType = ZuiType, State extends ZuiType = ZuiType, Requests extends Record<string, ZuiType> = Record<string, ZuiType>> = (this: BaseWorkflowInstance<TName>, props: HandlerProps<Input, Output, State, Requests>) => Promise<z.infer<Output>> | z.infer<Output>;
+    export type Props<TName extends string = string, Input extends ZuiType = ZuiType, Output extends ZuiType = ZuiType, State extends ZuiType = ZuiType, Requests extends Record<string, ZuiType> = Record<string, ZuiType>> = {
+        name: TName;
+        description?: string;
+        input?: Input;
+        output?: Output;
+        state?: State;
+        requests?: Requests;
+        handler: Handler<TName, Input, Output, State, Requests>;
+        schedule?: string;
+        timeout?: `${number}s` | `${number}m` | `${number}h`;
+    };
+    export const Primitive: "workflow";
+    export {};
+}
+export declare class BaseWorkflow<TName extends string = string, Input extends ZuiType = WorkflowDefinitions[TName] extends never ? ZuiType : WorkflowDefinitions[TName]["input"] extends ZodType ? WorkflowDefinitions[TName]["input"] : ZuiType, Output extends ZuiType = WorkflowDefinitions[TName] extends never ? ZuiType : WorkflowDefinitions[TName]["output"] extends ZodType ? WorkflowDefinitions[TName]["output"] : ZuiType, State extends ZuiType = WorkflowDefinitions[TName] extends never ? ZuiType : WorkflowDefinitions[TName]["state"] extends ZodType ? WorkflowDefinitions[TName]["state"] : ZuiType, Requests extends Record<string, ZuiType> = Record<string, ZuiType>> {
+    readonly name: TName;
+    readonly description?: string;
+    readonly timeout: number;
+    state: z.infer<State>;
+    constructor(props: Typings.Props<TName, Input, Output, State, Requests>);
+    /**
+     * Get or create a workflow instance with the given key and input
+     *
+     * @param props.key - Optional unique key for workflow deduplication
+     * @param props.start - Whether to start the workflow immediately (default: true)
+     * @param props.input - The input data for the workflow
+     * @returns The workflow instance
+     */
+    getOrCreate(props: {
+        key?: string;
+        statuses?: Workflow["status"][];
+        input: WorkflowDefinitions[TName] extends never ? z.infer<Input> : WorkflowDefinitions[TName]["input"];
+    }): Promise<BaseWorkflowInstance<TName>>;
+    /**
+     * Provide data in response to a workflow data request.
+     * Call this method from a conversation handler when you receive a WorkflowDataRequestEvent.
+     * @param event - The event object from the conversation handler
+     * @param data - The data to provide to the workflow
+     * @example
+     * if (isWorkflowDataRequest(event)) {
+     *   await SomeWorkflow.provide(event, { orderId: "12345" });
+     * }
+     */
+    provide(event: {
+        type: string;
+        payload: z.infer<typeof WorkflowDataRequestEvent.schema>;
+    }, data: any): Promise<void>;
+    start(input: z.infer<Input>): Promise<BaseWorkflowInstance<TName>>;
+}
+//# sourceMappingURL=workflow.d.ts.map

package/dist/primitives/workflow.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"workflow.d.ts","sourceRoot":"","sources":["../../src/primitives/workflow.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AACnC,OAAO,EAAE,mBAAmB,EAAE,MAAM,qBAAqB,CAAC;AAC1D,OAAO,EACL,oBAAoB,EAErB,MAAM,qBAAqB,CAAC;AAG7B,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAEpD,OAAO,KAAK,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACjE,OAAO,EAAU,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,EACL,UAAU,EAEV,wBAAwB,EACzB,MAAM,YAAY,CAAC;AAKpB,yBAAiB,OAAO,CAAC;IAEvB,KAAK,iBAAiB,GAAG,CAAC,CAAC,EACzB,IAAI,EAAE,MAAM,EACZ,GAAG,EAAE,CAAC,EAAE,OAAO,EAAE,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,KAAK,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,EACzD,OAAO,CAAC,EAAE;QAAE,WAAW,CAAC,EAAE,MAAM,CAAA;KAAE,KAC/B,OAAO,CAAC,CAAC,CAAC,CAAC;IAGhB,KAAK,WAAW,GAAG,IAAI,CACrB,YAAY,EACV,QAAQ,GACR,MAAM,GACN,UAAU,GACV,OAAO,GACP,OAAO,GACP,YAAY,GACZ,iBAAiB,GACjB,iBAAiB,GACjB,KAAK,GACL,SAAS,GACT,OAAO,CACV,CAAC;IAEF,MAAM,MAAM,iBAAiB,CAAC,QAAQ,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IACpE,iBAAiB,GACf,WAAW,GAAG;QACZ;;;;;;;;;WASG;QACH,OAAO,CAAC,QAAQ,SAAS,MAAM,QAAQ,GAAG,MAAM,EAC9C,OAAO,EAAE,QAAQ,EACjB,OAAO,EAAE,MAAM,EACf,QAAQ,CAAC,EAAE,MAAM,GAChB,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC;KACzC,CAAC;IAEN,MAAM,MAAM,YAAY,CACtB,KAAK,SAAS,OAAO,GAAG,OAAO,EAC/B,OAAO,SAAS,OAAO,GAAG,OAAO,EACjC,KAAK,SAAS,OAAO,GAAG,OAAO,EAC/B,QAAQ,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAClE,IAAI,SAAS,OAAO,GAAG,OAAO,IAC5B;QACF,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACtB,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;QACtB,IAAI,EAAE,iBAAiB,CAAC,QAAQ,CAAC,CAAC;QAClC,MAAM,EAAE,SAAS,CAAC,IAAI,CAAC,CAAC;QACxB,OAAO,EAAE,UAAU,CAAC,SAAS,CAAC;KAC/B,CAAC;IAEF,MAAM,MAAM,OAAO,CACjB,KAAK,SAAS,MAAM,GAAG,MAAM,EAC7B,KAAK,SAAS,OAAO,GAAG,OAAO,EAC/B,MAAM,SAAS,OAAO,GAAG,OAAO,EAChC,KAAK,SAAS,OAAO,GAAG,OAAO,EAC/B,QAAQ,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAChE,CACF,IAAI,EAAE,oBAAoB,CAAC,KAAK,CAAC,EACjC,KAAK,EAAE,YAAY,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,CAAC,KAChD,OAAO,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAEhD,MAAM,MAAM,KAAK,CACf,KAAK,SAAS,MAAM,GAAG,MAAM,EAC7B,KAAK,SAAS,OAAO,GAAG,OAAO,EAC/B,MAAM,SAAS,OAAO,GAAG,OAAO,EAChC,KAAK,SAAS,OAAO,GAAG,OAAO,EAC/B,QAAQ,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,IAChE;QACF,IAAI,EAAE,KAAK,CAAC;QACZ,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,KAAK,CAAC,EAAE,KAAK,CAAC;QACd,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,KAAK,CAAC,EAAE,KAAK,CAAC;QACd,QAAQ,CAAC,EAAE,QAAQ,CAAC;QACpB,OAAO,EAAE,OAAO,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;QACxD,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,OAAO,CAAC,EAAE,GAAG,MAAM,GAAG,GAAG,GAAG,MAAM,GAAG,GAAG,GAAG,MAAM,GAAG,CAAC;KACtD,CAAC;IAEF,MAAM,CAAC,MAAM,SAAS,EAAG,UAAmB,CAAC;;CAC9C;AAED,qBAAa,YAAY,CACvB,KAAK,SAAS,MAAM,GAAG,MAAM,EAC7B,KAAK,SAAS,OAAO,GAAG,mBAAmB,CAAC,KAAK,CAAC,SAAS,KAAK,GAC5D,OAAO,GACP,mBAAmB,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,SAAS,OAAO,GACjD,mBAAmB,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,GACnC,OAAO,EACb,MAAM,SAAS,OAAO,GAAG,mBAAmB,CAAC,KAAK,CAAC,SAAS,KAAK,GAC7D,OAAO,GACP,mBAAmB,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,SAAS,OAAO,GAClD,mBAAmB,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,GACpC,OAAO,EACb,KAAK,SAAS,OAAO,GAAG,mBAAmB,CAAC,KAAK,CAAC,SAAS,KAAK,GAC5D,OAAO,GACP,mBAAmB,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,SAAS,OAAO,GACjD,mBAAmB,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,GACnC,OAAO,EACb,QAAQ,SAAS,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAElE,SAAgB,IAAI,EAAE,KAAK,CAAC;IAC5B,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAe9B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAY;IAGpC,KAAK,EAAG,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;gBAEX,KAAK,EAAE,OAAO,CAAC,KAAK,CAAC,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,QAAQ,CAAC;IAuDvE;;;;;;;OAOG;IACG,WAAW,CAAC,KAAK,EAAE;QACvB,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,QAAQ,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;QAChC,KAAK,EAAE,mBAAmB,CAAC,KAAK,CAAC,SAAS,KAAK,GAC3C,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,GACd,mBAAmB,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC;KACzC,GAAG,OAAO,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;IAoDxC;;;;;;;;;OASG;IACG,OAAO,CACX,KAAK,EAAE;QACL,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,MAAM,CAAC,CAAC;KAC1D,EACD,IAAI,EAAE,GAAG,GACR,OAAO,CAAC,IAAI,CAAC;IAkDV,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,GAAG,OAAO,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAC;CAwBzE"}

package/dist/runtime/actions.d.ts

@@ -0,0 +1,6 @@
+import { BotActions } from "../_types/actions";
+import { IntegrationActions } from "../_types/integration-actions";
+type ActionsProxy = IntegrationActions & BotActions;
+export declare const actions: ActionsProxy;
+export {};
+//# sourceMappingURL=actions.d.ts.map

package/dist/runtime/actions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"actions.d.ts","sourceRoot":"","sources":["../../src/runtime/actions.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AAKnE,KAAK,YAAY,GAAG,kBAAkB,GAAG,UAAU,CAAC;AAEpD,eAAO,MAAM,OAAO,EAAE,YA6LpB,CAAC"}