@threadedstack/wmd 0.0.0-stage → 0.1.12

package/bin/run.js

@@ -0,0 +1,28 @@
+// The wmd, wmdd and wmd-relay commands of @threadedstack/wmd (bin/<name>.js): runs the program of that name from the
+// platform package with the same arguments, stdin, stdout and stderr, and ends with its exit code (or its signal).
+import { spawn } from 'node:child_process'
+import { binPath } from '../index.js'
+
+export function run(name) {
+  let file
+  try {
+    file = binPath(name)
+  } catch (e) {
+    console.error(e.message)
+    process.exit(1)
+  }
+  const child = spawn(file, process.argv.slice(2), { stdio: 'inherit' })
+  // the terminal sends ^C to the whole process group; other signals are passed on
+  for (const sig of ['SIGTERM', 'SIGHUP', 'SIGQUIT', 'SIGUSR1', 'SIGUSR2']) process.on(sig, () => child.kill(sig))
+  process.on('SIGINT', () => {})
+  child.on('error', (e) => {
+    console.error(`wmd: ${file}: ${e.message}`)
+    process.exit(1)
+  })
+  child.on('exit', (code, signal) => {
+    if (signal) {
+      process.removeAllListeners(signal)
+      process.kill(process.pid, signal)
+    } else process.exit(code ?? 1)
+  })
+}

package/bin/wmd-relay.js

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+import { run } from './run.js'
+
+run('wmd-relay')

package/bin/wmd.js

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+import { run } from './run.js'
+
+run('wmd')

package/bin/wmdd.js

@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+import { run } from './run.js'
+
+run('wmdd')

package/index.d.ts

@@ -0,0 +1,14 @@
+/** The programs a platform package carries. */
+export declare const PROGRAMS: readonly string[]
+/** wmd's version (the release tag without the v). */
+export declare const version: string
+/** The full commit this release was built from. */
+export declare const commit: string
+/** The platform package's name, e.g. @threadedstack/wmd-darwin-arm64. */
+export declare function platformPackage(platform?: string, arch?: string): string
+/** The bin folder of this machine's platform package. */
+export declare function binDir(): string
+/** The path of one program (wmd, wmdd, wmd-run, wmd-relay, wmd-exe-stub, wmd-fixtures-gen, bootlock.sh). */
+export declare function binPath(name?: string): string
+/** The guest files folder (vm.wasm, Image, Image-4k, initramfs.cpio.gz, features, config). */
+export declare function guestDir(arch?: string): string

package/index.js

@@ -0,0 +1,62 @@
+// @threadedstack/wmd: where the wmd programs and guest files of this machine's platform package are.
+//
+//   import { binPath, guestDir } from '@threadedstack/wmd'
+//   binPath('wmd')        // .../node_modules/@threadedstack/wmd-darwin-arm64/bin/wmd
+//   guestDir('arm64')     // .../node_modules/@threadedstack/wmd-darwin-arm64/bin/guest/arm64
+//
+// The programs and the guest live in one platform package (an optional dependency, so npm installs only the one
+// for this os and cpu). wmd finds wmdd, wmd-run and guest/<arch> next to its own file, so they stay together in bin/.
+import { chmodSync, existsSync, readFileSync, statSync } from 'node:fs'
+import { createRequire } from 'node:module'
+import { dirname, join } from 'node:path'
+
+const require = createRequire(import.meta.url)
+const self = JSON.parse(readFileSync(new URL('./package.json', import.meta.url), 'utf8'))
+
+/** The programs a platform package carries. */
+export const PROGRAMS = ['wmd', 'wmdd', 'wmd-run', 'wmd-relay', 'wmd-exe-stub', 'wmd-fixtures-gen', 'bootlock.sh']
+/** wmd's version (the release tag without the v) and the commit it was built from. */
+export const version = self.version
+export const commit = self.wmd?.commit ?? ''
+
+/** The platform package's name for this machine, e.g. @threadedstack/wmd-darwin-arm64. */
+export function platformPackage(platform = process.platform, arch = process.arch) {
+  return `@threadedstack/wmd-${platform}-${arch}`
+}
+
+/** The bin folder of this machine's platform package; throws, naming what to install, when there is none. */
+export function binDir() {
+  const name = platformPackage()
+  if (!Object.hasOwn(self.optionalDependencies ?? {}, name))
+    throw new Error(
+      `wmd: no build for ${process.platform} ${process.arch}; there is one for ` +
+        Object.keys(self.optionalDependencies ?? {}).map((n) => n.replace('@threadedstack/wmd-', '')).join(', '),
+    )
+  let pkg
+  try {
+    pkg = require.resolve(`${name}/package.json`)
+  } catch {
+    throw new Error(
+      `wmd: ${name} is not installed. It is an optional dependency of @threadedstack/wmd; ` +
+        `install without --no-optional / --omit=optional, or add ${name}@${version} yourself`,
+    )
+  }
+  return join(dirname(pkg), 'bin')
+}
+
+/** The path of one program (see PROGRAMS), executable. */
+export function binPath(name = 'wmd') {
+  if (!PROGRAMS.includes(name)) throw new Error(`wmd: ${name} is not one of ${PROGRAMS.join(', ')}`)
+  const p = join(binDir(), name)
+  if (!existsSync(p)) throw new Error(`wmd: ${p} is missing`)
+  // an install that dropped the mode bits (some package managers do) would leave it unrunnable
+  if ((statSync(p).mode & 0o111) === 0) chmodSync(p, 0o755)
+  return p
+}
+
+/** The guest files folder (vm.wasm, Image, Image-4k, initramfs.cpio.gz, features, config) for arch. */
+export function guestDir(arch = 'arm64') {
+  const d = join(binDir(), 'guest', arch)
+  if (!existsSync(d)) throw new Error(`wmd: this build has no ${arch} guest (${d})`)
+  return d
+}

package/package.json

@@ -1,6 +1,40 @@
 {
   "name": "@threadedstack/wmd",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.1.12",
+  "license": "MIT",
+  "homepage": "https://github.com/threadedstack/wmd-releases",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/threadedstack/wmd-releases.git"
+  },
+  "description": "wmd: a Docker Engine API compatible daemon and CLI that runs Linux containers in WebAssembly",
+  "wmd": {
+    "tag": "v0.1.12",
+    "commit": "7ee6237bcee18c5d8a28e8a172838c85802d4602"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "default": "./index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "types": "./index.d.ts",
+  "bin": {
+    "wmd": "bin/wmd.js",
+    "wmdd": "bin/wmdd.js",
+    "wmd-relay": "bin/wmd-relay.js"
+  },
+  "files": [
+    "index.js",
+    "index.d.ts",
+    "bin"
+  ],
+  "engines": {
+    "node": ">=18"
+  },
+  "optionalDependencies": {
+    "@threadedstack/wmd-darwin-arm64": "0.1.12"
+  }
+}

package/README.md

@@ -1,3 +0,0 @@
-# Temporary Holding Version
-
-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.