@contentcredits/sdk 2.0.0 → 2.0.2

package/LICENSE

@@ -0,0 +1,178 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship made available under
+      the License, as indicated by a copyright notice that is included in
+      or attached to the work (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean, as submitted to the Licensor for inclusion
+      in the Work by the copyright owner or by an individual or Legal Entity
+      authorized to submit on behalf of the copyright owner. For the purposes
+      of this definition, "submitted" means any form of electronic, verbal,
+      or written communication sent to the Licensor or its representatives,
+      including but not limited to communication on electronic mailing lists,
+      source code control systems, and issue tracking systems that are managed
+      by, or on behalf of, the Licensor for the purpose of discussing and
+      improving the Work, but excluding communication that is conspicuously
+      marked or designated in writing by the copyright owner as "Not a
+      Contribution."
+
+      "Contributor" shall mean Licensor and any Legal Entity on behalf of
+      whom a Contribution has been received by the Licensor and included
+      within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by the combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a cross-claim
+      or counterclaim in a lawsuit) alleging that the Work or any
+      Contribution embodied within the Work constitutes direct or contributory
+      patent infringement, then any patent licenses granted to You under
+      this License for that Work shall terminate as of the date such
+      litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative
+          Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, You must include a readable copy of the
+          attribution notices contained within such NOTICE file, in
+          at least one of the following places: within a NOTICE text
+          file distributed as part of the Derivative Works; within
+          the Source form or documentation, if provided along with the
+          Derivative Works; or, within a display generated by the
+          Derivative Works, if and wherever such third-party notices
+          normally appear. The contents of the NOTICE file are for
+          informational purposes only and do not modify the License.
+          You may add Your own attribution notices within Derivative
+          Works that You distribute, alongside or in addition to the
+          NOTICE text from the Work, provided that such additional
+          attribution notices cannot be construed as modifying the License.
+
+   You may add Your own license statement for Your modifications and
+   may provide additional grant of rights to use, copy, modify, and
+   distribute those modifications.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or reproducing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or exemplary damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or all other
+      commercial damages or losses), even if such Contributor has been
+      advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may offer only
+      conditions consistent with this License.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2025 Content Credits
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied. See the License for the specific language governing
+   permissions and limitations under the License.

package/README.md

@@ -0,0 +1,180 @@
+# @contentcredits/sdk
+
+[![npm version](https://img.shields.io/npm/v/@contentcredits/sdk)](https://www.npmjs.com/package/@contentcredits/sdk)
+[![license](https://img.shields.io/badge/license-Apache%202.0-blue)](https://github.com/contentcredits/sdk/blob/main/LICENSE)
+[![TypeScript](https://img.shields.io/badge/TypeScript-5.x-blue)](https://www.typescriptlang.org/)
+
+Drop-in paywall and threaded comment system for any website. Add credit-based article monetisation in under 5 minutes — no backend changes required.
+
+**[Full documentation →](https://docs.contentcredits.com)**
+
+---
+
+## What it does
+
+- **Paywall** — hides premium content behind a credit gate using a CSS selector. Reveals it instantly when the reader pays. No server-side content splitting needed.
+- **Comments** — threaded comment panel with likes, edit, delete, and sorting. Rendered in a Shadow DOM so it never conflicts with your CSS.
+- **Auth** — popup-based login on desktop, redirect flow on mobile. Tokens stored in memory (never cookies).
+- **Extension support** — detects the Content Credits Chrome extension for a one-click experience.
+
+---
+
+## Installation
+
+```bash
+npm install @contentcredits/sdk
+```
+
+Or via CDN (no build step):
+
+```html
+<script src="https://cdn.jsdelivr.net/npm/@contentcredits/sdk@2.0.0/dist/content-credits.umd.min.js"></script>
+```
+
+---
+
+## Quick start
+
+### Script tag (CDN)
+
+```html
+<!-- Wrap your premium content -->
+<div id="premium-content">
+  <p>This content is only visible after the reader pays.</p>
+</div>
+
+<!-- Load and initialise the SDK -->
+<script src="https://cdn.jsdelivr.net/npm/@contentcredits/sdk@2.0.0/dist/content-credits.umd.min.js"></script>
+<script>
+  ContentCreditsSDK.ContentCredits.init({
+    apiKey: 'pub_YOUR_API_KEY',
+    contentSelector: '#premium-content',
+    teaserParagraphs: 2,
+    enableComments: true,
+  });
+</script>
+```
+
+### Auto-init (zero JavaScript)
+
+```html
+<script
+  src="https://cdn.jsdelivr.net/npm/@contentcredits/sdk@2.0.0/dist/content-credits.umd.min.js"
+  data-api-key="pub_YOUR_API_KEY"
+  data-content-selector="#premium-content"
+  data-teaser-paragraphs="2"
+></script>
+```
+
+### npm / ES module
+
+```ts
+import { ContentCredits } from '@contentcredits/sdk';
+
+const cc = ContentCredits.init({
+  apiKey: 'pub_YOUR_API_KEY',
+  contentSelector: '#premium-content',
+  teaserParagraphs: 2,
+  enableComments: true,
+});
+
+cc.on('paywall:hidden', () => {
+  console.log('Article unlocked!');
+});
+```
+
+---
+
+## Configuration
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `apiKey` | `string` | **required** | Your publisher API key from the dashboard |
+| `contentSelector` | `string` | `'.cc-premium-content'` | CSS selector for the gated element |
+| `teaserParagraphs` | `number` | `2` | Paragraphs to show before the paywall |
+| `enableComments` | `boolean` | `true` | Show the comment widget |
+| `articleUrl` | `string` | `location.href` | Canonical URL of the article |
+| `theme.primaryColor` | `string` | `'#44C678'` | Brand colour for buttons |
+| `theme.fontFamily` | `string` | system UI | Font for all SDK UI |
+| `onAccessGranted` | `() => void` | — | Fires when content is unlocked |
+| `debug` | `boolean` | `false` | Verbose console logging |
+
+---
+
+## Events
+
+```ts
+cc.on('ready',               ({ state }) => { });
+cc.on('auth:login',          ({ user }) => { });
+cc.on('auth:logout',         () => { });
+cc.on('paywall:shown',       () => { });
+cc.on('paywall:hidden',      () => { });
+cc.on('article:purchased',   ({ creditsSpent, remainingBalance }) => { });
+cc.on('credits:insufficient',({ required, available }) => { });
+cc.on('comment:posted',      ({ comment }) => { });
+cc.on('comment:liked',       ({ commentId, hasLiked }) => { });
+cc.on('comment:deleted',     ({ commentId }) => { });
+cc.on('error',               ({ message, error }) => { });
+```
+
+All events are also dispatched as native `CustomEvent`s on `document` with the prefix `contentcredits:` — useful for Google Tag Manager and analytics integrations.
+
+---
+
+## API
+
+```ts
+const cc = ContentCredits.init(config);
+
+cc.on(event, handler)    // subscribe — returns unsubscribe fn
+cc.off(event, handler)   // unsubscribe
+cc.getState()            // → SDKState snapshot
+cc.checkAccess()         // trigger access check manually
+cc.openComments()        // open comment panel
+cc.closeComments()       // close comment panel
+cc.isLoggedIn()          // → boolean
+cc.destroy()             // tear down SDK, restore hidden content
+
+ContentCredits.version   // → "2.0.0"
+```
+
+---
+
+## React / Next.js
+
+```tsx
+'use client'; // Next.js App Router
+
+import { useEffect } from 'react';
+import { ContentCredits } from '@contentcredits/sdk';
+
+export function PremiumGate({ apiKey, children }) {
+  useEffect(() => {
+    const cc = ContentCredits.init({
+      apiKey,
+      contentSelector: '#premium-content',
+    });
+    return () => cc.destroy();
+  }, [apiKey]);
+
+  return <div id="premium-content">{children}</div>;
+}
+```
+
+---
+
+## Requirements
+
+- Modern browsers (Chrome, Firefox, Safari, Edge)
+- Your domain must be registered as a publisher at [app.contentcredits.com](https://app.contentcredits.com)
+- HTTPS required in production
+
+---
+
+## Links
+
+- [Full documentation](https://docs.contentcredits.com)
+- [Quick start guide](https://docs.contentcredits.com/getting-started/quick-start)
+- [API reference](https://docs.contentcredits.com/api-reference/contentcredits-class)
+- [Publisher dashboard](https://app.contentcredits.com)
+- [Content Credits website](https://contentcredits.com)

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@contentcredits/sdk",
-  "version": "2.0.0",
+  "version": "2.0.2",
   "description": "Content Credits JS SDK — drop-in paywall and comments for any website",
   "author": "Content Credits",
-  "license": "MIT",
+  "license": "Apache-2.0",
   "main": "dist/content-credits.cjs.js",
   "module": "dist/content-credits.esm.js",
   "browser": "dist/content-credits.umd.min.js",