@usecolf/shared

v1.0.1

Published

COLF shared utilities, cryptographic Ed25519 signing/verification, and licensing types

Readme

@usecolf/shared

Shared utilities, Ed25519 cryptographic license verification, error classes, and common types for COLF SDKs.

Overview

@usecolf/shared provides cross-cutting infrastructure used across all @usecolf/* packages, including Ed25519 cryptographic token signing, offline license key validation, unified error hierarchies, and string helper utilities.

Features

  • Ed25519 Cryptographic Validation: Validates signed COLF license keys offline without network latency.
  • Unified Error Handling: Standardized COLFError classes and codes across server and client runtimes.
  • License Claims Schema: Strong TypeScript interfaces for Free, Pro, and Enterprise license claims.

Installation

npm install @usecolf/shared
# or
pnpm add @usecolf/shared

Quick Start

import { verifyLicense, parseLicenseKey } from '@usecolf/shared';

const licenseKey = 'colf_live_...';
const publicKeys = ['...'];

const claims = verifyLicense(licenseKey, publicKeys);
if (claims.valid) {
  console.log(`License active for plan: ${claims.plan}`);
} else {
  console.error(`Invalid license: ${claims.reason}`);
}

License

MIT © COLF Team