@uniformdev/mesh-sdk 20.74.2 → 20.74.3

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 (6) hide show
  1. package/dist/index.d.mts +82 -3
  2. package/dist/index.d.ts +82 -3
  3. package/dist/index.esm.js +1 -1
  4. package/dist/index.js +1 -1
  5. package/dist/index.mjs +1 -1
  6. package/package.json +6 -6
package/dist/index.d.mts CHANGED
@@ -244,25 +244,40 @@ interface paths$1 {
244
244
  content: {
245
245
  "application/json": {
246
246
  results: {
247
+ /** @description Optional reference to the JSON schema used to validate this manifest (for editor/agent tooling). Ignored by Uniform. */
248
+ $schema?: string;
249
+ /** @description Integration public id. Do not change after registering. Must be unique and lowercase alphanumeric with hyphens/underscores. */
247
250
  type: string;
251
+ /** @description Display name used in the UI for the integration. */
248
252
  displayName: string;
253
+ /** @description URL to the integration's logo icon (larger, used on listing). */
249
254
  logoIconUrl?: string;
255
+ /** @description URL to the integration's badge icon (small, round, used as a badge in the UI). */
250
256
  badgeIconUrl?: string;
251
- /** @enum {string} */
257
+ /**
258
+ * @description Category of the integration.
259
+ * @enum {string}
260
+ */
252
261
  category?: "analytics" | "cdn" | "classic" | "commerce" | "content" | "comingSoon" | "data" | "deprecated" | "email" | "framework" | "search" | "starters" | "translation" | "uniform" | "ai" | "unknown";
253
262
  public?: boolean;
263
+ /** @description List of permissions to access sensitive data or perform certain actions. */
254
264
  scopes?: string[];
265
+ /** @description When true, this integration can request delegation tokens to call Uniform APIs on behalf of the current user. */
255
266
  identityDelegation?: boolean;
256
267
  /** Format: uuid */
257
268
  integrationId?: string;
258
269
  hasAppSecret?: boolean;
270
+ /** @description Prefix for location URL paths. When set, location URLs may be relative to it; otherwise full URLs are required. */
259
271
  baseLocationUrl?: string;
272
+ /** @description Locations where the integration is exposed within the Uniform application. */
260
273
  locations: {
274
+ /** @description Locations used during installation of the integration. */
261
275
  install?: {
262
276
  description?: string[];
263
277
  informationUrl?: string;
264
278
  canvasPackageUrl?: string;
265
279
  };
280
+ /** @description Settings location for configuring the integration. */
266
281
  settings?: {
267
282
  url: string;
268
283
  locations?: {
@@ -277,6 +292,7 @@ interface paths$1 {
277
292
  };
278
293
  };
279
294
  };
295
+ /** @description Locations within Uniform Canvas for the integration to extend. */
280
296
  canvas?: {
281
297
  parameterTypes?: {
282
298
  type: string;
@@ -347,6 +363,7 @@ interface paths$1 {
347
363
  };
348
364
  };
349
365
  };
366
+ /** @description Data Connector(s) provided by the integration. */
350
367
  dataConnectors?: {
351
368
  type: string;
352
369
  displayName: string;
@@ -407,6 +424,7 @@ interface paths$1 {
407
424
  };
408
425
  badgeIconUrl?: string;
409
426
  }[];
427
+ /** @description Asset Library provided by the integration. */
410
428
  assetLibrary?: {
411
429
  assetLibraryUrl: string;
412
430
  assetParameterUrl: string;
@@ -427,6 +445,7 @@ interface paths$1 {
427
445
  singleAssetArchetypeId: string;
428
446
  };
429
447
  };
448
+ /** @description Deprecated. Use `assetLibrary` instead. */
430
449
  unstable_assetLibrary?: {
431
450
  url: string;
432
451
  dynamicAssets?: {
@@ -435,6 +454,7 @@ interface paths$1 {
435
454
  singleAssetArchetypeId: string;
436
455
  };
437
456
  };
457
+ /** @description AI configuration for the integration. */
438
458
  ai?: {
439
459
  generateUrl: string;
440
460
  metadataUrl?: string;
@@ -456,10 +476,12 @@ interface paths$1 {
456
476
  parameterTypes: string[];
457
477
  }[];
458
478
  };
479
+ /** @description Deprecated. Use `ai` instead. */
459
480
  unstable_ai?: {
460
481
  generateUrl: string;
461
482
  metadataUrl?: string;
462
483
  };
484
+ /** @description Deprecated/experimental. AI agents function-calling configuration. */
463
485
  aiAgents?: {
464
486
  functionCalling?: {
465
487
  handlerUrl: string;
@@ -477,6 +499,7 @@ interface paths$1 {
477
499
  }[];
478
500
  };
479
501
  };
502
+ /** @description Deprecated. Will be removed shortly. */
480
503
  tools?: {
481
504
  id: string;
482
505
  name: string;
@@ -487,6 +510,7 @@ interface paths$1 {
487
510
  teamAdminRequired?: true;
488
511
  };
489
512
  }[];
513
+ /** @description Project-level tools provided by the integration. */
490
514
  projectTools?: {
491
515
  id: string;
492
516
  name: string;
@@ -497,6 +521,7 @@ interface paths$1 {
497
521
  teamAdminRequired?: true;
498
522
  };
499
523
  }[];
524
+ /** @description Dashboard-level tools provided by the integration. */
500
525
  dashboardTools?: {
501
526
  id: string;
502
527
  name: string;
@@ -508,6 +533,7 @@ interface paths$1 {
508
533
  };
509
534
  }[];
510
535
  };
536
+ /** @description Deprecated. Use `locations.ai.prompts` instead. */
511
537
  unstable_prompts?: {
512
538
  id: string;
513
539
  name: string;
@@ -550,21 +576,36 @@ interface paths$1 {
550
576
  /** @description The team ID */
551
577
  teamId: string;
552
578
  data: {
579
+ /** @description Optional reference to the JSON schema used to validate this manifest (for editor/agent tooling). Ignored by Uniform. */
580
+ $schema?: string;
581
+ /** @description Integration public id. Do not change after registering. Must be unique and lowercase alphanumeric with hyphens/underscores. */
553
582
  type: string;
583
+ /** @description Display name used in the UI for the integration. */
554
584
  displayName: string;
585
+ /** @description URL to the integration's logo icon (larger, used on listing). */
555
586
  logoIconUrl?: string;
587
+ /** @description URL to the integration's badge icon (small, round, used as a badge in the UI). */
556
588
  badgeIconUrl?: string;
557
- /** @enum {string} */
589
+ /**
590
+ * @description Category of the integration.
591
+ * @enum {string}
592
+ */
558
593
  category?: "analytics" | "cdn" | "classic" | "commerce" | "content" | "comingSoon" | "data" | "deprecated" | "email" | "framework" | "search" | "starters" | "translation" | "uniform" | "ai" | "unknown";
594
+ /** @description List of permissions to access sensitive data or perform certain actions. */
559
595
  scopes?: string[];
596
+ /** @description When true, this integration can request delegation tokens to call Uniform APIs on behalf of the current user. */
560
597
  identityDelegation?: boolean;
598
+ /** @description Prefix for location URL paths. When set, location URLs may be relative to it; otherwise full URLs are required. */
561
599
  baseLocationUrl?: string;
600
+ /** @description Locations where the integration is exposed within the Uniform application. */
562
601
  locations: {
602
+ /** @description Locations used during installation of the integration. */
563
603
  install?: {
564
604
  description?: string[];
565
605
  informationUrl?: string;
566
606
  canvasPackageUrl?: string;
567
607
  };
608
+ /** @description Settings location for configuring the integration. */
568
609
  settings?: {
569
610
  url: string;
570
611
  locations?: {
@@ -579,6 +620,7 @@ interface paths$1 {
579
620
  };
580
621
  };
581
622
  };
623
+ /** @description Locations within Uniform Canvas for the integration to extend. */
582
624
  canvas?: {
583
625
  parameterTypes?: {
584
626
  type: string;
@@ -649,6 +691,7 @@ interface paths$1 {
649
691
  };
650
692
  };
651
693
  };
694
+ /** @description Data Connector(s) provided by the integration. */
652
695
  dataConnectors?: {
653
696
  type: string;
654
697
  displayName: string;
@@ -709,6 +752,7 @@ interface paths$1 {
709
752
  };
710
753
  badgeIconUrl?: string;
711
754
  }[];
755
+ /** @description Asset Library provided by the integration. */
712
756
  assetLibrary?: {
713
757
  assetLibraryUrl: string;
714
758
  assetParameterUrl: string;
@@ -729,6 +773,7 @@ interface paths$1 {
729
773
  singleAssetArchetypeId: string;
730
774
  };
731
775
  };
776
+ /** @description Deprecated. Use `assetLibrary` instead. */
732
777
  unstable_assetLibrary?: {
733
778
  url: string;
734
779
  dynamicAssets?: {
@@ -737,6 +782,7 @@ interface paths$1 {
737
782
  singleAssetArchetypeId: string;
738
783
  };
739
784
  };
785
+ /** @description AI configuration for the integration. */
740
786
  ai?: {
741
787
  generateUrl: string;
742
788
  metadataUrl?: string;
@@ -758,10 +804,12 @@ interface paths$1 {
758
804
  parameterTypes: string[];
759
805
  }[];
760
806
  };
807
+ /** @description Deprecated. Use `ai` instead. */
761
808
  unstable_ai?: {
762
809
  generateUrl: string;
763
810
  metadataUrl?: string;
764
811
  };
812
+ /** @description Deprecated/experimental. AI agents function-calling configuration. */
765
813
  aiAgents?: {
766
814
  functionCalling?: {
767
815
  handlerUrl: string;
@@ -779,6 +827,7 @@ interface paths$1 {
779
827
  }[];
780
828
  };
781
829
  };
830
+ /** @description Deprecated. Will be removed shortly. */
782
831
  tools?: {
783
832
  id: string;
784
833
  name: string;
@@ -789,6 +838,7 @@ interface paths$1 {
789
838
  teamAdminRequired?: true;
790
839
  };
791
840
  }[];
841
+ /** @description Project-level tools provided by the integration. */
792
842
  projectTools?: {
793
843
  id: string;
794
844
  name: string;
@@ -799,6 +849,7 @@ interface paths$1 {
799
849
  teamAdminRequired?: true;
800
850
  };
801
851
  }[];
852
+ /** @description Dashboard-level tools provided by the integration. */
802
853
  dashboardTools?: {
803
854
  id: string;
804
855
  name: string;
@@ -810,6 +861,7 @@ interface paths$1 {
810
861
  };
811
862
  }[];
812
863
  };
864
+ /** @description Deprecated. Use `locations.ai.prompts` instead. */
813
865
  unstable_prompts?: {
814
866
  id: string;
815
867
  name: string;
@@ -839,14 +891,25 @@ interface paths$1 {
839
891
  };
840
892
  content: {
841
893
  "application/json": {
894
+ /** @description Optional reference to the JSON schema used to validate this manifest (for editor/agent tooling). Ignored by Uniform. */
895
+ $schema?: string;
896
+ /** @description Integration public id. Do not change after registering. Must be unique and lowercase alphanumeric with hyphens/underscores. */
842
897
  type: string;
898
+ /** @description Display name used in the UI for the integration. */
843
899
  displayName: string;
900
+ /** @description URL to the integration's logo icon (larger, used on listing). */
844
901
  logoIconUrl?: string;
902
+ /** @description URL to the integration's badge icon (small, round, used as a badge in the UI). */
845
903
  badgeIconUrl?: string;
846
- /** @enum {string} */
904
+ /**
905
+ * @description Category of the integration.
906
+ * @enum {string}
907
+ */
847
908
  category?: "analytics" | "cdn" | "classic" | "commerce" | "content" | "comingSoon" | "data" | "deprecated" | "email" | "framework" | "search" | "starters" | "translation" | "uniform" | "ai" | "unknown";
848
909
  public?: boolean;
910
+ /** @description List of permissions to access sensitive data or perform certain actions. */
849
911
  scopes?: string[];
912
+ /** @description When true, this integration can request delegation tokens to call Uniform APIs on behalf of the current user. */
850
913
  identityDelegation?: boolean;
851
914
  /**
852
915
  * Format: uuid
@@ -854,13 +917,17 @@ interface paths$1 {
854
917
  */
855
918
  integrationId: string;
856
919
  hasAppSecret?: boolean;
920
+ /** @description Prefix for location URL paths. When set, location URLs may be relative to it; otherwise full URLs are required. */
857
921
  baseLocationUrl?: string;
922
+ /** @description Locations where the integration is exposed within the Uniform application. */
858
923
  locations: {
924
+ /** @description Locations used during installation of the integration. */
859
925
  install?: {
860
926
  description?: string[];
861
927
  informationUrl?: string;
862
928
  canvasPackageUrl?: string;
863
929
  };
930
+ /** @description Settings location for configuring the integration. */
864
931
  settings?: {
865
932
  url: string;
866
933
  locations?: {
@@ -875,6 +942,7 @@ interface paths$1 {
875
942
  };
876
943
  };
877
944
  };
945
+ /** @description Locations within Uniform Canvas for the integration to extend. */
878
946
  canvas?: {
879
947
  parameterTypes?: {
880
948
  type: string;
@@ -945,6 +1013,7 @@ interface paths$1 {
945
1013
  };
946
1014
  };
947
1015
  };
1016
+ /** @description Data Connector(s) provided by the integration. */
948
1017
  dataConnectors?: {
949
1018
  type: string;
950
1019
  displayName: string;
@@ -1005,6 +1074,7 @@ interface paths$1 {
1005
1074
  };
1006
1075
  badgeIconUrl?: string;
1007
1076
  }[];
1077
+ /** @description Asset Library provided by the integration. */
1008
1078
  assetLibrary?: {
1009
1079
  assetLibraryUrl: string;
1010
1080
  assetParameterUrl: string;
@@ -1025,6 +1095,7 @@ interface paths$1 {
1025
1095
  singleAssetArchetypeId: string;
1026
1096
  };
1027
1097
  };
1098
+ /** @description Deprecated. Use `assetLibrary` instead. */
1028
1099
  unstable_assetLibrary?: {
1029
1100
  url: string;
1030
1101
  dynamicAssets?: {
@@ -1033,6 +1104,7 @@ interface paths$1 {
1033
1104
  singleAssetArchetypeId: string;
1034
1105
  };
1035
1106
  };
1107
+ /** @description AI configuration for the integration. */
1036
1108
  ai?: {
1037
1109
  generateUrl: string;
1038
1110
  metadataUrl?: string;
@@ -1054,10 +1126,12 @@ interface paths$1 {
1054
1126
  parameterTypes: string[];
1055
1127
  }[];
1056
1128
  };
1129
+ /** @description Deprecated. Use `ai` instead. */
1057
1130
  unstable_ai?: {
1058
1131
  generateUrl: string;
1059
1132
  metadataUrl?: string;
1060
1133
  };
1134
+ /** @description Deprecated/experimental. AI agents function-calling configuration. */
1061
1135
  aiAgents?: {
1062
1136
  functionCalling?: {
1063
1137
  handlerUrl: string;
@@ -1075,6 +1149,7 @@ interface paths$1 {
1075
1149
  }[];
1076
1150
  };
1077
1151
  };
1152
+ /** @description Deprecated. Will be removed shortly. */
1078
1153
  tools?: {
1079
1154
  id: string;
1080
1155
  name: string;
@@ -1085,6 +1160,7 @@ interface paths$1 {
1085
1160
  teamAdminRequired?: true;
1086
1161
  };
1087
1162
  }[];
1163
+ /** @description Project-level tools provided by the integration. */
1088
1164
  projectTools?: {
1089
1165
  id: string;
1090
1166
  name: string;
@@ -1095,6 +1171,7 @@ interface paths$1 {
1095
1171
  teamAdminRequired?: true;
1096
1172
  };
1097
1173
  }[];
1174
+ /** @description Dashboard-level tools provided by the integration. */
1098
1175
  dashboardTools?: {
1099
1176
  id: string;
1100
1177
  name: string;
@@ -1106,6 +1183,7 @@ interface paths$1 {
1106
1183
  };
1107
1184
  }[];
1108
1185
  };
1186
+ /** @description Deprecated. Use `locations.ai.prompts` instead. */
1109
1187
  unstable_prompts?: {
1110
1188
  id: string;
1111
1189
  name: string;
@@ -1503,6 +1581,7 @@ declare class IntegrationDefinitionClient extends ApiClient<DefClientOptions> {
1503
1581
  get(options?: Omit<IntegrationDefinitionGetParameters, 'teamId'>): Promise<IntegrationDefinitionGetResponse>;
1504
1582
  /** Creates or updates a mesh app definition on a team. Identity-delegation credentials must be minted separately via {@link rotateCredential}. */
1505
1583
  upsert(body: Omit<IntegrationDefinitionPutParameters, 'teamId'>): Promise<{
1584
+ $schema?: string;
1506
1585
  type: string;
1507
1586
  displayName: string;
1508
1587
  logoIconUrl?: string;
package/dist/index.d.ts CHANGED
@@ -244,25 +244,40 @@ interface paths$1 {
244
244
  content: {
245
245
  "application/json": {
246
246
  results: {
247
+ /** @description Optional reference to the JSON schema used to validate this manifest (for editor/agent tooling). Ignored by Uniform. */
248
+ $schema?: string;
249
+ /** @description Integration public id. Do not change after registering. Must be unique and lowercase alphanumeric with hyphens/underscores. */
247
250
  type: string;
251
+ /** @description Display name used in the UI for the integration. */
248
252
  displayName: string;
253
+ /** @description URL to the integration's logo icon (larger, used on listing). */
249
254
  logoIconUrl?: string;
255
+ /** @description URL to the integration's badge icon (small, round, used as a badge in the UI). */
250
256
  badgeIconUrl?: string;
251
- /** @enum {string} */
257
+ /**
258
+ * @description Category of the integration.
259
+ * @enum {string}
260
+ */
252
261
  category?: "analytics" | "cdn" | "classic" | "commerce" | "content" | "comingSoon" | "data" | "deprecated" | "email" | "framework" | "search" | "starters" | "translation" | "uniform" | "ai" | "unknown";
253
262
  public?: boolean;
263
+ /** @description List of permissions to access sensitive data or perform certain actions. */
254
264
  scopes?: string[];
265
+ /** @description When true, this integration can request delegation tokens to call Uniform APIs on behalf of the current user. */
255
266
  identityDelegation?: boolean;
256
267
  /** Format: uuid */
257
268
  integrationId?: string;
258
269
  hasAppSecret?: boolean;
270
+ /** @description Prefix for location URL paths. When set, location URLs may be relative to it; otherwise full URLs are required. */
259
271
  baseLocationUrl?: string;
272
+ /** @description Locations where the integration is exposed within the Uniform application. */
260
273
  locations: {
274
+ /** @description Locations used during installation of the integration. */
261
275
  install?: {
262
276
  description?: string[];
263
277
  informationUrl?: string;
264
278
  canvasPackageUrl?: string;
265
279
  };
280
+ /** @description Settings location for configuring the integration. */
266
281
  settings?: {
267
282
  url: string;
268
283
  locations?: {
@@ -277,6 +292,7 @@ interface paths$1 {
277
292
  };
278
293
  };
279
294
  };
295
+ /** @description Locations within Uniform Canvas for the integration to extend. */
280
296
  canvas?: {
281
297
  parameterTypes?: {
282
298
  type: string;
@@ -347,6 +363,7 @@ interface paths$1 {
347
363
  };
348
364
  };
349
365
  };
366
+ /** @description Data Connector(s) provided by the integration. */
350
367
  dataConnectors?: {
351
368
  type: string;
352
369
  displayName: string;
@@ -407,6 +424,7 @@ interface paths$1 {
407
424
  };
408
425
  badgeIconUrl?: string;
409
426
  }[];
427
+ /** @description Asset Library provided by the integration. */
410
428
  assetLibrary?: {
411
429
  assetLibraryUrl: string;
412
430
  assetParameterUrl: string;
@@ -427,6 +445,7 @@ interface paths$1 {
427
445
  singleAssetArchetypeId: string;
428
446
  };
429
447
  };
448
+ /** @description Deprecated. Use `assetLibrary` instead. */
430
449
  unstable_assetLibrary?: {
431
450
  url: string;
432
451
  dynamicAssets?: {
@@ -435,6 +454,7 @@ interface paths$1 {
435
454
  singleAssetArchetypeId: string;
436
455
  };
437
456
  };
457
+ /** @description AI configuration for the integration. */
438
458
  ai?: {
439
459
  generateUrl: string;
440
460
  metadataUrl?: string;
@@ -456,10 +476,12 @@ interface paths$1 {
456
476
  parameterTypes: string[];
457
477
  }[];
458
478
  };
479
+ /** @description Deprecated. Use `ai` instead. */
459
480
  unstable_ai?: {
460
481
  generateUrl: string;
461
482
  metadataUrl?: string;
462
483
  };
484
+ /** @description Deprecated/experimental. AI agents function-calling configuration. */
463
485
  aiAgents?: {
464
486
  functionCalling?: {
465
487
  handlerUrl: string;
@@ -477,6 +499,7 @@ interface paths$1 {
477
499
  }[];
478
500
  };
479
501
  };
502
+ /** @description Deprecated. Will be removed shortly. */
480
503
  tools?: {
481
504
  id: string;
482
505
  name: string;
@@ -487,6 +510,7 @@ interface paths$1 {
487
510
  teamAdminRequired?: true;
488
511
  };
489
512
  }[];
513
+ /** @description Project-level tools provided by the integration. */
490
514
  projectTools?: {
491
515
  id: string;
492
516
  name: string;
@@ -497,6 +521,7 @@ interface paths$1 {
497
521
  teamAdminRequired?: true;
498
522
  };
499
523
  }[];
524
+ /** @description Dashboard-level tools provided by the integration. */
500
525
  dashboardTools?: {
501
526
  id: string;
502
527
  name: string;
@@ -508,6 +533,7 @@ interface paths$1 {
508
533
  };
509
534
  }[];
510
535
  };
536
+ /** @description Deprecated. Use `locations.ai.prompts` instead. */
511
537
  unstable_prompts?: {
512
538
  id: string;
513
539
  name: string;
@@ -550,21 +576,36 @@ interface paths$1 {
550
576
  /** @description The team ID */
551
577
  teamId: string;
552
578
  data: {
579
+ /** @description Optional reference to the JSON schema used to validate this manifest (for editor/agent tooling). Ignored by Uniform. */
580
+ $schema?: string;
581
+ /** @description Integration public id. Do not change after registering. Must be unique and lowercase alphanumeric with hyphens/underscores. */
553
582
  type: string;
583
+ /** @description Display name used in the UI for the integration. */
554
584
  displayName: string;
585
+ /** @description URL to the integration's logo icon (larger, used on listing). */
555
586
  logoIconUrl?: string;
587
+ /** @description URL to the integration's badge icon (small, round, used as a badge in the UI). */
556
588
  badgeIconUrl?: string;
557
- /** @enum {string} */
589
+ /**
590
+ * @description Category of the integration.
591
+ * @enum {string}
592
+ */
558
593
  category?: "analytics" | "cdn" | "classic" | "commerce" | "content" | "comingSoon" | "data" | "deprecated" | "email" | "framework" | "search" | "starters" | "translation" | "uniform" | "ai" | "unknown";
594
+ /** @description List of permissions to access sensitive data or perform certain actions. */
559
595
  scopes?: string[];
596
+ /** @description When true, this integration can request delegation tokens to call Uniform APIs on behalf of the current user. */
560
597
  identityDelegation?: boolean;
598
+ /** @description Prefix for location URL paths. When set, location URLs may be relative to it; otherwise full URLs are required. */
561
599
  baseLocationUrl?: string;
600
+ /** @description Locations where the integration is exposed within the Uniform application. */
562
601
  locations: {
602
+ /** @description Locations used during installation of the integration. */
563
603
  install?: {
564
604
  description?: string[];
565
605
  informationUrl?: string;
566
606
  canvasPackageUrl?: string;
567
607
  };
608
+ /** @description Settings location for configuring the integration. */
568
609
  settings?: {
569
610
  url: string;
570
611
  locations?: {
@@ -579,6 +620,7 @@ interface paths$1 {
579
620
  };
580
621
  };
581
622
  };
623
+ /** @description Locations within Uniform Canvas for the integration to extend. */
582
624
  canvas?: {
583
625
  parameterTypes?: {
584
626
  type: string;
@@ -649,6 +691,7 @@ interface paths$1 {
649
691
  };
650
692
  };
651
693
  };
694
+ /** @description Data Connector(s) provided by the integration. */
652
695
  dataConnectors?: {
653
696
  type: string;
654
697
  displayName: string;
@@ -709,6 +752,7 @@ interface paths$1 {
709
752
  };
710
753
  badgeIconUrl?: string;
711
754
  }[];
755
+ /** @description Asset Library provided by the integration. */
712
756
  assetLibrary?: {
713
757
  assetLibraryUrl: string;
714
758
  assetParameterUrl: string;
@@ -729,6 +773,7 @@ interface paths$1 {
729
773
  singleAssetArchetypeId: string;
730
774
  };
731
775
  };
776
+ /** @description Deprecated. Use `assetLibrary` instead. */
732
777
  unstable_assetLibrary?: {
733
778
  url: string;
734
779
  dynamicAssets?: {
@@ -737,6 +782,7 @@ interface paths$1 {
737
782
  singleAssetArchetypeId: string;
738
783
  };
739
784
  };
785
+ /** @description AI configuration for the integration. */
740
786
  ai?: {
741
787
  generateUrl: string;
742
788
  metadataUrl?: string;
@@ -758,10 +804,12 @@ interface paths$1 {
758
804
  parameterTypes: string[];
759
805
  }[];
760
806
  };
807
+ /** @description Deprecated. Use `ai` instead. */
761
808
  unstable_ai?: {
762
809
  generateUrl: string;
763
810
  metadataUrl?: string;
764
811
  };
812
+ /** @description Deprecated/experimental. AI agents function-calling configuration. */
765
813
  aiAgents?: {
766
814
  functionCalling?: {
767
815
  handlerUrl: string;
@@ -779,6 +827,7 @@ interface paths$1 {
779
827
  }[];
780
828
  };
781
829
  };
830
+ /** @description Deprecated. Will be removed shortly. */
782
831
  tools?: {
783
832
  id: string;
784
833
  name: string;
@@ -789,6 +838,7 @@ interface paths$1 {
789
838
  teamAdminRequired?: true;
790
839
  };
791
840
  }[];
841
+ /** @description Project-level tools provided by the integration. */
792
842
  projectTools?: {
793
843
  id: string;
794
844
  name: string;
@@ -799,6 +849,7 @@ interface paths$1 {
799
849
  teamAdminRequired?: true;
800
850
  };
801
851
  }[];
852
+ /** @description Dashboard-level tools provided by the integration. */
802
853
  dashboardTools?: {
803
854
  id: string;
804
855
  name: string;
@@ -810,6 +861,7 @@ interface paths$1 {
810
861
  };
811
862
  }[];
812
863
  };
864
+ /** @description Deprecated. Use `locations.ai.prompts` instead. */
813
865
  unstable_prompts?: {
814
866
  id: string;
815
867
  name: string;
@@ -839,14 +891,25 @@ interface paths$1 {
839
891
  };
840
892
  content: {
841
893
  "application/json": {
894
+ /** @description Optional reference to the JSON schema used to validate this manifest (for editor/agent tooling). Ignored by Uniform. */
895
+ $schema?: string;
896
+ /** @description Integration public id. Do not change after registering. Must be unique and lowercase alphanumeric with hyphens/underscores. */
842
897
  type: string;
898
+ /** @description Display name used in the UI for the integration. */
843
899
  displayName: string;
900
+ /** @description URL to the integration's logo icon (larger, used on listing). */
844
901
  logoIconUrl?: string;
902
+ /** @description URL to the integration's badge icon (small, round, used as a badge in the UI). */
845
903
  badgeIconUrl?: string;
846
- /** @enum {string} */
904
+ /**
905
+ * @description Category of the integration.
906
+ * @enum {string}
907
+ */
847
908
  category?: "analytics" | "cdn" | "classic" | "commerce" | "content" | "comingSoon" | "data" | "deprecated" | "email" | "framework" | "search" | "starters" | "translation" | "uniform" | "ai" | "unknown";
848
909
  public?: boolean;
910
+ /** @description List of permissions to access sensitive data or perform certain actions. */
849
911
  scopes?: string[];
912
+ /** @description When true, this integration can request delegation tokens to call Uniform APIs on behalf of the current user. */
850
913
  identityDelegation?: boolean;
851
914
  /**
852
915
  * Format: uuid
@@ -854,13 +917,17 @@ interface paths$1 {
854
917
  */
855
918
  integrationId: string;
856
919
  hasAppSecret?: boolean;
920
+ /** @description Prefix for location URL paths. When set, location URLs may be relative to it; otherwise full URLs are required. */
857
921
  baseLocationUrl?: string;
922
+ /** @description Locations where the integration is exposed within the Uniform application. */
858
923
  locations: {
924
+ /** @description Locations used during installation of the integration. */
859
925
  install?: {
860
926
  description?: string[];
861
927
  informationUrl?: string;
862
928
  canvasPackageUrl?: string;
863
929
  };
930
+ /** @description Settings location for configuring the integration. */
864
931
  settings?: {
865
932
  url: string;
866
933
  locations?: {
@@ -875,6 +942,7 @@ interface paths$1 {
875
942
  };
876
943
  };
877
944
  };
945
+ /** @description Locations within Uniform Canvas for the integration to extend. */
878
946
  canvas?: {
879
947
  parameterTypes?: {
880
948
  type: string;
@@ -945,6 +1013,7 @@ interface paths$1 {
945
1013
  };
946
1014
  };
947
1015
  };
1016
+ /** @description Data Connector(s) provided by the integration. */
948
1017
  dataConnectors?: {
949
1018
  type: string;
950
1019
  displayName: string;
@@ -1005,6 +1074,7 @@ interface paths$1 {
1005
1074
  };
1006
1075
  badgeIconUrl?: string;
1007
1076
  }[];
1077
+ /** @description Asset Library provided by the integration. */
1008
1078
  assetLibrary?: {
1009
1079
  assetLibraryUrl: string;
1010
1080
  assetParameterUrl: string;
@@ -1025,6 +1095,7 @@ interface paths$1 {
1025
1095
  singleAssetArchetypeId: string;
1026
1096
  };
1027
1097
  };
1098
+ /** @description Deprecated. Use `assetLibrary` instead. */
1028
1099
  unstable_assetLibrary?: {
1029
1100
  url: string;
1030
1101
  dynamicAssets?: {
@@ -1033,6 +1104,7 @@ interface paths$1 {
1033
1104
  singleAssetArchetypeId: string;
1034
1105
  };
1035
1106
  };
1107
+ /** @description AI configuration for the integration. */
1036
1108
  ai?: {
1037
1109
  generateUrl: string;
1038
1110
  metadataUrl?: string;
@@ -1054,10 +1126,12 @@ interface paths$1 {
1054
1126
  parameterTypes: string[];
1055
1127
  }[];
1056
1128
  };
1129
+ /** @description Deprecated. Use `ai` instead. */
1057
1130
  unstable_ai?: {
1058
1131
  generateUrl: string;
1059
1132
  metadataUrl?: string;
1060
1133
  };
1134
+ /** @description Deprecated/experimental. AI agents function-calling configuration. */
1061
1135
  aiAgents?: {
1062
1136
  functionCalling?: {
1063
1137
  handlerUrl: string;
@@ -1075,6 +1149,7 @@ interface paths$1 {
1075
1149
  }[];
1076
1150
  };
1077
1151
  };
1152
+ /** @description Deprecated. Will be removed shortly. */
1078
1153
  tools?: {
1079
1154
  id: string;
1080
1155
  name: string;
@@ -1085,6 +1160,7 @@ interface paths$1 {
1085
1160
  teamAdminRequired?: true;
1086
1161
  };
1087
1162
  }[];
1163
+ /** @description Project-level tools provided by the integration. */
1088
1164
  projectTools?: {
1089
1165
  id: string;
1090
1166
  name: string;
@@ -1095,6 +1171,7 @@ interface paths$1 {
1095
1171
  teamAdminRequired?: true;
1096
1172
  };
1097
1173
  }[];
1174
+ /** @description Dashboard-level tools provided by the integration. */
1098
1175
  dashboardTools?: {
1099
1176
  id: string;
1100
1177
  name: string;
@@ -1106,6 +1183,7 @@ interface paths$1 {
1106
1183
  };
1107
1184
  }[];
1108
1185
  };
1186
+ /** @description Deprecated. Use `locations.ai.prompts` instead. */
1109
1187
  unstable_prompts?: {
1110
1188
  id: string;
1111
1189
  name: string;
@@ -1503,6 +1581,7 @@ declare class IntegrationDefinitionClient extends ApiClient<DefClientOptions> {
1503
1581
  get(options?: Omit<IntegrationDefinitionGetParameters, 'teamId'>): Promise<IntegrationDefinitionGetResponse>;
1504
1582
  /** Creates or updates a mesh app definition on a team. Identity-delegation credentials must be minted separately via {@link rotateCredential}. */
1505
1583
  upsert(body: Omit<IntegrationDefinitionPutParameters, 'teamId'>): Promise<{
1584
+ $schema?: string;
1506
1585
  type: string;
1507
1586
  displayName: string;
1508
1587
  logoIconUrl?: string;
package/dist/index.esm.js CHANGED
@@ -167,7 +167,7 @@ var getLogger = (prefix, debug) => {
167
167
  };
168
168
 
169
169
  // src/temp/version.ts
170
- var UNIFORM_MESH_SDK_VERSION = "20.74.2";
170
+ var UNIFORM_MESH_SDK_VERSION = "20.74.3";
171
171
 
172
172
  // src/framepost/constants.ts
173
173
  var DEFAULT_REQUEST_TIMEOUT = 5e3;
package/dist/index.js CHANGED
@@ -213,7 +213,7 @@ var getLogger = (prefix, debug) => {
213
213
  };
214
214
 
215
215
  // src/temp/version.ts
216
- var UNIFORM_MESH_SDK_VERSION = "20.74.2";
216
+ var UNIFORM_MESH_SDK_VERSION = "20.74.3";
217
217
 
218
218
  // src/framepost/constants.ts
219
219
  var DEFAULT_REQUEST_TIMEOUT = 5e3;
package/dist/index.mjs CHANGED
@@ -167,7 +167,7 @@ var getLogger = (prefix, debug) => {
167
167
  };
168
168
 
169
169
  // src/temp/version.ts
170
- var UNIFORM_MESH_SDK_VERSION = "20.74.2";
170
+ var UNIFORM_MESH_SDK_VERSION = "20.74.3";
171
171
 
172
172
  // src/framepost/constants.ts
173
173
  var DEFAULT_REQUEST_TIMEOUT = 5e3;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@uniformdev/mesh-sdk",
3
- "version": "20.74.2",
3
+ "version": "20.74.3",
4
4
  "description": "Uniform Mesh Framework SDK",
5
5
  "license": "SEE LICENSE IN LICENSE.txt",
6
6
  "engines": {
@@ -51,10 +51,10 @@
51
51
  "access": "public"
52
52
  },
53
53
  "dependencies": {
54
- "@uniformdev/assets": "20.74.2",
55
- "@uniformdev/canvas": "20.74.2",
56
- "@uniformdev/context": "20.74.2",
57
- "@uniformdev/project-map": "20.74.2",
54
+ "@uniformdev/assets": "20.74.3",
55
+ "@uniformdev/canvas": "20.74.3",
56
+ "@uniformdev/context": "20.74.3",
57
+ "@uniformdev/project-map": "20.74.3",
58
58
  "cookie": "^1.1.1",
59
59
  "imagesloaded": "^5.0.0",
60
60
  "jose": "^6.2.2",
@@ -65,5 +65,5 @@
65
65
  "openai": "6.44.0",
66
66
  "tsup": "8.5.1"
67
67
  },
68
- "gitHead": "2008e13563b56b6774555e45125f09f1abfd7e04"
68
+ "gitHead": "87fd3f8846e0be53ccd820490ca81dbc85297933"
69
69
  }