@rsj-de/pdfmergesortsplit 0.1.0 → 0.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 RSJ Software GmbH, Germering, Germany
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,32 +1,67 @@
-# @rsj-de/pdfmergesortsplit — RSJ PDF Merge, Sort & Split SDK
-
-> The editor runs in test mode without a licence: everything works, a banner
-> shows that the embedding is unlicensed. See
-> [Licensing](https://pdfmerge.rsj.de/docs/licensing).
-
-Embed the editor of <https://pdfmerge.rsj.de> in your own product. One iframe, a
-small SDK, and documents that never leave the browser.
-
-Two levels, same editor:
-
-- **Low-level** `PDFMergeSortSplitClass` (`@rsj-de/pdfmergesortsplit`) — any framework.
-- **High-level** `<PDFMergeSortSplit>` + `usePdfMergeSortSplit`
-  (`@rsj-de/pdfmergesortsplit/react`) — React, built on the class.
+# @rsj-de/pdfmergesortsplit
+
+Embed the PDF editor of [pdfmerge.rsj.de](https://pdfmerge.rsj.de) in your own
+product: merging, sorting, rotating, splitting and exporting PDFs inside one
+iframe, with the documents never leaving the browser.
+
+**Website:** <https://pdfmerge.rsj.de> · **Documentation:**
+<https://pdfmerge.rsj.de/docs> · **Source and samples:**
+<https://github.com/pdfmergesortsplit/pdfmergesortsplit> · **Licence:** MIT
+([LICENSE](LICENSE))
+
+## Features
+
+- **Merge** any number of PDFs, or ZIP archives containing PDFs.
+- **Sort** pages by drag & drop, including multi-selection (Ctrl/Cmd+click,
+  Shift+click a range); rotate, duplicate and delete one page or a whole
+  selection; undo/redo on every edit.
+- **Split** into parts: every part has a title line, an editable name used as
+  the file name, and its own save and print button. Pages can be moved between
+  parts, also with the keyboard.
+- **Export** one PDF per part, one merged PDF, or a ZIP of all parts — from your
+  own buttons or from the editor's.
+- **Page provenance**: every page keeps the source file and page it came from;
+  a source can bring its own provenance, it can be written into exported PDFs,
+  and it is restored when such a PDF is imported again.
+- **Google Drive**: open a file from Drive's "Open with" menu, browse Drive in
+  the editor's own dialog, and save the result back to Drive.
+- **Your branding**: replace the title and icon, hide any control, inject your
+  own buttons into three injection points and receive their clicks as events.
+- **Your product's look**: light and dark theme, a page viewer, seven languages.
+- **Nothing uploaded**: PDFs are parsed, edited and rebuilt in the visitor's
+  browser; no document reaches a server.
+- **Two levels**: a framework-agnostic class and a React component with a hook.
+
+## Business model
+
+The **code** of this SDK is MIT-licensed (see [LICENSE](LICENSE)): read it, fork
+it, change it, ship it.
+
+The **editor it embeds** is a subscription product. An embedded editor asks for a
+licence token (`apiKey`); without a valid one it runs in **test mode** — every
+feature works, a banner marks the embedding as unlicensed. Licences are per
+integration and volume, not per page.
+
+- Pricing and the licence model: <https://pdfmerge.rsj.de/docs/licensing>
+- A licence: [info@rsj.de](mailto:info@rsj.de?subject=RSJ%20PDF%20Merge%20SDK%20licence)
+
+## Install
 
 ```bash
-pnpm add @rsj-de/pdfmergesortsplit
+npm install @rsj-de/pdfmergesortsplit
 ```
 
+`react` is an optional peer dependency: the plain class does not import it.
+
+## Quick start
+
 ```js
 import { PDFMergeSortSplitClass } from '@rsj-de/pdfmergesortsplit';
 
 const editor = new PDFMergeSortSplitClass('#editor', {
-  embedUrl: 'https://pdfmerge.rsj.de',   // or your self-hosted deployment
-  apiKey: '<licence JWT>',                // removes the test-mode banner
+  apiKey: '<licence JWT>',              // test mode without one
   title: 'Acme Document Suite',
-  ui: { toolbar: { print: false } },
   actions: {
-    // Any number of buttons per injection point; the event carries the key.
     saveAll: {
       savePdf: { title: 'Export PDF' },
       saveZip: { title: 'Export ZIP' },
@@ -36,6 +71,7 @@ const editor = new PDFMergeSortSplitClass('#editor', {
 
 await editor.whenReady();
 await editor.loadDocument({ name: 'contract.pdf', content: file });
+
 const pdf = await editor.exportDocument(0, 'pdf');   // part 0 → Blob
 
 editor.on('action', async ({ action, part }) => {
@@ -49,62 +85,70 @@ React:
 ```jsx
 import { PDFMergeSortSplit, usePdfMergeSortSplit } from '@rsj-de/pdfmergesortsplit/react';
 
-function App() {
-  // The hook returns the editor's methods, bound to the instance it creates.
+export function PdfEditor({ apiKey }) {
   const { ref, exportDocument } = usePdfMergeSortSplit();
 
   const handleAction = async ({ action, part }) => {
     if (action === 'savePdf') download(await exportDocument(part, 'pdf'));
   };
 
-  const handleExport = ({ fileName, blob }) => download(blob, fileName);
-
   return (
     <PDFMergeSortSplit
       ref={ref}
       config={{ apiKey }}
       style={{ height: 640 }}
       onAction={handleAction}
-      onExport={handleExport}
     />
   );
 }
 ```
 
+More, including the configuration reference, the events and the provenance
+model: <https://pdfmerge.rsj.de/docs>.
+
 ## API
 
-| member | description |
-|---|---|
-| `new PDFMergeSortSplitClass(container, config)` | creates the iframe in `container` (element or selector) |
-| `whenReady()` | resolves when the editor took the configuration |
-| `setConfig(config)` | applies a new configuration to the running editor (no reload) |
-| `loadDocument({name, content, provenance})` | adds a PDF (File, Blob, ArrayBuffer, base64, data URL) |
-| `getPages()` | the pages with their per-page provenance |
-| `exportDocument(reference?, mode?)` | one part (`"pdf"`) or everything (`"zip"`) → `Blob`; `reference` is a part index or name |
-| `on("action" \| "export", handler)` | injected buttons and finished exports; returns an unsubscribe function |
-| `destroy()` | removes the iframe |
+| Member | Description |
+| --- | --- |
+| `new PDFMergeSortSplitClass(container, config)` | Creates the editor in `container` (element or selector). |
+| `whenReady()` | Resolves when the editor took the configuration. |
+| `setConfig(config)` | Applies a new configuration to the running editor (no reload). |
+| `loadDocument({name, content, provenance})` | Adds a PDF (File, Blob, ArrayBuffer, base64, data URL), optionally with per-page provenance. |
+| `getPages()` | The pages in screen order, each with its provenance. |
+| `exportDocument(reference?, mode?)` | One part (`"pdf"`, by index or name) or everything (`"zip"`) → `Blob`. |
+| `on("action" \| "export" \| "license", handler)` | Injected buttons, finished exports, licence state; returns an unsubscribe function. |
+| `destroy()` | Removes the editor and rejects pending requests. |
 
 ## Configuration
 
-`config` is passed to the editor as it is:
-
-- `embedUrl` — where the editor is served (default `https://pdfmerge.rsj.de`).
-- `apiKey` — the licence JWT. Without one the embedded editor shows a
-  "test mode" banner and stays fully functional.
+- `apiKey` — the licence token; without one the editor runs in test mode.
+- `embedUrl` — where the editor is served (default `https://pdfmerge.rsj.de`,
+  or your self-hosted deployment).
 - `title`, `icon` — replace the title bar of the editor.
-- `ui` — hide any combination of the title-bar and toolbar controls and the
-  part-header buttons (`ui.toolbar`, `ui.partHeader`); everything is shown by
-  default.
+- `ui` — hide any combination of the title-bar, toolbar and part-header controls.
 - `actions.loaders` / `actions.saveAll` / `actions.savePart` — buttons injected
-  into the editor. Their clicks arrive as `on("action", …)` with
+  into the editor; their clicks arrive as `on("action", …)` with
   `{action, where, reference, part}`.
 - `provenance.attach` — write the page provenance into exported PDFs.
+- `googleClientId` — OAuth client ID of your own Google Cloud project for the
+  Drive integration (see <https://pdfmerge.rsj.de/docs/google-drive>).
 
 A running editor takes a new configuration with `setConfig(config)`; the React
 component calls it whenever the `config` prop changes, so the open document
-stays. Only a different `embedUrl` needs a new iframe.
+stays. Only a different `embedUrl` needs a new iframe. The full schema is in
+`types/index.d.ts`.
+
+## Samples
 
-The full schema is in `types/index.d.ts`.
+`../sdksimple` (plain JavaScript) and `../sdksample` (React) use this package
+through `link:../sdk`, so build the SDK before starting a sample:
+
+```bash
+pnpm --dir sdk install --ignore-workspace
+pnpm --dir sdk run build
+pnpm --dir sdksimple install --ignore-workspace && pnpm --dir sdksimple run dev
+pnpm --dir sdksample install --ignore-workspace && pnpm --dir sdksample run dev
+```
 
 ## Build and publish
 
@@ -114,13 +158,8 @@ pnpm run build                      # dist/index.js, dist/index.cjs, dist/react.
 npm publish                         # prepublishOnly builds again
 ```
 
-`react` is an optional peer dependency: the plain class does not import it.
-
-## Samples
-
-`../sdksimple` (plain JavaScript) and `../sdksample` (React) both use this
-package through `link:../sdk`, so build the SDK before starting a sample.
+## Licence
 
-The published sources live in
-<https://github.com/pdfmergesortsplit/pdfmergesortsplit> (mirrored from the
-product repository on every release); issues go there.
+MIT — see [LICENSE](LICENSE). The MIT licence covers this SDK's code; operating
+the embedded editor requires a subscription as described under
+[Business model](#business-model).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rsj-de/pdfmergesortsplit",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Embed the RSJ PDF Merge, Sort & Split editor in your own product: one iframe, a small SDK, documents never leave the browser.",
   "keywords": [
     "pdf",
@@ -40,13 +40,14 @@
   "files": [
     "dist",
     "types",
-    "README.md"
+    "README.md",
+    "LICENSE"
   ],
   "publishConfig": {
     "access": "public"
   },
   "sideEffects": false,
-  "license": "UNLICENSED",
+  "license": "MIT",
   "scripts": {
     "build": "vite build",
     "prepublishOnly": "pnpm run build"

package/types/index.d.ts

@@ -8,6 +8,12 @@ export interface PDFMergeConfig {
   title?: string;
   /** Icon (URL) that replaces ours in the title bar. */
   icon?: string;
+  /**
+   * OAuth client ID of your own Google Cloud project for the Drive integration.
+   * It overrides the one compiled into the editor, so a self-hosted deployment
+   * needs no rebuild. Without it the Drive buttons are hidden.
+   */
+  googleClientId?: string;
   /** Hide parts of the editor's UI. Everything is shown by default. */
   ui?: {
     logo?: boolean;