@ssubedir/open-spanner 0.1.0

package/README.md

@@ -0,0 +1,19 @@
+# Open Spanner TypeScript SDK
+
+Small TypeScript/JavaScript client stub for Open Spanner.
+
+```ts
+import { OpenSpannerClient } from "@ssubedir/open-spanner";
+
+const client = new OpenSpannerClient({
+  baseUrl: "http://localhost:18081",
+});
+
+await client.createUsage({
+  meter: "api_requests",
+  subject: "org_123",
+  quantity: 1,
+});
+```
+
+Types are generated from `../../docs/sdk-openapi.json` with `openapi-typescript`. The handwritten code is only a small `fetch` wrapper around those generated OpenAPI types.

package/dist/index.d.ts

@@ -0,0 +1,41 @@
+import type { components, paths } from "./schema.js";
+export interface OpenSpannerClientOptions {
+    baseUrl: string;
+    fetch?: typeof fetch;
+    headers?: HeadersInit;
+}
+export type ErrorBody = components["schemas"]["ErrorBody"];
+export type ErrorResponse = components["schemas"]["ErrorResponse"];
+export type Meter = components["schemas"]["Meter"];
+export type MeterCreateRequest = components["schemas"]["MeterCreateRequest"];
+export type MeterUpdateRequest = components["schemas"]["MeterUpdateRequest"];
+export type MeterListResponse = components["schemas"]["MeterListResponse"];
+export type UsageCreateRequest = components["schemas"]["UsageCreateRequest"];
+export type UsageEvent = components["schemas"]["UsageEvent"];
+export type UsageBulkResult = components["schemas"]["UsageBulkResult"];
+export type UsageBucket = components["schemas"]["UsageBucket"];
+export type UsageBucketListResponse = paths["/v1/usages"]["get"]["responses"]["200"]["content"]["application/json"];
+export type ListMetersParams = NonNullable<paths["/v1/meters"]["get"]["parameters"]["query"]>;
+export type ListUsageBucketsParams = NonNullable<paths["/v1/usages"]["get"]["parameters"]["query"]>;
+export declare class OpenSpannerError extends Error {
+    readonly status: number;
+    readonly body: unknown;
+    constructor(status: number, body: unknown);
+}
+export declare class OpenSpannerClient {
+    private readonly baseUrl;
+    private readonly fetchFn;
+    private readonly headers?;
+    constructor(options: OpenSpannerClientOptions);
+    health(): Promise<void>;
+    createMeter(input: MeterCreateRequest): Promise<Meter>;
+    listMeters(params?: ListMetersParams): Promise<MeterListResponse>;
+    getMeter(name: string): Promise<Meter>;
+    updateMeter(name: string, input: MeterUpdateRequest): Promise<Meter>;
+    deleteMeter(name: string): Promise<void>;
+    createUsage(input: UsageCreateRequest): Promise<UsageEvent>;
+    createUsageBulk(input: UsageCreateRequest[]): Promise<UsageBulkResult>;
+    listUsageBuckets(params: ListUsageBucketsParams): Promise<UsageBucketListResponse>;
+    private request;
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AAErD,MAAM,WAAW,wBAAwB;IACvC,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,OAAO,KAAK,CAAC;IACrB,OAAO,CAAC,EAAE,WAAW,CAAC;CACvB;AAED,MAAM,MAAM,SAAS,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,WAAW,CAAC,CAAC;AAC3D,MAAM,MAAM,aAAa,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,eAAe,CAAC,CAAC;AACnE,MAAM,MAAM,KAAK,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,OAAO,CAAC,CAAC;AACnD,MAAM,MAAM,kBAAkB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,oBAAoB,CAAC,CAAC;AAC7E,MAAM,MAAM,kBAAkB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,oBAAoB,CAAC,CAAC;AAC7E,MAAM,MAAM,iBAAiB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,mBAAmB,CAAC,CAAC;AAC3E,MAAM,MAAM,kBAAkB,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,oBAAoB,CAAC,CAAC;AAC7E,MAAM,MAAM,UAAU,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,YAAY,CAAC,CAAC;AAC7D,MAAM,MAAM,eAAe,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,iBAAiB,CAAC,CAAC;AACvE,MAAM,MAAM,WAAW,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,aAAa,CAAC,CAAC;AAC/D,MAAM,MAAM,uBAAuB,GACjC,KAAK,CAAC,YAAY,CAAC,CAAC,KAAK,CAAC,CAAC,WAAW,CAAC,CAAC,KAAK,CAAC,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CAAC;AAChF,MAAM,MAAM,gBAAgB,GAAG,WAAW,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;AAC9F,MAAM,MAAM,sBAAsB,GAAG,WAAW,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;AAEpG,qBAAa,gBAAiB,SAAQ,KAAK;IACzC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;gBAEX,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,OAAO;CAM1C;AAED,qBAAa,iBAAiB;IAC5B,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAe;IACvC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAc;gBAE3B,OAAO,EAAE,wBAAwB;IAM7C,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAIvB,WAAW,CAAC,KAAK,EAAE,kBAAkB,GAAG,OAAO,CAAC,KAAK,CAAC;IAItD,UAAU,CAAC,MAAM,GAAE,gBAAqB,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAIrE,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,KAAK,CAAC;IAItC,WAAW,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,kBAAkB,GAAG,OAAO,CAAC,KAAK,CAAC;IAIpE,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAIxC,WAAW,CAAC,KAAK,EAAE,kBAAkB,GAAG,OAAO,CAAC,UAAU,CAAC;IAI3D,eAAe,CAAC,KAAK,EAAE,kBAAkB,EAAE,GAAG,OAAO,CAAC,eAAe,CAAC;IAItE,gBAAgB,CAAC,MAAM,EAAE,sBAAsB,GAAG,OAAO,CAAC,uBAAuB,CAAC;YAIpE,OAAO;CAoBtB"}

package/dist/index.js

@@ -0,0 +1,86 @@
+export class OpenSpannerError extends Error {
+    status;
+    body;
+    constructor(status, body) {
+        super(`Open Spanner request failed with status ${status}`);
+        this.name = "OpenSpannerError";
+        this.status = status;
+        this.body = body;
+    }
+}
+export class OpenSpannerClient {
+    baseUrl;
+    fetchFn;
+    headers;
+    constructor(options) {
+        this.baseUrl = options.baseUrl.replace(/\/+$/, "");
+        this.fetchFn = options.fetch ?? fetch;
+        this.headers = options.headers;
+    }
+    health() {
+        return this.request("GET", "/health");
+    }
+    createMeter(input) {
+        return this.request("POST", "/v1/meters", input);
+    }
+    listMeters(params = {}) {
+        return this.request("GET", `/v1/meters${toQuery(params)}`);
+    }
+    getMeter(name) {
+        return this.request("GET", `/v1/meters/${encodeURIComponent(name)}`);
+    }
+    updateMeter(name, input) {
+        return this.request("PUT", `/v1/meters/${encodeURIComponent(name)}`, input);
+    }
+    deleteMeter(name) {
+        return this.request("DELETE", `/v1/meters/${encodeURIComponent(name)}`);
+    }
+    createUsage(input) {
+        return this.request("POST", "/v1/usages", input);
+    }
+    createUsageBulk(input) {
+        return this.request("POST", "/v1/usages/bulk", input);
+    }
+    listUsageBuckets(params) {
+        return this.request("GET", `/v1/usages${toQuery(params)}`);
+    }
+    async request(method, path, body) {
+        const response = await this.fetchFn(`${this.baseUrl}${path}`, {
+            body: body === undefined ? undefined : JSON.stringify(body),
+            headers: {
+                ...this.headers,
+                ...(body === undefined ? {} : { "Content-Type": "application/json" }),
+            },
+            method,
+        });
+        if (!response.ok) {
+            throw new OpenSpannerError(response.status, await readBody(response));
+        }
+        if (response.status === 204) {
+            return undefined;
+        }
+        return (await response.json());
+    }
+}
+function toQuery(params) {
+    const query = new URLSearchParams();
+    for (const [key, value] of Object.entries(params)) {
+        if (typeof value === "string" && value !== "") {
+            query.set(key, value);
+        }
+    }
+    const encoded = query.toString();
+    return encoded ? `?${encoded}` : "";
+}
+async function readBody(response) {
+    const text = await response.text();
+    if (!text) {
+        return undefined;
+    }
+    try {
+        return JSON.parse(text);
+    }
+    catch {
+        return text;
+    }
+}