Quirin Brändli

Repositories Projects Packages

3

Public activity Starred repositories

@qf0xb/foxshield-api-client (0.1.0-nightly.11)

Published 2026-09-21 22:07:06 +00:00 by qf0xb

Installation

Setup this registry in your project .npmrc file:

@qf0xb:registry=

To install the package using npm, run the following command:

npm install @qf0xb/[email protected]

or add it to the package.json file:

"@qf0xb/foxshield-api-client": "0.1.0-nightly.11"

For more information on the npm registry, see the documentation.

About this package

@qf0xb/[email protected]

A TypeScript SDK client for the localhost API.

Usage

First, install the SDK from npm.

npm install @qf0xb/foxshield-api-client --save

Next, try it out.

import {
  Configuration,
  AuthenticationApi,
} from '@qf0xb/foxshield-api-client';
import type { LoginOperationRequest } from '@qf0xb/foxshield-api-client';

async function example() {
  console.log("🚀 Testing @qf0xb/foxshield-api-client SDK...");
  const api = new AuthenticationApi();

  const body = {
    // LoginRequest
    loginRequest: ...,
  } satisfies LoginOperationRequest;

  try {
    const data = await api.login(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Documentation

API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
AuthenticationApi	login	POST /v1/auth/login	Authenticate a tenant-scoped account
AuthenticationApi	logout	POST /v1/auth/logout	Revoke the current refresh session
AuthenticationApi	refreshTokens	POST /v1/auth/refresh	Rotate a refresh token
IdentitiesApi	deactivateIdentity	POST /v1/identities/{identityId}/deactivate	Deactivate an identity
IdentitiesApi	getCurrentIdentity	GET /v1/auth/me	Get the authenticated identity
WellKnownApi	getJsonWebKeySet	GET /.well-known/jwks.json	Get public token-signing keys

Models

• GetCurrentIdentity200Response
• GetJsonWebKeySet200Response
• GetJsonWebKeySet200ResponseKeysInner
• Identity
• JsonWebKeySet
• Login200Response
• Login400Response
• LoginRequest
• Problem
• RefreshTokenRequest
• RefreshTokensRequest
• TokenSet

Authorization

Authentication schemes defined for the API:

bearerAuth

• Type: HTTP Bearer Token authentication (JWT)

About

This TypeScript SDK client supports the Fetch API and is automatically generated by the OpenAPI Generator project:

• API version: 0.1.0-nightly.11
• Package version: 0.1.0-nightly.11
• Generator version: 7.25.0
• Build package: org.openapitools.codegen.languages.TypeScriptFetchClientCodegen

The generated npm module supports the following:

• Environments
  • Node.js
  • Webpack
  • Browserify
• Language levels
  • ES5 - you must have a Promises/A+ library installed
  • ES6
• Module systems
  • CommonJS
  • ES6 module system

Development

Building

To build the TypeScript source code, you need to have Node.js and npm installed. After cloning the repository, navigate to the project directory and run:

npm install
npm run build

Publishing

Once you've built the package, you can publish it to npm:

npm publish

License

Dependencies

Development dependencies

ID	Version
typescript	^4.0 || ^5.0

Details

npm

2026-09-21 22:07:06 +00:00

1

OpenAPI-Generator

Project website

nightly

25 KiB

Assets (1)

foxshield-api-client-0.1.0-nightly.11.tgz 25 KiB

Versions (4) View all

0.1.0-nightly.11 2026-09-21

0.1.0 2026-09-21

0.0.0-link-test.1790026206 2026-09-21

0.1.0-nightly.10 2026-09-21