@openmeter/sdk 1.0.0-beta.13 → 1.0.0-beta.130

package/README.md

@@ -54,6 +54,12 @@ const event: Event = {
 await openmeter.events.ingest(event)
 ```
 
+### batch ingest
+
+```ts
+await openmeter.events.ingest([event1, event2, event3])
+```
+
 #### list
 
 Retrieve latest raw events. Useful for debugging.
@@ -96,7 +102,7 @@ const values = await openmeter.meters.query('my-meter-slug', {
 })
 ```
 
-#### subjects
+#### meter subjects
 
 List meter subjects.
 
@@ -104,57 +110,229 @@ List meter subjects.
 const subjects = await openmeter.meters.subjects('my-meter-slug')
 ```
 
-## Helpers
+### Portal
+
+#### createToken
+
+Create subject-specific tokens.
+Useful to build consumer dashboards.
+
+```ts
+const token = await openmeter.portal.createToken({ subject: 'customer-1' })
+```
+
+#### invalidateTokens
+
+Invalidate portal tokens for all or specific subjects.
+
+```ts
+await openmeter.portal.invalidateTokens()
+```
+
+### Subject
 
-### Vercel AI SDK / Next.js
+Subject mappings. Like display name and metadata.
+
+#### upsert
+
+Upsert subjects.
+
+```ts
+const subjects = await openmeter.subjects.upsert([
+  {
+    key: 'customer-1',
+    displayName: 'ACME',
+  },
+])
+```
+
+#### list
+
+List subjects.
+
+```ts
+const subjects = await openmeter.subjects.list()
+```
+
+#### get
 
-The OpenAI streaming API used by the Vercel AI SDK doesn't return token usage metadata by default.
-The OpenMeter `createOpenAIStreamCallback` helper function decorates the callback with a `onUsage`
-callback which you can use to report usage to OpenMeter.
+Get subject by key.
 
 ```ts
-import OpenAI from 'openai'
-import { OpenAIStream, StreamingTextResponse } from 'ai'
-import { createOpenAIStreamCallback } from '@openmeter/sdk'
+const subjects = await openmeter.subjects.get('customer-1')
+```
+
+#### delete
+
+Delete subject by key.
+It doesn't delete corresponding usage.
+
+```ts
+await openmeter.subjects.delete('customer-1')
+```
+
+#### createEntitlement
+
+Create entitlement for a subject.
+Entitlements allow you to manage subject feature access, balances, and usage limits.
+
+```ts
+// Issue 10,000,000 tokens every month
+const entitlement = await openmeter.subjects.createEntitlement('customer-1', {
+  type: 'metered',
+  featureKey: 'ai_tokens',
+  usagePeriod: {
+    interval: 'MONTH',
+  },
+  issueAfterReset: 10000000,
+})
+```
+
+#### listEntitlements
+
+List subject entitlements.
+
+```ts
+const entitlement = await openmeter.subjects.listEntitlements('customer-1')
+```
+
+#### getEntitlement
+
+Get a subject entitlement by ID by Feature ID or by Feature Key.
+
+```ts
+const entitlement = await openmeter.subjects.getEntitlement(
+  'customer-1',
+  'ai_tokens'
+)
+```
+
+#### deleteEntitlement
+
+Delete a subject entitlement by ID by Feature ID or by Feature Key.
+
+```ts
+await openmeter.subjects.deleteEntitlement('customer-1', 'ai_tokens')
+```
 
-export async function POST(req: Request) {
-  const { messages } = await req.json()
-  const model = 'gpt-3.5-turbo'
+#### getEntitlementValue
 
-  const response = await openai.chat.completions.create({
-    model,
-    messages,
-    stream: true,
-  })
+Get entitlement value by ID by Feature ID or by Feature Key.
 
-  const streamCallbacks = await createOpenAIStreamCallback(
-    {
-      model,
-      prompts: messages.map(({ content }) => content),
+```ts
+const value = await openmeter.subjects.getEntitlementValue(
+  'customer-1',
+  'ai_tokens'
+)
+```
+
+#### getEntitlementHistory
+
+Get entitlement history by ID by Feature ID or by Feature Key
+
+```ts
+const entitlement = await openmeter.subjects.getEntitlementHistory(
+  'customer-1',
+  'ai_tokens'
+)
+```
+
+#### resetEntitlementUsage
+
+Reset the entitlement usage and start a new period. Eligible grants will be rolled over.
+
+```ts
+const entitlement = await openmeter.subjects.resetEntitlementUsage(
+  'customer-1',
+  {
+    retainAnchor: true,
+  }
+)
+```
+
+#### createEntitlementGrant
+
+Create a grant for an entitlement.
+
+```ts
+const grant = await openmeter.subjects.createEntitlementGrant(
+  'customer-1',
+  'ai_tokens',
+  {
+    amount: 100,
+    priority: 1,
+    effectiveAt: '2023-01-01T00:00:00Z',
+    expiration: {
+      duration: 'HOUR',
+      count: 12,
     },
-    {
-      // onToken() => {...}
-      // onFinal() => {...}
-      async onUsage(usage) {
-        try {
-          await openmeter.events.ingest({
-            source: 'my-app',
-            type: 'my-event-type',
-            subject: 'my-customer-id',
-            data: {
-              // Usage is { total_tokens, prompt_tokens, completion_tokens }
-              ...usage,
-              model,
-            },
-          })
-        } catch (err) {
-          console.error('failed to ingest usage', err)
-        }
-      },
-    }
-  )
-
-  const stream = OpenAIStream(response, streamCallbacks)
-  return new StreamingTextResponse(stream)
-}
+    minRolloverAmount: 100,
+    maxRolloverAmount: 100,
+    recurrence: {
+      interval: 'MONTH',
+      anchor: '2024-06-28T18:29:44.867Z',
+    },
+  }
+)
+```
+
+#### listEntitlementGrants
+
+List entitlement grants
+
+```ts
+const entitlement = await openmeter.subjects.listEntitlementGrants('customer-1', 'ai_tokens)
+```
+
+## Features
+
+Features are the building blocks of your entitlements, part of your product offering.
+
+#### create
+
+Upsert subjects.
+
+```ts
+const feature = await openmeter.features.create({
+  key: 'ai_tokens',
+  name: 'AI Tokens',
+  // optional
+  meterSlug: 'tokens_total',
+})
+```
+
+#### list
+
+List features.
+
+```ts
+const features = await openmeter.features.list()
+```
+
+#### get
+
+Get feature by key.
+
+```ts
+const feature = await openmeter.features.get('ai_tokens')
+```
+
+#### delete
+
+Delete feature by key.
+
+```ts
+await openmeter.features.delete('ai_tokens')
+```
+
+## Grants
+
+Entitlement grants allow to issue of additional one-time or recurring allowances on a subject's entitlement.
+
+#### list
+
+List grants.
+
+```ts
+const grants = await openmeter.grants.list()
 ```

package/dist/cjs/clients/client.cjs

@@ -0,0 +1,120 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpError = exports.BaseClient = void 0;
+const undici_1 = require("undici");
+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 (0, undici_1.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)) {
+                for (const item of value) {
+                    searchParams.append(key, item);
+                }
+            }
+            else if (typeof value === 'boolean') {
+                searchParams.append(key, value.toString());
+            }
+            else if (value instanceof Date) {
+                searchParams.append(key, value.toISOString());
+            }
+            else if (typeof value === 'object') {
+                Object.entries(value).forEach(([k, v]) => {
+                    searchParams.append(`${key}[${k}]`, v);
+                });
+            }
+            else {
+                searchParams.append(key, value.toString());
+            }
+        }
+        return searchParams;
+    }
+}
+exports.BaseClient = BaseClient;
+class HttpError extends Error {
+    statusCode;
+    problem;
+    constructor({ statusCode, problem, }) {
+        super(problem?.type || 'unexpected status code');
+        this.name = 'HttpError';
+        this.statusCode = statusCode;
+        this.problem = problem;
+    }
+}
+exports.HttpError = HttpError;
+//# sourceMappingURL=client.js.map

package/dist/cjs/clients/client.d.cts

@@ -0,0 +1,37 @@
+import { IncomingHttpHeaders } from 'http';
+import { Dispatcher } from 'undici';
+import { components } from '../schemas/openapi.cjs';
+export type OpenMeterConfig = {
+    baseUrl: string;
+    token?: string;
+    username?: string;
+    password?: string;
+    headers?: IncomingHttpHeaders;
+};
+export type RequestOptions = {
+    headers?: IncomingHttpHeaders;
+};
+export type Problem = components['schemas']['Problem'];
+export declare class BaseClient {
+    protected config: OpenMeterConfig;
+    constructor(config: OpenMeterConfig);
+    protected request<T>({ path, method, searchParams, headers, body, options, }: {
+        path: string;
+        method: Dispatcher.HttpMethod;
+        searchParams?: URLSearchParams;
+        headers?: IncomingHttpHeaders;
+        body?: string | Buffer | Uint8Array;
+        options?: RequestOptions;
+    }): Promise<T>;
+    protected getUrl(path: string, searchParams?: URLSearchParams): import("url").URL;
+    protected getAuthHeaders(): IncomingHttpHeaders;
+    protected static toURLSearchParams(params: Record<string, string | boolean | number | Date | string[] | Record<string, string> | undefined>): URLSearchParams;
+}
+export declare class HttpError extends Error {
+    statusCode: number;
+    problem?: Problem;
+    constructor({ statusCode, problem, }: {
+        statusCode: number;
+        problem?: Problem;
+    });
+}

package/dist/cjs/clients/client.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../clients/client.ts"],"names":[],"mappings":";;;AACA,mCAA4C;AAuB5C,MAAa,UAAU;IACX,MAAM,CAAiB;IAEjC,YAAY,MAAuB;QACjC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAES,KAAK,CAAC,OAAO,CAAI,EACzB,IAAI,EACJ,MAAM,EACN,YAAY,EACZ,OAAO,EACP,IAAI,EACJ,OAAO,GAQR;QACC,eAAe;QACf,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,CAAC,IAAI,EAAE,YAAY,CAAC,CAAA;QAE3C,kBAAkB;QAClB,MAAM,UAAU,GAAwB;YACtC,MAAM,EAAE,kBAAkB;YAC1B,GAAG,OAAO;YACV,GAAG,IAAI,CAAC,cAAc,EAAE;YACxB,GAAG,IAAI,CAAC,MAAM,CAAC,OAAO;YACtB,GAAG,OAAO,EAAE,OAAO;SACpB,CAAA;QACD,MAAM,OAAO,GAAyB;YACpC,MAAM;YACN,OAAO,EAAE,UAAU;SACpB,CAAA;QAED,gBAAgB;QAChB,IAAI,IAAI,EAAE,CAAC;YACT,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,cAAc,CAAC,EAAE,CAAC;gBAC/D,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAA;YACvD,CAAC;YAED,OAAO,CAAC,IAAI,GAAG,IAAI,CAAA;QACrB,CAAC;QAED,MAAM,IAAI,GAAG,MAAM,IAAA,gBAAO,EAAC,GAAG,EAAE,OAAO,CAAC,CAAA;QAExC,iBAAiB;QACjB,IAAI,IAAI,CAAC,UAAU,GAAG,GAAG,EAAE,CAAC;YAC1B,IAAI,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,KAAK,0BAA0B,EAAE,CAAC;gBAChE,MAAM,OAAO,GAAG,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAY,CAAA;gBACnD,MAAM,IAAI,SAAS,CAAC;oBAClB,UAAU,EAAE,IAAI,CAAC,UAAU;oBAC3B,OAAO;iBACR,CAAC,CAAA;YACJ,CAAC;YAED,wEAAwE;YACxE,MAAM,IAAI,SAAS,CAAC;gBAClB,UAAU,EAAE,IAAI,CAAC,UAAU;aAC5B,CAAC,CAAA;QACJ,CAAC;QAED,mBAAmB;QACnB,IAAI,IAAI,CAAC,UAAU,KAAK,GAAG,IAAI,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,KAAK,GAAG,EAAE,CAAC;YACtE,OAAO,SAAyB,CAAA;QAClC,CAAC;QACD,IAAI,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,KAAK,kBAAkB,EAAE,CAAC;YACxD,OAAO,CAAC,MAAM,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAM,CAAA;QACtC,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC;YAClC,MAAM,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAA;QACzC,CAAC;QAED,MAAM,IAAI,KAAK,CAAC,yBAAyB,IAAI,CAAC,OAAO,CAAC,cAAc,CAAC,EAAE,CAAC,CAAA;IAC1E,CAAC;IAES,MAAM,CAAC,IAAY,EAAE,YAA8B;QAC3D,IAAI,EAAE,GAAG,YAAY,CAAC,CAAC,CAAC,YAAY,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAA;QACpD,EAAE,GAAG,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAA;QAClC,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,GAAG,IAAI,GAAG,EAAE,EAAE,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;QACxD,OAAO,GAAG,CAAA;IACZ,CAAC;IAES,cAAc;QACtB,IAAI,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE,CAAC;YACtB,OAAO;gBACL,aAAa,EAAE,UAAU,IAAI,CAAC,MAAM,CAAC,KAAK,EAAE;aAC7C,CAAA;QACH,CAAC;QAED,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAAC;YACjD,MAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CACzB,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,IAAI,IAAI,CAAC,MAAM,CAAC,QAAQ,EAAE,CAClD,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAA;YACpB,OAAO;gBACL,aAAa,EAAE,SAAS,OAAO,EAAE;aAClC,CAAA;QACH,CAAC;QAED,OAAO,EAAE,CAAA;IACX,CAAC;IAES,MAAM,CAAC,iBAAiB,CAChC,MASC;QAED,MAAM,YAAY,GAAG,IAAI,eAAe,EAAE,CAAA;QAE1C,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;YAClD,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;gBACxB,SAAQ;YACV,CAAC;YAED,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBACzB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;oBACzB,YAAY,CAAC,MAAM,CAAC,GAAG,EAAE,IAAI,CAAC,CAAA;gBAChC,CAAC;YACH,CAAC;iBAAM,IAAI,OAAO,KAAK,KAAK,SAAS,EAAE,CAAC;gBACtC,YAAY,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAA;YAC5C,CAAC;iBAAM,IAAI,KAAK,YAAY,IAAI,EAAE,CAAC;gBACjC,YAAY,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,WAAW,EAAE,CAAC,CAAA;YAC/C,CAAC;iBAAM,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;gBACrC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE;oBACvC,YAAY,CAAC,MAAM,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,CAAA;gBACxC,CAAC,CAAC,CAAA;YACJ,CAAC;iBAAM,CAAC;gBACN,YAAY,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAA;YAC5C,CAAC;QACH,CAAC;QAED,OAAO,YAAY,CAAA;IACrB,CAAC;CACF;AA/ID,gCA+IC;AAED,MAAa,SAAU,SAAQ,KAAK;IAC3B,UAAU,CAAQ;IAClB,OAAO,CAAU;IAExB,YAAY,EACV,UAAU,EACV,OAAO,GAIR;QACC,KAAK,CAAC,OAAO,EAAE,IAAI,IAAI,wBAAwB,CAAC,CAAA;QAChD,IAAI,CAAC,IAAI,GAAG,WAAW,CAAA;QACvB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;QAC5B,IAAI,CAAC,OAAO,GAAG,OAAO,CAAA;IACxB,CAAC;CACF;AAhBD,8BAgBC"}

package/dist/cjs/clients/entitlement.cjs

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EntitlementClient = void 0;
+const client_js_1 = require("./client.cjs");
+class EntitlementClient extends client_js_1.BaseClient {
+    constructor(config) {
+        super(config);
+    }
+    /**
+     * List all entitlements regardless of subject.
+     * @example
+     * const entitlement = await openmeter.entitlements.list()
+     */
+    async list(params, options) {
+        const searchParams = params
+            ? client_js_1.BaseClient.toURLSearchParams(params)
+            : undefined;
+        return await this.request({
+            path: '/api/v1/entitlements',
+            method: 'GET',
+            searchParams,
+            options,
+        });
+    }
+}
+exports.EntitlementClient = EntitlementClient;
+//# sourceMappingURL=entitlement.js.map

package/dist/cjs/clients/entitlement.d.cts

@@ -0,0 +1,26 @@
+import { components, operations } from '../schemas/openapi.cjs';
+import { RequestOptions, BaseClient, OpenMeterConfig } from './client.cjs';
+import { Paginated } from './pagination.cjs';
+export type Entitlement = EntitlementMetered | EntitlementStatic | EntitlementBoolean;
+export type EntitlementMetered = components['schemas']['EntitlementMetered'];
+export type EntitlementStatic = components['schemas']['EntitlementStatic'];
+export type EntitlementBoolean = components['schemas']['EntitlementBoolean'];
+export type RecurringPeriodEnum = components['schemas']['RecurringPeriodEnum'];
+export type EntitlementValue = components['schemas']['EntitlementValue'];
+export type WindowedBalanceHistory = components['schemas']['WindowedBalanceHistory'];
+export type EntitlementCreateInputs = EntitlementMeteredCreateInputs | EntitlementStaticCreateInputs | EntitlementBooleanCreateInputs;
+export type EntitlementMeteredCreateInputs = components['schemas']['EntitlementMeteredCreateInputs'];
+export type EntitlementStaticCreateInputs = components['schemas']['EntitlementStaticCreateInputs'];
+export type EntitlementBooleanCreateInputs = components['schemas']['EntitlementBooleanCreateInputs'];
+export type EntitlementResetInputs = operations['resetEntitlementUsage']['requestBody']['content']['application/json'];
+export type ListEntitlementQueryParams = operations['listEntitlements']['parameters']['query'];
+export type GetEntitlementHistoryQueryParams = operations['getEntitlementHistory']['parameters']['query'];
+export declare class EntitlementClient extends BaseClient {
+    constructor(config: OpenMeterConfig);
+    /**
+     * List all entitlements regardless of subject.
+     * @example
+     * const entitlement = await openmeter.entitlements.list()
+     */
+    list(params?: ListEntitlementQueryParams, options?: RequestOptions): Promise<Entitlement[] | Paginated<Entitlement>>;
+}

package/dist/cjs/clients/entitlement.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entitlement.js","sourceRoot":"","sources":["../../../clients/entitlement.ts"],"names":[],"mappings":";;;AACA,2CAAyE;AA+BzE,MAAa,iBAAkB,SAAQ,sBAAU;IAC/C,YAAY,MAAuB;QACjC,KAAK,CAAC,MAAM,CAAC,CAAA;IACf,CAAC;IAED;;;;OAIG;IACI,KAAK,CAAC,IAAI,CACf,MAAmC,EACnC,OAAwB;QAExB,MAAM,YAAY,GAAG,MAAM;YACzB,CAAC,CAAC,sBAAU,CAAC,iBAAiB,CAAC,MAAM,CAAC;YACtC,CAAC,CAAC,SAAS,CAAA;QACb,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC;YACxB,IAAI,EAAE,sBAAsB;YAC5B,MAAM,EAAE,KAAK;YACb,YAAY;YACZ,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;CACF;AAxBD,8CAwBC"}

package/dist/cjs/clients/event.cjs

@@ -0,0 +1,71 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.EventsClient = void 0;
+const crypto_1 = __importDefault(require("crypto"));
+const client_js_1 = require("./client.cjs");
+class EventsClient extends client_js_1.BaseClient {
+    constructor(config) {
+        super(config);
+    }
+    /**
+     * Ingest usage event in a CloudEvents format
+     * @see https://cloudevents.io
+     */
+    async ingest(usageEvent, options) {
+        const isBatch = Array.isArray(usageEvent);
+        const cloudEvents = (isBatch ? usageEvent : [usageEvent]).map((ev) => {
+            // Validate content type
+            if (ev.datacontenttype && ev.datacontenttype !== 'application/json') {
+                throw new TypeError(`Unsupported datacontenttype: ${ev.datacontenttype}`);
+            }
+            // We default where we can to lower the barrier to use CloudEvents
+            const cloudEvent = {
+                specversion: ev.specversion ?? '1.0',
+                id: ev.id ?? crypto_1.default.randomUUID(),
+                source: ev.source ?? '@openmeter/sdk',
+                type: ev.type,
+                subject: ev.subject,
+                time: ev.time?.toISOString(),
+                datacontenttype: ev.datacontenttype,
+                dataschema: ev.dataschema,
+                data: ev.data,
+            };
+            return cloudEvent;
+        });
+        const contentType = isBatch
+            ? 'application/cloudevents-batch+json'
+            : 'application/cloudevents+json';
+        const body = isBatch
+            ? JSON.stringify(cloudEvents)
+            : JSON.stringify(cloudEvents[0]);
+        // Making Request
+        return await this.request({
+            path: '/api/v1/events',
+            method: 'POST',
+            body,
+            headers: {
+                'Content-Type': contentType,
+            },
+            options,
+        });
+    }
+    /**
+     * List raw events
+     */
+    async list(params, options) {
+        const searchParams = params
+            ? client_js_1.BaseClient.toURLSearchParams(params)
+            : undefined;
+        return this.request({
+            method: 'GET',
+            path: `/api/v1/events`,
+            searchParams,
+            options,
+        });
+    }
+}
+exports.EventsClient = EventsClient;
+//# sourceMappingURL=event.js.map

package/dist/cjs/clients/event.d.cts

@@ -0,0 +1,79 @@
+import { components } from '../schemas/openapi.cjs';
+import { RequestOptions, BaseClient, OpenMeterConfig } from './client.cjs';
+export type CloudEvent = components['schemas']['Event'];
+export type IngestedEvent = components['schemas']['IngestedEvent'];
+export type EventsQueryParams = {
+    /**
+     * @description Limit number of results. Max: 100
+     * @example 25
+     */
+    limit?: number;
+};
+/**
+ * Usage Event
+ */
+export type Event = {
+    /**
+     * @description The version of the CloudEvents specification which the event uses.
+     * @example 1.0
+     */
+    specversion?: string;
+    /**
+     * @description Unique identifier for the event, defaults to uuid v4.
+     * @example "5c10fade-1c9e-4d6c-8275-c52c36731d3c"
+     */
+    id?: string;
+    /**
+     * Format: uri-reference
+     * @description Identifies the context in which an event happened, defaults to: @openmeter/sdk
+     * @example services/service-0
+     */
+    source?: string;
+    /**
+     * @description Describes the type of event related to the originating occurrence.
+     * @example "api_request"
+     */
+    type: string;
+    /**
+     * @description Describes the subject of the event in the context of the event producer (identified by source).
+     * @example "customer_id"
+     */
+    subject: string;
+    /**
+     * Format: date-time
+     * @description Date of when the occurrence happened.
+     * @example new Date('2023-01-01T01:01:01.001Z')
+     */
+    time?: Date;
+    /**
+     * Format: uri
+     * @description Identifies the schema that data adheres to.
+     */
+    dataschema?: string;
+    /**
+     * @description Content type of the data value. Must adhere to RFC 2046 format.
+     * @example application/json
+     * @enum {string|null}
+     */
+    datacontenttype?: 'application/json';
+    /**
+     * @description The event payload.
+     * @example {
+     *   "duration_ms": "12",
+     *   "path": "/hello"
+     * }
+     */
+    data: Record<string, unknown>;
+};
+export declare class EventsClient extends BaseClient {
+    constructor(config: OpenMeterConfig);
+    /**
+     * Ingest usage event in a CloudEvents format
+     * @see https://cloudevents.io
+     */
+    ingest(usageEvent: Event | Event[], options?: RequestOptions): Promise<void>;
+    /**
+     * List raw events
+     */
+    list(params?: EventsQueryParams, options?: RequestOptions): Promise<IngestedEvent[]>;
+}

package/dist/cjs/clients/event.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"event.js","sourceRoot":"","sources":["../../../clients/event.ts"],"names":[],"mappings":";;;;;;AAAA,oDAA2B;AAE3B,2CAAyE;AAuEzE,MAAa,YAAa,SAAQ,sBAAU;IAC1C,YAAY,MAAuB;QACjC,KAAK,CAAC,MAAM,CAAC,CAAA;IACf,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,MAAM,CACjB,UAA2B,EAC3B,OAAwB;QAExB,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAA;QACzC,MAAM,WAAW,GAAiB,CAAC,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,GAAG,CACzE,CAAC,EAAE,EAAE,EAAE;YACL,wBAAwB;YACxB,IAAI,EAAE,CAAC,eAAe,IAAI,EAAE,CAAC,eAAe,KAAK,kBAAkB,EAAE,CAAC;gBACpE,MAAM,IAAI,SAAS,CACjB,gCAAgC,EAAE,CAAC,eAAe,EAAE,CACrD,CAAA;YACH,CAAC;YAED,kEAAkE;YAClE,MAAM,UAAU,GAAe;gBAC7B,WAAW,EAAE,EAAE,CAAC,WAAW,IAAI,KAAK;gBACpC,EAAE,EAAE,EAAE,CAAC,EAAE,IAAI,gBAAM,CAAC,UAAU,EAAE;gBAChC,MAAM,EAAE,EAAE,CAAC,MAAM,IAAI,gBAAgB;gBACrC,IAAI,EAAE,EAAE,CAAC,IAAI;gBACb,OAAO,EAAE,EAAE,CAAC,OAAO;gBACnB,IAAI,EAAE,EAAE,CAAC,IAAI,EAAE,WAAW,EAAE;gBAC5B,eAAe,EAAE,EAAE,CAAC,eAAe;gBACnC,UAAU,EAAE,EAAE,CAAC,UAAU;gBACzB,IAAI,EAAE,EAAE,CAAC,IAAI;aACd,CAAA;YAED,OAAO,UAAU,CAAA;QACnB,CAAC,CACF,CAAA;QAED,MAAM,WAAW,GAAG,OAAO;YACzB,CAAC,CAAC,oCAAoC;YACtC,CAAC,CAAC,8BAA8B,CAAA;QAClC,MAAM,IAAI,GAAG,OAAO;YAClB,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC;YAC7B,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAA;QAElC,iBAAiB;QACjB,OAAO,MAAM,IAAI,CAAC,OAAO,CAAC;YACxB,IAAI,EAAE,gBAAgB;YACtB,MAAM,EAAE,MAAM;YACd,IAAI;YACJ,OAAO,EAAE;gBACP,cAAc,EAAE,WAAW;aAC5B;YACD,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,IAAI,CACf,MAA0B,EAC1B,OAAwB;QAExB,MAAM,YAAY,GAAG,MAAM;YACzB,CAAC,CAAC,sBAAU,CAAC,iBAAiB,CAAC,MAAM,CAAC;YACtC,CAAC,CAAC,SAAS,CAAA;QACb,OAAO,IAAI,CAAC,OAAO,CAAkB;YACnC,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,gBAAgB;YACtB,YAAY;YACZ,OAAO;SACR,CAAC,CAAA;IACJ,CAAC;CACF;AA5ED,oCA4EC"}