@contentcredits/sdk 2.2.0 → 2.4.0

package/dist/index.d.ts

@@ -97,6 +97,13 @@ export declare class ContentCredits {
     closeComments(): void;
     /** Check if the user is currently authenticated. */
     isLoggedIn(): boolean;
+    /**
+     * Log the current user out.
+     *
+     * Revokes the refresh token on the server (best-effort), clears all local
+     * auth state, resets SDK state, and emits `auth:logout`.
+     */
+    logout(): Promise<void>;
     /** Tear down the SDK — removes all UI, event listeners, and stored state. */
     destroy(): void;
     /** SDK version string. */

package/dist/paywall/index.d.ts

@@ -3,11 +3,12 @@ import type { createCreditsApi } from '../api/credits.js';
 import type { StateStore } from '../core/state.js';
 import type { EventEmitter } from '../core/events.js';
 import type { ResolvedConfig } from '../types/index.js';
-export declare function createPaywall(config: ResolvedConfig, creditsApi: ReturnType<typeof createCreditsApi>, state: StateStore, emitter: EventEmitter, existingGate?: Gate): {
-    init: () => Promise<void>;
-    checkAccess: () => Promise<void>;
-    destroy: () => void;
-    login: () => Promise<void>;
-    purchase: () => Promise<void>;
-    buyMoreCredits: () => void;
-};
+export interface PaywallModule {
+    init(): Promise<void>;
+    checkAccess(): Promise<void>;
+    destroy(): void;
+    login(): Promise<void>;
+    purchase(): Promise<void>;
+    buyMoreCredits(): void;
+}
+export declare function createPaywall(config: ResolvedConfig, creditsApi: ReturnType<typeof createCreditsApi>, state: StateStore, emitter: EventEmitter, existingGate?: Gate): PaywallModule;

package/dist/paywall/renderer.d.ts

@@ -1,16 +1,17 @@
 import type { ResolvedConfig } from '../types/index.js';
 export type PaywallUIState = 'checking' | 'login' | 'purchase' | 'insufficient' | 'loading' | 'granted';
 export interface PaywallRendererCallbacks {
-    onLogin(): void;
-    onPurchase(): void;
+    onLogin(): void | Promise<void>;
+    onPurchase(): void | Promise<void>;
     onBuyMoreCredits(): void;
 }
-export declare function createPaywallRenderer(config: ResolvedConfig): {
-    init: () => void;
-    render: (state: PaywallUIState, callbacks: PaywallRendererCallbacks, meta?: {
+export interface PaywallRenderer {
+    init(): void;
+    render(state: PaywallUIState, callbacks: PaywallRendererCallbacks, meta?: {
         requiredCredits?: number | null;
         creditBalance?: number | null;
-    }) => void;
-    setButtonLoading: (loading: boolean) => void;
-    destroy: () => void;
-};
+    }): void;
+    setButtonLoading(loading: boolean): void;
+    destroy(): void;
+}
+export declare function createPaywallRenderer(config: ResolvedConfig): PaywallRenderer;

package/dist/types/index.d.ts

@@ -93,6 +93,64 @@ export interface SDKConfig {
     paywallTemplate?: string;
     /** Called when the user is granted access to the article */
     onAccessGranted?: () => void;
+    /**
+     * Called on every state change. Receives the full state snapshot.
+     * Use this as the single reactive hook to drive a custom UI instead of
+     * calling `cc.subscribe()` separately.
+     */
+    onStateChange?: (state: SDKState) => void;
+    /**
+     * Called once the SDK has finished its first access check.
+     * Equivalent to listening for the `ready` event.
+     */
+    onReady?: (state: SDKState) => void;
+    /**
+     * Called when the paywall is reached and the user is **not logged in**.
+     * Render your login UI here and call `cc.login()` from your button.
+     */
+    onLoginRequired?: () => void;
+    /**
+     * Called when the user is logged in but has **not yet purchased** this article.
+     * Render your unlock/purchase UI here and call `cc.purchase()` from your button.
+     */
+    onPurchaseRequired?: (info: {
+        requiredCredits: number | null;
+        creditBalance: number | null;
+    }) => void;
+    /**
+     * Called when the user is logged in but their credit balance is **below** the
+     * article price. Render a top-up UI here and call `cc.buyMoreCredits()`.
+     */
+    onInsufficientCredits?: (info: {
+        required: number;
+        available: number;
+    }) => void;
+    /**
+     * Called after a successful article purchase.
+     * Equivalent to listening for the `article:purchased` event.
+     */
+    onPurchased?: (info: {
+        creditsSpent: number;
+        remainingBalance: number;
+    }) => void;
+    /**
+     * Called when a user logs in.
+     * Equivalent to listening for the `auth:login` event.
+     */
+    onUserLogin?: (user: User) => void;
+    /**
+     * Called when the user logs out.
+     * Equivalent to listening for the `auth:logout` event.
+     */
+    onUserLogout?: () => void;
+    /**
+     * Called when any SDK error occurs.
+     * Equivalent to listening for the `error` event.
+     */
+    onError?: (info: {
+        message: string;
+        error?: unknown;
+    }) => void;
     /** Enable verbose debug logging */
     debug?: boolean;
     /**
@@ -116,7 +174,7 @@ export interface SDKTheme {
     /** Font family for all SDK UI elements */
     fontFamily?: string;
 }
-export interface ResolvedConfig extends Required<Omit<SDKConfig, 'paywallTemplate' | 'onAccessGranted' | 'theme'>> {
+export interface ResolvedConfig extends Required<Omit<SDKConfig, 'paywallTemplate' | 'onAccessGranted' | 'onStateChange' | 'onReady' | 'onLoginRequired' | 'onPurchaseRequired' | 'onInsufficientCredits' | 'onPurchased' | 'onUserLogin' | 'onUserLogout' | 'onError' | 'theme'>> {
     articleUrl: string;
     hostName: string;
     pageTitle: string;
@@ -124,6 +182,27 @@ export interface ResolvedConfig extends Required<Omit<SDKConfig, 'paywallTemplat
     accountsUrl: string;
     paywallTemplate?: string;
     onAccessGranted?: () => void;
+    onStateChange?: (state: SDKState) => void;
+    onReady?: (state: SDKState) => void;
+    onLoginRequired?: () => void;
+    onPurchaseRequired?: (info: {
+        requiredCredits: number | null;
+        creditBalance: number | null;
+    }) => void;
+    onInsufficientCredits?: (info: {
+        required: number;
+        available: number;
+    }) => void;
+    onPurchased?: (info: {
+        creditsSpent: number;
+        remainingBalance: number;
+    }) => void;
+    onUserLogin?: (user: User) => void;
+    onUserLogout?: () => void;
+    onError?: (info: {
+        message: string;
+        error?: unknown;
+    }) => void;
     theme: Required<SDKTheme>;
 }
 export interface SDKState {

package/package.json

@@ -1,9 +1,13 @@
 {
   "name": "@contentcredits/sdk",
-  "version": "2.2.0",
+  "version": "2.4.0",
   "description": "Content Credits JS SDK — drop-in paywall and comments for any website",
   "author": "Content Credits",
   "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/content-credits/sdk.git"
+  },
   "main": "dist/content-credits.cjs.js",
   "module": "dist/content-credits.esm.js",
   "browser": "dist/content-credits.umd.min.js",
@@ -35,6 +39,7 @@
   "devDependencies": {
     "@rollup/plugin-node-resolve": "^15.2.3",
     "@rollup/plugin-replace": "^5.0.5",
+    "@rollup/plugin-terser": "^0.4.4",
     "@rollup/plugin-typescript": "^11.1.6",
     "@types/node": "^20.11.5",
     "@typescript-eslint/eslint-plugin": "^6.19.1",
@@ -44,7 +49,6 @@
     "jsdom": "^24.0.0",
     "rollup": "^4.9.6",
     "rollup-plugin-dts": "^6.1.0",
-    "rollup-plugin-terser": "^7.0.2",
     "tslib": "^2.6.2",
     "typescript": "^5.3.3",
     "vitest": "^1.2.2"