@contentcredits/sdk 2.0.0

package/dist/types/index.d.ts

@@ -0,0 +1,174 @@
+export interface User {
+    _id: string;
+    firstName: string;
+    lastName: string;
+    email: string;
+    credits: number;
+    roles: UserRole[];
+    isVerified: boolean;
+    isActive: boolean;
+    linkedPublisherId?: string;
+    purchaseHistory: PurchaseItem[];
+}
+export type UserRole = 'consumer' | 'publisher' | 'admin';
+export interface PurchaseItem {
+    articleId: string;
+    postUrl: string;
+    postName: string;
+    creditsSpent: number;
+    purchasedAt: string;
+}
+export interface Article {
+    _id: string;
+    publisherId: string;
+    url: string;
+    title: string;
+    creditsToPurchase: number;
+    publisherEarningRate: number;
+    totalPurchases: number;
+    isActive: boolean;
+}
+export interface Comment {
+    _id: string;
+    threadId: string;
+    parentCommentId: string | null;
+    authorId: string;
+    content: string;
+    isActive: boolean;
+    mentions: string[];
+    likeCount: number;
+    hasLiked: boolean;
+    createdAt: string;
+    updatedAt: string;
+    author?: CommentAuthor;
+    replies?: Comment[];
+}
+export interface CommentAuthor {
+    _id: string;
+    firstName: string;
+    lastName: string;
+    profilePicture?: string;
+}
+export interface CommentThread {
+    _id: string;
+    pageUrl: string;
+    hostname: string;
+    isOpen: boolean;
+}
+export type CommentSortBy = 'TOP' | 'NEWEST' | 'TIPPED_MOST';
+export interface ApiResponse<T = Record<string, unknown>> {
+    success: boolean;
+    message?: string;
+    data?: T;
+}
+export interface CheckAccessResponse {
+    success: boolean;
+    message?: string;
+}
+export interface PurchaseResponse {
+    success: boolean;
+    message?: string;
+}
+export interface CommentsResponse {
+    thread: CommentThread;
+    comments: Comment[];
+}
+export type EnsureThreadResponse = CommentThread;
+export interface SDKConfig {
+    /** Publisher API key from the Content Credits admin panel */
+    apiKey: string;
+    /** Full URL of the article page. Defaults to window.location.href */
+    articleUrl?: string;
+    /** CSS selector for the element containing the premium content to gate */
+    contentSelector?: string;
+    /** Number of visible paragraphs before the paywall kicks in. Default: 2 */
+    teaserParagraphs?: number;
+    /** Whether to enable the comment widget. Default: true */
+    enableComments?: boolean;
+    /** Override the Chrome extension ID */
+    extensionId?: string;
+    /** Visual theme options */
+    theme?: SDKTheme;
+    /** Custom HTML template string for the paywall overlay */
+    paywallTemplate?: string;
+    /** Called when the user is granted access to the article */
+    onAccessGranted?: () => void;
+    /** Enable verbose debug logging */
+    debug?: boolean;
+}
+export interface SDKTheme {
+    /** Primary brand colour used for buttons and accents. Default: '#44C678' */
+    primaryColor?: string;
+    /** Font family for all SDK UI elements */
+    fontFamily?: string;
+}
+export interface ResolvedConfig extends Required<Omit<SDKConfig, 'paywallTemplate' | 'onAccessGranted' | 'theme'>> {
+    articleUrl: string;
+    hostName: string;
+    pageTitle: string;
+    apiBaseUrl: string;
+    accountsUrl: string;
+    paywallTemplate?: string;
+    onAccessGranted?: () => void;
+    theme: Required<SDKTheme>;
+}
+export interface SDKState {
+    isLoading: boolean;
+    isExtensionAvailable: boolean;
+    isLoggedIn: boolean;
+    hasAccess: boolean;
+    isLoaded: boolean;
+    user: User | null;
+    creditBalance: number | null;
+    requiredCredits: number | null;
+}
+export interface SDKEventMap {
+    ready: {
+        state: SDKState;
+    };
+    'auth:login': {
+        user: User;
+    };
+    'auth:logout': Record<string, never>;
+    'paywall:shown': Record<string, never>;
+    'paywall:hidden': Record<string, never>;
+    'article:purchased': {
+        creditsSpent: number;
+        remainingBalance: number;
+    };
+    'credits:insufficient': {
+        required: number;
+        available: number;
+    };
+    'comment:posted': {
+        comment: Comment;
+    };
+    'comment:liked': {
+        commentId: string;
+        hasLiked: boolean;
+    };
+    'comment:deleted': {
+        commentId: string;
+    };
+    error: {
+        message: string;
+        error?: unknown;
+    };
+}
+export type SDKEventName = keyof SDKEventMap;
+export type SDKEventHandler<K extends SDKEventName> = (payload: SDKEventMap[K]) => void;
+export interface ExtensionMessage {
+    type: string;
+    data?: Record<string, unknown>;
+}
+export interface AuthorizationResponseData {
+    isAuthenticated: boolean;
+    doesHaveAccess: boolean;
+    creditBalance?: number;
+    requiredCredits?: number;
+}
+export interface PurchaseResponseData {
+    doesHaveAccess: boolean;
+    creditBalance?: number;
+    creditsSpent?: number;
+}

package/dist/ui/sanitize.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Safe DOM text node — never use innerHTML with user-generated content.
+ * Returns a text node that can be appended to any element.
+ */
+export declare function safeText(str: string): Text;
+/**
+ * Set an element's text content safely (no HTML injection).
+ */
+export declare function setTextContent(el: Element, str: string): void;
+/**
+ * Create an element with safe text content.
+ */
+export declare function el<K extends keyof HTMLElementTagNameMap>(tag: K, text?: string, attrs?: Record<string, string>): HTMLElementTagNameMap[K];
+/**
+ * Render comment content as safe DOM nodes.
+ * Supports newlines → <br> but no raw HTML from user input.
+ * Returns a DocumentFragment.
+ */
+export declare function renderCommentContent(raw: string): DocumentFragment;
+/**
+ * Validate that a URL is safe (http/https only).
+ * Returns null if unsafe.
+ */
+export declare function sanitizeUrl(url: string): string | null;

package/dist/ui/shadow.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Creates an isolated Shadow DOM host attached to document.body.
+ * All SDK UI lives inside this shadow root so partner CSS cannot
+ * bleed in and SDK CSS cannot bleed out.
+ */
+export declare function createShadowHost(id: string): {
+    host: HTMLElement;
+    root: ShadowRoot;
+};
+export declare function removeShadowHost(id: string): void;
+/** Inject a <style> tag into a shadow root */
+export declare function injectStyles(root: ShadowRoot, css: string): void;

package/dist/ui/styles.d.ts

@@ -0,0 +1,2 @@
+export declare function getPaywallStyles(primaryColor: string, fontFamily: string): string;
+export declare function getCommentStyles(primaryColor: string, fontFamily: string): string;

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@contentcredits/sdk",
+  "version": "2.0.0",
+  "description": "Content Credits JS SDK — drop-in paywall and comments for any website",
+  "author": "Content Credits",
+  "license": "MIT",
+  "main": "dist/content-credits.cjs.js",
+  "module": "dist/content-credits.esm.js",
+  "browser": "dist/content-credits.umd.min.js",
+  "types": "dist/content-credits.d.ts",
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "import": "./dist/content-credits.esm.js",
+      "require": "./dist/content-credits.cjs.js",
+      "types": "./dist/content-credits.d.ts"
+    }
+  },
+  "scripts": {
+    "build": "rollup -c rollup.config.mjs",
+    "build:watch": "rollup -c rollup.config.mjs --watch",
+    "build:dev": "USE_LOCALHOST=true rollup -c rollup.config.mjs",
+    "demo": "npm run build && npx serve . -l 4444 --no-clipboard",
+    "demo:dev": "npm run build:dev && npx serve . -l 4444 --no-clipboard",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "lint": "eslint src --ext .ts",
+    "lint:fix": "eslint src --ext .ts --fix",
+    "typecheck": "tsc --noEmit",
+    "clean": "rm -rf dist"
+  },
+  "devDependencies": {
+    "@rollup/plugin-node-resolve": "^15.2.3",
+    "@rollup/plugin-replace": "^5.0.5",
+    "@rollup/plugin-typescript": "^11.1.6",
+    "@types/node": "^20.11.5",
+    "@typescript-eslint/eslint-plugin": "^6.19.1",
+    "@typescript-eslint/parser": "^6.19.1",
+    "@vitest/coverage-v8": "^1.2.2",
+    "eslint": "^8.56.0",
+    "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"
+  }
+}