@hopps/api-client v1.0.2

@hopps/api-client

The hopps API client library for interacting with the hopps backend services.

Description

This package provides a TypeScript client for the hopps API, allowing you to easily interact with the backend services from your frontend application. It includes auto-generated clients for the organization service and other API endpoints.

Installation

npm install @hopps/api-client

Usage

import { createApiService } from '@hopps/api-client';

// Create an API service instance
const apiService = createApiService({
  orgBaseUrl: 'https://api.hopps.org',
  finBaseUrl: 'https://finance.hopps.org',
  getAccessToken: () => localStorage.getItem('access_token'),
  refreshToken: async () => {
    // Implement your token refresh logic here
    // For example:
    const response = await fetch('https://auth.hopps.org/refresh', {
      method: 'POST',
      headers: {
        'Content-Type': 'application/json',
      },
      body: JSON.stringify({
        refresh_token: localStorage.getItem('refresh_token'),
      }),
    });
    
    const data = await response.json();
    localStorage.setItem('access_token', data.access_token);
    return true;
  },
});

// Use the API service
async function getOrganization() {
  try {
    const organization = await apiService.organization.getOrganization('my-org');
    console.log(organization);
  } catch (error) {
    console.error('Failed to get organization:', error);
  }
}

Generating the Organization Service Client

The organization service client (OrgService.ts) is auto-generated from the OpenAPI specification using NSwag. To regenerate the client after changes to the API, run:

npm run generate:org-service

This command uses the OpenAPI specification located at ../../backend/app.hopps.org//target/openapi/openapi.json by default.

Providing a Custom OpenAPI Specification

If you want to use a different OpenAPI specification for generating the client, you can:

Option 1: Modify the package.json script

Edit the generate:org-service script in package.json to point to your custom OpenAPI specification:

"scripts": {
  "generate:org-service": "nswag openapi2tsclient /input:path/to/your/openapi.json /output:./src/services/OrgService.ts"
}

Option 2: Use a local file

1. Save your OpenAPI specification to a local file
2. Run the nswag command directly:

npx nswag openapi2tsclient /input:path/to/your/openapi.json /output:./src/services/OrgService.ts

Option 3: Use a URL

You can also generate the client from an OpenAPI specification available at a URL:

npx nswag openapi2tsclient /input:http://your-api-server/v3/api-docs /output:./src/services/OrgService.ts

Configuration

The client generation is configured in the org-service.nswag file. You can modify this file to change the generation options, such as:

• The TypeScript version
• The HTTP client template
• Naming conventions
• Type generation options

After modifying the configuration, regenerate the client using the command above.

Development

To build the package:

npm run build

To publish the package:

npm run publish

License

MIT