@openmeter/sdk 1.0.0-beta.22 → 1.0.0-beta.221

package/dist/schemas/openapi.d.ts

@@ -1,460 +0,0 @@
-/**
- * This file was auto-generated by openapi-typescript.
- * Do not make direct changes to the file.
- */
-export interface paths {
-    '/api/v1/events': {
-        /** @description Retrieve latest raw events. */
-        get: operations['listEvents'];
-        /** @description Ingest events */
-        post: operations['ingestEvents'];
-    };
-    '/api/v1/meters': {
-        /** @description List meters */
-        get: operations['listMeters'];
-        /** @description Create meter */
-        post: operations['createMeter'];
-    };
-    '/api/v1/meters/{meterIdOrSlug}': {
-        /** @description Get meter by slugs */
-        get: operations['getMeter'];
-        /** @description Delete meter by slug */
-        delete: operations['deleteMeter'];
-    };
-    '/api/v1/meters/{meterIdOrSlug}/query': {
-        /** @description Query meter */
-        get: operations['queryMeter'];
-    };
-    '/api/v1/meters/{meterIdOrSlug}/subjects': {
-        /** @description List meter subjects */
-        get: operations['listMeterSubjects'];
-    };
-    '/api/v1/portal/tokens': {
-        post: operations['createPortalToken'];
-    };
-    '/api/v1/portal/tokens/invalidate': {
-        post: operations['invalidatePortalTokens'];
-    };
-}
-export type webhooks = Record<string, never>;
-export interface components {
-    schemas: {
-        /**
-         * @description A Problem Details object (RFC 7807)
-         * @example {
-         *   "type": "urn:problem-type:bad-request",
-         *   "title": "Bad Request",
-         *   "status": 400,
-         *   "detail": "header Content-Type has unexpected value \"application/xml\"",
-         *   "instance": "urn:request:local/JMOlctsKV8-000001"
-         * }
-         */
-        Problem: {
-            /**
-             * Format: uri
-             * @description Type contains a URI that identifies the problem type.
-             * @example urn:problem-type:bad-request
-             */
-            type: string;
-            /**
-             * @description A a short, human-readable summary of the problem type.
-             * @example Bad Request
-             */
-            title: string;
-            /**
-             * Format: int32
-             * @description The HTTP status code generated by the origin server for this occurrence of the problem.
-             * @example 400
-             */
-            status: number;
-            /**
-             * @description A human-readable explanation specific to this occurrence of the problem.
-             * @example header Content-Type has unexpected value \"application/xml\"
-             */
-            detail: string;
-            /**
-             * Format: uri
-             * @description A URI reference that identifies the specific occurrence of the problem.
-             * @example urn:request:local/JMOlctsKV8-000001
-             */
-            instance?: string;
-            [key: string]: unknown;
-        };
-        /** @description CloudEvents Specification JSON Schema */
-        Event: {
-            /**
-             * @description Identifies the event.
-             * @example 5c10fade-1c9e-4d6c-8275-c52c36731d3c
-             */
-            id: string;
-            /**
-             * Format: uri-reference
-             * @description Identifies the context in which an event happened.
-             * @example services/service-0
-             */
-            source: string;
-            /**
-             * @description The version of the CloudEvents specification which the event uses.
-             * @example 1.0
-             */
-            specversion: string;
-            /**
-             * @description Describes the type of event related to the originating occurrence.
-             * @example api_request
-             */
-            type: string;
-            /**
-             * @description Content type of the data value. Must adhere to RFC 2046 format.
-             * @example application/json
-             * @enum {string|null}
-             */
-            datacontenttype?: 'application/json' | null;
-            /**
-             * Format: uri
-             * @description Identifies the schema that data adheres to.
-             */
-            dataschema?: string | null;
-            /**
-             * @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 Timestamp of when the occurrence happened. Must adhere to RFC 3339.
-             * @example 2023-01-01T01:01:01.001Z
-             */
-            time?: string | null;
-            /**
-             * @description The event payload.
-             * @example {
-             *   "duration_ms": "12",
-             *   "path": "/hello"
-             * }
-             */
-            data?: {
-                [key: string]: unknown;
-            };
-        };
-        Meter: {
-            /**
-             * @description A unique identifier for the meter.
-             * @example 01G65Z755AFWAKHE12NY0CQ9FH
-             */
-            id?: string;
-            /**
-             * @description A unique identifier for the meter.
-             * @example my_meter
-             */
-            slug: string;
-            /**
-             * @description A description of the meter.
-             * @example My Meter Description
-             */
-            description?: string | null;
-            aggregation: components['schemas']['MeterAggregation'];
-            windowSize: components['schemas']['WindowSize'];
-            /**
-             * @description The event type to aggregate.
-             * @example api_request
-             */
-            eventType: string;
-            /**
-             * @description JSONPath expression to extract the value from the event data.
-             * @example $.duration_ms
-             */
-            valueProperty?: string;
-            /**
-             * @description Named JSONPath expressions to extract the group by values from the event data.
-             * @example {
-             *   "method": "$.method",
-             *   "path": "$.path"
-             * }
-             */
-            groupBy?: {
-                [key: string]: string;
-            };
-        };
-        /**
-         * @description The aggregation type to use for the meter.
-         * @enum {string}
-         */
-        MeterAggregation: 'SUM' | 'COUNT' | 'AVG' | 'MIN' | 'MAX';
-        /**
-         * @description Aggregation window size.
-         * @enum {string}
-         */
-        WindowSize: 'MINUTE' | 'HOUR' | 'DAY';
-        MeterQueryRow: {
-            value: number;
-            /** Format: date-time */
-            windowStart: string;
-            /** Format: date-time */
-            windowEnd: string;
-            /** @description The subject of the meter value. */
-            subject?: string | null;
-            groupBy?: {
-                [key: string]: string;
-            } | null;
-        };
-        PortalToken: {
-            subject: string;
-            /** Format: date-time */
-            expiresAt: string;
-            token: string;
-            allowedMeterSlugs?: string[];
-        };
-        IdOrSlug: string;
-    };
-    responses: {
-        /** @description Bad Request */
-        BadRequestProblemResponse: {
-            content: {
-                'application/problem+json': components['schemas']['Problem'];
-            };
-        };
-        /** @description Method not allowed, feature not supported */
-        MethodNotAllowedProblemResponse: {
-            content: {
-                'application/problem+json': components['schemas']['Problem'];
-            };
-        };
-        /** @description Not Found */
-        NotFoundProblemResponse: {
-            content: {
-                'application/problem+json': components['schemas']['Problem'];
-            };
-        };
-        /** @description Not Implemented */
-        NotImplementedProblemResponse: {
-            content: {
-                'application/problem+json': components['schemas']['Problem'];
-            };
-        };
-        /** @description Unexpected error */
-        UnexpectedProblemResponse: {
-            content: {
-                'application/problem+json': components['schemas']['Problem'];
-            };
-        };
-    };
-    parameters: {
-        /** @description A unique identifier for the meter. */
-        meterIdOrSlug: components['schemas']['IdOrSlug'];
-        /**
-         * @description Start date-time in RFC 3339 format.
-         * Inclusive.
-         */
-        queryFrom?: string;
-        /**
-         * @description End date-time in RFC 3339 format.
-         * 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'];
-        /**
-         * @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.
-         */
-        queryWindowTimeZone?: string;
-        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 Retrieve latest raw events. */
-    listEvents: {
-        parameters: {
-            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-batch+json': components['schemas']['Event'][];
-            };
-        };
-        responses: {
-            /** @description OK */
-            204: {
-                content: never;
-            };
-            400: components['responses']['BadRequestProblemResponse'];
-            default: components['responses']['UnexpectedProblemResponse'];
-        };
-    };
-    /** @description List meters */
-    listMeters: {
-        responses: {
-            /** @description Meters response */
-            200: {
-                content: {
-                    'application/json': components['schemas']['Meter'][];
-                };
-            };
-            default: components['responses']['UnexpectedProblemResponse'];
-        };
-    };
-    /** @description Create meter */
-    createMeter: {
-        requestBody: {
-            content: {
-                'application/json': components['schemas']['Meter'];
-            };
-        };
-        responses: {
-            /** @description Created */
-            201: {
-                content: {
-                    'application/json': components['schemas']['Meter'];
-                };
-            };
-            400: components['responses']['BadRequestProblemResponse'];
-            501: components['responses']['NotImplementedProblemResponse'];
-            default: components['responses']['UnexpectedProblemResponse'];
-        };
-    };
-    /** @description Get meter by slugs */
-    getMeter: {
-        parameters: {
-            path: {
-                meterIdOrSlug: components['parameters']['meterIdOrSlug'];
-            };
-        };
-        responses: {
-            /** @description OK */
-            200: {
-                content: {
-                    'application/json': components['schemas']['Meter'];
-                };
-            };
-            404: components['responses']['NotFoundProblemResponse'];
-            default: components['responses']['UnexpectedProblemResponse'];
-        };
-    };
-    /** @description Delete meter by slug */
-    deleteMeter: {
-        parameters: {
-            path: {
-                meterIdOrSlug: components['parameters']['meterIdOrSlug'];
-            };
-        };
-        responses: {
-            /** @description No Content */
-            204: {
-                content: never;
-            };
-            404: components['responses']['NotFoundProblemResponse'];
-            501: components['responses']['NotImplementedProblemResponse'];
-            default: components['responses']['UnexpectedProblemResponse'];
-        };
-    };
-    /** @description Query meter */
-    queryMeter: {
-        parameters: {
-            query?: {
-                from?: components['parameters']['queryFrom'];
-                to?: components['parameters']['queryTo'];
-                windowSize?: components['parameters']['queryWindowSize'];
-                windowTimeZone?: components['parameters']['queryWindowTimeZone'];
-                subject?: components['parameters']['querySubject'];
-                groupBy?: components['parameters']['queryGroupBy'];
-            };
-            path: {
-                meterIdOrSlug: components['parameters']['meterIdOrSlug'];
-            };
-        };
-        responses: {
-            /** @description OK */
-            200: {
-                content: {
-                    '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'];
-        };
-    };
-    /** @description List meter subjects */
-    listMeterSubjects: {
-        parameters: {
-            path: {
-                meterIdOrSlug: components['parameters']['meterIdOrSlug'];
-            };
-        };
-        responses: {
-            /** @description OK */
-            200: {
-                content: {
-                    'application/json': string[];
-                };
-            };
-            400: components['responses']['BadRequestProblemResponse'];
-            default: components['responses']['UnexpectedProblemResponse'];
-        };
-    };
-    createPortalToken: {
-        requestBody?: {
-            content: {
-                'application/json': components['schemas']['PortalToken'];
-            };
-        };
-        responses: {
-            /** @description OK */
-            200: {
-                content: {
-                    'application/json': components['schemas']['PortalToken'];
-                };
-            };
-            400: components['responses']['BadRequestProblemResponse'];
-            default: components['responses']['UnexpectedProblemResponse'];
-        };
-    };
-    invalidatePortalTokens: {
-        requestBody?: {
-            content: {
-                'application/json': {
-                    subject?: string;
-                };
-            };
-        };
-        responses: {
-            /** @description No Content */
-            204: {
-                content: never;
-            };
-            400: components['responses']['BadRequestProblemResponse'];
-            default: components['responses']['UnexpectedProblemResponse'];
-        };
-    };
-}

package/dist/schemas/openapi.js

@@ -1,5 +0,0 @@
-/**
- * This file was auto-generated by openapi-typescript.
- * Do not make direct changes to the file.
- */
-export {};

package/dist/test/agent.d.ts

@@ -1,2 +0,0 @@
-import { MockAgent } from 'undici';
-export declare const mockAgent: MockAgent<MockAgent.Options>;

package/dist/test/agent.js

@@ -1,178 +0,0 @@
-import { MockAgent } from 'undici';
-import { mockEvent, mockMeter, mockMeterValue } from './mocks.js';
-export const mockAgent = new MockAgent();
-mockAgent.disableNetConnect();
-const client = mockAgent.get('http://127.0.0.1:8888');
-/** Event */
-client
-    .intercept({
-    path: '/api/v1/events',
-    method: 'POST',
-    headers: {
-        Accept: 'application/json',
-        'Content-Type': 'application/cloudevents+json',
-    },
-    body: JSON.stringify({
-        specversion: '1.0',
-        id: 'id-1',
-        source: 'my-app',
-        type: 'my-type',
-        subject: 'my-awesome-user-id',
-        time: new Date('2023-01-01'),
-        data: {
-            api_calls: 1,
-        },
-    }),
-})
-    .reply(204);
-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',
-        'Content-Type': 'application/cloudevents+json',
-    },
-    body: JSON.stringify({
-        specversion: '1.0',
-        id: 'aaf17be7-860c-4519-91d3-00d97da3cc65',
-        source: '@openmeter/sdk',
-        type: 'my-type',
-        subject: 'my-awesome-user-id',
-        data: {
-            api_calls: 1,
-        },
-    }),
-})
-    .reply(204);
-/** Portal */
-client
-    .intercept({
-    path: '/api/v1/meters',
-    method: 'GET',
-    headers: {
-        Accept: 'application/json',
-    },
-})
-    .reply(200, [mockMeter], {
-    headers: {
-        'Content-Type': 'application/json',
-    },
-});
-client
-    .intercept({
-    path: `/api/v1/meters/${mockMeter.slug}`,
-    method: 'GET',
-    headers: {
-        Accept: 'application/json',
-    },
-})
-    .reply(200, mockMeter, {
-    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',
-    },
-})
-    .reply(200, {
-    from: mockMeterValue.windowStart,
-    to: mockMeterValue.windowEnd,
-    windowSize: 'HOUR',
-    data: [mockMeterValue],
-}, {
-    headers: {
-        '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',
-    },
-});
-/** Portal */
-client
-    .intercept({
-    path: '/api/v1/portal/tokens',
-    method: 'POST',
-    headers: {
-        Accept: 'application/json',
-        'Content-Type': 'application/json',
-    },
-    body: JSON.stringify({
-        subject: 'customer-1',
-    }),
-})
-    .reply(201, {
-    subject: 'customer-1',
-    expiresAt: new Date('2023-01-01'),
-}, {
-    headers: {
-        'Content-Type': 'application/json',
-    },
-});
-client
-    .intercept({
-    path: '/api/v1/portal/tokens/invalidate',
-    method: 'POST',
-    headers: {
-        Accept: 'application/json',
-        'Content-Type': 'application/json',
-    },
-    body: JSON.stringify({}),
-})
-    .reply(204);

package/dist/test/mocks.d.ts

@@ -1,12 +0,0 @@
-import { Event, Meter } from '../index.js';
-export declare const mockEvent: Event;
-export declare const mockMeter: Meter;
-export declare const mockMeterValue: {
-    subject: string;
-    windowStart: string;
-    windowEnd: string;
-    value: number;
-    groupBy: {
-        method: string;
-    };
-};

package/dist/test/mocks.js

@@ -1,32 +0,0 @@
-import { WindowSize } from '../index.js';
-export const mockEvent = {
-    specversion: '1.0',
-    id: 'id-1',
-    source: 'my-app',
-    type: 'my-type',
-    subject: 'my-awesome-user-id',
-    time: new Date('2023-01-01'),
-    data: {
-        api_calls: 1,
-    },
-};
-export const mockMeter = {
-    slug: 'm1',
-    aggregation: 'SUM',
-    eventType: 'api_requests',
-    valueProperty: '$.duration_ms',
-    windowSize: WindowSize.HOUR,
-    groupBy: {
-        method: '$.method',
-        path: '$.path',
-    },
-};
-export const mockMeterValue = {
-    subject: 'customer-1',
-    windowStart: '2023-01-01T01:00:00.001Z',
-    windowEnd: '2023-01-01T01:00:00.001Z',
-    value: 1,
-    groupBy: {
-        method: 'GET',
-    },
-};