@licenseseat/js 0.1.0 → 0.2.0

package/dist/types/types.d.ts

@@ -0,0 +1,321 @@
+/**
+ * SDK Configuration options
+ */
+export type LicenseSeatConfig = {
+    /**
+     * - Base URL for the LicenseSeat API
+     */
+    apiBaseUrl?: string;
+    /**
+     * - API key for authentication (required for most operations)
+     */
+    apiKey?: string;
+    /**
+     * - Prefix for localStorage keys
+     */
+    storagePrefix?: string;
+    /**
+     * - Interval in ms for automatic license validation (default: 1 hour)
+     */
+    autoValidateInterval?: number;
+    /**
+     * - Interval in ms to check network connectivity when offline (default: 30s)
+     */
+    networkRecheckInterval?: number;
+    /**
+     * - Maximum number of retry attempts for failed API calls
+     */
+    maxRetries?: number;
+    /**
+     * - Initial delay in ms between retries (exponential backoff applied)
+     */
+    retryDelay?: number;
+    /**
+     * - Enable debug logging to console
+     */
+    debug?: boolean;
+    /**
+     * - Interval in ms to refresh offline license (default: 72 hours)
+     */
+    offlineLicenseRefreshInterval?: number;
+    /**
+     * - Enable offline validation fallback on network errors
+     */
+    offlineFallbackEnabled?: boolean;
+    /**
+     * - Maximum days a license can be used offline (0 = disabled)
+     */
+    maxOfflineDays?: number;
+    /**
+     * - Maximum allowed clock skew in ms for offline validation (default: 5 minutes)
+     */
+    maxClockSkewMs?: number;
+    /**
+     * - Automatically initialize and validate cached license on construction
+     */
+    autoInitialize?: boolean;
+};
+/**
+ * License activation options
+ */
+export type ActivationOptions = {
+    /**
+     * - Custom device identifier (auto-generated if not provided)
+     */
+    deviceIdentifier?: string;
+    /**
+     * - ISO8601 date string for version-aware activation
+     */
+    softwareReleaseDate?: string;
+    /**
+     * - Additional metadata to include with the activation
+     */
+    metadata?: any;
+};
+/**
+ * License validation options
+ */
+export type ValidationOptions = {
+    /**
+     * - Device identifier to validate against
+     */
+    deviceIdentifier?: string;
+    /**
+     * - Product slug for product-specific validation
+     */
+    productSlug?: string;
+};
+/**
+ * Activation response from the API
+ */
+export type ActivationResponse = {
+    /**
+     * - Activation ID
+     */
+    id: string;
+    /**
+     * - The activated license key
+     */
+    license_key: string;
+    /**
+     * - Device identifier used for activation
+     */
+    device_identifier: string;
+    /**
+     * - ISO8601 timestamp of activation
+     */
+    activated_at: string;
+    /**
+     * - Additional metadata
+     */
+    metadata?: any;
+};
+/**
+ * Cached license data
+ */
+export type CachedLicense = {
+    /**
+     * - The license key
+     */
+    license_key: string;
+    /**
+     * - Device identifier
+     */
+    device_identifier: string;
+    /**
+     * - Original activation response
+     */
+    activation?: ActivationResponse;
+    /**
+     * - ISO8601 timestamp of activation
+     */
+    activated_at: string;
+    /**
+     * - ISO8601 timestamp of last validation
+     */
+    last_validated: string;
+    /**
+     * - Latest validation result
+     */
+    validation?: ValidationResult;
+};
+/**
+ * Entitlement object
+ */
+export type Entitlement = {
+    /**
+     * - Unique entitlement key
+     */
+    key: string;
+    /**
+     * - Human-readable name
+     */
+    name: string | null;
+    /**
+     * - Description of the entitlement
+     */
+    description: string | null;
+    /**
+     * - ISO8601 expiration timestamp
+     */
+    expires_at: string | null;
+    /**
+     * - Additional metadata
+     */
+    metadata: any | null;
+};
+/**
+ * Validation result from API or offline verification
+ */
+export type ValidationResult = {
+    /**
+     * - Whether the license is valid
+     */
+    valid: boolean;
+    /**
+     * - Whether this was an offline validation
+     */
+    offline?: boolean;
+    /**
+     * - Reason for invalid status (online)
+     */
+    reason?: string;
+    /**
+     * - Machine-readable reason code (offline)
+     */
+    reason_code?: string;
+    /**
+     * - List of active entitlements
+     */
+    active_entitlements?: Entitlement[];
+    /**
+     * - Whether this is an optimistic validation (pending server confirmation)
+     */
+    optimistic?: boolean;
+};
+/**
+ * Entitlement check result
+ */
+export type EntitlementCheckResult = {
+    /**
+     * - Whether the entitlement is active
+     */
+    active: boolean;
+    /**
+     * - Reason if not active ("no_license" | "not_found" | "expired")
+     */
+    reason?: string;
+    /**
+     * - ISO8601 expiration timestamp if expired
+     */
+    expires_at?: string;
+    /**
+     * - Full entitlement object if active
+     */
+    entitlement?: Entitlement;
+};
+/**
+ * License status object
+ */
+export type LicenseStatus = {
+    /**
+     * - Status string ("inactive" | "pending" | "invalid" | "offline-invalid" | "offline-valid" | "active")
+     */
+    status: string;
+    /**
+     * - Human-readable status message
+     */
+    message?: string;
+    /**
+     * - License key (if active)
+     */
+    license?: string;
+    /**
+     * - Device identifier (if active)
+     */
+    device?: string;
+    /**
+     * - ISO8601 activation timestamp
+     */
+    activated_at?: string;
+    /**
+     * - ISO8601 last validation timestamp
+     */
+    last_validated?: string;
+    /**
+     * - List of active entitlements
+     */
+    entitlements?: Entitlement[];
+};
+/**
+ * Offline license payload
+ */
+export type OfflineLicensePayload = {
+    /**
+     * - License key
+     */
+    lic_k?: string;
+    /**
+     * - ISO8601 expiration timestamp
+     */
+    exp_at?: string;
+    /**
+     * - Key ID for signature verification
+     */
+    kid?: string;
+    /**
+     * - Active entitlements
+     */
+    active_ents?: Array<any>;
+    /**
+     * - Active entitlements (alternative key)
+     */
+    active_entitlements?: Array<any>;
+    /**
+     * - Additional metadata
+     */
+    metadata?: any;
+};
+/**
+ * Signed offline license data
+ */
+export type SignedOfflineLicense = {
+    /**
+     * - The license payload
+     */
+    payload: OfflineLicensePayload;
+    /**
+     * - Base64URL-encoded Ed25519 signature
+     */
+    signature_b64u: string;
+    /**
+     * - Key ID for public key lookup
+     */
+    kid?: string;
+};
+/**
+ * Event callback function
+ */
+export type EventCallback = (data: any) => void;
+/**
+ * Event unsubscribe function
+ */
+export type EventUnsubscribe = () => void;
+/**
+ * API Error data
+ */
+export type APIErrorData = {
+    /**
+     * - Error message
+     */
+    error?: string;
+    /**
+     * - Error code
+     */
+    code?: string;
+    /**
+     * - Additional error details
+     */
+    details?: any;
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/types/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/types.js"],"names":[],"mappings":";;;;;;;iBASc,MAAM;;;;aACN,MAAM;;;;oBACN,MAAM;;;;2BACN,MAAM;;;;6BACN,MAAM;;;;iBACN,MAAM;;;;iBACN,MAAM;;;;YACN,OAAO;;;;oCACP,MAAM;;;;6BACN,OAAO;;;;qBACP,MAAM;;;;qBACN,MAAM;;;;qBACN,OAAO;;;;;;;;;uBAMP,MAAM;;;;0BACN,MAAM;;;;;;;;;;;;;uBAON,MAAM;;;;kBACN,MAAM;;;;;;;;;QAMN,MAAM;;;;iBACN,MAAM;;;;uBACN,MAAM;;;;kBACN,MAAM;;;;;;;;;;;;;iBAON,MAAM;;;;uBACN,MAAM;;;;iBACN,kBAAkB;;;;kBAClB,MAAM;;;;oBACN,MAAM;;;;iBACN,gBAAgB;;;;;;;;;SAMhB,MAAM;;;;UACN,MAAM,GAAC,IAAI;;;;iBACX,MAAM,GAAC,IAAI;;;;gBACX,MAAM,GAAC,IAAI;;;;cACX,MAAO,IAAI;;;;;;;;;WAMX,OAAO;;;;cACP,OAAO;;;;aACP,MAAM;;;;kBACN,MAAM;;;;0BACN,WAAW,EAAE;;;;iBACb,OAAO;;;;;;;;;YAMP,OAAO;;;;aACP,MAAM;;;;iBACN,MAAM;;;;kBACN,WAAW;;;;;;;;;YAMX,MAAM;;;;cACN,MAAM;;;;cACN,MAAM;;;;aACN,MAAM;;;;mBACN,MAAM;;;;qBACN,MAAM;;;;mBACN,WAAW,EAAE;;;;;;;;;YAMb,MAAM;;;;aACN,MAAM;;;;UACN,MAAM;;;;kBACN,KAAK,KAAQ;;;;0BACb,KAAK,KAAQ;;;;;;;;;;;;;aAOb,qBAAqB;;;;oBACrB,MAAM;;;;UACN,MAAM;;;;;mCAMT,GAAC,KACC,IAAI;;;;qCAMJ,IAAI;;;;;;;;YAMH,MAAM;;;;WACN,MAAM"}

package/dist/types/utils.d.ts

@@ -0,0 +1,54 @@
+/**
+ * Parse active entitlements from a raw API payload into a consistent shape
+ * @param {Object} [payload={}] - Raw payload from API or offline license
+ * @returns {import('./types.js').Entitlement[]} Normalized entitlements array
+ */
+export function parseActiveEntitlements(payload?: any): import("./types.js").Entitlement[];
+/**
+ * Constant-time string comparison to mitigate timing attacks
+ * @param {string} [a=""] - First string
+ * @param {string} [b=""] - Second string
+ * @returns {boolean} True if strings are equal
+ */
+export function constantTimeEqual(a?: string, b?: string): boolean;
+/**
+ * Generate a canonical JSON string from an object (keys sorted)
+ * This is crucial for consistent signature verification.
+ * @param {Object} obj - The object to stringify
+ * @returns {string} Canonical JSON string
+ */
+export function canonicalJsonStringify(obj: any): string;
+/**
+ * Decode a Base64URL string to a Uint8Array
+ * @param {string} base64UrlString - The Base64URL encoded string
+ * @returns {Uint8Array} Decoded bytes
+ */
+export function base64UrlDecode(base64UrlString: string): Uint8Array;
+/**
+ * Simple hash function for generating device fingerprints
+ * @param {string} str - String to hash
+ * @returns {string} Base36 encoded hash
+ */
+export function hashCode(str: string): string;
+/**
+ * Get canvas fingerprint for device identification
+ * @returns {string} Canvas fingerprint or "no-canvas" if unavailable
+ */
+export function getCanvasFingerprint(): string;
+/**
+ * Generate a unique device identifier based on browser characteristics
+ * @returns {string} Unique device identifier
+ */
+export function generateDeviceId(): string;
+/**
+ * Sleep for a specified duration
+ * @param {number} ms - Duration in milliseconds
+ * @returns {Promise<void>} Resolves after the specified duration
+ */
+export function sleep(ms: number): Promise<void>;
+/**
+ * Get CSRF token from meta tag (for browser form submissions)
+ * @returns {string} CSRF token or empty string if not found
+ */
+export function getCsrfToken(): string;
+//# sourceMappingURL=utils.d.ts.map

package/dist/types/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/utils.js"],"names":[],"mappings":"AAQA;;;;GAIG;AACH,wDAFa,OAAO,YAAY,EAAE,WAAW,EAAE,CAW9C;AAED;;;;;GAKG;AACH,sCAJW,MAAM,MACN,MAAM,GACJ,OAAO,CASnB;AAED;;;;;GAKG;AACH,kDAFa,MAAM,CAuBlB;AAED;;;;GAIG;AACH,iDAHW,MAAM,GACJ,UAAU,CAatB;AAED;;;;GAIG;AACH,8BAHW,MAAM,GACJ,MAAM,CAUlB;AAED;;;GAGG;AACH,wCAFa,MAAM,CAalB;AAED;;;GAGG;AACH,oCAFa,MAAM,CAgBlB;AAED;;;;GAIG;AACH,0BAHW,MAAM,GACJ,OAAO,CAAC,IAAI,CAAC,CAIzB;AAED;;;GAGG;AACH,gCAFa,MAAM,CAMlB"}

package/package.json

@@ -1,49 +1,85 @@
 {
   "name": "@licenseseat/js",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Official JavaScript SDK for LicenseSeat – simple, secure software licensing.",
   "main": "dist/index.js",
   "module": "dist/index.js",
+  "types": "dist/types/index.d.ts",
   "exports": {
-    "import": "./dist/index.js"
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/types/index.d.ts"
+    }
   },
   "files": [
-    "dist/"
+    "dist/",
+    "src/"
   ],
   "type": "module",
+  "sideEffects": false,
   "scripts": {
-    "build": "esbuild src/index.js --bundle --format=esm --outfile=dist/index.js",
+    "build": "npm run build:js && npm run build:types",
+    "build:js": "esbuild src/index.js --bundle --format=esm --outfile=dist/index.js --external:@noble/ed25519 --external:@noble/hashes --external:canonical-json",
+    "build:bundle": "esbuild src/index.js --bundle --format=esm --outfile=dist/index.bundled.js",
+    "build:types": "tsc --project tsconfig.json",
+    "build:iife": "esbuild src/index.js --bundle --format=iife --global-name=LicenseSeat --outfile=dist/index.global.js",
     "dev": "esbuild src/index.js --bundle --format=esm --outfile=dist/index.js --watch",
-    "test": "echo \"No tests yet\""
+    "typecheck": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "lint": "eslint src/",
+    "prepublishOnly": "npm run build"
   },
   "keywords": [
     "licensing",
     "licenseseat",
     "sdk",
     "javascript",
+    "typescript",
     "js",
+    "ts",
     "software licensing",
     "license manager",
     "licensing server",
     "license key",
-    "api client"
+    "api client",
+    "license validation",
+    "offline licensing",
+    "entitlements"
   ],
   "repository": {
     "type": "git",
     "url": "https://github.com/licenseseat/licenseseat-js.git"
   },
-  "author": "rameerez",
+  "author": "LicenseSeat <hello@licenseseat.com>",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/licenseseat/licenseseat-js/issues"
   },
   "homepage": "https://licenseseat.com",
+  "engines": {
+    "node": ">=18.0.0"
+  },
   "devDependencies": {
-    "esbuild": "^0.20.2"
+    "@vitest/coverage-v8": "^1.6.0",
+    "esbuild": "^0.20.2",
+    "jsdom": "^24.1.3",
+    "msw": "^2.3.0",
+    "typescript": "^5.4.0",
+    "vitest": "^1.6.0"
   },
   "dependencies": {
     "@noble/ed25519": "^2.3.0",
     "@noble/hashes": "^1.8.0",
     "canonical-json": "^0.2.0"
+  },
+  "peerDependencies": {
+    "typescript": ">=4.7.0"
+  },
+  "peerDependenciesMeta": {
+    "typescript": {
+      "optional": true
+    }
   }
 }