CloudPDF TypeScript SDK

The official TypeScript SDK for the CloudPDF API.

Table of Contents

• Installation
• Reference
• Usage
• Request and Response Types
• Exception Handling
• File Uploads
• Uploads From the Browser
• Binary Response
• Advanced
  • Subpackage Exports
  • Additional Headers
  • Additional Query String Parameters
  • Retries
  • Timeouts
  • Aborting Requests
  • Access Raw Response Data
  • Logging
  • Custom Fetch
  • Runtime Compatibility
• Contributing

Installation

npm i -s @cloudpdf/sdk

Reference

A full reference for this library is available here.

Usage

Instantiate and use the client with the following:

import { CloudPDFClient } from "@cloudpdf/sdk";

const client = new CloudPDFClient({ token: "YOUR_TOKEN" });
await client.grants.exchange({
    grant: "grant"
});

The client talks to CloudPDF SaaS (https://engine.cloudpdf.com). For your own CloudPDF server, pass its address:

const client = new CloudPDFClient({ baseUrl: "https://pdf.example.com", token: "YOUR_TOKEN" });

Request and Response Types

The SDK exports all request and response types as TypeScript interfaces. Simply import them with the following namespace:

import { CloudPDF } from "@cloudpdf/sdk";

const request: CloudPDF.HeadDocRequest = {
    ...
};

Exception Handling

When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error will be thrown.

import { CloudPDFError } from "@cloudpdf/sdk";

try {
    await client.grants.exchange(...);
} catch (err) {
    if (err instanceof CloudPDFError) {
        console.log(err.statusCode);
        console.log(err.message);
        console.log(err.body);
        console.log(err.rawResponse);
    }
}

File Uploads

Use the high-level upload workflow. It computes the content hash before init, prefers a direct presigned object-store upload, and commits only after a successful transfer:

const result = await client.uploads.create({
    tenantId: "tenant_123",
    source: { path: "invoice.pdf" },
    uploadPreference: "auto",
    onProgress: (loaded, total) => console.log(`${loaded}/${total}`),
});

source accepts a Uint8Array, ArrayBuffer, Blob, { path: string }, or a reopenable source with a known size and SHA-256. An unknown one-shot stream is intentionally rejected: the server pins size and hash during init, before any bytes are transferred. Set uploadPreference: "proxy" only when the server is configured to allow its bounded multipart fallback.

onProgress reports the bytes sent as they go.

Uploads From the Browser

A user's browser can upload a PDF straight to CloudPDF, so the file never passes through your server and your API key never leaves it. Your server makes an upload token, which says where the file goes and runs out in minutes:

const { token } = await client.tokens.issue({
    tenantId: "tenant_123",
    body: { kind: "upload", sub: user.id, folderId, metadata: { contractId }, expiresIn: 600 },
});

The page imports only the upload entry, about 3 KB gzipped, with nothing from Node or the rest of the SDK:

import { upload } from "@cloudpdf/sdk/upload";

const { document } = await upload(file, {
    token,
    onProgress: (loaded, total) => console.log(`${loaded}/${total}`),
});

The token uploads into its folder with its metadata, up to maxFiles documents (one by default), and nothing else. upload() takes name, signal and, for your own CloudPDF server, baseUrl.

Binary Response

You can consume binary data from endpoints using the BinaryResponse type which lets you choose how to consume the data:

const response = await client.doc.download(...);
const stream: ReadableStream<Uint8Array> = response.stream();
// const arrayBuffer: ArrayBuffer = await response.arrayBuffer();
// const blob: Blob = response.blob();
// const bytes: Uint8Array = response.bytes();
// You can only use the response body once, so you must choose one of the above methods.
// If you want to check if the response body has been used, you can use the following property.
const bodyUsed = response.bodyUsed;

Advanced

Subpackage Exports

This SDK supports direct imports of subpackage clients, which allows JavaScript bundlers to tree-shake and include only the imported subpackage code. This results in much smaller bundle sizes.

import { DeploymentClient } from '@cloudpdf/sdk/deployment';

const client = new DeploymentClient({...});

Additional Headers

If you would like to send additional headers as part of the request, use the headers request option.

import { CloudPDFClient } from "@cloudpdf/sdk";

const client = new CloudPDFClient({
    ...
    headers: {
        'X-Custom-Header': 'custom value'
    }
});

const response = await client.grants.exchange(..., {
    headers: {
        'X-Custom-Header': 'custom value'
    }
});

Additional Query String Parameters

If you would like to send additional query string parameters as part of the request, use the queryParams request option.

const response = await client.grants.exchange(..., {
    queryParams: {
        'customQueryParamKey': 'custom query param value'
    }
});

Retries

The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long as the request is deemed retryable and the number of retry attempts has not grown larger than the configured retry limit (default: 2).

Which status codes are retried depends on the retryStatusCodes generator configuration:

legacy (current default): retries on

• 408 (Timeout)
• 429 (Too Many Requests)
• 5XX (All server errors, including 500)

recommended: retries on

• 408 (Timeout)
• 429 (Too Many Requests)
• 502 (Bad Gateway)
• 503 (Service Unavailable)
• 504 (Gateway Timeout)

Use the maxRetries request option to configure this behavior.

const response = await client.grants.exchange(..., {
    maxRetries: 0 // override maxRetries at the request level
});

Timeouts

The SDK defaults to a 60 second timeout. Use the timeoutInSeconds option to configure this behavior.

const response = await client.grants.exchange(..., {
    timeoutInSeconds: 30 // override timeout to 30s
});

Aborting Requests

The SDK allows users to abort requests at any point by passing in an abort signal.

const controller = new AbortController();
const response = await client.grants.exchange(..., {
    abortSignal: controller.signal
});
controller.abort(); // aborts the request

Access Raw Response Data

The SDK provides access to raw response data, including headers, through the .withRawResponse() method. The .withRawResponse() method returns a promise that results to an object with a data and a rawResponse property.

const { data, rawResponse } = await client.grants.exchange(...).withRawResponse();

console.log(data);
console.log(rawResponse.headers['X-My-Header']);

Logging

The SDK supports logging. You can configure the logger by passing in a logging object to the client options.

import { CloudPDFClient, logging } from "@cloudpdf/sdk";

const client = new CloudPDFClient({
    ...
    logging: {
        level: logging.LogLevel.Debug, // defaults to logging.LogLevel.Info
        logger: new logging.ConsoleLogger(), // defaults to ConsoleLogger
        silent: false, // defaults to true, set to false to enable logging
    }
});

The logging object can have the following properties:

• level: The log level to use. Defaults to logging.LogLevel.Info.
• logger: The logger to use. Defaults to a logging.ConsoleLogger.
• silent: Whether to silence the logger. Defaults to true.

The level property can be one of the following values:

• logging.LogLevel.Debug
• logging.LogLevel.Info
• logging.LogLevel.Warn
• logging.LogLevel.Error

To provide a custom logger, you can pass in an object that implements the logging.ILogger interface.

import winston from 'winston';

const winstonLogger = winston.createLogger({...});

const logger: logging.ILogger = {
    debug: (msg, ...args) => winstonLogger.debug(msg, ...args),
    info: (msg, ...args) => winstonLogger.info(msg, ...args),
    warn: (msg, ...args) => winstonLogger.warn(msg, ...args),
    error: (msg, ...args) => winstonLogger.error(msg, ...args),
};

import pino from 'pino';

const pinoLogger = pino({...});

const logger: logging.ILogger = {
  debug: (msg, ...args) => pinoLogger.debug(args, msg),
  info: (msg, ...args) => pinoLogger.info(args, msg),
  warn: (msg, ...args) => pinoLogger.warn(args, msg),
  error: (msg, ...args) => pinoLogger.error(args, msg),
};

Custom Fetch

The SDK provides a low-level fetch method for making custom HTTP requests while still benefiting from SDK-level configuration like authentication, retries, timeouts, and logging. This is useful for calling API endpoints not yet supported in the SDK.

const response = await client.fetch("/v1/custom/endpoint", {
    method: "GET",
}, {
    timeoutInSeconds: 30,
    maxRetries: 3,
    headers: {
        "X-Custom-Header": "custom-value",
    },
});

const data = await response.json();

Runtime Compatibility

The SDK works in the following runtimes:

• Node.js 18+
• Vercel
• Cloudflare Workers
• Deno v1.25+
• Bun 1.0+
• React Native

Contributing

While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!

On the other hand, contributions to the README are always very welcome!