Skip to content

Commit 0cfd771

Browse files
authored
Merge pull request #282 from objectstack-ai/copilot/complete-roadmap-development
2 parents 721561c + e39b32e commit 0cfd771

File tree

18 files changed

+139
-492
lines changed

18 files changed

+139
-492
lines changed

.github/copilot-instructions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ The **"Business Operating System"** for the ObjectStack ecosystem.
4141
- **Internal:** Event Bus (EventEmitter / Redis / NATS).
4242
- **Outbound:** Webhooks / SMTP / SMS.
4343
- **Dependencies:**
44-
- Depends on `@objectql/core` for Data Access.
44+
- Depends on `@objectstack/objectql` for Data Access.
4545
- Depends on `@objectstack/runtime` for Kernel lifecycle.
4646
- Depends on `@objectstack/spec` for protocol contracts.
4747

ARCHITECTURE.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -54,10 +54,8 @@ All ObjectOS plugins must conform to this lifecycle for consistency and predicta
5454
- **Location**: https://github.com/objectstack-ai/objectql
5555
- **Purpose**: Defines the metadata standard and provides core implementations
5656
- **Key Packages**:
57-
- `@objectql/core` - Metadata parser, AST builder, query compiler
58-
- `@objectql/types` - TypeScript type definitions for the protocol
59-
- `@objectql/driver-sql` - SQL database driver (PostgreSQL, MySQL, SQLite)
60-
- `@objectql/driver-mongo` - MongoDB driver
57+
- `@objectstack/objectql` - ObjectQL plugin (data engine, metadata parser, query compiler)
58+
- `@objectstack/driver-memory` - In-memory data driver for development and testing
6159

6260
### ObjectOS Repository (Runtime Implementation)
6361

@@ -257,10 +255,10 @@ interface ObjectQLDriver {
257255

258256
### Supported Drivers
259257

260-
| Driver | Package | Databases |
261-
| -------------- | ------------------------ | ------------------------- |
262-
| SQL Driver | `@objectql/driver-sql` | PostgreSQL, MySQL, SQLite |
263-
| MongoDB Driver | `@objectql/driver-mongo` | MongoDB |
258+
| Driver | Package | Databases |
259+
| --------------- | ---------------------------- | ------------------------ |
260+
| Memory Driver | `@objectstack/driver-memory` | In-memory (dev/testing) |
261+
| ObjectQL Plugin | `@objectstack/objectql` | SQL, MongoDB via drivers |
264262

265263
## Layer 4: HTTP Layer (@objectos/server)
266264

CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ interface ObjectConfig {
129129
}
130130

131131
// ✅ GOOD
132-
import { ObjectConfig } from '@objectql/types';
132+
import { ObjectConfig } from '@objectstack/spec/data';
133133
```
134134

135135
#### Rule #2: Use Strict Types
@@ -141,7 +141,7 @@ async find(name: string, opts: any): Promise<any> {
141141
}
142142

143143
// ✅ GOOD
144-
import { FindOptions } from '@objectql/types';
144+
import { FindOptions } from '@objectstack/spec/data';
145145

146146
async find(
147147
name: string,

ROADMAP.md

Lines changed: 79 additions & 71 deletions
Large diffs are not rendered by default.

content/docs/guide/development-plan.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ title: ObjectOS Development Plan
100100

101101
**Task List:**
102102

103-
1. Define permission interface in `@objectql/types`
103+
1. Define permission interface in `@objectstack/spec`
104104

105105
```typescript
106106
interface PermissionSet {

content/docs/guide/index.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ ObjectOS is a **metadata-driven runtime engine** that interprets and executes bu
1414
┌─────────────────────────────────────────────────┐
1515
│ ObjectQL (Protocol Repository) │
1616
│ - Metadata standard in YAML │
17-
│ - Type definitions (@objectql/types)
17+
│ - Type definitions (@objectstack/spec)
1818
│ - Database drivers │
1919
└─────────────────────┬───────────────────────────┘
2020
@@ -77,7 +77,7 @@ ObjectOS follows a strict architectural principle:
7777
> **"Kernel handles logic, Drivers handle data, Server handles HTTP."**
7878

7979
- **Kernel** (`@objectos/kernel`): Validates, enforces permissions, runs hooks
80-
- **Drivers** (`@objectql/driver-*`): Translates to SQL/NoSQL queries
80+
- **Drivers** (`@objectstack/objectql`): Translates to SQL/NoSQL queries
8181
- **Server** (`@objectos/server`): Exposes REST APIs
8282

8383
This separation means you can swap databases without changing business logic!
@@ -116,7 +116,7 @@ cd my-app
116116
npm init -y
117117
118118
# Install ObjectOS packages
119-
npm install @objectos/kernel @objectos/server @objectql/driver-sql
119+
npm install @objectos/kernel @objectos/server @objectstack/objectql
120120
121121
# Install database driver
122122
npm install pg # for PostgreSQL
@@ -216,7 +216,7 @@ Create `src/main.ts`:
216216

217217
```typescript
218218
import { ObjectOS } from '@objectos/kernel';
219-
import { PostgresDriver } from '@objectql/driver-sql';
219+
import { ObjectQLPlugin } from '@objectstack/objectql';
220220
import * as yaml from 'js-yaml';
221221
import * as fs from 'fs';
222222
import * as path from 'path';

content/docs/guide/migration-from-kernel.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ ObjectOS has evolved from a monolithic kernel architecture to a **microkernel pl
3030
│ • Hot Reload │
3131
│ • Workflow Engine │
3232
├──────────────────────────────────────┤
33-
│ @objectql/core
33+
│ @objectstack/objectql
3434
└──────────────────────────────────────┘
3535
```
3636

@@ -54,7 +54,7 @@ ObjectOS has evolved from a monolithic kernel architecture to a **microkernel pl
5454
│ • Event Bus (Hooks) │
5555
│ • Dependency Resolver │
5656
├──────────────────────────────────────┤
57-
│ @objectql/core
57+
│ @objectstack/objectql
5858
└──────────────────────────────────────┘
5959
```
6060

content/docs/guide/sdk-reference.mdx

Lines changed: 11 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -7,28 +7,21 @@ This document provides a complete reference for the ObjectOS Kernel SDK. Use the
77
## Installation
88

99
```bash
10-
npm install @objectos/kernel @objectql/driver-sql
10+
npm install @objectos/kernel @objectstack/objectql
1111
```
1212

1313
## Basic Setup
1414

1515
```typescript
1616
import { ObjectOS } from '@objectos/kernel';
17-
import { PostgresDriver } from '@objectql/driver-sql';
17+
import { ObjectQLPlugin } from '@objectstack/objectql';
1818

1919
// Create kernel instance
2020
const kernel = new ObjectOS();
2121

22-
// Configure database driver
23-
const driver = new PostgresDriver({
24-
client: 'pg',
25-
connection: {
26-
host: 'localhost',
27-
port: 5432,
28-
user: 'postgres',
29-
password: 'password',
30-
database: 'myapp',
31-
},
22+
// Configure data engine
23+
const objectql = new ObjectQLPlugin({
24+
driver: 'memory',
3225
});
3326

3427
// Connect driver to kernel
@@ -434,13 +427,12 @@ Set the database driver.
434427
**Example:**
435428

436429
```typescript
437-
import { PostgresDriver } from '@objectql/driver-sql';
430+
import { ObjectQLPlugin } from '@objectstack/objectql';
438431

439-
const driver = new PostgresDriver({
432+
const objectql = new ObjectQLPlugin({
440433
/* config */
441434
});
442-
kernel.useDriver(driver);
443-
await driver.connect();
435+
kernel.usePlugin(objectql);
444436
```
445437

446438
### `kernel.getDriver()`
@@ -654,12 +646,12 @@ type FieldType =
654646

655647
```typescript
656648
import { ObjectOS } from '@objectos/kernel';
657-
import { PostgresDriver } from '@objectql/driver-sql';
649+
import { ObjectQLPlugin } from '@objectstack/objectql';
658650

659651
// Initialize
660652
const kernel = new ObjectOS();
661-
const driver = new PostgresDriver({
662-
connection: process.env.DATABASE_URL,
653+
const objectql = new ObjectQLPlugin({
654+
driver: 'memory',
663655
});
664656

665657
kernel.useDriver(driver);

package.json

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -108,10 +108,6 @@
108108
"@objectos/telemetry": "workspace:*",
109109
"@objectos/ui": "workspace:*",
110110
"@objectos/workflow": "workspace:*",
111-
"@objectql/core": "^4.2.2",
112-
"@objectql/driver-mongo": "^4.2.2",
113-
"@objectql/driver-sql": "^4.2.2",
114-
"@objectql/platform-node": "^4.2.2",
115111
"@objectstack/driver-memory": "3.0.6",
116112
"@objectstack/objectql": "3.0.6",
117113
"@objectstack/plugin-auth": "3.0.6",

packages/audit/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,6 @@
2828
"typescript": "^5.9.3"
2929
},
3030
"peerDependencies": {
31-
"@objectql/core": "^4.2.2"
31+
"@objectstack/objectql": "^3.0.6"
3232
}
3333
}

0 commit comments

Comments
 (0)