@cleocode/contracts 2026.3.37 → 2026.3.39
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +21 -0
- package/README.md +491 -0
- package/dist/adapter.d.ts +0 -0
- package/dist/adapter.d.ts.map +0 -0
- package/dist/adapter.js +0 -0
- package/dist/adapter.js.map +0 -0
- package/dist/archive.d.ts +0 -0
- package/dist/archive.d.ts.map +0 -0
- package/dist/archive.js +0 -0
- package/dist/archive.js.map +0 -0
- package/dist/brain.d.ts +0 -0
- package/dist/brain.d.ts.map +0 -0
- package/dist/brain.js +0 -0
- package/dist/brain.js.map +0 -0
- package/dist/capabilities.d.ts +0 -0
- package/dist/capabilities.d.ts.map +0 -0
- package/dist/capabilities.js +0 -0
- package/dist/capabilities.js.map +0 -0
- package/dist/config.d.ts +0 -0
- package/dist/config.d.ts.map +0 -0
- package/dist/config.js +0 -0
- package/dist/config.js.map +0 -0
- package/dist/context-monitor.d.ts +0 -0
- package/dist/context-monitor.d.ts.map +0 -0
- package/dist/context-monitor.js +0 -0
- package/dist/context-monitor.js.map +0 -0
- package/dist/data-accessor.d.ts +0 -0
- package/dist/data-accessor.d.ts.map +1 -1
- package/dist/data-accessor.js +0 -0
- package/dist/data-accessor.js.map +1 -1
- package/dist/discovery.d.ts +0 -0
- package/dist/discovery.d.ts.map +0 -0
- package/dist/discovery.js +0 -0
- package/dist/discovery.js.map +0 -0
- package/dist/errors.d.ts +135 -0
- package/dist/errors.d.ts.map +1 -0
- package/dist/errors.js +180 -0
- package/dist/errors.js.map +1 -0
- package/dist/exit-codes.d.ts +0 -0
- package/dist/exit-codes.d.ts.map +0 -0
- package/dist/exit-codes.js +0 -0
- package/dist/exit-codes.js.map +0 -0
- package/dist/hooks.d.ts +0 -0
- package/dist/hooks.d.ts.map +0 -0
- package/dist/hooks.js +0 -0
- package/dist/hooks.js.map +0 -0
- package/dist/index.d.ts +25 -25
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +14 -12
- package/dist/index.js.map +1 -1
- package/dist/install.d.ts +0 -0
- package/dist/install.d.ts.map +0 -0
- package/dist/install.js +0 -0
- package/dist/install.js.map +0 -0
- package/dist/lafs.d.ts +0 -0
- package/dist/lafs.d.ts.map +0 -0
- package/dist/lafs.js +0 -0
- package/dist/lafs.js.map +0 -0
- package/dist/memory.d.ts +0 -0
- package/dist/memory.d.ts.map +0 -0
- package/dist/memory.js +0 -0
- package/dist/memory.js.map +0 -0
- package/dist/operations/index.d.ts +0 -0
- package/dist/operations/index.d.ts.map +0 -0
- package/dist/operations/index.js +0 -0
- package/dist/operations/index.js.map +0 -0
- package/dist/operations/issues.d.ts +0 -0
- package/dist/operations/issues.d.ts.map +0 -0
- package/dist/operations/issues.js +0 -0
- package/dist/operations/issues.js.map +0 -0
- package/dist/operations/lifecycle.d.ts +0 -0
- package/dist/operations/lifecycle.d.ts.map +1 -1
- package/dist/operations/lifecycle.js +0 -0
- package/dist/operations/lifecycle.js.map +0 -0
- package/dist/operations/orchestrate.d.ts +0 -0
- package/dist/operations/orchestrate.d.ts.map +0 -0
- package/dist/operations/orchestrate.js +0 -0
- package/dist/operations/orchestrate.js.map +0 -0
- package/dist/operations/release.d.ts +0 -0
- package/dist/operations/release.d.ts.map +0 -0
- package/dist/operations/release.js +0 -0
- package/dist/operations/release.js.map +0 -0
- package/dist/operations/research.d.ts +0 -0
- package/dist/operations/research.d.ts.map +0 -0
- package/dist/operations/research.js +0 -0
- package/dist/operations/research.js.map +0 -0
- package/dist/operations/session.d.ts +0 -0
- package/dist/operations/session.d.ts.map +0 -0
- package/dist/operations/session.js +0 -0
- package/dist/operations/session.js.map +0 -0
- package/dist/operations/skills.d.ts +0 -0
- package/dist/operations/skills.d.ts.map +0 -0
- package/dist/operations/skills.js +0 -0
- package/dist/operations/skills.js.map +0 -0
- package/dist/operations/system.d.ts +0 -0
- package/dist/operations/system.d.ts.map +0 -0
- package/dist/operations/system.js +0 -0
- package/dist/operations/system.js.map +0 -0
- package/dist/operations/tasks.d.ts +0 -0
- package/dist/operations/tasks.d.ts.map +1 -1
- package/dist/operations/tasks.js +0 -0
- package/dist/operations/tasks.js.map +0 -0
- package/dist/operations/validate.d.ts +0 -0
- package/dist/operations/validate.d.ts.map +0 -0
- package/dist/operations/validate.js +0 -0
- package/dist/operations/validate.js.map +0 -0
- package/dist/provider-paths.d.ts +0 -0
- package/dist/provider-paths.d.ts.map +0 -0
- package/dist/provider-paths.js +0 -0
- package/dist/provider-paths.js.map +0 -0
- package/dist/results.d.ts +0 -0
- package/dist/results.d.ts.map +0 -0
- package/dist/results.js +0 -0
- package/dist/results.js.map +0 -0
- package/dist/session.d.ts +0 -0
- package/dist/session.d.ts.map +1 -1
- package/dist/session.js +0 -0
- package/dist/session.js.map +1 -1
- package/dist/spawn-types.d.ts +0 -0
- package/dist/spawn-types.d.ts.map +0 -0
- package/dist/spawn-types.js +0 -0
- package/dist/spawn-types.js.map +0 -0
- package/dist/spawn.d.ts +2 -0
- package/dist/spawn.d.ts.map +1 -1
- package/dist/spawn.js +0 -0
- package/dist/spawn.js.map +0 -0
- package/dist/status-registry.d.ts +0 -0
- package/dist/status-registry.d.ts.map +0 -0
- package/dist/status-registry.js +0 -0
- package/dist/status-registry.js.map +0 -0
- package/dist/task-record.d.ts +0 -0
- package/dist/task-record.d.ts.map +0 -0
- package/dist/task-record.js +0 -0
- package/dist/task-record.js.map +0 -0
- package/dist/task-sync.d.ts +0 -0
- package/dist/task-sync.d.ts.map +1 -1
- package/dist/task-sync.js +0 -0
- package/dist/task-sync.js.map +0 -0
- package/dist/task.d.ts +0 -0
- package/dist/task.d.ts.map +1 -1
- package/dist/task.js +0 -0
- package/dist/task.js.map +0 -0
- package/dist/tessera.d.ts +0 -0
- package/dist/tessera.d.ts.map +0 -0
- package/dist/tessera.js +0 -0
- package/dist/tessera.js.map +0 -0
- package/dist/todowrite.d.ts +0 -0
- package/dist/todowrite.d.ts.map +0 -0
- package/dist/todowrite.js +0 -0
- package/dist/todowrite.js.map +0 -0
- package/dist/transport.d.ts +0 -0
- package/dist/transport.d.ts.map +0 -0
- package/dist/transport.js +0 -0
- package/dist/transport.js.map +0 -0
- package/dist/warp-chain.d.ts +0 -0
- package/dist/warp-chain.d.ts.map +0 -0
- package/dist/warp-chain.js +0 -0
- package/dist/warp-chain.js.map +0 -0
- package/package.json +12 -7
- package/src/adapter.ts +0 -0
- package/src/archive.ts +0 -0
- package/src/brain.ts +0 -0
- package/src/capabilities.ts +0 -0
- package/src/config.ts +0 -0
- package/src/context-monitor.ts +0 -0
- package/src/data-accessor.ts +1 -7
- package/src/discovery.ts +0 -0
- package/src/errors.ts +204 -0
- package/src/exit-codes.ts +0 -0
- package/src/hooks.ts +0 -0
- package/src/index.ts +233 -242
- package/src/install.ts +0 -0
- package/src/lafs.ts +0 -0
- package/src/memory.ts +0 -0
- package/src/operations/index.ts +0 -0
- package/src/operations/issues.ts +0 -0
- package/src/operations/lifecycle.ts +1 -0
- package/src/operations/orchestrate.ts +0 -0
- package/src/operations/release.ts +0 -0
- package/src/operations/research.ts +0 -0
- package/src/operations/session.ts +0 -0
- package/src/operations/skills.ts +0 -0
- package/src/operations/system.ts +0 -0
- package/src/operations/tasks.ts +1 -0
- package/src/operations/validate.ts +0 -0
- package/src/provider-paths.ts +0 -0
- package/src/results.ts +0 -0
- package/src/session.ts +1 -0
- package/src/spawn-types.ts +0 -0
- package/src/spawn.ts +2 -0
- package/src/status-registry.ts +0 -0
- package/src/task-record.ts +0 -0
- package/src/task-sync.ts +11 -2
- package/src/task.ts +1 -0
- package/src/tessera.ts +0 -0
- package/src/todowrite.ts +0 -0
- package/src/transport.ts +0 -0
- package/src/warp-chain.ts +0 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 CLEO Contributors
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
ADDED
|
@@ -0,0 +1,491 @@
|
|
|
1
|
+
# @cleocode/contracts
|
|
2
|
+
|
|
3
|
+
Domain types, interfaces, and contracts for the CLEO ecosystem.
|
|
4
|
+
|
|
5
|
+
## Overview
|
|
6
|
+
|
|
7
|
+
This package contains all type definitions, interfaces, and contracts used throughout the CLEO monorepo. It is the **leaf package** in the dependency graph with **zero runtime dependencies**, serving as the foundation for type safety across all other packages.
|
|
8
|
+
|
|
9
|
+
All domain types (Task, Session, DataAccessor, etc.) are defined here. Implementation packages (`@cleocode/core`, `@cleocode/cleo`) import from here.
|
|
10
|
+
|
|
11
|
+
## Installation
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
npm install @cleocode/contracts
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
pnpm add @cleocode/contracts
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
```bash
|
|
22
|
+
yarn add @cleocode/contracts
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## API Overview
|
|
26
|
+
|
|
27
|
+
### Core Types
|
|
28
|
+
|
|
29
|
+
#### Task Types
|
|
30
|
+
|
|
31
|
+
```typescript
|
|
32
|
+
import type {
|
|
33
|
+
Task,
|
|
34
|
+
TaskCreate,
|
|
35
|
+
TaskPriority,
|
|
36
|
+
TaskStatus,
|
|
37
|
+
TaskType,
|
|
38
|
+
TaskSize,
|
|
39
|
+
EpicLifecycle,
|
|
40
|
+
Phase,
|
|
41
|
+
PhaseStatus,
|
|
42
|
+
PhaseTransition,
|
|
43
|
+
VerificationGate,
|
|
44
|
+
TaskVerification,
|
|
45
|
+
TaskWorkState
|
|
46
|
+
} from '@cleocode/contracts';
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
#### Session Types
|
|
50
|
+
|
|
51
|
+
```typescript
|
|
52
|
+
import type {
|
|
53
|
+
Session,
|
|
54
|
+
SessionScope,
|
|
55
|
+
SessionStartResult,
|
|
56
|
+
SessionStats,
|
|
57
|
+
SessionTaskWork,
|
|
58
|
+
SessionView
|
|
59
|
+
} from '@cleocode/contracts';
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
#### Memory Types
|
|
63
|
+
|
|
64
|
+
```typescript
|
|
65
|
+
import type {
|
|
66
|
+
BrainEntryRef,
|
|
67
|
+
BrainEntrySummary,
|
|
68
|
+
ContradictionDetail,
|
|
69
|
+
SupersededEntry,
|
|
70
|
+
MemoryBridgeConfig,
|
|
71
|
+
MemoryBridgeContent,
|
|
72
|
+
BridgeDecision,
|
|
73
|
+
BridgeLearning,
|
|
74
|
+
BridgeObservation,
|
|
75
|
+
BridgePattern,
|
|
76
|
+
SessionSummary
|
|
77
|
+
} from '@cleocode/contracts';
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
#### Data Accessor Interface
|
|
81
|
+
|
|
82
|
+
```typescript
|
|
83
|
+
import type {
|
|
84
|
+
DataAccessor,
|
|
85
|
+
TransactionAccessor,
|
|
86
|
+
TaskQueryFilters,
|
|
87
|
+
QueryTasksResult,
|
|
88
|
+
TaskFieldUpdates,
|
|
89
|
+
ArchiveFields,
|
|
90
|
+
ArchiveFile
|
|
91
|
+
} from '@cleocode/contracts';
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
### Status Registry
|
|
95
|
+
|
|
96
|
+
Centralized status definitions with validation and display helpers:
|
|
97
|
+
|
|
98
|
+
```typescript
|
|
99
|
+
import {
|
|
100
|
+
TASK_STATUSES,
|
|
101
|
+
SESSION_STATUSES,
|
|
102
|
+
LIFECYCLE_STAGE_STATUSES,
|
|
103
|
+
LIFECYCLE_PIPELINE_STATUSES,
|
|
104
|
+
GATE_STATUSES,
|
|
105
|
+
ADR_STATUSES,
|
|
106
|
+
MANIFEST_STATUSES,
|
|
107
|
+
isValidStatus,
|
|
108
|
+
STATUS_REGISTRY,
|
|
109
|
+
TASK_STATUS_SYMBOLS_ASCII,
|
|
110
|
+
TASK_STATUS_SYMBOLS_UNICODE,
|
|
111
|
+
PIPELINE_STATUS_ICONS,
|
|
112
|
+
STAGE_STATUS_ICONS,
|
|
113
|
+
TERMINAL_TASK_STATUSES,
|
|
114
|
+
TERMINAL_STAGE_STATUSES,
|
|
115
|
+
TERMINAL_PIPELINE_STATUSES
|
|
116
|
+
} from '@cleocode/contracts';
|
|
117
|
+
|
|
118
|
+
// Validate a status
|
|
119
|
+
const isValid = isValidStatus('task', 'in_progress');
|
|
120
|
+
|
|
121
|
+
// Get status icon
|
|
122
|
+
const icon = TASK_STATUS_SYMBOLS_UNICODE['completed'];
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
### Exit Codes
|
|
126
|
+
|
|
127
|
+
Standardized exit codes for CLEO operations:
|
|
128
|
+
|
|
129
|
+
```typescript
|
|
130
|
+
import {
|
|
131
|
+
ExitCode,
|
|
132
|
+
getExitCodeName,
|
|
133
|
+
isSuccessCode,
|
|
134
|
+
isErrorCode,
|
|
135
|
+
isRecoverableCode,
|
|
136
|
+
isNoChangeCode
|
|
137
|
+
} from '@cleocode/contracts';
|
|
138
|
+
|
|
139
|
+
// Check exit code meaning
|
|
140
|
+
if (isSuccessCode(exitCode)) {
|
|
141
|
+
console.log('Operation succeeded');
|
|
142
|
+
}
|
|
143
|
+
```
|
|
144
|
+
|
|
145
|
+
### Configuration Types
|
|
146
|
+
|
|
147
|
+
```typescript
|
|
148
|
+
import type {
|
|
149
|
+
CleoConfig,
|
|
150
|
+
ConfigSource,
|
|
151
|
+
LogLevel,
|
|
152
|
+
LoggingConfig,
|
|
153
|
+
SessionConfig,
|
|
154
|
+
LifecycleConfig,
|
|
155
|
+
LifecycleEnforcementMode,
|
|
156
|
+
EnforcementProfile,
|
|
157
|
+
SharingConfig,
|
|
158
|
+
SharingMode,
|
|
159
|
+
SignalDockConfig,
|
|
160
|
+
SignalDockMode,
|
|
161
|
+
OutputConfig,
|
|
162
|
+
OutputFormat,
|
|
163
|
+
DateFormat,
|
|
164
|
+
BackupConfig,
|
|
165
|
+
HierarchyConfig,
|
|
166
|
+
ResolvedValue
|
|
167
|
+
} from '@cleocode/contracts';
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
### LAFS (Language-Agnostic Feedback Schema)
|
|
171
|
+
|
|
172
|
+
Standardized envelope format for API responses:
|
|
173
|
+
|
|
174
|
+
```typescript
|
|
175
|
+
import type {
|
|
176
|
+
LafsEnvelope,
|
|
177
|
+
LafsSuccess,
|
|
178
|
+
LafsError,
|
|
179
|
+
LafsErrorDetail,
|
|
180
|
+
LAFSPage,
|
|
181
|
+
LAFSPageOffset,
|
|
182
|
+
LAFSPageNone,
|
|
183
|
+
LAFSMeta,
|
|
184
|
+
MVILevel,
|
|
185
|
+
Warning,
|
|
186
|
+
LafsAlternative,
|
|
187
|
+
CleoResponse,
|
|
188
|
+
GatewayEnvelope,
|
|
189
|
+
GatewaySuccess,
|
|
190
|
+
GatewayError,
|
|
191
|
+
GatewayMeta,
|
|
192
|
+
ConformanceReport,
|
|
193
|
+
FlagInput,
|
|
194
|
+
LAFSError,
|
|
195
|
+
LAFSErrorCategory,
|
|
196
|
+
LAFSTransport
|
|
197
|
+
} from '@cleocode/contracts';
|
|
198
|
+
|
|
199
|
+
import {
|
|
200
|
+
isLafsSuccess,
|
|
201
|
+
isLafsError,
|
|
202
|
+
isGatewayEnvelope
|
|
203
|
+
} from '@cleocode/contracts';
|
|
204
|
+
```
|
|
205
|
+
|
|
206
|
+
### Provider Adapter Contracts
|
|
207
|
+
|
|
208
|
+
```typescript
|
|
209
|
+
import type {
|
|
210
|
+
CLEOProviderAdapter,
|
|
211
|
+
AdapterHealthStatus,
|
|
212
|
+
AdapterCapabilities,
|
|
213
|
+
AdapterContextMonitorProvider,
|
|
214
|
+
AdapterHookProvider,
|
|
215
|
+
AdapterInstallProvider,
|
|
216
|
+
InstallOptions,
|
|
217
|
+
InstallResult,
|
|
218
|
+
AdapterSpawnProvider,
|
|
219
|
+
SpawnContext,
|
|
220
|
+
SpawnResult,
|
|
221
|
+
AdapterTransportProvider,
|
|
222
|
+
AdapterPathProvider,
|
|
223
|
+
AdapterTaskSyncProvider,
|
|
224
|
+
ExternalTask,
|
|
225
|
+
ExternalTaskStatus,
|
|
226
|
+
ReconcileAction,
|
|
227
|
+
ReconcileActionType,
|
|
228
|
+
ReconcileOptions,
|
|
229
|
+
ReconcileResult,
|
|
230
|
+
SyncSessionState,
|
|
231
|
+
ConflictPolicy
|
|
232
|
+
} from '@cleocode/contracts';
|
|
233
|
+
```
|
|
234
|
+
|
|
235
|
+
### Task Sync Types
|
|
236
|
+
|
|
237
|
+
Provider-agnostic reconciliation types:
|
|
238
|
+
|
|
239
|
+
```typescript
|
|
240
|
+
import type {
|
|
241
|
+
ExternalTask,
|
|
242
|
+
ExternalTaskStatus,
|
|
243
|
+
ReconcileAction,
|
|
244
|
+
ReconcileActionType,
|
|
245
|
+
ReconcileOptions,
|
|
246
|
+
ReconcileResult,
|
|
247
|
+
SyncSessionState,
|
|
248
|
+
ConflictPolicy
|
|
249
|
+
} from '@cleocode/contracts';
|
|
250
|
+
```
|
|
251
|
+
|
|
252
|
+
### Archive Types
|
|
253
|
+
|
|
254
|
+
```typescript
|
|
255
|
+
import type {
|
|
256
|
+
ArchivedTask,
|
|
257
|
+
ArchiveMetadata,
|
|
258
|
+
ArchiveSummaryReport,
|
|
259
|
+
ArchiveTrendsReport,
|
|
260
|
+
ArchiveCycleTimesReport,
|
|
261
|
+
ArchiveStatsEnvelope,
|
|
262
|
+
ArchiveReportType,
|
|
263
|
+
ArchiveDailyTrend,
|
|
264
|
+
ArchiveMonthlyTrend,
|
|
265
|
+
ArchiveLabelEntry,
|
|
266
|
+
ArchivePhaseEntry,
|
|
267
|
+
ArchivePriorityEntry,
|
|
268
|
+
CycleTimeDistribution,
|
|
269
|
+
CycleTimePercentiles
|
|
270
|
+
} from '@cleocode/contracts';
|
|
271
|
+
```
|
|
272
|
+
|
|
273
|
+
### Results Types
|
|
274
|
+
|
|
275
|
+
Dashboard and statistics results:
|
|
276
|
+
|
|
277
|
+
```typescript
|
|
278
|
+
import type {
|
|
279
|
+
DashboardResult,
|
|
280
|
+
StatsResult,
|
|
281
|
+
StatsActivityMetrics,
|
|
282
|
+
StatsAllTime,
|
|
283
|
+
StatsCompletionMetrics,
|
|
284
|
+
StatsCurrentState,
|
|
285
|
+
StatsCycleTimes,
|
|
286
|
+
ContextResult,
|
|
287
|
+
LogQueryResult,
|
|
288
|
+
SequenceResult,
|
|
289
|
+
TaskDepsResult,
|
|
290
|
+
TaskAnalysisResult,
|
|
291
|
+
TaskRef,
|
|
292
|
+
TaskRefPriority,
|
|
293
|
+
TaskSummary,
|
|
294
|
+
LabelCount,
|
|
295
|
+
CompleteTaskUnblocked,
|
|
296
|
+
BottleneckTask,
|
|
297
|
+
LeveragedTask
|
|
298
|
+
} from '@cleocode/contracts';
|
|
299
|
+
```
|
|
300
|
+
|
|
301
|
+
### Task Record Types
|
|
302
|
+
|
|
303
|
+
String-widened types for dispatch and LAFS:
|
|
304
|
+
|
|
305
|
+
```typescript
|
|
306
|
+
import type {
|
|
307
|
+
TaskRecord,
|
|
308
|
+
MinimalTaskRecord,
|
|
309
|
+
TaskRecordRelation,
|
|
310
|
+
ValidationHistoryEntry
|
|
311
|
+
} from '@cleocode/contracts';
|
|
312
|
+
```
|
|
313
|
+
|
|
314
|
+
### Spawn Types
|
|
315
|
+
|
|
316
|
+
CLEO spawn system types:
|
|
317
|
+
|
|
318
|
+
```typescript
|
|
319
|
+
import type {
|
|
320
|
+
CLEOSpawnAdapter,
|
|
321
|
+
CLEOSpawnContext,
|
|
322
|
+
CLEOSpawnResult,
|
|
323
|
+
CAAMPSpawnOptions,
|
|
324
|
+
CAAMPSpawnResult,
|
|
325
|
+
Provider,
|
|
326
|
+
SpawnStatus,
|
|
327
|
+
TokenResolution
|
|
328
|
+
} from '@cleocode/contracts';
|
|
329
|
+
```
|
|
330
|
+
|
|
331
|
+
### Tessera Types
|
|
332
|
+
|
|
333
|
+
Template instantiation types:
|
|
334
|
+
|
|
335
|
+
```typescript
|
|
336
|
+
import type {
|
|
337
|
+
TesseraTemplate,
|
|
338
|
+
TesseraVariable,
|
|
339
|
+
TesseraInstantiationInput
|
|
340
|
+
} from '@cleocode/contracts';
|
|
341
|
+
```
|
|
342
|
+
|
|
343
|
+
### WarpChain Types
|
|
344
|
+
|
|
345
|
+
Protocol execution chain types:
|
|
346
|
+
|
|
347
|
+
```typescript
|
|
348
|
+
import type {
|
|
349
|
+
WarpChain,
|
|
350
|
+
WarpChainInstance,
|
|
351
|
+
WarpChainExecution,
|
|
352
|
+
WarpStage,
|
|
353
|
+
WarpLink,
|
|
354
|
+
GateContract,
|
|
355
|
+
GateName,
|
|
356
|
+
GateCheck,
|
|
357
|
+
GateResult,
|
|
358
|
+
ChainValidation,
|
|
359
|
+
ChainShape,
|
|
360
|
+
ProtocolType
|
|
361
|
+
} from '@cleocode/contracts';
|
|
362
|
+
```
|
|
363
|
+
|
|
364
|
+
### Operations Types (Namespace)
|
|
365
|
+
|
|
366
|
+
All operation types are namespaced under `ops` to avoid collisions:
|
|
367
|
+
|
|
368
|
+
```typescript
|
|
369
|
+
import { ops } from '@cleocode/contracts';
|
|
370
|
+
|
|
371
|
+
// Access operation types
|
|
372
|
+
const taskParams: ops.TaskQueryParams = { ... };
|
|
373
|
+
const createParams: ops.TaskCreateParams = { ... };
|
|
374
|
+
```
|
|
375
|
+
|
|
376
|
+
Available operation namespaces:
|
|
377
|
+
- `ops.TaskQueryParams`
|
|
378
|
+
- `ops.TaskCreateParams`
|
|
379
|
+
- `ops.TaskUpdateParams`
|
|
380
|
+
- `ops.TaskCompleteParams`
|
|
381
|
+
- `ops.SessionStartParams`
|
|
382
|
+
- `ops.SessionEndParams`
|
|
383
|
+
- `ops.MemoryObserveParams`
|
|
384
|
+
- `ops.MemorySearchParams`
|
|
385
|
+
- `ops.BrainQueryParams`
|
|
386
|
+
- `ops.ValidateParams`
|
|
387
|
+
- `ops.ReleaseParams`
|
|
388
|
+
- `ops.OrchestrateParams`
|
|
389
|
+
- `ops.ResearchParams`
|
|
390
|
+
- `ops.SkillsParams`
|
|
391
|
+
- `ops.SystemParams`
|
|
392
|
+
- `ops.IssuesParams`
|
|
393
|
+
- And more...
|
|
394
|
+
|
|
395
|
+
### Discovery Types
|
|
396
|
+
|
|
397
|
+
Provider manifest discovery:
|
|
398
|
+
|
|
399
|
+
```typescript
|
|
400
|
+
import type {
|
|
401
|
+
AdapterManifest,
|
|
402
|
+
DetectionPattern
|
|
403
|
+
} from '@cleocode/contracts';
|
|
404
|
+
```
|
|
405
|
+
|
|
406
|
+
### Context Monitor Types
|
|
407
|
+
|
|
408
|
+
```typescript
|
|
409
|
+
import type {
|
|
410
|
+
AdapterContextMonitorProvider
|
|
411
|
+
} from '@cleocode/contracts';
|
|
412
|
+
```
|
|
413
|
+
|
|
414
|
+
### Hooks Types
|
|
415
|
+
|
|
416
|
+
```typescript
|
|
417
|
+
import type {
|
|
418
|
+
AdapterHookProvider
|
|
419
|
+
} from '@cleocode/contracts';
|
|
420
|
+
```
|
|
421
|
+
|
|
422
|
+
## Usage Examples
|
|
423
|
+
|
|
424
|
+
### Creating a Task Type
|
|
425
|
+
|
|
426
|
+
```typescript
|
|
427
|
+
import type { TaskCreate, TaskPriority, TaskType } from '@cleocode/contracts';
|
|
428
|
+
|
|
429
|
+
const newTask: TaskCreate = {
|
|
430
|
+
title: 'Implement authentication',
|
|
431
|
+
description: 'Add JWT-based auth to the API',
|
|
432
|
+
priority: 'high' as TaskPriority,
|
|
433
|
+
type: 'feature' as TaskType,
|
|
434
|
+
size: 'medium',
|
|
435
|
+
labels: ['backend', 'security']
|
|
436
|
+
};
|
|
437
|
+
```
|
|
438
|
+
|
|
439
|
+
### Using the Data Accessor Interface
|
|
440
|
+
|
|
441
|
+
```typescript
|
|
442
|
+
import type { DataAccessor, TaskQueryFilters } from '@cleocode/contracts';
|
|
443
|
+
|
|
444
|
+
async function fetchHighPriorityTasks(accessor: DataAccessor) {
|
|
445
|
+
const filters: TaskQueryFilters = {
|
|
446
|
+
priority: ['high', 'urgent'],
|
|
447
|
+
status: ['pending', 'in_progress'],
|
|
448
|
+
limit: 10
|
|
449
|
+
};
|
|
450
|
+
|
|
451
|
+
return await accessor.queryTasks(filters);
|
|
452
|
+
}
|
|
453
|
+
```
|
|
454
|
+
|
|
455
|
+
### Working with LAFS Envelopes
|
|
456
|
+
|
|
457
|
+
```typescript
|
|
458
|
+
import { isLafsSuccess, isLafsError, type LafsEnvelope } from '@cleocode/contracts';
|
|
459
|
+
|
|
460
|
+
function handleResponse(response: LafsEnvelope<unknown>) {
|
|
461
|
+
if (isLafsSuccess(response)) {
|
|
462
|
+
console.log('Success:', response.data);
|
|
463
|
+
} else if (isLafsError(response)) {
|
|
464
|
+
console.error('Error:', response.error.message);
|
|
465
|
+
}
|
|
466
|
+
}
|
|
467
|
+
```
|
|
468
|
+
|
|
469
|
+
### Status Validation
|
|
470
|
+
|
|
471
|
+
```typescript
|
|
472
|
+
import { isValidStatus, TASK_STATUSES } from '@cleocode/contracts';
|
|
473
|
+
|
|
474
|
+
// Check if a status is valid
|
|
475
|
+
if (isValidStatus('task', 'in_progress')) {
|
|
476
|
+
console.log('Valid task status');
|
|
477
|
+
}
|
|
478
|
+
|
|
479
|
+
// Iterate over all valid statuses
|
|
480
|
+
for (const status of TASK_STATUSES) {
|
|
481
|
+
console.log(`Valid status: ${status}`);
|
|
482
|
+
}
|
|
483
|
+
```
|
|
484
|
+
|
|
485
|
+
## Dependencies
|
|
486
|
+
|
|
487
|
+
This package has **no runtime dependencies**. It contains only TypeScript type definitions and interfaces.
|
|
488
|
+
|
|
489
|
+
## License
|
|
490
|
+
|
|
491
|
+
MIT License - see [LICENSE](../LICENSE) for details.
|
package/dist/adapter.d.ts
CHANGED
|
File without changes
|
package/dist/adapter.d.ts.map
CHANGED
|
File without changes
|
package/dist/adapter.js
CHANGED
|
File without changes
|
package/dist/adapter.js.map
CHANGED
|
File without changes
|
package/dist/archive.d.ts
CHANGED
|
File without changes
|
package/dist/archive.d.ts.map
CHANGED
|
File without changes
|
package/dist/archive.js
CHANGED
|
File without changes
|
package/dist/archive.js.map
CHANGED
|
File without changes
|
package/dist/brain.d.ts
CHANGED
|
File without changes
|
package/dist/brain.d.ts.map
CHANGED
|
File without changes
|
package/dist/brain.js
CHANGED
|
File without changes
|
package/dist/brain.js.map
CHANGED
|
File without changes
|
package/dist/capabilities.d.ts
CHANGED
|
File without changes
|
|
File without changes
|
package/dist/capabilities.js
CHANGED
|
File without changes
|
package/dist/capabilities.js.map
CHANGED
|
File without changes
|
package/dist/config.d.ts
CHANGED
|
File without changes
|
package/dist/config.d.ts.map
CHANGED
|
File without changes
|
package/dist/config.js
CHANGED
|
File without changes
|
package/dist/config.js.map
CHANGED
|
File without changes
|
|
File without changes
|
|
File without changes
|
package/dist/context-monitor.js
CHANGED
|
File without changes
|
|
File without changes
|
package/dist/data-accessor.d.ts
CHANGED
|
File without changes
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"data-accessor.d.ts","sourceRoot":"","sources":["../src/data-accessor.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AACjD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAC5C,OAAO,KAAK,
|
|
1
|
+
{"version":3,"file":"data-accessor.d.ts","sourceRoot":"","sources":["../src/data-accessor.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AACjD,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAC5C,OAAO,KAAK,EAAE,IAAI,EAAE,YAAY,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AAEpF,+CAA+C;AAC/C,MAAM,WAAW,aAAa;IAC5B,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B;AAED,8BAA8B;AAC9B,MAAM,WAAW,WAAW;IAC1B,aAAa,EAAE,YAAY,EAAE,CAAC;IAC9B,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAMD,uEAAuE;AACvE,MAAM,WAAW,gBAAgB;IAC/B,MAAM,CAAC,EAAE,UAAU,GAAG,UAAU,EAAE,CAAC;IACnC,QAAQ,CAAC,EAAE,YAAY,CAAC;IACxB,IAAI,CAAC,EAAE,QAAQ,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,aAAa,CAAC,EAAE,UAAU,GAAG,UAAU,EAAE,CAAC;IAC1C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,UAAU,GAAG,WAAW,GAAG,WAAW,GAAG,UAAU,CAAC;CAC/D;AAED,wDAAwD;AACxD,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,IAAI,EAAE,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;CACf;AAED,sDAAsD;AACtD,MAAM,WAAW,gBAAgB;IAC/B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,MAAM,CAAC,EAAE,UAAU,CAAC;IACpB,QAAQ,CAAC,EAAE,YAAY,CAAC;IACxB,IAAI,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAC;IACvB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,IAAI,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAC;IACvB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACvB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9B,cAAc,CAAC,EAAE,OAAO,GAAG,IAAI,CAAC;IAChC,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5B,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACnC,gBAAgB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACjC,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IAClC,gBAAgB,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5C,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACxE,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAChD,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACzD,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC1E,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAC1D;AAED;;;;;;GAMG;AACH,MAAM,WAAW,YAAY;IAC3B,gDAAgD;IAChD,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC;IAI1B,oEAAoE;IACpE,WAAW,IAAI,OAAO,CAAC,WAAW,GAAG,IAAI,CAAC,CAAC;IAE3C,qEAAqE;IACrE,WAAW,CAAC,IAAI,EAAE,WAAW,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAI9C,2EAA2E;IAC3E,YAAY,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC,CAAC;IAEnC,iDAAiD;IACjD,YAAY,CAAC,QAAQ,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAIjD,wCAAwC;IACxC,SAAS,CAAC,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAIzD,0DAA0D;IAC1D,KAAK,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAIvB,kEAAkE;IAClE,gBAAgB,CAAC,IAAI,EAAE,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5C,+EAA+E;IAC/E,iBAAiB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAExE,6DAA6D;IAC7D,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEhD,+FAA+F;IAC/F,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC,CAAC;IAErD,0DAA0D;IAC1D,WAAW,CACT,MAAM,EAAE,MAAM,EACd,SAAS,EAAE,MAAM,EACjB,YAAY,EAAE,MAAM,EACpB,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,IAAI,CAAC,CAAC;IAIjB,6EAA6E;IAC7E,YAAY,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC;IAEhD,iDAAiD;IACjD,YAAY,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzD,6FAA6F;IAC7F,gBAAgB,IAAI,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,CAAC;IAI3C,gGAAgG;IAChG,UAAU,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;IAEjE,2EAA2E;IAC3E,UAAU,CAAC,OAAO,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,UAAU,GAAG,UAAU,EAAE,CAAC;QAAC,QAAQ,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAEjG,4CAA4C;IAC5C,WAAW,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;IAE/C,6EAA6E;IAC7E,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAEjD,6DAA6D;IAC7D,mBAAmB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAEvD,uFAAuF;IACvF,gBAAgB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;IAElD,+EAA+E;IAC/E,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;IAE5C,oFAAoF;IACpF,aAAa,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;IAE/C,gFAAgF;IAChF,kBAAkB,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,CAAC;IAEtD,8DAA8D;IAC9D,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC;IAE7C,yDAAyD;IACzD,SAAS,CAAC,OAAO,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;IAI9C,qEAAqE;IACrE,gBAAgB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,gBAAgB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE1E,2FAA2F;IAC3F,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC,CAAC;IAE1D,8EAA8E;IAC9E,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,EAAE,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5F,4FAA4F;IAC5F,WAAW,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,EAAE,mBAAmB,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IAIxE,uEAAuE;IACvE,gBAAgB,IAAI,OAAO,CAAC,OAAO,GAAG,IAAI,CAAC,CAAC;IAE5C,gDAAgD;IAChD,mBAAmB,CAAC,OAAO,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAErD,qCAAqC;IACrC,mBAAmB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACvD"}
|
package/dist/data-accessor.js
CHANGED
|
File without changes
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"data-accessor.js","sourceRoot":"","sources":["../src/data-accessor.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;;
|
|
1
|
+
{"version":3,"file":"data-accessor.js","sourceRoot":"","sources":["../src/data-accessor.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;GAaG;;AA0NH,8EAA8E;AAC9E,qCAAqC"}
|
package/dist/discovery.d.ts
CHANGED
|
File without changes
|
package/dist/discovery.d.ts.map
CHANGED
|
File without changes
|
package/dist/discovery.js
CHANGED
|
File without changes
|
package/dist/discovery.js.map
CHANGED
|
File without changes
|