@botpress/sdk 4.21.0 → 5.0.0

package/dist/plugin/server/types.d.ts

@@ -4,8 +4,11 @@ import * as workflowProxy from '../../bot/workflow-proxy';
 import * as utils from '../../utils/type-utils';
 import * as actionProxy from '../action-proxy';
 import * as common from '../common';
+import * as conversationProxy from '../conversation-proxy';
 import * as eventProxy from '../event-proxy';
+import * as messageProxy from '../message-proxy';
 import * as stateProxy from '../state-proxy';
+import * as userProxy from '../user-proxy';
 type EnumeratePluginEvents<TPlugin extends common.BasePlugin> = bot.EnumerateEvents<TPlugin> & common.EnumerateInterfaceEvents<TPlugin>;
 type _IncomingEvents<TPlugin extends common.BasePlugin> = {
     [K in utils.StringKeys<EnumeratePluginEvents<TPlugin>>]: utils.Merge<client.Event, {
@@ -15,7 +18,7 @@ type _IncomingEvents<TPlugin extends common.BasePlugin> = {
 };
 type _IncomingMessages<TPlugin extends common.BasePlugin> = {
     [K in utils.StringKeys<bot.GetMessages<TPlugin>>]: utils.Merge<client.Message, {
-        type: K;
+        type: Extract<K, string>;
         payload: bot.GetMessages<TPlugin>[K];
     }>;
 };
@@ -110,72 +113,142 @@ export type PluginClient<_TPlugin extends common.BasePlugin> = bot.BotSpecificCl
 export type CommonHandlerProps<TPlugin extends common.BasePlugin> = {
     ctx: bot.BotContext;
     logger: bot.BotLogger;
+    /**
+     * Please use the `users`, `conversations`, `actions`, `messages`, `states`,
+     * `events`, `workflows` utilities instead of accessing the client directly.
+     *
+     * For example, you can replace `props.client.listUsers(...)` with
+     * `props.users.list(...).take(n)`
+     */
     client: PluginClient<TPlugin>;
 };
 export type InjectedHandlerProps<TPlugin extends common.BasePlugin> = {
     configuration: common.PluginConfiguration<TPlugin>;
+    /**
+     * Mapping of plugin interface dependencies to the integrations that
+     * implement them.
+     */
     interfaces: common.PluginInterfaceExtensions<TPlugin>;
-    alias?: string;
+    /**
+     * Mapping of plugin integration dependencies to the integrations that
+     * implement them.
+     */
+    integrations: common.PluginIntegrationExtensions<TPlugin>;
+    /**
+     * Alias of the plugin within the bot. This is usually equal to the plugin's
+     * name, but may be different if the bot has multiple instances of the same
+     * plugin installed.
+     */
+    alias: string;
+    /**
+     * Allows calling actions defined by the plugins's integration and interface
+     * dependencies.
+     */
     actions: actionProxy.ActionProxy<TPlugin>;
+    /**
+     * Allows querying and mutating states defined by the plugin.
+     */
     states: stateProxy.StateProxy<TPlugin>;
+    /**
+     * Allows emitting events defined by the plugin.
+     */
     events: eventProxy.EventProxy<TPlugin>;
+    /**
+     * Allows querying and mutating users.
+     */
+    users: userProxy.UserFinder<TPlugin>;
+    /**
+     * Allows querying and mutating conversations on channels defined by the
+     * plugin's integration and interface dependencies.
+     */
+    conversations: conversationProxy.ConversationFinder<TPlugin>;
+    /**
+     * Allows querying and mutating individual messages.
+     */
+    messages: messageProxy.MessageFinder<TPlugin>;
     /**
      * # EXPERIMENTAL
      * This API is experimental and may change in the future.
      */
     workflows: workflowProxy.WorkflowProxy<TPlugin>;
 };
-export type ExtendedHandlerProps<TPlugin extends common.BasePlugin> = CommonHandlerProps<TPlugin> & InjectedHandlerProps<TPlugin>;
-export type MessagePayloads<TPlugin extends common.BasePlugin> = {
-    [TMessageName in utils.StringKeys<IncomingMessages<TPlugin>>]: ExtendedHandlerProps<TPlugin> & {
+type _WithInjectedProps<T extends Record<string, Record<string, any>>, TPlugin extends common.BasePlugin, TMerge extends object = {}> = {
+    [K in keyof T]: utils.Merge<T[K], TMerge> & InjectedHandlerProps<TPlugin>;
+};
+type _WithInjectedPropsFn<T extends Record<string, (args: any) => any>, TPlugin extends common.BasePlugin, TMerge extends object = {}> = {
+    [K in keyof T]: (args: utils.Merge<Parameters<T[K]>[0], TMerge> & InjectedHandlerProps<TPlugin>) => ReturnType<T[K]>;
+};
+export type MessagePayloadsWithoutInjectedProps<TPlugin extends common.BasePlugin> = {
+    [TMessageName in utils.StringKeys<IncomingMessages<TPlugin>>]: CommonHandlerProps<TPlugin> & {
         message: IncomingMessages<TPlugin>[TMessageName];
         user: client.User;
         conversation: client.Conversation;
         event: client.Event;
     };
 };
-export type MessageHandlers<TPlugin extends common.BasePlugin> = {
-    [TMessageName in utils.StringKeys<IncomingMessages<TPlugin>>]: (args: MessagePayloads<TPlugin>[TMessageName]) => Promise<void>;
+export type MessageHandlersWithoutInjectedProps<TPlugin extends common.BasePlugin> = {
+    [TMessageName in utils.StringKeys<IncomingMessages<TPlugin>>]: (args: MessagePayloadsWithoutInjectedProps<TPlugin>[TMessageName]) => Promise<void>;
 };
-export type EventPayloads<TPlugin extends common.BasePlugin> = {
-    [TEventName in utils.StringKeys<IncomingEvents<TPlugin>>]: ExtendedHandlerProps<TPlugin> & {
+export type MessageHandlers<TPlugin extends common.BasePlugin> = _WithInjectedPropsFn<MessageHandlersWithoutInjectedProps<TPlugin>, TPlugin, {
+    user: userProxy.ActionableUser<TPlugin, string>;
+    conversation: conversationProxy.ActionableConversation<TPlugin>;
+    message: messageProxy.ActionableMessage<TPlugin>;
+}>;
+export type EventPayloadsWithoutInjectedProps<TPlugin extends common.BasePlugin> = {
+    [TEventName in utils.StringKeys<IncomingEvents<TPlugin>>]: CommonHandlerProps<TPlugin> & {
         event: IncomingEvents<TPlugin>[TEventName];
     };
 };
-export type EventHandlers<TPlugin extends common.BasePlugin> = {
-    [TEventName in utils.StringKeys<IncomingEvents<TPlugin>>]: (args: EventPayloads<TPlugin>[TEventName]) => Promise<void>;
+export type EventPayloads<TPlugin extends common.BasePlugin> = _WithInjectedProps<EventPayloadsWithoutInjectedProps<TPlugin>, TPlugin>;
+export type EventHandlersWithoutInjectedProps<TPlugin extends common.BasePlugin> = {
+    [TEventName in utils.StringKeys<IncomingEvents<TPlugin>>]: (args: EventPayloadsWithoutInjectedProps<TPlugin>[TEventName]) => Promise<void>;
 };
-export type StateExpiredPayloads<TPlugin extends common.BasePlugin> = {
-    [TSateName in utils.StringKeys<IncomingStates<TPlugin>>]: ExtendedHandlerProps<TPlugin> & {
+export type EventHandlers<TPlugin extends common.BasePlugin> = _WithInjectedPropsFn<EventHandlersWithoutInjectedProps<TPlugin>, TPlugin>;
+export type StateExpiredPayloadsWithoutInjectedProps<TPlugin extends common.BasePlugin> = {
+    [TSateName in utils.StringKeys<IncomingStates<TPlugin>>]: CommonHandlerProps<TPlugin> & {
         state: IncomingStates<TPlugin>[TSateName];
     };
 };
-export type StateExpiredHandlers<TPlugin extends common.BasePlugin> = {
-    [TSateName in utils.StringKeys<IncomingStates<TPlugin>>]: (args: StateExpiredPayloads<TPlugin>[TSateName]) => Promise<void>;
+export type StateExpiredPayloads<TPlugin extends common.BasePlugin> = _WithInjectedProps<StateExpiredPayloadsWithoutInjectedProps<TPlugin>, TPlugin>;
+export type StateExpiredHandlersWithoutInjectedProps<TPlugin extends common.BasePlugin> = {
+    [TSateName in utils.StringKeys<IncomingStates<TPlugin>>]: (args: StateExpiredPayloadsWithoutInjectedProps<TPlugin>[TSateName]) => Promise<void>;
 };
-export type ActionHandlerPayloads<TPlugin extends common.BasePlugin> = {
-    [TActionName in utils.StringKeys<TPlugin['actions']>]: ExtendedHandlerProps<TPlugin> & {
+export type StateExpiredHandlers<TPlugin extends common.BasePlugin> = _WithInjectedPropsFn<StateExpiredHandlersWithoutInjectedProps<TPlugin>, TPlugin>;
+export type ActionHandlerPayloadsWithoutInjectedProps<TPlugin extends common.BasePlugin> = {
+    [TActionName in utils.StringKeys<TPlugin['actions']>]: CommonHandlerProps<TPlugin> & {
         type?: TActionName;
         input: TPlugin['actions'][TActionName]['input'];
     };
 };
-export type ActionHandlers<TPlugin extends common.BasePlugin> = {
-    [TActionName in utils.StringKeys<TPlugin['actions']>]: (props: ActionHandlerPayloads<TPlugin>[TActionName]) => Promise<TPlugin['actions'][TActionName]['output']>;
+export type ActionHandlerPayloads<TPlugin extends common.BasePlugin> = _WithInjectedProps<ActionHandlerPayloadsWithoutInjectedProps<TPlugin>, TPlugin>;
+export type ActionHandlersWithoutInjectedProps<TPlugin extends common.BasePlugin> = {
+    [TActionName in utils.StringKeys<TPlugin['actions']>]: (props: ActionHandlerPayloadsWithoutInjectedProps<TPlugin>[TActionName]) => Promise<TPlugin['actions'][TActionName]['output']>;
 };
-export type WorkflowPayloads<TPlugin extends common.BasePlugin> = {
-    [TWorkflowName in utils.StringKeys<TPlugin['workflows']>]: ExtendedHandlerProps<TPlugin> & {
+export type ActionHandlers<TPlugin extends common.BasePlugin> = _WithInjectedPropsFn<ActionHandlersWithoutInjectedProps<TPlugin>, TPlugin>;
+export type WorkflowPayloadsWithoutInjectedProps<TPlugin extends common.BasePlugin> = {
+    [TWorkflowName in utils.StringKeys<TPlugin['workflows']>]: CommonHandlerProps<TPlugin> & {
         conversation?: client.Conversation;
         user?: client.User;
         event: bot.WorkflowUpdateEvent;
+        workflow: client.Workflow;
+    };
+};
+export type WorkflowPayloads<TPlugin extends common.BasePlugin> = _WithInjectedProps<{
+    [TWorkflowName in keyof WorkflowPayloadsWithoutInjectedProps<TPlugin>]: utils.Merge<WorkflowPayloadsWithoutInjectedProps<TPlugin>[TWorkflowName], {
         /**
          * # EXPERIMENTAL
          * This API is experimental and may change in the future.
          */
-        workflow: workflowProxy.WorkflowWithUtilities<TPlugin, TWorkflowName>;
-    };
+        workflow: workflowProxy.ActionableWorkflow<TPlugin, TWorkflowName>;
+    }>;
+}, TPlugin>;
+export type WorkflowHandlersWithoutInjectedProps<TPlugin extends common.BasePlugin> = {
+    [TWorkflowName in utils.StringKeys<TPlugin['workflows']>]: (props: WorkflowPayloadsWithoutInjectedProps<TPlugin>[TWorkflowName]) => Promise<void>;
 };
 export type WorkflowHandlers<TPlugin extends common.BasePlugin> = {
-    [TWorkflowName in utils.StringKeys<TPlugin['workflows']>]: (props: WorkflowPayloads<TPlugin>[TWorkflowName]) => Promise<void>;
+    [TWorkflowName in utils.StringKeys<TPlugin['workflows']>]: (props: utils.Merge<WorkflowPayloads<TPlugin>[TWorkflowName], {
+        workflow: workflowProxy.ActionableWorkflow<TPlugin, TWorkflowName>;
+    }>) => Promise<void>;
 };
 type BaseHookDefinition = {
     stoppable?: boolean;
@@ -259,13 +332,16 @@ export type HookData<TPlugin extends common.BasePlugin> = {
         [THookDataName in utils.StringKeys<HookDefinitions<TPlugin>[THookType]['data']>]: HookDefinitions<TPlugin>[THookType]['data'][THookDataName];
     };
 };
-export type HookInputs<TPlugin extends common.BasePlugin> = {
+export type HookInputsWithoutInjectedProps<TPlugin extends common.BasePlugin> = {
     [THookType in utils.StringKeys<HookData<TPlugin>>]: {
-        [THookDataName in utils.StringKeys<HookData<TPlugin>[THookType]>]: ExtendedHandlerProps<TPlugin> & {
+        [THookDataName in utils.StringKeys<HookData<TPlugin>[THookType]>]: CommonHandlerProps<TPlugin> & {
             data: HookData<TPlugin>[THookType][THookDataName];
         };
     };
 };
+export type HookInputs<TPlugin extends common.BasePlugin> = {
+    [THookType in utils.StringKeys<HookData<TPlugin>>]: _WithInjectedProps<HookInputsWithoutInjectedProps<TPlugin>[THookType], TPlugin>;
+};
 export type HookOutputs<TPlugin extends common.BasePlugin> = {
     [THookType in utils.StringKeys<HookData<TPlugin>>]: {
         [THookDataName in utils.StringKeys<HookData<TPlugin>[THookType]>]: {
@@ -275,32 +351,23 @@ export type HookOutputs<TPlugin extends common.BasePlugin> = {
         } : {});
     };
 };
-export type HookHandlers<TPlugin extends common.BasePlugin> = {
+export type HookHandlersWithoutInjectedProps<TPlugin extends common.BasePlugin> = {
     [THookType in utils.StringKeys<HookData<TPlugin>>]: {
-        [THookDataName in utils.StringKeys<HookData<TPlugin>[THookType]>]: (input: HookInputs<TPlugin>[THookType][THookDataName]) => Promise<HookOutputs<TPlugin>[THookType][THookDataName] | undefined>;
+        [THookDataName in utils.StringKeys<HookData<TPlugin>[THookType]>]: (input: HookInputsWithoutInjectedProps<TPlugin>[THookType][THookDataName]) => Promise<HookOutputs<TPlugin>[THookType][THookDataName] | undefined>;
     };
 };
-export type ActionHandlersMap<TPlugin extends common.BasePlugin> = {
-    [TActionName in utils.StringKeys<TPlugin['actions']>]?: (props: Omit<Parameters<ActionHandlers<TPlugin>[TActionName]>[0], keyof InjectedHandlerProps<TPlugin>>) => Promise<Awaited<ReturnType<ActionHandlers<TPlugin>[TActionName]>>>;
-};
-export type MessageHandlersMap<TPlugin extends common.BasePlugin> = {
-    [TMessageName in utils.StringKeys<IncomingMessages<TPlugin>>]?: ((props: Omit<Parameters<MessageHandlers<TPlugin>[TMessageName]>[0], keyof InjectedHandlerProps<TPlugin>>) => Promise<void>)[];
-};
-export type EventHandlersMap<TPlugin extends common.BasePlugin> = {
-    [TEventName in utils.StringKeys<IncomingEvents<TPlugin>>]?: ((props: Omit<Parameters<EventHandlers<TPlugin>[TEventName]>[0], keyof InjectedHandlerProps<TPlugin>>) => Promise<void>)[];
-};
-export type StateExpiredHandlersMap<TPlugin extends common.BasePlugin> = {
-    [TStateName in utils.StringKeys<IncomingStates<TPlugin>>]?: ((props: Omit<Parameters<StateExpiredHandlers<TPlugin>[TStateName]>[0], keyof InjectedHandlerProps<TPlugin>>) => Promise<void>)[];
+export type HookHandlers<TPlugin extends common.BasePlugin> = {
+    [THookType in utils.StringKeys<HookData<TPlugin>>]: _WithInjectedPropsFn<HookHandlersWithoutInjectedProps<TPlugin>[THookType], TPlugin>;
 };
 export type HookHandlersMap<TPlugin extends common.BasePlugin> = {
     [THookType in utils.StringKeys<HookData<TPlugin>>]: {
-        [THookDataName in utils.StringKeys<HookData<TPlugin>[THookType]>]?: ((props: Omit<Parameters<HookHandlers<TPlugin>[THookType][THookDataName]>[0], keyof InjectedHandlerProps<TPlugin>>) => Promise<Awaited<ReturnType<HookHandlers<TPlugin>[THookType][THookDataName]>>>)[];
+        [THookDataName in utils.StringKeys<HookData<TPlugin>[THookType]>]?: HookHandlersWithoutInjectedProps<TPlugin>[THookType][THookDataName][];
     };
 };
 export type WorkflowHandlersMap<TPlugin extends common.BasePlugin> = {
     [TWorkflowUpdateType in bot.WorkflowUpdateType]: {
         [TWorkflowName in utils.StringKeys<TPlugin['workflows']>]?: {
-            handler: (props: Omit<Parameters<WorkflowHandlers<TPlugin>[TWorkflowName]>[0], keyof InjectedHandlerProps<TPlugin> | 'workflow'> & {
+            handler: (props: Omit<Parameters<WorkflowHandlersWithoutInjectedProps<TPlugin>[TWorkflowName]>[0], 'workflow'> & {
                 workflow: client.Workflow;
             }) => Promise<client.Workflow>;
             order: number;
@@ -343,12 +410,26 @@ export type OrderedWorkflowHandlersMap<TPlugin extends common.BasePlugin> = {
 };
 /** Plugin handlers without InjectedHandlerProps */
 export type PluginHandlers<TPlugin extends common.BasePlugin> = {
-    actionHandlers: ActionHandlersMap<TPlugin>;
-    messageHandlers: MessageHandlersMap<TPlugin>;
-    eventHandlers: EventHandlersMap<TPlugin>;
-    stateExpiredHandlers: StateExpiredHandlersMap<TPlugin>;
-    hookHandlers: HookHandlersMap<TPlugin>;
-    workflowHandlers: WorkflowHandlersMap<TPlugin>;
+    actionHandlers: ActionHandlersWithoutInjectedProps<TPlugin>;
+    messageHandlers: {
+        [TMessageName in utils.StringKeys<IncomingMessages<TPlugin>>]?: MessageHandlersWithoutInjectedProps<TPlugin>[TMessageName][];
+    };
+    eventHandlers: {
+        [TEventName in utils.StringKeys<IncomingEvents<TPlugin>>]?: EventHandlersWithoutInjectedProps<TPlugin>[TEventName][];
+    };
+    stateExpiredHandlers: {
+        [TStateName in utils.StringKeys<IncomingStates<TPlugin>>]?: StateExpiredHandlersWithoutInjectedProps<TPlugin>[TStateName][];
+    };
+    hookHandlers: {
+        [THookType in utils.StringKeys<HookData<TPlugin>>]: {
+            [THookDataName in utils.StringKeys<HookData<TPlugin>[THookType]>]?: HookHandlersWithoutInjectedProps<TPlugin>[THookType][THookDataName][];
+        };
+    };
+    workflowHandlers: {
+        [TWorkflowUpdateType in bot.WorkflowUpdateType]: {
+            [TWorkflowName in utils.StringKeys<TPlugin['workflows']>]?: WorkflowHandlersWithoutInjectedProps<TPlugin>[TWorkflowName][];
+        };
+    };
 };
 /** identical to PluginHandlers, but contains the injected properties */
 export type InjectedPluginHandlers<TPlugin extends common.BasePlugin> = {
@@ -369,10 +450,7 @@ export type InjectedPluginHandlers<TPlugin extends common.BasePlugin> = {
     };
     workflowHandlers: {
         [TWorkflowUpdateType in bot.WorkflowUpdateType]: {
-            [TWorkflowName in utils.StringKeys<TPlugin['workflows']>]?: {
-                handler: WorkflowHandlers<TPlugin>[TWorkflowName];
-                order: number;
-            }[];
+            [TWorkflowName in utils.StringKeys<TPlugin['workflows']>]?: WorkflowHandlers<TPlugin>[TWorkflowName][];
         };
     };
 };

package/dist/plugin/tag-prefixer.d.ts

@@ -0,0 +1,10 @@
+export declare const unprefixTagsOwnedByPlugin: <T extends {} | {
+    tags?: Record<string, string>;
+}>(obj: T, { alias }: {
+    alias?: string;
+}) => T;
+export declare const prefixTagsIfNeeded: <T extends {} | {
+    tags?: Record<string, string>;
+}>(obj: T, { alias }: {
+    alias?: string;
+}) => T;

package/dist/plugin/tag-prefixer.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/plugin/user-proxy/index.d.ts

@@ -0,0 +1,2 @@
+export { proxyUsers, proxyUser } from './proxy';
+export { UserFinder, ActionableUser } from './types';

package/dist/plugin/user-proxy/proxy.d.ts

@@ -0,0 +1,14 @@
+import type * as client from '@botpress/client';
+import type { BotSpecificClient } from '../../bot';
+import type { BasePlugin } from '../common';
+import type { UserFinder, ActionableUser } from './types';
+export declare const proxyUsers: <TPlugin extends BasePlugin>(props: {
+    client: BotSpecificClient<TPlugin> | client.Client;
+    pluginAlias?: string;
+}) => UserFinder<TPlugin>;
+export declare const proxyUser: <TPlugin extends BasePlugin, TConversationId extends string | undefined>(props: {
+    client: BotSpecificClient<TPlugin> | client.Client;
+    conversationId?: TConversationId;
+    pluginAlias?: string;
+    user: client.User;
+}) => ActionableUser<TPlugin, TConversationId>;

package/dist/plugin/user-proxy/types.d.ts

@@ -0,0 +1,30 @@
+import { ClientInputs, User } from '@botpress/client';
+import type { commonTypes } from '../../common';
+import type { AsyncCollection } from '../../utils/api-paging-utils';
+import type * as typeUtils from '../../utils/type-utils';
+import { BasePlugin } from '../common';
+export type UserFinder<TPlugin extends BasePlugin> = {
+    list: <TConversationId extends string | undefined = undefined>(props?: {
+        conversationId?: TConversationId;
+        tags?: commonTypes.ToTags<typeUtils.StringKeys<TPlugin['user']['tags']>>;
+    }) => AsyncCollection<ActionableUser<TPlugin, TConversationId>>;
+    getById: (props: {
+        id: string;
+    }) => Promise<ActionableUser<TPlugin>>;
+};
+export type ActionableUser<TPlugin extends BasePlugin, TConversationId extends string | undefined = undefined> = TConversationId extends string ? ActionableUserWithConversation<TPlugin, TConversationId> : ActionableUserWithoutConversation<TPlugin, TConversationId>;
+export type ActionableUserWithConversation<TPlugin extends BasePlugin, TConversationId extends string | undefined> = BaseActionableUser<TPlugin, TConversationId> & {
+    removeFromConversation: () => Promise<ActionableUser<TPlugin, undefined>>;
+};
+export type ActionableUserWithoutConversation<TPlugin extends BasePlugin, TConversationId extends string | undefined> = BaseActionableUser<TPlugin, TConversationId> & {
+    addToConversation: <TNewConversationId extends string>(props: {
+        conversationId: TNewConversationId;
+    }) => Promise<ActionableUser<TPlugin, TNewConversationId>>;
+};
+export type BaseActionableUser<TPlugin extends BasePlugin, TConversationId extends string | undefined = undefined> = typeUtils.Merge<User, {
+    tags: commonTypes.ToTags<typeUtils.StringKeys<TPlugin['user']['tags']>>;
+}> & {
+    update: (props: typeUtils.Merge<Omit<ClientInputs['updateUser'], 'id'>, {
+        tags?: commonTypes.ToTags<typeUtils.StringKeys<TPlugin['user']['tags']>>;
+    }>) => Promise<ActionableUser<TPlugin, TConversationId>>;
+};

package/dist/utils/api-paging-utils.d.ts

@@ -0,0 +1,43 @@
+type _PageLister<R> = (t: {
+    nextToken?: string;
+}) => Promise<{
+    items: R[];
+    meta: {
+        nextToken?: string;
+    };
+}>;
+declare class AsyncCollection<T> implements AsyncIterableIterator<T> {
+    private _list;
+    private _nextToken?;
+    private _elementsBuffer;
+    private _isExhausted;
+    constructor(_list: _PageLister<T>);
+    [Symbol.asyncIterator](): AsyncIterableIterator<T>;
+    /**
+     * Get the next element from the collection and advance the iterator.
+     */
+    next(): Promise<IteratorResult<T, undefined>>;
+    /**
+     * Take the next n elements from the collection, advancing the iterator, and
+     * return them as an array.
+     */
+    take(amount: number): Promise<T[]>;
+    /**
+     * Take the next n pages of elements from the collection, advancing the
+     * iterator, and return the elements as an array.
+     */
+    takePage(amount: number): Promise<T[]>;
+    /**
+     * Take all remaining elements from in collection, moving the iterator to the
+     * end, and return them as an array.
+     */
+    takeAll(): Promise<T[]>;
+    /**
+     * Returns true if there are no more elements to fetch in the collection.
+     */
+    get isExhausted(): boolean;
+    private _fetchNextPageIntoBuffer;
+    private get _bufferIsEmpty();
+}
+export type { AsyncCollection };
+export declare const createAsyncCollection: <T>(listFn: _PageLister<T>) => AsyncCollection<T>;

package/dist/utils/api-paging-utils.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/utils/type-utils.d.ts

@@ -59,4 +59,5 @@ type DeepPartialObject<T extends object> = T extends infer O ? {
 export type DeepPartial<T> = T extends (...args: infer A) => infer R ? (...args: DeepPartial<A>) => DeepPartial<R> : T extends Array<infer E> ? Array<DeepPartial<E>> : T extends ReadonlyArray<infer E> ? ReadonlyArray<DeepPartial<E>> : T extends Promise<infer R> ? Promise<DeepPartial<R>> : T extends Buffer ? Buffer : T extends object ? DeepPartialObject<T> : T;
 export type SafeOmit<T, K extends keyof T> = Omit<T, K>;
 export type StringKeys<T> = Extract<keyof T, string>;
+export type DistributivePick<T, K extends keyof T> = T extends any ? Pick<T, K> : never;
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botpress/sdk",
-  "version": "4.21.0",
+  "version": "5.0.0",
   "description": "Botpress SDK",
   "main": "./dist/index.cjs",
   "module": "./dist/index.mjs",

package/dist/integration/common/types.d.ts

@@ -1,2 +0,0 @@
-import * as utils from '../../utils/type-utils';
-export type ToTags<TTags extends string | number | symbol> = utils.Cast<Partial<Record<TTags, string>>, Record<string, string>>;

package/dist/plugin/interface-resolution.d.ts

@@ -1,15 +0,0 @@
-import { PluginInterfaceExtensions } from './common';
-export type ParsedActionRef = {
-    namespace: string;
-    actionName: string;
-};
-export type ParsedEventRef = {
-    namespace: string;
-    eventName: string;
-};
-export declare const parseActionRef: (actionRef: string) => ParsedActionRef | null;
-export declare const parseEventRef: (eventRef: string) => ParsedEventRef | null;
-export declare const formatActionRef: (actionRef: ParsedActionRef) => string;
-export declare const formatEventRef: (eventRef: ParsedEventRef) => string;
-export declare const resolveAction: (actionRef: ParsedActionRef, interfaces: PluginInterfaceExtensions<any>) => ParsedActionRef;
-export declare const resolveEvent: (eventRef: ParsedEventRef, interfaces: PluginInterfaceExtensions<any>) => ParsedEventRef;