bare-stow 0.0.0 → 0.1.1

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 [yyyy] [name of copyright owner]
+
+   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

@@ -0,0 +1,241 @@
+# bare-stow
+
+Module bundling and harness generation for Bare. Built on top of `bare-pack` (<https://github.com/holepunchto/bare-pack>), `bare-stow` produces a bundle for a target runtime together with a small harness that boots it from the host environment.
+
+A [CLI](#cli) is also included and provides support for stowing a module graph from the command line.
+
+```
+npm i [-g] bare-stow
+```
+
+## Usage
+
+Given an entry module `core.js` that exports a `start` function receiving the IPC stream and an optional `ready` callback. The function may optionally return (or resolve to) a function that runs before the bundle exits:
+
+```js
+module.exports = async function start(ipc, ready) {
+  ipc.on('data', (data) => {
+    // Handle messages from the host.
+  })
+
+  // Optionally call `ready()` to signal readiness early. Otherwise it is
+  // signaled automatically when `start()` resolves.
+  ready()
+
+  return async function stop() {
+    // Clean up before the bundle exits.
+  }
+}
+```
+
+The `ipc` argument is a duplex byte stream. Anything written to it is delivered to the host, and `'data'` events fire when the host writes back.
+
+Stow it for the `bare-sidecar` target:
+
+```js
+const stow = require('bare-stow')
+
+const entry = new URL('file:///app/core.js')
+const out = new URL('file:///app/out/index.js')
+
+for await (const artifact of stow(entry, 'bare-sidecar', out)) {
+  console.log(artifact.url.href)
+}
+```
+
+Or equivalently from the command line:
+
+```console
+$ bare-stow --target bare-sidecar --out ./out/index.js ./core.js
+```
+
+This writes the harness to `out` and the bundle alongside it. The harness can then be required from the host and booted with `start()`. The harness awaits the worker's `ready` signal before resolving, so by the time `start()` returns the bundle is up:
+
+```js
+const harness = require('/app/out/index.js')
+
+const { ipc } = await harness.start()
+
+ipc.write(Buffer.from('hello from the host'))
+
+ipc.on('exit', (code) => {
+  console.log('bundle exited with', code)
+})
+
+// Request a graceful shutdown.
+ipc.destroy()
+```
+
+## Protocol
+
+The harness multiplexes a control channel and a user data channel over the underlying binary duplex stream. The `ipc` returned from `start()` is itself a duplex stream carrying the user data; control frames ride alongside it on the same handle. RPC libraries (such as `bare-rpc`) bind to `ipc` just like a raw stream.
+
+Control frames signal lifecycle events:
+
+| Direction      | Type        | Payload              |
+| :------------- | :---------- | :------------------- |
+| Worker -> Host | `ready`     | -                    |
+| Worker -> Host | `exit`      | `{ code }`           |
+| Worker -> Host | `error`     | `{ message, stack }` |
+| Host -> Worker | `terminate` | -                    |
+
+An incoming `error` frame destroys the local `ipc` with the carried error, surfacing it as a normal stream `error` event. Other control frames emit a regular event named after the type.
+
+The `ipc` handle exposes the lifecycle as events and methods on the same duplex:
+
+- `ipc.ready`: A promise that resolves once the worker has signaled ready. Rejects if the worker errors before ready.
+- `ipc.on('exit', code)`: Emitted when the worker signals exit. `code` carries the exit code.
+- `ipc.on('error', err)`: Emitted when the worker reports a fault, or when the underlying transport errors. Either way the `ipc` is destroyed.
+- `ipc.on('close')`: Emitted when the underlying transport closes.
+- `ipc.destroy()`: Standard stream destroy. Sends a `terminate` control frame to the worker and waits for the underlying transport to close.
+- `ipc.terminate()`: Like `destroy()` but resolves with the worker's exit code.
+
+The framing layer is also exported directly for embedders that bring their own transport:
+
+```js
+const protocol = require('bare-stow/protocol')
+
+const ipc = protocol.attach(stream) // Any duplex byte stream
+ipc.write(Buffer.from('payload')) // User data
+ipc.send('ready') // Control frame
+ipc.on('exit', () => {
+  /* ... */
+})
+```
+
+The host helper layers the lifecycle promise and `terminate` method on top of the protocol:
+
+```js
+const { wrap } = require('bare-stow/host')
+
+const ipc = wrap(stream) // Any duplex byte stream
+await ipc.ready
+```
+
+## API
+
+#### `const artifacts = stow(entry, target, out[, opts])`
+
+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.
+
+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.
+
+Options include:
+
+```js
+opts = {
+  client,
+  server,
+  base,
+  hosts,
+  resolveTarget,
+  resolveRPC
+}
+```
+
+- `client`: The RPC library to wire into the harness as a client, given either as a built-in name (`'bare-rpc'`) or as an [RPC provider](#targets-and-rpc-providers) object.
+- `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'`).
+- `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`.
+
+#### TypeScript
+
+TypeScript modules are supported out of the box: `.ts`, `.mts`, and `.cts` sources are stripped of their type syntax with [`bare-type-stripper`](https://github.com/holepunchto/bare-type-stripper) as they are read, and their extensions are aliased to `.js`, `.mjs`, and `.cjs` respectively for module-type detection. The stripper only erases types, so the module system follows the aliased JavaScript extension. Because stripping is purely lexical, non-erasable constructs (`enum`, `namespace` with a body, parameter properties) throw, and JSX (`.tsx`) is not supported.
+
+### Targets and RPC providers
+
+The harness and RPC code generators are decoupled from the bundler: `target`, `client`, and `server` each accept a provider object directly, so generators can live outside `bare-stow`. Passing a name instead resolves it through `resolveTarget` / `resolveRPC`, which default to the built-in registries.
+
+Both kinds of provider return an ordered array of artifacts. An artifact is `{ extension?, source }`:
+
+```js
+artifacts = [
+  { source }, // The primary output.
+  { extension, source } // A companion, named after the primary plus this extension.
+]
+```
+
+A target provider describes the runtime profile it owns and generates the harness that boots the bundle from the host:
+
+```js
+target = {
+  name, // The target's name, used in diagnostics.
+  linked, // Whether assets and addons are linked into the bundle.
+  offload, // Whether (and which) assets and addons are offloaded as sibling files.
+  format, // The bundle encoding: 'bundle', 'bundle.cjs', 'bundle.mjs', or 'bundle.json'.
+  encoding, // The string encoding for encoded formats, or null for raw bytes.
+  extension, // The bundle file extension, e.g. '.bundle'.
+  module, // The harness module system: 'esm' or 'cjs'.
+  hosts, // The host triples the target supports.
+  generate({ bundleSpecifier, ipc, rpc, client }) {
+    // Return an array of harness artifacts.
+  }
+}
+```
+
+For a target, each artifact is a file. The first has no `extension` and is written to `out`; each remaining artifact is written next to `out` with its own `extension` substituted for the harness extension (e.g. `{ extension: '.d.ts' }` becomes `index.d.ts`). The built-in targets emit two artifacts: The harness and its TypeScript declaration.
+
+`generate()` receives `bundleSpecifier`, the relative specifier from the harness to the bundle artifact; `ipc`, the identifier the harness should bind the IPC stream to; `rpc`, the identifier the RPC client setup binds its instance to; and `client`, the resolved RPC client (or `null` when no client is requested). When present, `client` is `{ source, type }`: `source` is the runtime setup to splice into the harness (referencing `ipc` and binding `rpc`), and `type` is the TypeScript type of the bound instance to splice into the declaration. The target owns `linked`, `offload`, `format`, `encoding`, and `extension`; they are not overridable through `opts`.
+
+An RPC provider generates the wiring that binds an RPC instance to the IPC stream, used on both the client (harness) and server (shim) side:
+
+```js
+rpc = {
+  name, // The library's name, used in diagnostics.
+  generate({ ipc, rpc, module, role }) {
+    // Return an array of RPC artifacts.
+  }
+}
+```
+
+For an RPC provider, each artifact is a fragment contributed to the harness file with the matching extension. The artifact with no `extension` is the runtime setup (reading `ipc`, binding `rpc`); the `{ extension: '.d.ts' }` artifact is the TypeScript type of the bound instance. `generate()` receives `ipc`, the identifier of the IPC stream in scope; `rpc`, the identifier to bind the RPC instance to; `module`, the surrounding module system (`'esm'` or `'cjs'`) so the runtime fragment can emit the matching import form; and `role`, either `'client'` or `'server'`. The bundler owns the `ipc` and `rpc` binding names and threads them to both the target and the RPC provider so neither has to assume them. It renders the client in the target's `module` and the server as `'esm'` (the shim is always an ES module), splicing the runtime fragment and, for the client, the type fragment into the target's artifacts. The shim is not a typed, host-facing module, so the server's type fragment is unused.
+
+## CLI
+
+#### `bare-stow [flags] <entry>`
+
+Stow the module graph rooted at `<entry>`, writing the harness and bundle to the path given by `--out`.
+
+```console
+--version|-v
+--target <name>
+--client <name>
+--server <name>
+--base <path>
+--out|-o <path>
+--builtins <path>
+--imports <path>
+--defer <specifier>
+--host <name>
+--help|-h
+```
+
+##### `--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.
+
+##### `--client <name>` and `--server <name>`
+
+The RPC library to wire into the harness (`--client`) or the bundle entry shim (`--server`). The built-in `bare-rpc` is resolved directly; any other `<name>` is loaded from its `bare-stow-rpc-<name>` package, or from `<name>` itself as a full module specifier, resolved from the working directory.
+
+##### `--builtins <path>` and `--imports <path>`
+
+Paths to JavaScript or JSON files exporting a list of builtin module names and a map of global import overrides respectively. Forwarded to `bare-pack`.
+
+##### `--defer <specifier>`
+
+A module specifier whose resolution should be deferred. May be passed multiple times.
+
+##### `--host <name>`
+
+A host triple to build for. Must be a subset of the host triples supported by the target. May be passed multiple times. Defaults to all host triples supported by the target.
+
+## License
+
+Apache-2.0

package/bin.js

@@ -0,0 +1,107 @@
+#!/usr/bin/env node
+const path = require('path')
+const { pathToFileURL } = require('url')
+const { command, flag, arg, summary } = require('paparam')
+const pkg = require('./package')
+const stow = require('.')
+
+const cmd = command(
+  pkg.name,
+  summary(pkg.description),
+  arg('<entry>', 'The entry point of the module graph'),
+  flag('--version|-v', 'Print the current version'),
+  flag(
+    '--target <name>',
+    'The target runtime (bare-sidecar, or a bare-stow-target-<name> package)'
+  ),
+  flag(
+    '--client <name>',
+    'The RPC client to include (bare-rpc, or a bare-stow-rpc-<name> package)'
+  ),
+  flag(
+    '--server <name>',
+    'The RPC server to include (bare-rpc, or a bare-stow-rpc-<name> package)'
+  ),
+  flag('--base <path>', 'The base path of the bundle'),
+  flag('--out|-o <path>', 'The output path of the harness'),
+  flag('--builtins <path>', 'A list of builtin modules'),
+  flag('--imports <path>', 'A map of global import overrides'),
+  flag('--defer <specifier>', 'A module specifier to defer resolution of').multiple(),
+  flag('--host <name>', 'A host triple to include (must be a subset of the target)').multiple(),
+  async (cmd) => {
+    const { entry } = cmd.args
+    let {
+      version,
+      target,
+      client,
+      server,
+      base = '.',
+      out,
+      builtins,
+      imports,
+      defer,
+      host: hosts
+    } = cmd.flags
+
+    if (version) return console.log(`v${pkg.version}`)
+
+    if (!target) throw new Error('--target is required')
+    if (!out) throw new Error('--out is required')
+
+    if (builtins) {
+      builtins = require(path.resolve(builtins))
+
+      if ('default' in builtins) builtins = builtins.default
+    }
+
+    if (imports) {
+      imports = require(path.resolve(imports))
+
+      if ('default' in imports) imports = imports.default
+    }
+
+    base = pathToFileURL(base)
+
+    if (!base.pathname.endsWith('/')) base.pathname += '/'
+
+    for await (const _ of stow(pathToFileURL(entry), target, pathToFileURL(out), {
+      client,
+      server,
+      base,
+      hosts,
+      resolveTarget,
+      resolveRPC,
+      builtins,
+      imports,
+      defer
+    })) {
+      //
+    }
+  }
+)
+
+// Built-in names are resolved by bare-stow itself; any other name is loaded
+// from its `bare-stow-target-<name>` / `bare-stow-rpc-<name>` package, or as a
+// full module specifier, resolved from the working directory.
+
+function resolveTarget(name) {
+  return load('bare-stow-target', name)
+}
+
+function resolveRPC(name) {
+  return load('bare-stow-rpc', name)
+}
+
+function load(prefix, name) {
+  for (const specifier of [`${prefix}-${name}`, name]) {
+    try {
+      return require(require.resolve(specifier, { paths: [process.cwd()] }))
+    } catch {
+      continue
+    }
+  }
+
+  throw new Error(`Cannot resolve '${name}'`)
+}
+
+cmd.parse()

package/index.d.ts

@@ -0,0 +1,83 @@
+import URL from 'bare-url'
+
+interface Artifact {
+  extension?: string
+  source: string
+}
+
+type TargetName = 'bare-sidecar'
+
+interface TargetContext {
+  bundleSpecifier: string
+  ipc: string
+  rpc: string
+  client: RPCClient | null
+}
+
+interface Target {
+  name: string
+  linked: boolean
+  offload: boolean | { addons?: boolean; assets?: boolean }
+  format: 'bundle' | 'bundle.cjs' | 'bundle.mjs' | 'bundle.json'
+  encoding: string | null
+  extension: string
+  module: 'esm' | 'cjs'
+  hosts: string[]
+  generate(context: TargetContext): Artifact[]
+}
+
+type RPCName = 'bare-rpc'
+
+interface RPCContext {
+  ipc: string
+  rpc: string
+  module: 'esm' | 'cjs'
+  role: 'client' | 'server'
+}
+
+interface RPC {
+  name: string
+  generate(context: RPCContext): Artifact[]
+}
+
+interface RPCClient {
+  source: string
+  type: string
+}
+
+interface StowOptions {
+  client?: RPC | RPCName
+  server?: RPC | RPCName
+  base?: URL | string
+  hosts?: string[]
+  resolveTarget?(name: string): Target
+  resolveRPC?(name: string): RPC
+}
+
+interface StowArtifact {
+  url: URL
+}
+
+declare function stow(
+  entry: URL | string,
+  target: Target | TargetName,
+  out: URL | string,
+  opts?: StowOptions
+): AsyncGenerator<StowArtifact>
+
+declare namespace stow {
+  export {
+    type Target,
+    type TargetName,
+    type TargetContext,
+    type RPC,
+    type RPCName,
+    type RPCContext,
+    type RPCClient,
+    type Artifact,
+    type StowOptions,
+    type StowArtifact
+  }
+}
+
+export = stow