@onodocs/canvas 0.3.0 → 0.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +12 -4
- package/LICENSING.md +19 -3
- package/README.md +400 -256
- package/SDK.md +400 -256
- package/agreement-review.md +13 -0
- package/ai-report-demo.md +40 -0
- package/application-integration.md +89 -0
- package/document-collaboration.md +54 -0
- package/document-forms.md +84 -0
- package/document-modes.md +44 -0
- package/editor.md +39 -0
- package/index.js +214 -41
- package/package.json +12 -3
- package/proposal.md +36 -0
- package/templates.md +71 -0
- package/types/canvas/index.d.ts +3 -0
- package/types/canvas/presentation.d.ts +3 -0
- package/types/canvas/text-selection.d.ts +6 -0
- package/types/foundation/page-interaction.d.ts +17 -0
- package/types/render-api/page-display-list.d.ts +4 -0
package/LICENSE
CHANGED
|
@@ -1,10 +1,18 @@
|
|
|
1
|
-
OnoDocs SDK
|
|
1
|
+
OnoDocs SDK and Canvas
|
|
2
2
|
All rights reserved, except for the permissions below and separately licensed third-party components.
|
|
3
3
|
|
|
4
|
+
These terms apply to @onodocs/sdk and @onodocs/canvas. OnoDocs-authored @onodocs/editor source is separately licensed under MIT, including its interface, application sessions, form and template controls, and collaboration client. These commercial terms do not restrict the MIT rights to use, modify or redistribute that editor code. The editor's MIT license does not grant production or redistribution rights in SDK or Canvas dependencies. Third-party code retains its own license.
|
|
5
|
+
|
|
4
6
|
Free evaluation permits installation, development, testing, and internal demonstrations for the purpose of evaluating OnoDocs. It has no time limit. It does not permit production use, including internal production workflows or services supplied to others. Preserve evaluation notices and watermarks. A signed trial license permits watermark-free evaluation for 30 days from issuance; it does not grant production rights.
|
|
5
7
|
|
|
6
|
-
Production use requires a commercial license issued by OnoDocs. The named licensee may use and deploy
|
|
8
|
+
Production use requires a commercial license issued by OnoDocs. The named licensee may use and deploy OnoDocs within the application scope recorded in that license and the associated purchase agreement. One application license covers the SDK and Canvas packages and all capabilities serving that named product, including its frontend, backend, workers and self-hosted collaboration. Backend-only document automation also counts as an application. The same product's domains, environments, tenants and customer-hosted installations are included. A shared backend serving three distinct products requires scope covering three applications. Developers, users and processed documents are unlimited within the covered application scope.
|
|
9
|
+
|
|
10
|
+
Ordinary embedding and custom branding within a covered application are included. A finished document editor sold to end users is permitted under an ordinary application license. Reselling a reusable component containing the SDK or Canvas, granting independent downstream development rights to those packages, or selling a general document-processing API using them to developers requires a separate written redistribution agreement with OnoDocs. An agency or its client may be the named licensee, with the client application identified in the agreed scope.
|
|
11
|
+
|
|
12
|
+
Generated DOCX and PDF files and extracted data may be distributed without OnoDocs royalties or recipient licenses. Recipients who run SDK or Canvas in their own software must have that use covered by an application license or separate redistribution agreement. Evaluation notices and watermarks must still be preserved.
|
|
13
|
+
|
|
14
|
+
Covered releases may be used perpetually. The initial purchase includes 12 months of updates and email support for product issues. The updates-through date includes releases published on that UTC date; it is not a runtime expiry. Renewal is optional and grants further updates and support under the purchase agreement.
|
|
7
15
|
|
|
8
|
-
Do not use another customer's key or remove licensing checks or evaluation notices to obtain unlicensed production use. The same terms apply to low-level stage APIs, custom adapters, browser applications
|
|
16
|
+
Do not use another customer's key or remove licensing checks or evaluation notices to obtain unlicensed production use. The same terms apply to low-level stage APIs, custom adapters, browser applications and server processing. A publicly downloadable package does not grant production rights.
|
|
9
17
|
|
|
10
|
-
|
|
18
|
+
OnoDocs is provided as is, without warranties, except as expressly agreed in a commercial agreement. Third-party components retain their respective licenses.
|
package/LICENSING.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Offline licensing
|
|
2
2
|
|
|
3
|
-
The OnoDocs SDK and Canvas packages support evaluation, trial and commercial use under the
|
|
3
|
+
The OnoDocs SDK and Canvas packages support evaluation, trial and commercial use under the terms below. OnoDocs-authored `@onodocs/editor` code is licensed under MIT, including its UI, application sessions, form/template controls and collaboration client. You may use, modify and redistribute that editor code in commercial products under MIT. Preserve its copyright notice and applicable third-party notices. MIT rights in Editor do not grant production or redistribution rights in the commercial SDK and Canvas dependencies. Editor has no separate entitlement. Packages can be installed from an npm registry or supplied archives and copied into an offline environment. Runtime licensing makes no network requests.
|
|
4
4
|
|
|
5
5
|
| Mode | Behavior |
|
|
6
6
|
| --- | --- |
|
|
@@ -9,6 +9,18 @@ The OnoDocs SDK and Canvas packages support evaluation, trial and commercial use
|
|
|
9
9
|
| Commercial | Signed key permits the purchased scope and removes evaluation notices. Covered releases work indefinitely. |
|
|
10
10
|
| Demo | OnoDocs website demonstrations only. Valid for at most 24 hours at one exact browser origin; not valid for backend use. |
|
|
11
11
|
|
|
12
|
+
## Application scope
|
|
13
|
+
|
|
14
|
+
One application license covers SDK and Canvas and all capabilities serving one named product, including frontend, backend, workers and self-hosted collaboration. Backend-only document automation counts as an application. Multiple domains, environments, tenants and customer-hosted installations of that same product are included. A shared backend serving three distinct products needs scope covering three applications. Developers, users and documents are unlimited within that scope.
|
|
15
|
+
|
|
16
|
+
Ordinary embedding and custom branding are included, as is selling a finished document editor to end users. Reselling reusable components containing SDK or Canvas, granting independent downstream development rights to those commercial packages, or selling a general document-processing API using them to developers requires a separately quoted written redistribution agreement. Redistribution of the MIT editor code itself remains permitted under MIT. For agency work, identify the client application and whether the agency or client is the license holder in the purchase agreement.
|
|
17
|
+
|
|
18
|
+
Generated DOCX, PDF and extracted data can be distributed without OnoDocs royalties or recipient licenses. A recipient running SDK or Canvas in their own software needs covered application scope or a separate redistribution agreement. Preserve evaluation notices and watermarks. DOCX export does not add a watermark or restrict document content.
|
|
19
|
+
|
|
20
|
+
A one-application license costs $999 and a five-application license costs $2,499. Both include all capabilities, perpetual use of covered releases, and 12 months of updates and email product-issue support. Optional renewals cost $499 and $1,249 respectively. Renewals extend updates and support; covered releases continue working without renewal.
|
|
21
|
+
|
|
22
|
+
## Runtime configuration
|
|
23
|
+
|
|
12
24
|
Pass the issued token as `licenseKey` when opening a document:
|
|
13
25
|
|
|
14
26
|
```ts
|
|
@@ -24,10 +36,14 @@ The default Node analysis entry point accepts the same option. With `@onodocs/sd
|
|
|
24
36
|
|
|
25
37
|
Missing or invalid keys preserve document functionality and return evaluation mode with a `reason`: `missing-key`, `invalid-key`, `verification-unavailable`, `not-yet-valid`, `trial-expired`, or `release-not-covered`. Trial expiry is checked on opening, status access and rendering. Already produced images remain unchanged. Browsers need HTTPS or a secure local context for native signature verification; no internet connection is needed. The headless renderer supplies its own isolated secure context.
|
|
26
38
|
|
|
27
|
-
Commercial keys contain an inclusive `updatesThrough` date. A key covering 2027-10-04 permits releases published on or before that UTC date forever. Renew to use later releases and receive further support. `sdkReleaseDate`, exported from
|
|
39
|
+
Commercial keys contain an inclusive `updatesThrough` date. A key covering 2027-10-04 permits releases published on or before that UTC date forever. Renew to use later releases and receive further support. `sdkReleaseDate`, exported from the SDK analysis, browser and server entry points, identifies the running release date. Scope is recorded in the key and purchase agreement; it is not inferred from a hostname or tracked online.
|
|
28
40
|
|
|
29
41
|
Canvas, mounted views, PNG, JPEG and PDF receive the same evaluation watermark. Queries, source models, layouts and display lists remain complete. Low-level stage APIs and custom adapters are covered by the same terms; custom evaluation presentations must preserve an evaluation notice. Offline JavaScript checks can be bypassed by changing code or the clock; they do not provide immediate revocation or seat counting.
|
|
30
42
|
|
|
31
43
|
Demo licenses also report `demo-expired` or `origin-not-covered`. The website handles early renewal; the SDK continues to verify locally without contacting a license server. They do not grant customer production rights.
|
|
32
44
|
|
|
33
|
-
|
|
45
|
+
SDK and Canvas include the commercial `LICENSE`; Editor includes the MIT `LICENSE`. Third-party components retain their respective licenses.
|
|
46
|
+
|
|
47
|
+
Editor and application sessions accept the key through `document: { licenseKey }`. Form views and designers use the same document option. Collaborative browser sessions use `editor: { document: { licenseKey } }`; their host service accepts `createCollaborationService({ licenseKey, authorize, storage })`. Configure both sides of the named application. Templates retain their opening key when generating documents, and data-only forms use their supplied document's entitlement. The HTTP service forwards its `document` options to the renderer.
|
|
48
|
+
|
|
49
|
+
Application counts and redistribution permissions are contractual. The verifier checks signed identity, trial expiry and release coverage, with no application counter or customer host binding. The origin restriction applies only to short-lived OnoDocs website demo keys. Existing commercial keys remain valid within their agreed scope.
|