Skip to content

Commit 73e477c

Browse files
committed
Refactor skills structure: rename objectstack-data to objectstack-schema, objectstack-kernel to objectstack-plugin, and introduce objectstack-query. Update documentation and references accordingly. Consolidate hooks into objectstack-schema and deprecate objectstack-hooks. Enhance pagination and filtering rules in objectstack-query with comprehensive guides and examples.
1 parent fecaedd commit 73e477c

File tree

12 files changed

+1272
-26
lines changed

12 files changed

+1272
-26
lines changed

.github/copilot-instructions.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -88,11 +88,13 @@ objectstack-ai/spec/
8888
│ └── plugin-bi/ # Plugin example: BI dashboard
8989
9090
├── skills/ # 🤖 AI skill definitions (for Copilot/Cursor)
91-
│ ├── objectstack-data/
91+
│ ├── objectstack-schema/
92+
│ ├── objectstack-query/
9293
│ ├── objectstack-api/
9394
│ ├── objectstack-ui/
9495
│ ├── objectstack-automation/
9596
│ ├── objectstack-ai/
97+
│ ├── objectstack-plugin/
9698
│ └── objectstack-i18n/
9799
98100
└── content/docs/ # 📝 Documentation content
@@ -227,8 +229,9 @@ The `skills/` directory contains domain-specific AI skill definitions. When work
227229
| Skill | Path | Use When |
228230
|:---|:---|:---|
229231
| **Quickstart** | `skills/objectstack-quickstart/SKILL.md` | Project creation, defineStack(), drivers, adapters, bootstrap |
230-
| **Kernel** | `skills/objectstack-kernel/SKILL.md` | Plugin lifecycle, DI, EventBus, Kernel config |
231-
| Data Design | `skills/objectstack-data/SKILL.md` | Designing Objects, Fields, Relations |
232+
| **Plugin** | `skills/objectstack-plugin/SKILL.md` | Plugin lifecycle, DI, EventBus, Kernel config |
233+
| Schema Design | `skills/objectstack-schema/SKILL.md` | Designing Objects, Fields, Relations, Validations |
234+
| Query Design | `skills/objectstack-query/SKILL.md` | Filters, sorting, pagination, aggregation, joins |
232235
| API Design | `skills/objectstack-api/SKILL.md` | Designing REST/GraphQL endpoints |
233236
| UI Design | `skills/objectstack-ui/SKILL.md` | Designing Views, Dashboards, Apps |
234237
| Automation Design | `skills/objectstack-automation/SKILL.md` | Designing Flows, Workflows, Triggers |

CHANGELOG.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1313
- **`rules/` directory** — Detailed implementation rules with incorrect/correct code examples for better AI comprehension
1414
- **`evals/` directory** — Placeholder for future evaluation tests to validate AI assistant understanding
1515
- **Skills refactored:**
16-
- `objectstack-data` — Extracted rules for naming, relationships, validation, indexing, field types, and hooks (moved from objectstack-hooks)
17-
- `objectstack-kernel` — Extracted rules for plugin lifecycle, service registry, and hooks/events system
18-
- `objectstack-hooks`**DEPRECATED** and consolidated into `objectstack-data/rules/hooks.md` (hooks are core to data operations)
16+
- `objectstack-schema` (formerly `objectstack-data`) — Extracted rules for naming, relationships, validation, indexing, field types, and hooks (moved from objectstack-hooks)
17+
- `objectstack-plugin` (formerly `objectstack-kernel`) — Extracted rules for plugin lifecycle, service registry, and hooks/events system
18+
- `objectstack-query` — NEW skill for filters, sorting, pagination, aggregation, joins, expand, full-text search, window functions
19+
- `objectstack-hooks`**DEPRECATED** and consolidated into `objectstack-schema/rules/hooks.md` (hooks are core to data operations)
1920
- `objectstack-ui`, `objectstack-api`, `objectstack-automation`, `objectstack-ai`, `objectstack-i18n`, `objectstack-quickstart` — Added `rules/` and `evals/` structure with initial pattern documentation
2021
- **Benefits:**
2122
- Improved maintainability — Detailed rules are separated from high-level overview

packages/spec/scripts/build-skill-references.ts

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -30,16 +30,18 @@ const SKILLS_DIR = path.resolve(REPO_ROOT, 'skills');
3030
// Paths are relative to packages/spec/src/ (category/file.zod.ts)
3131

3232
const SKILL_MAP: Record<string, string[]> = {
33-
'objectstack-data': [
33+
'objectstack-schema': [
3434
'data/field.zod.ts',
3535
'data/object.zod.ts',
3636
'data/validation.zod.ts',
37-
'data/query.zod.ts',
38-
'data/filter.zod.ts',
39-
'data/datasource.zod.ts',
4037
'data/hook.zod.ts',
38+
'data/datasource.zod.ts',
4139
'security/permission.zod.ts',
4240
],
41+
'objectstack-query': [
42+
'data/query.zod.ts',
43+
'data/filter.zod.ts',
44+
],
4345
'objectstack-ai': [
4446
'ai/agent.zod.ts',
4547
'ai/tool.zod.ts',
@@ -89,7 +91,7 @@ const SKILL_MAP: Record<string, string[]> = {
8991
'data/datasource.zod.ts',
9092
'data/dataset.zod.ts',
9193
],
92-
'objectstack-kernel': [
94+
'objectstack-plugin': [
9395
'kernel/plugin.zod.ts',
9496
'kernel/context.zod.ts',
9597
'kernel/service-registry.zod.ts',

skills/objectstack-hooks/SKILL.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
name: objectstack-hooks
33
description: >
4-
⚠️ DEPRECATED: This skill has been integrated into objectstack-data.
5-
Please use the objectstack-data skill and refer to rules/hooks.md for
4+
⚠️ DEPRECATED: This skill has been integrated into objectstack-schema.
5+
Please use the objectstack-schema skill and refer to rules/hooks.md for
66
data lifecycle hook documentation.
77
license: Apache-2.0
88
compatibility: Requires @objectstack/spec v4+, @objectstack/objectql v4+
@@ -12,22 +12,22 @@ metadata:
1212
domain: hooks
1313
tags: hooks, lifecycle, validation, business-logic, side-effects, data-enrichment
1414
deprecated: true
15-
replacement: objectstack-data
15+
replacement: objectstack-schema
1616
---
1717

1818
# ⚠️ DEPRECATED: Hooks Skill Migrated
1919

20-
This skill has been **deprecated** and integrated into the **objectstack-data** skill.
20+
This skill has been **deprecated** and integrated into the **objectstack-schema** skill.
2121

2222
## Migration
2323

2424
For data lifecycle hook documentation, please use:
2525

26-
**New location:** [`objectstack-data/rules/hooks.md`](../objectstack-data/rules/hooks.md)
26+
**New location:** [`objectstack-schema/rules/hooks.md`](../objectstack-schema/rules/hooks.md)
2727

2828
## Rationale
2929

30-
Hooks are a core part of data operations and are best documented alongside object definitions, field types, and validations. The objectstack-data skill now provides comprehensive coverage of:
30+
Hooks are a core part of data operations and are best documented alongside object definitions, field types, and validations. The objectstack-schema skill now provides comprehensive coverage of:
3131

3232
- Object and field schema design
3333
- Validation rules
@@ -40,10 +40,10 @@ This consolidation reduces skill overlap and makes it easier for AI assistants t
4040

4141
All content from this skill is now available at:
4242

43-
- **Full documentation:** [`../objectstack-data/rules/hooks.md`](../objectstack-data/rules/hooks.md)
44-
- **Parent skill:** [`../objectstack-data/SKILL.md`](../objectstack-data/SKILL.md)
43+
- **Full documentation:** [`../objectstack-schema/rules/hooks.md`](../objectstack-schema/rules/hooks.md)
44+
- **Parent skill:** [`../objectstack-schema/SKILL.md`](../objectstack-schema/SKILL.md)
4545

46-
The objectstack-data skill now includes:
46+
The objectstack-schema skill now includes:
4747
- Hook definition schema
4848
- Hook context API
4949
- 14 lifecycle events (before/after for find/insert/update/delete, etc.)
@@ -58,10 +58,10 @@ The objectstack-data skill now includes:
5858

5959
For hook lifecycle documentation, see:
6060

61-
- [objectstack-data/rules/hooks.md](../objectstack-data/rules/hooks.md) — Complete hook documentation
62-
- [objectstack-data/SKILL.md](../objectstack-data/SKILL.md)Data skill overview
61+
- [objectstack-schema/rules/hooks.md](../objectstack-schema/rules/hooks.md) — Complete hook documentation
62+
- [objectstack-schema/SKILL.md](../objectstack-schema/SKILL.md)Schema skill overview
6363

6464
For kernel-level hooks (kernel:ready, kernel:shutdown, custom plugin events), see:
6565

66-
- [objectstack-kernel/rules/hooks-events.md](../objectstack-kernel/rules/hooks-events.md)Kernel hook system
67-
- [objectstack-kernel/SKILL.md](../objectstack-kernel/SKILL.md)Kernel skill overview
66+
- [objectstack-plugin/rules/hooks-events.md](../objectstack-plugin/rules/hooks-events.md)Plugin hook system
67+
- [objectstack-plugin/SKILL.md](../objectstack-plugin/SKILL.md)Plugin skill overview

skills/objectstack-i18n/SKILL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -691,6 +691,6 @@ export default {
691691

692692
## See Also
693693

694-
- **objectstack-data** — For understanding object and field metadata structure
694+
- **objectstack-schema** — For understanding object and field metadata structure
695695
- **objectstack-ui** — For view, app, and action translations
696696
- **objectstack-automation** — For workflow and flow message translations

skills/objectstack-i18n/references/_index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,6 @@
1414

1515
These schemas are included in the references for completeness but are primarily managed by other skills:
1616

17-
- **objectstack-data** — Object, Field schemas (source for translation extraction)
17+
- **objectstack-schema** — Object, Field schemas (source for translation extraction)
1818
- **objectstack-ui** — View, App, Dashboard schemas (UI translation sources)
1919
- **objectstack-automation** — Flow, Workflow schemas (automation message translations)

0 commit comments

Comments
 (0)