@meerrec/wasm-docx 0.0.0-stage → 2.0.2

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 2026 doc-converter contributors
+
+   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/README.md

@@ -1,3 +1,33 @@
-# Temporary Holding Version
+# @meerrec/wasm-docx
 
-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.
+Ленивый модуль просмотра DOCX: воркер грузит его по URL при открытии `.docx`,
+поэтому в основной бандл он не входит. Точка входа —
+`pkg/doc_converter_docx_wasm.js` рядом с `pkg/doc_converter_docx_wasm_bg.wasm`;
+каталог `pkg/` генерирует `wasm-pack` (скрипт `scripts/build-wasm.sh`), руками
+его править не нужно.
+
+## Установка
+
+Пакет опубликован в **GitHub Packages** этого репозитория
+(`@meerrec/wasm-docx@1.0.0`) — действующем зеркале; целевой основной реестр —
+`registry.npmjs.org` (публикация готовится,
+[ADR-0027](https://github.com/meerrec/wasm-converter/blob/main/docs/adr/0027-npmjs-primary-registry.md)).
+Реестр и токен с правом `read:packages` — в `~/.npmrc`:
+
+```ini
+# ~/.npmrc — <токен> это personal access token (classic) с read:packages
+@meerrec:registry=https://npm.pkg.github.com
+//npm.pkg.github.com/:_authToken=<токен>
+```
+
+```bash
+npm install @meerrec/wasm-docx --registry=https://npm.pkg.github.com
+```
+
+Без реестра — тарбол (`meerrec-wasm-docx-1.0.0.tgz`) в ассетах релиза
+[`v1.0.0`](https://github.com/meerrec/wasm-converter/releases/tag/v1.0.0).
+
+## Ссылки
+
+- Корневой [README](https://github.com/meerrec/wasm-converter#readme) — установка, быстрый старт, бюджеты.
+- Релиз [`v1.0.0`](https://github.com/meerrec/wasm-converter/releases/tag/v1.0.0) — тарболы всех пяти пакетов.

package/package.json

@@ -1,6 +1,36 @@
 {
   "name": "@meerrec/wasm-docx",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "2.0.2",
+  "description": "wasm-bindgen output of the lazy DOCX viewer module. Generated by wasm-pack — do not edit.",
+  "license": "Apache-2.0",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/meerrec/wasm-converter.git",
+    "directory": "packages/wasm-docx"
+  },
+  "homepage": "https://github.com/meerrec/wasm-converter#readme",
+  "bugs": {
+    "url": "https://github.com/meerrec/wasm-converter/issues"
+  },
+  "type": "module",
+  "main": "./pkg/doc_converter_docx_wasm.js",
+  "module": "./pkg/doc_converter_docx_wasm.js",
+  "types": "./pkg/doc_converter_docx_wasm.d.ts",
+  "exports": {
+    ".": {
+      "types": "./pkg/doc_converter_docx_wasm.d.ts",
+      "import": "./pkg/doc_converter_docx_wasm.js"
+    },
+    "./pkg/*": "./pkg/*"
+  },
+  "files": [
+    "pkg",
+    "README.md",
+    "LICENSE"
+  ],
+  "sideEffects": false,
+  "scripts": {
+    "build": "echo 'build via scripts/build-wasm.sh from repo root'",
+    "clean": "rm -rf pkg"
+  }
 }

package/pkg/doc_converter_docx_wasm.d.ts

@@ -0,0 +1,227 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Собрать кадр стопки страниц в буфер вызывающего — путь без `SharedArrayBuffer`.
+ *
+ * Байты пишутся в готовый массив: воркер держит два и заполняет то один, то
+ * другой, поэтому на кадр нет ни аллокации под сам кадр, ни копии из памяти
+ * wasm в JS (копия в память painter'а неизбежна: он живёт в другом модуле).
+ * `written: false` вместе с `bytes` больше длины буфера означает, что буфер
+ * мал: воркер вырастит его и повторит сборку.
+ *
+ * # Errors
+ * Если документ не открыт или окно описано неверно.
+ */
+export function docx_build_display_list_into(out: Uint8Array, viewport: any, gap: number): any;
+
+/**
+ * Собрать кадр стопки страниц сразу в слот ring'а.
+ *
+ * Возвращает `written: false`, если свободного слота не было: кадр теряется,
+ * но следующий за ним рисуется — так и задумано, догонять прокрутку
+ * устаревшими кадрами незачем. Второй случай `written: false` — кадр больше
+ * слота: `bytes` скажет, насколько.
+ *
+ * # Errors
+ * Если документ не открыт, окно описано неверно или SAB не тот.
+ */
+export function docx_build_display_list_sab(sab: SharedArrayBuffer, slot_capacity: number, viewport: any, gap: number): any;
+
+/**
+ * Закрыть документ и освободить память.
+ */
+export function docx_close(): void;
+
+/**
+ * Экспортировать документ в HTML — самостоятельную страницу со встроенными
+ * стилями, а не фрагмент.
+ *
+ * Разметка — у [`doc_converter_docx::export::html::to_html`].
+ *
+ * # Errors
+ * Если байты не OOXML-пакет или `word/document.xml` не разбирается.
+ */
+export function docx_export_html(bytes: Uint8Array): string;
+
+/**
+ * Экспортировать документ в Markdown.
+ *
+ * Разметка — у
+ * [`doc_converter_docx::export::markdown::to_markdown`]: заголовки, списки,
+ * GFM-таблицы, начертания, ссылки.
+ *
+ * # Errors
+ * Если байты не OOXML-пакет или `word/document.xml` не разбирается.
+ */
+export function docx_export_markdown(bytes: Uint8Array): string;
+
+/**
+ * Экспортировать документ в обычный текст: содержимое без разметки.
+ *
+ * Разметка — у [`doc_converter_docx::export::text::to_text`].
+ *
+ * # Errors
+ * Если байты не OOXML-пакет или `word/document.xml` не разбирается.
+ */
+export function docx_export_text(bytes: Uint8Array): string;
+
+/**
+ * TextLayer всего документа.
+ *
+ * Для больших документов это дорого: слой содержит run'ы всех страниц.
+ * Виртуализированный просмотрщик берёт [`docx_get_text_layer`] постранично,
+ * а полный слой — для семантического дерева и копирования целиком.
+ *
+ * # Errors
+ * Документ не открыт; сериализация в JS не удалась.
+ */
+export function docx_get_full_text_layer(): any;
+
+/**
+ * TextLayer одной страницы (0-based).
+ *
+ * # Errors
+ * Документ не открыт; страница вне диапазона; сериализация в JS не удалась.
+ */
+export function docx_get_text_layer(page: number): any;
+
+/**
+ * Байты картинки по её id.
+ *
+ * Возвращается `Uint8Array` — копия байтов из памяти wasm; буфер принадлежит
+ * интерфейсу, и дальше его можно отдать `postMessage` с transferables.
+ *
+ * # Errors
+ * Если документ не открыт или картинки с таким id нет.
+ */
+export function docx_image_bytes(id: number): Uint8Array;
+
+/**
+ * Картинки открытого документа: id, MIME-тип и длина байтов.
+ *
+ * Байты в список не входят: их забирает [`docx_image_bytes`] по одному id,
+ * чтобы не копировать разом всю media документа. В списке только части, на
+ * которые ссылается хотя бы один рисунок: остальные разбор не читает.
+ *
+ * # Errors
+ * Если документ не открыт.
+ */
+export function docx_images(): any;
+
+/**
+ * Открыт ли документ. Нужно интерфейсу, чтобы не рисовать пустоту.
+ */
+export function docx_is_open(): boolean;
+
+/**
+ * Открыть документ из байтов: разобрать, разложить по страницам, запомнить.
+ *
+ * Раскладка (`LayoutOptions::default()`) считается здесь и один раз: ширина
+ * полосы набора задана страницей документа, а не окном, поэтому окно и зум
+ * на неё не влияют и приходят только с кадром. Предыдущий документ
+ * закрывается.
+ *
+ * # Errors
+ * Если байты не OOXML-пакет, `word/document.xml` не разбирается или раскладка
+ * упирается в [`doc_converter_docx::LayoutError`].
+ */
+export function docx_open(bytes: Uint8Array): any;
+
+/**
+ * Открыть документ из байтов, отдав их без копирования.
+ *
+ * # Errors
+ * То же, что у [`docx_open`].
+ */
+export function docx_open_bytes(bytes: Uint8Array): any;
+
+/**
+ * Взвести или снять флаг кооперативной отмены (ADR-0032).
+ *
+ * Раскладка проверяет его между блоками тела. Флаг одноразовый: операция,
+ * которая его заметила, гасит его сама, — иначе отмена, пришедшая после
+ * операции, ждала бы следующую.
+ */
+export function set_cancel(flag: boolean): void;
+
+/**
+ * Дописать чанк. Возвращает накопленный размер — прогресс для диагностики.
+ *
+ * # Errors
+ * Если поток с таким id не заведён.
+ */
+export function stream_append(id: number, bytes: Uint8Array): bigint;
+
+/**
+ * Отменить поток: буфер освобождается, id больше не действителен.
+ */
+export function stream_free(id: number): void;
+
+/**
+ * Завести поток: id, под которым воркер будет слать чанки.
+ */
+export function stream_new(): number;
+
+/**
+ * Завершить поток: разобрать накопленный буфер как документ (ADR-0031 §6).
+ *
+ * Буфер изымается из реестра — поток одноразовый, — документ встаёт в `DOC`,
+ * как при `docx_open`. Ответ — тот же список страниц.
+ *
+ * # Errors
+ * Если поток неизвестен, буфер пуст (оборванный поток) или байты не
+ * OOXML-пакет.
+ */
+export function stream_open_docx(id: number): any;
+
+export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+export interface InitOutput {
+    readonly memory: WebAssembly.Memory;
+    readonly docx_build_display_list_into: (a: number, b: number, c: number, d: number) => void;
+    readonly docx_build_display_list_sab: (a: number, b: number, c: number, d: number, e: number) => void;
+    readonly docx_close: () => void;
+    readonly docx_export_html: (a: number, b: number) => void;
+    readonly docx_export_markdown: (a: number, b: number) => void;
+    readonly docx_export_text: (a: number, b: number) => void;
+    readonly docx_get_full_text_layer: (a: number) => void;
+    readonly docx_get_text_layer: (a: number, b: number) => void;
+    readonly docx_image_bytes: (a: number, b: number) => void;
+    readonly docx_images: (a: number) => void;
+    readonly docx_is_open: () => number;
+    readonly docx_open: (a: number, b: number, c: number) => void;
+    readonly docx_open_bytes: (a: number, b: number) => void;
+    readonly set_cancel: (a: number) => void;
+    readonly stream_append: (a: number, b: number, c: number, d: number) => void;
+    readonly stream_free: (a: number) => void;
+    readonly stream_new: () => number;
+    readonly stream_open_docx: (a: number, b: number) => void;
+    readonly __wbindgen_export: (a: number, b: number) => number;
+    readonly __wbindgen_export2: (a: number, b: number, c: number, d: number) => number;
+    readonly __wbindgen_export3: (a: number) => void;
+    readonly __wbindgen_add_to_stack_pointer: (a: number) => number;
+    readonly __wbindgen_export4: (a: number, b: number, c: number) => void;
+}
+
+export type SyncInitInput = BufferSource | WebAssembly.Module;
+
+/**
+ * Instantiates the given `module`, which can either be bytes or
+ * a precompiled `WebAssembly.Module`.
+ *
+ * @param {{ module: SyncInitInput }} module - Passing `SyncInitInput` directly is deprecated.
+ *
+ * @returns {InitOutput}
+ */
+export function initSync(module: { module: SyncInitInput } | SyncInitInput): InitOutput;
+
+/**
+ * If `module_or_path` is {RequestInfo} or {URL}, makes a request and
+ * for everything else, calls `WebAssembly.instantiate` directly.
+ *
+ * @param {{ module_or_path: InitInput | Promise<InitInput> }} module_or_path - Passing `InitInput` directly is deprecated.
+ *
+ * @returns {Promise<InitOutput>}
+ */
+export default function __wbg_init (module_or_path?: { module_or_path: InitInput | Promise<InitInput> } | InitInput | Promise<InitInput>): Promise<InitOutput>;