diff --git a/.changeset/fix-readme-stale-package-links.md b/.changeset/fix-readme-stale-package-links.md new file mode 100644 index 0000000..3378ccd --- /dev/null +++ b/.changeset/fix-readme-stale-package-links.md @@ -0,0 +1,26 @@ +--- +"@vayo-hq/types": patch +"@vayo-hq/ast": patch +"@vayo-hq/schema-engine": patch +"@vayo-hq/openapi-compiler": patch +"@vayo-hq/db-mongo": patch +"@vayo-hq/capture-express": patch +"@vayo-hq/server": patch +"@vayo-hq/cli": patch +--- + +Fixed every package README still linking to the old, never-actually-published +bare `vayo` npm package name (npm rejected it as a first-publish +typosquat — see the CLI rename changeset) instead of the real +`@vayo-hq/cli`. Also fixed `@vayo-hq/db-mongo`'s README claiming "most people +never call this directly," which contradicted the `createAdapter`/ +`runMigrations` wiring snippet every other doc (and `vayo init`'s own printed +next steps) shows being called directly in a real project. Root README's +"Using Vayo" section no longer describes the pre-publish tarball workflow — +all 9 packages are live on npm now, so it gives the real, verified +`npm install ...@beta` command instead. Every install example across the +repo now explicit about the `@beta` tag rather than relying on `latest`, +since `latest` only moves when explicitly re-tagged during this prerelease +period (discovered live: the very first publish grabbed `latest` +automatically and every subsequent `--tag beta` publish left it pointing at +an old, broken version). diff --git a/README.md b/README.md index 840a364..51a2f86 100644 --- a/README.md +++ b/README.md @@ -19,12 +19,14 @@ latter a full Postman-parity request client), API versioning + spec diffing, an in-app notification center, and the `vayo` CLI (`init`/`scan`/`export`/`create-owner`/`serve`/`diff`). -575 tests across all 9 packages (`pnpm test` from the repo root). +649 tests across all 9 packages (`pnpm test` from the repo root). `docs/09-roadmap.md` tracks the full build sequence and each milestone's -"done when" bar; M7 (this launch-readiness pass) is in progress — the -packages stay `"private": true` in each `package.json` until npm publish is -made as an explicit, separate decision. Everything below has been verified -by installing packed tarballs into a real, separate project via plain +"done when" bar; M7 (this launch-readiness pass) is in progress. All 9 +packages are published to npm under the `@vayo-hq` scope (the CLI is +`@vayo-hq/cli`) — currently under the `beta` dist-tag while this launch +pass is ongoing, so install with `@beta` explicitly rather than relying on +`latest`. Everything below has been verified against the real, published +packages installed into a separate throwaway project via plain `npm install` — not just run inside this workspace. ## Using Vayo in your own project @@ -43,25 +45,10 @@ pulling in Express 5 anyway (`--force`/`--legacy-peer-deps`), `capture()` itself checks the actually-installed version at startup and logs a clear `console.warn` rather than failing silently with wrong route paths. -Until these packages are published to npm, build the tarballs yourself from -a checkout of this repo and install them into your own project by path: - ```bash -# inside this repo -pnpm install && pnpm build -for pkg in types ast schema-engine openapi-compiler db-mongo capture-express server ui cli; do - pnpm --filter @vayo-hq/$pkg pack --pack-destination /some/tarball/dir -done +npm install @vayo-hq/cli@beta @vayo-hq/capture-express@beta @vayo-hq/db-mongo@beta express@^4.19.0 ``` -```bash -# inside YOUR project -npm install /some/tarball/dir/vayo-*.tgz express@^4.19.0 -``` - -Once published, this collapses to `npm install @vayo-hq/capture-express -@vayo-hq/db-mongo @vayo-hq/cli express@^4`. - ### 1. Initialize ```bash diff --git a/packages/ast/README.md b/packages/ast/README.md index c2f5c0a..57c4c6f 100644 --- a/packages/ast/README.md +++ b/packages/ast/README.md @@ -53,9 +53,13 @@ router.get("/orders/:id", getOrder); from the one-line `summary` every route already gets for free. Most people never call this directly — -[`vayo`](https://www.npmjs.com/package/vayo)'s `vayo scan` command +[`@vayo-hq/cli`](https://www.npmjs.com/package/@vayo-hq/cli)'s `vayo scan` command is the intended entry point. This package exists standalone for anyone -building custom tooling around the same static pass. +building custom tooling around the same static pass: + +```bash +npm install @vayo-hq/ast@beta +``` ## License diff --git a/packages/capture-express/README.md b/packages/capture-express/README.md index 2340e5a..97fd5e1 100644 --- a/packages/capture-express/README.md +++ b/packages/capture-express/README.md @@ -29,7 +29,8 @@ The only Vayo package allowed to import Express types — everything downstream of it is framework-agnostic. Typically installed and wired via `vayo init`'s printed snippet — see -[`vayo`](https://www.npmjs.com/package/vayo). +[`@vayo-hq/cli`](https://www.npmjs.com/package/@vayo-hq/cli). Currently in +beta: `npm install @vayo-hq/capture-express@beta`. ## License diff --git a/packages/cli/README.md b/packages/cli/README.md index 3ab1505..7f4b5bc 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -11,8 +11,11 @@ dependency — v1 targets Express 4 only; a bare `npm install express` today resolves to Express 5, which this rejects — install `express@^4.19.0` explicitly). +Currently in beta — install with the `@beta` tag explicitly, rather than +relying on `latest`: + ```bash -npm install @vayo-hq/cli @vayo-hq/capture-express @vayo-hq/db-mongo express@^4.19.0 +npm install @vayo-hq/cli@beta @vayo-hq/capture-express@beta @vayo-hq/db-mongo@beta express@^4.19.0 ``` ## Quickstart diff --git a/packages/db-mongo/README.md b/packages/db-mongo/README.md index 0868d4e..387597b 100644 --- a/packages/db-mongo/README.md +++ b/packages/db-mongo/README.md @@ -19,9 +19,10 @@ and [`@vayo-hq/server`](https://www.npmjs.com/package/@vayo-hq/server) both consume. Every collection is prefixed `vayo_` to avoid colliding with your own collections in a shared database. -Most people never call this directly — it's wired up automatically by -`vayo init`/`vayo scan`/`vayo serve` in -[`vayo`](https://www.npmjs.com/package/vayo). +You'll typically call `createAdapter`/`runMigrations` directly in your own +entry point — it's the exact snippet `vayo init` prints, and one of the +packages installed alongside [`@vayo-hq/cli`](https://www.npmjs.com/package/@vayo-hq/cli) +in the standard quickstart: `npm install @vayo-hq/db-mongo@beta`. ## License diff --git a/packages/openapi-compiler/README.md b/packages/openapi-compiler/README.md index 5455829..d8d7013 100644 --- a/packages/openapi-compiler/README.md +++ b/packages/openapi-compiler/README.md @@ -37,9 +37,12 @@ Other exports: if the input looks like a Postman Collection export instead (a distinct, not-yet-built import path). -Most people use this via -[`vayo export`](https://www.npmjs.com/package/vayo) / -`vayo import`, not directly. +Most people use this via `vayo export`/`vayo import`, not directly — see +[`@vayo-hq/cli`](https://www.npmjs.com/package/@vayo-hq/cli). To use it standalone: + +```bash +npm install @vayo-hq/openapi-compiler@beta +``` ## License diff --git a/packages/schema-engine/README.md b/packages/schema-engine/README.md index 462f55c..5b5c44d 100644 --- a/packages/schema-engine/README.md +++ b/packages/schema-engine/README.md @@ -1,7 +1,7 @@ # @vayo-hq/schema-engine Framework-agnostic schema inference and merge logic for -[Vayo](https://www.npmjs.com/package/vayo) — no Express import, no +[Vayo](https://www.npmjs.com/package/@vayo-hq/cli) — no Express import, no MongoDB import, pure functions only. This is where a captured request/response sample and a static-scan result @@ -20,7 +20,7 @@ re-scan or new traffic can never silently erase a manual edit. Key exports: Consumed internally by [`@vayo-hq/db-mongo`](https://www.npmjs.com/package/@vayo-hq/db-mongo) (which calls these merge functions on every capture/scan) — most people won't import this directly. Start with -[`vayo`](https://www.npmjs.com/package/vayo). +[`@vayo-hq/cli`](https://www.npmjs.com/package/@vayo-hq/cli). ## License diff --git a/packages/server/README.md b/packages/server/README.md index 3e30622..ab0760a 100644 --- a/packages/server/README.md +++ b/packages/server/README.md @@ -38,7 +38,8 @@ myExpressApp.use(vayoApp); ``` Most people run this via `vayo serve` — see -[`vayo`](https://www.npmjs.com/package/vayo). +[`@vayo-hq/cli`](https://www.npmjs.com/package/@vayo-hq/cli). To mount it +yourself instead: `npm install @vayo-hq/server@beta`. ## License diff --git a/packages/types/README.md b/packages/types/README.md index d5834a1..c4d46c3 100644 --- a/packages/types/README.md +++ b/packages/types/README.md @@ -1,14 +1,14 @@ # @vayo-hq/types -Shared TypeScript interfaces for [Vayo](https://www.npmjs.com/package/vayo) — the +Shared TypeScript interfaces for [Vayo](https://www.npmjs.com/package/@vayo-hq/cli) — the data model every other `@vayo-hq/*` package codes against (`CapturedSample`, `EndpointDoc`, `ResolvedEndpoint`, `VayoDbAdapter`, and the rest of the `vayo_*` collection shapes). No runtime code, no dependencies on any other Vayo package. You won't install this directly — it's a dependency of the packages that do the -actual work. Start with [`vayo`](https://www.npmjs.com/package/vayo) -instead. +actual work. Start with [`@vayo-hq/cli`](https://www.npmjs.com/package/@vayo-hq/cli) +instead (currently in beta — install with `npm install @vayo-hq/cli@beta`). ## License