|
| 1 | +# ObjectOS Kernel Upgrade to @objectstack 0.7.1 |
| 2 | + |
| 3 | +## Executive Summary |
| 4 | + |
| 5 | +Successfully upgraded ObjectOS kernel and all @objectstack dependencies from version 0.6.1 to 0.7.1, maintaining full backward compatibility while gaining access to new protocol features. |
| 6 | + |
| 7 | +## Upgrade Details |
| 8 | + |
| 9 | +### Package Versions Updated |
| 10 | + |
| 11 | +| Package | From | To | Notes | |
| 12 | +|---------|------|-----|-------| |
| 13 | +| @objectstack/spec | 0.6.1 | 0.7.1 | Core protocol definitions | |
| 14 | +| @objectstack/objectql | 0.6.1 | 0.7.1 | Data engine implementation | |
| 15 | +| @objectstack/runtime | 0.6.1 | 0.7.1 | Runtime kernel | |
| 16 | +| @objectstack/core | 0.6.1 | 0.7.1 | Core utilities (transitive) | |
| 17 | +| @objectstack/types | 0.6.1 | 0.7.1 | Type definitions (transitive) | |
| 18 | + |
| 19 | +### Files Modified |
| 20 | + |
| 21 | +1. **Root package.json** - Updated @objectstack/spec dependency |
| 22 | +2. **packages/kernel/package.json** - Updated @objectstack/spec dependency |
| 23 | +3. **packages/server/package.json** - Updated @objectstack/spec, @objectstack/runtime, @objectstack/objectql |
| 24 | +4. **packages/runtime/package.json** - Updated @objectstack/spec dependency |
| 25 | +5. **patches/@objectstack__objectql@0.7.1.patch** - New patch file to fix package.json main/types entries |
| 26 | + |
| 27 | +### Patches |
| 28 | + |
| 29 | +**Created:** |
| 30 | +- `patches/@objectstack__objectql@0.7.1.patch` - Fixes @objectstack/objectql package.json to point to compiled dist files instead of source TypeScript files |
| 31 | + |
| 32 | +**Removed:** |
| 33 | +- `patches/@objectstack__objectql@0.6.1.patch` - No longer needed |
| 34 | +- `patches/@objectstack__runtime@0.6.1.patch` - No longer needed (fixes included in 0.7.1) |
| 35 | + |
| 36 | +## New Features in @objectstack 0.7.1 |
| 37 | + |
| 38 | +### 1. Batch Operations API |
| 39 | +- Efficient bulk data operations with transaction support |
| 40 | +- Atomic transaction support (all-or-none) |
| 41 | +- Partial success handling |
| 42 | +- Detailed error reporting per record |
| 43 | +- Operations: create, update, upsert, delete |
| 44 | + |
| 45 | +### 2. Standardized Error Codes |
| 46 | +- Machine-readable error codes for common scenarios |
| 47 | +- Categorized errors (validation, authentication, authorization, etc.) |
| 48 | +- HTTP status code mapping |
| 49 | +- Retry guidance for each error type |
| 50 | +- Localization support |
| 51 | + |
| 52 | +### 3. Enhanced AI Protocol |
| 53 | +- New agent action types |
| 54 | +- Improved conversation token tracking (required fields for prompt/completion/total) |
| 55 | +- Cost tracking support |
| 56 | +- File URL support in conversation messages |
| 57 | + |
| 58 | +### 4. GraphQL Protocol Support |
| 59 | +- Schema definitions for GraphQL APIs |
| 60 | +- Query and mutation support |
| 61 | +- Subscription protocol |
| 62 | + |
| 63 | +### 5. API Contract Improvements |
| 64 | +- Enhanced discovery service schemas |
| 65 | +- Better endpoint metadata |
| 66 | +- Improved OpenAPI generation support |
| 67 | + |
| 68 | +## Compatibility |
| 69 | + |
| 70 | +### ✅ Backward Compatible |
| 71 | + |
| 72 | +All existing code remains fully compatible with version 0.7.1: |
| 73 | + |
| 74 | +- **No breaking changes** to existing APIs |
| 75 | +- **All 677 tests passing** without modifications |
| 76 | +- **Builds successfully** for all packages |
| 77 | +- **New features are optional** - can be adopted incrementally |
| 78 | + |
| 79 | +### Code Changes Required |
| 80 | + |
| 81 | +**None.** The upgrade maintains full backward compatibility. New features can be adopted at your own pace. |
| 82 | + |
| 83 | +## Validation Results |
| 84 | + |
| 85 | +### Test Results |
| 86 | +``` |
| 87 | +Test Suites: 30 passed, 30 total |
| 88 | +Tests: 677 passed, 677 total |
| 89 | +Status: ✅ All tests passing |
| 90 | +``` |
| 91 | + |
| 92 | +### Build Results |
| 93 | +``` |
| 94 | +Packages Built: |
| 95 | +- @objectos/kernel ✅ |
| 96 | +- @objectos/server ✅ |
| 97 | +- @objectos/runtime ✅ |
| 98 | +- @objectos/presets/base ✅ |
| 99 | +- @objectos/plugins/* ✅ |
| 100 | +- apps/site ✅ |
| 101 | +
|
| 102 | +Status: ✅ All packages build successfully |
| 103 | +``` |
| 104 | + |
| 105 | +## Migration Guide |
| 106 | + |
| 107 | +### For Existing Applications |
| 108 | + |
| 109 | +No immediate action required. The upgrade is transparent to existing applications. |
| 110 | + |
| 111 | +### To Adopt New Features |
| 112 | + |
| 113 | +#### 1. Batch Operations |
| 114 | + |
| 115 | +```typescript |
| 116 | +import { BatchOperationType } from '@objectstack/spec/api'; |
| 117 | + |
| 118 | +// Example: Batch create records |
| 119 | +const result = await api.batch({ |
| 120 | + type: BatchOperationType.CREATE, |
| 121 | + object: 'users', |
| 122 | + records: [ |
| 123 | + { data: { name: 'User 1', email: 'user1@example.com' } }, |
| 124 | + { data: { name: 'User 2', email: 'user2@example.com' } } |
| 125 | + ], |
| 126 | + options: { |
| 127 | + atomic: true, // All-or-none transaction |
| 128 | + returnRecords: true |
| 129 | + } |
| 130 | +}); |
| 131 | +``` |
| 132 | + |
| 133 | +#### 2. Standardized Error Codes |
| 134 | + |
| 135 | +```typescript |
| 136 | +import { StandardErrorCode, ErrorCategory } from '@objectstack/spec/api'; |
| 137 | + |
| 138 | +// Example: Handle errors with standard codes |
| 139 | +try { |
| 140 | + await api.update(record); |
| 141 | +} catch (error) { |
| 142 | + if (error.code === StandardErrorCode.CONCURRENT_MODIFICATION) { |
| 143 | + // Handle concurrent modification |
| 144 | + } else if (error.category === ErrorCategory.VALIDATION) { |
| 145 | + // Handle validation errors |
| 146 | + } |
| 147 | +} |
| 148 | +``` |
| 149 | + |
| 150 | +## Technical Notes |
| 151 | + |
| 152 | +### Why the Patch? |
| 153 | + |
| 154 | +The @objectstack/objectql@0.7.1 package publishes with `"main": "src/index.ts"` which points to uncompiled TypeScript source. This causes issues when: |
| 155 | + |
| 156 | +1. TypeScript tries to compile it with different module resolution settings |
| 157 | +2. Runtime expects compiled JavaScript |
| 158 | + |
| 159 | +The patch changes: |
| 160 | +```json |
| 161 | +{ |
| 162 | + "main": "src/index.ts", // Before |
| 163 | + "types": "src/index.ts" |
| 164 | +} |
| 165 | +``` |
| 166 | + |
| 167 | +To: |
| 168 | +```json |
| 169 | +{ |
| 170 | + "main": "dist/index.js", // After |
| 171 | + "types": "dist/index.d.ts" |
| 172 | +} |
| 173 | +``` |
| 174 | + |
| 175 | +This is a temporary workaround until the upstream package is fixed. |
| 176 | + |
| 177 | +### ES Modules Support |
| 178 | + |
| 179 | +Version 0.7.1 includes proper `.js` extensions in ES module imports, fixing issues that required patching in 0.6.1. The @objectstack/runtime package now properly supports both CommonJS (for NestJS) and ES modules. |
| 180 | + |
| 181 | +## Next Steps |
| 182 | + |
| 183 | +### Immediate |
| 184 | +- ✅ Upgrade complete |
| 185 | +- ✅ All tests passing |
| 186 | +- ✅ All builds successful |
| 187 | + |
| 188 | +### Optional (When Ready) |
| 189 | +- Adopt batch operations for bulk data processing |
| 190 | +- Implement standardized error codes in API responses |
| 191 | +- Explore new AI protocol features |
| 192 | +- Add GraphQL support if needed |
| 193 | + |
| 194 | +## Support |
| 195 | + |
| 196 | +For issues or questions about this upgrade: |
| 197 | +1. Check the @objectstack/spec changelog |
| 198 | +2. Review the protocol documentation |
| 199 | +3. Open an issue on GitHub |
| 200 | + |
| 201 | +## References |
| 202 | + |
| 203 | +- [@objectstack/spec v0.7.1 Release](https://www.npmjs.com/package/@objectstack/spec/v/0.7.1) |
| 204 | +- [ObjectStack Protocol Documentation](https://github.com/objectstack-ai/spec) |
| 205 | +- [ObjectOS Repository](https://github.com/objectstack-ai/objectos) |
| 206 | + |
| 207 | +--- |
| 208 | + |
| 209 | +**Upgrade Date:** 2026-01-31 |
| 210 | +**Performed By:** GitHub Copilot |
| 211 | +**Status:** ✅ Complete |
0 commit comments