Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
…ectql - Replace @objectql/core peerDependency with @objectstack/objectql in 6 packages - Remove @objectql/core, @objectql/driver-mongo, @objectql/driver-sql, @objectql/platform-node from root deps - Update ARCHITECTURE.md, SDK reference, guides, and copilot instructions - Build (24/24 tasks) and tests (24/24 tasks) pass Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
- Mark R.3 (@objectql/core migration) as complete - Mark R.4 (spec v4.0 naming alignment) as tracked - Update version to 17.0.0, status to "All Phases Complete ✅" - Remove deprecated @objectql packages from External Dependencies - Update CONTRIBUTING.md references from @objectql/types to @objectstack/spec - Add Phase R Outcomes section Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Completes ROADMAP Phase R by removing deprecated @objectql/core (and related @objectql/* packages) from the workspace and standardizing on @objectstack/objectql, with accompanying documentation/roadmap updates to reflect the new ObjectQL packaging.
Changes:
- Remove
@objectql/core/@objectql/driver-*/@objectql/platform-nodefrom root deps and lockfile; keep@objectstack/objectql. - Update six packages’
peerDependenciesfrom@objectql/coreto@objectstack/objectql. - Update ROADMAP + docs to reflect the migration and Phase R completion status.
Reviewed changes
Copilot reviewed 17 out of 18 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
| pnpm-lock.yaml | Removes @objectql/* packages and updates dependency graph to @objectstack/objectql. |
| package.json | Drops deprecated @objectql/* root dependencies. |
| packages/audit/package.json | Switches peer dependency to @objectstack/objectql. |
| packages/auth/package.json | Switches peer dependency to @objectstack/objectql. |
| packages/automation/package.json | Switches peer dependency to @objectstack/objectql. |
| packages/jobs/package.json | Switches peer dependency to @objectstack/objectql. |
| packages/permissions/package.json | Switches peer dependency to @objectstack/objectql. |
| packages/workflow/package.json | Switches peer dependency to @objectstack/objectql. |
| packages/permissions/IMPLEMENTATION_SUMMARY.md | Updates dependency snippet to the new ObjectQL package. |
| packages/browser/README.md | Updates server-side migration example to @objectstack/objectql. |
| content/docs/guide/sdk-reference.mdx | Updates install/setup examples to @objectstack/objectql (but currently contains inconsistent/stale code lines). |
| content/docs/guide/index.mdx | Updates getting-started references toward @objectstack/objectql (but currently contains inconsistent/stale code lines). |
| content/docs/guide/migration-from-kernel.mdx | Updates diagrams to reflect @objectstack/objectql. |
| content/docs/guide/development-plan.mdx | Updates spec/types reference to @objectstack/spec. |
| CONTRIBUTING.md | Updates example imports to @objectstack/spec/data. |
| ARCHITECTURE.md | Updates ObjectQL package references and the “supported drivers” section. |
| ROADMAP.md | Bumps roadmap version/status to “All Phases Complete” and records Phase R outcomes. |
| .github/copilot-instructions.md | Updates dependency description to @objectstack/objectql. |
Files not reviewed (1)
- pnpm-lock.yaml: Language not supported
Comments suppressed due to low confidence (2)
content/docs/guide/sdk-reference.mdx:30
- The snippet calls
kernel.useDriver(driver)/driver.connect(), butdriveris no longer defined/imported after switching toObjectQLPlugin. Update these lines to match the intended setup (driver-based vs plugin-based) so the snippet is runnable.
// Connect driver to kernel
kernel.useDriver(driver);
await driver.connect();
content/docs/guide/sdk-reference.mdx:658
- In the Complete Example,
objectqlis created but the snippet still callskernel.useDriver(driver)/driver.connect()even thoughdriveris not defined. Update this section to consistently use the ObjectQL plugin (or reintroduce a driver variable and import) so the example can be copy-pasted successfully.
driver: 'memory',
});
kernel.useDriver(driver);
await driver.connect();
| const objectql = new ObjectQLPlugin({ | ||
| /* config */ | ||
| }); | ||
| kernel.useDriver(driver); | ||
| await driver.connect(); | ||
| kernel.usePlugin(objectql); | ||
| ``` |
There was a problem hiding this comment.
This example is under kernel.useDriver(driver) but it uses kernel.usePlugin(objectql) instead. Align the example with the documented API (either change the heading/text to the plugin-based API or update the code sample to use useDriver).
| import { ObjectOS } from '@objectos/kernel'; | ||
| import { PostgresDriver } from '@objectql/driver-sql'; | ||
| import { ObjectQLPlugin } from '@objectstack/objectql'; | ||
| import * as yaml from 'js-yaml'; | ||
| import * as fs from 'fs'; | ||
| import * as path from 'path'; |
There was a problem hiding this comment.
The initialization example updates the import to ObjectQLPlugin but the remainder of the snippet still configures PostgresDriver (which is not imported) and never uses ObjectQLPlugin. Update the snippet to a single coherent approach so it can be copy-pasted without missing symbols.
| - **Kernel** (`@objectos/kernel`): Validates, enforces permissions, runs hooks | ||
| - **Drivers** (`@objectql/driver-*`): Translates to SQL/NoSQL queries | ||
| - **Drivers** (`@objectstack/objectql`): Translates to SQL/NoSQL queries | ||
| - **Server** (`@objectos/server`): Exposes REST APIs |
There was a problem hiding this comment.
@objectstack/objectql provides the ObjectQL engine/plugin; it is not itself a database driver. This bullet currently labels it as “Drivers” which is misleading given the repo’s plugin+driver split (e.g., ObjectQLPlugin + DriverPlugin). Consider describing @objectstack/objectql as the data engine and listing actual drivers separately (e.g., @objectstack/driver-memory).
| - ✅ All @objectstack/\* packages at v3.0.6 (R.1) | ||
| - ✅ All @objectql/\* packages upgraded to v4.2.2 (R.1) | ||
| - ✅ Roadmap accuracy audit with spec contract matrix (R.2) | ||
| - ✅ @objectql/core fully removed — migrated to @objectstack/objectql (R.3) | ||
| - ✅ @objectql/driver-mongo, @objectql/driver-sql, @objectql/platform-node removed from dependencies (R.3) |
There was a problem hiding this comment.
Phase R outcomes list both “All @objectql/* packages upgraded to v4.2.2 (R.1)” and later that @objectql packages were removed/migrated. Since the lockfile/root deps in this PR remove @objectql/*, this bullet is now misleading—either drop it or clarify that the upgrade was a temporary step prior to removal.
| // Configure data engine | ||
| const objectql = new ObjectQLPlugin({ | ||
| driver: 'memory', | ||
| }); |
There was a problem hiding this comment.
The Basic Setup example creates objectql = new ObjectQLPlugin(...) but never uses it. Either show how it is registered with the kernel, or remove it from the snippet to avoid confusion.
Completes Phase R (SDK Upgrade & Spec Alignment) — the final remaining roadmap phase. Migrates off the deprecated
@objectql/corepackage and tracks spec v4.0 naming changes.R.3 — @objectql/core deprecation migration
@objectql/core@^4.2.2peerDependency with@objectstack/objectql@^3.0.6in 6 packages (audit, auth, automation, jobs, permissions, workflow)@objectql/core,@objectql/driver-mongo,@objectql/driver-sql,@objectql/platform-nodefrom rootpackage.jsonR.4 — Spec v4.0 naming alignment
Tracked upcoming upstream renames (
plugin-auth→service-auth,plugin-hono-server→service-http) in ROADMAP.Documentation
@objectql/*references replacedVerification
Build (24/24 turbo tasks) and tests (24/24 tasks) pass after migration.
Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.