feat: Add @ocap/remote-iterables package (#600)

Extracts the `/vat` exports from `@metamask/streams` into a new package,
`@ocap/remote-iterables`. This functionality doesn't belong in the
streams package, which is intended to be generic and agnostic of
kernel-specific functionality. Since the functionality is only used
internally, we also keep the new package private for now.

Author: rekmarks

packages/kernel-test/package.json

@@ -58,7 +58,8 @@
     "@metamask/ocap-kernel": "workspace:^",
     "@metamask/streams": "workspace:^",
     "@metamask/utils": "^11.4.2",
-    "@ocap/nodejs": "workspace:^"
+    "@ocap/nodejs": "workspace:^",
+    "@ocap/remote-iterables": "workspace:^"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.17.4",

packages/kernel-test/src/vats/async-generator-iterator-vat.js

@@ -1,7 +1,7 @@
 import { E, Far } from '@endo/far';
 // ESLint's import-x/no-unresolved rule with commonjs:false doesn't support subpath exports
 // eslint-disable-next-line import-x/no-unresolved
-import { makeEventualIterator, makeFarGenerator } from '@metamask/streams/vat';
+import { makeEventualIterator, makeFarGenerator } from '@ocap/remote-iterables';
 
 /**
  * Build function for testing async generators.

packages/kernel-test/tsconfig.json

@@ -8,12 +8,13 @@
     "types": ["vitest"]
   },
   "references": [
-    { "path": "../streams" },
-    { "path": "../test-utils" },
+    { "path": "../kernel-store" },
     { "path": "../kernel-utils" },
     { "path": "../nodejs" },
     { "path": "../ocap-kernel" },
-    { "path": "../kernel-store" }
+    { "path": "../remote-iterables" },
+    { "path": "../streams" },
+    { "path": "../test-utils" }
   ],
   "include": ["../../vitest.config.ts", "./src", "./vitest.config.ts"]
 }

packages/remote-iterables/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+[Unreleased]: https://github.com/MetaMask/ocap-kernel/

packages/remote-iterables/README.md

@@ -0,0 +1,15 @@
+# `@ocap/remote-iterables`
+
+Remotable iterable objects, i.e. iterators and generators.
+
+## Installation
+
+`yarn add @ocap/remote-iterables`
+
+or
+
+`npm install @ocap/remote-iterables`
+
+## Contributing
+
+This package is part of a monorepo. Instructions for contributing can be found in the [monorepo README](https://github.com/MetaMask/ocap-kernel#readme).

packages/remote-iterables/package.json

@@ -0,0 +1,88 @@
+{
+  "name": "@ocap/remote-iterables",
+  "version": "0.0.0",
+  "private": true,
+  "description": "Remotable iterable objects",
+  "homepage": "https://github.com/MetaMask/ocap-kernel/tree/main/packages/remote-iterables#readme",
+  "bugs": {
+    "url": "https://github.com/MetaMask/ocap-kernel/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MetaMask/ocap-kernel.git"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist/"
+  ],
+  "scripts": {
+    "build": "ts-bridge --project tsconfig.build.json --clean",
+    "build:docs": "typedoc",
+    "changelog:validate": "../../scripts/validate-changelog.sh @ocap/remote-iterables",
+    "clean": "rimraf --glob './*.tsbuildinfo' ./.eslintcache ./coverage ./dist",
+    "lint": "yarn lint:eslint && yarn lint:misc --check && yarn constraints && yarn lint:dependencies",
+    "lint:dependencies": "depcheck",
+    "lint:eslint": "eslint . --cache",
+    "lint:fix": "yarn lint:eslint --fix && yarn lint:misc --write && yarn constraints --fix && yarn lint:dependencies",
+    "lint:misc": "prettier --no-error-on-unmatched-pattern '**/*.json' '**/*.md' '**/*.html' '!**/CHANGELOG.old.md' '**/*.yml' '!.yarnrc.yml' '!merged-packages/**' --ignore-path ../../.gitignore",
+    "publish:preview": "yarn npm publish --tag preview",
+    "test": "vitest run --config vitest.config.ts",
+    "test:clean": "yarn test --no-cache --coverage.clean",
+    "test:dev": "yarn test --mode development",
+    "test:verbose": "yarn test --reporter verbose",
+    "test:watch": "vitest --config vitest.config.ts"
+  },
+  "dependencies": {
+    "@endo/exo": "^1.5.12",
+    "@endo/far": "^1.1.14",
+    "@endo/patterns": "^1.7.0",
+    "@endo/stream": "^1.2.13"
+  },
+  "devDependencies": {
+    "@arethetypeswrong/cli": "^0.17.4",
+    "@endo/promise-kit": "^1.1.13",
+    "@metamask/auto-changelog": "^5.0.1",
+    "@metamask/eslint-config": "^14.0.0",
+    "@metamask/eslint-config-nodejs": "^14.0.0",
+    "@metamask/eslint-config-typescript": "^14.0.0",
+    "@ocap/test-utils": "workspace:^",
+    "@ts-bridge/cli": "^0.6.3",
+    "@ts-bridge/shims": "^0.1.1",
+    "@typescript-eslint/eslint-plugin": "^8.29.0",
+    "@typescript-eslint/parser": "^8.29.0",
+    "@typescript-eslint/utils": "^8.29.0",
+    "@vitest/eslint-plugin": "^1.3.4",
+    "depcheck": "^1.4.7",
+    "eslint": "^9.23.0",
+    "eslint-config-prettier": "^10.1.1",
+    "eslint-import-resolver-typescript": "^4.3.1",
+    "eslint-plugin-import-x": "^4.10.0",
+    "eslint-plugin-jsdoc": "^50.6.9",
+    "eslint-plugin-n": "^17.17.0",
+    "eslint-plugin-prettier": "^5.2.6",
+    "eslint-plugin-promise": "^7.2.1",
+    "prettier": "^3.5.3",
+    "rimraf": "^6.0.1",
+    "typedoc": "^0.28.1",
+    "typescript": "~5.8.2",
+    "typescript-eslint": "^8.29.0",
+    "vite": "^7.1.2",
+    "vitest": "^3.2.4"
+  },
+  "engines": {
+    "node": "^20 || >=22"
+  }
+}