@quillmark/quillify 0.0.0-stage → 0.3.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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, whether in Source or
+      Object form, 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 any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to 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 otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated 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 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 a Contribution incorporated 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, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, 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 as an addendum 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 copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   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 redistributing 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 consequential 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 any and 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 act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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/NOTICE

@@ -0,0 +1,85 @@
+quillify
+Copyright 2026 Nibs
+
+quillify redistributes eight files that are other projects' work. Everything
+else it depends on is installed by its consumer and is not in the package.
+
+assets/pdf.worker.js
+  The worker of pdf.js: build/pdf.worker.mjs of pdfjs-dist 6.4.299,
+  Copyright 2024 Mozilla Foundation, under the Apache License 2.0
+  (licenses/pdf.js-LICENSE).
+  Changed: a null guard added at two sites, a page's first unsplittable
+  node no longer taken from an overflow leader or trailer, a page set made to
+  clear its page areas' counts when it starts another pass, a field with no
+  control or a default one given a text control, a field whose control has no
+  HTML given a box for it so that its caption is laid out, a list bound to
+  data the file does not hold left with the items its template lists, a span
+  marked where a page's text embeds a page number or a page count that a
+  layout script fills, an exception of the XFA layout thrown on after it is
+  logged, and the last line, which named a source map, removed. The file's
+  first line says the same.
+
+assets/xfa-layer.js
+  Lines 1270 to 1588 of web/pdf_viewer.css of pdfjs-dist 6.4.299, unchanged,
+  under a header comment and as the text of a JavaScript module.
+  Copyright 2014 Mozilla Foundation, under the Apache License 2.0
+  (licenses/pdf.js-LICENSE).
+
+assets/LiberationSans-Regular.ttf
+assets/LiberationSans-Bold.ttf
+assets/LiberationSans-Italic.ttf
+assets/LiberationSans-BoldItalic.ttf
+  The four faces of Liberation Sans 2.1.5, unchanged. Digitized data
+  copyright (c) 2010 Google Corporation, Copyright (c) 2012 Red Hat, Inc.,
+  under the SIL Open Font License 1.1 (licenses/LiberationSans-LICENSE).
+  Liberation is a trademark of Red Hat, Inc.
+
+assets/qpdf.worker.js
+  dist/qpdf.js of @neslinesli93/qpdf-wasm 0.3.0, unchanged, under a first
+  line that says so and above a message handler that is quillify's own. It is
+  the script that loads assets/qpdf.wasm and runs it. That package declares
+  the ISC license, names no holder and ships no license text. The script
+  names no author and no license. It is the JavaScript that Emscripten writes
+  beside a binary it compiles, and Emscripten's own code is under the MIT
+  license and the University of Illinois/NCSA Open Source License
+  (licenses/emscripten-LICENSE). The script does not say which Emscripten
+  wrote it. That package's Dockerfile, at its tag 0.3.0, names the image
+  emscripten/emsdk:3.1.74, and the text is that version's.
+
+assets/qpdf.wasm
+  dist/qpdf.wasm of @neslinesli93/qpdf-wasm 0.3.0, unchanged. Its SHA-256 is
+  abd933f4ccace4f732999381b21aec8b7e3726f18a5b167fafd57f88dd440876.
+  That package declares the ISC license, names no holder and ships no license
+  text. What is linked into the binary follows, by the binary's own strings
+  where it says and by that package's Dockerfile, at its tag 0.3.0, where it
+  does not.
+
+  qpdf 12.2.0, Copyright (c) 2005-2021 Jay Berkenbilt and Copyright (c)
+  2022-2025 Jay Berkenbilt and Manfred Holger, under the Apache License 2.0
+  (licenses/qpdf-LICENSE). Its notice is licenses/qpdf-NOTICE. The binary
+  has qpdf's native crypto provider and no other, so it runs the two
+  implementations that notice names: the SHA-2 of sphlib 3.0, Copyright (c)
+  2007-2011 Projet RNRT SAPHIR, under the MIT license, whose text is in the
+  notice, and Philip J. Erdelsky's Rijndael, which is in the public domain.
+
+  libjpeg-turbo 2.1.1, Copyright (C) 1991-2021 The libjpeg-turbo Project and
+  many others, from ImageMagick's copy of its source, under the licenses of
+  licenses/libjpeg-turbo-LICENSE and of licenses/libjpeg-turbo-README.ijg,
+  which the first names. This software is based in part on the work of the
+  Independent JPEG Group.
+
+  zlib, (C) 1995-2022 Jean-loup Gailly and Mark Adler, under the zlib
+  license, which is the copyright notice in licenses/zlib-README. The binary
+  carries zlib's messages and no version of it. The Dockerfile names the
+  commit that is zlib 1.2.12, and the file is that version's.
+
+  The runtime Emscripten links: its own code (licenses/emscripten-LICENSE),
+  musl, under the MIT license (licenses/musl-COPYRIGHT), and LLVM's libc++,
+  libc++abi and compiler-rt, under the Apache License 2.0 with LLVM
+  Exceptions (licenses/libcxx-LICENSE, licenses/libcxxabi-LICENSE,
+  licenses/compiler-rt-LICENSE). The binary names no compiler. The Dockerfile
+  names the image emscripten/emsdk:3.1.74, and the five texts are that
+  version's. musl's messages and the type names of libc++ and libc++abi are
+  in the binary. That compiler-rt is in it too, and dlmalloc, Emscripten's
+  default allocator, which is in the public domain, follows from how
+  Emscripten builds and was not read from the binary.

package/README.md

@@ -1,3 +1,57 @@
-# Temporary Holding Version
+# quillify
 
-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.
+Turn a published PDF form into a [Quillmark](https://github.com/borb-sh/quillmark) quill, in the browser.
+
+Published forms rarely come as a clean fillable PDF. Most are encrypted with an empty password, and many are dynamic XFA, which only Acrobat lays out. quillify reads either kind and returns the page as a background with its form layer stripped, and every field with its place.
+
+57 of 59 federal forms and 1,147 of 1,354 Air Force forms convert, with every field read back at its place.
+
+## Install
+
+```
+npm install @quillmark/quillify @quillmark/wasm
+```
+
+## Use
+
+```ts
+import { init } from '@quillmark/wasm';
+import { quillify, sanitize, suggest } from '@quillmark/quillify';
+
+const read = await sanitize(pdf);
+if (!read.ok) throw new Error(read.refusal.code);
+
+const built = await quillify(read.form, {
+	name: 'tdy_request',
+	description: 'Request and authorization for TDY travel.',
+	fields: suggest(read.form.fields)
+});
+if (!built.ok) throw new Error(built.problems.map(({ code }) => code).join(', '));
+
+const { Quill } = await init();
+const quill = Quill.fromTree(built.tree);
+```
+
+`pdf` is the file's bytes: `new Uint8Array(await file.arrayBuffer())`.
+
+- `sanitize` parses the file and returns a `Form`, or the reason it does not take the file.
+- `suggest` names each field from the form's own tooltips.
+- `check` lists what is wrong with a naming.
+- `quillify` builds the quill's files.
+
+It runs in a browser and has no interface: the review screen, any model and storage are yours.
+
+The file is treated as hostile. The background comes back without its form layer, scripts, attachments and metadata, and [`SECURITY.md`](SECURITY.md) says what holds and what does not.
+
+## Documentation
+
+- [Example](examples/): a page that takes a PDF, lists its fields under the names `suggest` gives and renders a filled copy. In a clone: `npm ci`, `npm run build`, `npx vite examples`.
+- [API](docs/api.md): what goes in, what comes back, every refusal and problem.
+- [Guide](docs/guide.md): bundlers, content security policy, the engine, from a quill to a filled PDF.
+- [Limits](docs/limits.md): what converts, what is refused, how a redrawn form can differ.
+- [Architecture](docs/architecture.md): how the code is laid out.
+- [Security](SECURITY.md), [contributing](CONTRIBUTING.md), [changelog](CHANGELOG.md).
+
+## License
+
+Apache-2.0. [`NOTICE`](NOTICE) lists the third-party files the package ships.