mynextfocus-api-client

TypeScript/JavaScript client for the My NextFocus API. This package provides type-safe access to all API endpoints including authentication, sessions, activities, budget rules, reports, and user management.

Installation

npm install mynextfocus-api-client

Usage

import { Configuration, SessionsApi, AuthApi } from 'mynextfocus-api-client';

// Configure the API client
const configuration = new Configuration({
  basePath: 'http://127.0.0.1:8000',
  accessToken: 'your-jwt-token-here',
});

// Use the APIs
const sessionsApi = new SessionsApi(configuration);
const authApi = new AuthApi(configuration);

// Example: Get all sessions
const sessions = await sessionsApi.sessionsGet();

Building

To build the package from source:

npm install
npm run build

This will compile TypeScript to JavaScript in the dist/ directory.

Publishing

1. Make sure you're logged in: npm login
2. Build the package: npm run build
3. Publish: npm publish --access public

Versioning

Update the version in package.json before publishing:

• Patch: npm version patch (0.1.0 → 0.1.1)
• Minor: npm version minor (0.1.0 → 0.2.0)
• Major: npm version major (0.1.0 → 1.0.0)

Environment Support

• Node.js: >= 14.0.0
• Browsers: Modern browsers with Fetch API support
• TypeScript: ^4.0 || ^5.0
• Module Systems: CommonJS and ES6 modules

API Documentation

See the API Documentation for detailed endpoint information.