@you-agent-factory/client 0.0.2 → 0.0.7
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/dist/contracts.d.ts +1 -0
- package/dist/generated/factory-event.schema.json +235 -62
- package/dist/generated/factory.schema.json +171 -62
- package/dist/generated/openapi.d.ts +409 -41
- package/dist/generated/openapi.js +41 -14
- package/dist/index.d.ts +1 -1
- package/package.json +1 -2
|
@@ -114,7 +114,7 @@
|
|
|
114
114
|
"modelProvider": {
|
|
115
115
|
"allOf": [
|
|
116
116
|
{
|
|
117
|
-
"$ref": "#/$defs/
|
|
117
|
+
"$ref": "#/$defs/ProviderIdentity"
|
|
118
118
|
}
|
|
119
119
|
],
|
|
120
120
|
"description": "Provider whose inference-throttle history controls this factory-level guard."
|
|
@@ -146,32 +146,53 @@
|
|
|
146
146
|
],
|
|
147
147
|
"type": "string"
|
|
148
148
|
},
|
|
149
|
+
"FactoryInvocationArguments": {
|
|
150
|
+
"additionalProperties": {
|
|
151
|
+
"oneOf": [
|
|
152
|
+
{
|
|
153
|
+
"type": "string"
|
|
154
|
+
},
|
|
155
|
+
{
|
|
156
|
+
"items": {
|
|
157
|
+
"type": "string"
|
|
158
|
+
},
|
|
159
|
+
"type": "array"
|
|
160
|
+
}
|
|
161
|
+
]
|
|
162
|
+
},
|
|
163
|
+
"description": "Structured Factory invocation arguments keyed by parameter name, external name, or alias. Each value is either one string or an ordered array of strings.",
|
|
164
|
+
"type": "object"
|
|
165
|
+
},
|
|
149
166
|
"FactoryInvocationExample": {
|
|
150
167
|
"additionalProperties": false,
|
|
151
168
|
"description": "One example invocation for docs, help, and packaged-factory inspection.",
|
|
152
169
|
"properties": {
|
|
153
|
-
"
|
|
154
|
-
"
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
170
|
+
"args": {
|
|
171
|
+
"allOf": [
|
|
172
|
+
{
|
|
173
|
+
"$ref": "#/$defs/FactoryInvocationArguments"
|
|
174
|
+
}
|
|
175
|
+
],
|
|
176
|
+
"description": "Structured invocation arguments; values are never parsed or executed while loading the Factory."
|
|
159
177
|
},
|
|
160
178
|
"description": {
|
|
161
|
-
"
|
|
162
|
-
|
|
179
|
+
"allOf": [
|
|
180
|
+
{
|
|
181
|
+
"$ref": "#/$defs/NameValue"
|
|
182
|
+
}
|
|
183
|
+
],
|
|
184
|
+
"description": "Localized customer-facing explanation of what the example does."
|
|
163
185
|
},
|
|
164
186
|
"name": {
|
|
165
187
|
"description": "Stable example name.",
|
|
166
|
-
"
|
|
167
|
-
},
|
|
168
|
-
"stdin": {
|
|
169
|
-
"description": "Example stdin payload when the signature routes stdin into one parameter.",
|
|
188
|
+
"minLength": 1,
|
|
170
189
|
"type": "string"
|
|
171
190
|
}
|
|
172
191
|
},
|
|
173
192
|
"required": [
|
|
174
|
-
"name"
|
|
193
|
+
"name",
|
|
194
|
+
"description",
|
|
195
|
+
"args"
|
|
175
196
|
],
|
|
176
197
|
"type": "object"
|
|
177
198
|
},
|
|
@@ -352,13 +373,6 @@
|
|
|
352
373
|
"additionalProperties": false,
|
|
353
374
|
"description": "Canonical callable argument contract for invoking one factory. When present, CLI, API, dashboard, docs, and packaged-factory surfaces should discover and normalize invocation inputs from this shared schema instead of transport- or factory-specific argument definitions.",
|
|
354
375
|
"properties": {
|
|
355
|
-
"examples": {
|
|
356
|
-
"description": "Example invocations rendered in docs, help, and inspection surfaces.",
|
|
357
|
-
"items": {
|
|
358
|
-
"$ref": "#/$defs/FactoryInvocationExample"
|
|
359
|
-
},
|
|
360
|
-
"type": "array"
|
|
361
|
-
},
|
|
362
376
|
"outputContract": {
|
|
363
377
|
"allOf": [
|
|
364
378
|
{
|
|
@@ -1394,6 +1408,61 @@
|
|
|
1394
1408
|
],
|
|
1395
1409
|
"type": "object"
|
|
1396
1410
|
},
|
|
1411
|
+
"NameValue": {
|
|
1412
|
+
"additionalProperties": false,
|
|
1413
|
+
"description": "A customer-facing value with a required base fallback and optional exact locale overrides. Locale tags must use their canonical BCP 47 spelling.",
|
|
1414
|
+
"properties": {
|
|
1415
|
+
"id": {
|
|
1416
|
+
"description": "Optional stable metadata identifier; consumers must not render it as display copy.",
|
|
1417
|
+
"type": "string"
|
|
1418
|
+
},
|
|
1419
|
+
"locales": {
|
|
1420
|
+
"description": "Canonical BCP 47 locales for which the base value was authored.",
|
|
1421
|
+
"items": {
|
|
1422
|
+
"minLength": 2,
|
|
1423
|
+
"type": "string"
|
|
1424
|
+
},
|
|
1425
|
+
"type": "array",
|
|
1426
|
+
"uniqueItems": true
|
|
1427
|
+
},
|
|
1428
|
+
"type": {
|
|
1429
|
+
"description": "Discriminator for localized customer-facing metadata.",
|
|
1430
|
+
"enum": [
|
|
1431
|
+
"LOCALIZABLE_ASSET"
|
|
1432
|
+
],
|
|
1433
|
+
"type": "string"
|
|
1434
|
+
},
|
|
1435
|
+
"value": {
|
|
1436
|
+
"description": "Required base value returned when no exact locale override exists.",
|
|
1437
|
+
"minLength": 1,
|
|
1438
|
+
"type": "string"
|
|
1439
|
+
},
|
|
1440
|
+
"values": {
|
|
1441
|
+
"additionalProperties": {
|
|
1442
|
+
"type": "string"
|
|
1443
|
+
},
|
|
1444
|
+
"description": "Exact canonical BCP 47 locale tags mapped to localized overrides.",
|
|
1445
|
+
"type": "object"
|
|
1446
|
+
}
|
|
1447
|
+
},
|
|
1448
|
+
"required": [
|
|
1449
|
+
"type",
|
|
1450
|
+
"value"
|
|
1451
|
+
],
|
|
1452
|
+
"type": "object"
|
|
1453
|
+
},
|
|
1454
|
+
"ProviderIdentity": {
|
|
1455
|
+
"description": "Open provider identity used by authored modelProvider fields. Extension identities use lowercase letters and digits separated by dots or hyphens. Built-in identities and documented legacy aliases remain accepted compatibility spellings. For example, `customer.provider` is a valid extension identity.",
|
|
1456
|
+
"maxLength": 128,
|
|
1457
|
+
"minLength": 1,
|
|
1458
|
+
"pattern": "^(?:[a-z][a-z0-9]*(?:[.-][a-z0-9]+)*|ANTIGRAVITY|ANTHROPIC|CLAUDE|CODEX|OPENAI)$",
|
|
1459
|
+
"type": "string"
|
|
1460
|
+
},
|
|
1461
|
+
"ReasoningEffort": {
|
|
1462
|
+
"description": "Optional provider-neutral reasoning effort. Surrounding whitespace and letter case are normalized. Omit the field to preserve the selected provider and model default. Factory definitions may use an exact invocation-parameter placeholder such as `${executorReasoningEffort}`.",
|
|
1463
|
+
"pattern": "^(?:[\t-\r
- \u2028\u2029 ]*(?:[mM][iI][nN][iI][mM][aA][lL]|[lL][oO][wW]|[mM][eE][dD][iI][uU][mM]|[hH][iI][gG][hH]|[xX][hH][iI][gG][hH]|[mM][aA][xX])?[\t-\r
- \u2028\u2029 ]*|\\$\\{[A-Za-z0-9_.-]+\\})$",
|
|
1464
|
+
"type": "string"
|
|
1465
|
+
},
|
|
1397
1466
|
"RequiredTool": {
|
|
1398
1467
|
"additionalProperties": false,
|
|
1399
1468
|
"description": "One declarative external tool dependency for a portable factory.",
|
|
@@ -1523,11 +1592,8 @@
|
|
|
1523
1592
|
"description": "Stable built-in runner identifiers supported by factory and workstation runner selection.",
|
|
1524
1593
|
"enum": [
|
|
1525
1594
|
"codex",
|
|
1526
|
-
"
|
|
1527
|
-
"
|
|
1528
|
-
"cursor-cli",
|
|
1529
|
-
"opencode",
|
|
1530
|
-
"pi"
|
|
1595
|
+
"claude",
|
|
1596
|
+
"antigravity"
|
|
1531
1597
|
],
|
|
1532
1598
|
"type": "string"
|
|
1533
1599
|
},
|
|
@@ -1848,6 +1914,14 @@
|
|
|
1848
1914
|
"additionalProperties": false,
|
|
1849
1915
|
"description": "A named category of work that can move through the factory. Each work type declares the lifecycle states its work items can occupy.",
|
|
1850
1916
|
"properties": {
|
|
1917
|
+
"description": {
|
|
1918
|
+
"allOf": [
|
|
1919
|
+
{
|
|
1920
|
+
"$ref": "#/$defs/NameValue"
|
|
1921
|
+
}
|
|
1922
|
+
],
|
|
1923
|
+
"description": "Optional localized customer-facing explanation of this work type."
|
|
1924
|
+
},
|
|
1851
1925
|
"handlingBehavior": {
|
|
1852
1926
|
"description": "Optional CLI routing markers for this work type. Factories used with you run --factory must declare handlingBehavior DEFAULT on exactly one work type.",
|
|
1853
1927
|
"items": {
|
|
@@ -1919,13 +1993,21 @@
|
|
|
1919
1993
|
"description": "Command to execute when this worker runs through a command or script provider.",
|
|
1920
1994
|
"type": "string"
|
|
1921
1995
|
},
|
|
1996
|
+
"description": {
|
|
1997
|
+
"allOf": [
|
|
1998
|
+
{
|
|
1999
|
+
"$ref": "#/$defs/NameValue"
|
|
2000
|
+
}
|
|
2001
|
+
],
|
|
2002
|
+
"description": "Optional localized customer-facing explanation of this worker."
|
|
2003
|
+
},
|
|
1922
2004
|
"executorProvider": {
|
|
1923
2005
|
"allOf": [
|
|
1924
2006
|
{
|
|
1925
2007
|
"$ref": "#/$defs/WorkerProvider"
|
|
1926
2008
|
}
|
|
1927
2009
|
],
|
|
1928
|
-
"description": "
|
|
2010
|
+
"description": "Execution mechanism. Use `ACP` for ACP-backed workers and put the configured integration identity (for example `cursor-acp`) in modelProvider. `SCRIPT_WRAP` remains the command-wrapper compatibility value; legacy named executor identities remain accepted during migration."
|
|
1929
2011
|
},
|
|
1930
2012
|
"id": {
|
|
1931
2013
|
"description": "Optional durable public identifier for this worker. When present, graph and layout references should use this id instead of the mutable name.",
|
|
@@ -1952,21 +2034,21 @@
|
|
|
1952
2034
|
"description": "Provider locality for this model capability declaration. Use `LOCAL` for embedded or host-managed inference and `CLOUD` for remote provider execution."
|
|
1953
2035
|
},
|
|
1954
2036
|
"modelProvider": {
|
|
1955
|
-
"
|
|
2037
|
+
"description": "Canonical provider identity used for model routing and provider diagnostics, or an exact invocation-parameter placeholder such as `${modelProvider}`. For `executorProvider: ACP`, this names the configured ACP integration, such as `cursor-acp`. Extension identities use lowercase standardized syntax; built-in values such as `CLAUDE` and `CODEX` remain compatibility conveniences.",
|
|
2038
|
+
"oneOf": [
|
|
1956
2039
|
{
|
|
1957
|
-
"$ref": "#/$defs/
|
|
2040
|
+
"$ref": "#/$defs/ProviderIdentity"
|
|
2041
|
+
},
|
|
2042
|
+
{
|
|
2043
|
+
"pattern": "^\\$\\{[A-Za-z0-9_.-]+\\}$",
|
|
2044
|
+
"type": "string"
|
|
1958
2045
|
}
|
|
1959
|
-
]
|
|
1960
|
-
"description": "Canonical model-provider identifier used for model routing and provider diagnostics. Current public built-in values are `CLAUDE` and `CODEX`; the runtime maps them onto the underlying provider command IDs."
|
|
2046
|
+
]
|
|
1961
2047
|
},
|
|
1962
2048
|
"name": {
|
|
1963
2049
|
"description": "Worker name referenced by Workstation.worker.",
|
|
1964
2050
|
"type": "string"
|
|
1965
2051
|
},
|
|
1966
|
-
"openCodeAgent": {
|
|
1967
|
-
"description": "Optional OpenCode agent profile name for model workers that dispatch through the OpenCode runner. When set, OpenCode dispatches invoke `opencode run --agent \u003cname\u003e`. Discover agent names with `opencode agent list` (see https://opencode.ai/docs/cli/).",
|
|
1968
|
-
"type": "string"
|
|
1969
|
-
},
|
|
1970
2052
|
"operations": {
|
|
1971
2053
|
"description": "Provider-agnostic model operations that this worker can execute, including named input and output slots.",
|
|
1972
2054
|
"items": {
|
|
@@ -1982,6 +2064,9 @@
|
|
|
1982
2064
|
],
|
|
1983
2065
|
"description": "Built-in hosted provider identity when this worker uses repository-owned hosted execution."
|
|
1984
2066
|
},
|
|
2067
|
+
"reasoningEffort": {
|
|
2068
|
+
"$ref": "#/$defs/ReasoningEffort"
|
|
2069
|
+
},
|
|
1985
2070
|
"resources": {
|
|
1986
2071
|
"description": "Resource capacity this worker requires before it can be dispatched.",
|
|
1987
2072
|
"items": {
|
|
@@ -2023,25 +2108,11 @@
|
|
|
2023
2108
|
],
|
|
2024
2109
|
"type": "string"
|
|
2025
2110
|
},
|
|
2026
|
-
"WorkerModelProvider": {
|
|
2027
|
-
"description": "Canonical model-provider identifiers supported by model workers in factory config.",
|
|
2028
|
-
"enum": [
|
|
2029
|
-
"CLAUDE",
|
|
2030
|
-
"CODEX",
|
|
2031
|
-
"CURSOR",
|
|
2032
|
-
"GEMINI",
|
|
2033
|
-
"KIRO",
|
|
2034
|
-
"OPENCODE",
|
|
2035
|
-
"PI",
|
|
2036
|
-
"AGY"
|
|
2037
|
-
],
|
|
2038
|
-
"type": "string"
|
|
2039
|
-
},
|
|
2040
2111
|
"WorkerProvider": {
|
|
2041
|
-
"description": "
|
|
2042
|
-
"
|
|
2043
|
-
|
|
2044
|
-
],
|
|
2112
|
+
"description": "Worker execution mechanism. Canonical values are ACP and SCRIPT_WRAP; extensible lowercase identities remain accepted for compatibility with existing factories.",
|
|
2113
|
+
"maxLength": 128,
|
|
2114
|
+
"minLength": 1,
|
|
2115
|
+
"pattern": "^(?:ACP|SCRIPT_WRAP|\\$\\{[A-Za-z0-9_.-]+\\}|[a-z][a-z0-9]*(?:[.-][a-z0-9]+)*)$",
|
|
2045
2116
|
"type": "string"
|
|
2046
2117
|
},
|
|
2047
2118
|
"WorkerType": {
|
|
@@ -2091,6 +2162,14 @@
|
|
|
2091
2162
|
],
|
|
2092
2163
|
"description": "Cron trigger configuration for workstations whose behavior is CRON."
|
|
2093
2164
|
},
|
|
2165
|
+
"description": {
|
|
2166
|
+
"allOf": [
|
|
2167
|
+
{
|
|
2168
|
+
"$ref": "#/$defs/NameValue"
|
|
2169
|
+
}
|
|
2170
|
+
],
|
|
2171
|
+
"description": "Optional localized customer-facing explanation of this workstation."
|
|
2172
|
+
},
|
|
2094
2173
|
"env": {
|
|
2095
2174
|
"allOf": [
|
|
2096
2175
|
{
|
|
@@ -2150,10 +2229,6 @@
|
|
|
2150
2229
|
},
|
|
2151
2230
|
"type": "array"
|
|
2152
2231
|
},
|
|
2153
|
-
"openCodeAgent": {
|
|
2154
|
-
"description": "Optional OpenCode agent profile override for this workstation. When set, overrides the worker default for OpenCode dispatches and invokes `opencode run --agent \u003cname\u003e`. Discover agent names with `opencode agent list` (see https://opencode.ai/docs/cli/).",
|
|
2155
|
-
"type": "string"
|
|
2156
|
-
},
|
|
2157
2232
|
"operation": {
|
|
2158
2233
|
"allOf": [
|
|
2159
2234
|
{
|
|
@@ -2252,8 +2327,12 @@
|
|
|
2252
2327
|
},
|
|
2253
2328
|
"WorkstationCron": {
|
|
2254
2329
|
"additionalProperties": false,
|
|
2255
|
-
"description": "Trigger timing for
|
|
2330
|
+
"description": "Trigger timing for scheduled workstations. Provide exactly one of a five-field cron schedule or a positive duration in every; Factory validation enforces the exclusive choice.",
|
|
2256
2331
|
"properties": {
|
|
2332
|
+
"every": {
|
|
2333
|
+
"description": "Positive Go duration interval, such as 30s, 5m, 1h, or 1h30m, used instead of schedule.",
|
|
2334
|
+
"type": "string"
|
|
2335
|
+
},
|
|
2257
2336
|
"expiryWindow": {
|
|
2258
2337
|
"description": "Positive Go duration after due_at before a stale cron time token expires and can be consumed by the system expiry transition. Defaults to the duration until the next scheduled cron fire when omitted.",
|
|
2259
2338
|
"type": "string"
|
|
@@ -2272,9 +2351,6 @@
|
|
|
2272
2351
|
"type": "boolean"
|
|
2273
2352
|
}
|
|
2274
2353
|
},
|
|
2275
|
-
"required": [
|
|
2276
|
-
"schedule"
|
|
2277
|
-
],
|
|
2278
2354
|
"type": "object"
|
|
2279
2355
|
},
|
|
2280
2356
|
"WorkstationGuard": {
|
|
@@ -2294,10 +2370,14 @@
|
|
|
2294
2370
|
"type": "string"
|
|
2295
2371
|
},
|
|
2296
2372
|
"maxVisits": {
|
|
2297
|
-
"description": "For `VISIT_COUNT` guards, the visit
|
|
2373
|
+
"description": "For `VISIT_COUNT` guards, the fixed visit ceiling.",
|
|
2298
2374
|
"minimum": 1,
|
|
2299
2375
|
"type": "integer"
|
|
2300
2376
|
},
|
|
2377
|
+
"maxVisitsArgument": {
|
|
2378
|
+
"description": "Optional invocation argument whose positive integer value tightens the fixed visit ceiling.",
|
|
2379
|
+
"type": "string"
|
|
2380
|
+
},
|
|
2301
2381
|
"parentInput": {
|
|
2302
2382
|
"description": "For parent-aware input guards, the parent workType name from another input in the same workstation.",
|
|
2303
2383
|
"type": "string"
|
|
@@ -2377,6 +2457,20 @@
|
|
|
2377
2457
|
"description": "Go duration limit for one dispatch attempt before it times out.",
|
|
2378
2458
|
"type": "string"
|
|
2379
2459
|
},
|
|
2460
|
+
"maxGeneratedWorkItems": {
|
|
2461
|
+
"description": "Fixed maximum number of Work items one accepted worker-emitted FACTORY_REQUEST_BATCH may contain.",
|
|
2462
|
+
"minimum": 1,
|
|
2463
|
+
"type": "integer"
|
|
2464
|
+
},
|
|
2465
|
+
"maxGeneratedWorkItemsArgument": {
|
|
2466
|
+
"description": "Optional invocation argument whose positive integer value tightens the fixed generated-Work ceiling.",
|
|
2467
|
+
"type": "string"
|
|
2468
|
+
},
|
|
2469
|
+
"maxGeneratedWorkItemsArgumentOffset": {
|
|
2470
|
+
"description": "Offset added to the invocation argument before applying the generated-Work ceiling.",
|
|
2471
|
+
"minimum": 0,
|
|
2472
|
+
"type": "integer"
|
|
2473
|
+
},
|
|
2380
2474
|
"maxRetries": {
|
|
2381
2475
|
"description": "Maximum number of retry attempts after a failed dispatch before the workstation gives up.",
|
|
2382
2476
|
"type": "integer"
|
|
@@ -2476,6 +2570,21 @@
|
|
|
2476
2570
|
"additionalProperties": false,
|
|
2477
2571
|
"description": "Top-level factory.json contract. Declare the work types, resources, portability resources, workers, and workstations that make up one authored factory here. Guarded loop breakers should be authored as guarded LOGICAL_MOVE workstations using VISIT_COUNT guards instead of a top-level exhaustion-rules field.",
|
|
2478
2572
|
"properties": {
|
|
2573
|
+
"description": {
|
|
2574
|
+
"allOf": [
|
|
2575
|
+
{
|
|
2576
|
+
"$ref": "#/$defs/NameValue"
|
|
2577
|
+
}
|
|
2578
|
+
],
|
|
2579
|
+
"description": "Optional localized customer-facing explanation of this Factory."
|
|
2580
|
+
},
|
|
2581
|
+
"examples": {
|
|
2582
|
+
"description": "Ordered runnable invocation examples. Canonical Factory documents write examples here; legacy invocationSignature.examples are accepted only by the Factory input compatibility mapper.",
|
|
2583
|
+
"items": {
|
|
2584
|
+
"$ref": "#/$defs/FactoryInvocationExample"
|
|
2585
|
+
},
|
|
2586
|
+
"type": "array"
|
|
2587
|
+
},
|
|
2479
2588
|
"factoryDirectory": {
|
|
2480
2589
|
"description": "Directory that contained the factory.json used for this serialized runtime config.",
|
|
2481
2590
|
"type": "string"
|