Skip to content

feat(spec)!: remove deprecated DriverInterface alias — use IDataDriver (11.0, #2378)#2384

Merged
os-zhuang merged 1 commit into
mainfrom
v11-remove-idataengine
Jun 27, 2026
Merged

feat(spec)!: remove deprecated DriverInterface alias — use IDataDriver (11.0, #2378)#2384
os-zhuang merged 1 commit into
mainfrom
v11-remove-idataengine

Conversation

@os-zhuang

Copy link
Copy Markdown
Contributor

Addresses #2378 (with a scope correction). Part of the 11.0 breaking-change batch (#2364).

Scope correction

The issue title said "remove IDataEngine", but reading the code: IDataEngine is NOT deprecated — it's the live engine-layer contract (ObjectQL implements IDataEngine, 60 refs). The genuine @deprecated alias is DriverInterface (= IDataDriver). So this PR removes DriverInterface; IDataEngine stays.

Changes

  • spec/contracts/data-engine.ts: drop the DriverInterface alias + now-unused IDataDriver import.
  • @objectstack/core: drop the DriverInterface re-export (contracts/data-engine.ts + index.ts).
  • objectql/engine.ts: type drivers as IDataDriver (11 refs) — type-identical, since the alias literally was IDataDriver.
  • driver-memory config / sql-driver comment / data-engine.test.ts: renamed to IDataDriver.
  • Regenerated spec api-surface.json (diff is exactly one line: - "DriverInterface (type)").

Not touched

  • IDataEngine (live, not deprecated).
  • The separate zod-derived DriverInterface / DriverInterfaceSchema in @objectstack/spec/data (runtime driver schema) — different type, same name, not deprecated.

Verification

spec contracts/data tests 32, objectql 718 green; 8 build tasks green (incl. objectql DTS typecheck); api-surface snapshot regenerated. No other package imports the alias.

Driver authors migrate DriverInterfaceIDataDriver (identical shape).

🤖 Generated with Claude Code

…r (11.0, #2378)

Scope correction: `IDataEngine` is NOT deprecated (live engine-layer contract,
`ObjectQL implements IDataEngine`). The actual `@deprecated` alias was
`DriverInterface` (= `IDataDriver`) in spec/contracts + core.

- spec/contracts/data-engine.ts: drop the `DriverInterface` alias (+ now-unused
  IDataDriver import)
- core: drop the `DriverInterface` re-export (contracts/data-engine.ts + index.ts)
- objectql/engine.ts: type drivers as `IDataDriver` (type-identical rename, 11 refs)
- driver-memory config / sql-driver comment / data-engine.test.ts: IDataDriver
- regen spec api-surface snapshot (only `DriverInterface (type)` removed)

Untouched (not deprecated): `IDataEngine`, and the separate zod
`DriverInterface`/`DriverInterfaceSchema` in spec/data (runtime driver schema).

Verified: spec contracts/data tests (32) + objectql (718) green; 8 build tasks
green; api-surface check will pass (snapshot regenerated).

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
@vercel

vercel Bot commented Jun 27, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
spec Ready Ready Preview, Comment Jun 27, 2026 3:17pm

Request Review

@github-actions github-actions Bot added documentation Improvements or additions to documentation tests tooling size/s labels Jun 27, 2026
@github-actions

Copy link
Copy Markdown
Contributor

📓 Docs Drift Check

This PR changes 5 package(s): @objectstack/core, @objectstack/objectql, @objectstack/driver-memory, @objectstack/driver-sql, @objectstack/spec.

100 hand-written doc(s) reference the affected code and may need an implementation-accuracy re-verification:

  • content/docs/concepts/architecture.mdx (via @objectstack/spec)
  • content/docs/concepts/cloud-artifact-api.mdx (via packages/spec)
  • content/docs/concepts/cluster-semantics.mdx (via @objectstack/spec)
  • content/docs/concepts/core/index.mdx (via @objectstack/core)
  • content/docs/concepts/core/plugins.mdx (via @objectstack/core, @objectstack/driver-sql)
  • content/docs/concepts/core/services.mdx (via @objectstack/core, @objectstack/objectql)
  • content/docs/concepts/design-principles.mdx (via packages/spec)
  • content/docs/concepts/implementation-status.mdx (via @objectstack/core, @objectstack/objectql, @objectstack/driver-memory, @objectstack/driver-sql, @objectstack/spec)
  • content/docs/concepts/index.mdx (via @objectstack/spec)
  • content/docs/concepts/metadata-driven.mdx (via @objectstack/spec)
  • content/docs/concepts/metadata-lifecycle.mdx (via @objectstack/objectql, packages/spec)
  • content/docs/concepts/north-star.mdx (via packages/core, packages/spec)
  • content/docs/concepts/packages.mdx (via @objectstack/core, @objectstack/objectql, @objectstack/driver-memory, @objectstack/spec)
  • content/docs/concepts/setup-app.mdx (via @objectstack/spec)
  • content/docs/concepts/skills.mdx (via @objectstack/spec)
  • content/docs/concepts/terminology.mdx (via @objectstack/driver-sql)
  • content/docs/concepts/webhook-delivery.mdx (via @objectstack/core, @objectstack/spec)
  • content/docs/getting-started/architecture.mdx (via @objectstack/spec)
  • content/docs/getting-started/cli.mdx (via @objectstack/spec)
  • content/docs/getting-started/core-concepts.mdx (via @objectstack/spec)
  • content/docs/getting-started/examples.mdx (via @objectstack/spec)
  • content/docs/getting-started/glossary.mdx (via @objectstack/driver-memory, @objectstack/driver-sql)
  • content/docs/getting-started/quick-start.mdx (via @objectstack/spec)
  • content/docs/guides/adding-a-metadata-type.mdx (via @objectstack/spec)
  • content/docs/guides/ai-capabilities.mdx (via @objectstack/core, @objectstack/spec)
  • content/docs/guides/airtable-dashboard-analysis.mdx (via @objectstack/spec)
  • content/docs/guides/analytics-datasets.mdx (via @objectstack/spec)
  • content/docs/guides/api-reference.mdx (via @objectstack/spec)
  • content/docs/guides/authentication.mdx (via @objectstack/core, @objectstack/objectql, @objectstack/driver-memory)
  • content/docs/guides/business-logic.mdx (via @objectstack/spec)
  • content/docs/guides/cheatsheets/backward-compatibility.mdx (via @objectstack/spec)
  • content/docs/guides/cheatsheets/error-catalog.mdx (via @objectstack/spec)
  • content/docs/guides/cheatsheets/field-type-gallery.mdx (via @objectstack/spec)
  • content/docs/guides/cheatsheets/field-validation-rules.mdx (via @objectstack/spec)
  • content/docs/guides/cheatsheets/permissions-matrix.mdx (via @objectstack/spec)
  • content/docs/guides/cheatsheets/protocol-diagram.mdx (via packages/spec)
  • content/docs/guides/cheatsheets/query-cheat-sheet.mdx (via @objectstack/spec)
  • content/docs/guides/cheatsheets/quick-reference.mdx (via @objectstack/spec)
  • content/docs/guides/client-sdk.mdx (via @objectstack/spec)
  • content/docs/guides/common-patterns.mdx (via @objectstack/spec)
  • content/docs/guides/contracts/auth-service.mdx (via packages/spec)
  • content/docs/guides/contracts/cache-service.mdx (via packages/spec)
  • content/docs/guides/contracts/data-engine.mdx (via @objectstack/spec)
  • content/docs/guides/contracts/index.mdx (via @objectstack/core, @objectstack/spec)
  • content/docs/guides/contracts/metadata-service.mdx (via packages/spec)
  • content/docs/guides/contracts/storage-service.mdx (via packages/spec)
  • content/docs/guides/data-modeling.mdx (via @objectstack/spec)
  • content/docs/guides/deployment-vercel.mdx (via @objectstack/objectql, @objectstack/driver-memory, @objectstack/spec)
  • content/docs/guides/driver-configuration.mdx (via @objectstack/driver-memory, @objectstack/driver-sql, @objectstack/spec)
  • content/docs/guides/error-handling-client.mdx (via @objectstack/spec)
  • content/docs/guides/error-handling-server.mdx (via @objectstack/spec)
  • content/docs/guides/external-datasources.mdx (via @objectstack/spec)
  • content/docs/guides/formula.mdx (via packages/objectql, @objectstack/spec)
  • content/docs/guides/hook-bodies.mdx (via packages/spec)
  • content/docs/guides/kernel-services.mdx (via @objectstack/core, @objectstack/objectql, @objectstack/driver-memory, @objectstack/spec)
  • content/docs/guides/metadata/dashboard.mdx (via @objectstack/spec)
  • content/docs/guides/metadata/field.mdx (via @objectstack/spec)
  • content/docs/guides/metadata/flow.mdx (via @objectstack/spec)
  • content/docs/guides/metadata/index.mdx (via @objectstack/spec)
  • content/docs/guides/metadata/object.mdx (via @objectstack/spec)
  • content/docs/guides/metadata/validation.mdx (via @objectstack/spec)
  • content/docs/guides/metadata/workflow.mdx (via @objectstack/spec)
  • content/docs/guides/objectql-migration.mdx (via @objectstack/core, @objectstack/objectql)
  • content/docs/guides/packages.mdx (via @objectstack/core, @objectstack/objectql, @objectstack/driver-memory, @objectstack/driver-sql, @objectstack/spec)
  • content/docs/guides/plugin-development.mdx (via @objectstack/core, @objectstack/spec)
  • content/docs/guides/plugins.mdx (via @objectstack/core, @objectstack/objectql, @objectstack/driver-memory, @objectstack/spec)
  • content/docs/guides/project-scoping.mdx (via @objectstack/spec)
  • content/docs/guides/public-forms.mdx (via @objectstack/spec)
  • content/docs/guides/runtime-services/email-service.mdx (via packages/spec)
  • content/docs/guides/runtime-services/examples.mdx (via @objectstack/core)
  • content/docs/guides/runtime-services/index.mdx (via packages/spec)
  • content/docs/guides/runtime-services/queue-service.mdx (via packages/spec)
  • content/docs/guides/runtime-services/sharing-service.mdx (via packages/spec)
  • content/docs/guides/runtime-services/storage-service.mdx (via packages/spec)
  • content/docs/guides/security.mdx (via @objectstack/spec)
  • content/docs/guides/seed-data.mdx (via @objectstack/spec)
  • content/docs/guides/skills.mdx (via @objectstack/spec)
  • content/docs/guides/standards.mdx (via @objectstack/spec)
  • content/docs/guides/troubleshooting.mdx (via @objectstack/spec)
  • content/docs/guides/validating-metadata.mdx (via @objectstack/spec)
  • content/docs/protocol/knowledge.mdx (via @objectstack/spec)
  • content/docs/protocol/objectos/config-resolution.mdx (via @objectstack/core, @objectstack/spec)
  • content/docs/protocol/objectos/i18n-standard.mdx (via @objectstack/spec)
  • content/docs/protocol/objectos/index.mdx (via @objectstack/core, @objectstack/objectql, @objectstack/driver-sql)
  • content/docs/protocol/objectos/lifecycle.mdx (via @objectstack/core, @objectstack/driver-sql, @objectstack/spec)
  • content/docs/protocol/objectos/plugin-spec.mdx (via @objectstack/core, @objectstack/spec)
  • content/docs/protocol/objectos/runtime-capabilities.mdx (via @objectstack/spec)
  • content/docs/protocol/objectql/index.mdx (via packages/spec)
  • content/docs/protocol/objectql/query-syntax.mdx (via @objectstack/spec)
  • content/docs/protocol/objectql/schema.mdx (via @objectstack/spec)
  • content/docs/protocol/objectql/security.mdx (via packages/spec)
  • content/docs/protocol/objectql/state-machine.mdx (via @objectstack/objectql, @objectstack/spec)
  • content/docs/protocol/objectui/actions.mdx (via @objectstack/spec)
  • content/docs/protocol/objectui/concept.mdx (via @objectstack/spec)
  • content/docs/protocol/objectui/index.mdx (via @objectstack/spec)
  • content/docs/protocol/objectui/layout-dsl.mdx (via packages/spec)
  • content/docs/protocol/objectui/record-alert.mdx (via @objectstack/spec)
  • content/docs/protocol/objectui/widget-contract.mdx (via @objectstack/spec)
  • content/docs/releases/index.mdx (via @objectstack/spec)
  • content/docs/releases/v9.mdx (via @objectstack/objectql, @objectstack/spec)

Advisory only. To re-verify, run the docs-accuracy-audit workflow scoped to these files:
node scripts/docs-audit/affected-docs.mjs origin/main → pass the list as args.docs.

@os-zhuang
os-zhuang merged commit 3e593a7 into main Jun 27, 2026
17 checks passed
@os-zhuang
os-zhuang deleted the v11-remove-idataengine branch June 27, 2026 15:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size/s tests tooling

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant