@openmeter/sdk 1.0.0-beta.184 → 1.0.0-beta.188

package/README.md

@@ -1,4 +1,4 @@
-# OpenMeter Node SDK
+# OpenMeter JavaScript SDK
 
 ## Install
 
@@ -6,333 +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)
-```
-
-### 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
-
-List meters.
-
-```ts
-const meters = await openmeter.meters.list()
-```
-
-#### get
-
-Get one meter by slug.
-
-```ts
-const meter = await openmeter.meters.get('m1')
-```
-
-#### query
-
-Query meter values.
-
-```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,
-})
-```
-
-#### 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.
+To use the OpenMeter SDK on your backend, you need to configure `baseUrl` and `apiKey` for OpenMeter Cloud:
 
 ```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')
-```
+import { OpenMeter } from '@openmeter/sdk'
 
-#### createEntitlement
-
-Create entitlement for a subject.
-Entitlements allow you to manage subject feature access, balances, and usage limits.
-
-```ts
-// Issue 10,000,000 tokens every month
-const entitlement = await openmeter.subjects.createEntitlement('customer-1', {
-  type: 'metered',
-  featureKey: 'ai_tokens',
-  usagePeriod: {
-    interval: 'MONTH',
-  },
-  issueAfterReset: 10000000,
+const openmeter = new OpenMeter({
+  baseUrl: 'https://openmeter.cloud',
+  apiKey: 'om_...',
 })
 ```
 
-#### listEntitlements
-
-List subject entitlements.
-
-```ts
-const entitlement = await openmeter.subjects.listEntitlements('customer-1')
-```
-
-#### getEntitlement
-
-Get a subject entitlement by ID by Feature ID or by Feature Key.
-
-```ts
-const entitlement = await openmeter.subjects.getEntitlement(
-  'customer-1',
-  'ai_tokens'
-)
-```
-
-#### deleteEntitlement
-
-Delete a subject entitlement by ID by Feature ID or by Feature Key.
-
-```ts
-await openmeter.subjects.deleteEntitlement('customer-1', 'ai_tokens')
-```
-
-#### getEntitlementValue
-
-Get entitlement value by ID by Feature ID or by Feature Key.
-
-```ts
-const value = await openmeter.subjects.getEntitlementValue(
-  'customer-1',
-  'ai_tokens'
-)
-```
-
-#### getEntitlementHistory
-
-Get entitlement history by ID by Feature ID or by Feature Key
-
-```ts
-const entitlement = await openmeter.subjects.getEntitlementHistory(
-  'customer-1',
-  'ai_tokens'
-)
-```
-
-#### resetEntitlementUsage
+## Configuration for accessing the OpenMeter Portal API
 
-Reset the entitlement usage and start a new period. Eligible grants will be rolled over.
+To use the OpenMeter Portal SDK on your frontend, you need to configure it use a portal token in your configuration:
 
 ```ts
-const entitlement = await openmeter.subjects.resetEntitlementUsage(
-  'customer-1',
-  {
-    retainAnchor: true,
-  }
-)
-```
-
-#### createEntitlementGrant
-
-Create a grant for an entitlement.
-
-```ts
-const grant = await openmeter.subjects.createEntitlementGrant(
-  'customer-1',
-  'ai_tokens',
-  {
-    amount: 100,
-    priority: 1,
-    effectiveAt: '2023-01-01T00:00:00Z',
-    expiration: {
-      duration: 'HOUR',
-      count: 12,
-    },
-    minRolloverAmount: 100,
-    maxRolloverAmount: 100,
-    recurrence: {
-      interval: 'MONTH',
-      anchor: '2024-06-28T18:29:44.867Z',
-    },
-  }
-)
-```
-
-#### listEntitlementGrants
-
-List entitlement grants
-
-```ts
-const entitlement = await openmeter.subjects.listEntitlementGrants('customer-1', 'ai_tokens)
-```
-
-## Features
-
-Features are the building blocks of your entitlements, part of your product offering.
-
-#### create
+import { OpenMeter } from '@openmeter/sdk/portal'
 
-Upsert subjects.
-
-```ts
-const feature = await openmeter.features.create({
-  key: 'ai_tokens',
-  name: 'AI Tokens',
-  // optional
-  meterSlug: 'tokens_total',
+const openmeter = new OpenMeter({
+  baseUrl: 'https://openmeter.cloud',
+  portalToken: 'om_portal_...',
 })
 ```
 
-#### list
+## Configuration for accessing the OpenMeter React SDK
 
-List features.
+To use the OpenMeter React SDK for the portal API, you need to configure a Portal Client and a React Context:
 
 ```ts
-const features = await openmeter.features.list()
-```
-
-#### get
-
-Get feature by key.
-
-```ts
-const feature = await openmeter.features.get('ai_tokens')
-```
-
-#### delete
+import {
+  OpenMeter,
+  OpenMeterProvider,
+  useOpenMeter,
+} from '@openmeter/sdk/react'
 
-Delete feature by key.
+function App() {
+  // get portal token from your backend
+  const openmeter = new OpenMeter({
+    baseUrl: 'https://openmeter.cloud',
+    portalToken,
+  })
 
-```ts
-await openmeter.features.delete('ai_tokens')
-```
-
-## Grants
-
-Entitlement grants allow to issue of additional one-time or recurring allowances on a subject's entitlement.
-
-#### list
+  return (
+    <OpenMeterProvider value={openmeter}>
+      <UsageComponent />
+      {/* ... */}
+    </OpenMeterProvider>
+  )
+}
 
-List grants.
+function UsageComponent() {
+  // get openmeter client from context
+  const openmeter = useOpenMeter()
 
-```ts
-const grants = await openmeter.grants.list()
+  // ...
+}
 ```

package/dist/cjs/index.cjs

@@ -14,38 +14,5 @@ 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.OpenMeter = exports.WindowSize = exports.MeterAggregation = void 0;
-const entitlement_js_1 = require("./clients/entitlement.cjs");
-const event_js_1 = require("./clients/event.cjs");
-const feature_js_1 = require("./clients/feature.cjs");
-const grant_js_1 = require("./clients/grant.cjs");
-const meter_js_1 = require("./clients/meter.cjs");
-const notifications_js_1 = require("./clients/notifications.cjs");
-const portal_js_1 = require("./clients/portal.cjs");
-const subject_js_1 = require("./clients/subject.cjs");
-var meter_js_2 = require("./clients/meter.cjs");
-Object.defineProperty(exports, "MeterAggregation", { enumerable: true, get: function () { return meter_js_2.MeterAggregation; } });
-Object.defineProperty(exports, "WindowSize", { enumerable: true, get: function () { return meter_js_2.WindowSize; } });
-__exportStar(require("./clients/notifications.cjs"), exports);
-class OpenMeter {
-    events;
-    meters;
-    portal;
-    subjects;
-    features;
-    entitlements;
-    grants;
-    notification;
-    constructor(config) {
-        this.events = new event_js_1.EventsClient(config);
-        this.meters = new meter_js_1.MetersClient(config);
-        this.portal = new portal_js_1.PortalClient(config);
-        this.subjects = new subject_js_1.SubjectClient(config);
-        this.features = new feature_js_1.FeatureClient(config);
-        this.entitlements = new entitlement_js_1.EntitlementClient(config);
-        this.grants = new grant_js_1.GrantClient(config);
-        this.notification = new notifications_js_1.NotificationClient(config);
-    }
-}
-exports.OpenMeter = OpenMeter;
+__exportStar(require("./src/client/index.cjs"), exports);
 //# sourceMappingURL=index.js.map

package/dist/cjs/index.d.cts

@@ -1,24 +1 @@
-import { OpenMeterConfig } from './clients/client.cjs';
-import { EntitlementClient } from './clients/entitlement.cjs';
-import { EventsClient } from './clients/event.cjs';
-import { FeatureClient } from './clients/feature.cjs';
-import { GrantClient } from './clients/grant.cjs';
-import { MetersClient } from './clients/meter.cjs';
-import { NotificationClient } from './clients/notifications.cjs';
-import { PortalClient } from './clients/portal.cjs';
-import { SubjectClient } from './clients/subject.cjs';
-export { OpenMeterConfig, RequestOptions } from './clients/client.cjs';
-export { Event, IngestedEvent, CloudEvent } from './clients/event.cjs';
-export { Meter, MeterAggregation, WindowSize } from './clients/meter.cjs';
-export * from './clients/notifications.cjs';
-export declare class OpenMeter {
-    events: EventsClient;
-    meters: MetersClient;
-    portal: PortalClient;
-    subjects: SubjectClient;
-    features: FeatureClient;
-    entitlements: EntitlementClient;
-    grants: GrantClient;
-    notification: NotificationClient;
-    constructor(config: OpenMeterConfig);
-}
+export * from './src/client/index.cjs';

package/dist/cjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AACA,6DAA4D;AAC5D,iDAAiD;AACjD,qDAAoD;AACpD,iDAAgD;AAChD,iDAAiD;AACjD,iEAA+D;AAC/D,mDAAkD;AAClD,qDAAoD;AAIpD,+CAAwE;AAAxD,4GAAA,gBAAgB,OAAA;AAAE,sGAAA,UAAU,OAAA;AAC5C,6DAA0C;AAE1C,MAAa,SAAS;IACb,MAAM,CAAc;IACpB,MAAM,CAAc;IACpB,MAAM,CAAc;IACpB,QAAQ,CAAe;IACvB,QAAQ,CAAe;IACvB,YAAY,CAAmB;IAC/B,MAAM,CAAa;IACnB,YAAY,CAAoB;IAEvC,YAAY,MAAuB;QACjC,IAAI,CAAC,MAAM,GAAG,IAAI,uBAAY,CAAC,MAAM,CAAC,CAAA;QACtC,IAAI,CAAC,MAAM,GAAG,IAAI,uBAAY,CAAC,MAAM,CAAC,CAAA;QACtC,IAAI,CAAC,MAAM,GAAG,IAAI,wBAAY,CAAC,MAAM,CAAC,CAAA;QACtC,IAAI,CAAC,QAAQ,GAAG,IAAI,0BAAa,CAAC,MAAM,CAAC,CAAA;QACzC,IAAI,CAAC,QAAQ,GAAG,IAAI,0BAAa,CAAC,MAAM,CAAC,CAAA;QACzC,IAAI,CAAC,YAAY,GAAG,IAAI,kCAAiB,CAAC,MAAM,CAAC,CAAA;QACjD,IAAI,CAAC,MAAM,GAAG,IAAI,sBAAW,CAAC,MAAM,CAAC,CAAA;QACrC,IAAI,CAAC,YAAY,GAAG,IAAI,qCAAkB,CAAC,MAAM,CAAC,CAAA;IACpD,CAAC;CACF;AApBD,8BAoBC"}
+{"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