diff --git a/.changeset/objectql-skip-schema-sync-out-of-repo-migrate-script.md b/.changeset/objectql-skip-schema-sync-out-of-repo-migrate-script.md new file mode 100644 index 0000000000..77dec436f0 --- /dev/null +++ b/.changeset/objectql-skip-schema-sync-out-of-repo-migrate-script.md @@ -0,0 +1,21 @@ +--- +"@objectstack/objectql": patch +--- + +`ObjectQLPluginOptions.skipSchemaSync`'s TSDoc no longer presents `apps/cloud/scripts/migrate.ts` as a path in this repository. + +The option's docblock names a concrete script as the out-of-band DDL example: + +```ts + * assume DDL is managed out-of-band (e.g. an `apps/cloud/scripts/migrate.ts` + * run before deploy that connects directly to the database and creates + * all `sys_*` + custom tables once). +``` + +`apps/cloud` was deleted from this repository — the reference cloud host now lives in `objectstack-ai/cloud` — so an unmarked present-tense mention sends a reader looking for a script that is not in the tree they cloned. The referent is genuine, so the sentence is marked rather than re-pointed or deleted. + +This ships to consumers: the docblock is emitted into `dist/index.d.ts` and `dist/index.d.mts`, both of which are in the published tarball (`files: ["dist", "README.md", "CHANGELOG.md"]`), so it is the text an IDE shows on `skipSchemaSync`. + +The wording is copied from `packages/cli/src/commands/serve.ts`'s migrate-and-exit note, which names the same script and was already marked — the two sentences were written as a pair and only one of them had been swept. + +No behaviour changes: the diff is comment text only. No exported symbol, signature, default or runtime path moves. diff --git a/packages/cloud-connection/src/marketplace-install-local-seed-replayer.test.ts b/packages/cloud-connection/src/marketplace-install-local-seed-replayer.test.ts index 4acb05bba6..6971b7081c 100644 --- a/packages/cloud-connection/src/marketplace-install-local-seed-replayer.test.ts +++ b/packages/cloud-connection/src/marketplace-install-local-seed-replayer.test.ts @@ -13,7 +13,7 @@ // // A runtime that declares no data of its own — `objects: []`, no `data`, which is // exactly what a marketplace-install target looks like and exactly what -// `apps/objectos-ee` is — therefore ended up with `seed-datasets` POPULATED and +// `apps/objectos-ee` (cloud repo) is — therefore ended up with `seed-datasets` POPULATED and // `seed-replayer` ABSENT. The org-scoping middleware reads both, finds the // datasets, finds no replayer, logs `datasets present but no replayer registered` // and does nothing. Every organization founded after the install boots EMPTY, diff --git a/packages/objectql/src/plugin.ts b/packages/objectql/src/plugin.ts index f397398d2a..7f91913db1 100644 --- a/packages/objectql/src/plugin.ts +++ b/packages/objectql/src/plugin.ts @@ -162,7 +162,8 @@ export interface ObjectQLPluginOptions { * Skip both `syncRegisteredSchemas()` calls inside `start()` and * assume DDL is managed out-of-band (e.g. an `apps/cloud/scripts/migrate.ts` * run before deploy that connects directly to the database and creates - * all `sys_*` + custom tables once). + * all `sys_*` + custom tables once — that script lives in the separate + * `objectstack-ai/cloud` repo and is NOT a path in this one). * * Use this on cold-start-sensitive runtimes (Cloudflare Containers, * Lambda) where the platform's inbound-request budget is shorter than