Skip to content

Commit a59cd2e

Browse files
Copilothotlong
Copilot
and
hotlong
committed
Fix IDataEngine interface and add tests
- Fixed Zod schema to use manual TypeScript interface for better type safety - Added proper QueryOptions to QueryAST conversion (sort Record to orderBy array) - Created comprehensive test suite for IDataEngine interface - Updated test-objectql-plugin.ts import path - All tests passing (spec package: 1718 tests, custom tests: 100%) Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
1 parent 7992974 commit a59cd2e

File tree

12 files changed

+341
-17
lines changed

12 files changed

+341
-17
lines changed

‎content/docs/references/data/data-engine.mdx‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title: Data Engine
3+
description: Data Engine protocol schemas
4+
---
5+
6+
# Data Engine
7+
8+
<Callout type="info">
9+
**Source:** `packages/spec/src/data/data-engine.zod.ts`
10+
</Callout>
11+
12+
## TypeScript Usage
13+
14+
```typescript
15+
import { QueryFilterSchema } from '@objectstack/spec/data';
16+
import type { QueryFilter } from '@objectstack/spec/data';
17+
18+
// Validate data
19+
const result = QueryFilterSchema.parse(data);
20+
```
21+
22+
---
23+
24+
## QueryFilter
25+
26+
### Properties
27+
28+
| Property | Type | Required | Description |
29+
| :--- | :--- | :--- | :--- |
30+
| **where** | `any` | optional | |
31+

‎content/docs/references/data/filter.mdx‎

Lines changed: 2 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ description: Filter protocol schemas
1212
## TypeScript Usage
1313

1414
```typescript
15-
import { ComparisonOperatorSchema, EqualityOperatorSchema, FieldOperatorsSchema, FieldReferenceSchema, FilterConditionSchema, NormalizedFilterSchema, QueryFilterSchema, RangeOperatorSchema, SetOperatorSchema, SpecialOperatorSchema, StringOperatorSchema } from '@objectstack/spec/data';
16-
import type { ComparisonOperator, EqualityOperator, FieldOperators, FieldReference, FilterCondition, NormalizedFilter, QueryFilter, RangeOperator, SetOperator, SpecialOperator, StringOperator } from '@objectstack/spec/data';
15+
import { ComparisonOperatorSchema, EqualityOperatorSchema, FieldOperatorsSchema, FieldReferenceSchema, FilterConditionSchema, NormalizedFilterSchema, RangeOperatorSchema, SetOperatorSchema, SpecialOperatorSchema, StringOperatorSchema } from '@objectstack/spec/data';
16+
import type { ComparisonOperator, EqualityOperator, FieldOperators, FieldReference, FilterCondition, NormalizedFilter, RangeOperator, SetOperator, SpecialOperator, StringOperator } from '@objectstack/spec/data';
1717

1818
// Validate data
1919
const result = ComparisonOperatorSchema.parse(data);
@@ -94,16 +94,6 @@ const result = ComparisonOperatorSchema.parse(data);
9494

9595
---
9696

97-
## QueryFilter
98-
99-
### Properties
100-
101-
| Property | Type | Required | Description |
102-
| :--- | :--- | :--- | :--- |
103-
| **where** | `any` | optional | |
104-
105-
---
106-
10797
## RangeOperator
10898

10999
### Properties

‎content/docs/references/system/data-engine.mdx‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
title: Data Engine
3+
description: Data Engine protocol schemas
4+
---
5+
6+
# Data Engine
7+
8+
<Callout type="info">
9+
**Source:** `packages/spec/src/system/data-engine.zod.ts`
10+
</Callout>
11+
12+
## TypeScript Usage
13+
14+
```typescript
15+
import { DataEngineSchema, QueryFilterSchema, QueryOptionsSchema } from '@objectstack/spec/system';
16+
import type { DataEngine, QueryFilter, QueryOptions } from '@objectstack/spec/system';
17+
18+
// Validate data
19+
const result = DataEngineSchema.parse(data);
20+
```
21+
22+
---
23+
24+
## DataEngine
25+
26+
Data Engine Interface
27+
28+
### Properties
29+
30+
| Property | Type | Required | Description |
31+
| :--- | :--- | :--- | :--- |
32+
33+
---
34+
35+
## QueryFilter
36+
37+
Query filter conditions
38+
39+
---
40+
41+
## QueryOptions
42+
43+
Query options for find operations
44+
45+
### Properties
46+
47+
| Property | Type | Required | Description |
48+
| :--- | :--- | :--- | :--- |
49+
| **filter** | `Record<string, any>` | optional | Query filter conditions |
50+
| **select** | `string[]` | optional | |
51+
| **sort** | `Record<string, Enum<'1' \| '-1' \| 'asc' \| 'desc'>>` | optional | |
52+
| **limit** | `number` | optional | |
53+
| **skip** | `number` | optional | |
54+
| **top** | `number` | optional | |
55+

‎content/docs/references/system/index.mdx‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ This section contains all protocol schemas for the system layer of ObjectStack.
1010
<Cards>
1111
<Card href="./audit" title="Audit" description="Source: packages/spec/src/system/audit.zod.ts" />
1212
<Card href="./context" title="Context" description="Source: packages/spec/src/system/context.zod.ts" />
13+
<Card href="./data-engine" title="Data Engine" description="Source: packages/spec/src/system/data-engine.zod.ts" />
1314
<Card href="./datasource" title="Datasource" description="Source: packages/spec/src/system/datasource.zod.ts" />
1415
<Card href="./driver" title="Driver" description="Source: packages/spec/src/system/driver.zod.ts" />
1516
<Card href="./events" title="Events" description="Source: packages/spec/src/system/events.zod.ts" />

‎content/docs/references/system/meta.json‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
"pages": [
44
"audit",
55
"context",
6+
"data-engine",
67
"datasource",
78
"driver",
89
"events",

‎packages/objectql/src/index.ts‎

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,12 @@ export class ObjectQL implements IDataEngine {
239239
ast.fields = query.select;
240240
}
241241
if (query.sort) {
242-
ast.orderBy = query.sort;
242+
// Convert sort Record to orderBy array
243+
// sort: { createdAt: -1, name: 'asc' } => orderBy: [{ field: 'createdAt', order: 'desc' }, { field: 'name', order: 'asc' }]
244+
ast.orderBy = Object.entries(query.sort).map(([field, order]) => ({
245+
field,
246+
order: (order === -1 || order === 'desc') ? 'desc' : 'asc'
247+
}));
243248
}
244249
// Handle both limit and top (top takes precedence)
245250
if (query.top !== undefined) {

‎packages/spec/json-schema/system/DataEngine.json‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"$ref": "#/definitions/DataEngine",
3+
"definitions": {
4+
"DataEngine": {
5+
"type": "object",
6+
"properties": {},
7+
"additionalProperties": false,
8+
"description": "Data Engine Interface"
9+
}
10+
},
11+
"$schema": "http://json-schema.org/draft-07/schema#"
12+
}

‎packages/spec/json-schema/system/QueryFilter.json‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"$ref": "#/definitions/QueryFilter",
3+
"definitions": {
4+
"QueryFilter": {
5+
"type": "object",
6+
"additionalProperties": {},
7+
"description": "Query filter conditions"
8+
}
9+
},
10+
"$schema": "http://json-schema.org/draft-07/schema#"
11+
}

‎packages/spec/json-schema/system/QueryOptions.json‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
{
2+
"$ref": "#/definitions/QueryOptions",
3+
"definitions": {
4+
"QueryOptions": {
5+
"type": "object",
6+
"properties": {
7+
"filter": {
8+
"type": "object",
9+
"additionalProperties": {},
10+
"description": "Query filter conditions"
11+
},
12+
"select": {
13+
"type": "array",
14+
"items": {
15+
"type": "string"
16+
}
17+
},
18+
"sort": {
19+
"type": "object",
20+
"additionalProperties": {
21+
"type": [
22+
"number",
23+
"string"
24+
],
25+
"enum": [
26+
1,
27+
-1,
28+
"asc",
29+
"desc"
30+
]
31+
}
32+
},
33+
"limit": {
34+
"type": "number"
35+
},
36+
"skip": {
37+
"type": "number"
38+
},
39+
"top": {
40+
"type": "number"
41+
}
42+
},
43+
"additionalProperties": false,
44+
"description": "Query options for find operations"
45+
}
46+
},
47+
"$schema": "http://json-schema.org/draft-07/schema#"
48+
}

‎packages/spec/src/system/data-engine.zod.ts‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ export const DataEngineSchema = z.object({
6060
* @returns Promise resolving to an array of matching records
6161
*/
6262
find: z.function()
63-
.args(z.string(), QueryOptionsSchema.optional())
63+
.args(z.string())
6464
.returns(z.promise(z.array(z.any())))
6565
.describe('Find records matching a query'),
6666

@@ -95,4 +95,12 @@ export const DataEngineSchema = z.object({
9595
*/
9696
export type QueryFilter = z.infer<typeof QueryFilterSchema>;
9797
export type QueryOptions = z.infer<typeof QueryOptionsSchema>;
98-
export type IDataEngine = z.infer<typeof DataEngineSchema>;
98+
99+
// Define the TypeScript interface manually for better type safety
100+
// Zod function schema doesn't handle optional parameters well
101+
export interface IDataEngine {
102+
insert(objectName: string, data: any): Promise<any>;
103+
find(objectName: string, query?: QueryOptions): Promise<any[]>;
104+
update(objectName: string, id: any, data: any): Promise<any>;
105+
delete(objectName: string, id: any): Promise<boolean>;
106+
}

0 commit comments

Comments
 (0)