@openmeter/sdk 1.0.0-beta.6 → 1.0.0-beta.62

package/dist/{test → types/test}/mocks.d.ts

@@ -1,4 +1,6 @@
-import { Meter } from '../index.js';
+import { Subject } from '../clients/subject.js';
+import { Event, Meter } from '../index.js';
+export declare const mockEvent: Event;
 export declare const mockMeter: Meter;
 export declare const mockMeterValue: {
     subject: string;
@@ -9,3 +11,4 @@ export declare const mockMeterValue: {
         method: string;
     };
 };
+export declare const mockSubject: Subject;

package/index.ts

@@ -1,22 +1,23 @@
 import { OpenMeterConfig } from './clients/client.js'
 import { EventsClient } from './clients/event.js'
 import { MetersClient } from './clients/meter.js'
+import { PortalClient } from './clients/portal.js'
+import { SubjectClient } from './clients/subject.js'
 
 export { OpenMeterConfig, RequestOptions } from './clients/client.js'
-export { Event } from './clients/event.js'
-export {
-  Meter,
-  MeterValue,
-  MeterAggregation,
-  WindowSize,
-} from './clients/meter.js'
+export { Event, IngestedEvent } from './clients/event.js'
+export { Meter, MeterAggregation, WindowSize } from './clients/meter.js'
 
 export class OpenMeter {
   public events: EventsClient
   public meters: MetersClient
+  public portal: PortalClient
+  public subjects: SubjectClient
 
   constructor(config: OpenMeterConfig) {
     this.events = new EventsClient(config)
     this.meters = new MetersClient(config)
+    this.portal = new PortalClient(config)
+    this.subjects = new SubjectClient(config)
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmeter/sdk",
-  "version": "1.0.0-beta.6",
+  "version": "1.0.0-beta.62",
   "description": "Client for OpenMeter: Real-Time and Scalable Usage Metering",
   "license": "Apache 2.0",
   "homepage": "https://openmeter.io",
@@ -9,46 +9,50 @@
     "url": "https://github.com/openmeterio/openmeter.git",
     "directory": "api/client/node"
   },
-  "main": "./dist/index.js",
-  "types": "./dist/index.d.ts",
+  "main": "./dist/esm/index.js",
+  "types": "./dist/types/index.d.ts",
+  "exports": {
+    "import": "./dist/esm/index.js",
+    "require": "./dist/cjs/index.js",
+    "default": "./dist/esm/index.js"
+  },
   "type": "module",
   "engines": {
     "node": ">=18.16.1"
   },
-  "scripts": {
-    "lint": "eslint . --ext .ts --format=pretty",
-    "format": "prettier --write .",
-    "build": "rimraf ./dist && tsc --build",
-    "generate": "rimraf ./schemas && openapi-typescript \"../../openapi.yaml\" --output schemas/",
-    "pretest": "npm run build",
-    "test": "vitest --run --threads=false",
-    "test:watch": "vitest --watch --threads=false",
-    "prepublishOnly": "npm run generate && npm run build && npm run test && npm run lint"
-  },
   "devDependencies": {
-    "@types/node": "^20.5.0",
-    "@types/node-fetch": "^2.6.4",
-    "@typescript-eslint/eslint-plugin": "^6.4.0",
-    "@typescript-eslint/parser": "^6.4.0",
-    "eslint": "^8.47.0",
-    "eslint-config-prettier": "^9.0.0",
-    "eslint-formatter-pretty": "^5.0.0",
-    "eslint-import-resolver-typescript": "^3.6.0",
-    "eslint-plugin-compat": "^4.1.4",
-    "eslint-plugin-import": "^2.28.0",
-    "eslint-plugin-require-extensions": "^0.1.3",
-    "eslint-plugin-unused-imports": "^3.0.0",
-    "eslint-plugin-vitest": "^0.2.8",
-    "openapi-typescript": "^6.5.0",
-    "prettier": "^3.0.1",
-    "rimraf": "^5.0.1",
-    "typescript": "^5.1.6",
-    "vitest": "^0.34.1"
+    "@types/node": "^20.12.7",
+    "@types/node-fetch": "2.6.11",
+    "@typescript-eslint/eslint-plugin": "7.7.0",
+    "@typescript-eslint/parser": "7.7.0",
+    "eslint": "8.57.0",
+    "eslint-config-prettier": "9.1.0",
+    "eslint-formatter-pretty": "5.0.0",
+    "eslint-import-resolver-typescript": "3.6.1",
+    "eslint-plugin-compat": "4.2.0",
+    "eslint-plugin-import": "2.29.1",
+    "eslint-plugin-require-extensions": "0.1.3",
+    "eslint-plugin-unused-imports": "3.1.0",
+    "eslint-plugin-vitest": "0.4.1",
+    "openapi-typescript": "6.7.5",
+    "prettier": "3.2.5",
+    "rimraf": "5.0.5",
+    "typescript": "5.4.5",
+    "vitest": "1.5.0"
   },
   "browserslist": [
     "current node"
   ],
   "dependencies": {
-    "undici": "^5.23.0"
+    "undici": "^6.13.0"
+  },
+  "scripts": {
+    "lint": "eslint . --ext .ts --format=pretty",
+    "format": "prettier --write .",
+    "build": "rimraf ./dist && tsc --project tsconfig.cjs.json && tsc --project tsconfig.esm.json",
+    "generate": "rimraf ./schemas && openapi-typescript '../../openapi.yaml' --output schemas/openapi.ts && prettier --write schemas/",
+    "pretest": "pnpm run build",
+    "test": "vitest --run",
+    "test:watch": "vitest --watch"
   }
-}
+}

package/tsconfig.base.json

@@ -0,0 +1,24 @@
+{
+  "compilerOptions": {
+    "moduleResolution": "node",
+    "declaration": true,
+    "allowJs": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "forceConsistentCasingInFileNames": true,
+    "esModuleInterop": true,
+    "incremental": true,
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    "allowSyntheticDefaultImports": true,
+    "sourceMap": true
+  },
+  "include": ["**/*.ts"],
+  "exclude": [
+    "**/*.spec.ts",
+    "**/*.test.ts",
+    "scripts/**/*.ts",
+    "dist/**/*.ts",
+    "*.config.ts"
+  ]
+}

package/tsconfig.cjs.json

@@ -0,0 +1,8 @@
+{
+  "extends": "./tsconfig.base.json",
+  "compilerOptions": {
+    "module": "CommonJS",
+    "outDir": "dist/cjs",
+    "declarationDir": "dist/types"
+  }
+}

package/tsconfig.esm.json

@@ -0,0 +1,8 @@
+{
+  "extends": "./tsconfig.base.json",
+  "compilerOptions": {
+    "module": "ES2020",
+    "outDir": "dist/esm",
+    "declarationDir": "dist/types"
+  }
+}

package/dist/clients/client.js

@@ -1,104 +0,0 @@
-import { request } from 'undici';
-export class BaseClient {
-    config;
-    constructor(config) {
-        this.config = config;
-    }
-    async request({ path, method, searchParams, headers, body, options, }) {
-        // Building URL
-        const url = this.getUrl(path, searchParams);
-        // Request options
-        const reqHeaders = {
-            Accept: 'application/json',
-            ...headers,
-            ...this.getAuthHeaders(),
-            ...this.config.headers,
-            ...options?.headers,
-        };
-        const reqOpts = {
-            method,
-            headers: reqHeaders,
-        };
-        // Optional body
-        if (body) {
-            if (!reqHeaders['Content-Type'] && !reqHeaders['content-type']) {
-                throw new Error('Content Type is required with body');
-            }
-            reqOpts.body = body;
-        }
-        const resp = await request(url, reqOpts);
-        // Error handling
-        if (resp.statusCode > 399) {
-            if (resp.headers['content-type'] === 'application/problem+json') {
-                const problem = (await resp.body.json());
-                throw new HttpError({
-                    statusCode: resp.statusCode,
-                    problem,
-                });
-            }
-            // Requests can fail before API, in this case we only have a status code
-            throw new HttpError({
-                statusCode: resp.statusCode,
-            });
-        }
-        // Response parsing
-        if (resp.statusCode === 204 || resp.headers['content-length'] === '0') {
-            return undefined;
-        }
-        if (resp.headers['content-type'] === 'application/json') {
-            return (await resp.body.json());
-        }
-        if (!resp.headers['content-type']) {
-            throw new Error('Missing content type');
-        }
-        throw new Error(`Unknown content type: ${resp.headers['content-type']}`);
-    }
-    getUrl(path, searchParams) {
-        let qs = searchParams ? searchParams.toString() : '';
-        qs = qs.length > 0 ? `?${qs}` : '';
-        const url = new URL(`${path}${qs}`, this.config.baseUrl);
-        return url;
-    }
-    getAuthHeaders() {
-        if (this.config.token) {
-            return {
-                authorization: `Bearer ${this.config.token}`,
-            };
-        }
-        if (this.config.username && this.config.password) {
-            const encoded = Buffer.from(`${this.config.username}:${this.config.password}`).toString('base64');
-            return {
-                authorization: `Basic ${encoded}`,
-            };
-        }
-        return {};
-    }
-    static toURLSearchParams(params) {
-        const searchParams = new URLSearchParams();
-        for (const [key, value] of Object.entries(params)) {
-            if (value === undefined) {
-                continue;
-            }
-            if (Array.isArray(value)) {
-                searchParams.append(key, value.join(','));
-            }
-            else if (value instanceof Date) {
-                searchParams.append(key, value.toISOString());
-            }
-            else {
-                searchParams.append(key, value.toString());
-            }
-        }
-        return searchParams;
-    }
-}
-export class HttpError extends Error {
-    statusCode;
-    problem;
-    constructor({ statusCode, problem, }) {
-        super(problem?.type || 'unexpected status code');
-        this.name = 'HttpError';
-        this.statusCode = statusCode;
-        this.problem = problem;
-    }
-}

package/dist/clients/event.js

@@ -1,39 +0,0 @@
-import crypto from 'crypto';
-import { BaseClient } from './client.js';
-export class EventsClient extends BaseClient {
-    constructor(config) {
-        super(config);
-    }
-    /**
-     * Ingest usage event in a CloudEvents format
-     * @see https://cloudevents.io
-     */
-    async ingest(usageEvent, options) {
-        if (usageEvent.datacontenttype &&
-            usageEvent.datacontenttype !== 'application/json') {
-            throw new TypeError(`Unsupported datacontenttype: ${usageEvent.datacontenttype}`);
-        }
-        // We default where we can to lower the barrier to use CloudEvents
-        const body = {
-            specversion: usageEvent.specversion ?? '1.0',
-            id: usageEvent.id ?? crypto.randomUUID(),
-            source: usageEvent.source ?? '@openmeter/sdk',
-            type: usageEvent.type,
-            subject: usageEvent.subject,
-            time: usageEvent.time?.toISOString(),
-            datacontenttype: usageEvent.datacontenttype,
-            dataschema: usageEvent.dataschema,
-            data: usageEvent.data,
-        };
-        // Making Request
-        return await this.request({
-            path: '/api/v1/events',
-            method: 'POST',
-            body: JSON.stringify(body),
-            headers: {
-                'Content-Type': 'application/cloudevents+json',
-            },
-            options,
-        });
-    }
-}

package/dist/clients/meter.js

@@ -1,79 +0,0 @@
-import { BaseClient } from './client.js';
-export var WindowSize;
-(function (WindowSize) {
-    WindowSize["MINUTE"] = "MINUTE";
-    WindowSize["HOUR"] = "HOUR";
-    WindowSize["DAY"] = "DAY";
-})(WindowSize || (WindowSize = {}));
-export var MeterAggregation;
-(function (MeterAggregation) {
-    MeterAggregation["SUM"] = "SUM";
-    MeterAggregation["COUNT"] = "COUNT";
-    MeterAggregation["AVG"] = "AVG";
-    MeterAggregation["MIN"] = "MIN";
-    MeterAggregation["MAX"] = "MAX";
-})(MeterAggregation || (MeterAggregation = {}));
-export class MetersClient extends BaseClient {
-    constructor(config) {
-        super(config);
-    }
-    /**
-     * Get one meter by slug
-     */
-    async get(slug, options) {
-        return this.request({
-            method: 'GET',
-            path: `/api/v1/meters/${slug}`,
-            options,
-        });
-    }
-    /**
-     * List meters
-     */
-    async list(options) {
-        return this.request({
-            method: 'GET',
-            path: `/api/v1/meters`,
-            options,
-        });
-    }
-    /**
-     * Get aggregated values of a meter
-     * @deprecated Use `meters.query` instead
-     */
-    async values(slug, params, options) {
-        const searchParams = params
-            ? BaseClient.toURLSearchParams(params)
-            : undefined;
-        return this.request({
-            method: 'GET',
-            path: `/api/v1/meters/${slug}/values`,
-            searchParams,
-            options,
-        });
-    }
-    /**
-     * Query a meter
-     */
-    async query(slug, params, options) {
-        const searchParams = params
-            ? BaseClient.toURLSearchParams(params)
-            : undefined;
-        return this.request({
-            method: 'GET',
-            path: `/api/v1/meters/${slug}/query`,
-            searchParams,
-            options,
-        });
-    }
-    /**
-     * List subjects of a meter
-     */
-    async subjects(slug, options) {
-        return this.request({
-            method: 'GET',
-            path: `/api/v1/meters/${slug}/subjects`,
-            options,
-        });
-    }
-}

package/dist/index.js

@@ -1,11 +0,0 @@
-import { EventsClient } from './clients/event.js';
-import { MetersClient } from './clients/meter.js';
-export { MeterAggregation, WindowSize, } from './clients/meter.js';
-export class OpenMeter {
-    events;
-    meters;
-    constructor(config) {
-        this.events = new EventsClient(config);
-        this.meters = new MetersClient(config);
-    }
-}