@studio-design/studio-auth-node

TypeScript / JavaScript client for the Studio Auth Service API.

Install

Stable

pnpm add @studio-design/studio-auth-node
# or
npm install @studio-design/studio-auth-node

Snapshot release (pre-release validation)

To validate unreleased SDK changes on staging, install the snapshot tagged on every main commit that touches the OpenAPI spec via the next dist-tag:

pnpm add @studio-design/studio-auth-node@next
# or
npm install @studio-design/studio-auth-node@next

The snapshot version follows <next-patch>-rc.<run_number> (e.g. 0.2.25-rc.5). See the studio-auth-node Releases for the latest snapshot tag.

⚠️ Snapshot releases are intended for staging / CI validation. For production, install the stable version (pnpm add @studio-design/studio-auth-node or pin to a stable ^X.Y.Z range).

Usage

Host configuration (required)

The SDK does not ship with a default host URL. Configure the base URL before making any requests.

import { client } from '@studio-design/studio-auth-node';

client.setConfig({
  baseUrl: 'https://your-auth-server.example.com',
  auth: () => `Bearer ${accessToken}`,
});

The SDK is generated from the Studio Auth Service OpenAPI specification.

Example: fetch the authenticated caller's organization

import { client, getMyOrganization } from '@studio-design/studio-auth-node';

client.setConfig({
  baseUrl: 'https://your-auth-server.example.com',
  auth: () => `Bearer ${accessToken}`,
});

try {
  const { data } = await getMyOrganization({
    path: { organization_id: orgId },
    throwOnError: true,
  });
  // data is typed as `Organization`
  console.log(data.display_name);
} catch (err) {
  // With `throwOnError: true`, non-2xx responses throw. The error payload
  // follows the RFC 9457 ProblemDetails contract documented in the OpenAPI
  // spec (e.g. 403 `membership-required`, 500 `internal-error`).
}

Versioning

Releases follow Semantic Versioning. Breaking changes bump the major version; backwards-compatible additions bump the minor version. During the 0.x series, minor bumps may contain breaking changes.

Published with npm provenance — verify with npm audit signatures.

License

MIT © Studio Design Inc.