teamsync-pdf-viewer 1.0.3

package/LICENSE

@@ -0,0 +1,77 @@
+Common Public Attribution License Version 1.0 (CPAL)
+
+1. “Definitions”
+
+1.0.1 “Commercial Use” means distribution or otherwise making the Covered Code available to a third party.
+
+1.1 “Contributor” means each entity that creates or contributes to the creation of Modifications.
+
+1.2 “Contributor Version” means the combination of the Original Code, prior Modifications used by a Contributor, and the Modifications made by that particular Contributor.
+
+1.3 “Covered Code” means the Original Code or Modifications or the combination of the Original Code and Modifications, in each case including portions thereof.
+
+1.4 “Electronic Distribution Mechanism” means a mechanism generally accepted in the software development community for the electronic transfer of data.
+
+1.5 “Executable” means Covered Code in any form other than Source Code.
+
+1.6 “Initial Developer” means the individual or entity identified as the Initial Developer in the Source Code notice required by Exhibit A.
+
+1.7 “Larger Work” means a work which combines Covered Code or portions thereof with code not governed by the terms of this License.
+
+1.8 “License” means this document.
+
+1.8.1 “Licensable” means having the right to grant, to the maximum extent possible, whether at the time of the initial grant or subsequently acquired, any and all of the rights conveyed herein.
+
+1.9 “Modifications” means any addition to or deletion from the substance or structure of either the Original Code or any previous Modifications. When Covered Code is released as a series of files, a Modification is:
+
+A. Any addition to or deletion from the contents of a file containing Original Code or previous Modifications.
+
+B. Any new file that contains any part of the Original Code or previous Modifications.
+
+1.10 “Original Code” means Source Code of computer software code which is described in the Source Code notice required by Exhibit A as Original Code, and which, at the time of its release under this License is not already Covered Code governed by this License.
+
+1.10.1 “Patent Claims” means any patent claim(s), now owned or hereafter acquired, including without limitation, method, process, and apparatus claims, in any patent Licensable by grantor.
+
+1.11 “Source Code” means the preferred form of the Covered Code for making modifications to it, including all modules it contains, plus any associated interface definition files, scripts used to control compilation and installation of an Executable, or source code differential comparisons against either the Original Code or another well known, available Covered Code of the Contributor’s choice. The Source Code can be in a compressed or archival form, provided the appropriate decompression or de-archiving software is widely available for no charge.
+
+1.12 “You” (or “Your”) means an individual or a legal entity exercising rights under, and complying with all of the terms of, this License or a future version of this License issued under Section 6.1. For legal entities, “You” includes any entity which controls, is controlled by, or is under common control with You. For purposes of this definition, “control” means (a) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (b) ownership of more than fifty percent (50%) of the outstanding shares or beneficial ownership of such entity.
+
+2. Source Code License.
+
+2.1 The Initial Developer Grant.
+The Initial Developer hereby grants You a world-wide, royalty-free, non-exclusive license, subject to third party intellectual property claims:
+
+     (a) under intellectual property rights (other than patent or trademark) Licensable by Initial Developer to use, reproduce, modify, display, perform, sublicense and distribute the Original Code (or portions thereof) with or without Modifications, and/or as part of a Larger Work; and
+
+     (b) under Patents Claims infringed by the making, using or selling of Original Code, to make, have made, use, practice, sell, and offer for sale, and/or otherwise dispose of the Original Code (or portions thereof).
+
+     (c) the licenses granted in this Section 2.1(a) and (b) are effective on the date Initial Developer first distributes Original Code under the terms of this License.
+
+     (d) Notwithstanding Section 2.1(b) above, no patent license is granted: 1) for code that You delete from the Original Code; 2) separate from the Original Code; or 3) for infringements caused by: i) the modification of the Original Code or ii) the combination of the Original Code with other software or devices.
+
+2.2 Contributor Grant.
+Subject to third party intellectual property claims, each Contributor hereby grants You a world-wide, royalty-free, non-exclusive license
+
+     (a) under intellectual property rights (other than patent or trademark) Licensable by Contributor, to use, reproduce, modify, display, perform, sublicense and distribute the Modifications created by such Contributor (or portions thereof) either on an unmodified basis, with other Modifications, as Covered Code and/or as part of a Larger Work; and
+
+     (b) under Patent Claims infringed by the making, using, or selling of Modifications made by that Contributor either alone and/or in combination with its Contributor Version (or portions of such combination), to make, use, sell, offer for sale, have made, and/or otherwise dispose of: 1) Modifications made by that Contributor (or portions thereof); and 2) the combination of Modifications made by that Contributor with its Contributor Version (or portions of such combination).
+
+     (c) the licenses granted in Sections 2.2(a) and 2.2(b) are effective on the date Contributor first makes Commercial Use of the Covered Code.
+
+     (d) Notwithstanding Section 2.2(b) above, no patent license is granted: 1) for any code that Contributor has deleted from the Contributor Version; 2) separate from the Contributor Version; 3) for infringements caused by: i) third party modifications of Contributor Version or ii) the combination of Modifications made by that Contributor with other software (except as part of the Contributor Version) or other devices; or 4) under Patent Claims infringed by Covered Code in the absence of Modifications made by that Contributor.
+
+3. Distribution Obligations.
+
+3.1 Application of License.
+The Modifications which You create or to which You contribute are governed by the terms of this License, including without limitation Section 2.2. The Source Code version of Covered Code may be distributed only under the terms of this License or a future version of this License released under Section 6.1, and You must include a copy of this License with every copy of the Source Code You distribute. You may not offer or impose any terms on any Source Code version that alters or restricts the applicable version of this License or the recipients’ rights hereunder. However, You may include an additional document offering the additional rights described in Section 3.5.
+
+3.2 Availability of Source Code.
+Any Modification which You create or to which You contribute must be made available in Source Code form under the terms of this License either on the same media as an Executable version or via an accepted Electronic Distribution Mechanism to anyone to whom you made an Executable version available; and if made available via Electronic Distribution Mechanism, must remain available for at least twelve (12) months after the date it initially became available, or at least six (6) months after a subsequent version of that particular Modification has been made available to such recipients. You are responsible for ensuring that the Source Code version remains available even if the Electronic Distribution Mechanism is maintained by a third party.
+
+3.3 Description of Modifications.
+You must cause all Covered Code to which You contribute to contain a file documenting the changes You made to create that Covered Code and the date of any change. You must include a prominent statement that the Modification is derived, directly or indirectly, from Original Code provided by the Initial Developer and including the name of the Initial Developer in (a) the Source Code, and (b) in any notice in an Executable version or related documentation in which You describe the origin or ownership of the Covered Code.
+
+3.4 Intellectual Property Matters
+
+     (a) Third Party Claims.  If Contributor has knowledge that a license under a third party’s intellectual property rights is required to exercise the rights granted by such Contributor under Sections 2.1 or 2.2, Contributor must include a text file with the Source Code distribution titled “LEGAL” which describes the claim and the party making the claim in sufficient detail that a recipient will know whom to contact. If Contributor obtains such knowledge after the Modificati
+

package/README.md

@@ -0,0 +1,233 @@
+# TeamSync PDF Viewer SDK
+
+<div align="center">
+
+![TeamSync PDF Viewer UI](https://raw.githubusercontent.com/angelbot-ai/TeamSync-PDF-Viewer/main/docs/images/viewer_ui.png)
+
+### **100% Open Source. 100% Client-Side. Enterprise PDF Engine.**
+
+[![License: CPAL-1.0](https://img.shields.io/badge/License-CPAL--1.0-blue.svg)](LICENSE)
+[![Live Demo](https://img.shields.io/badge/Live%20Demo-pdfviewer.teamsync.com-000000.svg)](https://pdfviewer.teamsync.com/)
+[![NPM Version](https://img.shields.io/badge/npm-%40angelbot--ai%2Fteamsync--pdf--viewer-blue.svg)](https://www.npmjs.com/package/teamsync-pdf-viewer)
+[![React 19](https://img.shields.io/badge/React-19-61dafb.svg)](https://reactjs.org/)
+[![Vite 8](https://img.shields.io/badge/Vite-8.2-646cff.svg)](https://vitejs.dev/)
+[![TypeScript](https://img.shields.io/badge/TypeScript-6.0-blue.svg)](https://www.typescriptlang.org/)
+
+*No paywalls. No vendor lock-in. No server dependencies.*  
+Try the **[Interactive Live Demo](https://pdfviewer.teamsync.com/)** or integrate the high-performance PDF Viewer SDK into your React applications.
+
+</div>
+
+---
+
+## 🚀 Why TeamSync PDF Viewer?
+
+Traditional commercial PDF viewers force developers into expensive per-domain licenses, opaque sales calls, and heavy server-side processing dependencies. **TeamSync PDF Viewer** is built from the ground up to solve these pain points.
+
+- 💰 **Zero-Cost, Transparent Licensing**: Uncapped usage, no per-server fees, and no commercial paywalls. 100% free and open-source under CPAL 1.0.
+- ⚡ **100% Client-Side WebAssembly**: Documents never leave the browser sandbox. Process, redact, and render PDFs entirely on the client—guaranteeing instant **HIPAA**, **GDPR**, and **FINRA** compliance.
+- 🔌 **Universal WebViewer API**: Clean, intuitive `WebViewer({...})` API interface that makes integrating into your web applications effortless.
+- 🎨 **Headless & Customizable**: Built for modern React 19 SPA lifecycles. No bloated iFrames to fight—customize toolbars, sidebars, context menus, and controls natively.
+
+---
+
+## 📦 Installation via NPM
+
+Install the package into your React / TypeScript project:
+
+```bash
+# Using npm
+npm install teamsync-pdf-viewer
+
+# Using yarn
+yarn add teamsync-pdf-viewer
+
+# Using pnpm
+pnpm add teamsync-pdf-viewer
+```
+
+### Installing from GitHub Packages (Alternative)
+
+If installing from GitHub Packages registry:
+
+1. Create or update your `.npmrc` file:
+   ```ini
+   @angelbot-ai:registry=https://npm.pkg.github.com
+   ```
+2. Install via npm:
+   ```bash
+   npm install teamsync-pdf-viewer
+   ```
+
+---
+
+## 📖 Official Documentation & Wiki
+
+Explore detailed SDK guides, parameter options, code snippets, and architecture deep dives:
+
+- 🏠 **[Wiki Home](docs/wiki/Home.md)**: Main documentation index & overview.
+- 🚀 **[Getting Started Guide](docs/wiki/Getting-Started.md)**: Installation, CDN, and framework setups.
+- ⚙️ **[API Reference & Options](docs/wiki/API-Reference-&-Options.md)**: Complete parameter list for `WebViewerOptions` & `SDKPermissions`.
+- 🎨 **[Annotations & Markup Guide](docs/wiki/Annotations-&-Markup-Guide.md)**: Freehand drawing, vector shapes, callouts & links.
+- 🛡️ **[Redactions & PII Sanitization Guide](docs/wiki/Redactions-&-PII-Sanitization.md)**: Binary redactions, regex PII scanning & discard options.
+- 💧 **[Forensic Watermarking Guide](docs/wiki/Forensic-Watermarking.md)**: Dynamic single and tiled watermark setup.
+- 🔌 **[Plugin Architecture Guide](docs/wiki/Plugin-Architecture.md)**: Writing custom extension plugins.
+
+---
+
+## ✨ Uncompromised Feature Set
+
+Everything you need to build collaborative, secure document workflows.
+
+### 🎨 Smart Markup & Annotations
+- **Full Drawing Toolkit**: Freehand ink (`brush`), highlighters, geometric shapes (rectangles, ellipses), arrows, and lines.
+- **Notes & Callouts**: Sticky notes, callout text boxes with directional arrows, and text annotations.
+- **Interactive Hyperlinks**: Create internal page-jump links (`#page=N`) or external web URL links directly on document selections.
+
+### 🛡️ Military-Grade Secure Redaction
+- **Binary-Level Data Obliteration**: We don't just place black boxes over text—redactions are permanently rasterized and burned into the underlying PDF vector structure.
+- **Text Layer Sanitization**: Redacted text is automatically stripped from the DOM `textLayer` and PDF content streams, preventing copy/paste extraction and search indexing.
+- **Automatic Regex Redactions**: Programmatically locate and redact sensitive PII (Aadhaar numbers, SSNs, credit cards, dates of birth) in a single click.
+- **Discard Unapplied Redactions**: Easily discard individual pending redactions or bulk-discard all unapplied redaction marks before committing.
+
+### 🔍 High-DPI Canvas Rendering & Search
+- **Retina 60 FPS Zoom & Pan**: High-DPI `devicePixelRatio` scaling eliminates blurred text. Micro-debounced rendering enables buttery-smooth 60 FPS trackpad pinching and 360° mouse drag panning.
+- **Contextual Document Search**: Instant client-side text search with real-time match highlighting, result jumping, and match counting.
+
+### 💧 Dynamic Forensic Watermarking
+- Programmatic, non-destructive watermarks rendered on the fly (single centered or full-page tiled) with customizable text, color, opacity, font size, and rotation.
+
+---
+
+## 💻 Developer SDK Usage
+
+### Standard WebViewer Initialization
+
+Drop the SDK into any container element with a single function call:
+
+```typescript
+import { WebViewer } from 'teamsync-pdf-viewer';
+import 'teamsync-pdf-viewer/style.css';
+
+WebViewer({
+  initialDoc: '/sample.pdf',
+  initialScale: 1.0, // 100% natural size
+  enableAnnotations: true,
+  permissions: {
+    canRedact: true,
+    canAddAnnotations: true
+  },
+  watermark: {
+    text: 'CONFIDENTIAL',
+    mode: 'single',
+    size: 48,
+    opacity: 0.1,
+    color: '#dc2626'
+  }
+}, document.getElementById('viewer-container')).then((instance) => {
+  console.log('TeamSync PDF Viewer is ready!', instance);
+  
+  // Export annotated PDF buffer
+  instance.Core.documentViewer.getDocument().getFileData().then((pdfBytes) => {
+    console.log('Exported PDF byte length:', pdfBytes.length);
+  });
+});
+```
+
+### Native React Component Usage
+
+For native React integration, use the `<DocumentViewer />` component:
+
+```tsx
+import { DocumentViewer } from 'teamsync-pdf-viewer';
+import 'teamsync-pdf-viewer/style.css';
+
+function App() {
+  return (
+    <div style={{ width: '100vw', height: '100vh' }}>
+      <DocumentViewer
+        initialDoc="/contract.pdf"
+        scale={1.0}
+        enableAnnotations={true}
+        permissions={{ canRedact: true }}
+      />
+    </div>
+  );
+}
+```
+
+---
+
+## 🛠️ Local Development Quick Start
+
+### 1. Clone & Install
+
+```bash
+git clone https://github.com/angelbot-ai/TeamSync-PDF-Viewer.git
+cd TeamSync-PDF-Viewer
+npm install
+```
+
+### 2. Launch Dev Server
+
+```bash
+npm run dev
+```
+
+Open `http://localhost:5173` in your browser to launch the live SDK viewer.
+
+---
+
+## 🔌 Extensible Plugin Architecture
+
+TeamSync PDF Viewer features a decoupled **Plugin Architecture**. Core PDF rendering, smart annotations, redaction engines, and search remain lightweight and modular in the main engine, while enterprise extensions plug in as independent modules.
+
+```
+┌─────────────────────────────────────────────────────────┐
+│              TeamSync PDF Viewer Core                   │
+│   (Page Rendering, Annotations, Redactions, Search)     │
+└───────────────────────────┬─────────────────────────────┘
+                            │ Plugins Registry API
+┌───────────────────────────▼─────────────────────────────┐
+│                   Custom Extension                      │
+│      (Custom Modals, Action Buttons, Export Hooks)      │
+└─────────────────────────────────────────────────────────┘
+```
+
+---
+
+## 🏛️ Architecture & Tech Stack
+
+- **Core Engine**: HTML5, TypeScript, WebAssembly (PDF.js + pdf-lib)
+- **UI & State**: React 19, Lucide Icons, Pure CSS Modules
+- **Build System**: Vite 8 & Oxlint (Sub-500ms tree-shakable builds)
+
+```
+TeamSync-PDF-Viewer/
+├── src/
+│   ├── components/       # Native React UI (Header, DocumentViewer, Sidebars, Modals)
+│   ├── hooks/            # Search & Keyboard shortcut hooks
+│   ├── utils/            # Redaction algorithms & vector helpers
+│   ├── plugins/          # Plugin API interfaces & registry
+│   ├── index.ts          # Main SDK package exports
+│   ├── main.tsx          # WebViewer SDK entry point & public API bridge
+│   └── App.tsx           # Demo Application Shell
+├── public/               # Static PDF assets & PDF.js workers
+└── docs/images/          # High-res UI documentation screenshots
+```
+
+---
+
+## 📄 License
+
+Distributed under the **CPAL 1.0 (Common Public Attribution License)**.  
+100% Free and Open Source for personal and commercial usage.
+
+---
+<div align="center">
+  <b>AngelBot AI • TeamSync • </b> <a href="https://www.teamsync.com" target="_blank" rel="noopener noreferrer">https://www.teamsync.com</a>
+</div>
+
+<div align="center">
+  <b>TeamSync PDF Viewer Engine</b> • Engineered with ❤️ for the Open Web.
+</div>