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

package/Makefile

@@ -0,0 +1,43 @@
+# A Self-Documenting Makefile: http://marmelab.com/blog/2016/02/29/auto-documented-makefile.html
+
+.PHONY: generate
+generate: ## Generate JavaScript SDK
+	$(call print-target)
+	pnpm --frozen-lockfile install
+	pnpm run generate
+	pnpm build
+	pnpm test
+
+# Warning: keep in sync with .dagger/release.go for now
+.PHONY: publish-javascript-sdk
+publish-javascript-sdk: ## Publish JavaScript SDK
+	$(call print-target)
+	@if [ -z "$$JS_SDK_RELEASE_VERSION" ]; then \
+		echo "ERROR: JS_SDK_RELEASE_VERSION is required"; \
+		echo "Usage: JS_SDK_RELEASE_VERSION=1.2.3 make publish-javascript-sdk [JS_SDK_RELEASE_TAG=beta]"; \
+		exit 1; \
+	fi
+
+	@if [ -z "$$JS_SDK_RELEASE_TAG" ]; then \
+		echo "ERROR: JS_SDK_RELEASE_TAG is required"; \
+		echo "Usage: JS_SDK_RELEASE_VERSION=1.2.3 make publish-javascript-sdk [JS_SDK_RELEASE_TAG=beta]"; \
+		exit 1; \
+	fi
+
+	pnpm --frozen-lockfile install
+	pnpm version "$${JS_SDK_RELEASE_VERSION}" --no-git-tag-version
+	CACHE_BUSTER="$$(date --rfc-3339=seconds)" pnpm publish --no-git-checks --tag "$${JS_SDK_RELEASE_TAG}"
+	@echo "✅ Published $${JS_SDK_RELEASE_TAG} JavaScript SDK version $${JS_SDK_RELEASE_VERSION} with tag $${JS_SDK_RELEASE_TAG}"
+
+.PHONY: help
+.DEFAULT_GOAL := help
+help:
+	@grep -h -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
+
+# Variable outputting/exporting rules
+var-%: ; @echo $($*)
+varexport-%: ; @echo $*=$($*)
+
+define print-target
+    @printf "Executing target: \033[36m$@\033[0m\n"
+endef

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/addons.cjs

@@ -0,0 +1,105 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Addons = void 0;
+const utils_js_1 = require("./utils.cjs");
+class Addons {
+    client;
+    constructor(client) {
+        this.client = client;
+    }
+    /**
+     * Create a addon
+     * @param addon - The addon to create
+     * @param options - Optional request options
+     * @returns The created addon
+     */
+    async create(addon, options) {
+        const resp = await this.client.POST('/api/v1/addons', {
+            body: addon,
+            ...options,
+        });
+        return (0, utils_js_1.transformResponse)(resp);
+    }
+    /**
+     * List addons
+     * @param params - Optional parameters for listing addons
+     * @param options - Optional request options
+     * @returns A list of addons
+     */
+    async list(params, options) {
+        const resp = await this.client.GET('/api/v1/addons', {
+            params: { query: params },
+            ...options,
+        });
+        return (0, utils_js_1.transformResponse)(resp);
+    }
+    /**
+     * Get an addon by ID
+     * @param addonId - The ID of the addon to retrieve
+     * @param options - Optional request options
+     * @returns The addon
+     */
+    async get(addonId, options) {
+        const resp = await this.client.GET('/api/v1/addons/{addonId}', {
+            params: { path: { addonId } },
+            ...options,
+        });
+        return (0, utils_js_1.transformResponse)(resp);
+    }
+    /**
+     * Update an addon
+     * @param addonId - The ID of the addon to update
+     * @param addon - The addon data to update
+     * @param options - Optional request options
+     * @returns The updated addon
+     */
+    async update(addonId, addon, options) {
+        const resp = await this.client.PUT('/api/v1/addons/{addonId}', {
+            body: addon,
+            params: { path: { addonId } },
+            ...options,
+        });
+        return (0, utils_js_1.transformResponse)(resp);
+    }
+    /**
+     * Delete an addon by ID
+     * @param addonId - The ID of the addon to delete
+     * @param options - Optional request options
+     * @returns void or standard error response structure
+     */
+    async delete(addonId, options) {
+        const resp = await this.client.DELETE('/api/v1/addons/{addonId}', {
+            params: { path: { addonId } },
+            ...options,
+        });
+        return (0, utils_js_1.transformResponse)(resp);
+    }
+    /**
+     * Publish an addon
+     * @param addonId - The ID of the addon to publish
+     * @param options - Optional request options
+     * @returns The published addon
+     */
+    async publish(addonId, options) {
+        const resp = await this.client.POST('/api/v1/addons/{addonId}/publish', {
+            params: { path: { addonId } },
+            ...options,
+        });
+        return (0, utils_js_1.transformResponse)(resp);
+    }
+    /**
+     * Archive an addon
+     * @param addonId - The ID of the addon to archive
+     * @param options - Optional request options
+     * @returns The archived addon
+     */
+    async archive(addonId, options) {
+        const resp = await this.client.POST('/api/v1/addons/{addonId}/archive', {
+            params: { path: { addonId } },
+            ...options,
+        });
+        return (0, utils_js_1.transformResponse)(resp);
+    }
+}
+exports.Addons = Addons;
+//# sourceMappingURL=addons.js.map

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

@@ -0,0 +1,152 @@
+import type { RequestOptions } from './common.cjs';
+import type { paths, AddonCreate, operations } from './schemas.cjs';
+import type { Client } from 'openapi-fetch';
+export declare class Addons {
+    private client;
+    constructor(client: Client<paths, `${string}/${string}`>);
+    /**
+     * Create a addon
+     * @param addon - The addon to create
+     * @param options - Optional request options
+     * @returns The created addon
+     */
+    create(addon: AddonCreate, options?: RequestOptions): Promise<{
+        readonly id: string;
+        name: string;
+        description?: string;
+        metadata?: import("./schemas.cjs").components["schemas"]["Metadata"] | null;
+        readonly createdAt: Date;
+        readonly updatedAt: Date;
+        readonly deletedAt?: Date;
+        key: string;
+        readonly annotations?: import("./schemas.cjs").components["schemas"]["Annotations"];
+        readonly version: number;
+        instanceType: import("./schemas.cjs").components["schemas"]["AddonInstanceType"];
+        currency: import("./schemas.cjs").components["schemas"]["CurrencyCode"];
+        readonly effectiveFrom?: Date;
+        readonly effectiveTo?: Date;
+        readonly status: import("./schemas.cjs").components["schemas"]["AddonStatus"];
+        rateCards: import("./schemas.cjs").components["schemas"]["RateCard"][];
+        readonly validationErrors: import("./schemas.cjs").components["schemas"]["ValidationError"][] | null;
+    }>;
+    /**
+     * List addons
+     * @param params - Optional parameters for listing addons
+     * @param options - Optional request options
+     * @returns A list of addons
+     */
+    list(params?: operations['listAddons']['parameters']['query'], options?: RequestOptions): Promise<{
+        totalCount: number;
+        page: number;
+        pageSize: number;
+        items: import("./schemas.cjs").components["schemas"]["Addon"][];
+    }>;
+    /**
+     * Get an addon by ID
+     * @param addonId - The ID of the addon to retrieve
+     * @param options - Optional request options
+     * @returns The addon
+     */
+    get(addonId: string, options?: RequestOptions): Promise<{
+        readonly id: string;
+        name: string;
+        description?: string;
+        metadata?: import("./schemas.cjs").components["schemas"]["Metadata"] | null;
+        readonly createdAt: Date;
+        readonly updatedAt: Date;
+        readonly deletedAt?: Date;
+        key: string;
+        readonly annotations?: import("./schemas.cjs").components["schemas"]["Annotations"];
+        readonly version: number;
+        instanceType: import("./schemas.cjs").components["schemas"]["AddonInstanceType"];
+        currency: import("./schemas.cjs").components["schemas"]["CurrencyCode"];
+        readonly effectiveFrom?: Date;
+        readonly effectiveTo?: Date;
+        readonly status: import("./schemas.cjs").components["schemas"]["AddonStatus"];
+        rateCards: import("./schemas.cjs").components["schemas"]["RateCard"][];
+        readonly validationErrors: import("./schemas.cjs").components["schemas"]["ValidationError"][] | null;
+    }>;
+    /**
+     * Update an addon
+     * @param addonId - The ID of the addon to update
+     * @param addon - The addon data to update
+     * @param options - Optional request options
+     * @returns The updated addon
+     */
+    update(addonId: string, addon: operations['updateAddon']['requestBody']['content']['application/json'], options?: RequestOptions): Promise<{
+        readonly id: string;
+        name: string;
+        description?: string;
+        metadata?: import("./schemas.cjs").components["schemas"]["Metadata"] | null;
+        readonly createdAt: Date;
+        readonly updatedAt: Date;
+        readonly deletedAt?: Date;
+        key: string;
+        readonly annotations?: import("./schemas.cjs").components["schemas"]["Annotations"];
+        readonly version: number;
+        instanceType: import("./schemas.cjs").components["schemas"]["AddonInstanceType"];
+        currency: import("./schemas.cjs").components["schemas"]["CurrencyCode"];
+        readonly effectiveFrom?: Date;
+        readonly effectiveTo?: Date;
+        readonly status: import("./schemas.cjs").components["schemas"]["AddonStatus"];
+        rateCards: import("./schemas.cjs").components["schemas"]["RateCard"][];
+        readonly validationErrors: import("./schemas.cjs").components["schemas"]["ValidationError"][] | null;
+    }>;
+    /**
+     * Delete an addon by ID
+     * @param addonId - The ID of the addon to delete
+     * @param options - Optional request options
+     * @returns void or standard error response structure
+     */
+    delete(addonId: string, options?: RequestOptions): Promise<undefined>;
+    /**
+     * Publish an addon
+     * @param addonId - The ID of the addon to publish
+     * @param options - Optional request options
+     * @returns The published addon
+     */
+    publish(addonId: string, options?: RequestOptions): Promise<{
+        readonly id: string;
+        name: string;
+        description?: string;
+        metadata?: import("./schemas.cjs").components["schemas"]["Metadata"] | null;
+        readonly createdAt: Date;
+        readonly updatedAt: Date;
+        readonly deletedAt?: Date;
+        key: string;
+        readonly annotations?: import("./schemas.cjs").components["schemas"]["Annotations"];
+        readonly version: number;
+        instanceType: import("./schemas.cjs").components["schemas"]["AddonInstanceType"];
+        currency: import("./schemas.cjs").components["schemas"]["CurrencyCode"];
+        readonly effectiveFrom?: Date;
+        readonly effectiveTo?: Date;
+        readonly status: import("./schemas.cjs").components["schemas"]["AddonStatus"];
+        rateCards: import("./schemas.cjs").components["schemas"]["RateCard"][];
+        readonly validationErrors: import("./schemas.cjs").components["schemas"]["ValidationError"][] | null;
+    }>;
+    /**
+     * Archive an addon
+     * @param addonId - The ID of the addon to archive
+     * @param options - Optional request options
+     * @returns The archived addon
+     */
+    archive(addonId: string, options?: RequestOptions): Promise<{
+        readonly id: string;
+        name: string;
+        description?: string;
+        metadata?: import("./schemas.cjs").components["schemas"]["Metadata"] | null;
+        readonly createdAt: Date;
+        readonly updatedAt: Date;
+        readonly deletedAt?: Date;
+        key: string;
+        readonly annotations?: import("./schemas.cjs").components["schemas"]["Annotations"];
+        readonly version: number;
+        instanceType: import("./schemas.cjs").components["schemas"]["AddonInstanceType"];
+        currency: import("./schemas.cjs").components["schemas"]["CurrencyCode"];
+        readonly effectiveFrom?: Date;
+        readonly effectiveTo?: Date;
+        readonly status: import("./schemas.cjs").components["schemas"]["AddonStatus"];
+        rateCards: import("./schemas.cjs").components["schemas"]["RateCard"][];
+        readonly validationErrors: import("./schemas.cjs").components["schemas"]["ValidationError"][] | null;
+    }>;
+}

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

@@ -0,0 +1 @@
+{"version":3,"file":"addons.js","sourceRoot":"","sources":["../../../../src/client/addons.ts"],"names":[],"mappings":";;;AAAA,yCAA8C;AAK9C,MAAa,MAAM;IACG;IAApB,YAAoB,MAA4C;QAA5C,WAAM,GAAN,MAAM,CAAsC;IAAG,CAAC;IAEpE;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CAAC,KAAkB,EAAE,OAAwB;QAC9D,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,gBAAgB,EAAE;YACpD,IAAI,EAAE,KAAK;YACX,GAAG,OAAO;SACX,CAAC,CAAA;QAEF,OAAO,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,IAAI,CACf,MAAwD,EACxD,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,gBAAgB,EAAE;YACnD,MAAM,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE;YACzB,GAAG,OAAO;SACX,CAAC,CAAA;QAEF,OAAO,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,GAAG,CAAC,OAAe,EAAE,OAAwB;QACxD,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,0BAA0B,EAAE;YAC7D,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,EAAE;YAC7B,GAAG,OAAO;SACX,CAAC,CAAA;QAEF,OAAO,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;;OAMG;IACI,KAAK,CAAC,MAAM,CACjB,OAAe,EACf,KAA8E,EAC9E,OAAwB;QAExB,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,0BAA0B,EAAE;YAC7D,IAAI,EAAE,KAAK;YACX,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,EAAE;YAC7B,GAAG,OAAO;SACX,CAAC,CAAA;QAEF,OAAO,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,MAAM,CAAC,OAAe,EAAE,OAAwB;QAC3D,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,0BAA0B,EAAE;YAChE,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,EAAE;YAC7B,GAAG,OAAO;SACX,CAAC,CAAA;QAEF,OAAO,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,OAAO,CAAC,OAAe,EAAE,OAAwB;QAC5D,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,kCAAkC,EAAE;YACtE,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,EAAE;YAC7B,GAAG,OAAO;SACX,CAAC,CAAA;QAEF,OAAO,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAA;IAChC,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,OAAO,CAAC,OAAe,EAAE,OAAwB;QAC5D,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,kCAAkC,EAAE;YACtE,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,EAAE;YAC7B,GAAG,OAAO;SACX,CAAC,CAAA;QAEF,OAAO,IAAA,4BAAiB,EAAC,IAAI,CAAC,CAAA;IAChC,CAAC;CACF;AApHD,wBAoHC"}