@bpinternal/const 0.2.2 → 0.3.0

package/dist/prefixes.js

@@ -0,0 +1,103 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.objectToPrefixMap = exports.prefixToObjectMap = void 0;
+exports.prefixToObjectMap = {
+    accnt: 'account',
+    accntpf: 'accountPreference',
+    action: 'action',
+    activty: 'activity',
+    anlytic: 'analytics',
+    audit: 'audit',
+    bak: 'botApiKey',
+    bot: 'bot',
+    card: 'card',
+    cfg: 'configuration',
+    channel: 'channel',
+    conv: 'conversation',
+    devbot: 'devBot',
+    devint: 'devIntegration',
+    evt: 'event',
+    file: 'file',
+    flow: 'flow',
+    iak: 'integrationApiKey',
+    int: 'integration',
+    iface: 'interface',
+    ifver: 'interfaceVersion',
+    intver: 'integrationVersion',
+    iss: 'issue',
+    issevt: 'issueEvent',
+    kb: 'knowledgeBase',
+    limit: 'limit',
+    media: 'media',
+    msg: 'message',
+    node: 'node',
+    notif: 'notification',
+    pat: 'personalAccessToken',
+    plugin: 'plugin',
+    plugver: 'pluginVersion',
+    quota: 'quota',
+    recevt: 'recurringEvent',
+    report: 'report',
+    sandbox: 'sandbox',
+    schema: 'schema',
+    script: 'script',
+    state: 'state',
+    table: 'table',
+    tag: 'tag',
+    task: 'task',
+    usage: 'usage',
+    user: 'user',
+    webhook: 'webhook',
+    wkspace: 'workspace',
+    wrkflow: 'workflow',
+};
+exports.objectToPrefixMap = {
+    account: 'accnt',
+    accountPreference: 'accntpf',
+    action: 'action',
+    activity: 'activty',
+    analytics: 'anlytic',
+    audit: 'audit',
+    bot: 'bot',
+    botApiKey: 'bak',
+    card: 'card',
+    channel: 'channel',
+    configuration: 'cfg',
+    conversation: 'conv',
+    devBot: 'devbot',
+    devIntegration: 'devint',
+    event: 'evt',
+    file: 'file',
+    flow: 'flow',
+    integration: 'int',
+    integrationApiKey: 'iak',
+    integrationVersion: 'intver',
+    interface: 'iface',
+    interfaceVersion: 'ifver',
+    issue: 'iss',
+    issueEvent: 'issevt',
+    knowledgeBase: 'kb',
+    limit: 'limit',
+    media: 'media',
+    message: 'msg',
+    node: 'node',
+    notification: 'notif',
+    personalAccessToken: 'pat',
+    plugin: 'plugin',
+    pluginVersion: 'plugver',
+    quota: 'quota',
+    recurringEvent: 'recevt',
+    report: 'report',
+    sandbox: 'sandbox',
+    schema: 'schema',
+    script: 'script',
+    state: 'state',
+    table: 'table',
+    tag: 'tag',
+    task: 'task',
+    usage: 'usage',
+    user: 'user',
+    webhook: 'webhook',
+    workflow: 'wrkflow',
+    workspace: 'wkspace',
+};

package/dist/quotas.d.ts

@@ -0,0 +1,250 @@
+export type Quota = {
+    /**
+     * Friendly name of the usage type.
+     */
+    name: string;
+    /**
+     * Description of the usage type.
+     */
+    description: string;
+    /**
+     * The default limit for the usage type. This is the fallback value if the limit is not set.
+     */
+    default: number;
+    /**
+     * The kind of usage type. This is used to determine the object linked to the usage type.
+     */
+    kind: QuotaKind;
+    /**
+     * The usage category determine how the usage is calculated.
+     */
+    category: QuotaCategory;
+    /**
+     * If true, the usage is tracked per bot. This is only applicable if the kind is workspace.
+     */
+    trackUsagePerBot: boolean;
+    /**
+     * Parent quota type. This is used to determine the object linked to the usage type.
+     */
+    parent?: QuotaType;
+};
+export type QuotaKind = 'workspace' | 'bot';
+export type QuotaCategory = 'ratelimit' | 'count' | 'calls' | 'timeout' | 'credit';
+export type QuotaType = (typeof quotaTypes)[number];
+export declare const quotaTypes: readonly ["invocation_timeout", "invocation_calls", "storage_count", "bot_count", "knowledgebase_vector_storage", "workspace_ratelimit", "table_row_count", "workspace_member_count", "integrations_owned_count", "ai_spend", "openai_spend", "bing_search_spend", "always_alive"];
+export declare const quotaConfigs: {
+    readonly invocation_timeout: {
+        readonly name: "Invocation Timeout";
+        readonly description: "Maximum time in milliseconds a bot can run before timing out.";
+        readonly default: 60000;
+        readonly kind: "workspace";
+        readonly category: "timeout";
+        readonly trackUsagePerBot: false;
+    };
+    readonly storage_count: {
+        readonly name: "Storage Count";
+        readonly description: "Maximum number of storage bytes that can be stored.";
+        readonly default: 500000000;
+        readonly kind: "workspace";
+        readonly category: "count";
+        readonly trackUsagePerBot: true;
+    };
+    readonly bot_count: {
+        readonly name: "Bot Count";
+        readonly description: "Maximum number of bots that can be created.";
+        readonly default: 5;
+        readonly kind: "workspace";
+        readonly category: "count";
+        readonly trackUsagePerBot: false;
+    };
+    readonly workspace_member_count: {
+        readonly name: "Workspace Member Count";
+        readonly description: "Maximum number of members that can be added to a workspace.";
+        readonly default: 3;
+        readonly kind: "workspace";
+        readonly category: "count";
+        readonly trackUsagePerBot: false;
+    };
+    readonly knowledgebase_vector_storage: {
+        readonly name: "Knowledgebase Vector Storage";
+        readonly description: "Maximum size of knowledge base documents";
+        readonly default: 100000000;
+        readonly kind: "workspace";
+        readonly category: "count";
+        readonly trackUsagePerBot: true;
+    };
+    readonly table_row_count: {
+        readonly name: "Table Row Count";
+        readonly description: "Maximum number of rows that can be stored in a table.";
+        readonly default: 5000;
+        readonly kind: "workspace";
+        readonly category: "count";
+        readonly trackUsagePerBot: true;
+    };
+    readonly invocation_calls: {
+        readonly name: "Messages";
+        readonly description: "Maximum number of messages sent to a bot in a month.";
+        readonly default: 2000;
+        readonly kind: "workspace";
+        readonly category: "calls";
+        readonly trackUsagePerBot: true;
+    };
+    readonly workspace_ratelimit: {
+        readonly name: "Workspace Ratelimit";
+        readonly description: "Maximum number of API calls per second for a workspace.";
+        readonly default: 100;
+        readonly kind: "workspace";
+        readonly category: "ratelimit";
+        readonly trackUsagePerBot: false;
+    };
+    readonly integrations_owned_count: {
+        readonly name: "Owned Integrations Count";
+        readonly description: "Maximum number of integrations that can be created.";
+        readonly default: 20;
+        readonly kind: "workspace";
+        readonly category: "count";
+        readonly trackUsagePerBot: false;
+    };
+    readonly ai_spend: {
+        readonly name: "AI Spend";
+        readonly description: "Maximum amount of AI spend, expressed in nano-dollars (1 nano-dollar = $0.000000001) that can be used in a month.";
+        readonly default: 5000000000;
+        readonly kind: "workspace";
+        readonly category: "credit";
+        readonly trackUsagePerBot: true;
+    };
+    readonly openai_spend: {
+        readonly name: "OpenAI Spend";
+        readonly description: "Maximum amount of OpenAI spend, expressed in nano-dollars (1 nano-dollar = $0.000000001) that can be used in a month.";
+        readonly default: 5000000000;
+        readonly kind: "workspace";
+        readonly category: "credit";
+        readonly trackUsagePerBot: true;
+        readonly parent: "ai_spend";
+    };
+    readonly bing_search_spend: {
+        readonly name: "Bing Search Spend";
+        readonly description: "Maximum amount of Bing Search spend, expressed in nano-dollars (1 nano-dollar = $0.000000001) that can be used in a month.";
+        readonly default: 5000000000;
+        readonly kind: "workspace";
+        readonly category: "credit";
+        readonly trackUsagePerBot: true;
+        readonly parent: "ai_spend";
+    };
+    readonly always_alive: {
+        readonly name: "Always Alive";
+        readonly description: "Maximum number of bots that can be in always alive mode.";
+        readonly default: 0;
+        readonly kind: "workspace";
+        readonly category: "count";
+        readonly trackUsagePerBot: false;
+    };
+};
+export declare const quotaConfigsV3: {
+    readonly invocation_timeout: {
+        readonly name: "Invocation Timeout";
+        readonly description: "Maximum time in milliseconds a bot can run before timing out.";
+        readonly default: 60000;
+        readonly kind: "workspace";
+        readonly category: "timeout";
+        readonly trackUsagePerBot: false;
+    };
+    readonly storage_count: {
+        readonly name: "Storage Count";
+        readonly description: "Maximum number of storage bytes that can be stored.";
+        readonly default: 100000000;
+        readonly kind: "workspace";
+        readonly category: "count";
+        readonly trackUsagePerBot: true;
+    };
+    readonly bot_count: {
+        readonly name: "Bot Count";
+        readonly description: "Maximum number of bots that can be created.";
+        readonly default: 1;
+        readonly kind: "workspace";
+        readonly category: "count";
+        readonly trackUsagePerBot: false;
+    };
+    readonly workspace_member_count: {
+        readonly name: "Workspace Member Count";
+        readonly description: "Maximum number of members that can be added to a workspace.";
+        readonly default: 1;
+        readonly kind: "workspace";
+        readonly category: "count";
+        readonly trackUsagePerBot: false;
+    };
+    readonly knowledgebase_vector_storage: {
+        readonly name: "Knowledgebase Vector Storage";
+        readonly description: "Maximum size of knowledge base documents";
+        readonly default: 100000000;
+        readonly kind: "workspace";
+        readonly category: "count";
+        readonly trackUsagePerBot: true;
+    };
+    readonly table_row_count: {
+        readonly name: "Table Row Count";
+        readonly description: "Maximum number of rows that can be stored in a table.";
+        readonly default: 1000;
+        readonly kind: "workspace";
+        readonly category: "count";
+        readonly trackUsagePerBot: true;
+    };
+    readonly invocation_calls: {
+        readonly name: "Messages";
+        readonly description: "Maximum number of messages sent to a bot in a month.";
+        readonly default: 500;
+        readonly kind: "workspace";
+        readonly category: "calls";
+        readonly trackUsagePerBot: true;
+    };
+    readonly workspace_ratelimit: {
+        readonly name: "Workspace Ratelimit";
+        readonly description: "Maximum number of API calls per second for a workspace.";
+        readonly default: 100;
+        readonly kind: "workspace";
+        readonly category: "ratelimit";
+        readonly trackUsagePerBot: false;
+    };
+    readonly integrations_owned_count: {
+        readonly name: "Owned Integrations Count";
+        readonly description: "Maximum number of integrations that can be created.";
+        readonly default: 20;
+        readonly kind: "workspace";
+        readonly category: "count";
+        readonly trackUsagePerBot: false;
+    };
+    readonly ai_spend: {
+        readonly name: "AI Spend";
+        readonly description: "Maximum amount of AI spend, expressed in nano-dollars (1 nano-dollar = $0.000000001) that can be used in a month.";
+        readonly default: 5000000000;
+        readonly kind: "workspace";
+        readonly category: "credit";
+        readonly trackUsagePerBot: true;
+    };
+    readonly openai_spend: {
+        readonly name: "OpenAI Spend";
+        readonly description: "Maximum amount of OpenAI spend, expressed in nano-dollars (1 nano-dollar = $0.000000001) that can be used in a month.";
+        readonly default: 5000000000;
+        readonly kind: "workspace";
+        readonly category: "credit";
+        readonly trackUsagePerBot: true;
+        readonly parent: "ai_spend";
+    };
+    readonly bing_search_spend: {
+        readonly name: "Bing Search Spend";
+        readonly description: "Maximum amount of Bing Search spend, expressed in nano-dollars (1 nano-dollar = $0.000000001) that can be used in a month.";
+        readonly default: 5000000000;
+        readonly kind: "workspace";
+        readonly category: "credit";
+        readonly trackUsagePerBot: true;
+        readonly parent: "ai_spend";
+    };
+    readonly always_alive: {
+        readonly name: "Always Alive";
+        readonly description: "Maximum number of bots that can be in always alive mode.";
+        readonly default: 0;
+        readonly kind: "workspace";
+        readonly category: "count";
+        readonly trackUsagePerBot: false;
+    };
+};

package/dist/quotas.js

@@ -0,0 +1,234 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.quotaConfigsV3 = exports.quotaConfigs = exports.quotaTypes = void 0;
+exports.quotaTypes = [
+    'invocation_timeout',
+    'invocation_calls',
+    'storage_count',
+    'bot_count',
+    'knowledgebase_vector_storage',
+    'workspace_ratelimit',
+    'table_row_count',
+    'workspace_member_count',
+    'integrations_owned_count',
+    'ai_spend',
+    'openai_spend',
+    'bing_search_spend',
+    'always_alive',
+];
+exports.quotaConfigs = {
+    invocation_timeout: {
+        name: 'Invocation Timeout',
+        description: 'Maximum time in milliseconds a bot can run before timing out.',
+        default: 60_000,
+        kind: 'workspace',
+        category: 'timeout',
+        trackUsagePerBot: false,
+    },
+    storage_count: {
+        name: 'Storage Count',
+        description: 'Maximum number of storage bytes that can be stored.',
+        default: 500_000_000, // 500 MB
+        kind: 'workspace',
+        category: 'count',
+        trackUsagePerBot: true,
+    },
+    bot_count: {
+        name: 'Bot Count',
+        description: 'Maximum number of bots that can be created.',
+        default: 5,
+        kind: 'workspace',
+        category: 'count',
+        trackUsagePerBot: false,
+    },
+    workspace_member_count: {
+        name: 'Workspace Member Count',
+        description: 'Maximum number of members that can be added to a workspace.',
+        default: 3,
+        kind: 'workspace',
+        category: 'count',
+        trackUsagePerBot: false,
+    },
+    knowledgebase_vector_storage: {
+        name: 'Knowledgebase Vector Storage',
+        description: 'Maximum size of knowledge base documents',
+        default: 100_000_000, // 100 MB
+        kind: 'workspace',
+        category: 'count',
+        trackUsagePerBot: true,
+    },
+    table_row_count: {
+        name: 'Table Row Count',
+        description: 'Maximum number of rows that can be stored in a table.',
+        default: 5_000,
+        kind: 'workspace',
+        category: 'count',
+        trackUsagePerBot: true,
+    },
+    invocation_calls: {
+        name: 'Messages',
+        description: 'Maximum number of messages sent to a bot in a month.',
+        default: 2_000,
+        kind: 'workspace',
+        category: 'calls',
+        trackUsagePerBot: true,
+    },
+    workspace_ratelimit: {
+        name: 'Workspace Ratelimit',
+        description: 'Maximum number of API calls per second for a workspace.',
+        default: 100,
+        kind: 'workspace',
+        category: 'ratelimit',
+        trackUsagePerBot: false,
+    },
+    integrations_owned_count: {
+        name: 'Owned Integrations Count',
+        description: 'Maximum number of integrations that can be created.',
+        default: 20,
+        kind: 'workspace',
+        category: 'count',
+        trackUsagePerBot: false,
+    },
+    ai_spend: {
+        name: 'AI Spend',
+        description: 'Maximum amount of AI spend, expressed in nano-dollars (1 nano-dollar = $0.000000001) that can be used in a month.',
+        default: 5_000_000_000,
+        kind: 'workspace',
+        category: 'credit',
+        trackUsagePerBot: true,
+    },
+    openai_spend: {
+        name: 'OpenAI Spend',
+        description: 'Maximum amount of OpenAI spend, expressed in nano-dollars (1 nano-dollar = $0.000000001) that can be used in a month.',
+        default: 5_000_000_000,
+        kind: 'workspace',
+        category: 'credit',
+        trackUsagePerBot: true,
+        parent: 'ai_spend',
+    },
+    bing_search_spend: {
+        name: 'Bing Search Spend',
+        description: 'Maximum amount of Bing Search spend, expressed in nano-dollars (1 nano-dollar = $0.000000001) that can be used in a month.',
+        default: 5_000_000_000,
+        kind: 'workspace',
+        category: 'credit',
+        trackUsagePerBot: true,
+        parent: 'ai_spend',
+    },
+    always_alive: {
+        name: 'Always Alive',
+        description: 'Maximum number of bots that can be in always alive mode.',
+        default: 0,
+        kind: 'workspace',
+        category: 'count',
+        trackUsagePerBot: false,
+    },
+};
+exports.quotaConfigsV3 = {
+    invocation_timeout: {
+        name: 'Invocation Timeout',
+        description: 'Maximum time in milliseconds a bot can run before timing out.',
+        default: 60_000,
+        kind: 'workspace',
+        category: 'timeout',
+        trackUsagePerBot: false,
+    },
+    storage_count: {
+        name: 'Storage Count',
+        description: 'Maximum number of storage bytes that can be stored.',
+        default: 100_000_000, // 100 MB
+        kind: 'workspace',
+        category: 'count',
+        trackUsagePerBot: true,
+    },
+    bot_count: {
+        name: 'Bot Count',
+        description: 'Maximum number of bots that can be created.',
+        default: 1,
+        kind: 'workspace',
+        category: 'count',
+        trackUsagePerBot: false,
+    },
+    workspace_member_count: {
+        name: 'Workspace Member Count',
+        description: 'Maximum number of members that can be added to a workspace.',
+        default: 1,
+        kind: 'workspace',
+        category: 'count',
+        trackUsagePerBot: false,
+    },
+    knowledgebase_vector_storage: {
+        name: 'Knowledgebase Vector Storage',
+        description: 'Maximum size of knowledge base documents',
+        default: 100_000_000, // 100 MB
+        kind: 'workspace',
+        category: 'count',
+        trackUsagePerBot: true,
+    },
+    table_row_count: {
+        name: 'Table Row Count',
+        description: 'Maximum number of rows that can be stored in a table.',
+        default: 1_000,
+        kind: 'workspace',
+        category: 'count',
+        trackUsagePerBot: true,
+    },
+    invocation_calls: {
+        name: 'Messages',
+        description: 'Maximum number of messages sent to a bot in a month.',
+        default: 500,
+        kind: 'workspace',
+        category: 'calls',
+        trackUsagePerBot: true,
+    },
+    workspace_ratelimit: {
+        name: 'Workspace Ratelimit',
+        description: 'Maximum number of API calls per second for a workspace.',
+        default: 100,
+        kind: 'workspace',
+        category: 'ratelimit',
+        trackUsagePerBot: false,
+    },
+    integrations_owned_count: {
+        name: 'Owned Integrations Count',
+        description: 'Maximum number of integrations that can be created.',
+        default: 20,
+        kind: 'workspace',
+        category: 'count',
+        trackUsagePerBot: false,
+    },
+    ai_spend: {
+        name: 'AI Spend',
+        description: 'Maximum amount of AI spend, expressed in nano-dollars (1 nano-dollar = $0.000000001) that can be used in a month.',
+        default: 5_000_000_000,
+        kind: 'workspace',
+        category: 'credit',
+        trackUsagePerBot: true,
+    },
+    openai_spend: {
+        name: 'OpenAI Spend',
+        description: 'Maximum amount of OpenAI spend, expressed in nano-dollars (1 nano-dollar = $0.000000001) that can be used in a month.',
+        default: 5_000_000_000,
+        kind: 'workspace',
+        category: 'credit',
+        trackUsagePerBot: true,
+        parent: 'ai_spend',
+    },
+    bing_search_spend: {
+        name: 'Bing Search Spend',
+        description: 'Maximum amount of Bing Search spend, expressed in nano-dollars (1 nano-dollar = $0.000000001) that can be used in a month.',
+        default: 5_000_000_000,
+        kind: 'workspace',
+        category: 'credit',
+        trackUsagePerBot: true,
+        parent: 'ai_spend',
+    },
+    always_alive: {
+        name: 'Always Alive',
+        description: 'Maximum number of bots that can be in always alive mode.',
+        default: 0,
+        kind: 'workspace',
+        category: 'count',
+        trackUsagePerBot: false,
+    },
+};

package/dist/tags.d.ts

@@ -0,0 +1,80 @@
+export type Tag = {
+    type?: 'boolean' | 'string';
+    description?: string;
+};
+export type TagType = keyof typeof Tags;
+export declare const Tags: {
+    readonly bot: {};
+    readonly conversation: {
+        readonly upstream: {
+            readonly description: "Used for HITL as a convention. The upstream conversation ID, ie. the conversation ID of the original conversation";
+        };
+        readonly downstream: {
+            readonly description: "Used for HITL as a convention. The downstream conversation ID, ie. the conversation ID of conversation in HITL channel";
+        };
+    };
+    readonly message: {
+        readonly origin: {
+            readonly description: "The origin location of the message in the bot, eg. \"workflow://[id]/node/[id]\"";
+        };
+        readonly iteration: {
+            readonly description: "The LLMz iteration ID of the message, for tracking and debugging purposes";
+        };
+    };
+    readonly event: {};
+    readonly workflow: {};
+    readonly user: {};
+    readonly file: {
+        readonly system: {
+            readonly type: "boolean";
+            readonly description: "System files are managed by Botpress and should not be modified";
+        };
+        readonly purpose: {
+            readonly description: "The purpose of the file, eg. \"swap\"";
+        };
+        readonly source: {
+            readonly description: "The source of the file, eg. \"knowledge-base\"";
+        };
+        readonly kbId: {
+            readonly description: "The ID of the knowledge base";
+        };
+        readonly favicon: {
+            readonly description: "The favicon URL to display for the file, eg. \"https://example.com/favicon.ico\"";
+        };
+        readonly pageUrl: {
+            readonly description: "The original page URL of the file, eg. \"https://example.com/page\"";
+        };
+        readonly integrationName: {
+            readonly description: "The name of the integration that created the file";
+        };
+        readonly webchatInjectConfigVersion: {
+            readonly description: "The version of the webchat inject configuration (used by the dashboard)";
+        };
+    };
+    readonly table: {
+        readonly system: {
+            readonly type: "boolean";
+            readonly description: "System tables are managed by Botpress and should not be modified";
+        };
+        readonly 'x-studio-title': {
+            readonly description: "Overrides the table title in the Studio";
+        };
+        readonly 'x-studio-readonly': {
+            readonly type: "boolean";
+            readonly description: "Prevents the table from being modified by the user in the Studio";
+        };
+        readonly 'x-studio-icon': {
+            readonly description: "Overrides the table icon in the Studio. The value can be a lucide icon URL, eg. \"lucide://atom\"";
+        };
+        readonly 'x-studio-color': {
+            readonly description: "Overrides the table color in the Studio.";
+        };
+        readonly 'x-studio-folder': {
+            readonly description: "Groups the table in a folder in the Studio";
+        };
+        readonly 'x-studio-deletable': {
+            readonly type: "boolean";
+            readonly description: "Prevents the table from being deleted by the user in the Studio";
+        };
+    };
+};