scalar-galaxy-typescript

Developer-friendly, idiomatic Typescript SDK for the scalar-galaxy-typescript API.

Summary

Scalar Galaxy: The Scalar Galaxy is an example OpenAPI specification to test OpenAPI tools and libraries. It’s a fictional universe with fictional planets and fictional data. Get all the data for all planets.

Resources

• https://github.com/scalar/scalar
• https://github.com/OAI/OpenAPI-Specification
• https://scalar.com

Markdown Support

All descriptions can contain ~~tons of text~~ Markdown. If GitHub supports the syntax, chances are we’re supporting it, too. You can even create internal links to reference endpoints.

Blockquotes

I love OpenAPI. <3

Tables

| Feature | Availability | | ---------------- | ------------ | | Markdown Support | ✓ |

Accordion

<details>
  <summary>Using Details Tags</summary>
  <p>HTML Example</p>
</details>

Images

Yes, there’s support for images, too!

Alerts

[!tip] You can now use markdown alerts in your descriptions.

For more information about the API: Documentation

Table of Contents

• @scott-w-jones-hotmail-com-team/scalar-galaxy-typescript
  • Resources
  • Markdown Support
• Note that Yarn does not install peer dependencies automatically. You will need
• to install zod as shown above.
• 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/scalar-galaxy-typescript

PNPM

pnpm add @scott-w-jones-hotmail-com-team/scalar-galaxy-typescript

Bun

bun add @scott-w-jones-hotmail-com-team/scalar-galaxy-typescript

Yarn

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

const scalarGalaxyTypescript = new ScalarGalaxyTypescript();

async function run() {
  const result = await scalarGalaxyTypescript.planets.getAllData({});

  console.log(result);
}

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security schemes globally:

| Name | Type | Scheme | | --------------- | ------------- | ------------------------ | | bearerAuth | http | HTTP Bearer | | basicAuth | http | HTTP Basic | | apiKeyQuery | apiKey | API key | | apiKeyHeader | apiKey | API key | | apiKeyCookie | apiKey | API key | | oAuth2 | oauth2 | OAuth2 token | | openIdConnect | openIdConnect | OpenID Connect Discovery |

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 { ScalarGalaxyTypescript } from "@scott-w-jones-hotmail-com-team/scalar-galaxy-typescript";

const scalarGalaxyTypescript = new ScalarGalaxyTypescript({
  security: {
    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
  },
});

async function run() {
  const result = await scalarGalaxyTypescript.planets.getAllData({});

  console.log(result);
}

run();

Available Resources and Operations

authentication

• createUserJson - Create a user
• createUserRaw - Create a user
• getTokenJson - Get a token
• getTokenRaw - Get a token
• getMe - Get authenticated user

planets

• getAllData - Get all planets
• createPlanetJson - Create a planet
• createPlanetRaw - Create a planet
• getPlanet - Get a planet
• updatePlanetJson - Update a planet
• updatePlanetRaw - Update a planet
• deletePlanet - Delete a planet
• uploadImage - Upload an image to a planet

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.

• authenticationCreateUserJson - Create a user
• authenticationCreateUserRaw - Create a user
• authenticationGetMe - Get authenticated user
• authenticationGetTokenJson - Get a token
• authenticationGetTokenRaw - Get a token
• planetsCreatePlanetJson - Create a planet
• planetsCreatePlanetRaw - Create a planet
• planetsDeletePlanet - Delete a planet
• planetsGetAllData - Get all planets
• planetsGetPlanet - Get a planet
• planetsUpdatePlanetJson - Update a planet
• planetsUpdatePlanetRaw - Update a planet
• planetsUploadImage - Upload an image to a planet

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 { ScalarGalaxyTypescript } from "@scott-w-jones-hotmail-com-team/scalar-galaxy-typescript";

const scalarGalaxyTypescript = new ScalarGalaxyTypescript();

async function run() {
  const result = await scalarGalaxyTypescript.planets.createPlanetRaw(
    bytesToStream(
      new TextEncoder().encode(
        "{\"name\":\"Mars\",\"description\":\"The red planet\",\"type\":\"terrestrial\",\"habitabilityIndex\":0.68,\"physicalProperties\":{\"mass\":0.107,\"radius\":0.532,\"gravity\":0.378,\"temperature\":{\"min\":130,\"max\":308,\"average\":210}},\"atmosphere\":[{\"compound\":\"CO2\",\"percentage\":95.3}],\"discoveredAt\":\"1610-01-07T00:00:00Z\",\"image\":\"https://cdn.scalar.com/photos/mars.jpg\",\"satellites\":[{\"name\":\"Phobos\",\"diameter\":22.2}],\"creator\":{\"name\":\"Marc\"},\"tags\":[\"solar-system\",\"rocky\",\"explored\"],\"callbackUrl\":\"https://example.com/webhook\"}",
      ),
    ),
  );

  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 { ScalarGalaxyTypescript } from "@scott-w-jones-hotmail-com-team/scalar-galaxy-typescript";

const scalarGalaxyTypescript = new ScalarGalaxyTypescript();

async function run() {
  const result = await scalarGalaxyTypescript.planets.getAllData({}, {
    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 { ScalarGalaxyTypescript } from "@scott-w-jones-hotmail-com-team/scalar-galaxy-typescript";

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

async function run() {
  const result = await scalarGalaxyTypescript.planets.getAllData({});

  console.log(result);
}

run();

Error Handling

ScalarGalaxyTypescriptError 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 |

Example

import { ScalarGalaxyTypescript } from "@scott-w-jones-hotmail-com-team/scalar-galaxy-typescript";
import * as errors from "@scott-w-jones-hotmail-com-team/scalar-galaxy-typescript/models/errors";

const scalarGalaxyTypescript = new ScalarGalaxyTypescript();

async function run() {
  try {
    const result = await scalarGalaxyTypescript.planets.getAllData({});

    console.log(result);
  } catch (error) {
    if (error instanceof errors.ScalarGalaxyTypescriptError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);
    }
  }
}

run();

Error Classes

Primary error:

• ScalarGalaxyTypescriptError: 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 ScalarGalaxyTypescriptError:

• 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.

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 | Variables | Description | | --- | ------------------------------------- | --------------------- | ------------------------------- | | 0 | https://galaxy.scalar.com | | | | 1 | {protocol}://void.scalar.com/{path} | protocolpath | Responds with your request data |

If the selected server has variables, you may override its default values through the additional parameters made available in the SDK constructor:

| Variable | Parameter | Supported Values | Default | Description | | ---------- | --------------------------------- | ---------------- | --------- | ----------- | | protocol | protocol: models.ServerProtocol | - "https" | "https" | | | path | path: string | string | "" | |

Example

import { ScalarGalaxyTypescript } from "@scott-w-jones-hotmail-com-team/scalar-galaxy-typescript";

const scalarGalaxyTypescript = new ScalarGalaxyTypescript({
  serverIdx: 1,
  protocol: "https",
  path: "18258",
});

async function run() {
  const result = await scalarGalaxyTypescript.planets.getAllData({});

  console.log(result);
}

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 { ScalarGalaxyTypescript } from "@scott-w-jones-hotmail-com-team/scalar-galaxy-typescript";

const scalarGalaxyTypescript = new ScalarGalaxyTypescript({
  serverURL: "https://void.scalar.com/",
});

async function run() {
  const result = await scalarGalaxyTypescript.planets.getAllData({});

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

const sdk = new ScalarGalaxyTypescript({ 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