@bpinternal/const 0.0.1 → 0.0.3

package/dist/index.cjs

@@ -20,11 +20,88 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var src_exports = {};
 __export(src_exports, {
+  limitConfigs: () => limitConfigs,
   objectToPrefixMap: () => objectToPrefixMap,
-  prefixToObjectMap: () => prefixToObjectMap
+  prefixToObjectMap: () => prefixToObjectMap,
+  quotaConfigs: () => quotaConfigs,
+  quotaTypes: () => quotaTypes
 });
 module.exports = __toCommonJS(src_exports);
 
+// src/limits.ts
+var limitConfigs = {
+  bot_configuration_bytes: {
+    value: 20480,
+    // 20 KB
+    unit: "bytes"
+  },
+  bot_installed_integrations_count: {
+    value: 30,
+    unit: "count"
+  },
+  bot_integration_configuration_bytes: {
+    value: 20480,
+    // 20 KB
+    unit: "bytes"
+  },
+  bot_recurring_event_count: {
+    value: 5,
+    unit: "count"
+  },
+  bot_recurring_event_payload_bytes: {
+    value: 131072,
+    // 128 KB
+    unit: "bytes"
+  },
+  event_definition_count: {
+    value: 20,
+    unit: "count"
+  },
+  integration_channel_count: {
+    value: 10,
+    unit: "count"
+  },
+  integration_channel_message_type_count: {
+    value: 20,
+    unit: "count"
+  },
+  integration_identifier_count: {
+    value: 50,
+    unit: "count"
+  },
+  integration_version_count: {
+    value: 50,
+    unit: "count"
+  },
+  integrations_owned_count: {
+    value: 20,
+    unit: "count"
+  },
+  message_payload_bytes: {
+    value: 131072,
+    // 128 KB
+    unit: "bytes"
+  },
+  schema_bytes: {
+    value: 102400,
+    // 100 KB
+    unit: "bytes"
+  },
+  state_definition_count: {
+    value: 5,
+    unit: "count"
+  },
+  state_item_payload_bytes: {
+    value: 131072,
+    // 128 KB
+    unit: "bytes"
+  },
+  tag_definition_count: {
+    value: 50,
+    unit: "count"
+  }
+};
+
 // src/prefixes.ts
 var prefixToObjectMap = {
   action: "action",
@@ -92,8 +169,82 @@ var objectToPrefixMap = {
   webhook: "webhook",
   workspace: "wkspace"
 };
+
+// src/quotas.ts
+var quotaTypes = [
+  "invocation_timeout",
+  "invocation_calls",
+  "storage_count",
+  "bot_count",
+  "knowledgebase_vector_count",
+  "bot_ratelimit",
+  "table_row_count",
+  "workspace_member_count"
+];
+var quotaConfigs = {
+  invocation_timeout: {
+    name: "Invocation Timeout",
+    description: "Maximum time in milliseconds a bot can run before timing out.",
+    default: 6e4,
+    kind: "bot",
+    category: "timeout"
+  },
+  storage_count: {
+    name: "Storage Count",
+    description: "Maximum number of storage bytes that can be stored.",
+    default: 104857600,
+    // 100 MB
+    kind: "bot",
+    category: "count"
+  },
+  bot_count: {
+    name: "Bot Count",
+    description: "Maximum number of bots that can be created.",
+    default: 5,
+    kind: "workspace",
+    category: "count"
+  },
+  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"
+  },
+  knowledgebase_vector_count: {
+    name: "Knowledgebase Vector Count",
+    description: "Maximum number of knowledgebase vectors that can be created.",
+    default: 5e3,
+    kind: "bot",
+    category: "count"
+  },
+  table_row_count: {
+    name: "Table Row Count",
+    description: "Maximum number of rows that can be stored in a table.",
+    default: 5e3,
+    kind: "bot",
+    category: "count"
+  },
+  invocation_calls: {
+    name: "Invocation Calls",
+    description: "Maximum number of times a bot can be invoked in a month.",
+    default: 25e3,
+    kind: "bot",
+    category: "calls"
+  },
+  bot_ratelimit: {
+    name: "Bot Ratelimit",
+    description: "Maximum number of times a bot can be invoked in a minute.",
+    default: 100,
+    kind: "bot",
+    category: "ratelimit"
+  }
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  limitConfigs,
   objectToPrefixMap,
-  prefixToObjectMap
+  prefixToObjectMap,
+  quotaConfigs,
+  quotaTypes
 });

package/dist/index.mjs

@@ -1,3 +1,77 @@
+// src/limits.ts
+var limitConfigs = {
+  bot_configuration_bytes: {
+    value: 20480,
+    // 20 KB
+    unit: "bytes"
+  },
+  bot_installed_integrations_count: {
+    value: 30,
+    unit: "count"
+  },
+  bot_integration_configuration_bytes: {
+    value: 20480,
+    // 20 KB
+    unit: "bytes"
+  },
+  bot_recurring_event_count: {
+    value: 5,
+    unit: "count"
+  },
+  bot_recurring_event_payload_bytes: {
+    value: 131072,
+    // 128 KB
+    unit: "bytes"
+  },
+  event_definition_count: {
+    value: 20,
+    unit: "count"
+  },
+  integration_channel_count: {
+    value: 10,
+    unit: "count"
+  },
+  integration_channel_message_type_count: {
+    value: 20,
+    unit: "count"
+  },
+  integration_identifier_count: {
+    value: 50,
+    unit: "count"
+  },
+  integration_version_count: {
+    value: 50,
+    unit: "count"
+  },
+  integrations_owned_count: {
+    value: 20,
+    unit: "count"
+  },
+  message_payload_bytes: {
+    value: 131072,
+    // 128 KB
+    unit: "bytes"
+  },
+  schema_bytes: {
+    value: 102400,
+    // 100 KB
+    unit: "bytes"
+  },
+  state_definition_count: {
+    value: 5,
+    unit: "count"
+  },
+  state_item_payload_bytes: {
+    value: 131072,
+    // 128 KB
+    unit: "bytes"
+  },
+  tag_definition_count: {
+    value: 50,
+    unit: "count"
+  }
+};
+
 // src/prefixes.ts
 var prefixToObjectMap = {
   action: "action",
@@ -65,7 +139,81 @@ var objectToPrefixMap = {
   webhook: "webhook",
   workspace: "wkspace"
 };
+
+// src/quotas.ts
+var quotaTypes = [
+  "invocation_timeout",
+  "invocation_calls",
+  "storage_count",
+  "bot_count",
+  "knowledgebase_vector_count",
+  "bot_ratelimit",
+  "table_row_count",
+  "workspace_member_count"
+];
+var quotaConfigs = {
+  invocation_timeout: {
+    name: "Invocation Timeout",
+    description: "Maximum time in milliseconds a bot can run before timing out.",
+    default: 6e4,
+    kind: "bot",
+    category: "timeout"
+  },
+  storage_count: {
+    name: "Storage Count",
+    description: "Maximum number of storage bytes that can be stored.",
+    default: 104857600,
+    // 100 MB
+    kind: "bot",
+    category: "count"
+  },
+  bot_count: {
+    name: "Bot Count",
+    description: "Maximum number of bots that can be created.",
+    default: 5,
+    kind: "workspace",
+    category: "count"
+  },
+  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"
+  },
+  knowledgebase_vector_count: {
+    name: "Knowledgebase Vector Count",
+    description: "Maximum number of knowledgebase vectors that can be created.",
+    default: 5e3,
+    kind: "bot",
+    category: "count"
+  },
+  table_row_count: {
+    name: "Table Row Count",
+    description: "Maximum number of rows that can be stored in a table.",
+    default: 5e3,
+    kind: "bot",
+    category: "count"
+  },
+  invocation_calls: {
+    name: "Invocation Calls",
+    description: "Maximum number of times a bot can be invoked in a month.",
+    default: 25e3,
+    kind: "bot",
+    category: "calls"
+  },
+  bot_ratelimit: {
+    name: "Bot Ratelimit",
+    description: "Maximum number of times a bot can be invoked in a minute.",
+    default: 100,
+    kind: "bot",
+    category: "ratelimit"
+  }
+};
 export {
+  limitConfigs,
   objectToPrefixMap,
-  prefixToObjectMap
+  prefixToObjectMap,
+  quotaConfigs,
+  quotaTypes
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bpinternal/const",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "Constant utilities for Botpress",
   "main": "./dist/index.cjs",
   "browser": "./dist/index.mjs",

package/src/index.ts

@@ -1 +1,3 @@
+export * from './limits';
 export * from './prefixes';
+export * from './quotas';

package/src/limits.ts

@@ -0,0 +1,80 @@
+type Limit = {
+  /**
+   * The maximum value for the limit.
+   */
+  value: number
+  /**
+   * The unit of the limit.
+   */
+  unit: LimitUnit
+}
+
+export type LimitType = keyof typeof limitConfigs
+export type LimitUnit = 'count' | 'bytes'
+
+export const limitConfigs = {
+  bot_configuration_bytes: {
+    value: 20480, // 20 KB
+    unit: 'bytes',
+  },
+  bot_installed_integrations_count: {
+    value: 30,
+    unit: 'count',
+  },
+  bot_integration_configuration_bytes: {
+    value: 20480, // 20 KB
+    unit: 'bytes',
+  },
+  bot_recurring_event_count: {
+    value: 5,
+    unit: 'count',
+  },
+  bot_recurring_event_payload_bytes: {
+    value: 131072, // 128 KB
+    unit: 'bytes',
+  },
+  event_definition_count: {
+    value: 20,
+    unit: 'count',
+  },
+  integration_channel_count: {
+    value: 10,
+    unit: 'count',
+  },
+  integration_channel_message_type_count: {
+    value: 20,
+    unit: 'count',
+  },
+  integration_identifier_count: {
+    value: 50,
+    unit: 'count',
+  },
+  integration_version_count: {
+    value: 50,
+    unit: 'count',
+  },
+  integrations_owned_count: {
+    value: 20,
+    unit: 'count',
+  },
+  message_payload_bytes: {
+    value: 131072, // 128 KB
+    unit: 'bytes',
+  },
+  schema_bytes: {
+    value: 102400, // 100 KB
+    unit: 'bytes',
+  },
+  state_definition_count: {
+    value: 5,
+    unit: 'count',
+  },
+  state_item_payload_bytes: {
+    value: 131072, // 128 KB
+    unit: 'bytes',
+  },
+  tag_definition_count: {
+    value: 50,
+    unit: 'count',
+  },
+} as const satisfies Record<string, Limit>

package/src/quotas.ts

@@ -0,0 +1,96 @@
+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
+}
+
+export type QuotaKind = 'workspace' | 'bot'
+export type QuotaCategory = 'ratelimit' | 'count' | 'calls' | 'timeout'
+export type QuotaType = typeof quotaTypes[number]
+
+export const quotaTypes = [
+  'invocation_timeout',
+  'invocation_calls',
+  'storage_count',
+  'bot_count',
+  'knowledgebase_vector_count',
+  'bot_ratelimit',
+  'table_row_count',
+  'workspace_member_count',
+] as const
+
+export const quotaConfigs = {
+  invocation_timeout: {
+    name: 'Invocation Timeout',
+    description: 'Maximum time in milliseconds a bot can run before timing out.',
+    default: 60_000,
+    kind: 'bot',
+    category: 'timeout',
+  },
+  storage_count: {
+    name: 'Storage Count',
+    description: 'Maximum number of storage bytes that can be stored.',
+    default: 104_857_600, // 100 MB
+    kind: 'bot',
+    category: 'count',
+  },
+  bot_count: {
+    name: 'Bot Count',
+    description: 'Maximum number of bots that can be created.',
+    default: 5,
+    kind: 'workspace',
+    category: 'count',
+  },
+  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',
+  },
+  knowledgebase_vector_count: {
+    name: 'Knowledgebase Vector Count',
+    description: 'Maximum number of knowledgebase vectors that can be created.',
+    default: 5_000,
+    kind: 'bot',
+    category: 'count',
+  },
+  table_row_count: {
+    name: 'Table Row Count',
+    description: 'Maximum number of rows that can be stored in a table.',
+    default: 5_000,
+    kind: 'bot',
+    category: 'count',
+  },
+  invocation_calls: {
+    name: 'Invocation Calls',
+    description: 'Maximum number of times a bot can be invoked in a month.',
+    default: 25_000,
+    kind: 'bot',
+    category: 'calls',
+  },
+  bot_ratelimit: {
+    name: 'Bot Ratelimit',
+    description: 'Maximum number of times a bot can be invoked in a minute.',
+    default: 100,
+    kind: 'bot',
+    category: 'ratelimit',
+  },
+} as const satisfies Record<QuotaType, Quota>