patronts

Developer-friendly & type-safe Typescript SDK specifically catered to leverage patronts API.

Summary

Patron API: An open source Patreon alternative with lower fees designed for creators who publish ongoing sequential content like books, podcasts, and comics.

Table of Contents

• patronts
  • SDK Installation
  • Requirements
  • SDK Example Usage
  • Authentication
  • Available Resources and Operations
  • Standalone functions
  • Pagination
  • File uploads
  • Retries
  • Error Handling
  • Server Selection
  • Custom HTTP Client
  • Debugging
• Development
  • Maturity
  • Contributions

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add patronts

PNPM

pnpm add patronts

Bun

bun add patronts

Yarn

yarn add patronts

[!NOTE] This package is published with CommonJS and ES Modules (ESM) support.

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { Patronts } from "patronts";

const patronts = new Patronts({
  security: {
    bearerAuth: process.env["PATRONTS_BEARER_AUTH"] ?? "",
    cookieAuth: process.env["PATRONTS_COOKIE_AUTH"] ?? "",
  },
});

async function run() {
  const result = await patronts.apiKeys.list();

  for await (const page of result) {
    console.log(page);
  }
}

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security schemes globally:

| Name | Type | Scheme | Environment Variable | | ------------ | ------ | ----------- | ---------------------- | | bearerAuth | http | HTTP Bearer | PATRONTS_BEARER_AUTH | | cookieAuth | apiKey | API key | PATRONTS_COOKIE_AUTH |

You can set the security parameters through the security optional parameter when initializing the SDK client instance. The selected scheme will be used by default to authenticate with the API for all operations that support it. For example:

import { Patronts } from "patronts";

const patronts = new Patronts({
  security: {
    bearerAuth: process.env["PATRONTS_BEARER_AUTH"] ?? "",
    cookieAuth: process.env["PATRONTS_COOKIE_AUTH"] ?? "",
  },
});

async function run() {
  const result = await patronts.apiKeys.list();

  for await (const page of result) {
    console.log(page);
  }
}

run();

Per-Operation Security Schemes

Some operations in this SDK require the security scheme to be specified at the request level. For example:

import { Patronts } from "patronts";

const patronts = new Patronts();

async function run() {
  const result = await patronts.outrank.processWebhook({
    bearerAuth: process.env["PATRONTS_BEARER_AUTH"] ?? "",
  }, {
    data: {
      "recommendations": [
        "Improve meta descriptions",
        "Add alt text to images",
      ],
      "score": 85,
    },
    eventType: "analysis_complete",
  });

  console.log(result);
}

run();

Available Resources and Operations

apiKeys

• list - List API keys with cursor-based pagination and optional filtering
• create - Create a new API key
• get - Get a specific API key by ID
• update - Update an API key
• delete - Delete an API key (hard delete for security)

auth

• checkEmail - Check if email exists
• forgotPassword - Forgot password
• googleRedirect - Google OAuth redirect
• googleCallback - Google OAuth callback
• login - User login
• logout - Logout
• getCurrentUser - Get current user info
• updateUserInfo - Update user information
• register - User registration
• resendVerificationEmail - Resend verification email
• resetPassword - Reset password
• verifyEmail - Email verification

files

• serveCdn - Serve file content without authentication
• list - List user's files with cursor-based pagination
• upload - Upload a file
• get - Get a specific file by ID
• update - Update file metadata and properties
• delete - Permanently delete a user file

outrank

• processWebhook - Process Outrank webhook

posts

• list - List posts with cursor-based pagination and optional series filtering
• create - Create a new post
• get - Get a specific post by ID with series ownership validation
• update - Update a post
• delete - Delete a post (soft delete) with series ownership validation

series

• list - List user's series with cursor-based pagination
• create - Create a new series
• get - Get a specific series by ID with user ownership validation
• update - Update a series
• delete - Delete a series (soft delete) with user ownership validation

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.

• apiKeysCreate - Create a new API key
• apiKeysDelete - Delete an API key (hard delete for security)
• apiKeysGet - Get a specific API key by ID
• apiKeysList - List API keys with cursor-based pagination and optional filtering
• apiKeysUpdate - Update an API key
• authCheckEmail - Check if email exists
• authForgotPassword - Forgot password
• authGetCurrentUser - Get current user info
• authGoogleCallback - Google OAuth callback
• authGoogleRedirect - Google OAuth redirect
• authLogin - User login
• authLogout - Logout
• authRegister - User registration
• authResendVerificationEmail - Resend verification email
• authResetPassword - Reset password
• authUpdateUserInfo - Update user information
• authVerifyEmail - Email verification
• filesDelete - Permanently delete a user file
• filesGet - Get a specific file by ID
• filesList - List user's files with cursor-based pagination
• filesServeCdn - Serve file content without authentication
• filesUpdate - Update file metadata and properties
• filesUpload - Upload a file
• outrankProcessWebhook - Process Outrank webhook
• postsCreate - Create a new post
• postsDelete - Delete a post (soft delete) with series ownership validation
• postsGet - Get a specific post by ID with series ownership validation
• postsList - List posts with cursor-based pagination and optional series filtering
• postsUpdate - Update a post
• seriesCreate - Create a new series
• seriesDelete - Delete a series (soft delete) with user ownership validation
• seriesGet - Get a specific series by ID with user ownership validation
• seriesList - List user's series with cursor-based pagination
• seriesUpdate - Update a series

Pagination

Some of the endpoints in this SDK support pagination. To use pagination, you make your SDK calls as usual, but the returned response object will also be an async iterable that can be consumed using the for await...of syntax.

Here's an example of one such pagination call:

import { Patronts } from "patronts";

const patronts = new Patronts({
  security: {
    bearerAuth: process.env["PATRONTS_BEARER_AUTH"] ?? "",
    cookieAuth: process.env["PATRONTS_COOKIE_AUTH"] ?? "",
  },
});

async function run() {
  const result = await patronts.apiKeys.list();

  for await (const page of result) {
    console.log(page);
  }
}

run();

File uploads

Certain SDK methods accept files as part of a multi-part request. It is possible and typically recommended to upload files as a stream rather than reading the entire contents into memory. This avoids excessive memory consumption and potentially crashing with out-of-memory errors when working with very large files. The following example demonstrates how to attach a file stream to a request.

[!TIP]

Depending on your JavaScript runtime, there are convenient utilities that return a handle to a file without reading the entire contents into memory:

• Node.js v20+: Since v20, Node.js comes with a native openAsBlob function in node:fs.
• Bun: The native Bun.file function produces a file handle that can be used for streaming file uploads.
• Browsers: All supported browsers return an instance to a File when reading the value from an <input type="file"> element.
• Node.js v18: A file stream can be created using the fileFrom helper from fetch-blob/from.js.

import { openAsBlob } from "node:fs";
import { Patronts } from "patronts";

const patronts = new Patronts({
  security: {
    bearerAuth: process.env["PATRONTS_BEARER_AUTH"] ?? "",
    cookieAuth: process.env["PATRONTS_COOKIE_AUTH"] ?? "",
  },
});

async function run() {
  const result = await patronts.files.upload({
    file: await openAsBlob("example.file"),
  });

  console.log(result);
}

run();

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:

import { Patronts } from "patronts";

const patronts = new Patronts({
  security: {
    bearerAuth: process.env["PATRONTS_BEARER_AUTH"] ?? "",
    cookieAuth: process.env["PATRONTS_COOKIE_AUTH"] ?? "",
  },
});

async function run() {
  const result = await patronts.apiKeys.list({
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  for await (const page of result) {
    console.log(page);
  }
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import { Patronts } from "patronts";

const patronts = new Patronts({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  security: {
    bearerAuth: process.env["PATRONTS_BEARER_AUTH"] ?? "",
    cookieAuth: process.env["PATRONTS_COOKIE_AUTH"] ?? "",
  },
});

async function run() {
  const result = await patronts.apiKeys.list();

  for await (const page of result) {
    console.log(page);
  }
}

run();

Error Handling

PatrontsError is the base class for all HTTP error responses. It has the following properties:

| Property | Type | Description | | ------------------- | ---------- | --------------------------------------------------------------------------------------- | | error.message | string | Error message | | error.statusCode | number | HTTP response status code eg 404 | | error.headers | Headers | HTTP response headers | | error.body | string | HTTP body. Can be empty string if no body is returned. | | error.rawResponse | Response | Raw HTTP response | | error.data$ | | Optional. Some errors may contain structured data. See Error Classes. |

Example

import { Patronts } from "patronts";
import * as errors from "patronts/models/errors";

const patronts = new Patronts({
  security: {
    bearerAuth: process.env["PATRONTS_BEARER_AUTH"] ?? "",
    cookieAuth: process.env["PATRONTS_COOKIE_AUTH"] ?? "",
  },
});

async function run() {
  try {
    const result = await patronts.apiKeys.list();

    for await (const page of result) {
      console.log(page);
    }
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.PatrontsError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);

      // Depending on the method different errors may be thrown
      if (error instanceof errors.ErrorResponse) {
        console.log(error.data$.code); // string
        console.log(error.data$.error); // string
      }
    }
  }
}

run();

Error Classes

Primary errors:

• PatrontsError: The base class for HTTP error responses.
  • ErrorResponse: Standard JSON error response structure for API endpoints. *

Network errors:

• ConnectionError: HTTP client was unable to make a request to a server.
• RequestTimeoutError: HTTP request timed out due to an AbortSignal signal.
• RequestAbortedError: HTTP request was aborted by the client.
• InvalidRequestError: Any input used to create a request is invalid.
• UnexpectedClientError: Unrecognised or unexpected error.

Inherit from PatrontsError:

• ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. See error.rawValue for the raw value and error.pretty() for a nicely formatted multi-line string.

* Check the method documentation to see if the error is applicable.

Server Selection

Select Server by Index

You can override the default server globally by passing a server index to the serverIdx: number optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:

| # | Server | Description | | --- | ------------------------ | ------------------------ | | 0 | http://localhost:8080 | Local development server | | 1 | https://api.patron.com | Production server |

Example

import { Patronts } from "patronts";

const patronts = new Patronts({
  serverIdx: 1,
  security: {
    bearerAuth: process.env["PATRONTS_BEARER_AUTH"] ?? "",
    cookieAuth: process.env["PATRONTS_COOKIE_AUTH"] ?? "",
  },
});

async function run() {
  const result = await patronts.apiKeys.list();

  for await (const page of result) {
    console.log(page);
  }
}

run();

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:

import { Patronts } from "patronts";

const patronts = new Patronts({
  serverURL: "https://api.patron.com",
  security: {
    bearerAuth: process.env["PATRONTS_BEARER_AUTH"] ?? "",
    cookieAuth: process.env["PATRONTS_COOKIE_AUTH"] ?? "",
  },
});

async function run() {
  const result = await patronts.apiKeys.list();

  for await (const page of result) {
    console.log(page);
  }
}

run();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native 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.

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:

import { Patronts } from "patronts";
import { HTTPClient } from "patronts/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 Patronts({ httpClient: httpClient });

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.

import { Patronts } from "patronts";

const sdk = new Patronts({ debugLogger: console });

You can also enable a default debug logger by setting an environment variable PATRONTS_DEBUG to true.

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

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.

SDK Created by Speakeasy