@ofidj/node

FIDJ node tools - A TypeScript library providing utilities for client authentication, session management, and more.

Renamed from fidj-node at 1.0.0. The old fidj-node package is deprecated; install @ofidj/node.

📋 Description

Node.js library that provides a set of tools for FIDJ client authentication, connection management, session handling, and various utility functions. It's designed to simplify interactions with remote services or APIs.

🚀 Quick Start (5 minutes)

npm install @ofidj/node

import {FidjNodeService} from '@ofidj/node';

const fidj = new FidjNodeService();

// Zero-config: connects to sandbox automatically
await fidj.init();

// Or with your app ID for production
// await fidj.init('your-fidj-app-id', {prod: true});

await fidj.login('[email protected]', 'password');
const token = await fidj.fidjGetIdToken();

Where to find your fidjId? Log in to fidj.ovh, go to your app settings, and copy the App ID.

See the full Quickstart Guide for more examples (demo mode, browser usage, API calls, troubleshooting).

🧩 Modules

The library consists of several modules:

• connection: Provides classes and interfaces for client authentication and connection management
• sdk: Software development kit for interacting with services
• session: Handles user sessions
• tools: Utility functions for Base64 encoding/decoding, storage operations, and XOR operations

📚 Documentation

Please read the specifications for detailed information about each module:

• connection: Client authentication and connection management
• sdk: SDK for service interaction
• session: Session handling
• tools: Utility functions
• scenarios: Usage scenarios and examples

🧪 Testing

# Run tests
npm test

# Run tests with coverage
npm run test-coverage

📝 History

See Changelog.

📄 License

MIT