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

package/dist/schemas/openapi.d.ts

@@ -3,29 +3,31 @@
  * Do not make direct changes to the file.
  */
 export interface paths {
-    "/api/v1/events": {
+    '/api/v1/events': {
+        /** @description Retrieve latest raw events. */
+        get: operations['listEvents'];
         /** @description Ingest events */
-        post: operations["ingestEvents"];
+        post: operations['ingestEvents'];
     };
-    "/api/v1/meters": {
+    '/api/v1/meters': {
         /** @description List meters */
-        get: operations["listMeters"];
+        get: operations['listMeters'];
         /** @description Create meter */
-        post: operations["createMeter"];
+        post: operations['createMeter'];
     };
-    "/api/v1/meters/{meterIdOrSlug}": {
+    '/api/v1/meters/{meterIdOrSlug}': {
         /** @description Get meter by slugs */
-        get: operations["getMeter"];
+        get: operations['getMeter'];
         /** @description Delete meter by slug */
-        delete: operations["deleteMeter"];
+        delete: operations['deleteMeter'];
     };
-    "/api/v1/meters/{meterIdOrSlug}/values": {
-        /** @description Get meter values */
-        get: operations["getMeterValues"];
+    '/api/v1/meters/{meterIdOrSlug}/query': {
+        /** @description Query meter */
+        get: operations['queryMeter'];
     };
-    "/api/v1/namespaces": {
-        /** @description Create namespace */
-        post: operations["createNamespace"];
+    '/api/v1/meters/{meterIdOrSlug}/subjects': {
+        /** @description List meter subjects */
+        get: operations['listMeterSubjects'];
     };
 }
 export type webhooks = Record<string, never>;
@@ -100,7 +102,7 @@ export interface components {
              * @example application/json
              * @enum {string|null}
              */
-            datacontenttype?: "application/json" | null;
+            datacontenttype?: 'application/json' | null;
             /**
              * Format: uri
              * @description Identifies the schema that data adheres to.
@@ -136,7 +138,7 @@ export interface components {
             id?: string;
             /**
              * @description A unique identifier for the meter.
-             * @example my-meter
+             * @example my_meter
              */
             slug: string;
             /**
@@ -144,7 +146,7 @@ export interface components {
              * @example My Meter Description
              */
             description?: string | null;
-            aggregation: components["schemas"]["MeterAggregation"];
+            aggregation: components['schemas']['MeterAggregation'];
             /**
              * @description The event type to aggregate.
              * @example api_request
@@ -154,185 +156,190 @@ export interface components {
              * @description JSONPath expression to extract the value from the event data.
              * @example $.duration_ms
              */
-            valueProperty: string;
+            valueProperty?: string;
             /**
              * @description Named JSONPath expressions to extract the group by values from the event data.
              * @example {
-             *   "duration_ms": "$.duration_ms",
+             *   "method": "$.method",
              *   "path": "$.path"
              * }
              */
             groupBy?: {
                 [key: string]: string;
             };
-            windowSize: components["schemas"]["WindowSize"];
+            windowSize: components['schemas']['WindowSize'];
         };
         /**
          * @description The aggregation type to use for the meter.
          * @enum {string}
          */
-        MeterAggregation: "SUM" | "COUNT" | "AVG" | "MIN" | "MAX";
+        MeterAggregation: 'SUM' | 'COUNT' | 'AVG' | 'MIN' | 'MAX';
         /** @enum {string} */
-        WindowSize: "MINUTE" | "HOUR" | "DAY";
-        MeterValue: {
-            /** @description The subject of the meter value. */
-            subject?: string;
+        WindowSize: 'MINUTE' | 'HOUR' | 'DAY';
+        MeterQueryRow: {
+            value: number;
             /** Format: date-time */
             windowStart: string;
             /** Format: date-time */
             windowEnd: string;
-            value: number;
+            /** @description The subject of the meter value. */
+            subject?: string | null;
             groupBy?: {
                 [key: string]: string;
             } | null;
         };
         IdOrSlug: string;
-        Namespace: {
-            /**
-             * @description A namespace
-             * @example my-namesapce
-             */
-            namespace: string;
-        };
     };
     responses: {
         /** @description Bad Request */
         BadRequestProblemResponse: {
             content: {
-                "application/problem+json": components["schemas"]["Problem"];
+                'application/problem+json': components['schemas']['Problem'];
             };
         };
         /** @description Method not allowed, feature not supported */
         MethodNotAllowedProblemResponse: {
             content: {
-                "application/problem+json": components["schemas"]["Problem"];
+                'application/problem+json': components['schemas']['Problem'];
             };
         };
         /** @description Not Found */
         NotFoundProblemResponse: {
             content: {
-                "application/problem+json": components["schemas"]["Problem"];
+                'application/problem+json': components['schemas']['Problem'];
             };
         };
         /** @description Not Implemented */
         NotImplementedProblemResponse: {
             content: {
-                "application/problem+json": components["schemas"]["Problem"];
+                'application/problem+json': components['schemas']['Problem'];
             };
         };
         /** @description Unexpected error */
         UnexpectedProblemResponse: {
             content: {
-                "application/problem+json": components["schemas"]["Problem"];
+                'application/problem+json': components['schemas']['Problem'];
             };
         };
     };
     parameters: {
         /** @description A unique identifier for the meter. */
-        meterIdOrSlug: components["schemas"]["IdOrSlug"];
+        meterIdOrSlug: components['schemas']['IdOrSlug'];
         /**
-         * @description Optional namespace
-         * @default default
+         * @description Start date-time in RFC 3339 format in UTC timezone.
+         * Must be aligned with the window size.
+         * Inclusive.
          */
-        namespaceParam?: string;
+        queryFrom?: string;
+        /**
+         * @description End date-time in RFC 3339 format in UTC timezone.
+         * Must be aligned with the window size.
+         * Inclusive.
+         */
+        queryTo?: string;
+        /** @description If not specified, a single usage aggregate will be returned for the entirety of the specified period for each subject and group. */
+        queryWindowSize?: components['schemas']['WindowSize'];
+        querySubject?: string[];
+        /** @description If not specified a single aggregate will be returned for each subject and time window. */
+        queryGroupBy?: string[];
     };
     requestBodies: never;
     headers: never;
     pathItems: never;
 }
+export type $defs = Record<string, never>;
 export type external = Record<string, never>;
 export interface operations {
-    /** @description Ingest events */
-    ingestEvents: {
+    /** @description Retrieve latest raw events. */
+    listEvents: {
         parameters: {
-            header?: {
-                "OM-Namespace"?: components["parameters"]["namespaceParam"];
+            query?: {
+                /** @description Number of events to return. */
+                limit?: number;
+            };
+        };
+        responses: {
+            /** @description Events response */
+            200: {
+                content: {
+                    'application/json': components['schemas']['Event'][];
+                };
             };
+            400: components['responses']['BadRequestProblemResponse'];
+            default: components['responses']['UnexpectedProblemResponse'];
         };
+    };
+    /** @description Ingest events */
+    ingestEvents: {
         requestBody: {
             content: {
-                "application/cloudevents+json": components["schemas"]["Event"];
+                'application/cloudevents+json': components['schemas']['Event'];
+                'application/cloudevents-batch+json': components['schemas']['Event'][];
             };
         };
         responses: {
             /** @description OK */
-            200: {
+            204: {
                 content: never;
             };
-            400: components["responses"]["BadRequestProblemResponse"];
-            default: components["responses"]["UnexpectedProblemResponse"];
+            400: components['responses']['BadRequestProblemResponse'];
+            default: components['responses']['UnexpectedProblemResponse'];
         };
     };
     /** @description List meters */
     listMeters: {
-        parameters: {
-            header?: {
-                "OM-Namespace"?: components["parameters"]["namespaceParam"];
-            };
-        };
         responses: {
             /** @description Meters response */
             200: {
                 content: {
-                    "application/json": components["schemas"]["Meter"][];
+                    'application/json': components['schemas']['Meter'][];
                 };
             };
-            default: components["responses"]["UnexpectedProblemResponse"];
+            default: components['responses']['UnexpectedProblemResponse'];
         };
     };
     /** @description Create meter */
     createMeter: {
-        parameters: {
-            header?: {
-                "OM-Namespace"?: components["parameters"]["namespaceParam"];
-            };
-        };
         requestBody: {
             content: {
-                "application/json": components["schemas"]["Meter"];
+                'application/json': components['schemas']['Meter'];
             };
         };
         responses: {
             /** @description Created */
             201: {
                 content: {
-                    "application/json": components["schemas"]["Meter"];
+                    'application/json': components['schemas']['Meter'];
                 };
             };
-            400: components["responses"]["BadRequestProblemResponse"];
-            501: components["responses"]["NotImplementedProblemResponse"];
-            default: components["responses"]["UnexpectedProblemResponse"];
+            400: components['responses']['BadRequestProblemResponse'];
+            501: components['responses']['NotImplementedProblemResponse'];
+            default: components['responses']['UnexpectedProblemResponse'];
         };
     };
     /** @description Get meter by slugs */
     getMeter: {
         parameters: {
-            header?: {
-                "OM-Namespace"?: components["parameters"]["namespaceParam"];
-            };
             path: {
-                meterIdOrSlug: components["parameters"]["meterIdOrSlug"];
+                meterIdOrSlug: components['parameters']['meterIdOrSlug'];
             };
         };
         responses: {
             /** @description OK */
             200: {
                 content: {
-                    "application/json": components["schemas"]["Meter"];
+                    'application/json': components['schemas']['Meter'];
                 };
             };
-            404: components["responses"]["NotFoundProblemResponse"];
-            default: components["responses"]["UnexpectedProblemResponse"];
+            404: components['responses']['NotFoundProblemResponse'];
+            default: components['responses']['UnexpectedProblemResponse'];
         };
     };
     /** @description Delete meter by slug */
     deleteMeter: {
         parameters: {
-            header?: {
-                "OM-Namespace"?: components["parameters"]["namespaceParam"];
-            };
             path: {
-                meterIdOrSlug: components["parameters"]["meterIdOrSlug"];
+                meterIdOrSlug: components['parameters']['meterIdOrSlug'];
             };
         };
         responses: {
@@ -340,75 +347,60 @@ export interface operations {
             204: {
                 content: never;
             };
-            404: components["responses"]["NotFoundProblemResponse"];
-            501: components["responses"]["NotImplementedProblemResponse"];
-            default: components["responses"]["UnexpectedProblemResponse"];
+            404: components['responses']['NotFoundProblemResponse'];
+            501: components['responses']['NotImplementedProblemResponse'];
+            default: components['responses']['UnexpectedProblemResponse'];
         };
     };
-    /** @description Get meter values */
-    getMeterValues: {
+    /** @description Query meter */
+    queryMeter: {
         parameters: {
             query?: {
-                subject?: string;
-                /**
-                 * @description Start date-time in RFC 3339 format.
-                 * Must be aligned with the window size.
-                 * Inclusive.
-                 */
-                from?: string;
-                /**
-                 * @description End date-time in RFC 3339 format.
-                 * Must be aligned with the window size.
-                 * Inclusive.
-                 */
-                to?: string;
-                /** @description If not specified, a single usage aggregate will be returned for the entirety of the specified period for each subject and group. */
-                windowSize?: components["schemas"]["WindowSize"];
-                /**
-                 * @description If not specified, OpenMeter will use the default aggregation type.
-                 * As OpenMeter stores aggregates defined by meter config, passing a different aggregate can lead to inaccurate results.
-                 * For example getting the MIN of SUMs.
-                 */
-                aggregation?: components["schemas"]["MeterAggregation"];
-                /** @description If not specified a single aggregate will be returned for each subject and time window. */
-                groupBy?: string;
-            };
-            header?: {
-                "OM-Namespace"?: components["parameters"]["namespaceParam"];
+                from?: components['parameters']['queryFrom'];
+                to?: components['parameters']['queryTo'];
+                windowSize?: components['parameters']['queryWindowSize'];
+                subject?: components['parameters']['querySubject'];
+                groupBy?: components['parameters']['queryGroupBy'];
             };
             path: {
-                meterIdOrSlug: components["parameters"]["meterIdOrSlug"];
+                meterIdOrSlug: components['parameters']['meterIdOrSlug'];
             };
         };
         responses: {
             /** @description OK */
             200: {
                 content: {
-                    "application/json": {
-                        windowSize?: components["schemas"]["WindowSize"];
-                        data: components["schemas"]["MeterValue"][];
+                    'application/json': {
+                        /** Format: date-time */
+                        from?: string;
+                        /** Format: date-time */
+                        to?: string;
+                        windowSize?: components['schemas']['WindowSize'];
+                        data: components['schemas']['MeterQueryRow'][];
                     };
+                    'text/csv': string;
                 };
             };
-            400: components["responses"]["BadRequestProblemResponse"];
-            default: components["responses"]["UnexpectedProblemResponse"];
+            400: components['responses']['BadRequestProblemResponse'];
+            default: components['responses']['UnexpectedProblemResponse'];
         };
     };
-    /** @description Create namespace */
-    createNamespace: {
-        requestBody: {
-            content: {
-                "application/json": components["schemas"]["Namespace"];
+    /** @description List meter subjects */
+    listMeterSubjects: {
+        parameters: {
+            path: {
+                meterIdOrSlug: components['parameters']['meterIdOrSlug'];
             };
         };
         responses: {
-            /** @description Created */
-            201: {
+            /** @description OK */
+            200: {
                 content: {
-                    "application/json": components["schemas"]["Namespace"];
+                    'application/json': string[];
                 };
             };
-            default: components["responses"]["UnexpectedProblemResponse"];
+            400: components['responses']['BadRequestProblemResponse'];
+            default: components['responses']['UnexpectedProblemResponse'];
         };
     };
 }

package/dist/test/agent.js

@@ -1,13 +1,14 @@
 import { MockAgent } from 'undici';
-import { mockMeter, mockMeterValue } from './mocks.js';
+import { mockEvent, mockMeter, mockMeterValue } from './mocks.js';
 export const mockAgent = new MockAgent();
 mockAgent.disableNetConnect();
 const client = mockAgent.get('http://127.0.0.1:8888');
-client.intercept({
+client
+    .intercept({
     path: '/api/v1/events',
     method: 'POST',
     headers: {
-        'Accept': 'application/json',
+        Accept: 'application/json',
         'Content-Type': 'application/cloudevents+json',
     },
     body: JSON.stringify({
@@ -20,14 +21,28 @@ client.intercept({
         data: {
             api_calls: 1,
         },
-    })
+    }),
 })
     .reply(204);
-client.intercept({
+client
+    .intercept({
+    path: `/api/v1/events`,
+    method: 'GET',
+    headers: {
+        Accept: 'application/json',
+    },
+})
+    .reply(200, [mockEvent], {
+    headers: {
+        'Content-Type': 'application/json',
+    },
+});
+client
+    .intercept({
     path: '/api/v1/events',
     method: 'POST',
     headers: {
-        'Accept': 'application/json',
+        Accept: 'application/json',
         'Content-Type': 'application/cloudevents+json',
     },
     body: JSON.stringify({
@@ -39,67 +54,131 @@ client.intercept({
         data: {
             api_calls: 1,
         },
-    })
+    }),
 })
     .reply(204);
-client.intercept({
+client
+    .intercept({
     path: '/api/v1/meters',
     method: 'GET',
     headers: {
-        'Accept': 'application/json'
-    }
+        Accept: 'application/json',
+    },
 })
     .reply(200, [mockMeter], {
     headers: {
-        'Content-Type': 'application/json'
-    }
+        'Content-Type': 'application/json',
+    },
 });
-client.intercept({
+client
+    .intercept({
     path: `/api/v1/meters/${mockMeter.slug}`,
     method: 'GET',
     headers: {
-        'Accept': 'application/json'
-    }
+        Accept: 'application/json',
+    },
 })
     .reply(200, mockMeter, {
     headers: {
-        'Content-Type': 'application/json'
-    }
+        'Content-Type': 'application/json',
+    },
 });
-client.intercept({
+/** Meter Values */
+client
+    .intercept({
     path: `/api/v1/meters/${mockMeter.slug}/values`,
     query: {},
     method: 'GET',
     headers: {
-        'Accept': 'application/json'
-    }
+        Accept: 'application/json',
+    },
 })
     .reply(200, {
     windowSize: 'HOUR',
-    data: [mockMeterValue]
+    data: [mockMeterValue],
 }, {
     headers: {
-        'Content-Type': 'application/json'
-    }
+        'Content-Type': 'application/json',
+    },
 });
-client.intercept({
+client
+    .intercept({
     path: `/api/v1/meters/${mockMeter.slug}/values`,
     query: {
         subject: 'user-1',
         from: new Date('2021-01-01').toISOString(),
         to: new Date('2021-01-02').toISOString(),
-        windowSize: 'HOUR'
+        windowSize: 'HOUR',
+    },
+    method: 'GET',
+    headers: {
+        Accept: 'application/json',
+    },
+})
+    .reply(200, {
+    windowSize: 'HOUR',
+    data: [mockMeterValue],
+}, {
+    headers: {
+        'Content-Type': 'application/json',
+    },
+});
+/** Meter Query */
+client
+    .intercept({
+    path: `/api/v1/meters/${mockMeter.slug}/query`,
+    query: {},
+    method: 'GET',
+    headers: {
+        Accept: 'application/json',
+    },
+})
+    .reply(200, {
+    from: mockMeterValue.windowStart,
+    to: mockMeterValue.windowEnd,
+    windowSize: 'HOUR',
+    data: [mockMeterValue],
+}, {
+    headers: {
+        'Content-Type': 'application/json',
+    },
+});
+client
+    .intercept({
+    path: `/api/v1/meters/${mockMeter.slug}/query`,
+    query: {
+        subject: 'user-1',
+        groupBy: 'a,b',
+        from: new Date('2021-01-01').toISOString(),
+        to: new Date('2021-01-02').toISOString(),
+        windowSize: 'HOUR',
     },
     method: 'GET',
     headers: {
-        'Accept': 'application/json'
-    }
+        Accept: 'application/json',
+    },
 })
     .reply(200, {
+    from: mockMeterValue.windowStart,
+    to: mockMeterValue.windowEnd,
     windowSize: 'HOUR',
-    data: [mockMeterValue]
+    data: [mockMeterValue],
 }, {
     headers: {
-        'Content-Type': 'application/json'
-    }
+        'Content-Type': 'application/json',
+    },
+});
+/** Meter Subjects */
+client
+    .intercept({
+    path: `/api/v1/meters/${mockMeter.slug}/subjects`,
+    method: 'GET',
+    headers: {
+        Accept: 'application/json',
+    },
+})
+    .reply(200, [mockMeterValue.subject], {
+    headers: {
+        'Content-Type': 'application/json',
+    },
 });

package/dist/test/mocks.d.ts

@@ -1,4 +1,5 @@
-import { Meter } from "../index.js";
+import { Event, Meter } from '../index.js';
+export declare const mockEvent: Event;
 export declare const mockMeter: Meter;
 export declare const mockMeterValue: {
     subject: string;