@openmeter/sdk 1.0.0-beta.5 → 1.0.0-beta.51

package/README.md

@@ -3,7 +3,7 @@
 ## Install
 
 ```sh
-npm install --save @openmeter/sdk@beta
+npm install --save @openmeter/sdk
 ```
 
 ## Example
@@ -54,6 +54,20 @@ 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.
+
+```ts
+const events = await openmeter.events.list()
+```
+
 ### Meters
 
 #### list
@@ -72,17 +86,87 @@ Get one meter by slug.
 const meter = await openmeter.meters.get('m1')
 ```
 
-#### values
+#### query
 
-Get back meter values.
+Query meter values.
 
 ```ts
 import { WindowSize } from '@openmeter/sdk'
 
-const values = await openmeter.meters.values('my-meter-slug', {
-  subject: 'user-1',
+const values = await openmeter.meters.query('my-meter-slug', {
+  subject: ['user-1'],
+  groupBy: ['method', 'path'],
   from: new Date('2021-01-01'),
   to: new Date('2021-01-02'),
   windowSize: WindowSize.HOUR,
 })
 ```
+
+#### meter subjects
+
+List meter subjects.
+
+```ts
+const subjects = await openmeter.meters.subjects('my-meter-slug')
+```
+
+### 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
+
+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
+
+Get subject by key.
+
+```ts
+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')
+```

package/dist/clients/client.js

@@ -80,7 +80,9 @@ export class BaseClient {
                 continue;
             }
             if (Array.isArray(value)) {
-                searchParams.append(key, value.join(','));
+                for (const item of value) {
+                    searchParams.append(key, item);
+                }
             }
             else if (value instanceof Date) {
                 searchParams.append(key, value.toISOString());

package/dist/clients/event.d.ts

@@ -1,4 +1,14 @@
+import { components } from '../schemas/openapi.js';
 import { RequestOptions, BaseClient, OpenMeterConfig } from './client.js';
+export type CloudEvents = 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
  */
@@ -53,7 +63,7 @@ export type Event = {
      *   "path": "/hello"
      * }
      */
-    data: Record<string, string | number | Record<string, string | number>>;
+    data: Record<string, unknown>;
 };
 export declare class EventsClient extends BaseClient {
     constructor(config: OpenMeterConfig);
@@ -61,5 +71,9 @@ export declare class EventsClient extends BaseClient {
      * Ingest usage event in a CloudEvents format
      * @see https://cloudevents.io
      */
-    ingest(usageEvent: Event, options?: RequestOptions): Promise<void>;
+    ingest(usageEvent: Event | Event[], options?: RequestOptions): Promise<void>;
+    /**
+     * List raw events
+     */
+    list(params?: EventsQueryParams, options?: RequestOptions): Promise<IngestedEvent[]>;
 }

package/dist/clients/event.js

@@ -9,31 +9,52 @@ export class EventsClient extends BaseClient {
      * @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,
-        };
+        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.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: JSON.stringify(body),
+            body,
             headers: {
-                'Content-Type': 'application/cloudevents+json',
+                'Content-Type': contentType,
             },
             options,
         });
     }
+    /**
+     * List raw events
+     */
+    async list(params, options) {
+        const searchParams = params
+            ? BaseClient.toURLSearchParams(params)
+            : undefined;
+        return this.request({
+            method: 'GET',
+            path: `/api/v1/events`,
+            searchParams,
+            options,
+        });
+    }
 }

package/dist/clients/meter.d.ts

@@ -13,7 +13,11 @@ export declare enum MeterAggregation {
     MAX = "MAX"
 }
 export type MeterQueryParams = {
-    subject?: string;
+    /**
+     * @description Subject(s) to filter by.
+     * @example ["customer-1", "customer-2"]
+     */
+    subject?: string[];
     /**
      * @description Start date.
      * Must be aligned with the window size.
@@ -26,13 +30,24 @@ export type MeterQueryParams = {
      * Inclusive.
      */
     to?: Date;
-    /** @description If not specified, a single usage aggregate will be returned for the entirety of the specified period for each subject and group. */
+    /**
+     * @description Window Size
+     * If not specified, a single usage aggregate will be returned for the entirety of
+     * the specified period for each subject and group.
+     */
     windowSize?: WindowSizeType;
-    /** @description If not specified a single aggregate will be returned for each subject and time window. */
+    /**
+     * @description The value is the name of the time zone as defined in the IANA Time Zone Database (http://www.iana.org/time-zones).
+     * If not specified, the UTC timezone will be used.
+     */
+    windowTimeZone?: string;
+    /**
+     * @description Group By
+     * If not specified a single aggregate will be returned for each subject and time window.
+     */
     groupBy?: string[];
 };
-export type MeterQueryResponse = paths['/api/v1/meters/{meterIdOrSlug}/values']['get']['responses']['200']['content']['application/json'];
-export type MeterValue = components['schemas']['MeterValue'];
+export type MeterQueryResponse = paths['/api/v1/meters/{meterIdOrSlug}/query']['get']['responses']['200']['content']['application/json'];
 export type Meter = components['schemas']['Meter'];
 export type WindowSizeType = components['schemas']['WindowSize'];
 export declare class MetersClient extends BaseClient {
@@ -46,7 +61,11 @@ export declare class MetersClient extends BaseClient {
      */
     list(options?: RequestOptions): Promise<Meter[]>;
     /**
-     * Get aggregated values of a meter
+     * Query a meter
+     */
+    query(slug: string, params?: MeterQueryParams, options?: RequestOptions): Promise<MeterQueryResponse>;
+    /**
+     * List subjects of a meter
      */
-    values(slug: string, params?: MeterQueryParams, options?: RequestOptions): Promise<MeterQueryResponse>;
+    subjects(slug: string, options?: RequestOptions): Promise<string[]>;
 }

package/dist/clients/meter.js

@@ -38,17 +38,27 @@ export class MetersClient extends BaseClient {
         });
     }
     /**
-     * Get aggregated values of a meter
+     * Query a meter
      */
-    async values(slug, params, options) {
+    async query(slug, params, options) {
         const searchParams = params
             ? BaseClient.toURLSearchParams(params)
             : undefined;
         return this.request({
             method: 'GET',
-            path: `/api/v1/meters/${slug}/values`,
+            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/clients/portal.d.ts

@@ -0,0 +1,22 @@
+import { components } from '../schemas/openapi.js';
+import { RequestOptions, BaseClient, OpenMeterConfig } from './client.js';
+export type PortalToken = components['schemas']['PortalToken'];
+export declare class PortalClient extends BaseClient {
+    constructor(config: OpenMeterConfig);
+    /**
+     * Create portal token
+     * Useful for creating a token sharable with your customer to query their own usage
+     */
+    createToken(token: {
+        subject: string;
+        expiresAt?: Date;
+        allowedMeterSlugs?: string[];
+    }, options?: RequestOptions): Promise<PortalToken>;
+    /**
+     * Invalidate portal token
+     * @note OpenMeter Cloud only feature
+     */
+    invalidateTokens(invalidate?: {
+        subject?: string;
+    }, options?: RequestOptions): Promise<void>;
+}

package/dist/clients/portal.js

@@ -0,0 +1,36 @@
+import { BaseClient } from './client.js';
+export class PortalClient extends BaseClient {
+    constructor(config) {
+        super(config);
+    }
+    /**
+     * Create portal token
+     * Useful for creating a token sharable with your customer to query their own usage
+     */
+    async createToken(token, options) {
+        return await this.request({
+            path: '/api/v1/portal/tokens',
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json',
+            },
+            body: JSON.stringify(token),
+            options,
+        });
+    }
+    /**
+     * Invalidate portal token
+     * @note OpenMeter Cloud only feature
+     */
+    async invalidateTokens(invalidate = {}, options) {
+        return await this.request({
+            path: '/api/v1/portal/tokens/invalidate',
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json',
+            },
+            body: JSON.stringify(invalidate),
+            options,
+        });
+    }
+}

package/dist/clients/subject.d.ts

@@ -0,0 +1,27 @@
+import { components } from '../schemas/openapi.js';
+import { RequestOptions, BaseClient, OpenMeterConfig } from './client.js';
+export type Subject = components['schemas']['Subject'];
+export declare class SubjectClient extends BaseClient {
+    constructor(config: OpenMeterConfig);
+    /**
+     * Upsert subject
+     * Useful to map display name and metadata to subjects
+     * @note OpenMeter Cloud only feature
+     */
+    upsert(subject: Omit<Subject, 'id'>[], options?: RequestOptions): Promise<Subject[]>;
+    /**
+     * Get subject by id or key
+     * @note OpenMeter Cloud only feature
+     */
+    get(idOrKey: string, options?: RequestOptions): Promise<void>;
+    /**
+     * List subjects
+     * @note OpenMeter Cloud only feature
+     */
+    list(options?: RequestOptions): Promise<void>;
+    /**
+     * Delete subject by id or key
+     * @note OpenMeter Cloud only feature
+     */
+    delete(idOrKey: string, options?: RequestOptions): Promise<void>;
+}

package/dist/clients/subject.js

@@ -0,0 +1,55 @@
+import { BaseClient } from './client.js';
+export class SubjectClient extends BaseClient {
+    constructor(config) {
+        super(config);
+    }
+    /**
+     * Upsert subject
+     * Useful to map display name and metadata to subjects
+     * @note OpenMeter Cloud only feature
+     */
+    async upsert(subject, options) {
+        return await this.request({
+            path: '/api/v1/subjects',
+            method: 'POST',
+            headers: {
+                'Content-Type': 'application/json',
+            },
+            body: JSON.stringify(subject),
+            options,
+        });
+    }
+    /**
+     * Get subject by id or key
+     * @note OpenMeter Cloud only feature
+     */
+    async get(idOrKey, options) {
+        return await this.request({
+            path: `/api/v1/subjects/${idOrKey}`,
+            method: 'GET',
+            options,
+        });
+    }
+    /**
+     * List subjects
+     * @note OpenMeter Cloud only feature
+     */
+    async list(options) {
+        return await this.request({
+            path: '/api/v1/subjects',
+            method: 'GET',
+            options,
+        });
+    }
+    /**
+     * Delete subject by id or key
+     * @note OpenMeter Cloud only feature
+     */
+    async delete(idOrKey, options) {
+        return await this.request({
+            path: `/api/v1/subjects/${idOrKey}`,
+            method: 'DELETE',
+            options,
+        });
+    }
+}

package/dist/index.d.ts

@@ -1,11 +1,15 @@
 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 declare class OpenMeter {
     events: EventsClient;
     meters: MetersClient;
+    portal: PortalClient;
+    subjects: SubjectClient;
     constructor(config: OpenMeterConfig);
 }

package/dist/index.js

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