authelete-pro

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

Important

This SDK is not yet ready for production use. To complete setup please follow the steps outlined in your workspace. Delete this section before > publishing to a package manager.

Summary

Petstore - OpenAPI 3.1: This is a sample Pet Store Server based on the OpenAPI 3.1 specification.

Some useful links:

For more information about the API: Find out more about Swagger

SDK Installation

Tip

To finish publishing your SDK to npm and others you must run your first generation action.

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

NPM

npm add <UNSET>

PNPM

pnpm add <UNSET>

Bun

bun add <UNSET>

Yarn

yarn add <UNSET> 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.

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Example

import { AutheletePro } from "authelete-pro";

const autheletePro = new AutheletePro({
  apiKey: process.env["AUTHELETEPRO_API_KEY"] ?? "",
});

async function run() {
  const result = await autheletePro.pet.updatePet({
    id: 10,
    name: "doggie",
    category: {
      id: 1,
      name: "Dogs",
    },
    photoUrls: [
      "<value 1>",
    ],
  });

  console.log(result);
}

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme	Environment Variable
`apiKey`	apiKey	API key	`AUTHELETEPRO_API_KEY`

To authenticate with the API the apiKey parameter must be set when initializing the SDK client instance. For example:

import { AutheletePro } from "authelete-pro";

const autheletePro = new AutheletePro({
  apiKey: process.env["AUTHELETEPRO_API_KEY"] ?? "",
});

async function run() {
  const result = await autheletePro.pet.updatePet({
    id: 10,
    name: "doggie",
    category: {
      id: 1,
      name: "Dogs",
    },
    photoUrls: [
      "<value 1>",
    ],
  });

  console.log(result);
}

run();

Available Resources and Operations

Available methods

pet

updatePet - Update an existing pet
addPet - Add a new pet to the store
findPetsByStatus - Finds Pets by status
findPetsByTags - Finds Pets by tags
getPetById - Find pet by ID
deletePet - Deletes a pet
uploadFile - uploads an image

store

getInventory - Returns pet inventories by status
placeOrder - Place an order for a pet
getOrderById - Find purchase order by ID
deleteOrder - Delete purchase order by ID

user

createUser - Create user
createUsersWithListInput - Creates list of users with given input array
loginUser - Logs user into the system
logoutUser - Logs out current logged in user session
getUserByName - Get user by user name
updateUser - Update user
deleteUser - Delete user

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.

Available standalone functions

petAddPet - Add a new pet to the store
petDeletePet - Deletes a pet
petFindPetsByStatus - Finds Pets by status
petFindPetsByTags - Finds Pets by tags
petGetPetById - Find pet by ID
petUpdatePet - Update an existing pet
petUploadFile - uploads an image
storeDeleteOrder - Delete purchase order by ID
storeGetInventory - Returns pet inventories by status
storeGetOrderById - Find purchase order by ID
storePlaceOrder - Place an order for a pet
userCreateUser - Create user
userCreateUsersWithListInput - Creates list of users with given input array
userDeleteUser - Delete user
userGetUserByName - Get user by user name
userLoginUser - Logs user into the system
userLogoutUser - Logs out current logged in user session
userUpdateUser - Update user

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 { AutheletePro } from "authelete-pro";

const autheletePro = new AutheletePro({
  apiKey: process.env["AUTHELETEPRO_API_KEY"] ?? "",
});

async function run() {
  const result = await autheletePro.pet.uploadFile({
    petId: 150516,
  });

  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 { AutheletePro } from "authelete-pro";

const autheletePro = new AutheletePro({
  apiKey: process.env["AUTHELETEPRO_API_KEY"] ?? "",
});

async function run() {
  const result = await autheletePro.pet.updatePet({
    id: 10,
    name: "doggie",
    category: {
      id: 1,
      name: "Dogs",
    },
    photoUrls: [
      "<value 1>",
    ],
  }, {
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  console.log(result);
}

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 { AutheletePro } from "authelete-pro";

const autheletePro = new AutheletePro({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  apiKey: process.env["AUTHELETEPRO_API_KEY"] ?? "",
});

async function run() {
  const result = await autheletePro.pet.updatePet({
    id: 10,
    name: "doggie",
    category: {
      id: 1,
      name: "Dogs",
    },
    photoUrls: [
      "<value 1>",
    ],
  });

  console.log(result);
}

run();

Error Handling

AutheleteProError 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 { AutheletePro } from "authelete-pro";
import * as errors from "authelete-pro/models/errors";

const autheletePro = new AutheletePro({
  apiKey: process.env["AUTHELETEPRO_API_KEY"] ?? "",
});

async function run() {
  try {
    const result = await autheletePro.pet.updatePet({
      id: 10,
      name: "doggie",
      category: {
        id: 1,
        name: "Dogs",
      },
      photoUrls: [
        "<value 1>",
      ],
    });

    console.log(result);
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.AutheleteProError) {
      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.ApiErrorInvalidInput) {
        console.log(error.data$.status); // number
        console.log(error.data$.error); // string
      }
    }
  }
}

run();

Error Classes

Primary error:

AutheleteProError: The base class for HTTP error responses.

Less common errors (9)

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 AutheleteProError:

ApiErrorUnauthorized: Unauthorized error. Status code 401. Applicable to 12 of 18 methods.*
ApiErrorNotFound: Not Found error. Status code 404. Applicable to 12 of 18 methods.*
ApiErrorInvalidInput: Not Found error. Status code 400. Applicable to 10 of 18 methods.*
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

Server Variables

The default server https://{environment}.petstore.io contains variables and is set to https://prod.petstore.io by default. To override default values, the following parameters are available when initializing the SDK client instance:

Variable	Parameter	Supported Values	Default	Description
`environment`	`environment: models.ServerEnvironment`	- `"prod"` - `"staging"` - `"dev"`	`"prod"`	The environment name. Defaults to the production environment.

Example

import { AutheletePro } from "authelete-pro";

const autheletePro = new AutheletePro({
  environment: "dev",
  apiKey: process.env["AUTHELETEPRO_API_KEY"] ?? "",
});

async function run() {
  const result = await autheletePro.pet.updatePet({
    id: 10,
    name: "doggie",
    category: {
      id: 1,
      name: "Dogs",
    },
    photoUrls: [
      "<value 1>",
    ],
  });

  console.log(result);
}

run();

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:

import { AutheletePro } from "authelete-pro";

const autheletePro = new AutheletePro({
  serverURL: "https://prod.petstore.io",
  apiKey: process.env["AUTHELETEPRO_API_KEY"] ?? "",
});

async function run() {
  const result = await autheletePro.pet.updatePet({
    id: 10,
    name: "doggie",
    category: {
      id: 1,
      name: "Dogs",
    },
    photoUrls: [
      "<value 1>",
    ],
  });

  console.log(result);
}

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 { AutheletePro } from "authelete-pro";
import { HTTPClient } from "authelete-pro/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 AutheletePro({ 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 { AutheletePro } from "authelete-pro";

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

You can also enable a default debug logger by setting an environment variable AUTHELETEPRO_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.

Name		Name	Last commit message	Last commit date
Latest commit History 4 Commits
.devcontainer		.devcontainer
.github/workflows		.github/workflows
.speakeasy		.speakeasy
docs		docs
examples		examples
specs		specs
src		src
.gitattributes		.gitattributes
.gitignore		.gitignore
.npmignore		.npmignore
CONTRIBUTING.md		CONTRIBUTING.md
FUNCTIONS.md		FUNCTIONS.md
README.md		README.md
RUNTIMES.md		RUNTIMES.md
USAGE.md		USAGE.md
eslint.config.mjs		eslint.config.mjs
jsr.json		jsr.json
package-lock.json		package-lock.json
package.json		package.json
tsconfig.json		tsconfig.json

srqai/authlete-pro-typescript

Folders and files

Latest commit

History

Repository files navigation

authelete-pro

Summary

Table of Contents

SDK Installation

NPM

PNPM

Bun

Yarn

Requirements

SDK Example Usage

Example

Authentication

Per-Client Security Schemes

Available Resources and Operations

pet

store

user

Standalone functions

File uploads

Retries

Error Handling

Example

Error Classes

Server Selection

Server Variables

Example

Override Server URL Per-Client

Custom HTTP Client

Debugging

Development

Maturity

Contributions

SDK Created by Speakeasy

About

Resources

Contributing

Uh oh!

Stars

Watchers

Forks

Releases 1

Packages 0

Languages

Packages