@takeshape/schema 11.105.0 → 11.106.1

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 (89) hide show
  1. package/dist/agents.d.ts +4 -4
  2. package/dist/agents.js +4 -4
  3. package/dist/migration/index.d.ts +1 -0
  4. package/dist/migration/index.js +3 -1
  5. package/dist/migration/to/v3.57.0.d.ts +4 -0
  6. package/dist/migration/to/v3.57.0.js +18 -0
  7. package/dist/migration/types.d.ts +7 -4
  8. package/dist/migration/types.js +3 -3
  9. package/dist/project-schema/index.d.ts +4 -1
  10. package/dist/project-schema/index.js +2 -1
  11. package/dist/project-schema/latest.d.ts +452 -260
  12. package/dist/project-schema/migrate.js +4 -1
  13. package/dist/project-schema/v3.57.0.d.ts +2597 -0
  14. package/dist/project-schema/v3.57.0.js +7 -0
  15. package/dist/refs.js +2 -2
  16. package/dist/schema-util.d.ts +2 -2
  17. package/dist/schemas/index.d.ts +2 -2
  18. package/dist/schemas/index.js +5 -3
  19. package/dist/schemas/project-schema/{experimental.json → experimental-2025-07.json} +1 -2
  20. package/dist/schemas/project-schema/latest.d.ts +180 -0
  21. package/dist/schemas/project-schema/latest.js +11 -0
  22. package/dist/schemas/project-schema/latest.json +1292 -12
  23. package/dist/schemas/project-schema/v3.48.0.json +2 -2
  24. package/dist/schemas/project-schema/v3.49.0.json +2 -2
  25. package/dist/schemas/project-schema/v3.50.0.json +3 -3
  26. package/dist/schemas/project-schema/v3.51.0.json +3 -3
  27. package/dist/schemas/project-schema/v3.52.0.json +3 -3
  28. package/dist/schemas/project-schema/v3.53.0.json +3 -3
  29. package/dist/schemas/project-schema/v3.54.0.json +3 -3
  30. package/dist/schemas/project-schema/v3.55.0.json +3 -3
  31. package/dist/schemas/project-schema/v3.56.0.json +7 -7
  32. package/dist/schemas/project-schema/v3.57.0.json +4810 -0
  33. package/dist/schemas/project-schema.json +3 -0
  34. package/dist/util/mcp.d.ts +1 -1
  35. package/dist/util/mcp.js +2 -2
  36. package/dist/validate/validate.d.ts +2 -1
  37. package/dist/validate/validate.js +15 -13
  38. package/examples/latest/agent-schema.json +174 -176
  39. package/examples/latest/all-fields-shapes-inline.json +1 -1
  40. package/examples/latest/all-fields-shapes.json +1 -1
  41. package/examples/latest/betzino.json +1 -1
  42. package/examples/latest/blog-schema.json +1 -1
  43. package/examples/latest/brewery-schema.json +1 -1
  44. package/examples/latest/clear-cache-schema.json +1 -1
  45. package/examples/latest/complex-project-schema.json +1 -1
  46. package/examples/latest/complex-schema.json +1 -1
  47. package/examples/latest/edit-schema.json +1 -1
  48. package/examples/latest/fabric-ecommerce.json +1 -1
  49. package/examples/latest/frank-and-fred-schema.json +1 -1
  50. package/examples/latest/klirr-schema.json +1 -1
  51. package/examples/latest/layers/rick-and-morty-layer.json +1 -1
  52. package/examples/latest/layers/shopify-layer-2023-01.json +1 -1
  53. package/examples/latest/layers/shopify-storefront-2023-04.json +1 -1
  54. package/examples/latest/layers/wordpress-2024-01.json +1 -1
  55. package/examples/latest/massive-schema.json +1 -1
  56. package/examples/latest/mill-components-schema.json +1 -1
  57. package/examples/latest/nested-shape-arrays.json +1 -1
  58. package/examples/latest/one-earth.json +1 -1
  59. package/examples/latest/pet-oneof-array.json +1 -1
  60. package/examples/latest/post-schema.json +1 -1
  61. package/examples/latest/pruned-shopify-product-schema.json +1 -1
  62. package/examples/latest/rag-example.json +1 -1
  63. package/examples/latest/real-world-schema.json +1 -1
  64. package/examples/latest/recursive-repeater-schema.json +1 -1
  65. package/examples/latest/recursive-schema.json +1 -1
  66. package/examples/latest/rick-and-morty-ast.json +1 -1
  67. package/examples/latest/rick-and-morty-graphql.json +1 -1
  68. package/examples/latest/rick-and-morty-rest.json +1 -1
  69. package/examples/latest/rick-and-morty-user-schema.json +1 -1
  70. package/examples/latest/rick-and-morty-with-indexing.json +1 -1
  71. package/examples/latest/schema-where-filter.json +1 -1
  72. package/examples/latest/schema-with-repeater-draftjs.json +1 -1
  73. package/examples/latest/schema-with-rick-and-morty.json +1 -1
  74. package/examples/latest/shape-books-v3_2_0.json +1 -1
  75. package/examples/latest/shape-books.json +1 -1
  76. package/examples/latest/shape-editor-schema-edited.json +1 -1
  77. package/examples/latest/shape-editor-schema-initial.json +1 -1
  78. package/examples/latest/shapedb-crud-every-prop-type.json +1 -1
  79. package/examples/latest/shopify-lookbook.json +1 -1
  80. package/examples/latest/shopify-product-2022-07.json +1 -1
  81. package/examples/latest/shopify-product-2023-04.json +1 -1
  82. package/examples/latest/shopify-store-with-widget.json +1 -1
  83. package/examples/latest/stripe-product-runtime-schema.json +1 -1
  84. package/examples/latest/stripe-starter-resolved.json +1 -1
  85. package/examples/latest/user-schema-no-required.json +1 -1
  86. package/examples/latest/user-schema-with-defaults.json +1 -1
  87. package/examples/latest/valvoline-ai-demo.json +1 -1
  88. package/examples/latest/vector-search-schema.json +1 -1
  89. package/package.json +27 -28
@@ -310,12 +310,94 @@ export type CacheTriggerConfig = CacheScheduleTriggerConfig | CacheWebhookTrigge
310
310
  * via the `definition` "shapeSchema".
311
311
  */
312
312
  export type ShapeSchema = ShapeSchemaAllOf | ShapeSchemaExtends | ShapeSchemaOneOf | ShapeSchemaEnum | ObjectSchema | ShapeSchemaAny;
313
+ /**
314
+ * Human-readable id for use in the UI
315
+ */
316
+ export type WorkflowName = string;
317
+ /**
318
+ * machine-readable slug
319
+ */
320
+ export type Name = string;
321
+ /**
322
+ * Human-readable id for use in the UI
323
+ */
324
+ export type Title = string;
325
+ export type Description = string;
326
+ /**
327
+ * Hex color code
328
+ */
329
+ export type Color = string;
330
+ /**
331
+ * Value to indicate whether items in the state should be returned in list queries
332
+ */
333
+ export type Live = boolean;
334
+ /**
335
+ * machine-readable id
336
+ */
337
+ export type Key = string;
338
+ export type Steps = WorkflowStep[];
339
+ /**
340
+ * The general type of this service, specifying how and where it will be utilized.
341
+ *
342
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
343
+ * via the `definition` "serviceType".
344
+ */
345
+ export type ServiceType = 'deployment' | 'authentication' | 'takeshape' | 'rest' | 'graphql' | 'openapi' | 'aws' | 'unknown';
346
+ /**
347
+ * The name of a health check to run
348
+ */
349
+ export type CheckName = 'graphqlIntrospection' | 'ping' | 'none';
350
+ /**
351
+ * The endpoint to use when checking the service health.
352
+ */
353
+ export type Endpoint = string;
354
+ /**
355
+ * A custom method to use for the health check request.
356
+ */
357
+ export type RequestMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
358
+ /**
359
+ * A custom body to send along with the ping request.
360
+ */
361
+ export type RequestBody = string;
362
+ /**
363
+ * A custom body to send along with the ping request.
364
+ */
365
+ export type RequestBodyFormat = 'string' | 'form' | 'json' | 'form-data';
366
+ /**
367
+ * The amount of time to wait when receiving a response from the health check, in seconds.
368
+ */
369
+ export type RequestTimeout = number;
370
+ /**
371
+ * The response status code that qualifies as healthy.
372
+ */
373
+ export type HealthyResponseStatusCode = number;
374
+ /**
375
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
376
+ * via the `definition` "serviceHealthCheckTrigger".
377
+ */
378
+ export type ServiceHealthCheckTrigger = 'manual' | 'schedule';
379
+ /**
380
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
381
+ * via the `definition` "agentApiInput".
382
+ */
313
383
  export type AgentAPIInput = AgentAPIMutationInput;
314
384
  export type InteractionTimeoutMilliseconds = number;
315
385
  export type AgentStateSessionMemory = AgentStateSessionMemoryAssignment[];
316
386
  export type Variables = AgentVariable[];
387
+ /**
388
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
389
+ * via the `definition` "agentExecution".
390
+ */
317
391
  export type AgentExecution = AgentExecutionGraphQL | AgentExecutionGenerate | AgentExecutionChat;
392
+ /**
393
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
394
+ * via the `definition` "agentAiStateInput".
395
+ */
318
396
  export type AgentAIStateInput = AgentAIStateInputArgument | AgentAIStateInputTemplate;
397
+ /**
398
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
399
+ * via the `definition` "agentToolConfigArg".
400
+ */
319
401
  export type AgentToolConfigArg = AgentControlled | VariableValue;
320
402
  /**
321
403
  * The argument name that will be exposed by the tool for the LLM to use.
@@ -377,6 +459,9 @@ export type EnableOpenAISchemaFormat = boolean;
377
459
  export type MinimatchPattern = string;
378
460
  /**
379
461
  * Remove properties from the schema sent to the model with keys matching these minimatch glob patterns.
462
+ *
463
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
464
+ * via the `definition` "removePropertyKeyPatterns".
380
465
  */
381
466
  export type RemovePropertyKeyPatterns = MinimatchPattern[];
382
467
  /**
@@ -385,20 +470,27 @@ export type RemovePropertyKeyPatterns = MinimatchPattern[];
385
470
  export type StripMarkdown = boolean;
386
471
  /**
387
472
  * These steps are evaluated in order until a destination is found.
473
+ *
474
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
475
+ * via the `definition` "agentTransition".
388
476
  */
389
477
  export type AgentTransition = AgentTransitionImmediate | AgentTransitionSuspend;
390
478
  export type AgentStateSessionMemory1 = AgentStateSessionMemoryAssignment[];
391
479
  export type GuardID = string;
392
480
  export type Variables1 = AgentVariable[];
481
+ /**
482
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
483
+ * via the `definition` "historyStrategyTransform".
484
+ */
393
485
  export type HistoryStrategyTransform = HistoryStrategyTransformNone | HistoryStrategyTransformReplace | HistoryStrategyTransformSummarize;
394
486
  /**
395
487
  * The human-readable name of the Guard.
396
488
  */
397
- export type Name = string;
489
+ export type Name1 = string;
398
490
  /**
399
491
  * A description of the Guard.
400
492
  */
401
- export type Description = string;
493
+ export type Description1 = string;
402
494
  /**
403
495
  * Guards will not run unless enabled.
404
496
  */
@@ -434,6 +526,10 @@ export type Topic = {
434
526
  }[];
435
527
  export type InputStrength = 'NONE' | 'LOW' | 'MEDIUM' | 'HIGH';
436
528
  export type OutputStrength = 'NONE' | 'LOW' | 'MEDIUM' | 'HIGH';
529
+ /**
530
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
531
+ * via the `definition` "guardrailModality".
532
+ */
437
533
  export type GuardrailModality = 'TEXT' | 'IMAGE';
438
534
  /**
439
535
  * Whether to filter images or text
@@ -465,6 +561,10 @@ export type WordList = {
465
561
  export type ManagedWordList = {
466
562
  type: 'PROFANITY';
467
563
  }[];
564
+ /**
565
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
566
+ * via the `definition` "guardrailSensitiveInformationAction".
567
+ */
468
568
  export type GuardrailSensitiveInformationAction = 'ANONYMIZE' | 'BLOCK';
469
569
  /**
470
570
  * PII entity to infer from the text.
@@ -497,73 +597,11 @@ export type Filter1 = {
497
597
  type: Type;
498
598
  threshold: Threshold;
499
599
  }[];
500
- export type ToolArg = AgentControlled;
501
- /**
502
- * Human-readable id for use in the UI
503
- */
504
- export type WorkflowName = string;
505
- /**
506
- * machine-readable slug
507
- */
508
- export type Name1 = string;
509
- /**
510
- * Human-readable id for use in the UI
511
- */
512
- export type Title = string;
513
- export type Description1 = string;
514
- /**
515
- * Hex color code
516
- */
517
- export type Color = string;
518
- /**
519
- * Value to indicate whether items in the state should be returned in list queries
520
- */
521
- export type Live = boolean;
522
- /**
523
- * machine-readable id
524
- */
525
- export type Key = string;
526
- export type Steps = WorkflowStep[];
527
- /**
528
- * The general type of this service, specifying how and where it will be utilized.
529
- *
530
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
531
- * via the `definition` "serviceType".
532
- */
533
- export type ServiceType = 'deployment' | 'authentication' | 'takeshape' | 'rest' | 'graphql' | 'openapi' | 'aws' | 'unknown';
534
- /**
535
- * The name of a health check to run
536
- */
537
- export type CheckName = 'graphqlIntrospection' | 'ping' | 'none';
538
- /**
539
- * The endpoint to use when checking the service health.
540
- */
541
- export type Endpoint = string;
542
- /**
543
- * A custom method to use for the health check request.
544
- */
545
- export type RequestMethod = 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
546
- /**
547
- * A custom body to send along with the ping request.
548
- */
549
- export type RequestBody = string;
550
- /**
551
- * A custom body to send along with the ping request.
552
- */
553
- export type RequestBodyFormat = 'string' | 'form' | 'json' | 'form-data';
554
- /**
555
- * The amount of time to wait when receiving a response from the health check, in seconds.
556
- */
557
- export type RequestTimeout = number;
558
- /**
559
- * The response status code that qualifies as healthy.
560
- */
561
- export type HealthyResponseStatusCode = number;
562
600
  /**
563
601
  * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
564
- * via the `definition` "serviceHealthCheckTrigger".
602
+ * via the `definition` "toolArg".
565
603
  */
566
- export type ServiceHealthCheckTrigger = 'manual' | 'schedule';
604
+ export type ToolArg = AgentControlled;
567
605
  /**
568
606
  * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
569
607
  * via the `definition` "allOfSchema".
@@ -635,7 +673,7 @@ export interface ProjectSchemaJSON {
635
673
  /**
636
674
  * The version of the schema format your project is using. We increase the version as we make breaking changes to the schema format.
637
675
  */
638
- schemaVersion: '3.56.0';
676
+ schemaVersion: '3.57.0';
639
677
  /**
640
678
  * The ID of the TakeShape project this schema belongs to.
641
679
  */
@@ -653,10 +691,12 @@ export interface ProjectSchemaJSON {
653
691
  queries: QueryMap;
654
692
  mutations: QueryMap;
655
693
  shapes: ShapeMap;
656
- 'ai-experimental'?: AIExperimental;
657
694
  forms?: FormMap;
658
695
  workflows: WorkflowMap;
659
696
  services?: ServiceMapJSON;
697
+ agents?: AgentMap;
698
+ guards?: GuardMap;
699
+ mcp?: MCPServerConfiguration;
660
700
  }
661
701
  /**
662
702
  * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
@@ -1523,32 +1563,56 @@ export interface UtilChunkResolverOptionsSemantic {
1523
1563
  */
1524
1564
  maxTokens?: number;
1525
1565
  }
1566
+ /**
1567
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1568
+ * via the `definition` "aiRunAgentResolver".
1569
+ */
1526
1570
  export interface AISendAgentMessageResolver {
1527
1571
  id?: string;
1528
1572
  name: AIResolverName5;
1529
1573
  agentName: string;
1530
1574
  inputName: string;
1531
1575
  }
1576
+ /**
1577
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1578
+ * via the `definition` "aiInspectAgentResolver".
1579
+ */
1532
1580
  export interface AIInspectAgentResolver {
1533
1581
  id?: string;
1534
1582
  name: AIResolverName6;
1535
1583
  agentName: string;
1536
1584
  }
1585
+ /**
1586
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1587
+ * via the `definition` "aiCreateAgentSessionResolver".
1588
+ */
1537
1589
  export interface AICreateAgentSessionResolver {
1538
1590
  id?: string;
1539
1591
  name: AIResolverName7;
1540
1592
  agentName: string;
1541
1593
  }
1594
+ /**
1595
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1596
+ * via the `definition` "aiGetAgentMessageResolver".
1597
+ */
1542
1598
  export interface AIGetAgentMessageResolver {
1543
1599
  id?: string;
1544
1600
  name: AIResolverName8;
1545
1601
  agentName: string;
1546
1602
  }
1603
+ /**
1604
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1605
+ * via the `definition` "aiAbortAgentMessageResolver".
1606
+ */
1547
1607
  export interface AIAbortAgentMessageResolver {
1548
1608
  id?: string;
1549
1609
  name: AIResolverName9;
1550
1610
  agentName: string;
1551
1611
  }
1612
+ /**
1613
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1614
+ * via the `definition` "aiSendAgentFeedbackResolver".
1615
+ */
1552
1616
  export interface AISendAgentFeedbackResolver {
1553
1617
  id?: string;
1554
1618
  name: AIResolverName10;
@@ -1786,66 +1850,237 @@ export interface ShapeSchemaEnum {
1786
1850
  */
1787
1851
  export interface ShapeSchemaAny {
1788
1852
  }
1789
- export interface AIExperimental {
1790
- agents?: AgentMap;
1791
- guards?: GuardMap;
1792
- mcp?: MCPServerConfiguration;
1793
- }
1794
- export interface AgentMap {
1795
- [k: string]: AgentJSON;
1853
+ /**
1854
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1855
+ * via the `definition` "formMap".
1856
+ */
1857
+ export interface FormMap {
1858
+ [k: string]: FormsConfig;
1796
1859
  }
1797
1860
  /**
1798
- * An Agent is a configuration for an AI service such as a chat bot or a search engine.
1861
+ * This interface was referenced by `FormMap`'s JSON-Schema definition
1862
+ * via the `patternProperty` "[0-9A-Za-z_-]+".
1799
1863
  *
1800
- * This interface was referenced by `AgentMap`'s JSON-Schema definition
1801
- * via the `patternProperty` "^[0-9A-Za-z_]+$".
1864
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1865
+ * via the `definition` "formsConfig".
1802
1866
  */
1803
- export interface AgentJSON {
1804
- description?: string;
1805
- systemPrompt?: string;
1806
- api: AgentAPI;
1807
- memory?: AgentMemory;
1808
- start: AgentStart;
1809
- states: AgentStates;
1810
- guards?: AgentGuard[];
1811
- historyStrategies?: HistoryStrategyMap;
1812
- }
1813
- export interface AgentAPI {
1814
- inputs: AgentAPIInput[];
1815
- }
1816
- export interface AgentAPIMutationInput {
1817
- type: 'mutation';
1818
- name: string;
1819
- args: string;
1820
- interactionTimeout?: InteractionTimeoutMilliseconds;
1821
- }
1822
- export interface AgentMemory {
1823
- sessionMemory: AgentSessionMemory;
1824
- }
1825
- export interface AgentSessionMemory {
1826
- shape?: string;
1867
+ export interface FormsConfig {
1868
+ default: FormConfig;
1869
+ [k: string]: FormConfig;
1827
1870
  }
1828
1871
  /**
1829
- * Configuration for the start of an agent's execution
1872
+ * This interface was referenced by `FormsConfig`'s JSON-Schema definition
1873
+ * via the `patternProperty` "[0-9A-Za-z_-]+".
1874
+ *
1875
+ * This interface was referenced by `undefined`'s JSON-Schema definition
1876
+ * via the `patternProperty` "[0-9A-Za-z_-]+".
1877
+ *
1878
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1879
+ * via the `definition` "formConfig".
1830
1880
  */
1831
- export interface AgentStart {
1832
- transitions: AgentTransitionSuspend[];
1833
- }
1834
- export interface AgentTransitionSuspend {
1835
- type: 'suspend';
1836
- destination: string;
1837
- input: string;
1838
- condition?: string;
1839
- limit?: number;
1840
- sessionMemory?: AgentStateSessionMemory;
1841
- historyStrategy?: string;
1842
- }
1843
- export interface AgentStateSessionMemoryAssignment {
1844
- memoryPath?: string;
1845
- expression: string;
1881
+ export interface FormConfig {
1882
+ [k: string]: any;
1846
1883
  }
1847
1884
  /**
1848
- * States that are traversed during the execution of an agent.
1885
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1886
+ * via the `definition` "workflowMap".
1887
+ */
1888
+ export interface WorkflowMap {
1889
+ [k: string]: Workflow;
1890
+ }
1891
+ /**
1892
+ * This interface was referenced by `WorkflowMap`'s JSON-Schema definition
1893
+ * via the `patternProperty` "[0-9A-Za-z_-]+".
1894
+ *
1895
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1896
+ * via the `definition` "workflow".
1897
+ */
1898
+ export interface Workflow {
1899
+ /**
1900
+ * machine-readable id
1901
+ */
1902
+ name: string;
1903
+ title: WorkflowName;
1904
+ steps: Steps;
1905
+ [k: string]: any;
1906
+ }
1907
+ /**
1908
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1909
+ * via the `definition` "workflowStep".
1910
+ */
1911
+ export interface WorkflowStep {
1912
+ name: Name;
1913
+ title: Title;
1914
+ description?: Description;
1915
+ color: Color;
1916
+ live: Live;
1917
+ key: Key;
1918
+ }
1919
+ /**
1920
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1921
+ * via the `definition` "storedServiceMap".
1922
+ */
1923
+ export interface ServiceMapJSON {
1924
+ [k: string]: ServiceConfigJSON;
1925
+ }
1926
+ /**
1927
+ * This interface was referenced by `ServiceMapJSON`'s JSON-Schema definition
1928
+ * via the `patternProperty` "[0-9A-Za-z_-]+".
1929
+ *
1930
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1931
+ * via the `definition` "storedServiceConfig".
1932
+ */
1933
+ export interface ServiceConfigJSON {
1934
+ /**
1935
+ * Machine-readable identifier, should typically be the same as the property name on the services object.
1936
+ */
1937
+ id: string;
1938
+ /**
1939
+ * Human-readable name for this service.
1940
+ */
1941
+ title: string;
1942
+ /**
1943
+ * The service provider id.
1944
+ */
1945
+ provider: string;
1946
+ /**
1947
+ * A namespace to use for the imported types tied to this service.
1948
+ */
1949
+ namespace?: string;
1950
+ serviceType: ServiceType;
1951
+ authenticationType: 'oauth2' | 'basic' | 'bearer' | 'searchParams' | 'oauth2Bearer' | 'custom' | 'aws' | 'google' | 'none' | 'unknown';
1952
+ authentication?: string;
1953
+ healthCheck?: ServiceHealthCheck;
1954
+ webhookId?: string;
1955
+ /**
1956
+ * Configuration options passed to and handled by the provider.
1957
+ */
1958
+ options?: {
1959
+ [k: string]: any;
1960
+ };
1961
+ }
1962
+ /**
1963
+ * Configuration for ping health checks.
1964
+ *
1965
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1966
+ * via the `definition` "serviceHealthCheck".
1967
+ */
1968
+ export interface ServiceHealthCheck {
1969
+ checkName: CheckName;
1970
+ endpoint?: Endpoint;
1971
+ requestMethod?: RequestMethod;
1972
+ requestHeaders?: RequestHeaders;
1973
+ requestSearchParams?: RequestSearchParams;
1974
+ requestBody?: RequestBody;
1975
+ requestBodyFormat?: RequestBodyFormat;
1976
+ requestTimeout?: RequestTimeout;
1977
+ healthyResponseStatusCode?: HealthyResponseStatusCode;
1978
+ triggers?: ServiceHealthCheckTrigger[];
1979
+ }
1980
+ /**
1981
+ * Any custom headers to set with the health check request.
1982
+ */
1983
+ export interface RequestHeaders {
1984
+ [k: string]: any;
1985
+ }
1986
+ /**
1987
+ * Any custom search params to set with the health check request.
1988
+ */
1989
+ export interface RequestSearchParams {
1990
+ [k: string]: any;
1991
+ }
1992
+ /**
1993
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
1994
+ * via the `definition` "agentMap".
1995
+ */
1996
+ export interface AgentMap {
1997
+ [k: string]: AgentJSON;
1998
+ }
1999
+ /**
2000
+ * An Agent is a configuration for an AI service such as a chat bot or a search engine.
2001
+ *
2002
+ * This interface was referenced by `AgentMap`'s JSON-Schema definition
2003
+ * via the `patternProperty` "^[0-9A-Za-z_]+$".
2004
+ *
2005
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2006
+ * via the `definition` "agent".
2007
+ */
2008
+ export interface AgentJSON {
2009
+ description?: string;
2010
+ systemPrompt?: string;
2011
+ api: AgentAPI;
2012
+ memory?: AgentMemory;
2013
+ start: AgentStart;
2014
+ states: AgentStates;
2015
+ guards?: AgentGuard[];
2016
+ historyStrategies?: HistoryStrategyMap;
2017
+ }
2018
+ /**
2019
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2020
+ * via the `definition` "agentApi".
2021
+ */
2022
+ export interface AgentAPI {
2023
+ inputs: AgentAPIInput[];
2024
+ }
2025
+ /**
2026
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2027
+ * via the `definition` "agentApiMutationInput".
2028
+ */
2029
+ export interface AgentAPIMutationInput {
2030
+ type: 'mutation';
2031
+ name: string;
2032
+ args: string;
2033
+ interactionTimeout?: InteractionTimeoutMilliseconds;
2034
+ }
2035
+ /**
2036
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2037
+ * via the `definition` "agentMemory".
2038
+ */
2039
+ export interface AgentMemory {
2040
+ sessionMemory: AgentSessionMemory;
2041
+ }
2042
+ /**
2043
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2044
+ * via the `definition` "agentSessionMemory".
2045
+ */
2046
+ export interface AgentSessionMemory {
2047
+ shape?: string;
2048
+ }
2049
+ /**
2050
+ * Configuration for the start of an agent's execution
2051
+ *
2052
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2053
+ * via the `definition` "agentStart".
2054
+ */
2055
+ export interface AgentStart {
2056
+ transitions: AgentTransitionSuspend[];
2057
+ }
2058
+ /**
2059
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2060
+ * via the `definition` "agentTransitionSuspend".
2061
+ */
2062
+ export interface AgentTransitionSuspend {
2063
+ type: 'suspend';
2064
+ destination: string;
2065
+ input: string;
2066
+ condition?: string;
2067
+ limit?: number;
2068
+ sessionMemory?: AgentStateSessionMemory;
2069
+ historyStrategy?: string;
2070
+ }
2071
+ /**
2072
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2073
+ * via the `definition` "agentStateSessionMemoryAssignment".
2074
+ */
2075
+ export interface AgentStateSessionMemoryAssignment {
2076
+ memoryPath?: string;
2077
+ expression: string;
2078
+ }
2079
+ /**
2080
+ * States that are traversed during the execution of an agent.
2081
+ *
2082
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2083
+ * via the `definition` "agentStateMap".
1849
2084
  */
1850
2085
  export interface AgentStates {
1851
2086
  [k: string]: AgentState;
@@ -1855,6 +2090,9 @@ export interface AgentStates {
1855
2090
  *
1856
2091
  * This interface was referenced by `AgentStates`'s JSON-Schema definition
1857
2092
  * via the `patternProperty` "^[0-9A-Za-z_]+$".
2093
+ *
2094
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2095
+ * via the `definition` "agentState".
1858
2096
  */
1859
2097
  export interface AgentState {
1860
2098
  name: string;
@@ -1862,6 +2100,10 @@ export interface AgentState {
1862
2100
  execution: AgentExecution;
1863
2101
  transitions?: AgentTransition[];
1864
2102
  }
2103
+ /**
2104
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2105
+ * via the `definition` "agentVariable".
2106
+ */
1865
2107
  export interface AgentVariable {
1866
2108
  name: string;
1867
2109
  /**
@@ -1869,15 +2111,27 @@ export interface AgentVariable {
1869
2111
  */
1870
2112
  steps: AgentVariableStep[];
1871
2113
  }
2114
+ /**
2115
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2116
+ * via the `definition` "agentVariableStep".
2117
+ */
1872
2118
  export interface AgentVariableStep {
1873
2119
  condition?: string;
1874
2120
  expression: string;
1875
2121
  }
2122
+ /**
2123
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2124
+ * via the `definition` "agentExecutionGraphql".
2125
+ */
1876
2126
  export interface AgentExecutionGraphQL {
1877
2127
  type: 'graphql';
1878
2128
  query: string;
1879
2129
  path?: string;
1880
2130
  }
2131
+ /**
2132
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2133
+ * via the `definition` "agentExecutionGenerate".
2134
+ */
1881
2135
  export interface AgentExecutionGenerate {
1882
2136
  type: 'generate';
1883
2137
  service: string;
@@ -1888,13 +2142,25 @@ export interface AgentExecutionGenerate {
1888
2142
  tools?: AgentToolConfig[];
1889
2143
  options?: AgentGenerateOptions;
1890
2144
  }
2145
+ /**
2146
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2147
+ * via the `definition` "agentAiStateInputArg".
2148
+ */
1891
2149
  export interface AgentAIStateInputArgument {
1892
2150
  type: 'arg';
1893
2151
  }
2152
+ /**
2153
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2154
+ * via the `definition` "agentAiStateInputTemplate".
2155
+ */
1894
2156
  export interface AgentAIStateInputTemplate {
1895
2157
  type: 'template';
1896
2158
  inputTemplate: string;
1897
2159
  }
2160
+ /**
2161
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2162
+ * via the `definition` "agentToolConfig".
2163
+ */
1898
2164
  export interface AgentToolConfig {
1899
2165
  name: string;
1900
2166
  ref: string;
@@ -1902,15 +2168,27 @@ export interface AgentToolConfig {
1902
2168
  args?: AgentToolConfigArg[];
1903
2169
  selectionSet?: string;
1904
2170
  }
2171
+ /**
2172
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2173
+ * via the `definition` "agentToolConfigArgAgent".
2174
+ */
1905
2175
  export interface AgentControlled {
1906
2176
  type: 'agent';
1907
2177
  argName: ToolArgumentName;
1908
2178
  }
2179
+ /**
2180
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2181
+ * via the `definition` "agentToolConfigArgVariable".
2182
+ */
1909
2183
  export interface VariableValue {
1910
2184
  type: 'variable';
1911
2185
  argName: ToolArgumentName1;
1912
2186
  variableName: StateVariableName;
1913
2187
  }
2188
+ /**
2189
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2190
+ * via the `definition` "agentGenerateOptions".
2191
+ */
1914
2192
  export interface AgentGenerateOptions {
1915
2193
  history?: History1;
1916
2194
  maxTokens?: MaximumTokens1;
@@ -1935,6 +2213,10 @@ export interface AgentGenerateOptions {
1935
2213
  removePropertyKeyPatterns?: RemovePropertyKeyPatterns;
1936
2214
  stripMarkdown?: StripMarkdown;
1937
2215
  }
2216
+ /**
2217
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2218
+ * via the `definition` "agentExecutionChat".
2219
+ */
1938
2220
  export interface AgentExecutionChat {
1939
2221
  type: 'chat';
1940
2222
  service: string;
@@ -1945,6 +2227,10 @@ export interface AgentExecutionChat {
1945
2227
  tools?: AgentToolConfig[];
1946
2228
  options?: AgentGenerateOptions;
1947
2229
  }
2230
+ /**
2231
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2232
+ * via the `definition` "agentTransitionImmediate".
2233
+ */
1948
2234
  export interface AgentTransitionImmediate {
1949
2235
  type: 'immediate';
1950
2236
  destination: string;
@@ -1953,15 +2239,26 @@ export interface AgentTransitionImmediate {
1953
2239
  sessionMemory?: AgentStateSessionMemory1;
1954
2240
  historyStrategy?: string;
1955
2241
  }
2242
+ /**
2243
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2244
+ * via the `definition` "agentGuard".
2245
+ */
1956
2246
  export interface AgentGuard {
1957
2247
  guardId: GuardID;
1958
2248
  }
2249
+ /**
2250
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2251
+ * via the `definition` "historyStrategyMap".
2252
+ */
1959
2253
  export interface HistoryStrategyMap {
1960
2254
  [k: string]: HistoryStrategy;
1961
2255
  }
1962
2256
  /**
1963
2257
  * This interface was referenced by `HistoryStrategyMap`'s JSON-Schema definition
1964
2258
  * via the `patternProperty` "^[0-9A-Za-z_]+$".
2259
+ *
2260
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2261
+ * via the `definition` "historyStrategy".
1965
2262
  */
1966
2263
  export interface HistoryStrategy {
1967
2264
  name: string;
@@ -1969,16 +2266,32 @@ export interface HistoryStrategy {
1969
2266
  filter?: HistoryStrategyFilter;
1970
2267
  transform: HistoryStrategyTransform;
1971
2268
  }
2269
+ /**
2270
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2271
+ * via the `definition` "historyStrategyFilter".
2272
+ */
1972
2273
  export interface HistoryStrategyFilter {
1973
2274
  toolCalls?: 'retain' | 'clear';
1974
2275
  }
2276
+ /**
2277
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2278
+ * via the `definition` "historyStrategyTransformNone".
2279
+ */
1975
2280
  export interface HistoryStrategyTransformNone {
1976
2281
  type: 'none';
1977
2282
  }
2283
+ /**
2284
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2285
+ * via the `definition` "historyStrategyTransformReplace".
2286
+ */
1978
2287
  export interface HistoryStrategyTransformReplace {
1979
2288
  type: 'replace';
1980
2289
  template: string;
1981
2290
  }
2291
+ /**
2292
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2293
+ * via the `definition` "historyStrategyTransformSummarize".
2294
+ */
1982
2295
  export interface HistoryStrategyTransformSummarize {
1983
2296
  type: 'generate';
1984
2297
  service: string;
@@ -1987,6 +2300,10 @@ export interface HistoryStrategyTransformSummarize {
1987
2300
  tools?: AgentToolConfig[];
1988
2301
  options?: AgentGenerateOptions;
1989
2302
  }
2303
+ /**
2304
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2305
+ * via the `definition` "guardMap".
2306
+ */
1990
2307
  export interface GuardMap {
1991
2308
  [k: string]: GuardJSON;
1992
2309
  }
@@ -1995,10 +2312,13 @@ export interface GuardMap {
1995
2312
  *
1996
2313
  * This interface was referenced by `GuardMap`'s JSON-Schema definition
1997
2314
  * via the `patternProperty` "^[0-9A-Za-z_]+$".
2315
+ *
2316
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2317
+ * via the `definition` "guard".
1998
2318
  */
1999
2319
  export interface GuardJSON {
2000
- name: Name;
2001
- description?: Description;
2320
+ name: Name1;
2321
+ description?: Description1;
2002
2322
  enabled?: Enabled;
2003
2323
  guardrailIdentifier?: GuardrailIdentifier;
2004
2324
  guardrailVersion?: GuardrailVersion;
@@ -2042,15 +2362,26 @@ export interface SensitiveInformationPolicy {
2042
2362
  export interface ContextualGroundingPolicy {
2043
2363
  filtersConfig: Filter1;
2044
2364
  }
2365
+ /**
2366
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2367
+ * via the `definition` "mcpConfig".
2368
+ */
2045
2369
  export interface MCPServerConfiguration {
2046
2370
  tools?: ToolMap;
2047
2371
  }
2372
+ /**
2373
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2374
+ * via the `definition` "toolMap".
2375
+ */
2048
2376
  export interface ToolMap {
2049
2377
  [k: string]: ToolJSON;
2050
2378
  }
2051
2379
  /**
2052
2380
  * This interface was referenced by `ToolMap`'s JSON-Schema definition
2053
2381
  * via the `patternProperty` "^[0-9A-Za-z_]+$".
2382
+ *
2383
+ * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2384
+ * via the `definition` "tool".
2054
2385
  */
2055
2386
  export interface ToolJSON {
2056
2387
  name: string;
@@ -2059,145 +2390,6 @@ export interface ToolJSON {
2059
2390
  args?: ToolArg[];
2060
2391
  selectionSet?: string;
2061
2392
  }
2062
- /**
2063
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2064
- * via the `definition` "formMap".
2065
- */
2066
- export interface FormMap {
2067
- [k: string]: FormsConfig;
2068
- }
2069
- /**
2070
- * This interface was referenced by `FormMap`'s JSON-Schema definition
2071
- * via the `patternProperty` "[0-9A-Za-z_-]+".
2072
- *
2073
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2074
- * via the `definition` "formsConfig".
2075
- */
2076
- export interface FormsConfig {
2077
- default: FormConfig;
2078
- [k: string]: FormConfig;
2079
- }
2080
- /**
2081
- * This interface was referenced by `FormsConfig`'s JSON-Schema definition
2082
- * via the `patternProperty` "[0-9A-Za-z_-]+".
2083
- *
2084
- * This interface was referenced by `undefined`'s JSON-Schema definition
2085
- * via the `patternProperty` "[0-9A-Za-z_-]+".
2086
- *
2087
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2088
- * via the `definition` "formConfig".
2089
- */
2090
- export interface FormConfig {
2091
- [k: string]: any;
2092
- }
2093
- /**
2094
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2095
- * via the `definition` "workflowMap".
2096
- */
2097
- export interface WorkflowMap {
2098
- [k: string]: Workflow;
2099
- }
2100
- /**
2101
- * This interface was referenced by `WorkflowMap`'s JSON-Schema definition
2102
- * via the `patternProperty` "[0-9A-Za-z_-]+".
2103
- *
2104
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2105
- * via the `definition` "workflow".
2106
- */
2107
- export interface Workflow {
2108
- /**
2109
- * machine-readable id
2110
- */
2111
- name: string;
2112
- title: WorkflowName;
2113
- steps: Steps;
2114
- [k: string]: any;
2115
- }
2116
- /**
2117
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2118
- * via the `definition` "workflowStep".
2119
- */
2120
- export interface WorkflowStep {
2121
- name: Name1;
2122
- title: Title;
2123
- description?: Description1;
2124
- color: Color;
2125
- live: Live;
2126
- key: Key;
2127
- }
2128
- /**
2129
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2130
- * via the `definition` "storedServiceMap".
2131
- */
2132
- export interface ServiceMapJSON {
2133
- [k: string]: ServiceConfigJSON;
2134
- }
2135
- /**
2136
- * This interface was referenced by `ServiceMapJSON`'s JSON-Schema definition
2137
- * via the `patternProperty` "[0-9A-Za-z_-]+".
2138
- *
2139
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2140
- * via the `definition` "storedServiceConfig".
2141
- */
2142
- export interface ServiceConfigJSON {
2143
- /**
2144
- * Machine-readable identifier, should typically be the same as the property name on the services object.
2145
- */
2146
- id: string;
2147
- /**
2148
- * Human-readable name for this service.
2149
- */
2150
- title: string;
2151
- /**
2152
- * The service provider id.
2153
- */
2154
- provider: string;
2155
- /**
2156
- * A namespace to use for the imported types tied to this service.
2157
- */
2158
- namespace?: string;
2159
- serviceType: ServiceType;
2160
- authenticationType: 'oauth2' | 'basic' | 'bearer' | 'searchParams' | 'oauth2Bearer' | 'custom' | 'aws' | 'google' | 'none' | 'unknown';
2161
- authentication?: string;
2162
- healthCheck?: ServiceHealthCheck;
2163
- webhookId?: string;
2164
- /**
2165
- * Configuration options passed to and handled by the provider.
2166
- */
2167
- options?: {
2168
- [k: string]: any;
2169
- };
2170
- }
2171
- /**
2172
- * Configuration for ping health checks.
2173
- *
2174
- * This interface was referenced by `ProjectSchemaJSON`'s JSON-Schema
2175
- * via the `definition` "serviceHealthCheck".
2176
- */
2177
- export interface ServiceHealthCheck {
2178
- checkName: CheckName;
2179
- endpoint?: Endpoint;
2180
- requestMethod?: RequestMethod;
2181
- requestHeaders?: RequestHeaders;
2182
- requestSearchParams?: RequestSearchParams;
2183
- requestBody?: RequestBody;
2184
- requestBodyFormat?: RequestBodyFormat;
2185
- requestTimeout?: RequestTimeout;
2186
- healthyResponseStatusCode?: HealthyResponseStatusCode;
2187
- triggers?: ServiceHealthCheckTrigger[];
2188
- }
2189
- /**
2190
- * Any custom headers to set with the health check request.
2191
- */
2192
- export interface RequestHeaders {
2193
- [k: string]: any;
2194
- }
2195
- /**
2196
- * Any custom search params to set with the health check request.
2197
- */
2198
- export interface RequestSearchParams {
2199
- [k: string]: any;
2200
- }
2201
2393
  /**
2202
2394
  * All possible options for the more specific ParameterSerializeStyleOptions types.
2203
2395
  *