@jti/typst 1.0.0

package/CHANGELOG.adoc

@@ -0,0 +1,20 @@
+// vim: tw=0 ai et ts=2 sw=2
+= Changelog
+Ewan Edwards <eedwards@journaltech.com>
+:keepacl: https://keepachangelog.com/en/1.1.0/[Keep a Changelog^]
+:semantic: https://semver.org/spec/v2.0.0.html[Semantic Versioning^]
+:org: https://github.com/jtidocs
+:repo: jti-typst
+:unreleased: {org}/{repo}/compare/v1.0.0\...HEAD[Unreleased]
+:1-0-0: {org}/{repo}/releases/tag/1.0.0[1.0.0]
+
+All notable changes to this project are documented in this file.
+
+The format is based on {keepacl}, and this project adheres to {semantic}.
+
+
+== {unreleased}
+
+== {1-0-0} - 2026-03-29
+
+- Initial release.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Journal Technologies, Inc.
+
+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.adoc

@@ -0,0 +1,3 @@
+= jti-typst
+
+A Node.js package that installs a Typst binary suitable for the host platform.

package/install.js

@@ -0,0 +1,167 @@
+#!/usr/bin/env node
+
+// Installs a platform/arch appropriate binary for typst/typst.
+
+'use strict'
+
+const fs            = require('fs')
+const path          = require('path')
+const { pipeline }  = require('stream/promises')
+const tar           = require('tar')
+const https         = require('https')
+const http          = require('http')
+const lzma          = require('lzma-native')
+
+// Debugging helper.
+const DEBUG = true
+const debug = function (...msgs) {
+  if (DEBUG) {
+    for (let m of msgs) {
+      console.log(m)
+    }
+  }
+}
+
+// Main configuration.
+const cwd = process.env.INIT_CWD
+  ? process.env.INIT_CWD
+  : process.cwd()
+const { platform, arch } = process
+const typstVersion = '0.14.2'
+const targetFolder = path.join(__dirname, 'bin')
+
+// Returns the release-specific platform string based on platform
+const mapPlatform = (map = {}) => {
+  if (!(platform in map)) return null
+  return map[platform]
+}
+
+// Returns the release-specific arch string based on arch
+const mapArch = (map = {}) => {
+  if (!(arch in map)) return null
+  return map[arch]
+}
+
+const extractTarXz = async (source, outputDir = 'bin') => {
+  // Create output directory if it doesn't exist
+  if (!fs.existsSync(outputDir)) {
+    fs.mkdirSync(outputDir, { recursive: true })
+    debug(`Created output dir: ${outputDir}`)
+  }
+
+  let readStream
+
+  // Handle HTTP/HTTPS URL
+  const client = source.startsWith('https://') ? https : http
+  readStream = await new Promise((resolve, reject) => {
+    const handleResponse = (response) => {
+      if (response.statusCode === 302 || response.statusCode === 301) {
+        // Handle redirects
+        const redirectUrl = response.headers.location
+        const redirectClient = redirectUrl.startsWith('https://') ? https : http
+        redirectClient.get(redirectUrl, handleResponse).on('error', reject)
+      } else if (response.statusCode === 200) {
+        resolve(response)
+      } else {
+        reject(new Error(`Failed to fetch: ${response.statusCode}`))
+      }
+    }
+
+    client.get(source, handleResponse).on('error', reject);
+  })
+
+  // Decompress xz and extract tar in one pipeline
+  debug(`Have HTTP response for release`)
+  await pipeline(
+    readStream,
+    lzma.createDecompressor(),
+    tar.extract({
+      cwd: outputDir,
+      strip: 0
+    })
+  )
+  debug('Fetched, decompressed, and wrote release contents')
+  debug(fs.readdirSync(outputDir))
+}
+
+const getRelease = async (url, outputDir) => {
+  console.log(`Installing ${url} into ${outputDir}`)
+
+  // Fetch an unpack the release archive
+  await extractTarXz(url, outputDir)
+
+  // Typst archives include an encapsulating folder.
+  // So:
+  // 1. Move the `typst` executable to the target folder.
+  // 2. Remove the encapsulating folder.
+  try {
+    // determine the path to the encapsulating folder
+    let [dirname] = path.basename(url).split('.tar.xz')
+    let dir = path.join(outputDir, dirname)
+    debug(`Encapsulating folder: ${dir}`)
+
+    // Find the Typst binary
+    let found = false
+    const files = fs.readdirSync(dir)
+    for (let file of files) {
+      debug(`Evaluating file: ${file}`)
+      if (file.startsWith('typst')) {
+        found = true
+        debug(`Found binary! Moving...`)
+        // Move the binary out of the encapsulating folder
+        fs.renameSync(path.join(dir, file), path.join(outputDir, file))
+        debug('Moved!')
+        break
+      }
+    }
+
+    // Remove the encapsulating folder
+    if (found) {
+      debug(`Removing encapsulating folder...`)
+      fs.rmSync(dir, { recursive: true })
+      debug(`Removed...`)
+    }
+    else {
+      debug("Did not find Typst binary!")
+    }
+  }
+  catch (err) {
+    console.log(`Could not process downloaded asset:`, err)
+  }
+  debug(`All done!`)
+}
+
+const typst = async () => {
+  // Set up the download URL for the appropriate platform/arch.
+  const p = mapPlatform({
+    'darwin': 'apple-darwin',
+    'linux': 'unknown-linux-musl',
+    'win32': 'pc-windows-msvc'
+  })
+
+  const a = mapArch({
+    'x64': 'x86_64',
+    'arm64': 'aarch64',
+  })
+
+  if (!p || !a) {
+    console.log(`Cannot handle a Typst release for ${p}/${a}.`)
+    return
+  }
+
+  const ext = (p === 'pc-windows-msvc') ? 'zip' : 'tar.xz'
+  if (ext !== 'tar.xz' && ext !== 'zip') {
+    console.log(`Don't know how to handle a .${ext} file!`)
+    return
+  }
+
+  const url = `https://github.com/typst/typst/releases/download/`
+    + `v${typstVersion}/typst-${a}-${p}.${ext}`
+
+  await getRelease(url, targetFolder)
+  debug(`Really all done!`)
+  process.exit(0)
+}
+
+console.log(`Installing typst...`)
+typst()

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@jti/typst",
+  "version": "1.0.0",
+  "license": "MIT",
+  "author": "Ewan Edwards <eedwards@journaltech.com>",
+  "description": "This package installs typst/typst in the `bin` folder.",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/jtidocs/jti-typst.git"
+  },
+  "bugs": {
+    "url": "https://github.com/jtidocs/jti-typst/issues"
+  },
+  "homepage": "https://github.com/jtidocs/jti-typst#readme",
+  "main": "install.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "postinstall": "node install.js"
+  },
+  "bin": {
+    "typst": "run.js"
+  },
+  "keywords": [
+    "antora",
+    "documentation",
+    "link",
+    "check",
+    "vale",
+    "tools"
+  ],
+  "dependencies": {
+    "tar": "7.4.3",
+    "lzma-native": "8.0.6",
+    "@jti/utils": "1.0.3"
+  }
+}

package/run.js

@@ -0,0 +1,18 @@
+#!/usr/bin/env node
+const path = require('path');
+const { execFileSync } = require('child_process');
+
+const binFile = process.platform === 'win32' ? 'typst.exe' : 'typst'
+const binPath = path.join(__dirname, `bin/${binFile}`);
+
+try {
+  execFileSync(binPath, process.argv.slice(2), {
+    stdio: 'inherit',
+    windowsHide: true,
+  })
+}
+catch (err) {
+  // Vale emits its own errors.
+	// But we still need to show that errors occurred.
+	process.exit(1)
+}