@microsoft/sp-module-interfaces 1.20.2 → 1.21.0-beta.2

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 (159) hide show
  1. package/dist/index-internal-beta.d.ts +59 -1
  2. package/dist/index-internal-public.d.ts +53 -1
  3. package/dist/index-internal.d.ts +760 -15
  4. package/lib-commonjs/index.js +31 -28
  5. package/lib-commonjs/manifestHelpers.js +22 -19
  6. package/lib-commonjs/manifestSchemaValidator.js +100 -63
  7. package/lib-commonjs/manifestSchemas/IAdaptiveCardExtensionManifest.js +5 -2
  8. package/lib-commonjs/manifestSchemas/IClientSideApplicationManifest.js +5 -2
  9. package/lib-commonjs/manifestSchemas/IClientSideAssemblyManifest.js +5 -2
  10. package/lib-commonjs/manifestSchemas/IClientSideComponentLoaderConfiguration.js +11 -3
  11. package/lib-commonjs/manifestSchemas/IClientSideComponentManifest.js +5 -2
  12. package/lib-commonjs/manifestSchemas/IClientSideExtensionManifest.js +5 -2
  13. package/lib-commonjs/manifestSchemas/IClientSideLibraryManifest.js +5 -2
  14. package/lib-commonjs/manifestSchemas/IClientSideManifestBase.js +10 -3
  15. package/lib-commonjs/manifestSchemas/IClientSideMultiVersionManifest.js +5 -2
  16. package/lib-commonjs/manifestSchemas/IClientSideWebPartManifest.js +62 -67
  17. package/lib-commonjs/manifestSchemas/ICommandSetExtensionManifest.js +5 -2
  18. package/lib-commonjs/manifestSchemas/IPrefabAppManifest.js +6 -0
  19. package/lib-commonjs/manifestSchemas/ManifestType.js +18 -13
  20. package/lib-commonjs/manifestSchemas/examples/application_1.manifest.js +24 -6
  21. package/lib-commonjs/manifestSchemas/examples/application_2.manifest.js +28 -7
  22. package/lib-commonjs/manifestSchemas/examples/application_3.manifest.js +22 -5
  23. package/lib-commonjs/manifestSchemas/examples/assembly_1.manifest.js +18 -4
  24. package/lib-commonjs/manifestSchemas/examples/commandSet_1.manifest.js +15 -3
  25. package/lib-commonjs/manifestSchemas/examples/extension_1.manifest.js +15 -3
  26. package/lib-commonjs/manifestSchemas/examples/extension_2.manifest.js +15 -3
  27. package/lib-commonjs/manifestSchemas/examples/extension_3.manifest.js +15 -3
  28. package/lib-commonjs/manifestSchemas/examples/extension_4.manifest.js +15 -3
  29. package/lib-commonjs/manifestSchemas/examples/library_1.manifest.js +18 -4
  30. package/lib-commonjs/manifestSchemas/examples/multi-version_1.manifest.js +24 -6
  31. package/lib-commonjs/manifestSchemas/examples/prefab_1.manifest.js +354 -0
  32. package/lib-commonjs/manifestSchemas/examples/prefab_2.manifest.js +391 -0
  33. package/lib-commonjs/manifestSchemas/examples/prefabapp.manifest.json +379 -0
  34. package/lib-commonjs/manifestSchemas/examples/webpart_1.manifest.js +24 -6
  35. package/lib-commonjs/manifestSchemas/examples/webpart_2.manifest.js +47 -12
  36. package/lib-commonjs/manifestSchemas/jsonSchemas/adaptive-card-extension-manifest.schema.json +8 -0
  37. package/lib-commonjs/manifestSchemas/jsonSchemas/client-side-component-manifest.schema.json +5 -2
  38. package/lib-commonjs/manifestSchemas/jsonSchemas/client-side-web-part-manifest.schema.json +23 -0
  39. package/lib-commonjs/manifestSchemas/jsonSchemas/prefab-app-manifest.schema.json +176 -0
  40. package/lib-commonjs/manifestSchemas/remote/draft-04.schema.json +137 -0
  41. package/lib-commonjs/manifestSchemas/remote/site-design-script-actions.schema.json +1158 -0
  42. package/{lib-commonjs → lib-dts}/index.d.ts +1 -0
  43. package/{lib-commonjs → lib-dts}/manifestSchemaValidator.d.ts +4 -1
  44. package/{lib-commonjs → lib-dts}/manifestSchemas/IAdaptiveCardExtensionManifest.d.ts +6 -0
  45. package/{lib-commonjs → lib-dts}/manifestSchemas/IClientSideComponentManifest.d.ts +1 -1
  46. package/{lib-commonjs → lib-dts}/manifestSchemas/IClientSideWebPartManifest.d.ts +33 -0
  47. package/lib-dts/manifestSchemas/IPrefabAppManifest.d.ts +255 -0
  48. package/{lib-commonjs → lib-dts}/manifestSchemas/examples/application_1.manifest.d.ts +1 -1
  49. package/{lib-commonjs → lib-dts}/manifestSchemas/examples/application_2.manifest.d.ts +1 -1
  50. package/{lib-commonjs → lib-dts}/manifestSchemas/examples/application_3.manifest.d.ts +1 -1
  51. package/{lib-commonjs → lib-dts}/manifestSchemas/examples/assembly_1.manifest.d.ts +1 -1
  52. package/{lib-commonjs → lib-dts}/manifestSchemas/examples/commandSet_1.manifest.d.ts +1 -1
  53. package/{lib-commonjs → lib-dts}/manifestSchemas/examples/extension_1.manifest.d.ts +1 -1
  54. package/{lib-commonjs → lib-dts}/manifestSchemas/examples/extension_2.manifest.d.ts +1 -1
  55. package/{lib-commonjs → lib-dts}/manifestSchemas/examples/extension_3.manifest.d.ts +1 -1
  56. package/{lib-commonjs → lib-dts}/manifestSchemas/examples/extension_4.manifest.d.ts +1 -1
  57. package/{lib-commonjs → lib-dts}/manifestSchemas/examples/library_1.manifest.d.ts +1 -1
  58. package/{lib-commonjs → lib-dts}/manifestSchemas/examples/multi-version_1.manifest.d.ts +1 -1
  59. package/lib-dts/manifestSchemas/examples/prefab_1.manifest.d.ts +4 -0
  60. package/lib-dts/manifestSchemas/examples/prefab_2.manifest.d.ts +4 -0
  61. package/{lib-commonjs → lib-dts}/manifestSchemas/examples/webpart_1.manifest.d.ts +1 -1
  62. package/{lib-commonjs → lib-dts}/manifestSchemas/examples/webpart_2.manifest.d.ts +1 -1
  63. package/{dist → lib-dts}/tsdoc-metadata.json +1 -1
  64. package/lib-esm/index.js +15 -0
  65. package/lib-esm/manifestHelpers.js +21 -0
  66. package/lib-esm/manifestSchemaValidator.js +135 -0
  67. package/lib-esm/manifestSchemas/IAdaptiveCardExtensionManifest.js +9 -0
  68. package/lib-esm/manifestSchemas/IClientSideApplicationManifest.js +5 -0
  69. package/lib-esm/manifestSchemas/IClientSideAssemblyManifest.js +7 -0
  70. package/lib-esm/manifestSchemas/IClientSideComponentLoaderConfiguration.js +17 -0
  71. package/lib-esm/manifestSchemas/IClientSideComponentManifest.js +27 -0
  72. package/lib-esm/manifestSchemas/IClientSideExtensionManifest.js +7 -0
  73. package/lib-esm/manifestSchemas/IClientSideLibraryManifest.js +7 -0
  74. package/lib-esm/manifestSchemas/IClientSideManifestBase.js +7 -0
  75. package/lib-esm/manifestSchemas/IClientSideMultiVersionManifest.js +25 -0
  76. package/lib-esm/manifestSchemas/IClientSideWebPartManifest.js +62 -0
  77. package/lib-esm/manifestSchemas/ICommandSetExtensionManifest.js +8 -0
  78. package/lib-esm/manifestSchemas/IPrefabAppManifest.js +7 -0
  79. package/lib-esm/manifestSchemas/ManifestType.js +15 -0
  80. package/lib-esm/manifestSchemas/examples/application.manifest.json +346 -0
  81. package/lib-esm/manifestSchemas/examples/application_1.manifest.js +344 -0
  82. package/lib-esm/manifestSchemas/examples/application_2.manifest.js +47 -0
  83. package/lib-esm/manifestSchemas/examples/application_3.manifest.js +42 -0
  84. package/lib-esm/manifestSchemas/examples/assembly.manifest.json +331 -0
  85. package/lib-esm/manifestSchemas/examples/assembly_1.manifest.js +336 -0
  86. package/lib-esm/manifestSchemas/examples/commandSet_1.manifest.js +42 -0
  87. package/lib-esm/manifestSchemas/examples/commandset.manifest.json +38 -0
  88. package/lib-esm/manifestSchemas/examples/extension.manifest.json +20 -0
  89. package/lib-esm/manifestSchemas/examples/extension_1.manifest.js +25 -0
  90. package/lib-esm/manifestSchemas/examples/extension_2.manifest.js +24 -0
  91. package/lib-esm/manifestSchemas/examples/extension_3.manifest.js +23 -0
  92. package/lib-esm/manifestSchemas/examples/extension_4.manifest.js +23 -0
  93. package/lib-esm/manifestSchemas/examples/library.manifest.json +330 -0
  94. package/lib-esm/manifestSchemas/examples/library_1.manifest.js +335 -0
  95. package/lib-esm/manifestSchemas/examples/multi-version_1.manifest.js +673 -0
  96. package/lib-esm/manifestSchemas/examples/multi-version_1.manifest.json +336 -0
  97. package/lib-esm/manifestSchemas/examples/prefab_1.manifest.js +344 -0
  98. package/lib-esm/manifestSchemas/examples/prefab_2.manifest.js +381 -0
  99. package/lib-esm/manifestSchemas/examples/prefabapp.manifest.json +379 -0
  100. package/lib-esm/manifestSchemas/examples/webpart.manifest.json +380 -0
  101. package/lib-esm/manifestSchemas/examples/webpart_1.manifest.js +350 -0
  102. package/lib-esm/manifestSchemas/examples/webpart_2.manifest.js +388 -0
  103. package/lib-esm/manifestSchemas/jsonSchemas/adaptive-card-extension-manifest.schema.json +230 -0
  104. package/lib-esm/manifestSchemas/jsonSchemas/any-value.schema.json +8 -0
  105. package/lib-esm/manifestSchemas/jsonSchemas/client-side-application-manifest.schema.json +138 -0
  106. package/lib-esm/manifestSchemas/jsonSchemas/client-side-assembly-manifest.schema.json +45 -0
  107. package/lib-esm/manifestSchemas/jsonSchemas/client-side-component-loader-configuration.schema.json +273 -0
  108. package/lib-esm/manifestSchemas/jsonSchemas/client-side-component-manifest.schema.json +131 -0
  109. package/lib-esm/manifestSchemas/jsonSchemas/client-side-extension-manifest.schema.json +61 -0
  110. package/lib-esm/manifestSchemas/jsonSchemas/client-side-library-manifest.schema.json +39 -0
  111. package/lib-esm/manifestSchemas/jsonSchemas/client-side-manifest-base.schema.json +25 -0
  112. package/lib-esm/manifestSchemas/jsonSchemas/client-side-multi-version-manifest.schema.json +118 -0
  113. package/lib-esm/manifestSchemas/jsonSchemas/client-side-web-part-manifest.schema.json +348 -0
  114. package/lib-esm/manifestSchemas/jsonSchemas/command-set-extension-manifest.schema.json +81 -0
  115. package/lib-esm/manifestSchemas/jsonSchemas/guid.schema.json +6 -0
  116. package/lib-esm/manifestSchemas/jsonSchemas/localized-string.schema.json +33 -0
  117. package/lib-esm/manifestSchemas/jsonSchemas/prefab-app-manifest.schema.json +176 -0
  118. package/lib-esm/manifestSchemas/jsonSchemas/semver.schema.json +8 -0
  119. package/lib-esm/manifestSchemas/remote/draft-04.schema.json +137 -0
  120. package/lib-esm/manifestSchemas/remote/site-design-script-actions.schema.json +1158 -0
  121. package/package.json +32 -11
  122. package/lib-commonjs/index.d.ts.map +0 -1
  123. package/lib-commonjs/manifestHelpers.d.ts.map +0 -1
  124. package/lib-commonjs/manifestSchemaValidator.d.ts.map +0 -1
  125. package/lib-commonjs/manifestSchemas/IAdaptiveCardExtensionManifest.d.ts.map +0 -1
  126. package/lib-commonjs/manifestSchemas/IClientSideApplicationManifest.d.ts.map +0 -1
  127. package/lib-commonjs/manifestSchemas/IClientSideAssemblyManifest.d.ts.map +0 -1
  128. package/lib-commonjs/manifestSchemas/IClientSideComponentLoaderConfiguration.d.ts.map +0 -1
  129. package/lib-commonjs/manifestSchemas/IClientSideComponentManifest.d.ts.map +0 -1
  130. package/lib-commonjs/manifestSchemas/IClientSideExtensionManifest.d.ts.map +0 -1
  131. package/lib-commonjs/manifestSchemas/IClientSideLibraryManifest.d.ts.map +0 -1
  132. package/lib-commonjs/manifestSchemas/IClientSideManifestBase.d.ts.map +0 -1
  133. package/lib-commonjs/manifestSchemas/IClientSideMultiVersionManifest.d.ts.map +0 -1
  134. package/lib-commonjs/manifestSchemas/IClientSideWebPartManifest.d.ts.map +0 -1
  135. package/lib-commonjs/manifestSchemas/ICommandSetExtensionManifest.d.ts.map +0 -1
  136. package/lib-commonjs/manifestSchemas/ManifestType.d.ts.map +0 -1
  137. package/lib-commonjs/manifestSchemas/examples/application_1.manifest.d.ts.map +0 -1
  138. package/lib-commonjs/manifestSchemas/examples/application_2.manifest.d.ts.map +0 -1
  139. package/lib-commonjs/manifestSchemas/examples/application_3.manifest.d.ts.map +0 -1
  140. package/lib-commonjs/manifestSchemas/examples/assembly_1.manifest.d.ts.map +0 -1
  141. package/lib-commonjs/manifestSchemas/examples/commandSet_1.manifest.d.ts.map +0 -1
  142. package/lib-commonjs/manifestSchemas/examples/extension_1.manifest.d.ts.map +0 -1
  143. package/lib-commonjs/manifestSchemas/examples/extension_2.manifest.d.ts.map +0 -1
  144. package/lib-commonjs/manifestSchemas/examples/extension_3.manifest.d.ts.map +0 -1
  145. package/lib-commonjs/manifestSchemas/examples/extension_4.manifest.d.ts.map +0 -1
  146. package/lib-commonjs/manifestSchemas/examples/library_1.manifest.d.ts.map +0 -1
  147. package/lib-commonjs/manifestSchemas/examples/multi-version_1.manifest.d.ts.map +0 -1
  148. package/lib-commonjs/manifestSchemas/examples/webpart_1.manifest.d.ts.map +0 -1
  149. package/lib-commonjs/manifestSchemas/examples/webpart_2.manifest.d.ts.map +0 -1
  150. /package/{lib-commonjs → lib-dts}/manifestHelpers.d.ts +0 -0
  151. /package/{lib-commonjs → lib-dts}/manifestSchemas/IClientSideApplicationManifest.d.ts +0 -0
  152. /package/{lib-commonjs → lib-dts}/manifestSchemas/IClientSideAssemblyManifest.d.ts +0 -0
  153. /package/{lib-commonjs → lib-dts}/manifestSchemas/IClientSideComponentLoaderConfiguration.d.ts +0 -0
  154. /package/{lib-commonjs → lib-dts}/manifestSchemas/IClientSideExtensionManifest.d.ts +0 -0
  155. /package/{lib-commonjs → lib-dts}/manifestSchemas/IClientSideLibraryManifest.d.ts +0 -0
  156. /package/{lib-commonjs → lib-dts}/manifestSchemas/IClientSideManifestBase.d.ts +0 -0
  157. /package/{lib-commonjs → lib-dts}/manifestSchemas/IClientSideMultiVersionManifest.d.ts +0 -0
  158. /package/{lib-commonjs → lib-dts}/manifestSchemas/ICommandSetExtensionManifest.d.ts +0 -0
  159. /package/{lib-commonjs → lib-dts}/manifestSchemas/ManifestType.d.ts +0 -0
@@ -2,7 +2,7 @@
2
2
  * Type of client-side component.
3
3
  * @public
4
4
  */
5
- export declare type ComponentType = 'Application' | 'WebPart' | 'Library' | 'Extension' | 'AdaptiveCardExtension';
5
+ export declare type ComponentType = 'Application' | 'WebPart' | 'Library' | 'Extension' | 'AdaptiveCardExtension' | 'Prefab';
6
6
 
7
7
  /**
8
8
  * The type of client-side extension. Used by IClientSideExtensionManifest.extensionType.
@@ -55,6 +55,12 @@ export declare interface IAdaptiveCardExtensionManifest<TProperties> extends ICl
55
55
  */
56
56
  hiddenFromToolbox?: boolean;
57
57
  /* Excluded from this release type: isolationLevel */
58
+ /**
59
+ * The scope of the personalization on how an AdaptiveCardExtension can be personalized by an end user.
60
+ *
61
+ * @beta
62
+ */
63
+ personalization?: 'Disallow' | 'Allow';
58
64
  /**
59
65
  * Definition:
60
66
  * - If true, the AdaptiveCardExtension will be disposed and reloaded when the AdaptiveCardExtension data is updated by an external source.
@@ -728,6 +734,20 @@ export declare interface IClientSideWebPartManifest<TProperties> extends IClient
728
734
  * and will be hosted as a Teams application (supportedHosts contains any of Teams hosts).
729
735
  */
730
736
  supportsSelfFramingInTeams?: boolean;
737
+ /**
738
+ * Definition: Defines the default sizing of webpart in flexible sections, as well as if it supports dynamic resizing.
739
+ * Example:
740
+ * ```
741
+ * flexibleLayoutSizing: {
742
+ * supportsDynamicResizing: false,
743
+ * defaultColumnWidth: 22,
744
+ * defaultRowHeight: 21
745
+ * }
746
+ * ```
747
+ * @remarks
748
+ * Ensure this remains up to date with IFlexibleControlSizingData in FlexibleControl.types.ts
749
+ */
750
+ flexibleLayoutSizing?: IFlexibleLayoutSizing;
731
751
  }
732
752
 
733
753
  /**
@@ -1030,6 +1050,26 @@ export declare interface IComponentModuleConfiguration extends IModuleConfigurat
1030
1050
  failoverPath?: string | IIntegrityPath;
1031
1051
  }
1032
1052
 
1053
+ /**
1054
+ * Flexible layout sizing data
1055
+ * @public
1056
+ */
1057
+ export declare interface IFlexibleLayoutSizing {
1058
+ /**
1059
+ * If true webpart can resize to any width between minimum and 70 columns
1060
+ * Otherwise webpart is slot resized to 22, 34, 48, or 70 columns
1061
+ */
1062
+ supportsDynamicResizing?: boolean;
1063
+ /**
1064
+ * Default column width for the webpart, used by drop hint
1065
+ */
1066
+ defaultColumnWidth?: number;
1067
+ /**
1068
+ * Default row height for the webpart, used by drop hint
1069
+ */
1070
+ defaultRowHeight?: number;
1071
+ }
1072
+
1033
1073
  /**
1034
1074
  * A path with the subresource integrity hash of the resource.
1035
1075
  *
@@ -1256,8 +1296,22 @@ export declare interface IPathModuleConfiguration extends IModuleConfigurationBa
1256
1296
  globalDependencies?: string[];
1257
1297
  }
1258
1298
 
1299
+ /* Excluded from this release type: IPrefabAppManifest */
1300
+
1301
+ /* Excluded from this release type: IPrefabAppOnDemandSiteScript */
1302
+
1303
+ /* Excluded from this release type: IPrefabAppOnInstallSiteScript */
1304
+
1305
+ /* Excluded from this release type: IPrefabAppSiteScriptBase */
1306
+
1307
+ /* Excluded from this release type: IPrefabAppSiteSettingsLink */
1308
+
1309
+ /* Excluded from this release type: IPrefabAppToolboxEntry */
1310
+
1259
1311
  /* Excluded from this release type: IPreloadOptions */
1260
1312
 
1313
+ /* Excluded from this release type: ISiteScriptActionBase */
1314
+
1261
1315
  /* Excluded from this release type: ManifestType */
1262
1316
 
1263
1317
  /**
@@ -1333,4 +1387,8 @@ export declare const enum PredefinedGroup {
1333
1387
  Local = "8b7bf6f1-a56a-4aa3-8657-7eb6e7e6af61"
1334
1388
  }
1335
1389
 
1390
+ /* Excluded from this release type: PrefabAppSiteScript */
1391
+
1392
+ /* Excluded from this release type: SiteScriptType */
1393
+
1336
1394
  export { }
@@ -2,7 +2,7 @@
2
2
  * Type of client-side component.
3
3
  * @public
4
4
  */
5
- export declare type ComponentType = 'Application' | 'WebPart' | 'Library' | 'Extension' | 'AdaptiveCardExtension';
5
+ export declare type ComponentType = 'Application' | 'WebPart' | 'Library' | 'Extension' | 'AdaptiveCardExtension' | 'Prefab';
6
6
 
7
7
  /**
8
8
  * The type of client-side extension. Used by IClientSideExtensionManifest.extensionType.
@@ -359,6 +359,20 @@ export declare interface IClientSideWebPartManifest<TProperties> extends IClient
359
359
  * and will be hosted as a Teams application (supportedHosts contains any of Teams hosts).
360
360
  */
361
361
  supportsSelfFramingInTeams?: boolean;
362
+ /**
363
+ * Definition: Defines the default sizing of webpart in flexible sections, as well as if it supports dynamic resizing.
364
+ * Example:
365
+ * ```
366
+ * flexibleLayoutSizing: {
367
+ * supportsDynamicResizing: false,
368
+ * defaultColumnWidth: 22,
369
+ * defaultRowHeight: 21
370
+ * }
371
+ * ```
372
+ * @remarks
373
+ * Ensure this remains up to date with IFlexibleControlSizingData in FlexibleControl.types.ts
374
+ */
375
+ flexibleLayoutSizing?: IFlexibleLayoutSizing;
362
376
  }
363
377
 
364
378
  /**
@@ -584,6 +598,26 @@ export declare interface ICommandSetExtensionManifest extends IClientSideExtensi
584
598
 
585
599
  /* Excluded from this release type: IComponentModuleConfiguration */
586
600
 
601
+ /**
602
+ * Flexible layout sizing data
603
+ * @public
604
+ */
605
+ export declare interface IFlexibleLayoutSizing {
606
+ /**
607
+ * If true webpart can resize to any width between minimum and 70 columns
608
+ * Otherwise webpart is slot resized to 22, 34, 48, or 70 columns
609
+ */
610
+ supportsDynamicResizing?: boolean;
611
+ /**
612
+ * Default column width for the webpart, used by drop hint
613
+ */
614
+ defaultColumnWidth?: number;
615
+ /**
616
+ * Default row height for the webpart, used by drop hint
617
+ */
618
+ defaultRowHeight?: number;
619
+ }
620
+
587
621
  /* Excluded from this release type: IIntegrityPath */
588
622
 
589
623
  /* Excluded from this release type: ILocalizedPathModuleConfiguration */
@@ -640,10 +674,28 @@ export declare interface ILocalizedString {
640
674
 
641
675
  /* Excluded from this release type: IPathModuleConfiguration */
642
676
 
677
+ /* Excluded from this release type: IPrefabAppManifest */
678
+
679
+ /* Excluded from this release type: IPrefabAppOnDemandSiteScript */
680
+
681
+ /* Excluded from this release type: IPrefabAppOnInstallSiteScript */
682
+
683
+ /* Excluded from this release type: IPrefabAppSiteScriptBase */
684
+
685
+ /* Excluded from this release type: IPrefabAppSiteSettingsLink */
686
+
687
+ /* Excluded from this release type: IPrefabAppToolboxEntry */
688
+
643
689
  /* Excluded from this release type: IPreloadOptions */
644
690
 
691
+ /* Excluded from this release type: ISiteScriptActionBase */
692
+
645
693
  /* Excluded from this release type: ManifestType */
646
694
 
647
695
  /* Excluded from this release type: PredefinedGroup */
648
696
 
697
+ /* Excluded from this release type: PrefabAppSiteScript */
698
+
699
+ /* Excluded from this release type: SiteScriptType */
700
+
649
701
  export { }