@revenium/openai 1.0.8

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

@@ -0,0 +1,73 @@
+/**
+ * Type Guards Module
+ *
+ * Runtime type checking utilities to ensure type safety.
+ * These functions validate that objects match expected interfaces.
+ */
+import { OpenAIChatResponse, OpenAIEmbeddingResponse, OpenAIChatRequest, OpenAIEmbeddingRequest, OpenAIClientInstance, StreamChunk } from '../types/function-parameters.js';
+/**
+ * Type guard for OpenAI chat response
+ */
+export declare function isOpenAIChatResponse(obj: unknown): obj is OpenAIChatResponse;
+/**
+ * Type guard for OpenAI embedding response
+ */
+export declare function isOpenAIEmbeddingResponse(obj: unknown): obj is OpenAIEmbeddingResponse;
+/**
+ * Type guard for OpenAI chat request
+ */
+export declare function isOpenAIChatRequest(obj: unknown): obj is OpenAIChatRequest;
+/**
+ * Type guard for OpenAI embedding request
+ */
+export declare function isOpenAIEmbeddingRequest(obj: unknown): obj is OpenAIEmbeddingRequest;
+/**
+ * Type guard for OpenAI client instance
+ */
+export declare function isOpenAIClientInstance(obj: unknown): obj is OpenAIClientInstance;
+/**
+ * Type guard for stream chunk
+ */
+export declare function isStreamChunk(obj: unknown): obj is StreamChunk;
+/**
+ * Type guard for usage object
+ */
+export declare function hasValidUsage(obj: unknown): obj is {
+    usage: {
+        prompt_tokens: number;
+        total_tokens: number;
+    };
+};
+/**
+ * Type guard for function
+ */
+export declare function isFunction(obj: unknown): obj is any;
+/**
+ * Type guard for string
+ */
+export declare function isString(obj: unknown): obj is string;
+/**
+ * Type guard for number
+ */
+export declare function isNumber(obj: unknown): obj is number;
+/**
+ * Type guard for boolean
+ */
+export declare function isBoolean(obj: unknown): obj is boolean;
+/**
+ * Type guard for object
+ */
+export declare function isObject(obj: unknown): obj is Record<string, unknown>;
+/**
+ * Type guard for array
+ */
+export declare function isArray(obj: unknown): obj is unknown[];
+/**
+ * Safe property access with type checking
+ */
+export declare function safeGetProperty<T>(obj: unknown, property: string, typeGuard: (value: unknown) => value is T): T | undefined;
+/**
+ * Safe nested property access
+ */
+export declare function safeGetNestedProperty<T>(obj: unknown, path: string[], typeGuard: (value: unknown) => value is T): T | undefined;
+//# sourceMappingURL=type-guards.d.ts.map

package/dist/types/utils/type-guards.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"type-guards.d.ts","sourceRoot":"","sources":["../../../src/utils/type-guards.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EACL,kBAAkB,EAClB,uBAAuB,EACvB,iBAAiB,EACjB,sBAAsB,EACtB,oBAAoB,EACpB,WAAW,EACZ,MAAM,iCAAiC,CAAC;AAEzC;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,kBAAkB,CAc5E;AAED;;GAEG;AACH,wBAAgB,yBAAyB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,uBAAuB,CAatF;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,iBAAiB,CAc1E;AAED;;GAEG;AACH,wBAAgB,wBAAwB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,sBAAsB,CAQpF;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,oBAAoB,CAYhF;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,WAAW,CAI9D;AAED;;GAEG;AACH,wBAAgB,aAAa,CAC3B,GAAG,EAAE,OAAO,GACX,GAAG,IAAI;IAAE,KAAK,EAAE;QAAE,aAAa,EAAE,MAAM,CAAC;QAAC,YAAY,EAAE,MAAM,CAAA;KAAE,CAAA;CAAE,CAUnE;AAED;;GAEG;AAEH,wBAAgB,UAAU,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,GAAG,CAEnD;AAED;;GAEG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,MAAM,CAEpD;AAED;;GAEG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,MAAM,CAEpD;AAED;;GAEG;AACH,wBAAgB,SAAS,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,OAAO,CAEtD;AAED;;GAEG;AACH,wBAAgB,QAAQ,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAErE;AAED;;GAEG;AACH,wBAAgB,OAAO,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,OAAO,EAAE,CAEtD;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,CAAC,EAC/B,GAAG,EAAE,OAAO,EACZ,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,GACxC,CAAC,GAAG,SAAS,CAKf;AAED;;GAEG;AACH,wBAAgB,qBAAqB,CAAC,CAAC,EACrC,GAAG,EAAE,OAAO,EACZ,IAAI,EAAE,MAAM,EAAE,EACd,SAAS,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,KAAK,IAAI,CAAC,GACxC,CAAC,GAAG,SAAS,CASf"}

package/dist/types/utils/url-builder.d.ts

@@ -0,0 +1,25 @@
+/**
+ * URL Builder Utilities
+ *
+ * Centralized URL construction logic to eliminate nested conditionals.
+ * Replaces the complex URL building logic from tracking.ts.
+ */
+/**
+ * Build Revenium API URL with proper path handling
+ *
+ * This function expects the base URL to NOT include the /v2 suffix for consistency
+ * with other Revenium middleware. It automatically appends the correct path.
+ *
+ * @param baseUrl - The base URL from configuration (e.g., 'https://api.revenium.io/meter')
+ * @param endpoint - The API endpoint to append (e.g., '/ai/completions')
+ * @returns Complete URL for the API call
+ */
+export declare function buildReveniumUrl(baseUrl: string, endpoint: string): string;
+/**
+ * Validate URL format
+ *
+ * @param url - URL to validate
+ * @returns true if valid, false otherwise
+ */
+export declare function isValidUrl(url: string): boolean;
+//# sourceMappingURL=url-builder.d.ts.map

package/dist/types/utils/url-builder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"url-builder.d.ts","sourceRoot":"","sources":["../../../src/utils/url-builder.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH;;;;;;;;;GASG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,MAAM,CAO1E;AAED;;;;;GAKG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAO/C"}

package/package.json

@@ -0,0 +1,84 @@
+{
+  "name": "@revenium/openai",
+  "version": "1.0.8",
+  "description": "Transparent TypeScript middleware for automatic Revenium usage tracking with OpenAI",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/types/index.d.ts",
+        "default": "./dist/esm/index.js"
+      },
+      "require": {
+        "types": "./dist/types/index.d.ts",
+        "default": "./dist/cjs/index.js"
+      }
+    }
+  },
+  "scripts": {
+    "build": "npm run build:cjs && npm run build:esm && npm run build:types",
+    "build:cjs": "tsc -p tsconfig.json",
+    "build:esm": "tsc -p tsconfig.esm.json",
+    "build:types": "tsc -p tsconfig.types.json",
+    "dev": "tsc --watch",
+    "clean": "node -e \"const fs = require('fs'); if (fs.existsSync('dist')) fs.rmSync('dist', {recursive: true, force: true})\"",
+    "prepublishOnly": "npm run clean && npm run build",
+    "lint": "eslint src/**/*.ts",
+    "lint:fix": "eslint src/**/*.ts --fix",
+    "format": "prettier --write src/**/*.ts",
+    "format:check": "prettier --check src/**/*.ts",
+    "example:openai-basic": "npm run build && npx ts-node examples/openai-basic.ts",
+    "example:openai-streaming": "npm run build && npx ts-node examples/openai-streaming.ts",
+    "example:azure-basic": "npm run build && npx ts-node examples/azure-basic.ts",
+    "example:azure-streaming": "npm run build && npx ts-node examples/azure-streaming.ts",
+    "example": "npm run example:openai-basic",
+    "example:openai-responses-basic": "npm run build && npx ts-node examples/openai-responses-basic.ts",
+    "example:openai-responses-streaming": "npm run build && npx ts-node examples/openai-responses-streaming.ts",
+    "example:azure-responses-basic": "npm run build && npx ts-node examples/azure-responses-basic.ts",
+    "example:azure-responses-streaming": "npm run build && npx ts-node examples/azure-responses-streaming.ts"
+  },
+  "keywords": [
+    "openai",
+    "revenium",
+    "middleware",
+    "typescript",
+    "nodejs",
+    "usage-tracking",
+    "metering",
+    "ai"
+  ],
+  "author": "Revenium",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/revenium/revenium-middleware-openai-node.git"
+  },
+  "homepage": "https://github.com/revenium/revenium-middleware-openai-node#readme",
+  "bugs": {
+    "url": "https://github.com/revenium/revenium-middleware-openai-node/issues"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "@typescript-eslint/eslint-plugin": "^6.21.0",
+    "@typescript-eslint/parser": "^6.21.0",
+    "dotenv": "^16.5.0",
+    "eslint": "^8.0.0",
+    "prettier": "^3.0.0",
+    "rimraf": "^6.0.1",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.0.0"
+  },
+  "peerDependencies": {
+    "openai": "^5.0.0"
+  },
+  "files": [
+    "dist/**/*",
+    "README.md",
+    "LICENSE"
+  ],
+  "engines": {
+    "node": ">=16.0.0"
+  }
+}