bare-stow 0.1.2 → 0.1.4

package/README.md

@@ -118,7 +118,7 @@ await ipc.ready
 
 Bundle the module graph rooted at `entry` for a `target` runtime and write the resulting artifacts to disk at and alongside `out`. Returns an async generator that yields `{ url }` objects as each artifact is written, allowing callers to observe progress.
 
-`entry` is a `URL` (or `URL`-coercible string) pointing at the entry module. `target` selects the target runtime, given either as the built-in name `'bare-sidecar'` or as a [target provider](#targets-and-rpc-providers) object. Other targets ship as their own packages; require one and pass it as the provider. The target determines the harness format, bundle extension, host triples, and whether assets and addons are linked into the bundle or offloaded as sibling files. `out` is the output `URL` of the harness; the bundle is written next to it with the target's extension.
+`entry` is a `URL` (or `URL`-coercible string) pointing at the entry module. `target` selects the target runtime, given either as a built-in name (`'bare-sidecar'` or `'bare-worker'`) or as a [target provider](#targets-and-rpc-providers) object. Other targets ship as their own packages; require one and pass it as the provider. The target determines the harness format, bundle extension, host triples, and whether assets and addons are linked into the bundle or offloaded as sibling files. `out` is the output `URL` of the harness; the bundle is written next to it with the target's extension.
 
 The harness artifacts are yielded first: The harness itself at `out`, followed by a TypeScript declaration (`.d.ts`) alongside it so hosts importing the harness are typed. The bundle is yielded next, then any offloaded assets and native addons when the target supports offloading.
 
@@ -139,7 +139,7 @@ opts = {
 - `server`: The RPC library to wire into the bundle entry shim as a server, given either as a built-in name (`'bare-rpc'`) or as an [RPC provider](#targets-and-rpc-providers) object.
 - `base`: The base `URL` of the module graph. Defaults to the directory containing `entry`.
 - `hosts`: An array of host triples to build for. Must be a subset of the host triples supported by the target; passing a host the target does not support throws. Defaults to all host triples supported by the target.
-- `resolveTarget`: A function mapping a target name to a [target provider](#targets-and-rpc-providers) object, called when `target` is a name not in the built-in registry (which only knows `'bare-sidecar'`).
+- `resolveTarget`: A function mapping a target name to a [target provider](#targets-and-rpc-providers) object, called when `target` is a name not in the built-in registry (which knows `'bare-sidecar'` and `'bare-worker'`).
 - `resolveRPC`: A function mapping an RPC library name to an [RPC provider](#targets-and-rpc-providers) object, called when `client` or `server` is a name not in the built-in registry (which only knows `'bare-rpc'`).
 
 Any additional options are forwarded to `bare-pack`. See <https://github.com/holepunchto/bare-pack> for the full set, including `builtins`, `imports`, `defer`, and `resolve`.
@@ -220,7 +220,7 @@ Stow the module graph rooted at `<entry>`, writing the harness and bundle to the
 
 ##### `--target <name>`
 
-The target runtime. Required. The built-in `bare-sidecar` is resolved directly; any other `<name>` is loaded from its `bare-stow-target-<name>` package, or from `<name>` itself as a full module specifier, resolved from the working directory.
+The target runtime. Required. The built-in `bare-sidecar` and `bare-worker` are resolved directly; any other `<name>` is loaded from its `bare-stow-target-<name>` package, or from `<name>` itself as a full module specifier, resolved from the working directory.
 
 ##### `--client <name>` and `--server <name>`
 

package/index.d.ts

@@ -1,11 +1,12 @@
 import URL from 'bare-url'
+import { PackOptions } from 'bare-pack'
 
 interface Artifact {
   extension?: string
   source: string
 }
 
-type TargetName = 'bare-sidecar'
+type TargetName = 'bare-sidecar' | 'bare-worker'
 
 interface TargetContext {
   bundleSpecifier: string
@@ -46,11 +47,9 @@ interface RPCClient {
   type: string
 }
 
-interface StowOptions {
+interface StowOptions extends Omit<PackOptions, 'offload' | 'linked' | 'resolve' | 'aliases'> {
   client?: RPC | RPCName
   server?: RPC | RPCName
-  base?: URL | string
-  hosts?: string[]
   resolveTarget?(name: string): Target
   resolveRPC?(name: string): RPC
 }

package/lib/protocol.d.ts

@@ -1,9 +1,15 @@
-import { Duplex } from 'bare-stream'
+import { Duplex, DuplexEvents } from 'bare-stream'
 
 declare const CONTROL: number
 declare const USER: number
 
-interface Protocol extends Duplex {
+interface ProtocolEvents extends DuplexEvents {
+  ready: []
+  terminate: []
+  exit: [code: number]
+}
+
+interface Protocol<E extends ProtocolEvents = ProtocolEvents> extends Duplex<E> {
   send(type: string, payload?: object): Promise<void>
 }
 
@@ -13,4 +19,4 @@ declare class Protocol {
 
 declare function attach(stream: Duplex): Protocol
 
-export { type Protocol, attach, CONTROL, USER }
+export { type Protocol, ProtocolEvents, attach, CONTROL, USER }

package/lib/target/bare-worker.js

@@ -0,0 +1,82 @@
+exports.name = 'bare-worker'
+exports.linked = false
+exports.offload = true
+exports.format = 'bundle'
+exports.encoding = null
+exports.extension = '.bundle'
+exports.hosts = [
+  'darwin-arm64',
+  'darwin-x64',
+  'linux-arm64',
+  'linux-x64',
+  'win32-arm64',
+  'win32-x64'
+]
+
+exports.generate = function generate(opts) {
+  const { bundleSpecifier, ipc, rpc, module = 'cjs', client = null } = opts
+
+  const esm = module === 'esm'
+
+  const returned = client ? `{ ${ipc}, ${rpc} }` : `{ ${ipc} }`
+
+  const handle = client
+    ? `{ ${ipc}: import('bare-stow/host').IPC; ${rpc}: ${client.type} }`
+    : `{ ${ipc}: import('bare-stow/host').IPC }`
+
+  const source = esm
+    ? `\
+import Worker from 'bare-worker'
+import stow from 'bare-stow/host'
+import { fileURLToPath } from 'bare-url'
+
+const bundle = fileURLToPath(new URL(${JSON.stringify(bundleSpecifier)}, import.meta.url))
+
+export async function start(opts = {}) {
+  const worker = new Worker(bundle, opts)
+
+  const ${ipc} = stow.wrap(worker.IPC)
+${client ? '\n' + indent(client.source, 2) : ''}
+  await ${ipc}.ready
+
+  return ${returned}
+}
+`
+    : `\
+const path = require('bare-path')
+const Worker = require('bare-worker')
+const stow = require('bare-stow/host')
+
+const bundle = path.join(__dirname, ${JSON.stringify(bundleSpecifier)})
+
+module.exports = {
+  async start(opts = {}) {
+    const worker = new Worker(bundle, opts)
+
+    const ${ipc} = stow.wrap(worker.IPC)
+${client ? '\n' + indent(client.source, 4) : ''}
+    await ${ipc}.ready
+
+    return ${returned}
+  }
+}
+`
+
+  return [
+    { source },
+    {
+      extension: '.d.ts',
+      source: `\
+export function start(opts?: import('bare-worker').WorkerOptions): Promise<${handle}>
+`
+    }
+  ]
+}
+
+function indent(source, spaces) {
+  const pad = ' '.repeat(spaces)
+  return source
+    .split('\n')
+    .map((line) => (line.length === 0 ? line : pad + line))
+    .join('\n')
+}

package/lib/target.js

@@ -1,5 +1,6 @@
 const registry = {
-  'bare-sidecar': () => require('./target/bare-sidecar')
+  'bare-sidecar': () => require('./target/bare-sidecar'),
+  'bare-worker': () => require('./target/bare-worker')
 }
 
 module.exports = function target(name, resolve) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bare-stow",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "description": "Module bundling and harness generation for Bare",
   "exports": {
     "./package": "./package.json",
@@ -76,6 +76,7 @@
   "devDependencies": {
     "bare-rpc": "^1.3.2",
     "bare-sidecar": "^0.5.0",
+    "bare-worker": "^4.3.0",
     "brittle": "^4.0.2",
     "lunte": "^1.7.0",
     "prettier": "^3.3.3",