@bpinternal/const 0.2.2 → 0.3.0

package/dist/tags.js

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

package/dist/usage-metadata.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Usage metadata definitions for v4 billing system
+ * These define the dimensions we want to track for each feature
+ */
+export type UsageEvent = {
+    transactionId: string;
+    amount: number;
+    feature: string;
+    workspaceId: string;
+    timestamp: number;
+    meta: Record<string, unknown>;
+};
+export type UsageMetadataConfig = {
+    feature: string;
+    dimensions: Record<string, {
+        description: string;
+        required: boolean;
+        type: 'string' | 'number' | 'boolean';
+    }>;
+};
+export declare const usageMetadataConfigs: Record<string, UsageMetadataConfig>;
+export declare const validateUsageEvent: (event: UsageEvent) => boolean;

package/dist/usage-metadata.js

@@ -0,0 +1,138 @@
+"use strict";
+/**
+ * Usage metadata definitions for v4 billing system
+ * These define the dimensions we want to track for each feature
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateUsageEvent = exports.usageMetadataConfigs = void 0;
+exports.usageMetadataConfigs = {
+    incoming_messages_events: {
+        feature: 'incoming_messages_events',
+        dimensions: {
+            botId: {
+                description: 'The ID of the bot that processed the message/event',
+                required: true,
+                type: 'string',
+            },
+            type: {
+                description: 'Whether this is a message or an event',
+                required: true,
+                type: 'string',
+            },
+            channel: {
+                description: 'The channel where the message/event originated',
+                required: false,
+                type: 'string',
+            },
+        },
+    },
+    integration_spend: {
+        feature: 'integration_spend',
+        dimensions: {
+            botId: {
+                description: 'The ID of the bot that used the integration',
+                required: true,
+                type: 'string',
+            },
+            integrationVersionId: {
+                description: 'The version ID of the integration used',
+                required: true,
+                type: 'string',
+            },
+            actionName: {
+                description: 'The specific action that was called',
+                required: true,
+                type: 'string',
+            },
+            provider: {
+                description: 'The provider of the integration (e.g., openai, anthropic)',
+                required: false,
+                type: 'string',
+            },
+            model: {
+                description: 'The specific model used (for AI integrations)',
+                required: false,
+                type: 'string',
+            },
+        },
+    },
+    table_rows: {
+        feature: 'table_rows',
+        dimensions: {
+            botId: {
+                description: 'The ID of the bot that owns the table',
+                required: true,
+                type: 'string',
+            },
+            tableId: {
+                description: 'The ID of the table',
+                required: true,
+                type: 'string',
+            },
+            operation: {
+                description: 'The operation performed (create, update, delete)',
+                required: true,
+                type: 'string',
+            },
+        },
+    },
+    file_storage: {
+        feature: 'file_storage',
+        dimensions: {
+            botId: {
+                description: 'The ID of the bot that owns the file',
+                required: true,
+                type: 'string',
+            },
+            fileId: {
+                description: 'The ID of the file',
+                required: true,
+                type: 'string',
+            },
+            operation: {
+                description: 'The operation performed (upload, delete)',
+                required: true,
+                type: 'string',
+            },
+            fileType: {
+                description: 'The type/extension of the file',
+                required: false,
+                type: 'string',
+            },
+        },
+    },
+    vector_db_storage: {
+        feature: 'vector_db_storage',
+        dimensions: {
+            botId: {
+                description: 'The ID of the bot that owns the vectors',
+                required: true,
+                type: 'string',
+            },
+            collectionId: {
+                description: 'The ID of the vector collection',
+                required: true,
+                type: 'string',
+            },
+            operation: {
+                description: 'The operation performed (insert, delete)',
+                required: true,
+                type: 'string',
+            },
+        },
+    },
+};
+const validateUsageEvent = (event) => {
+    const config = exports.usageMetadataConfigs[event.feature];
+    if (!config) {
+        return false;
+    }
+    // Check required dimensions
+    for (const [dimName, dimConfig] of Object.entries(config.dimensions)) {
+        if (dimConfig.required && !(dimName in event.meta)) {
+            return false;
+        }
+    }
+    return true;
+};
+exports.validateUsageEvent = validateUsageEvent;

package/package.json

@@ -1,29 +1,19 @@
 {
   "name": "@bpinternal/const",
-  "version": "0.2.2",
-  "description": "Constant utilities for Botpress",
-  "main": "./dist/index.cjs",
-  "browser": "./dist/index.mjs",
-  "types": "./src/index.ts",
-  "license": "MIT",
+  "version": "0.3.0",
+  "description": "Shared constants for Skynet billing refactor (vendored copy of upstream packages/const)",
+  "license": "UNLICENSED",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "scripts": {
-    "check:type": "tsc --noEmit",
-    "build:nodejs": "esbuild src/index.ts --bundle --platform=node --target=node16 --outfile=dist/index.cjs",
-    "build:browser": "esbuild src/index.ts --bundle --platform=browser --target=es2017 --format=esm --outfile=dist/index.mjs",
-    "build": "npm run build:nodejs && npm run build:browser",
-    "test": "vitest run"
+    "build": "tsc -b tsconfig.json",
+    "dev": "tsc -w",
+    "clean": "rm -rf dist tsconfig.tsbuildinfo"
   },
-  "dependencies": {},
+  "files": [
+    "dist"
+  ],
   "devDependencies": {
-    "@tsconfig/node18-strictest": "^1.0.0",
-    "esbuild": "^0.25.0",
-    "ts-node": "^10.9.1",
-    "typescript": "5.8.3",
-    "vitest": "1.6.0"
-  },
-  "engines": {
-    "node": ">=16.0.0",
-    "pnpm": "8.6.2"
-  },
-  "packageManager": "pnpm@8.6.2"
+    "typescript": "^5.3.3"
+  }
 }