@optare/optareid-js

Universal JavaScript/TypeScript SDK for Optare ID - Works in browser, Node.js, and edge runtimes.

Installation

npm install @optare/optareid-js
# or
yarn add @optare/optareid-js
# or
pnpm add @optare/optareid-js

Quick Start

Browser / Client-Side

import { OptareClient } from '@optare/optareid-js';

const client = new OptareClient({
  baseUrl: 'https://id.optare.one',
  clientId: 'your_client_id',
  token: 'user_access_token', // From OAuth flow
});

// Get current user
const user = await client.auth.getMe();
console.log(user.email);

Node.js / Server-Side

import { OptareClient } from '@optare/optareid-js';

const client = new OptareClient({
  baseUrl: 'https://id.optare.one',
  clientId: process.env.OPTARE_CLIENT_ID!,
  clientSecret: process.env.OPTARE_CLIENT_SECRET!,
  token: process.env.OPTARE_API_KEY!,
});

// Create a product
const product = await client.admin.createProduct({
  name: 'Pro Plan',
  slug: 'pro',
  features: ['sso', 'advanced-analytics'],
});

API Reference

Full API documentation with all namespaces, methods, types, and examples available at docs.optare.one.

Client Namespaces

• client.auth - Authentication methods
• client.license - Feature entitlement checking
• client.org - Organization management
• client.admin - Admin operations (products, subscriptions, OAuth apps)
• client.webhooks - Webhook signature verification

See full documentation for detailed usage of each namespace.

TypeScript Support

Full TypeScript definitions included with autocomplete support.

Runtime Support

• ✅ Browser (Chrome, Firefox, Safari, Edge)
• ✅ Node.js 18+
• ✅ Deno
• ✅ Bun
• ✅ Edge Runtimes (Cloudflare Workers, Vercel Edge)

Documentation

• Full Documentation
• API Reference
• Quick Start

License

MIT