@unkey/api 0.34.0 → 2.0.0-alpha.2

package/README.md

@@ -1,118 +1,473 @@
-<div align="center">
-    <h1 align="center">@unkey/api</h1>
-    <h5>`@unkey/api` is a TypeScript client for Unkey. If you prefer a typed experience over calling HTTP endpoints directly, this SDK is for you.</h5>
-</div>
+# @unkey/api
+
+Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@unkey/api* API.
 
-<div align="center">
-  <a href="https://www.unkey.com/docs/libraries/ts/sdk/overview">Documentation</a>
+<div align="left">
+    <a href="https://www.speakeasy.com/?utm_source=@unkey/api&utm_campaign=typescript"><img src="https://custom-icon-badges.demolab.com/badge/-Built%20By%20Speakeasy-212015?style=for-the-badge&logoColor=FBE331&logo=speakeasy&labelColor=545454" /></a>
+    <a href="https://opensource.org/licenses/MIT">
+        <img src="https://img.shields.io/badge/License-MIT-blue.svg" style="width: 100px; height: 28px;" />
+    </a>
 </div>
-<br/>
 
-## Installation
+
+<br /><br />
+> [!IMPORTANT]
+> This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your [workspace](https://app.speakeasy.com/org/unkey/unkey). Delete this section before > publishing to a package manager.
+
+<!-- Start Summary [summary] -->
+## Summary
+
+
+<!-- End Summary [summary] -->
+
+<!-- Start Table of Contents [toc] -->
+## Table of Contents
+<!-- $toc-max-depth=2 -->
+* [@unkey/api](#unkeyapi)
+  * [SDK Installation](#sdk-installation)
+  * [Requirements](#requirements)
+  * [SDK Example Usage](#sdk-example-usage)
+  * [Authentication](#authentication)
+  * [Available Resources and Operations](#available-resources-and-operations)
+  * [Standalone functions](#standalone-functions)
+  * [Retries](#retries)
+  * [Error Handling](#error-handling)
+  * [Server Selection](#server-selection)
+  * [Custom HTTP Client](#custom-http-client)
+  * [Debugging](#debugging)
+* [Development](#development)
+  * [Maturity](#maturity)
+  * [Contributions](#contributions)
+
+<!-- End Table of Contents [toc] -->
+
+<!-- Start SDK Installation [installation] -->
+## SDK Installation
+
+The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https://pnpm.io/), [bun](https://bun.sh/) or [yarn](https://classic.yarnpkg.com/en/) package managers.
+
+### NPM
 
 ```bash
-npm install @unkey/api
+npm add @unkey/api
 ```
 
-## Quickstart
+### PNPM
 
-1.  Create a new Unkey Root Key in the settings.
-2.  Use the root key to initialize the client:
+```bash
+pnpm add @unkey/api
+```
 
-```ts
-import { Unkey } from "@unkey/api";
+### Bun
 
-const unkey = new Unkey({ rootKey: "<UNKEY_ROOT_KEY>" });
+```bash
+bun add @unkey/api
 ```
 
-**Important:** Always keep your root key safe and reset it if you suspect it has been compromised.
+### Yarn
 
-## Usage
+```bash
+yarn add @unkey/api zod
+
+# Note that Yarn does not install peer dependencies automatically. You will need
+# to install zod as shown above.
+```
+
+> [!NOTE]
+> This package is published with CommonJS and ES Modules (ESM) support.
+<!-- End SDK Installation [installation] -->
+
+<!-- Start Requirements [requirements] -->
+## Requirements
+
+For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
+<!-- End Requirements [requirements] -->
+
+<!-- Start SDK Example Usage [usage] -->
+## SDK Example Usage
 
-### Verifying a Key
+### Example
 
-```ts
-import { verifyKey } from "@unkey/api";
+```typescript
+import { Unkey } from "@unkey/api";
+
+const unkey = new Unkey({
+  rootKey: "UNKEY_ROOT_KEY",
+});
 
-const { result, error } = await verifyKey("key_123");
+async function run() {
+  const result = await unkey.ratelimit.limit({
+    namespace: "sms.sign_up",
+    duration: 455106,
+    identifier: "<value>",
+    limit: 568662,
+  });
 
-if (error) {
-  console.error(error.message);
-  // Handle potential network or bad request error
-  // A link to our docs will be in the `error.docs` field
-  return;
+  // Handle the result
+  console.log(result);
 }
 
-if (!result.valid) {
-  // Do not grant access
-  return;
+run();
+
+```
+<!-- End SDK Example Usage [usage] -->
+
+<!-- Start Authentication [security] -->
+## Authentication
+
+### Per-Client Security Schemes
+
+This SDK supports the following security scheme globally:
+
+| Name      | Type | Scheme      | Environment Variable |
+| --------- | ---- | ----------- | -------------------- |
+| `rootKey` | http | HTTP Bearer | `UNKEY_ROOT_KEY`     |
+
+To authenticate with the API the `rootKey` parameter must be set when initializing the SDK client instance. For example:
+```typescript
+import { Unkey } from "@unkey/api";
+
+const unkey = new Unkey({
+  rootKey: "UNKEY_ROOT_KEY",
+});
+
+async function run() {
+  const result = await unkey.ratelimit.limit({
+    namespace: "sms.sign_up",
+    duration: 455106,
+    identifier: "<value>",
+    limit: 568662,
+  });
+
+  // Handle the result
+  console.log(result);
 }
 
-// Process request
-console.log(result);
+run();
+
 ```
+<!-- End Authentication [security] -->
+
+<!-- Start Available Resources and Operations [operations] -->
+## Available Resources and Operations
+
+<details open>
+<summary>Available methods</summary>
+
+### [liveness](docs/sdks/liveness/README.md)
+
+* [check](docs/sdks/liveness/README.md#check) - Liveness check
 
-## Response Format
+### [ratelimit](docs/sdks/ratelimit/README.md)
 
-All methods return either an `error` or a `result` field, never both and never none. This approach helps with proper error handling.
+* [limit](docs/sdks/ratelimit/README.md#limit) - TODO
+* [setOverride](docs/sdks/ratelimit/README.md#setoverride)
+* [getOverride](docs/sdks/ratelimit/README.md#getoverride)
+* [deleteOverride](docs/sdks/ratelimit/README.md#deleteoverride)
 
-### Success Response
 
-```ts
-{
-  result: T; // The result depends on what method you called
+</details>
+<!-- End Available Resources and Operations [operations] -->
+
+<!-- Start Standalone functions [standalone-funcs] -->
+## Standalone functions
+
+All the methods listed above are available as standalone functions. These
+functions are ideal for use in applications running in the browser, serverless
+runtimes or other environments where application bundle size is a primary
+concern. When using a bundler to build your application, all unused
+functionality will be either excluded from the final bundle or tree-shaken away.
+
+To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
+
+<details>
+
+<summary>Available standalone functions</summary>
+
+- [`livenessCheck`](docs/sdks/liveness/README.md#check) - Liveness check
+- [`ratelimitDeleteOverride`](docs/sdks/ratelimit/README.md#deleteoverride)
+- [`ratelimitGetOverride`](docs/sdks/ratelimit/README.md#getoverride)
+- [`ratelimitLimit`](docs/sdks/ratelimit/README.md#limit) - TODO
+- [`ratelimitSetOverride`](docs/sdks/ratelimit/README.md#setoverride)
+
+</details>
+<!-- End Standalone functions [standalone-funcs] -->
+
+<!-- Start Retries [retries] -->
+## Retries
+
+Some of the endpoints in this SDK support retries.  If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API.  However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.
+
+To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:
+```typescript
+import { Unkey } from "@unkey/api";
+
+const unkey = new Unkey({
+  rootKey: "UNKEY_ROOT_KEY",
+});
+
+async function run() {
+  const result = await unkey.ratelimit.limit({
+    namespace: "sms.sign_up",
+    duration: 455106,
+    identifier: "<value>",
+    limit: 568662,
+  }, {
+    retries: {
+      strategy: "backoff",
+      backoff: {
+        initialInterval: 1,
+        maxInterval: 50,
+        exponent: 1.1,
+        maxElapsedTime: 100,
+      },
+      retryConnectionErrors: false,
+    },
+  });
+
+  // Handle the result
+  console.log(result);
 }
+
+run();
+
 ```
 
-### Error Response
+If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:
+```typescript
+import { Unkey } from "@unkey/api";
 
-```ts
-{
-  error: {
-    message: string;
-    docs: string; // URL to relevant documentation
-  }
+const unkey = new Unkey({
+  retryConfig: {
+    strategy: "backoff",
+    backoff: {
+      initialInterval: 1,
+      maxInterval: 50,
+      exponent: 1.1,
+      maxElapsedTime: 100,
+    },
+    retryConnectionErrors: false,
+  },
+  rootKey: "UNKEY_ROOT_KEY",
+});
+
+async function run() {
+  const result = await unkey.ratelimit.limit({
+    namespace: "sms.sign_up",
+    duration: 455106,
+    identifier: "<value>",
+    limit: 568662,
+  });
+
+  // Handle the result
+  console.log(result);
 }
+
+run();
+
 ```
+<!-- End Retries [retries] -->
 
-## Configuration Options
+<!-- Start Error Handling [errors] -->
+## Error Handling
 
-### Base URL
+Some methods specify known errors which can be thrown. All the known errors are enumerated in the `models/errors/errors.ts` module. The known errors for a method are documented under the *Errors* tables in SDK docs. For example, the `limit` method may throw the following errors:
 
-You can customize the base URL for all requests:
+| Error Type             | Status Code   | Content Type             |
+| ---------------------- | ------------- | ------------------------ |
+| errors.BadRequestError | 400           | application/problem+json |
+| errors.BaseError       | 401, 403, 404 | application/problem+json |
+| errors.BaseError       | 500           | application/problem+json |
+| errors.APIError        | 4XX, 5XX      | \*/\*                    |
+
+If the method throws an error and it is not captured by the known errors, it will default to throwing a `APIError`.
+
+```typescript
+import { Unkey } from "@unkey/api";
+import {
+  BadRequestError,
+  BaseError,
+  SDKValidationError,
+} from "@unkey/api/models/errors";
 
-```ts
 const unkey = new Unkey({
-  rootKey: "<UNKEY_ROOT_KEY>",
-  baseUrl: "https://my.domain",
+  rootKey: "UNKEY_ROOT_KEY",
 });
+
+async function run() {
+  let result;
+  try {
+    result = await unkey.ratelimit.limit({
+      namespace: "sms.sign_up",
+      duration: 455106,
+      identifier: "<value>",
+      limit: 568662,
+    });
+
+    // Handle the result
+    console.log(result);
+  } catch (err) {
+    switch (true) {
+      // The server response does not match the expected SDK schema
+      case (err instanceof SDKValidationError): {
+        // Pretty-print will provide a human-readable multi-line error message
+        console.error(err.pretty());
+        // Raw value may also be inspected
+        console.error(err.rawValue);
+        return;
+      }
+      case (err instanceof BadRequestError): {
+        // Handle err.data$: BadRequestErrorData
+        console.error(err);
+        return;
+      }
+      case (err instanceof BaseError): {
+        // Handle err.data$: BaseErrorData
+        console.error(err);
+        return;
+      }
+      case (err instanceof BaseError): {
+        // Handle err.data$: BaseErrorData
+        console.error(err);
+        return;
+      }
+      default: {
+        // Other errors such as network errors, see HTTPClientErrors for more details
+        throw err;
+      }
+    }
+  }
+}
+
+run();
+
 ```
 
-### Retries
+Validation errors can also occur when either method arguments or data returned from the server do not match the expected format. The `SDKValidationError` that is thrown as a result will capture the raw value that failed validation in an attribute called `rawValue`. Additionally, a `pretty()` method is available on this error that can be used to log a nicely formatted multi-line string since validation errors can list many issues and the plain error string may be difficult read when debugging.
+
+In some rare cases, the SDK can fail to get a response from the server or even make the request due to unexpected circumstances such as network conditions. These types of errors are captured in the `models/errors/httpclienterrors.ts` module:
+
+| HTTP Client Error                                    | Description                                          |
+| ---------------------------------------------------- | ---------------------------------------------------- |
+| RequestAbortedError                                  | HTTP request was aborted by the client               |
+| RequestTimeoutError                                  | HTTP request timed out due to an AbortSignal signal  |
+| ConnectionError                                      | HTTP client was unable to make a request to a server |
+| InvalidRequestError                                  | Any input used to create a request is invalid        |
+| UnexpectedClientError                                | Unrecognised or unexpected error                     |
+<!-- End Error Handling [errors] -->
 
-Configure retry behavior for network errors:
+<!-- Start Server Selection [server] -->
+## Server Selection
+
+### Override Server URL Per-Client
+
+The default server can be overridden globally by passing a URL to the `serverURL: string` optional parameter when initializing the SDK client instance. For example:
+```typescript
+import { Unkey } from "@unkey/api";
 
-```ts
 const unkey = new Unkey({
-  rootKey: "<UNKEY_ROOT_KEY>",
-  retry: {
-    attempts: 3,
-    backoff: (retryCount) => retryCount * 1000,
-  },
+  serverURL: "https://api.unkey.com",
+  rootKey: "UNKEY_ROOT_KEY",
 });
+
+async function run() {
+  const result = await unkey.ratelimit.limit({
+    namespace: "sms.sign_up",
+    duration: 455106,
+    identifier: "<value>",
+    limit: 568662,
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+
 ```
+<!-- End Server Selection [server] -->
 
-### Disable Telemetry
+<!-- Start Custom HTTP Client [http-client] -->
+## Custom HTTP Client
 
-To opt out of anonymous telemetry data collection:
+The TypeScript SDK makes API calls using an `HTTPClient` that wraps the native
+[Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API). This
+client is a thin wrapper around `fetch` and provides the ability to attach hooks
+around the request lifecycle that can be used to modify the request or handle
+errors and response.
 
-```ts
-const unkey = new Unkey({
-  rootKey: "<UNKEY_ROOT_KEY>",
-  disableTelemetry: true,
+The `HTTPClient` constructor takes an optional `fetcher` argument that can be
+used to integrate a third-party HTTP client or when writing tests to mock out
+the HTTP client and feed in fixtures.
+
+The following example shows how to use the `"beforeRequest"` hook to to add a
+custom header and a timeout to requests and how to use the `"requestError"` hook
+to log errors:
+
+```typescript
+import { Unkey } from "@unkey/api";
+import { HTTPClient } from "@unkey/api/lib/http";
+
+const httpClient = new HTTPClient({
+  // fetcher takes a function that has the same signature as native `fetch`.
+  fetcher: (request) => {
+    return fetch(request);
+  }
 });
+
+httpClient.addHook("beforeRequest", (request) => {
+  const nextRequest = new Request(request, {
+    signal: request.signal || AbortSignal.timeout(5000)
+  });
+
+  nextRequest.headers.set("x-custom-header", "custom value");
+
+  return nextRequest;
+});
+
+httpClient.addHook("requestError", (error, request) => {
+  console.group("Request Error");
+  console.log("Reason:", `${error}`);
+  console.log("Endpoint:", `${request.method} ${request.url}`);
+  console.groupEnd();
+});
+
+const sdk = new Unkey({ httpClient });
 ```
+<!-- End Custom HTTP Client [http-client] -->
+
+<!-- Start Debugging [debug] -->
+## Debugging
+
+You can setup your SDK to emit debug logs for SDK requests and responses.
+
+You can pass a logger that matches `console`'s interface as an SDK option.
+
+> [!WARNING]
+> Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.
+
+```typescript
+import { Unkey } from "@unkey/api";
+
+const sdk = new Unkey({ debugLogger: console });
+```
+
+You can also enable a default debug logger by setting an environment variable `UNKEY_DEBUG` to true.
+<!-- End Debugging [debug] -->
+
+<!-- Placeholder for Future Speakeasy SDK Sections -->
+
+# Development
+
+## Maturity
+
+This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage
+to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally
+looking for the latest version.
+
+## Contributions
 
-### Documentation
+While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. 
+We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release. 
 
-[Read the full documentation](https://www.unkey.com/docs/libraries/ts/sdk/overview)
+### SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=@unkey/api&utm_campaign=typescript)

package/RUNTIMES.md

@@ -0,0 +1,48 @@
+# Supported JavaScript runtimes
+
+This SDK is intended to be used in JavaScript runtimes that support ECMAScript 2020 or newer. The SDK uses the following features:
+
+* [Web Fetch API][web-fetch]
+* [Web Streams API][web-streams] and in particular `ReadableStream`
+* [Async iterables][async-iter] using `Symbol.asyncIterator`
+
+[web-fetch]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
+[web-streams]: https://developer.mozilla.org/en-US/docs/Web/API/Streams_API
+[async-iter]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#the_async_iterator_and_async_iterable_protocols
+
+Runtime environments that are explicitly supported are:
+
+- Evergreen browsers which include: Chrome, Safari, Edge, Firefox
+- Node.js active and maintenance LTS releases
+  - Currently, this is v18 and v20
+- Bun v1 and above
+- Deno v1.39
+  - Note that Deno does not currently have native support for streaming file uploads backed by the filesystem ([issue link][deno-file-streaming])
+
+[deno-file-streaming]: https://github.com/denoland/deno/issues/11018
+
+## Recommended TypeScript compiler options
+
+The following `tsconfig.json` options are recommended for projects using this
+SDK in order to get static type support for features like async iterables,
+streams and `fetch`-related APIs ([`for await...of`][for-await-of], 
+[`AbortSignal`][abort-signal], [`Request`][request], [`Response`][response] and
+so on):
+
+[for-await-of]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/for-await...of
+[abort-signal]: https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal
+[request]: https://developer.mozilla.org/en-US/docs/Web/API/Request
+[response]: https://developer.mozilla.org/en-US/docs/Web/API/Response
+
+```jsonc
+{
+  "compilerOptions": {
+    "target": "es2020", // or higher
+    "lib": ["es2020", "dom", "dom.iterable"],
+  }
+}
+```
+
+While `target` can be set to older ECMAScript versions, it may result in extra,
+unnecessary compatibility code being generated if you are not targeting old
+runtimes.

package/dist/commonjs/core.d.ts

@@ -0,0 +1,10 @@
+import { ClientSDK } from "./lib/sdks.js";
+/**
+ * A minimal client to use when calling standalone SDK functions. Typically, an
+ * instance of this class would be instantiated once at the start of an
+ * application and passed around through some dependency injection mechanism  to
+ * parts of an application that need to make SDK calls.
+ */
+export declare class UnkeyCore extends ClientSDK {
+}
+//# sourceMappingURL=core.d.ts.map

package/dist/commonjs/core.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"core.d.ts","sourceRoot":"","sources":["../../src/core.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE1C;;;;;GAKG;AACH,qBAAa,SAAU,SAAQ,SAAS;CAAG"}

package/dist/commonjs/core.js

@@ -0,0 +1,17 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UnkeyCore = void 0;
+const sdks_js_1 = require("./lib/sdks.js");
+/**
+ * A minimal client to use when calling standalone SDK functions. Typically, an
+ * instance of this class would be instantiated once at the start of an
+ * application and passed around through some dependency injection mechanism  to
+ * parts of an application that need to make SDK calls.
+ */
+class UnkeyCore extends sdks_js_1.ClientSDK {
+}
+exports.UnkeyCore = UnkeyCore;
+//# sourceMappingURL=core.js.map

package/dist/commonjs/core.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"core.js","sourceRoot":"","sources":["../../src/core.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,2CAA0C;AAE1C;;;;;GAKG;AACH,MAAa,SAAU,SAAQ,mBAAS;CAAG;AAA3C,8BAA2C"}

package/dist/commonjs/funcs/livenessCheck.d.ts

@@ -0,0 +1,17 @@
+import { UnkeyCore } from "../core.js";
+import { RequestOptions } from "../lib/sdks.js";
+import { APIError } from "../models/errors/apierror.js";
+import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/errors/httpclienterrors.js";
+import * as errors from "../models/errors/index.js";
+import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
+import * as operations from "../models/operations/index.js";
+import { APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+/**
+ * Liveness check
+ *
+ * @remarks
+ * This endpoint checks if the service is alive.
+ */
+export declare function livenessCheck(client: UnkeyCore, options?: RequestOptions): APIPromise<Result<operations.LivenessResponse, errors.BaseError | errors.BaseError | APIError | SDKValidationError | UnexpectedClientError | InvalidRequestError | RequestAbortedError | RequestTimeoutError | ConnectionError>>;
+//# sourceMappingURL=livenessCheck.d.ts.map

package/dist/commonjs/funcs/livenessCheck.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"livenessCheck.d.ts","sourceRoot":"","sources":["../../../src/funcs/livenessCheck.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAGvC,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,EAAE,QAAQ,EAAE,MAAM,8BAA8B,CAAC;AACxD,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,KAAK,MAAM,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;;;;GAKG;AACH,wBAAgB,aAAa,CAC3B,MAAM,EAAE,SAAS,EACjB,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CACX,MAAM,CACJ,UAAU,CAAC,gBAAgB,EACzB,MAAM,CAAC,SAAS,GAChB,MAAM,CAAC,SAAS,GAChB,QAAQ,GACR,kBAAkB,GAClB,qBAAqB,GACrB,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,eAAe,CAClB,CACF,CAKA"}