lago-javascript-client 0.19.4-alpha

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Lago
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,115 @@
+# Lago JavaScript Client
+
+This is a JavaScript wrapper for Lago API. Works in Cloudflare Workers, Deno, and Node.js. Generated from [the Lago Swagger document](https://swagger.getlago.com/#/).
+
+[![PyPI version](https://badge.fury.io/js/lago-javascript-client.svg)](https://badge.fury.io/js/lago-javascript-client)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://spdx.org/licenses/MIT.html)
+
+## Installation
+
+For npm users:
+
+```bash
+npm install lago-javascript-client
+```
+
+```typescript
+// npm
+import { Client, getLagoError } from 'lago-javascript-client';
+
+// Deno
+import { Client, getLagoError } from 'https://deno.land/x/lago/mod.ts';
+
+const lagoClient = Client('__YOUR_API_KEY__');
+
+try {
+    const { data } = await lagoClient.billableMetrics.createBillableMetric(billableMetric);
+} catch (error) {
+    const lagoError = await getLagoError<typeof lagoClient.billableMetrics.createBillableMetric>(error);
+}
+```
+
+## Compatibility
+
+This SDK uses the [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) and natively supported Node.js version >= 18. For other Node versions:
+
+1. Ideally, run Node with the [`--experimental-fetch` flag](https://nodejs.org/docs/latest-v16.x/api/cli.html#--experimental-fetch)
+
+1. Otherwise, polyfill the Fetch API by doing both:
+
+    1. [Patching globalThis](https://github.com/node-fetch/node-fetch#providing-global-access)
+
+    1. [Pass a Fetch instance](https://github.com/node-fetch/node-fetch#loading-and-configuring-the-module) to the Lago client
+
+        ```typescript
+        import { Client } from 'lago-javascript-client';
+        import fetch from 'node-fetch';
+
+        const lagoClient = Client("api_key", { customFetch: fetch });
+        ```
+
+## Usage
+
+Check the [Lago API reference](https://doc.getlago.com/docs/api/intro)
+
+### Error handling
+
+Use the get `getLagoError<>()` utility function to extract the error object and TypeScript type:
+
+```typescript
+try {
+    const { data } = await lagoClient.billableMetrics.createBillableMetric(billableMetric);
+} catch (error) {
+    const lagoError = await getLagoError<typeof lagoClient.billableMetrics.createBillableMetric>(error);
+}
+```
+
+## Development
+
+Uses [dnt](https://github.com/denoland/dnt) to build and test for Deno and Node.
+
+### Release new version
+
+Change the affected fields in `scripts/build_npm.ts` and commit to GitHub. GitHub Actions will build and deploy to npm.
+
+### Dependencies
+
+Requires [Deno](https://deno.land/) and [Node.js >= 18](https://nodejs.org/en/)
+
+### Generate client from Swagger
+
+```bash
+deno task generate:swagger
+```
+
+### Run tests
+
+```bash
+deno task test
+```
+
+### Build
+
+```bash
+deno task build
+```
+
+### Publish to npm
+
+```bash
+deno task build
+cd npm
+npm publish
+```
+
+## Documentation
+
+The Lago documentation is available at [doc.getlago.com](https://doc.getlago.com/docs/api/intro).
+
+## Contributing
+
+The contribution documentation is available [here](https://github.com/getlago/lago-javascript-client/blob/main/CONTRIBUTING.md)
+
+## License
+
+Lago Node.js client is distributed under [AGPL-3.0](LICENSE).

package/esm/mod.js

@@ -0,0 +1,33 @@
+// deno-lint-ignore-file no-explicit-any
+import { Api } from "./swagger/client.js";
+export const Client = (apiKey, apiConfig) => {
+    const api = new Api({
+        securityWorker: (apiKey) => apiKey ? { headers: { Authorization: `Bearer ${apiKey}` } } : {},
+        // Cloudflare Workers doesn't support some options like credentials so need to override default
+        baseApiParams: {
+            redirect: "follow",
+        },
+        ...apiConfig,
+    });
+    api.setSecurityData(apiKey);
+    return api;
+};
+// https://github.com/remix-run/remix/blob/ef26f7671a9619966a6cfa3c39e196d44fbf32cf/packages/remix-server-runtime/responses.ts#L60
+function isResponse(value) {
+    return (value != null &&
+        typeof value.status === "number" &&
+        typeof value.statusText === "string" &&
+        typeof value.headers === "object" &&
+        typeof value.body !== "undefined");
+}
+export async function getLagoError(error) {
+    if (isResponse(error)) {
+        if (!error.bodyUsed) {
+            const errorJson = await error.json();
+            return errorJson;
+        }
+        return error.error;
+    }
+    throw new Error(error);
+}
+export * from "./swagger/client.js";

package/esm/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}