tasks-api-typescript

Developer-friendly, idiomatic Typescript SDK for the tasks-api-typescript API.

Summary

Tasks API: API documentation for the Tasks application

Table of Contents

• @scott-w-jones-hotmail-com-team/tasks-api-typescript
  • SDK Installation
  • Requirements
  • SDK Example Usage
  • Available Resources and Operations
  • Standalone functions
  • 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 @scott-w-jones-hotmail-com-team/tasks-api-typescript

PNPM

pnpm add @scott-w-jones-hotmail-com-team/tasks-api-typescript

Bun

bun add @scott-w-jones-hotmail-com-team/tasks-api-typescript

Yarn

yarn add @scott-w-jones-hotmail-com-team/tasks-api-typescript 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 { TasksApiTypescript } from "@scott-w-jones-hotmail-com-team/tasks-api-typescript";

const tasksApiTypescript = new TasksApiTypescript();

async function run() {
  const result = await tasksApiTypescript.index.index();

  console.log(result);
}

run();

Available Resources and Operations

index

• index - Index route for the Tasks API

tasks

• listTasks - List all tasks
• createTask - Create a new task
• getTaskById - Get a task by ID
• updateTaskById - Update a task by ID
• deleteTaskById - Delete a task by ID

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.

• indexIndex - Index route for the Tasks API
• tasksCreateTask - Create a new task
• tasksDeleteTaskById - Delete a task by ID
• tasksGetTaskById - Get a task by ID
• tasksListTasks - List all tasks
• tasksUpdateTaskById - Update a task by ID

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 { TasksApiTypescript } from "@scott-w-jones-hotmail-com-team/tasks-api-typescript";

const tasksApiTypescript = new TasksApiTypescript();

async function run() {
  const result = await tasksApiTypescript.index.index({
    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 { TasksApiTypescript } from "@scott-w-jones-hotmail-com-team/tasks-api-typescript";

const tasksApiTypescript = new TasksApiTypescript({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
});

async function run() {
  const result = await tasksApiTypescript.index.index();

  console.log(result);
}

run();

Error Handling

TasksAPITypescriptError 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 { TasksApiTypescript } from "@scott-w-jones-hotmail-com-team/tasks-api-typescript";
import * as errors from "@scott-w-jones-hotmail-com-team/tasks-api-typescript/models/errors";

const tasksApiTypescript = new TasksApiTypescript();

async function run() {
  try {
    const result = await tasksApiTypescript.tasks.createTask({
      name: "<value>",
      done: false,
    });

    console.log(result);
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.TasksAPITypescriptError) {
      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.CreateTaskResponseBody) {
        console.log(error.data$.success); // boolean
        console.log(error.data$.error); // errors.ErrorT
      }
    }
  }
}

run();

Error Classes

Primary error:

• TasksAPITypescriptError: The base class for HTTP error responses.

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

• GetTaskByIdResponseBody: Task not found. Status code 404. Applicable to 1 of 6 methods.*
• UpdateTaskByIdResponseBody: Task not found. Status code 404. Applicable to 1 of 6 methods.*
• DeleteTaskByIdResponseBody: Task not found. Status code 404. Applicable to 1 of 6 methods.*
• One: The validation error(s). Status code 422. Applicable to 1 of 6 methods.*
• Two: The validation error(s). Status code 422. Applicable to 1 of 6 methods.*
• CreateTaskResponseBody: The validation error(s). Status code 422. Applicable to 1 of 6 methods.*
• GetTaskByIdTasksResponseBody: Invalid id error. Status code 422. Applicable to 1 of 6 methods.*
• DeleteTaskByIdTasksResponseBody: Invalid id error. Status code 422. Applicable to 1 of 6 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 http://localhost:{port} contains variables and is set to http://localhost:9000 by default. To override default values, the following parameters are available when initializing the SDK client instance:

| Variable | Parameter | Default | Description | | -------- | -------------- | -------- | -------------------------------- | | port | port: string | "9000" | Port number for the local server |

Example

import { TasksApiTypescript } from "@scott-w-jones-hotmail-com-team/tasks-api-typescript";

const tasksApiTypescript = new TasksApiTypescript({
  port: "49564",
});

async function run() {
  const result = await tasksApiTypescript.index.index();

  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 { TasksApiTypescript } from "@scott-w-jones-hotmail-com-team/tasks-api-typescript";

const tasksApiTypescript = new TasksApiTypescript({
  serverURL: "http://localhost:9000",
});

async function run() {
  const result = await tasksApiTypescript.index.index();

  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 { TasksApiTypescript } from "@scott-w-jones-hotmail-com-team/tasks-api-typescript";
import { HTTPClient } from "@scott-w-jones-hotmail-com-team/tasks-api-typescript/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 TasksApiTypescript({ 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 { TasksApiTypescript } from "@scott-w-jones-hotmail-com-team/tasks-api-typescript";

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

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 Scalar