@oxy.so/contracts 4.11.0 → 4.13.0

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.
Files changed (40) hide show
  1. package/dist/cjs/.tsbuildinfo +1 -1
  2. package/dist/cjs/accountGraph.js +15 -0
  3. package/dist/cjs/avatarCharacter.js +120 -0
  4. package/dist/cjs/index.js +24 -14
  5. package/dist/cjs/inference/identifiers.js +14 -1
  6. package/dist/cjs/inference/routingPolicy.js +17 -0
  7. package/dist/cjs/inference/usage.js +8 -0
  8. package/dist/cjs/inference/version.js +1 -1
  9. package/dist/cjs/recommendations.js +3 -0
  10. package/dist/cjs/userResponse.js +7 -0
  11. package/dist/esm/.tsbuildinfo +1 -1
  12. package/dist/esm/accountGraph.js +15 -0
  13. package/dist/esm/avatarCharacter.js +115 -0
  14. package/dist/esm/index.js +4 -1
  15. package/dist/esm/inference/identifiers.js +13 -0
  16. package/dist/esm/inference/routingPolicy.js +18 -1
  17. package/dist/esm/inference/usage.js +9 -1
  18. package/dist/esm/inference/version.js +1 -1
  19. package/dist/esm/recommendations.js +3 -0
  20. package/dist/esm/userResponse.js +7 -0
  21. package/dist/types/.tsbuildinfo +1 -1
  22. package/dist/types/accountGraph.d.ts +15 -4
  23. package/dist/types/accountSubject.d.ts +4 -4
  24. package/dist/types/agency.d.ts +44 -44
  25. package/dist/types/avatarCharacter.d.ts +57 -0
  26. package/dist/types/deviceDirectory.d.ts +66 -66
  27. package/dist/types/email/messages.d.ts +22 -22
  28. package/dist/types/externalIdentity.d.ts +11 -4
  29. package/dist/types/index.d.ts +4 -2
  30. package/dist/types/inference/accountBilling.d.ts +2 -2
  31. package/dist/types/inference/decisions.d.ts +20 -0
  32. package/dist/types/inference/identifiers.d.ts +14 -0
  33. package/dist/types/inference/realtime.d.ts +18 -0
  34. package/dist/types/inference/request.d.ts +54 -0
  35. package/dist/types/inference/routingPolicy.d.ts +10 -0
  36. package/dist/types/inference/usage.d.ts +12 -0
  37. package/dist/types/inference/version.d.ts +1 -1
  38. package/dist/types/recommendations.d.ts +12 -0
  39. package/dist/types/userResponse.d.ts +100 -2
  40. package/package.json +1 -1
@@ -329,9 +329,17 @@ export declare const createAccountRequestSchema: z.ZodEffects<z.ZodObject<{
329
329
  * remedy must not either.
330
330
  */
331
331
  isPrivateAccount: z.ZodOptional<z.ZodBoolean>;
332
+ /**
333
+ * The 3D avatar character of a `bot` — and ONLY of a bot (the refinement
334
+ * below). Optional on the wire: a bot created without one is given a look
335
+ * seeded from its handle (`avatarCharacterFor`), so every bot account has a
336
+ * character from birth and the owner customizes it afterwards.
337
+ */
338
+ character: z.ZodOptional<z.ZodType<import("./avatarCharacter").AvatarCharacter, z.ZodTypeDef, unknown>>;
332
339
  }, "strip", z.ZodTypeAny, {
333
340
  kind: "bot" | "organization" | "project" | "channel";
334
341
  username: string;
342
+ color?: string | undefined;
335
343
  parentAccountId?: string | undefined;
336
344
  name?: {
337
345
  first?: string | undefined;
@@ -341,12 +349,13 @@ export declare const createAccountRequestSchema: z.ZodEffects<z.ZodObject<{
341
349
  bio?: string | undefined;
342
350
  avatar?: string | undefined;
343
351
  description?: string | undefined;
344
- color?: string | undefined;
345
352
  accountCategories?: ("security" | "news" | "politics" | "business" | "startup" | "finance" | "crypto" | "marketplace" | "retail" | "real_estate" | "agency" | "landlord" | "cooperative" | "architecture" | "technology" | "software" | "ai" | "automation" | "science" | "education" | "books" | "health" | "fitness" | "sports" | "gaming" | "music" | "film" | "podcast" | "art" | "photography" | "comedy" | "food" | "travel" | "fashion" | "home_garden" | "diy" | "automotive" | "animals" | "family" | "nonprofit" | "government" | "community" | "activism" | "environment" | "religion" | "other")[] | undefined;
346
353
  isPrivateAccount?: boolean | undefined;
354
+ character?: import("./avatarCharacter").AvatarCharacter | undefined;
347
355
  }, {
348
356
  kind: "bot" | "organization" | "project" | "channel";
349
357
  username: string;
358
+ color?: string | undefined;
350
359
  parentAccountId?: string | undefined;
351
360
  name?: {
352
361
  first?: string | undefined;
@@ -356,12 +365,13 @@ export declare const createAccountRequestSchema: z.ZodEffects<z.ZodObject<{
356
365
  bio?: string | undefined;
357
366
  avatar?: string | undefined;
358
367
  description?: string | undefined;
359
- color?: string | undefined;
360
368
  accountCategories?: ("security" | "news" | "politics" | "business" | "startup" | "finance" | "crypto" | "marketplace" | "retail" | "real_estate" | "agency" | "landlord" | "cooperative" | "architecture" | "technology" | "software" | "ai" | "automation" | "science" | "education" | "books" | "health" | "fitness" | "sports" | "gaming" | "music" | "film" | "podcast" | "art" | "photography" | "comedy" | "food" | "travel" | "fashion" | "home_garden" | "diy" | "automotive" | "animals" | "family" | "nonprofit" | "government" | "community" | "activism" | "environment" | "religion" | "other")[] | undefined;
361
369
  isPrivateAccount?: boolean | undefined;
370
+ character?: unknown;
362
371
  }>, {
363
372
  kind: "bot" | "organization" | "project" | "channel";
364
373
  username: string;
374
+ color?: string | undefined;
365
375
  parentAccountId?: string | undefined;
366
376
  name?: {
367
377
  first?: string | undefined;
@@ -371,12 +381,13 @@ export declare const createAccountRequestSchema: z.ZodEffects<z.ZodObject<{
371
381
  bio?: string | undefined;
372
382
  avatar?: string | undefined;
373
383
  description?: string | undefined;
374
- color?: string | undefined;
375
384
  accountCategories?: ("security" | "news" | "politics" | "business" | "startup" | "finance" | "crypto" | "marketplace" | "retail" | "real_estate" | "agency" | "landlord" | "cooperative" | "architecture" | "technology" | "software" | "ai" | "automation" | "science" | "education" | "books" | "health" | "fitness" | "sports" | "gaming" | "music" | "film" | "podcast" | "art" | "photography" | "comedy" | "food" | "travel" | "fashion" | "home_garden" | "diy" | "automotive" | "animals" | "family" | "nonprofit" | "government" | "community" | "activism" | "environment" | "religion" | "other")[] | undefined;
376
385
  isPrivateAccount?: boolean | undefined;
386
+ character?: import("./avatarCharacter").AvatarCharacter | undefined;
377
387
  }, {
378
388
  kind: "bot" | "organization" | "project" | "channel";
379
389
  username: string;
390
+ color?: string | undefined;
380
391
  parentAccountId?: string | undefined;
381
392
  name?: {
382
393
  first?: string | undefined;
@@ -386,8 +397,8 @@ export declare const createAccountRequestSchema: z.ZodEffects<z.ZodObject<{
386
397
  bio?: string | undefined;
387
398
  avatar?: string | undefined;
388
399
  description?: string | undefined;
389
- color?: string | undefined;
390
400
  accountCategories?: ("security" | "news" | "politics" | "business" | "startup" | "finance" | "crypto" | "marketplace" | "retail" | "real_estate" | "agency" | "landlord" | "cooperative" | "architecture" | "technology" | "software" | "ai" | "automation" | "science" | "education" | "books" | "health" | "fitness" | "sports" | "gaming" | "music" | "film" | "podcast" | "art" | "photography" | "comedy" | "food" | "travel" | "fashion" | "home_garden" | "diy" | "automotive" | "animals" | "family" | "nonprofit" | "government" | "community" | "activism" | "environment" | "religion" | "other")[] | undefined;
391
401
  isPrivateAccount?: boolean | undefined;
402
+ character?: unknown;
392
403
  }>;
393
404
  export type CreateAccountRequest = z.infer<typeof createAccountRequestSchema>;
@@ -166,7 +166,7 @@ export declare const financialEffectAttributionSchema: z.ZodEffects<z.ZodObject<
166
166
  }>;
167
167
  }, "strict", z.ZodTypeAny, {
168
168
  schemaVersion: 1;
169
- direction: "debit" | "credit";
169
+ direction: "credit" | "debit";
170
170
  subjectAccountId: string & z.BRAND<"OxyAccountId">;
171
171
  actor: {
172
172
  schemaVersion: 1;
@@ -176,7 +176,7 @@ export declare const financialEffectAttributionSchema: z.ZodEffects<z.ZodObject<
176
176
  };
177
177
  }, {
178
178
  schemaVersion: 1;
179
- direction: "debit" | "credit";
179
+ direction: "credit" | "debit";
180
180
  subjectAccountId: string;
181
181
  actor: {
182
182
  schemaVersion: 1;
@@ -186,7 +186,7 @@ export declare const financialEffectAttributionSchema: z.ZodEffects<z.ZodObject<
186
186
  };
187
187
  }>, {
188
188
  schemaVersion: 1;
189
- direction: "debit" | "credit";
189
+ direction: "credit" | "debit";
190
190
  subjectAccountId: string & z.BRAND<"OxyAccountId">;
191
191
  actor: {
192
192
  schemaVersion: 1;
@@ -196,7 +196,7 @@ export declare const financialEffectAttributionSchema: z.ZodEffects<z.ZodObject<
196
196
  };
197
197
  }, {
198
198
  schemaVersion: 1;
199
- direction: "debit" | "credit";
199
+ direction: "credit" | "debit";
200
200
  subjectAccountId: string;
201
201
  actor: {
202
202
  schemaVersion: 1;
@@ -2075,12 +2075,12 @@ export declare const catalogToolSchema: z.ZodEffects<z.ZodObject<{
2075
2075
  name: string;
2076
2076
  description: string;
2077
2077
  version: string;
2078
- rollback: "manual" | "supported" | "none";
2078
+ rollback: "none" | "manual" | "supported";
2079
2079
  inputSchema: Record<string, unknown>;
2080
2080
  capabilityPackage: "security" | "finance" | "read" | "create" | "publish" | "communicate" | "administer" | "delegate";
2081
2081
  requiredCapabilities: string[];
2082
2082
  resourceTypes: string[];
2083
- idempotency: "supported" | "none" | "required";
2083
+ idempotency: "none" | "supported" | "required";
2084
2084
  exposure: ("internal" | "mcp")[];
2085
2085
  limitKeys: {
2086
2086
  kind: "maximum_number" | "exact_boolean";
@@ -2096,12 +2096,12 @@ export declare const catalogToolSchema: z.ZodEffects<z.ZodObject<{
2096
2096
  name: string;
2097
2097
  description: string;
2098
2098
  version: string;
2099
- rollback: "manual" | "supported" | "none";
2099
+ rollback: "none" | "manual" | "supported";
2100
2100
  inputSchema: Record<string, unknown>;
2101
2101
  capabilityPackage: "security" | "finance" | "read" | "create" | "publish" | "communicate" | "administer" | "delegate";
2102
2102
  requiredCapabilities: string[];
2103
2103
  resourceTypes: string[];
2104
- idempotency: "supported" | "none" | "required";
2104
+ idempotency: "none" | "supported" | "required";
2105
2105
  exposure: ("internal" | "mcp")[];
2106
2106
  invocation: {
2107
2107
  path: string;
@@ -2117,12 +2117,12 @@ export declare const catalogToolSchema: z.ZodEffects<z.ZodObject<{
2117
2117
  name: string;
2118
2118
  description: string;
2119
2119
  version: string;
2120
- rollback: "manual" | "supported" | "none";
2120
+ rollback: "none" | "manual" | "supported";
2121
2121
  inputSchema: Record<string, unknown>;
2122
2122
  capabilityPackage: "security" | "finance" | "read" | "create" | "publish" | "communicate" | "administer" | "delegate";
2123
2123
  requiredCapabilities: string[];
2124
2124
  resourceTypes: string[];
2125
- idempotency: "supported" | "none" | "required";
2125
+ idempotency: "none" | "supported" | "required";
2126
2126
  exposure: ("internal" | "mcp")[];
2127
2127
  limitKeys: {
2128
2128
  kind: "maximum_number" | "exact_boolean";
@@ -2138,12 +2138,12 @@ export declare const catalogToolSchema: z.ZodEffects<z.ZodObject<{
2138
2138
  name: string;
2139
2139
  description: string;
2140
2140
  version: string;
2141
- rollback: "manual" | "supported" | "none";
2141
+ rollback: "none" | "manual" | "supported";
2142
2142
  inputSchema: Record<string, unknown>;
2143
2143
  capabilityPackage: "security" | "finance" | "read" | "create" | "publish" | "communicate" | "administer" | "delegate";
2144
2144
  requiredCapabilities: string[];
2145
2145
  resourceTypes: string[];
2146
- idempotency: "supported" | "none" | "required";
2146
+ idempotency: "none" | "supported" | "required";
2147
2147
  exposure: ("internal" | "mcp")[];
2148
2148
  invocation: {
2149
2149
  path: string;
@@ -2229,12 +2229,12 @@ export declare const appCapabilityCatalogSchema: z.ZodEffects<z.ZodObject<{
2229
2229
  name: string;
2230
2230
  description: string;
2231
2231
  version: string;
2232
- rollback: "manual" | "supported" | "none";
2232
+ rollback: "none" | "manual" | "supported";
2233
2233
  inputSchema: Record<string, unknown>;
2234
2234
  capabilityPackage: "security" | "finance" | "read" | "create" | "publish" | "communicate" | "administer" | "delegate";
2235
2235
  requiredCapabilities: string[];
2236
2236
  resourceTypes: string[];
2237
- idempotency: "supported" | "none" | "required";
2237
+ idempotency: "none" | "supported" | "required";
2238
2238
  exposure: ("internal" | "mcp")[];
2239
2239
  limitKeys: {
2240
2240
  kind: "maximum_number" | "exact_boolean";
@@ -2250,12 +2250,12 @@ export declare const appCapabilityCatalogSchema: z.ZodEffects<z.ZodObject<{
2250
2250
  name: string;
2251
2251
  description: string;
2252
2252
  version: string;
2253
- rollback: "manual" | "supported" | "none";
2253
+ rollback: "none" | "manual" | "supported";
2254
2254
  inputSchema: Record<string, unknown>;
2255
2255
  capabilityPackage: "security" | "finance" | "read" | "create" | "publish" | "communicate" | "administer" | "delegate";
2256
2256
  requiredCapabilities: string[];
2257
2257
  resourceTypes: string[];
2258
- idempotency: "supported" | "none" | "required";
2258
+ idempotency: "none" | "supported" | "required";
2259
2259
  exposure: ("internal" | "mcp")[];
2260
2260
  invocation: {
2261
2261
  path: string;
@@ -2271,12 +2271,12 @@ export declare const appCapabilityCatalogSchema: z.ZodEffects<z.ZodObject<{
2271
2271
  name: string;
2272
2272
  description: string;
2273
2273
  version: string;
2274
- rollback: "manual" | "supported" | "none";
2274
+ rollback: "none" | "manual" | "supported";
2275
2275
  inputSchema: Record<string, unknown>;
2276
2276
  capabilityPackage: "security" | "finance" | "read" | "create" | "publish" | "communicate" | "administer" | "delegate";
2277
2277
  requiredCapabilities: string[];
2278
2278
  resourceTypes: string[];
2279
- idempotency: "supported" | "none" | "required";
2279
+ idempotency: "none" | "supported" | "required";
2280
2280
  exposure: ("internal" | "mcp")[];
2281
2281
  limitKeys: {
2282
2282
  kind: "maximum_number" | "exact_boolean";
@@ -2292,12 +2292,12 @@ export declare const appCapabilityCatalogSchema: z.ZodEffects<z.ZodObject<{
2292
2292
  name: string;
2293
2293
  description: string;
2294
2294
  version: string;
2295
- rollback: "manual" | "supported" | "none";
2295
+ rollback: "none" | "manual" | "supported";
2296
2296
  inputSchema: Record<string, unknown>;
2297
2297
  capabilityPackage: "security" | "finance" | "read" | "create" | "publish" | "communicate" | "administer" | "delegate";
2298
2298
  requiredCapabilities: string[];
2299
2299
  resourceTypes: string[];
2300
- idempotency: "supported" | "none" | "required";
2300
+ idempotency: "none" | "supported" | "required";
2301
2301
  exposure: ("internal" | "mcp")[];
2302
2302
  invocation: {
2303
2303
  path: string;
@@ -2340,12 +2340,12 @@ export declare const appCapabilityCatalogSchema: z.ZodEffects<z.ZodObject<{
2340
2340
  name: string;
2341
2341
  description: string;
2342
2342
  version: string;
2343
- rollback: "manual" | "supported" | "none";
2343
+ rollback: "none" | "manual" | "supported";
2344
2344
  inputSchema: Record<string, unknown>;
2345
2345
  capabilityPackage: "security" | "finance" | "read" | "create" | "publish" | "communicate" | "administer" | "delegate";
2346
2346
  requiredCapabilities: string[];
2347
2347
  resourceTypes: string[];
2348
- idempotency: "supported" | "none" | "required";
2348
+ idempotency: "none" | "supported" | "required";
2349
2349
  exposure: ("internal" | "mcp")[];
2350
2350
  limitKeys: {
2351
2351
  kind: "maximum_number" | "exact_boolean";
@@ -2379,12 +2379,12 @@ export declare const appCapabilityCatalogSchema: z.ZodEffects<z.ZodObject<{
2379
2379
  name: string;
2380
2380
  description: string;
2381
2381
  version: string;
2382
- rollback: "manual" | "supported" | "none";
2382
+ rollback: "none" | "manual" | "supported";
2383
2383
  inputSchema: Record<string, unknown>;
2384
2384
  capabilityPackage: "security" | "finance" | "read" | "create" | "publish" | "communicate" | "administer" | "delegate";
2385
2385
  requiredCapabilities: string[];
2386
2386
  resourceTypes: string[];
2387
- idempotency: "supported" | "none" | "required";
2387
+ idempotency: "none" | "supported" | "required";
2388
2388
  exposure: ("internal" | "mcp")[];
2389
2389
  invocation: {
2390
2390
  path: string;
@@ -2418,12 +2418,12 @@ export declare const appCapabilityCatalogSchema: z.ZodEffects<z.ZodObject<{
2418
2418
  name: string;
2419
2419
  description: string;
2420
2420
  version: string;
2421
- rollback: "manual" | "supported" | "none";
2421
+ rollback: "none" | "manual" | "supported";
2422
2422
  inputSchema: Record<string, unknown>;
2423
2423
  capabilityPackage: "security" | "finance" | "read" | "create" | "publish" | "communicate" | "administer" | "delegate";
2424
2424
  requiredCapabilities: string[];
2425
2425
  resourceTypes: string[];
2426
- idempotency: "supported" | "none" | "required";
2426
+ idempotency: "none" | "supported" | "required";
2427
2427
  exposure: ("internal" | "mcp")[];
2428
2428
  limitKeys: {
2429
2429
  kind: "maximum_number" | "exact_boolean";
@@ -2457,12 +2457,12 @@ export declare const appCapabilityCatalogSchema: z.ZodEffects<z.ZodObject<{
2457
2457
  name: string;
2458
2458
  description: string;
2459
2459
  version: string;
2460
- rollback: "manual" | "supported" | "none";
2460
+ rollback: "none" | "manual" | "supported";
2461
2461
  inputSchema: Record<string, unknown>;
2462
2462
  capabilityPackage: "security" | "finance" | "read" | "create" | "publish" | "communicate" | "administer" | "delegate";
2463
2463
  requiredCapabilities: string[];
2464
2464
  resourceTypes: string[];
2465
- idempotency: "supported" | "none" | "required";
2465
+ idempotency: "none" | "supported" | "required";
2466
2466
  exposure: ("internal" | "mcp")[];
2467
2467
  invocation: {
2468
2468
  path: string;
@@ -2541,12 +2541,12 @@ export declare const catalogRegistrationSchema: z.ZodObject<{
2541
2541
  name: string;
2542
2542
  description: string;
2543
2543
  version: string;
2544
- rollback: "manual" | "supported" | "none";
2544
+ rollback: "none" | "manual" | "supported";
2545
2545
  inputSchema: Record<string, unknown>;
2546
2546
  capabilityPackage: "security" | "finance" | "read" | "create" | "publish" | "communicate" | "administer" | "delegate";
2547
2547
  requiredCapabilities: string[];
2548
2548
  resourceTypes: string[];
2549
- idempotency: "supported" | "none" | "required";
2549
+ idempotency: "none" | "supported" | "required";
2550
2550
  exposure: ("internal" | "mcp")[];
2551
2551
  limitKeys: {
2552
2552
  kind: "maximum_number" | "exact_boolean";
@@ -2562,12 +2562,12 @@ export declare const catalogRegistrationSchema: z.ZodObject<{
2562
2562
  name: string;
2563
2563
  description: string;
2564
2564
  version: string;
2565
- rollback: "manual" | "supported" | "none";
2565
+ rollback: "none" | "manual" | "supported";
2566
2566
  inputSchema: Record<string, unknown>;
2567
2567
  capabilityPackage: "security" | "finance" | "read" | "create" | "publish" | "communicate" | "administer" | "delegate";
2568
2568
  requiredCapabilities: string[];
2569
2569
  resourceTypes: string[];
2570
- idempotency: "supported" | "none" | "required";
2570
+ idempotency: "none" | "supported" | "required";
2571
2571
  exposure: ("internal" | "mcp")[];
2572
2572
  invocation: {
2573
2573
  path: string;
@@ -2583,12 +2583,12 @@ export declare const catalogRegistrationSchema: z.ZodObject<{
2583
2583
  name: string;
2584
2584
  description: string;
2585
2585
  version: string;
2586
- rollback: "manual" | "supported" | "none";
2586
+ rollback: "none" | "manual" | "supported";
2587
2587
  inputSchema: Record<string, unknown>;
2588
2588
  capabilityPackage: "security" | "finance" | "read" | "create" | "publish" | "communicate" | "administer" | "delegate";
2589
2589
  requiredCapabilities: string[];
2590
2590
  resourceTypes: string[];
2591
- idempotency: "supported" | "none" | "required";
2591
+ idempotency: "none" | "supported" | "required";
2592
2592
  exposure: ("internal" | "mcp")[];
2593
2593
  limitKeys: {
2594
2594
  kind: "maximum_number" | "exact_boolean";
@@ -2604,12 +2604,12 @@ export declare const catalogRegistrationSchema: z.ZodObject<{
2604
2604
  name: string;
2605
2605
  description: string;
2606
2606
  version: string;
2607
- rollback: "manual" | "supported" | "none";
2607
+ rollback: "none" | "manual" | "supported";
2608
2608
  inputSchema: Record<string, unknown>;
2609
2609
  capabilityPackage: "security" | "finance" | "read" | "create" | "publish" | "communicate" | "administer" | "delegate";
2610
2610
  requiredCapabilities: string[];
2611
2611
  resourceTypes: string[];
2612
- idempotency: "supported" | "none" | "required";
2612
+ idempotency: "none" | "supported" | "required";
2613
2613
  exposure: ("internal" | "mcp")[];
2614
2614
  invocation: {
2615
2615
  path: string;
@@ -2652,12 +2652,12 @@ export declare const catalogRegistrationSchema: z.ZodObject<{
2652
2652
  name: string;
2653
2653
  description: string;
2654
2654
  version: string;
2655
- rollback: "manual" | "supported" | "none";
2655
+ rollback: "none" | "manual" | "supported";
2656
2656
  inputSchema: Record<string, unknown>;
2657
2657
  capabilityPackage: "security" | "finance" | "read" | "create" | "publish" | "communicate" | "administer" | "delegate";
2658
2658
  requiredCapabilities: string[];
2659
2659
  resourceTypes: string[];
2660
- idempotency: "supported" | "none" | "required";
2660
+ idempotency: "none" | "supported" | "required";
2661
2661
  exposure: ("internal" | "mcp")[];
2662
2662
  limitKeys: {
2663
2663
  kind: "maximum_number" | "exact_boolean";
@@ -2691,12 +2691,12 @@ export declare const catalogRegistrationSchema: z.ZodObject<{
2691
2691
  name: string;
2692
2692
  description: string;
2693
2693
  version: string;
2694
- rollback: "manual" | "supported" | "none";
2694
+ rollback: "none" | "manual" | "supported";
2695
2695
  inputSchema: Record<string, unknown>;
2696
2696
  capabilityPackage: "security" | "finance" | "read" | "create" | "publish" | "communicate" | "administer" | "delegate";
2697
2697
  requiredCapabilities: string[];
2698
2698
  resourceTypes: string[];
2699
- idempotency: "supported" | "none" | "required";
2699
+ idempotency: "none" | "supported" | "required";
2700
2700
  exposure: ("internal" | "mcp")[];
2701
2701
  invocation: {
2702
2702
  path: string;
@@ -2730,12 +2730,12 @@ export declare const catalogRegistrationSchema: z.ZodObject<{
2730
2730
  name: string;
2731
2731
  description: string;
2732
2732
  version: string;
2733
- rollback: "manual" | "supported" | "none";
2733
+ rollback: "none" | "manual" | "supported";
2734
2734
  inputSchema: Record<string, unknown>;
2735
2735
  capabilityPackage: "security" | "finance" | "read" | "create" | "publish" | "communicate" | "administer" | "delegate";
2736
2736
  requiredCapabilities: string[];
2737
2737
  resourceTypes: string[];
2738
- idempotency: "supported" | "none" | "required";
2738
+ idempotency: "none" | "supported" | "required";
2739
2739
  exposure: ("internal" | "mcp")[];
2740
2740
  limitKeys: {
2741
2741
  kind: "maximum_number" | "exact_boolean";
@@ -2769,12 +2769,12 @@ export declare const catalogRegistrationSchema: z.ZodObject<{
2769
2769
  name: string;
2770
2770
  description: string;
2771
2771
  version: string;
2772
- rollback: "manual" | "supported" | "none";
2772
+ rollback: "none" | "manual" | "supported";
2773
2773
  inputSchema: Record<string, unknown>;
2774
2774
  capabilityPackage: "security" | "finance" | "read" | "create" | "publish" | "communicate" | "administer" | "delegate";
2775
2775
  requiredCapabilities: string[];
2776
2776
  resourceTypes: string[];
2777
- idempotency: "supported" | "none" | "required";
2777
+ idempotency: "none" | "supported" | "required";
2778
2778
  exposure: ("internal" | "mcp")[];
2779
2779
  invocation: {
2780
2780
  path: string;
@@ -2814,12 +2814,12 @@ export declare const catalogRegistrationSchema: z.ZodObject<{
2814
2814
  name: string;
2815
2815
  description: string;
2816
2816
  version: string;
2817
- rollback: "manual" | "supported" | "none";
2817
+ rollback: "none" | "manual" | "supported";
2818
2818
  inputSchema: Record<string, unknown>;
2819
2819
  capabilityPackage: "security" | "finance" | "read" | "create" | "publish" | "communicate" | "administer" | "delegate";
2820
2820
  requiredCapabilities: string[];
2821
2821
  resourceTypes: string[];
2822
- idempotency: "supported" | "none" | "required";
2822
+ idempotency: "none" | "supported" | "required";
2823
2823
  exposure: ("internal" | "mcp")[];
2824
2824
  limitKeys: {
2825
2825
  kind: "maximum_number" | "exact_boolean";
@@ -2858,12 +2858,12 @@ export declare const catalogRegistrationSchema: z.ZodObject<{
2858
2858
  name: string;
2859
2859
  description: string;
2860
2860
  version: string;
2861
- rollback: "manual" | "supported" | "none";
2861
+ rollback: "none" | "manual" | "supported";
2862
2862
  inputSchema: Record<string, unknown>;
2863
2863
  capabilityPackage: "security" | "finance" | "read" | "create" | "publish" | "communicate" | "administer" | "delegate";
2864
2864
  requiredCapabilities: string[];
2865
2865
  resourceTypes: string[];
2866
- idempotency: "supported" | "none" | "required";
2866
+ idempotency: "none" | "supported" | "required";
2867
2867
  exposure: ("internal" | "mcp")[];
2868
2868
  invocation: {
2869
2869
  path: string;
@@ -0,0 +1,57 @@
1
+ /**
2
+ * The 3D avatar character a `bot` account carries.
3
+ *
4
+ * ONE definition for the wire shape, its validator and the generator that picks
5
+ * a look for a new bot, shared by the Oxy API (which stores and serves it) and
6
+ * every client. It mirrors Bloom's flat `AvatarCharacter`
7
+ * (`@oxy.so/bloom/agent-avatar`).
8
+ *
9
+ * ## The vocabulary is Bloom's and is NOT enforced here
10
+ *
11
+ * Bloom is a React Native package this one cannot depend on, so the ids a
12
+ * character is made of are restated below as a curated SUBSET, only to PICK a
13
+ * look for a new bot ({@link avatarCharacterFor}). A STORED character is never
14
+ * checked against them: validating against a stale copy of somebody else's
15
+ * catalogue is how a working look starts being refused. What the schema checks
16
+ * is the SHAPE of what a client writes: only the keys a character has, each an
17
+ * id-like string, a `#rrggbb` paint, a spacing in range. The client resolves
18
+ * the ids and falls back on a default look for one it cannot draw.
19
+ */
20
+ import { z } from 'zod';
21
+ /** The flat shape of Bloom's `AvatarCharacter`; every field is optional (a preset supplies the rest). */
22
+ export interface AvatarCharacter {
23
+ preset?: string;
24
+ shape?: string;
25
+ eyes?: string;
26
+ eyewear?: string;
27
+ accessory?: string;
28
+ /** Named paint. */
29
+ color?: string;
30
+ /** Exact paint, `#rrggbb`; it wins over `color`. */
31
+ bodyColor?: string;
32
+ /** A multiplier (0.5 to 1.5) on the shape's eye separation. */
33
+ eyeSpacing?: number;
34
+ }
35
+ /** Bounds of {@link AvatarCharacter.eyeSpacing}. */
36
+ export declare const AVATAR_EYE_SPACING: {
37
+ readonly min: 0.5;
38
+ readonly max: 1.5;
39
+ };
40
+ /**
41
+ * A character a client sends. `.strict()` so a misspelled field is a refusal
42
+ * now rather than a look that never takes effect. A character with nothing in
43
+ * it draws nothing: it needs a preset, or a shape and a paint.
44
+ */
45
+ export declare const avatarCharacterSchema: z.ZodType<AvatarCharacter, z.ZodTypeDef, unknown>;
46
+ /** The validated character, or `null` for anything that is not one. */
47
+ export declare function parseAvatarCharacter(value: unknown): AvatarCharacter | null;
48
+ /** The parts a new bot's look is picked from: the plain, friendly shapes, in the editor's order. */
49
+ export declare const AVATAR_PICKABLE_SHAPES: readonly ["rounded_triangle", "capsule", "rounded_head_two_ears", "six_lobed_flower", "heart", "four_lobed_butterfly", "circle_two_ears", "twelve_scalloped_rosette", "rounded_cube", "rounded_diamond", "slender", "pocket", "petal", "star", "cloud", "shield", "pebble", "squircle"];
50
+ /** Bloom's named paints. */
51
+ export declare const AVATAR_PICKABLE_COLORS: readonly ["pink", "orchid", "violet", "blue", "cyan", "teal", "lime", "yellow", "coral"];
52
+ /**
53
+ * A look for a new bot, picked from its seed (its handle): a shape and a paint,
54
+ * plain oval eyes, nothing on its head. Stable — the same seed is the same look
55
+ * — and the owner changes it afterwards.
56
+ */
57
+ export declare function avatarCharacterFor(seed: string): AvatarCharacter;