@aseity/idocs 0.0.0-stage → 0.6.0

package/CHANGELOG.md

@@ -0,0 +1,17 @@
+# @aseity/idocs
+
+## 0.6.0
+
+### Minor Changes
+
+- Add `idocs pages` to inspect compact pagination summaries without writing a full layout file. Summaries include page labels, source locations, table row ranges and page-break reasons. Use `--pages` to select a page range and `--details` to include font records and diagnostic details. Existing document commands and source files remain compatible.
+
+## 0.5.0
+
+### Minor Changes
+
+- Add local Linux x64 glibc distribution packages. The npm launcher uses an installed native platform package without installation scripts or downloads. A standalone archive uses the same binary and includes checksums and redistribution notices. System fonts are discovered through fontconfig; additional directories can be configured once per user.
+
+## 0.4.1
+
+This version is the starting point for local distribution preparation. Public npm and native archive publication remains pending. Future release notes are generated from changesets.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 iDocs contributors
+
+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,3 +1,29 @@
-# Temporary Holding Version
+# iDocs CLI
 
-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.
+Create, check and render iDocs source documents and export editable DOCX files.
+
+The CLI is available from the public npm registry.
+
+The first native target is Linux x64 with glibc 2.36 or newer. The npm launcher requires Node 24 or newer. npm 11 is the tested package manager. musl, other CPU architectures and other operating systems are unsupported.
+
+For a published version, install `@aseity/idocs@<version>` with npm, retaining optional dependencies. The launcher requires the exact same version of `@aseity/idocs-linux-x64-gnu`. `--omit=optional` skips the binary. Reinstall with `--include=optional` if it is absent. Installation uses the package manager only, with no lifecycle scripts, binary downloader, font downloader or Rust build.
+
+The native archive runs without Node or Rust. It needs the system loader, glibc and libgcc runtime. Install fontconfig and suitable system fonts for document rendering. Debian 12 and Ubuntu systems can install fontconfig and Latin fonts with `apt-get install fontconfig fonts-liberation2`. Chinese rendering requires static single-face OTF or TTF fonts. Distribution packages containing only TTC font collections do not satisfy that requirement. Install static Noto CJK or MiSans fonts into a fontconfig-visible font directory, or configure a font directory once as described below. The package contains no external font directory. Embedded KaTeX math fonts and their licenses remain in the native binary distribution.
+
+```sh
+idocs --version
+idocs check report.idoc --layout report.layout.json
+idocs pages report.idoc
+idocs export report.idoc --out report.docx
+idocs snapshot report.idoc --out preview
+```
+
+Standard output is JSON for document commands. Exit codes are 0 for success, 1 for document failure and 2 for usage or environment failure. Inspect warnings and conversion losses even after success. Native snapshots use the current font environment; Word may paginate differently with other fonts.
+
+Use `idocs pages report.idoc --pages 2-4` to inspect a page range without writing a layout file. The summary reports page labels, source locations, table row ranges and page-break reasons. Add `--details` for font records and diagnostic details.
+
+Linux system and user fonts are discovered through `fc-list`. Additional font directories can be saved in `$XDG_CONFIG_HOME/idocs/config.json`, or `$HOME/.config/idocs/config.json` when XDG_CONFIG_HOME is unset. Use `{"fontDirs":["/absolute/font/directory"]}`. Relative directories resolve beside the config file. New processes load the saved directories automatically. Remove entries or the config file to clear them. Repeated `--font-dir` arguments add directories for one run without modifying configuration.
+
+Font priority is document registration, command-line directories, saved directories, system fonts, then the existing fallback resource directory. `IDOCS_FONTS` names that fallback directory, not a system font list. Missing or unreadable fonts and missing glyphs produce diagnostics. `--strict` makes relevant warnings fail. The CLI does not embed user fonts into exported DOCX.
+
+The platform package and native archive include third-party notices. Keep those notices when redistributing the executable.

package/bin/idocs.mjs

@@ -0,0 +1,36 @@
+#!/usr/bin/env node
+import { readFileSync } from 'node:fs'
+import { createRequire } from 'node:module'
+import { dirname, join } from 'node:path'
+
+const read = (url) => JSON.parse(readFileSync(url, 'utf8'))
+const manifest = read(new URL('../package.json', import.meta.url))
+const platform = read(new URL('../platform.json', import.meta.url))
+try {
+  if (process.platform !== platform.os || process.arch !== platform.cpu) {
+    throw new Error(`This release supports Linux x64 glibc only; found ${process.platform} ${process.arch}.`)
+  }
+  const glibc = process.report.getReport().header.glibcVersionRuntime
+  const parts = (value) => value.split('.').map(Number)
+  const [major, minor] = parts(glibc || '0.0')
+  const [minimumMajor, minimumMinor] = parts(platform.minimumGlibc)
+  if (major < minimumMajor || (major === minimumMajor && minor < minimumMinor)) {
+    throw new Error(`iDocs needs glibc >=${platform.minimumGlibc}; found ${glibc || 'non-glibc Linux'}.`)
+  }
+  let installed
+  try {
+    installed = createRequire(import.meta.url).resolve(`${platform.package}/package.json`)
+  } catch {
+    throw new Error(`Missing ${platform.package}@${manifest.version}. Reinstall with npm install --include=optional ${manifest.name}@${manifest.version}; --omit=optional skips the binary. You can also use the native archive.`)
+  }
+  const native = read(installed)
+  if (native.version !== manifest.version) {
+    throw new Error(`Expected ${platform.package}@${manifest.version}, found ${native.version}. Reinstall matching CLI and platform versions.`)
+  }
+  if (typeof process.execve !== 'function') throw new Error('iDocs requires Node 24 or newer, or use the native archive.')
+  const binary = join(dirname(installed), 'bin/idocs')
+  process.execve(binary, [binary, ...process.argv.slice(2)], process.env)
+} catch (error) {
+  console.error(`idocs: ${error.message}`)
+  process.exitCode = 2
+}

package/package.json

@@ -1,6 +1,27 @@
 {
   "name": "@aseity/idocs",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.6.0",
+  "description": "iDocs native command-line tools for editable DOCX documents",
+  "license": "MIT",
+  "type": "module",
+  "bin": {
+    "idocs": "bin/idocs.mjs"
+  },
+  "files": [
+    "bin",
+    "platform.json",
+    "README.md",
+    "CHANGELOG.md",
+    "LICENSE"
+  ],
+  "engines": {
+    "node": ">=24"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "optionalDependencies": {
+    "@aseity/idocs-linux-x64-gnu": "0.6.0"
+  }
+}

package/platform.json

@@ -0,0 +1,9 @@
+{
+  "package": "@aseity/idocs-linux-x64-gnu",
+  "target": "x86_64-unknown-linux-gnu",
+  "suffix": "linux-x64-gnu",
+  "os": "linux",
+  "cpu": "x64",
+  "libc": "glibc",
+  "minimumGlibc": "2.36"
+}