fix: Fix usageV2 imports, allow sdk source (#6164)

Author: arcoraven

.changeset/small-moons-behave.md

@@ -0,0 +1,5 @@
+---
+"@thirdweb-dev/service-utils": patch
+---
+
+[service-utils] fix: Add missing CompressionCodecs import

packages/service-utils/package.json

@@ -26,12 +26,8 @@
   },
   "typesVersions": {
     "*": {
-      "node": [
-        "./dist/types/node/index.d.ts"
-      ],
-      "cf-worker": [
-        "./dist/types/cf-worker/index.d.ts"
-      ]
+      "node": ["./dist/types/node/index.d.ts"],
+      "cf-worker": ["./dist/types/cf-worker/index.d.ts"]
     }
   },
   "repository": "https://github.com/thirdweb-dev/js/tree/main/packages/pay",
@@ -40,19 +36,17 @@
     "url": "https://github.com/thirdweb-dev/js/issues"
   },
   "author": "thirdweb eng <eng@thirdweb.com>",
-  "files": [
-    "dist/"
-  ],
+  "files": ["dist/"],
   "sideEffects": false,
   "dependencies": {
     "aws4fetch": "1.0.20",
     "kafkajs": "2.2.4",
-    "lz4js": "^0.2.0",
+    "lz4js": "0.2.0",
     "zod": "3.24.1"
   },
   "devDependencies": {
     "@cloudflare/workers-types": "4.20250129.0",
-    "@types/lz4js": "^0.2.1",
+    "@types/lz4js": "0.2.1",
     "@types/node": "22.13.0",
     "typescript": "5.7.3",
     "vitest": "3.0.4"

packages/service-utils/src/core/usageV2.ts

@@ -1,4 +1,6 @@
-import type { ServiceName } from "../node/index.js";
+import type { ServiceName } from "./services.js";
+
+export type UsageV2Source = ServiceName | "sdk";
 
 export interface UsageV2Event {
   /**
@@ -53,6 +55,6 @@ export interface UsageV2Event {
   [key: string]: boolean | number | string | Date | null | undefined;
 }
 
-export function getTopicName(productName: ServiceName) {
-  return `usage_v2.raw_${productName}`;
+export function getTopicName(source: UsageV2Source) {
+  return `usage_v2.raw_${source}`;
 }

packages/service-utils/src/node/usageV2.ts

@@ -1,15 +1,21 @@
 import { randomUUID } from "node:crypto";
 import { checkServerIdentity } from "node:tls";
 import {
-  CompressionCodecs,
   CompressionTypes,
   Kafka,
   type Producer,
   type ProducerConfig,
 } from "kafkajs";
 import { compress, decompress } from "lz4js";
-import type { ServiceName } from "../core/services.js";
-import { type UsageV2Event, getTopicName } from "../core/usageV2.js";
+import {
+  type UsageV2Event,
+  type UsageV2Source,
+  getTopicName,
+} from "../core/usageV2.js";
+
+// CompressionCodecs is not exported properly in kafkajs. Source: https://github.com/tulios/kafkajs/issues/1391
+import KafkaJS from "kafkajs";
+const { CompressionCodecs } = KafkaJS;
 
 /**
  * Creates a UsageV2Producer which opens a persistent TCP connection.
@@ -40,9 +46,9 @@ export class UsageV2Producer {
      */
     environment: "development" | "production";
     /**
-     * The product "source" where usage is coming from.
+     * The product where usage is coming from.
      */
-    productName: ServiceName;
+    source: UsageV2Source;
     /**
      * Whether to compress the events.
      */
@@ -54,7 +60,7 @@ export class UsageV2Producer {
     const {
       producerName,
       environment,
-      productName,
+      source,
       shouldCompress = true,
       username,
       password,
@@ -78,7 +84,7 @@ export class UsageV2Producer {
       },
     });
 
-    this.topic = getTopicName(productName);
+    this.topic = getTopicName(source);
     this.compression = shouldCompress
       ? CompressionTypes.LZ4
       : CompressionTypes.None;