@zotlit/reader-plugin 0.0.0-stage → 1.0.0-beta.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/NOTICE ADDED
@@ -0,0 +1,137 @@
1
+ ZotLit
2
+ Copyright (C) 2022-present AidenLx
3
+
4
+ This program is free software: you can redistribute it and/or modify
5
+ it under the terms of the GNU Affero General Public License as published by
6
+ the Free Software Foundation, either version 3 of the License, or
7
+ (at your option) any later version.
8
+
9
+ This program is distributed in the hope that it will be useful,
10
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
11
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12
+ GNU Affero General Public License for more details.
13
+
14
+ You should have received a copy of the GNU Affero General Public License
15
+ along with this program. If not, see <https://www.gnu.org/licenses/>.
16
+
17
+ =========================================================================
18
+
19
+ This project contains code derived from the following AGPL-3.0-licensed
20
+ projects by the Corporation for Digital Scholarship:
21
+
22
+ Zotero — https://github.com/zotero/zotero
23
+ Zotero Utilities — https://github.com/zotero/utilities
24
+ Zotero Reader — https://github.com/zotero/reader
25
+ Zotero Note Editor — https://github.com/zotero/note-editor
26
+ Zotero Data Server — https://github.com/zotero/dataserver
27
+
28
+ Copyright (C) Corporation for Digital Scholarship
29
+ Licensed under the GNU Affero General Public License, version 3.
30
+
31
+ Derived files include (non-exhaustive):
32
+
33
+ packages/db/src/lib/zt-csl-item.ts — itemToCSLJSON algorithm
34
+ packages/db/src/lib/zt-csl-name.ts — parseParticles algorithm
35
+ packages/db/src/lib/zt-extra-to-csl.ts — extraToCSL algorithm
36
+ packages/db/src/lib/zt-lang.ts — languageToISO6391 algorithm
37
+ packages/db/src/lib/zt-annot-pos.ts — annotation position schemas
38
+ packages/db/src/lib/zt-color.ts — annotation color palettes
39
+ packages/db/src/lib/zt-uri.ts — Item URI and slugify rules
40
+ packages/db/src/lib/zt-note-mark.ts — note markup handling
41
+ packages/item-lookup/src/format-creator.ts — creator name formatting
42
+ packages/zotero-types/src/keys.ts — object key validation
43
+ packages/zotero-types/src/uri.ts — zotero:// link building
44
+
45
+ Each file contains @see comments linking to the specific upstream source.
46
+
47
+ =========================================================================
48
+
49
+ This project contains a verbatim copy of three modules from Zotero's fork of
50
+ PDF.js, pinned to zotero/pdf.js f57fc80d1c07e4cdc50a767ae0b500b5272123b4
51
+ (zotero/reader 132bb787937a540a09513415fd507654eb0e88f9, zotero/zotero
52
+ 22f08d1ceddc8bad5718b3bc6eee9d3ae5dccc2c):
53
+
54
+ packages/pdf-structure/src/vendor/structure.js
55
+ packages/pdf-structure/src/vendor/page-label.js
56
+ packages/pdf-structure/src/vendor/util.js
57
+
58
+ src/core/module/ lives in zotero/pdf.js, an Apache-2.0 submodule of the
59
+ AGPL-3.0 zotero/reader, so those files are licensed under the Apache
60
+ License, Version 2.0. A copy of the License is available at
61
+
62
+ http://www.apache.org/licenses/LICENSE-2.0
63
+
64
+ structure.js additionally carries Mozilla's bidi.js inline, under its own
65
+ Apache-2.0 notice:
66
+
67
+ Copyright 2012 Mozilla Foundation
68
+
69
+ Each file repeats this notice and its pinned commits in its header.
70
+
71
+ =========================================================================
72
+
73
+ This project contains a vendored build of pdf.js-zotlit, ZotLit's fork of
74
+ Mozilla PDF.js (https://github.com/mozilla/pdf.js), based on PDF.js v6.5.438:
75
+
76
+ packages/pdfjs/dist/
77
+
78
+ Copyright Mozilla Foundation
79
+ Licensed under the Apache License, Version 2.0. A copy of the License is
80
+ in packages/pdfjs/LICENSE.
81
+
82
+ The fork modifies PDF.js. packages/pdfjs/provenance.json records the fork
83
+ commit and tag, each patch, and every modified file.
84
+
85
+ The build bundles two image decoders compiled to WebAssembly, each under
86
+ its own licence:
87
+
88
+ JBIG2 decoder (PDFium) packages/pdfjs/LICENSE_JBIG2,
89
+ packages/pdfjs/LICENSE_PDFJS_JBIG2
90
+ OpenJPEG packages/pdfjs/LICENSE_OPENJPEG,
91
+ packages/pdfjs/LICENSE_PDFJS_OPENJPEG
92
+
93
+ Other files in the build carry their own licences, in the licence files
94
+ beside them: the QCMS colour library (packages/pdfjs/dist/wasm/), the
95
+ Foxit and Liberation standard fonts (packages/pdfjs/dist/standard_fonts/)
96
+ and the CMaps (packages/pdfjs/dist/cmaps/).
97
+
98
+ =========================================================================
99
+
100
+ This project contains two unmodified upstream copies. Each folder's
101
+ provenance.json records the upstream commit.
102
+
103
+ packages/zotero-types/zotero-schema/schema.json
104
+ from zotero/zotero-schema — https://github.com/zotero/zotero-schema
105
+ Copyright (C) Corporation for Digital Scholarship
106
+
107
+ packages/pdfjs-dist/types/
108
+ type definitions generated from Zotero's fork of PDF.js, from
109
+ zotero-plugin-dev/zotero-pdfjs-types —
110
+ https://github.com/zotero-plugin-dev/zotero-pdfjs-types
111
+ PDF.js is licensed under the Apache License, Version 2.0.
112
+
113
+ =========================================================================
114
+
115
+ This project also contains code derived from Mozilla web-ext:
116
+
117
+ apps/zotero/scripts/dev-server/remote-firefox.ts
118
+ apps/zotero/scripts/dev-server/rdp-client.ts
119
+
120
+ Licensed under the Mozilla Public License 2.0 (MPL-2.0).
121
+ See SPDX headers in those files for details.
122
+
123
+ =========================================================================
124
+
125
+ The Fixture contains third-party copies and adaptations of Sakima's song,
126
+ written by Ursula Nafula and illustrated by Peris Wachuka. These assets are
127
+ licensed under CC BY 4.0 and are outside ZotLit's AGPL-3.0-or-later license
128
+ grant. Full provenance, checksums, and modification records are in:
129
+
130
+ packages/scripts/lib/fixture/assets/sakimas-song/NOTICE.md
131
+
132
+ The Fixture also contains a copy of Why Most Published Research Findings Are
133
+ False, written by John P. A. Ioannidis and published by PLOS. This asset is
134
+ licensed under the Creative Commons Attribution License and is outside ZotLit's
135
+ AGPL-3.0-or-later license grant. Full provenance and its checksum are in:
136
+
137
+ packages/scripts/lib/fixture/assets/ioannidis-2005/NOTICE.md
package/README.md CHANGED
@@ -1,3 +1,15 @@
1
- # Temporary Holding Version
1
+ # @zotlit/reader-plugin
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ The bundle of the ZotLit Reader Obsidian plugin, version 1.0.0-beta.0, for its publish
4
+ repository, [aidenlx/zotlit-reader](https://github.com/aidenlx/zotlit-reader).
5
+
6
+ - `main.js`: the plugin as one ES module. It holds ZotLit Reader's code and its
7
+ third-party code. It imports only the modules Obsidian provides at runtime.
8
+ - `styles.css`: the plugin's stylesheet.
9
+ - `resources/`: the files the plugin downloads at runtime from the Resource
10
+ Release `res-1.0.0-beta.0` of the publish repository.
11
+
12
+ Obsidian does not load this package. The publish repository builds the
13
+ plugin's `main.js` and `styles.css` from it with `scripts/build.mjs`. The
14
+ source code is in [aidenlx/zotlit-repo](https://github.com/aidenlx/zotlit-repo),
15
+ under `apps/reader`.
package/main.d.ts ADDED
@@ -0,0 +1,3 @@
1
+ // The plugin class Obsidian loads, a subclass of Plugin from "obsidian".
2
+ declare const plugin: abstract new (...args: never[]) => object;
3
+ export default plugin;