@openmeter/sdk 1.0.0-beta.21 → 1.0.0-beta.210

package/README.md

@@ -1,4 +1,4 @@
-# OpenMeter Node SDK
+# OpenMeter JavaScript SDK
 
 ## Install
 
@@ -6,174 +6,62 @@
 npm install --save @openmeter/sdk
 ```
 
-## Example
+## Configuration for accessing the OpenMeter API
 
-```ts
-import { OpenMeter, type Event } from '@openmeter/sdk'
-
-const openmeter = new OpenMeter({ baseUrl: 'http://localhost:8888' })
-
-// Ingesting an event
-const event: Event = {
-  specversion: '1.0',
-  id: 'id-1',
-  source: 'my-app',
-  type: 'my-type',
-  subject: 'my-awesome-user-id',
-  time: new Date(),
-  data: {
-    api_calls: 1,
-  },
-}
-await openmeter.events.ingest(event)
-
-// Fetching a meter
-const meter = await openmeter.meters.get('m1')
-```
-
-## API
-
-### Events
-
-#### ingest
-
-```ts
-import { type Event } from '@openmeter/sdk'
-
-const event: Event = {
-  specversion: '1.0',
-  id: 'id-1',
-  source: 'my-app',
-  type: 'my-type',
-  subject: 'my-awesome-user-id',
-  time: new Date(),
-  data: {
-    api_calls: 1,
-  },
-}
-await openmeter.events.ingest(event)
-```
-
-#### list
-
-Retrieve latest raw events. Useful for debugging.
-
-```ts
-const events = await openmeter.events.list()
-```
-
-### Meters
-
-#### list
-
-List meters.
-
-```ts
-const meters = await openmeter.meters.list()
-```
-
-#### get
-
-Get one meter by slug.
+To use the OpenMeter SDK on your backend, you need to configure `baseUrl` and `apiKey` for OpenMeter Cloud:
 
 ```ts
-const meter = await openmeter.meters.get('m1')
-```
-
-#### query
-
-Query meter values.
+import { OpenMeter } from '@openmeter/sdk'
 
-```ts
-import { WindowSize } from '@openmeter/sdk'
-
-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,
+const openmeter = new OpenMeter({
+  baseUrl: 'https://openmeter.cloud',
+  apiKey: 'om_...',
 })
 ```
 
-#### subjects
+## Configuration for accessing the OpenMeter Portal API
 
-List meter subjects.
+To use the OpenMeter Portal SDK on your frontend, you need to configure it use a portal token in your configuration:
 
 ```ts
-const subjects = await openmeter.meters.subjects('my-meter-slug')
-```
-
-### Portal
-
-#### createToken
-
-Create subject specific tokens.
-Useful to build consumer dashboards.
+import { OpenMeter } from '@openmeter/sdk/portal'
 
-```ts
-const token = await openmeter.portal.createToken({ subject: 'customer-1' })
-```
-
-#### invalidateTokens
-
-Invalidate portal tokens for all or specific subjects.
-
-```ts
-await openmeter.portal.invalidateTokens()
+const openmeter = new OpenMeter({
+  baseUrl: 'https://openmeter.cloud',
+  portalToken: 'om_portal_...',
+})
 ```
 
-## Helpers
-
-### Vercel AI SDK / Next.js
+## Configuration for accessing the OpenMeter React SDK
 
-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.
+To use the OpenMeter React SDK for the portal API, you need to configure a Portal Client and a React Context:
 
 ```ts
-import OpenAI from 'openai'
-import { OpenAIStream, StreamingTextResponse } from 'ai'
-import { createOpenAIStreamCallback } from '@openmeter/sdk'
-
-export async function POST(req: Request) {
-  const { messages } = await req.json()
-  const model = 'gpt-3.5-turbo'
-
-  const response = await openai.chat.completions.create({
-    model,
-    messages,
-    stream: true,
+import {
+  OpenMeter,
+  OpenMeterProvider,
+  useOpenMeter,
+} from '@openmeter/sdk/react'
+
+function App() {
+  // get portal token from your backend
+  const openmeter = new OpenMeter({
+    baseUrl: 'https://openmeter.cloud',
+    portalToken,
   })
 
-  const streamCallbacks = await createOpenAIStreamCallback(
-    {
-      model,
-      prompts: messages.map(({ content }) => content),
-    },
-    {
-      // 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)
-        }
-      },
-    }
+  return (
+    <OpenMeterProvider value={openmeter}>
+      <UsageComponent />
+      {/* ... */}
+    </OpenMeterProvider>
   )
+}
+
+function UsageComponent() {
+  // get openmeter client from context
+  const openmeter = useOpenMeter()
 
-  const stream = OpenAIStream(response, streamCallbacks)
-  return new StreamingTextResponse(stream)
+  // ...
 }
 ```

package/dist/cjs/index.cjs

@@ -0,0 +1,18 @@
+"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 });
+__exportStar(require("./src/client/index.cjs"), exports);
+//# sourceMappingURL=index.js.map

package/dist/cjs/index.d.cts

@@ -0,0 +1 @@
+export * from './src/client/index.cjs';

package/dist/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,wDAAqC"}

package/dist/cjs/src/client/apps.cjs

@@ -0,0 +1,174 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AppStripe = exports.AppMarketplace = exports.Apps = void 0;
+const utils_js_1 = require("./utils.cjs");
+/**
+ * Apps
+ * Manage integrations for extending OpenMeter's functionality.
+ */
+class Apps {
+    client;
+    marketplace;
+    stripe;
+    constructor(client) {
+        this.client = client;
+        this.marketplace = new AppMarketplace(client);
+        this.stripe = new AppStripe(client);
+    }
+    /**
+     * List apps
+     * @param query - The query parameters
+     * @param signal - An optional abort signal
+     * @returns The apps
+     */
+    async list(query, options) {
+        const resp = await this.client.GET('/api/v1/apps', {
+            params: { query },
+            ...options,
+        });
+        return (0, utils_js_1.transformResponse)(resp);
+    }
+    /**
+     * Get an app
+     * @param id - The ID of the app
+     * @param signal - An optional abort signal
+     * @returns The app
+     */
+    async get(id, options) {
+        const resp = await this.client.GET('/api/v1/apps/{id}', {
+            params: { path: { id } },
+            ...options,
+        });
+        return (0, utils_js_1.transformResponse)(resp);
+    }
+    /**
+     * Update an app
+     * @param id - The ID of the app
+     * @param body - The body of the request
+     * @param signal - An optional abort signal
+     * @returns The app
+     */
+    async update(id, body, options) {
+        const resp = await this.client.PUT('/api/v1/apps/{id}', {
+            body,
+            params: { path: { id } },
+            ...options,
+        });
+        return (0, utils_js_1.transformResponse)(resp);
+    }
+    /**
+     * Uninstall an app
+     * @param id - The ID of the app
+     * @param signal - An optional abort signal
+     * @returns The app
+     */
+    async uninstall(id, options) {
+        const resp = await this.client.DELETE('/api/v1/apps/{id}', {
+            params: { path: { id } },
+            ...options,
+        });
+        return (0, utils_js_1.transformResponse)(resp);
+    }
+}
+exports.Apps = Apps;
+/**
+ * App Marketplace
+ * Available apps from the OpenMeter Marketplace.
+ */
+class AppMarketplace {
+    client;
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * List available apps
+     * @param query - The query parameters
+     * @param signal - An optional abort signal
+     * @returns The apps
+     */
+    async list(query, options) {
+        const resp = await this.client.GET('/api/v1/marketplace/listings', {
+            params: { query },
+            ...options,
+        });
+        return (0, utils_js_1.transformResponse)(resp);
+    }
+    /**
+     * Get details for a listing
+     * @param type - The type of the listing
+     * @param signal - An optional abort signal
+     * @returns The listing
+     */
+    async get(type, options) {
+        const resp = await this.client.GET('/api/v1/marketplace/listings/{type}', {
+            params: { path: { type } },
+            ...options,
+        });
+        return (0, utils_js_1.transformResponse)(resp);
+    }
+    /**
+     * Install an app via OAuth. Returns a URL to start the OAuth 2.0 flow.
+     * @param type - The type of the listing
+     * @param signal - An optional abort signal
+     * @returns The OAuth2 install URL
+     */
+    async getOauth2InstallUrl(type, options) {
+        const resp = await this.client.GET('/api/v1/marketplace/listings/{type}/install/oauth2', {
+            params: { path: { type } },
+            ...options,
+        });
+        return (0, utils_js_1.transformResponse)(resp);
+    }
+    /**
+     * Authorize OAuth2 code. Verifies the OAuth code and exchanges it for a token and refresh token
+     * @param type - The type of the listing
+     * @param signal - An optional abort signal
+     * @returns The authorization URL
+     */
+    async authorizeOauth2(type, options) {
+        const resp = await this.client.GET('/api/v1/marketplace/listings/{type}/install/oauth2/authorize', {
+            params: { path: { type } },
+            ...options,
+        });
+        return (0, utils_js_1.transformResponse)(resp);
+    }
+    /**
+     * Install an app via API key.
+     * @param type - The type of the listing
+     * @param signal - An optional abort signal
+     * @returns The installation
+     */
+    async installWithAPIKey(type, body, options) {
+        const resp = await this.client.POST('/api/v1/marketplace/listings/{type}/install/apikey', {
+            body,
+            params: { path: { type } },
+            ...options,
+        });
+        return (0, utils_js_1.transformResponse)(resp);
+    }
+}
+exports.AppMarketplace = AppMarketplace;
+/**
+ * Stripe App
+ */
+class AppStripe {
+    client;
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * Create a checkout session
+     * @param body - The body of the request
+     * @param signal - An optional abort signal
+     * @returns The checkout session
+     */
+    async createCheckoutSession(body, options) {
+        const resp = await this.client.POST('/api/v1/stripe/checkout/sessions', {
+            body,
+            ...options,
+        });
+        return (0, utils_js_1.transformResponse)(resp);
+    }
+}
+exports.AppStripe = AppStripe;
+//# sourceMappingURL=apps.js.map

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

@@ -0,0 +1,285 @@
+import type { RequestOptions } from './common.cjs';
+import type { AppBaseReplaceUpdate, CreateStripeCheckoutSessionRequest, operations, paths } from './schemas.cjs';
+import type { Client } from 'openapi-fetch';
+/**
+ * Apps
+ * Manage integrations for extending OpenMeter's functionality.
+ */
+export declare class Apps {
+    private client;
+    marketplace: AppMarketplace;
+    stripe: AppStripe;
+    constructor(client: Client<paths, `${string}/${string}`>);
+    /**
+     * List apps
+     * @param query - The query parameters
+     * @param signal - An optional abort signal
+     * @returns The apps
+     */
+    list(query?: operations['listApps']['parameters']['query'], options?: RequestOptions): Promise<{
+        totalCount: number;
+        page: number;
+        pageSize: number;
+        items: import("./schemas.cjs").components["schemas"]["App"][];
+    }>;
+    /**
+     * Get an app
+     * @param id - The ID of the app
+     * @param signal - An optional abort signal
+     * @returns The app
+     */
+    get(id: operations['getApp']['parameters']['path']['id'], options?: RequestOptions): Promise<import("openapi-typescript-helpers").SuccessResponse<{
+        200: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": import("./schemas.cjs").components["schemas"]["App"];
+            };
+        };
+        400: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": import("./schemas.cjs").components["schemas"]["BadRequestProblemResponse"];
+            };
+        };
+        401: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": import("./schemas.cjs").components["schemas"]["UnauthorizedProblemResponse"];
+            };
+        };
+        403: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": import("./schemas.cjs").components["schemas"]["ForbiddenProblemResponse"];
+            };
+        };
+        404: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": import("./schemas.cjs").components["schemas"]["NotFoundProblemResponse"];
+            };
+        };
+        412: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": import("./schemas.cjs").components["schemas"]["PreconditionFailedProblemResponse"];
+            };
+        };
+        500: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": import("./schemas.cjs").components["schemas"]["InternalServerErrorProblemResponse"];
+            };
+        };
+        503: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": import("./schemas.cjs").components["schemas"]["ServiceUnavailableProblemResponse"];
+            };
+        };
+        default: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": import("./schemas.cjs").components["schemas"]["UnexpectedProblemResponse"];
+            };
+        };
+    }, `${string}/${string}`>>;
+    /**
+     * Update an app
+     * @param id - The ID of the app
+     * @param body - The body of the request
+     * @param signal - An optional abort signal
+     * @returns The app
+     */
+    update(id: operations['updateApp']['parameters']['path']['id'], body: AppBaseReplaceUpdate, options?: RequestOptions): Promise<import("openapi-typescript-helpers").SuccessResponse<{
+        200: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": import("./schemas.cjs").components["schemas"]["App"];
+            };
+        };
+        400: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": import("./schemas.cjs").components["schemas"]["BadRequestProblemResponse"];
+            };
+        };
+        401: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": import("./schemas.cjs").components["schemas"]["UnauthorizedProblemResponse"];
+            };
+        };
+        403: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": import("./schemas.cjs").components["schemas"]["ForbiddenProblemResponse"];
+            };
+        };
+        404: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": import("./schemas.cjs").components["schemas"]["NotFoundProblemResponse"];
+            };
+        };
+        412: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": import("./schemas.cjs").components["schemas"]["PreconditionFailedProblemResponse"];
+            };
+        };
+        500: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": import("./schemas.cjs").components["schemas"]["InternalServerErrorProblemResponse"];
+            };
+        };
+        503: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": import("./schemas.cjs").components["schemas"]["ServiceUnavailableProblemResponse"];
+            };
+        };
+        default: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": import("./schemas.cjs").components["schemas"]["UnexpectedProblemResponse"];
+            };
+        };
+    }, `${string}/${string}`>>;
+    /**
+     * Uninstall an app
+     * @param id - The ID of the app
+     * @param signal - An optional abort signal
+     * @returns The app
+     */
+    uninstall(id: operations['uninstallApp']['parameters']['path']['id'], options?: RequestOptions): Promise<undefined>;
+}
+/**
+ * App Marketplace
+ * Available apps from the OpenMeter Marketplace.
+ */
+export declare class AppMarketplace {
+    private client;
+    constructor(client: Client<paths, `${string}/${string}`>);
+    /**
+     * List available apps
+     * @param query - The query parameters
+     * @param signal - An optional abort signal
+     * @returns The apps
+     */
+    list(query?: operations['listMarketplaceListings']['parameters']['query'], options?: RequestOptions): Promise<{
+        totalCount: number;
+        page: number;
+        pageSize: number;
+        items: import("./schemas.cjs").components["schemas"]["MarketplaceListing"][];
+    }>;
+    /**
+     * Get details for a listing
+     * @param type - The type of the listing
+     * @param signal - An optional abort signal
+     * @returns The listing
+     */
+    get(type: operations['getMarketplaceListing']['parameters']['path']['type'], options?: RequestOptions): Promise<{
+        type: import("./schemas.cjs").components["schemas"]["AppType"];
+        name: string;
+        description: string;
+        capabilities: import("./schemas.cjs").components["schemas"]["AppCapability"][];
+    }>;
+    /**
+     * Install an app via OAuth. Returns a URL to start the OAuth 2.0 flow.
+     * @param type - The type of the listing
+     * @param signal - An optional abort signal
+     * @returns The OAuth2 install URL
+     */
+    getOauth2InstallUrl(type: operations['marketplaceOAuth2InstallGetURL']['parameters']['path']['type'], options?: RequestOptions): Promise<{
+        url: string;
+    }>;
+    /**
+     * Authorize OAuth2 code. Verifies the OAuth code and exchanges it for a token and refresh token
+     * @param type - The type of the listing
+     * @param signal - An optional abort signal
+     * @returns The authorization URL
+     */
+    authorizeOauth2(type: operations['marketplaceOAuth2InstallAuthorize']['parameters']['path']['type'], options?: RequestOptions): Promise<never>;
+    /**
+     * Install an app via API key.
+     * @param type - The type of the listing
+     * @param signal - An optional abort signal
+     * @returns The installation
+     */
+    installWithAPIKey(type: operations['marketplaceAppAPIKeyInstall']['parameters']['path']['type'], body: operations['marketplaceAppAPIKeyInstall']['requestBody']['content']['application/json'], options?: RequestOptions): Promise<{
+        app: import("./schemas.cjs").components["schemas"]["App"];
+        defaultForCapabilityTypes: import("./schemas.cjs").components["schemas"]["AppCapabilityType"][];
+    }>;
+}
+/**
+ * Stripe App
+ */
+export declare class AppStripe {
+    private client;
+    constructor(client: Client<paths, `${string}/${string}`>);
+    /**
+     * Create a checkout session
+     * @param body - The body of the request
+     * @param signal - An optional abort signal
+     * @returns The checkout session
+     */
+    createCheckoutSession(body: CreateStripeCheckoutSessionRequest, options?: RequestOptions): Promise<{
+        customerId: string;
+        stripeCustomerId: string;
+        sessionId: string;
+        setupIntentId: string;
+        clientSecret?: string;
+        clientReferenceId?: string;
+        customerEmail?: string;
+        currency?: import("./schemas.cjs").components["schemas"]["CurrencyCode"];
+        createdAt: Date;
+        expiresAt?: Date;
+        metadata?: {
+            [key: string]: string;
+        };
+        status?: string;
+        url?: string;
+        mode: import("./schemas.cjs").components["schemas"]["StripeCheckoutSessionMode"];
+        cancelURL?: string;
+        successURL?: string;
+        returnURL?: string;
+    }>;
+}