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

package/dist/cjs/src/client/utils.cjs

@@ -0,0 +1,69 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.transformResponse = transformResponse;
+exports.isIsoDateString = isIsoDateString;
+exports.decodeDates = decodeDates;
+exports.encodeDates = encodeDates;
+const common_js_1 = require("./common.cjs");
+/**
+ * Transform a response from the API
+ * @param resp - The response to transform
+ * @throws HTTPError if the response is an error
+ * @returns The transformed response
+ */
+function transformResponse(resp) {
+    // Handle errors
+    if (resp.error || resp.response.status >= 400) {
+        throw common_js_1.HTTPError.fromResponse(resp);
+    }
+    // Decode dates
+    if (resp.data) {
+        resp.data = decodeDates(resp.data);
+    }
+    return resp.data;
+}
+const ISODateFormat = /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(?:\.\d*)?(?:[-+]\d{2}:?\d{2}|Z)?$/;
+function isIsoDateString(value) {
+    return typeof value === 'string' && ISODateFormat.test(value);
+}
+function decodeDates(data) {
+    // if it's a date string, return a date
+    if (isIsoDateString(data)) {
+        return new Date(data);
+    }
+    // if it's not an object or array, return it
+    if (data === null || data === undefined || typeof data !== 'object') {
+        return data;
+    }
+    // if it's an array, decode each element
+    if (Array.isArray(data)) {
+        return data.map((val) => decodeDates(val));
+    }
+    // if it's an object, decode each key
+    for (const [key, val] of Object.entries(data)) {
+        // @ts-expect-error we know this will give back the same type
+        data[key] = decodeDates(val);
+    }
+    return data;
+}
+function encodeDates(data) {
+    // if it's a date, return a date string
+    if (data instanceof Date) {
+        return data.toISOString();
+    }
+    // if it's not an object or array, return it
+    if (data === null || data === undefined || typeof data !== 'object') {
+        return data;
+    }
+    // if it's an array, encode each element
+    if (Array.isArray(data)) {
+        return data.map((val) => encodeDates(val));
+    }
+    // if it's an object, encode each key
+    for (const [key, val] of Object.entries(data)) {
+        // @ts-expect-error we know this will give back the same type
+        data[key] = encodeDates(val);
+    }
+    return data;
+}
+//# sourceMappingURL=utils.js.map

package/dist/cjs/src/client/utils.d.cts

@@ -0,0 +1,12 @@
+import type { FetchResponse, ParseAsResponse } from 'openapi-fetch';
+import type { MediaType, ResponseObjectMap, SuccessResponse } from 'openapi-typescript-helpers';
+/**
+ * Transform a response from the API
+ * @param resp - The response to transform
+ * @throws HTTPError if the response is an error
+ * @returns The transformed response
+ */
+export declare function transformResponse<T extends Record<string | number, any>, Options, Media extends MediaType>(resp: FetchResponse<T, Options, Media>): ParseAsResponse<SuccessResponse<ResponseObjectMap<T>, Media>, Options> | never;
+export declare function isIsoDateString(value: unknown): value is string;
+export declare function decodeDates<T>(data: T): T;
+export declare function encodeDates<T>(data: T): T;

package/dist/cjs/src/client/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../../src/client/utils.ts"],"names":[],"mappings":";;AAcA,8CAoBC;AAKD,0CAEC;AAED,kCAuBC;AAED,kCAuBC;AA3FD,2CAAuC;AAQvC;;;;;GAKG;AACH,SAAgB,iBAAiB,CAK/B,IAAsC;IAItC,gBAAgB;IAChB,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,QAAQ,CAAC,MAAM,IAAI,GAAG,EAAE,CAAC;QAC9C,MAAM,qBAAS,CAAC,YAAY,CAAC,IAAI,CAAC,CAAA;IACpC,CAAC;IAED,eAAe;IACf,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;QACd,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACpC,CAAC;IAED,OAAO,IAAI,CAAC,IAAK,CAAA;AACnB,CAAC;AAED,MAAM,aAAa,GACjB,wEAAwE,CAAA;AAE1E,SAAgB,eAAe,CAAC,KAAc;IAC5C,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,CAAA;AAC/D,CAAC;AAED,SAAgB,WAAW,CAAI,IAAO;IACpC,uCAAuC;IACvC,IAAI,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC;QAC1B,OAAO,IAAI,IAAI,CAAC,IAAI,CAAM,CAAA;IAC5B,CAAC;IAED,4CAA4C;IAC5C,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,SAAS,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QACpE,OAAO,IAAI,CAAA;IACb,CAAC;IAED,wCAAwC;IACxC,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACxB,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,CAAM,CAAA;IACjD,CAAC;IAED,qCAAqC;IACrC,KAAK,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QAC9C,6DAA6D;QAC7D,IAAI,CAAC,GAAG,CAAC,GAAG,WAAW,CAAC,GAAG,CAAC,CAAA;IAC9B,CAAC;IAED,OAAO,IAAS,CAAA;AAClB,CAAC;AAED,SAAgB,WAAW,CAAI,IAAO;IACpC,uCAAuC;IACvC,IAAI,IAAI,YAAY,IAAI,EAAE,CAAC;QACzB,OAAO,IAAI,CAAC,WAAW,EAAO,CAAA;IAChC,CAAC;IAED,4CAA4C;IAC5C,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,SAAS,IAAI,OAAO,IAAI,KAAK,QAAQ,EAAE,CAAC;QACpE,OAAO,IAAI,CAAA;IACb,CAAC;IAED,wCAAwC;IACxC,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QACxB,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,WAAW,CAAC,GAAG,CAAC,CAAM,CAAA;IACjD,CAAC;IAED,qCAAqC;IACrC,KAAK,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC;QAC9C,6DAA6D;QAC7D,IAAI,CAAC,GAAG,CAAC,GAAG,WAAW,CAAC,GAAG,CAAC,CAAA;IAC9B,CAAC;IAED,OAAO,IAAS,CAAA;AAClB,CAAC"}

package/dist/cjs/src/portal/index.cjs

@@ -0,0 +1,89 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OpenMeter = void 0;
+const openapi_fetch_1 = __importStar(require("openapi-fetch"));
+const utils_js_1 = require("../client/utils.cjs");
+/**
+ * OpenMeter Portal Client
+ * Access to the customer portal.
+ */
+class OpenMeter {
+    client;
+    constructor(config) {
+        this.client = (0, openapi_fetch_1.default)({
+            ...config,
+            headers: {
+                ...config.headers,
+                Authorization: `Bearer ${config.portalToken}`,
+            },
+            querySerializer: (q) => (0, openapi_fetch_1.createQuerySerializer)({
+                array: {
+                    explode: true,
+                    style: 'form',
+                },
+                object: {
+                    explode: true,
+                    style: 'deepObject',
+                },
+            })((0, utils_js_1.encodeDates)(q)),
+        });
+    }
+    /**
+     * Query usage data for a meter by slug for customer portal.
+     * This endpoint is publicly exposable to consumers.
+     * @param meterSlug - The slug of the meter
+     * @param query - The query parameters
+     * @param signal - An optional abort signal
+     * @returns The meter data
+     */
+    async query(meterSlug, query, options) {
+        const resp = await this.client.GET('/api/v1/portal/meters/{meterSlug}/query', {
+            headers: {
+                Accept: 'application/json',
+            },
+            params: {
+                path: {
+                    meterSlug,
+                },
+                query,
+            },
+            ...options,
+        });
+        return (0, utils_js_1.transformResponse)(resp);
+    }
+}
+exports.OpenMeter = OpenMeter;
+//# sourceMappingURL=index.js.map

package/dist/cjs/src/portal/index.d.cts

@@ -0,0 +1,43 @@
+import type { RequestOptions } from '../client/common.cjs';
+import type { ClientOptions } from 'openapi-fetch';
+/**
+ * Portal Config
+ */
+export type Config = Pick<ClientOptions, 'baseUrl' | 'headers' | 'fetch' | 'Request' | 'requestInitExt'> & {
+    portalToken: string;
+};
+/**
+ * OpenMeter Portal Client
+ * Access to the customer portal.
+ */
+export declare class OpenMeter {
+    private client;
+    constructor(config: Config);
+    /**
+     * Query usage data for a meter by slug for customer portal.
+     * This endpoint is publicly exposable to consumers.
+     * @param meterSlug - The slug of the meter
+     * @param query - The query parameters
+     * @param signal - An optional abort signal
+     * @returns The meter data
+     */
+    query(meterSlug: string, query?: {
+        /** @description Start date-time in RFC 3339 format. Inclusive. */
+        from?: string | Date;
+        /** @description End date-time in RFC 3339 format. Inclusive. */
+        to?: string | Date;
+        /** @description If not specified, a single usage aggregate will be returned for the entirety of the specified period for each subject and group. */
+        windowSize?: 'MINUTE' | 'HOUR' | 'DAY';
+        /** @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 Simple filter for group bys with exact match. */
+        filterGroupBy?: Record<string, string>;
+        /** @description If not specified a single aggregate will be returned for each subject and time window. `subject` is a reserved group by value. */
+        groupBy?: string[];
+    }, options?: RequestOptions): Promise<{
+        from?: Date;
+        to?: Date;
+        windowSize?: import("../client/schemas.cjs").components["schemas"]["WindowSize"];
+        data: import("../client/schemas.cjs").components["schemas"]["MeterQueryRow"][];
+    }>;
+}

package/dist/cjs/src/portal/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/portal/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+DAAmE;AACnE,iDAAmE;AAenE;;;GAGG;AACH,MAAa,SAAS;IACZ,MAAM,CAAsC;IAEpD,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,IAAA,uBAAY,EAAQ;YAChC,GAAG,MAAM;YACT,OAAO,EAAE;gBACP,GAAG,MAAM,CAAC,OAAO;gBACjB,aAAa,EAAE,UAAU,MAAM,CAAC,WAAW,EAAE;aAC9C;YACD,eAAe,EAAE,CAAC,CAAC,EAAE,EAAE,CACrB,IAAA,qCAAqB,EAAC;gBACpB,KAAK,EAAE;oBACL,OAAO,EAAE,IAAI;oBACb,KAAK,EAAE,MAAM;iBACd;gBACD,MAAM,EAAE;oBACN,OAAO,EAAE,IAAI;oBACb,KAAK,EAAE,YAAY;iBACpB;aACF,CAAC,CAAC,IAAA,sBAAW,EAAC,CAAC,CAAC,CAAC;SACrB,CAAC,CAAA;IACJ,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,KAAK,CAChB,SAAiB,EACjB,KAaC,EACD,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAChC,yCAAyC,EACzC;YACE,OAAO,EAAE;gBACP,MAAM,EAAE,kBAAkB;aAC3B;YACD,MAAM,EAAE;gBACN,IAAI,EAAE;oBACJ,SAAS;iBACV;gBACD,KAAK;aACN;YACD,GAAG,OAAO;SACX,CACF,CAAA;QAED,OAAO,IAAA,4BAAiB,EACtB,IAAI,CACgF,CAAA;IACxF,CAAC;CACF;AAtED,8BAsEC"}

package/dist/cjs/src/react/context.cjs

@@ -0,0 +1,35 @@
+'use client';
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OpenMeterContext = void 0;
+exports.OpenMeterProvider = OpenMeterProvider;
+exports.useOpenMeter = useOpenMeter;
+const jsx_runtime_1 = require("react/jsx-runtime");
+const react_1 = require("react");
+__exportStar(require("../portal/index.cjs"), exports);
+exports.OpenMeterContext = (0, react_1.createContext)(null);
+function OpenMeterProvider({ children, value }) {
+    return ((0, jsx_runtime_1.jsx)(exports.OpenMeterContext.Provider, { value: value, children: children }));
+}
+function useOpenMeter() {
+    const context = (0, react_1.useContext)(exports.OpenMeterContext);
+    if (typeof context === 'undefined') {
+        throw new Error('useOpenMeter must be used within a OpenMeterProvider');
+    }
+    return context;
+}
+//# sourceMappingURL=context.js.map

package/dist/cjs/src/react/context.d.cts

@@ -0,0 +1,9 @@
+import type { OpenMeter } from '../portal/index.cjs';
+export * from '../portal/index.cjs';
+export declare const OpenMeterContext: import("react").Context<OpenMeter | null>;
+export type OpenMeterProviderProps = {
+    children?: React.ReactNode;
+    value: OpenMeter | null;
+};
+export declare function OpenMeterProvider({ children, value }: OpenMeterProviderProps): import("react/jsx-runtime").JSX.Element;
+export declare function useOpenMeter(): OpenMeter | null;

package/dist/cjs/src/react/context.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.js","sourceRoot":"","sources":["../../../../src/react/context.tsx"],"names":[],"mappings":"AAAA,YAAY,CAAA;;;;;;;;;;;;;;;;;;AAcZ,8CAMC;AAED,oCAOC;;AA3BD,iCAAiD;AAGjD,qDAAkC;AAErB,QAAA,gBAAgB,GAAG,IAAA,qBAAa,EAAmB,IAAI,CAAC,CAAA;AAOrE,SAAgB,iBAAiB,CAAC,EAAE,QAAQ,EAAE,KAAK,EAA0B;IAC3E,OAAO,CACL,uBAAC,wBAAgB,CAAC,QAAQ,IAAC,KAAK,EAAE,KAAK,YACpC,QAAQ,GACiB,CAC7B,CAAA;AACH,CAAC;AAED,SAAgB,YAAY;IAC1B,MAAM,OAAO,GAAG,IAAA,kBAAU,EAAC,wBAAgB,CAAC,CAAA;IAC5C,IAAI,OAAO,OAAO,KAAK,WAAW,EAAE,CAAC;QACnC,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAA;IACzE,CAAC;IAED,OAAO,OAAO,CAAA;AAChB,CAAC"}