@microsoft/sp-module-interfaces 1.16.1 → 1.17.0-beta.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.
@@ -526,6 +526,8 @@ export declare interface IClientSideComponentManifest extends IClientSideManifes
526
526
  /* Excluded from this release type: mpnId */
527
527
  /* Excluded from this release type: componentDeveloperName */
528
528
  /* Excluded from this release type: properties */
529
+ /* Excluded from this release type: manifestActivatedTime */
530
+ /* Excluded from this release type: experimentalData */
529
531
  }
530
532
 
531
533
  /**
@@ -714,6 +716,15 @@ export declare interface IClientSideWebPartManifest<TProperties> extends IClient
714
716
  */
715
717
  imagePreviewUrl?: string;
716
718
  /* Excluded from this release type: propertiesMetadata */
719
+ /**
720
+ * Definition: If true, notifies that the web part will render an iframe with a page from the same SharePoint tenant (domain).
721
+ * Example: display a SharePoint Page in an iframe.
722
+ *
723
+ * @remarks
724
+ * Usage: Use this flag if a web part will render an iframe with a page from the same SharePoint tenant (domain)
725
+ * and will be hosted as a Teams application (supportedHosts contains any of Teams hosts).
726
+ */
727
+ supportsSelfFramingInTeams?: boolean;
717
728
  }
718
729
 
719
730
  /**
@@ -152,6 +152,8 @@ export declare interface IClientSideComponentManifest extends IClientSideManifes
152
152
  /* Excluded from this release type: mpnId */
153
153
  /* Excluded from this release type: componentDeveloperName */
154
154
  /* Excluded from this release type: properties */
155
+ /* Excluded from this release type: manifestActivatedTime */
156
+ /* Excluded from this release type: experimentalData */
155
157
  }
156
158
 
157
159
  /**
@@ -340,6 +342,15 @@ export declare interface IClientSideWebPartManifest<TProperties> extends IClient
340
342
  */
341
343
  imagePreviewUrl?: string;
342
344
  /* Excluded from this release type: propertiesMetadata */
345
+ /**
346
+ * Definition: If true, notifies that the web part will render an iframe with a page from the same SharePoint tenant (domain).
347
+ * Example: display a SharePoint Page in an iframe.
348
+ *
349
+ * @remarks
350
+ * Usage: Use this flag if a web part will render an iframe with a page from the same SharePoint tenant (domain)
351
+ * and will be hosted as a Teams application (supportedHosts contains any of Teams hosts).
352
+ */
353
+ supportsSelfFramingInTeams?: boolean;
343
354
  }
344
355
 
345
356
  /**
@@ -11,9 +11,258 @@ export declare type ComponentType = 'Application' | 'WebPart' | 'Library' | 'Ext
11
11
  */
12
12
  export declare type ExtensionType = 'Unknown' | 'ApplicationCustomizer' | 'FieldCustomizer' | 'ListViewCommandSet' | 'SearchQueryModifier';
13
13
 
14
- /* Excluded from this release type: IAdaptiveCardExtensionManifest */
14
+ /**
15
+ * @beta
16
+ */
17
+ export declare interface IAdaptiveCardExtensionManifest<TProperties> extends IClientSideComponentManifest {
18
+ /**
19
+ * Id matching the Teams SaaS application that the ACE will redirect to when a “full page” experience is required
20
+ */
21
+ connectedTeamsAppId?: string;
22
+ /**
23
+ * Id of the SPFx application that the ACE will redirect to when a “full page” experience is required
24
+ */
25
+ connectedSPFXAppId?: string;
26
+ /**
27
+ * Definition: An array defining what host types are supported
28
+ *
29
+ *
30
+ * @remarks
31
+ * Usage: Use this array to define all hosts that are supported.
32
+ *
33
+ */
34
+ supportedHosts?: ReadonlyArray<'Dashboard'>;
35
+ /**
36
+ * Definition: If true, this ACE supports and has been tested for theme variants experience.
37
+ *
38
+ * @remarks
39
+ * Usage: Use this flag if a ACE supports theme variants and has been tested as such.
40
+ * In order to support theme variants, ACEs must have the capability to render correctly in the context
41
+ * of a theme variant. An ACE may or may not need to be updated to support theme variants, but should
42
+ * always be tested before enabling this flag. By default no ACEs support theme variants.
43
+ *
44
+ */
45
+ supportsThemeVariants?: boolean;
46
+ /**
47
+ * An untyped property bag for experimental flags not ready for production.
48
+ *
49
+ */
50
+ experimentalData?: {
51
+ [key: string]: any;
52
+ };
53
+ /**
54
+ * If true, this AdaptiveCardExtension should not be displayed in the modern SharePoint toolbox.
55
+ *
56
+ * @remarks
57
+ * Usage: Use this flag if it is not appropriate to display a AdaptiveCardExtension in the modern toolbox. By default,
58
+ * all AdaptiveCardExtensions are enabled to be displayed in the toolbox if supportedHosts contains 'SharePointWebPart'
59
+ * Such AdaptiveCardExtensions can be provisioned on pages though API or be added to the page in a pre configured way.
60
+ */
61
+ hiddenFromToolbox?: boolean;
62
+ /* Excluded from this release type: isolationLevel */
63
+ /**
64
+ * Definition:
65
+ * - If true, the AdaptiveCardExtension will be disposed and reloaded when the AdaptiveCardExtension data is updated by an external source.
66
+ * - If false, the AdaptiveCardExtension data will be deserialized and the properties of the AdaptiveCardExtension will be updated,
67
+ * onAfterPropertiesUpdatedExternally will be executed.
68
+ * - If undefined, AdaptiveCardExtensions developed with SPFx version below 1.9 will default to true and AdaptiveCardExtensions developed with
69
+ * a SPFx version 1.9 or greater will default to false.
70
+ *
71
+ * @remarks
72
+ * By default, onAfterPropertiesUpdatedExternally will re-render the AdaptiveCardExtension. If your AdaptiveCardExtension requires specialized
73
+ * logic, then it is recommended to override onAfterPropertiesUpdatedExternally.
74
+ */
75
+ useFallbackWhenPropertiesUpdatedExternally?: boolean;
76
+ /**
77
+ * A AdaptiveCardExtension can have pre-configured properties like the title, description, iconImageUrl, officeFabricIconFontName, toolbox group name
78
+ * and AdaptiveCardExtension specific custom properties. And there can be multiple instances of these pre-configured properties.
79
+ *
80
+ * @remarks
81
+ * This helps support scenarios where an organization may want to present multiple pre-configured entries
82
+ * for a AdaptiveCardExtension in the Toolbox. Each entry is expected to configure the AdaptiveCardExtension with a different set
83
+ * of pre-configured properties. A developer may decide to seed some initial values for these properties
84
+ * but an organization admin can go ahead and customize these properties per the needs of his/her organization.
85
+ * The properties can also be modified by the author of the page.
86
+ *
87
+ * Usage: help display a AdaptiveCardExtension in the Toolbox, PropertyPane and the initial rendering of the AdaptiveCardExtension.
88
+ *
89
+ * Type: JSON object
90
+ *
91
+ * Supported values: Array of `IClientSideWebPartManifestEntry` objects.
92
+ *
93
+ * Example:
94
+ * ```
95
+ * [{
96
+ * "groupId": "5c03119e-3074-46fd-976b-c60198311f70",
97
+ * "group": { "default": "Advanced" },
98
+ * "title": { "id": "$./ManifestStrings.resx:PrimaryTextL1Template;" },
99
+ * "description": { "id": "$./ManifestStrings.resx:PrimaryTextL1TemplateDescription;" },
100
+ * "officeFabricIconFontName": "Balloons",
101
+ * "properties": {
102
+ * "templateType": "primaryText",
103
+ * "title": "Primary Text",
104
+ * "primaryText": "Basic card",
105
+ * "description": "This is an example.",
106
+ * "cardSize": "Medium"
107
+ * }
108
+ * }]
109
+ * ```
110
+ */
111
+ preconfiguredEntries: IAdaptiveCardExtensionManifestEntry<TProperties>[];
112
+ }
15
113
 
16
- /* Excluded from this release type: IAdaptiveCardExtensionManifestEntry */
114
+ /**
115
+ * This interface specifies the set of properties that can be pre-configured by a AdaptiveCardExtension developer. Each
116
+ * pre-configured instance of the AdaptiveCardExtension will need a copy of these properties. Organization admins and
117
+ * content authors can modify these properties on a need basis.
118
+ *
119
+ * @beta
120
+ */
121
+ export declare interface IAdaptiveCardExtensionManifestEntry<TProperties> {
122
+ /**
123
+ * Size of the AdaptiveCardExtension when it is rendered. This is value must be one of the supported CardSizes
124
+ * ["Medium", "Large"] defined in the sp-adaptive-card-base project.
125
+ */
126
+ cardSize: string;
127
+ /**
128
+ * Title of the AdaptiveCardExtension represented as a single a dictionary of locale keys to title values. This
129
+ * value will be displayed to the user in the toolbox.
130
+ *
131
+ * @remarks
132
+ * This title should be used in the Toolbox and other display areas. The AdaptiveCardExtension developer may give
133
+ * an initial title to the AdaptiveCardExtension. The organization admin and page author will have the ability to
134
+ * change this title as per need.
135
+ *
136
+ * Usage: display the name of the AdaptiveCardExtension in the toolbox, web part gallery and the page.
137
+ *
138
+ * Supported values: a dictionary of locale keys to strings. Should always have a `'default'` key.
139
+ *
140
+ * Example: `"My Webpart"`
141
+ * ```
142
+ * {
143
+ * "default": "My WebPart"
144
+ * "en-us": "My WebPart",
145
+ * "fr-fr": "Ma WebPart",
146
+ * "zh": "我的 web 部件"
147
+ * }
148
+ * ```
149
+ */
150
+ title: ILocalizedString;
151
+ /**
152
+ * Description of the AdaptiveCardExtension represented as a dictionary of locale keys to description values. This
153
+ * value will be displayed to the user in the toolbox. This description should be used in the Toolbox tooltip and
154
+ * other display areas.
155
+ *
156
+ * @remarks
157
+ * The AdaptiveCardExtension developer may give an initial description to the AdaptiveCardExtension. The organization
158
+ * admin and page author will have the ability to change this description as per need.
159
+ *
160
+ * Usage: display the description of the AdaptiveCardExtension in the toolbox tooltip, web part gallery and the page.
161
+ *
162
+ * Supported values: a dictionary of locale keys to strings. Should always have a `'default'` key.
163
+ *
164
+ * Example: `"A tool for displaying neat information."`
165
+ *
166
+ * ```
167
+ * {
168
+ * "default": "A tool for displaying neat information.",
169
+ * "en-us": "A tool for displaying neat information.",
170
+ * "fr-fr": "Un outil d'affichage des informations soignées.",
171
+ * "zh": "用於顯示整潔資訊的工具。"
172
+ * }
173
+ * ```
174
+ */
175
+ description: ILocalizedString;
176
+ /**
177
+ * The icon for the AdaptiveCardExtension, to be displayed in the toolbox, represented as a character name in the
178
+ * Office 365 icon font file.
179
+ *
180
+ * @remarks
181
+ * The icon font is specified here: {@link https://aka.ms/uifabric-icons} If this field has
182
+ * a value, the {@link IClientSideWebPartManifestEntry.iconImageUrl} field will be ignored.
183
+ *
184
+ * Supported values: Any character name in the Office 365 Icon Font.
185
+ *
186
+ * Example: "graph"
187
+ */
188
+ officeFabricIconFontName?: string;
189
+ /**
190
+ * The icon for the AdaptiveCardExtension, to be displayed in the toolbox, represented an image URL. The image at the
191
+ * URL must be exactly 40x28 px (SPPPLAT VSO#218660 to fix the size of the icon image).
192
+ *
193
+ * @remarks
194
+ * If the {@link IClientSideWebPartManifestEntry.officeFabricIconFontName} field does not have a value,
195
+ * this field must have a value. This value can be an absolute URL (e.g. `"http://example.com/icons/my-icon.png"`) or
196
+ * a relative file path (e.g. `"./icons/my-icon.png"`). In the latter case, the path will be resolved relative to
197
+ * the folder containing the input manifest. The icon file will be copied to the deployment folder like an asset,
198
+ * and the output manifest's iconImageUrl will be replaced with a URL relative to the URL used to load all other
199
+ * assets (the loaderConfig.internalModuleBaseUrls property).
200
+ *
201
+ * Supported values: Any absolute URL.
202
+ *
203
+ * Example: `"https://contoso.akamaihd.net/files/myWebpartIcon.png"`
204
+ */
205
+ iconImageUrl?: string;
206
+ /**
207
+ * The group id to determine which modern group contains the AdaptiveCardExtension in modern site page. The SharePoint
208
+ * Framework reserves group ids for predefined groups. The developer can pick one from those groups. If the developer
209
+ * fills an id not in the predefined groups, it falls back to Other group.
210
+ *
211
+ * @remarks
212
+ *
213
+ * Supported values: the GUID from PredefinedGroup list
214
+ *
215
+ * Example: `"cf066440-0614-43d6-98ae-0b31cf14c7c3"`
216
+ *
217
+ * @beta
218
+ */
219
+ groupId: PredefinedGroup | string;
220
+ /**
221
+ * This field is used to tag a AdaptiveCardExtension with keywords that are different from the AdaptiveCardExtension group name.
222
+ * Tags can be used for categorization and searching of AdaptiveCardExtensions. For example, in the toolbox.
223
+ *
224
+ * @remarks
225
+ *
226
+ * Example `[{ "default": "image" }, { "default": "media" }, { "default": "picture" }, ...]`
227
+ *
228
+ * @beta
229
+ */
230
+ tags?: ILocalizedString[];
231
+ /**
232
+ * Definition: Use this field to specify the data version of the pre-configured data provided to the AdaptiveCardExtension.
233
+ * Note that data version is different from the version field in the manifest.
234
+ *
235
+ * @remarks
236
+ * The manifest version is used to control the versioning of the AdaptiveCardExtension code, while data version is used
237
+ * to control the versioning of the serialized data of the AdaptiveCardExtension. Refer to dataVersion field of your
238
+ * AdaptiveCardExtension for more information.
239
+ *
240
+ * Usage: versioning and evolving the serialized data of the AdaptiveCardExtension
241
+ *
242
+ * Type: string representing a {@link http://semver.org | semantic version} with only two parts
243
+ *
244
+ * Supported values: MAJOR.MINOR
245
+ *
246
+ * Example: `"1.0"`
247
+ */
248
+ dataVersion?: string;
249
+ /**
250
+ * Every AdaptiveCardExtension is expected to have some custom properties. For example, a page AdaptiveCardExtension might define
251
+ * properties for the page URL and caption text. A list AdaptiveCardExtension may have the list ID and list title as its
252
+ * properties, and so on.
253
+ *
254
+ * @remarks
255
+ *
256
+ * The SharePoint Framework passes these properties to the AdaptiveCardExtensions when they are loaded. The AdaptiveCardExtension developer
257
+ * fully controls the schema for these properties. The AdaptiveCardExtension developer should follow versioning rules when
258
+ * updating the properties.
259
+ *
260
+ * Usage: rendering of the AdaptiveCardExtension
261
+ *
262
+ * Example: `{"imageSource": "https://contoso.akamaihd.net/files/contosoLogo.jpg", "captionText": "Contoso logo"}"`
263
+ */
264
+ properties: TProperties;
265
+ }
17
266
 
18
267
  /* Excluded from this release type: ICapabilityCollection */
19
268
 
@@ -37,7 +286,120 @@ export declare interface IClientSideAssemblyManifest extends IClientSideComponen
37
286
  rootComponentId: string;
38
287
  }
39
288
 
40
- /* Excluded from this release type: IClientSideComponentLoaderConfiguration */
289
+ /**
290
+ * This interface describes how a client-side component is to be loaded and initialized by a SharePoint client
291
+ * framework. It contains all data for loading an entrypoint script and its dependency scripts.
292
+ *
293
+ * @beta
294
+ */
295
+ export declare interface IClientSideComponentLoaderConfiguration {
296
+ /**
297
+ * This is an array of fully-qualified paths to be prepended to each of the script resource paths with the
298
+ * "internal" or "localized" type. If one fails to load, the loader will attempt to load from the next until there
299
+ * are no base paths remaining.
300
+ *
301
+ * @remarks
302
+ * All "internal" and "localized" script resources that do not have fully-qualified URLs
303
+ * as their "path" field values must be hosted under each of the paths listed in this property. For example, if an
304
+ * internal module's "path" field value is `"master_2015-04-20/my-application.bundle_1928f8a0.js"` and this field's
305
+ * value is `[ "https://contoso.akamaihd.net/files/", "https://contoso.msecnd.net/files/" ]`, the loader will first
306
+ * attempt to load this script resource from the URL
307
+ * `"https://contoso.akamaihd.net/files/master_2015-04-20/my-application.bundle_1928f8a0.js"`. If loading from
308
+ * that URL fails, the loader will then attempt to load this script resource from
309
+ * `"https://contoso.msecnd.net/files/master_2015-04-20/my-application.bundle_1928f8a0.js"`. If that URL fails
310
+ * to load, the component will fail to load and an error will be returned. It is important to note that the support
311
+ * for multiple base URLs is purely for failover support. This means that all files must be present on all hosts
312
+ * listed in this field.
313
+ *
314
+ * Usage: Base URLs for script resources with the "internal" or "localized" type.
315
+ *
316
+ * Supported values: Any URL that contains all internal scripts referenced in the "scriptResources" dictionary.
317
+ *
318
+ * Example: `[ "https://contoso.akamaihd.net/files/", "https://contoso.msecnd.net/files/" ]`
319
+ */
320
+ internalModuleBaseUrls: string[];
321
+ /**
322
+ * This is the ID of one of the entries in the "scriptResources" dictionary.
323
+ *
324
+ * @remarks
325
+ * The loader will download and evaluate the script resource referenced in this field, resolve all dependencies
326
+ * against the keys in the "scriptResources", and return the exported object to the loader's calling function.
327
+ * The entry referenced in the "scriptResources" dictionary must be of the "internal" or the "localized" type.
328
+ *
329
+ * Supported values: An entry in the "scriptResources" dictionary that defines the base exported module of the
330
+ * component.
331
+ *
332
+ * Example: `"myApplication.bundle"`
333
+ */
334
+ entryModuleId: string;
335
+ /**
336
+ * The module referenced by the "entryModuleId" field may export an object with several fields.
337
+ *
338
+ * @remarks
339
+ * This value optionally references the name of a field on the object exported by the module referenced by the
340
+ * `entryModuleId` field. When this field has a value, the value of the referenced field on the object exported
341
+ * by the module referenced by the `entryModuleId` field is returned when this manifest is loaded instead of
342
+ * the base exported object. For example, if entryModuleId refers to a module with with a top-level export of
343
+ * `{ foo: 'bar', baz: 123 }` and:
344
+ *
345
+ * - if this field is unset, the value returned by the module loader is `{ foo: 'bar', baz: 123 }`
346
+ *
347
+ * - if this field is set to `foo`, the value returned by the module loader is `bar`
348
+ *
349
+ * - if this field is set to `bar`, the value returned by the module loader is undefined (as `bar` is not a key in
350
+ * the top-level export).
351
+ *
352
+ * Example: `mySpWebpart`
353
+ */
354
+ exportName?: string;
355
+ /**
356
+ * This is a dictionary of named script resources. `path` and `localizedPath` modules may reference each
357
+ * other and `manifest` modules are expected to be provided by the framework runtime. The resource named in the
358
+ * `entryModuleId` must contain the component's exported object.
359
+ *
360
+ * @remarks
361
+ *
362
+ * Supported values: A dictionary of named script resources.
363
+ *
364
+ * Example:
365
+ *
366
+ * ```
367
+ * {
368
+ * "myApplication.bundle": {
369
+ * "type": "path",
370
+ * "path": "master_2015-04-20/my-application.bundle_1928f8a0.js"
371
+ * },
372
+ * "@microsoft/sp-client-base": {
373
+ * "type": "component",
374
+ * "id": "af59c2b3-2da7-41fd-8b72-3939817960af",
375
+ * "version": "latest"
376
+ * },
377
+ * "@microsoft/sp-client-preview": {
378
+ * "type": "component",
379
+ * "id": "4d5eb168-6729-49a8-aec7-0e397f486b6e",
380
+ * "version": "latest"
381
+ * },
382
+ * "jQuery": {
383
+ * "type": "component",
384
+ * "id": "00000000-0000-0000-0000-000000000000",
385
+ * "version": "2.2.4",
386
+ * "path": "https://code.jquery.com/jquery-2.2.4.min.js"
387
+ * },
388
+ * "myApplication_strings": {
389
+ * "type": "localizedPath",
390
+ * "defaultPath": "master_2015-04-20/my-application_strings_default_af378e0d.js",
391
+ * "paths": {
392
+ * "en-us": "master_2015-04-20/my-application_strings_en-us_d38ff012.js",
393
+ * "fr-fr": "master_2015-04-20/my-application_strings_fr-fr_138af7e4.js"
394
+ * }
395
+ * }
396
+ * }
397
+ * ```
398
+ */
399
+ scriptResources: {
400
+ [name: string]: IModuleConfiguration;
401
+ };
402
+ }
41
403
 
42
404
  /**
43
405
  * All client-side components built on the SharePoint framework need a valid component manifest. This interface
@@ -146,12 +508,26 @@ export declare interface IClientSideComponentManifest extends IClientSideManifes
146
508
  * Usage: Requires Custom Script to be allowed in order for this component to be installed and run.
147
509
  */
148
510
  requiresCustomScript?: boolean;
149
- /* Excluded from this release type: loaderConfig */
511
+ /**
512
+ * This portion of the configuration describes how the component is to be loaded and initialized by a
513
+ * client. It contains an enumeration of scripts that the component requires along with a single
514
+ * entry point script.
515
+ *
516
+ * @remarks
517
+ * Usage: Loading a component.
518
+ *
519
+ * See `IClientSideComponentLoaderConfiguration` for more information and examples.
520
+ *
521
+ * @beta
522
+ */
523
+ loaderConfig: IClientSideComponentLoaderConfiguration;
150
524
  /* Excluded from this release type: isolatedDomain */
151
525
  /* Excluded from this release type: storeAppId */
152
526
  /* Excluded from this release type: mpnId */
153
527
  /* Excluded from this release type: componentDeveloperName */
154
528
  /* Excluded from this release type: properties */
529
+ /* Excluded from this release type: manifestActivatedTime */
530
+ /* Excluded from this release type: experimentalData */
155
531
  }
156
532
 
157
533
  /**
@@ -340,6 +716,15 @@ export declare interface IClientSideWebPartManifest<TProperties> extends IClient
340
716
  */
341
717
  imagePreviewUrl?: string;
342
718
  /* Excluded from this release type: propertiesMetadata */
719
+ /**
720
+ * Definition: If true, notifies that the web part will render an iframe with a page from the same SharePoint tenant (domain).
721
+ * Example: display a SharePoint Page in an iframe.
722
+ *
723
+ * @remarks
724
+ * Usage: Use this flag if a web part will render an iframe with a page from the same SharePoint tenant (domain)
725
+ * and will be hosted as a Teams application (supportedHosts contains any of Teams hosts).
726
+ */
727
+ supportsSelfFramingInTeams?: boolean;
343
728
  }
344
729
 
345
730
  /**
@@ -429,9 +814,42 @@ export declare interface IClientSideWebPartManifestEntry<TProperties> {
429
814
  * Example: `"https://contoso.akamaihd.net/files/myWebpartIcon.png"`
430
815
  */
431
816
  iconImageUrl?: string;
432
- /* Excluded from this release type: groupId */
433
- /* Excluded from this release type: group */
434
- /* Excluded from this release type: tags */
817
+ /**
818
+ * The group id to determine which modern group contains the web part in modern site page. The SharePoint
819
+ * Framework reserves group ids for predefined groups. The developer can pick one from those groups. If the developer
820
+ * fills an id not in the predefined groups, it falls back to Other group.
821
+ *
822
+ * @remarks
823
+ *
824
+ * Supported values: the GUID from PredefinedGroup list
825
+ *
826
+ * Example: `"cf066440-0614-43d6-98ae-0b31cf14c7c3"`
827
+ *
828
+ * @beta
829
+ */
830
+ groupId: PredefinedGroup | string;
831
+ /**
832
+ * The group name in web part picker to contain the web part in the classic page. If no value is provided,
833
+ * then the web part will be displayed in the Miscellaneous group.
834
+ *
835
+ * @remarks
836
+ *
837
+ * Example: `{ "default": "Media and Content" }`
838
+ *
839
+ * @beta
840
+ */
841
+ group?: ILocalizedString;
842
+ /**
843
+ * This field is used to tag a web part with keywords that are different from the web part group name.
844
+ * Tags can be used for categorization and searching of web parts. For example, in the web part toolbox.
845
+ *
846
+ * @remarks
847
+ *
848
+ * Example `[{ "default": "image" }, { "default": "media" }, { "default": "picture" }, ...]`
849
+ *
850
+ * @beta
851
+ */
852
+ tags?: ILocalizedString[];
435
853
  /**
436
854
  * Definition: Use this field to specify the data version of the pre-configured data provided to the web part.
437
855
  * Note that data version is different from the version field in the manifest.
@@ -563,11 +981,124 @@ export declare interface ICommandSetExtensionManifest extends IClientSideExtensi
563
981
  };
564
982
  }
565
983
 
566
- /* Excluded from this release type: IComponentModuleConfiguration */
984
+ /**
985
+ * This is the interface for a script module with the "component" type. Modules of this type will be provided via
986
+ * manifests. In order for the dependency to be loaded, the manifest must be available on the site.
987
+ *
988
+ * @beta
989
+ */
990
+ export declare interface IComponentModuleConfiguration extends IModuleConfigurationBase {
991
+ type: 'component';
992
+ /**
993
+ * The version of the framework-supplied component to be loaded. For framework runtime component such as
994
+ * `@microsoft/sp-client-base`, it is recommended the version of the framework component the component was developed
995
+ * against be specified.
996
+ *
997
+ * @remarks
998
+ *
999
+ * Supported values: string representing a {@link http://semver.org | semantic version}, or "latest".
1000
+ *
1001
+ * Example: `"2.2.4"`
1002
+ */
1003
+ version: string;
1004
+ /**
1005
+ * The ID of the framework-supplied component to be loaded.
1006
+ *
1007
+ * @remarks
1008
+ *
1009
+ * Supported values: string representing a component's ID.
1010
+ *
1011
+ * Example: `"0d910c1c-13b9-4e1c-9aa4-b008c5e42d7d"`
1012
+ */
1013
+ id: string;
1014
+ /**
1015
+ * A path to the framework-supplied component in case the framework fails to load the requested version.
1016
+ *
1017
+ * @remarks
1018
+ * This must be either a fully-qualified URL, or a path under the paths specified in the `internalModuleBaseUrls`
1019
+ * field. If this field is not specified and the version is not available in the framework runtime, the closest
1020
+ * matching version of the component will be provided instead.
1021
+ *
1022
+ * Supported values: The path to the component either as a fully-qualified URL or as a path under the
1023
+ * paths provided in the "internalModuleBaseUrls" field.
1024
+ *
1025
+ * Example: `"https://code.jquery.com/jquery-2.2.4.min.js"`
1026
+ */
1027
+ failoverPath?: string | IIntegrityPath;
1028
+ }
567
1029
 
568
- /* Excluded from this release type: IIntegrityPath */
1030
+ /**
1031
+ * A path with the subresource integrity hash of the resource.
1032
+ *
1033
+ * @beta
1034
+ */
1035
+ export declare interface IIntegrityPath {
1036
+ /**
1037
+ * The path to the resource.
1038
+ */
1039
+ path: string;
1040
+ /**
1041
+ * The subresource integrity hash of the resource referenced in {@link IIntegrityPath.path}.
1042
+ */
1043
+ integrity?: string;
1044
+ }
569
1045
 
570
- /* Excluded from this release type: ILocalizedPathModuleConfiguration */
1046
+ /**
1047
+ * This is the interface for a script module with the "localizedPath" type.
1048
+ *
1049
+ * @remarks
1050
+ * Modules of this type must be provided by the component developer. These script resources are similar to those of
1051
+ * the "path" type, but they may be present at a number of different paths, to be selected by the user's locale.
1052
+ * Paths in this module type are loaded exactly the same way as "internal" modules are.
1053
+ *
1054
+ * @beta
1055
+ */
1056
+ export declare interface ILocalizedPathModuleConfiguration extends IModuleConfigurationBase {
1057
+ type: 'localizedPath';
1058
+ /**
1059
+ * A path to this module's default locale javascript resource either as a fully-qualified URL or as a
1060
+ * path under the paths provided in the "internalModuleBaseUrls" field.
1061
+ *
1062
+ * @remarks
1063
+ * If the user's locale does not resolve to one of the paths specified in the "paths" field, the path in this
1064
+ * field is used. Paths in this module type are treated exactly the same way paths in modules of the "internal"
1065
+ * type are treated.
1066
+ *
1067
+ * Supported values: The path to the default locale version of the module either as a fully-qualified URL or as a path
1068
+ * under the paths provided in the "internalModuleBaseUrls" field.
1069
+ *
1070
+ * Example: `"master_2015-04-20/my-application_strings_default_af378e0d.js"`
1071
+ */
1072
+ defaultPath: string | IIntegrityPath;
1073
+ /**
1074
+ * This is a dictionary of locale keys (in the `"ll-cc"` format) to paths to this module's locale
1075
+ * javascript resource either as a fully-qualified URL or as a path under the paths provided in the
1076
+ * `"internalModuleBaseUrls"` field.
1077
+ *
1078
+ * @remarks
1079
+ * The loader will attempt to resolve the user's locale to one of the paths provided by this field, and will load
1080
+ * the script resource under that path. If the user's locale does not resolve to one of the paths specified in this
1081
+ * field, the path in `"defaultPath"` field is used. For example, if the user's locale is `"en-gb"`, and this field's
1082
+ * value contains the keys `[ "en-us", "en-gb", "fr-fr" ]`, the path specified by the `"en-gb"` key will be used.
1083
+ * If the user's locale is "en-gb", and this field's value contains the keys `[ "en-us", "fr-fr" ]`, the path
1084
+ * specified by the `"en-us"` key will be used. If the user's locale is `"en-gb"`, and this field's value contains
1085
+ * the keys `[ "es-es", "fr-fr" ]`, the path specified by the "defaultPath" field will be used.
1086
+ * Paths in this module type are treated exactly the same way paths in modules of the "internal" type are treated.
1087
+ *
1088
+ * Supported values: A dictionary of locale-to-path mappings.
1089
+ *
1090
+ * Example:
1091
+ * ```
1092
+ * {
1093
+ * "en-us": "master_2015-04-20/my-application_strings_en-us_d38ff012.js",
1094
+ * "fr-fr": "master_2015-04-20/my-application_strings_fr-fr_138af7e4.js"
1095
+ * }
1096
+ * ```
1097
+ */
1098
+ paths?: {
1099
+ [locale: string]: string | IIntegrityPath;
1100
+ };
1101
+ }
571
1102
 
572
1103
  /**
573
1104
  * A set of localized strings.
@@ -615,16 +1146,188 @@ export declare interface ILocalizedString {
615
1146
  [locale: string]: string | undefined;
616
1147
  }
617
1148
 
618
- /* Excluded from this release type: IModuleConfiguration */
1149
+ /**
1150
+ * @beta
1151
+ */
1152
+ export declare type IModuleConfiguration = IComponentModuleConfiguration | IPathModuleConfiguration | ILocalizedPathModuleConfiguration;
619
1153
 
620
- /* Excluded from this release type: IModuleConfigurationBase */
1154
+ /**
1155
+ * This is the base interface for a script module's definition.
1156
+ *
1157
+ * @beta
1158
+ */
1159
+ export declare interface IModuleConfigurationBase {
1160
+ /**
1161
+ * The type of the script block. `"component"` modules come from a component,
1162
+ * `"path"` and `"localizedPath"` modules must be available on the paths provided in
1163
+ * the `"internalModuleBaseUrls"` field.
1164
+ *
1165
+ * @remarks
1166
+ *
1167
+ * Modules with the `"path"` type use the `IPathModuleConfiguration` interface.
1168
+ *
1169
+ * Modules with the `"component"` type use the `IComponentModuleConfiguration` interface.
1170
+ * Modules with the "localizedPath" type use the `ILocalizedPathModuleConfiguration` interface.
1171
+ *
1172
+ * Supported values: `"component"`, `"path"`, `"localizedPath"`
1173
+ *
1174
+ * Example: `"localized"`
1175
+ */
1176
+ type: 'component' | 'path' | 'localizedPath';
1177
+ /**
1178
+ * If set to `true`, this module should not be preloaded when loading the component.
1179
+ *
1180
+ * @remarks
1181
+ * The most common case for setting this property to "true" is when a module is defined in a manifest,
1182
+ * but is not required for the module referenced in "entryModuleId" to load. Modules may be defined that
1183
+ * are loaded asynchronously, and these modules do not need to be preloaded. This field implicitly defaults
1184
+ * to `false`.
1185
+ *
1186
+ * Usage: Instructs the module loader to not preload this module.
1187
+ */
1188
+ shouldNotPreload?: boolean;
1189
+ }
621
1190
 
622
- /* Excluded from this release type: IPathModuleConfiguration */
1191
+ /**
1192
+ * This is the interface for a script module with the "path" type. Modules of this type must be provided by the
1193
+ * component developer.
1194
+ *
1195
+ * @beta
1196
+ */
1197
+ export declare interface IPathModuleConfiguration extends IModuleConfigurationBase {
1198
+ type: 'path';
1199
+ /**
1200
+ * A path to this module's javascript resource either as a fully-qualified URL or as a path under the
1201
+ * paths provided in the `internalModuleBaseUrls` field.
1202
+ *
1203
+ * @remarks
1204
+ *
1205
+ * For example, if this field's value is `"master_2015-04-20/my-application.bundle_1928f8a0.js"` and
1206
+ * the `"internalModuleBaseUrls"` field's value is
1207
+ * `[ "https://contoso.akamaihd.net/files/", "https://contoso.msecnd.net/files/" ]`, the loader will
1208
+ * first attempt to load this script resource from the URL
1209
+ * `"https://contoso.akamaihd.net/files/master_2015-04-20/my-application.bundle_1928f8a0.js"`.
1210
+ * If loading from that URL fails, the loader will then attempt to load this script resource from
1211
+ * `"https://contoso.msecnd.net/files/master_2015-04-20/my-application.bundle_1928f8a0.js"`.
1212
+ * If that URL fails to load, the component will fail to load and an error will be returned.
1213
+ *
1214
+ * Supported values: The path to the module either as a fully-qualified URL or as a path under the
1215
+ * paths provided in the "internalModuleBaseUrls" field.
1216
+ *
1217
+ * Example: `"master_2015-04-20/my-application.bundle_1928f8a0.js"`
1218
+ */
1219
+ path: string | IIntegrityPath;
1220
+ /**
1221
+ * If this property is specified, this module is considered non-AMD and
1222
+ * the module loader will not expect "define" or "require" to be called.
1223
+ *
1224
+ * @remarks
1225
+ * In order to load scripts that don't follow the AMD/module-pattern where "define" or "require" is
1226
+ * called and dependencies are explicitly listed and exports are explicitly returned, the module loader needs to
1227
+ * know which global variable must be examined. If this property is specified, this module is considered non-AMD and
1228
+ * the module loader will not expect "define" or "require" to be called. Instead, it will wait for the script to
1229
+ * finish loading and examine the global variable specified in this field.
1230
+ *
1231
+ * Supported values: Variable names that are expected to be populated after this module is loaded. For example,
1232
+ * if this module is describing jQuery, this value should probably be "$". If an empty string is specified,
1233
+ * the module loader will throw an exception and the component will fail to load.
1234
+ *
1235
+ * Example: `"$"`
1236
+ */
1237
+ globalName?: string;
1238
+ /**
1239
+ * For non-AMD/module-pattern scripts that have dependencies (for example, jQuery plugins), the module
1240
+ * loader will ensure that those dependencies are already loaded.
1241
+ *
1242
+ * @remarks
1243
+ * Entries in the array specified in this field must refer to other non-AMD modules in this component. This field
1244
+ * is not required to have a value for non-AMD modules. If any values are specified that do not refer to other
1245
+ * modules in the same component manifest that this module is specified, the module loader will throw an exception
1246
+ * and the component will fail to load.
1247
+ *
1248
+ * Supported values: Names of other non-AMD-pattern modules in this loader configuration, as specified by the key
1249
+ * `IClientSideComponentLoaderConfiguration.scriptResources[]`
1250
+ *
1251
+ * Example: `["jquery"]`
1252
+ */
1253
+ globalDependencies?: string[];
1254
+ }
623
1255
 
624
1256
  /* Excluded from this release type: IPreloadOptions */
625
1257
 
626
1258
  /* Excluded from this release type: ManifestType */
627
1259
 
628
- /* Excluded from this release type: PredefinedGroup */
1260
+ /**
1261
+ * Predefined web part group.
1262
+ *
1263
+ * @beta
1264
+ */
1265
+ export declare const enum PredefinedGroup {
1266
+ /**
1267
+ * Text, media and content.
1268
+ *
1269
+ * This group includes web parts that display text, multi-media, documents, information from the web, and other
1270
+ * rich content.
1271
+ *
1272
+ * @beta
1273
+ */
1274
+ TextMediaAndContent = "cf066440-0614-43d6-98ae-0b31cf14c7c3",
1275
+ /**
1276
+ * Discovery.
1277
+ *
1278
+ * This group includes web parts that organize, group, and filter content to help users discover information.
1279
+ *
1280
+ * @beta
1281
+ */
1282
+ DocumentsListsAndLibraries = "1edbd9a8-0bfb-4aa2-9afd-14b8c45dd489",
1283
+ /**
1284
+ * Communication and collaboration.
1285
+ *
1286
+ * This group includes web parts that facilitate information sharing, team work, and social interactions.
1287
+ *
1288
+ * @beta
1289
+ */
1290
+ Feeds = "75e22ed5-fa14-4829-850a-c890608aca2d",
1291
+ /**
1292
+ * Planning and process.
1293
+ *
1294
+ * This group includes web parts that empower team productivity with the use of planning and process tools.
1295
+ *
1296
+ * @beta
1297
+ */
1298
+ NewsPeopleAndEvents = "1bc7927e-4a5e-4520-b540-71305c79c20a",
1299
+ /**
1300
+ * Business and intelligence.
1301
+ *
1302
+ * This group includes web parts for tracking and analyzing data, and for integrating business flow with pages.
1303
+ *
1304
+ * @beta
1305
+ */
1306
+ DataAnalysis = "4aca9e90-eff5-4fa1-bac7-728f5f157b66",
1307
+ /**
1308
+ * Regional information
1309
+ *
1310
+ * This group includes web parts that display information based on current region and geographical location
1311
+ *
1312
+ * @beta
1313
+ */
1314
+ RegionalInformation = "cfc8bda5-cb9b-49e3-8526-2ee6e52b256a",
1315
+ /**
1316
+ * Other.
1317
+ *
1318
+ * This group includes web parts not in other groups.
1319
+ *
1320
+ * @beta
1321
+ */
1322
+ Advanced = "5c03119e-3074-46fd-976b-c60198311f70",
1323
+ /**
1324
+ * Other.
1325
+ *
1326
+ * This group includes local web parts.
1327
+ *
1328
+ * @beta
1329
+ */
1330
+ Local = "8b7bf6f1-a56a-4aa3-8657-7eb6e7e6af61"
1331
+ }
629
1332
 
630
1333
  export { }
@@ -5,7 +5,7 @@
5
5
  "toolPackages": [
6
6
  {
7
7
  "packageName": "@microsoft/api-extractor",
8
- "packageVersion": "7.31.2"
8
+ "packageVersion": "7.34.4"
9
9
  }
10
10
  ]
11
11
  }
@@ -252,5 +252,25 @@ export interface IClientSideComponentManifest extends IClientSideManifestBase {
252
252
  properties?: {
253
253
  [key: string]: any;
254
254
  };
255
+ /**
256
+ * UTC time of when an app is deployed to app catalog OR installed to site.
257
+ *
258
+ * @remarks
259
+ *
260
+ * If an app is tenant deployed, manifestActivatedTime represents when the app is deployed to app catalog.
261
+ *
262
+ * If an app is feature deployed, manifestActivatedTime represents when the app is installed to current site.
263
+ *
264
+ * @internal
265
+ */
266
+ manifestActivatedTime?: string;
267
+ /**
268
+ * An untyped property bag for experimental flags not ready for production.
269
+ *
270
+ * @alpha
271
+ */
272
+ experimentalData?: {
273
+ [key: string]: any;
274
+ };
255
275
  }
256
276
  //# sourceMappingURL=IClientSideComponentManifest.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"IClientSideComponentManifest.d.ts","sourceRoot":"","sources":["../../src/manifestSchemas/IClientSideComponentManifest.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uCAAuC,EAAE,MAAM,2CAA2C,CAAC;AACpG,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAEpE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,MAAM,WAAW,gBAAgB;IAC/B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;CACtC;AAED;;;GAGG;AACH,oBAAY,aAAa,GAAG,aAAa,GAAG,SAAS,GAAG,SAAS,GAAG,WAAW,GAAG,uBAAuB,CAAC;AAE1G;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,WAAW,4BAA6B,SAAQ,uBAAuB;IAC3E;;;;;;;;;;;;OAYG;IACH,aAAa,EAAE,aAAa,CAAC;IAE7B;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;;;;;;;;;;;OAcG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;;;;;;;;;;OAYG;IACH,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;IAE7B;;;OAGG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;;;OAIG;IACH,4BAA4B,CAAC,EAAE,OAAO,CAAC;IAEvC;;;;;;;;;;OAUG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAE/B;;;;;;;;;;;OAWG;IACH,YAAY,EAAE,uCAAuC,CAAC;IAEtD;;;;;;;;OAQG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;;;;;;;;;OAUG;IACH,UAAU,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;CACrC"}
1
+ {"version":3,"file":"IClientSideComponentManifest.d.ts","sourceRoot":"","sources":["../../src/manifestSchemas/IClientSideComponentManifest.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uCAAuC,EAAE,MAAM,2CAA2C,CAAC;AACpG,OAAO,EAAE,uBAAuB,EAAE,MAAM,2BAA2B,CAAC;AAEpE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,MAAM,WAAW,gBAAgB;IAC/B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAAC;CACtC;AAED;;;GAGG;AACH,oBAAY,aAAa,GAAG,aAAa,GAAG,SAAS,GAAG,SAAS,GAAG,WAAW,GAAG,uBAAuB,CAAC;AAE1G;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,MAAM,WAAW,4BAA6B,SAAQ,uBAAuB;IAC3E;;;;;;;;;;;;OAYG;IACH,aAAa,EAAE,aAAa,CAAC;IAE7B;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;;;;;;;;;;;OAcG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IAErB;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IAEnB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;;;;;;;;;;OAYG;IACH,iBAAiB,CAAC,EAAE,MAAM,EAAE,CAAC;IAE7B;;;OAGG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;;;OAIG;IACH,4BAA4B,CAAC,EAAE,OAAO,CAAC;IAEvC;;;;;;;;;;OAUG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAE/B;;;;;;;;;;;OAWG;IACH,YAAY,EAAE,uCAAuC,CAAC;IAEtD;;;;;;;;OAQG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,sBAAsB,CAAC,EAAE,MAAM,CAAC;IAEhC;;;;;;;;;;OAUG;IACH,UAAU,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAC;IAEpC;;;;;;;;;;OAUG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B;;;;OAIG;IACH,gBAAgB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAkC;CAC5E"}
@@ -175,6 +175,15 @@ export interface IClientSideWebPartManifest<TProperties> extends IClientSideComp
175
175
  propertiesMetadata?: {
176
176
  current: any;
177
177
  };
178
+ /**
179
+ * Definition: If true, notifies that the web part will render an iframe with a page from the same SharePoint tenant (domain).
180
+ * Example: display a SharePoint Page in an iframe.
181
+ *
182
+ * @remarks
183
+ * Usage: Use this flag if a web part will render an iframe with a page from the same SharePoint tenant (domain)
184
+ * and will be hosted as a Teams application (supportedHosts contains any of Teams hosts).
185
+ */
186
+ supportsSelfFramingInTeams?: boolean;
178
187
  }
179
188
  /**
180
189
  * Manifest that is relevant to a Web Part instance.
@@ -1 +1 @@
1
- {"version":3,"file":"IClientSideWebPartManifest.d.ts","sourceRoot":"","sources":["../../src/manifestSchemas/IClientSideWebPartManifest.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,4BAA4B,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAEhG;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,0BAA0B,CAAC,WAAW,CAAE,SAAQ,4BAA4B;IAC3F;;;;;;OAMG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IAEjC;;;;;;;OAOG;IACH,2BAA2B,CAAC,EAAE,OAAO,CAAC;IAEtC;;;;OAIG;IACH,gBAAgB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAkC;IAE3E;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B;;;;;;;;;;;;;OAaG;IACH,oBAAoB,CAAC,EAAE,qBAAqB,CAAC;IAE7C;;;;;;;;;;OAUG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,cAAc,GAAG,iBAAiB,CAAC;IAE7D;;;;;;;;;OASG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;;;;;;;;;;;OAYG;IACH,0CAA0C,CAAC,EAAE,OAAO,CAAC;IAErD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,oBAAoB,EAAE,+BAA+B,CAAC,WAAW,CAAC,EAAE,CAAC;IAErE;;;;;;;;;;;OAWG;IACH,cAAc,CAAC,EAAE,KAAK,CACpB,oBAAoB,GAAG,mBAAmB,GAAG,UAAU,GAAG,kBAAkB,GAAG,iBAAiB,CACjG,CAAC;IAEF;;;;;;;;OAQG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,kBAAkB,CAAC,EAAE;QAEnB,OAAO,EAAE,GAAG,CAAC;KACd,CAAC;CACH;AAED;;;;GAIG;AAEH,MAAM,WAAW,kCAAkC,CAAC,WAAW,CAAE,SAAQ,4BAA4B;CAAG;AAExG;;;;;;GAMG;AACH,MAAM,WAAW,+BAA+B,CAAC,WAAW;IAC1D;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,KAAK,EAAE,gBAAgB,CAAC;IAExB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,WAAW,EAAE,gBAAgB,CAAC;IAE9B;;;;;;;;;;;OAWG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;;;;;;;;;;;;;;OAeG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;;;;;;;;;OAYG;IACH,OAAO,EAAE,eAAe,GAAG,MAAM,CAAC;IAElC;;;;;;;;;OASG;IACH,KAAK,CAAC,EAAE,gBAAgB,CAAC;IAEzB;;;;;;;;;OASG;IACH,IAAI,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAE1B;;;;;;;;;;;;;;;;OAgBG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;;;;;;;;;OAcG;IACH,UAAU,EAAE,WAAW,CAAC;IAExB;;;;;;;;;;;;OAYG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;CAClC;AAED;;;;GAIG;AACH,0BAAkB,eAAe;IAC/B;;;;;;;OAOG;IACH,mBAAmB,yCAAyC;IAE5D;;;;;;OAMG;IACH,0BAA0B,yCAAyC;IAEnE;;;;;;OAMG;IACH,KAAK,yCAAyC;IAE9C;;;;;;OAMG;IACH,mBAAmB,yCAAyC;IAE5D;;;;;;OAMG;IACH,YAAY,yCAAyC;IAErD;;;;;;OAMG;IACH,mBAAmB,yCAAyC;IAE5D;;;;;;OAMG;IACH,QAAQ,yCAAyC;IAEjD;;;;;;OAMG;IACH,KAAK,yCAAyC;CAC/C;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;;;OAKG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,eAAe,GAAG,WAAW,CAAC,CAAC;CAC5D"}
1
+ {"version":3,"file":"IClientSideWebPartManifest.d.ts","sourceRoot":"","sources":["../../src/manifestSchemas/IClientSideWebPartManifest.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,EAAE,4BAA4B,EAAE,gBAAgB,EAAE,MAAM,gCAAgC,CAAC;AAEhG;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,0BAA0B,CAAC,WAAW,CAAE,SAAQ,4BAA4B;IAC3F;;;;;;OAMG;IACH,sBAAsB,CAAC,EAAE,OAAO,CAAC;IAEjC;;;;;;;OAOG;IACH,2BAA2B,CAAC,EAAE,OAAO,CAAC;IAEtC;;;;OAIG;IACH,gBAAgB,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,GAAG,CAAA;KAAE,CAAkC;IAE3E;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAE5B;;;;;;;;;;;;;OAaG;IACH,oBAAoB,CAAC,EAAE,qBAAqB,CAAC;IAE7C;;;;;;;;;;OAUG;IACH,cAAc,CAAC,EAAE,MAAM,GAAG,cAAc,GAAG,iBAAiB,CAAC;IAE7D;;;;;;;;;OASG;IACH,qBAAqB,CAAC,EAAE,OAAO,CAAC;IAEhC;;;;;;;;;;;;OAYG;IACH,0CAA0C,CAAC,EAAE,OAAO,CAAC;IAErD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,oBAAoB,EAAE,+BAA+B,CAAC,WAAW,CAAC,EAAE,CAAC;IAErE;;;;;;;;;;;OAWG;IACH,cAAc,CAAC,EAAE,KAAK,CACpB,oBAAoB,GAAG,mBAAmB,GAAG,UAAU,GAAG,kBAAkB,GAAG,iBAAiB,CACjG,CAAC;IAEF;;;;;;;;OAQG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,kBAAkB,CAAC,EAAE;QAEnB,OAAO,EAAE,GAAG,CAAC;KACd,CAAC;IAEF;;;;;;;OAOG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;CACtC;AAED;;;;GAIG;AAEH,MAAM,WAAW,kCAAkC,CAAC,WAAW,CAAE,SAAQ,4BAA4B;CAAG;AAExG;;;;;;GAMG;AACH,MAAM,WAAW,+BAA+B,CAAC,WAAW;IAC1D;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,KAAK,EAAE,gBAAgB,CAAC;IAExB;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,WAAW,EAAE,gBAAgB,CAAC;IAE9B;;;;;;;;;;;OAWG;IACH,wBAAwB,CAAC,EAAE,MAAM,CAAC;IAElC;;;;;;;;;;;;;;;OAeG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;;;;;;;;;;;OAYG;IACH,OAAO,EAAE,eAAe,GAAG,MAAM,CAAC;IAElC;;;;;;;;;OASG;IACH,KAAK,CAAC,EAAE,gBAAgB,CAAC;IAEzB;;;;;;;;;OASG;IACH,IAAI,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAE1B;;;;;;;;;;;;;;;;OAgBG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;;;;;;;;;OAcG;IACH,UAAU,EAAE,WAAW,CAAC;IAExB;;;;;;;;;;;;OAYG;IACH,uBAAuB,CAAC,EAAE,MAAM,CAAC;CAClC;AAED;;;;GAIG;AACH,0BAAkB,eAAe;IAC/B;;;;;;;OAOG;IACH,mBAAmB,yCAAyC;IAE5D;;;;;;OAMG;IACH,0BAA0B,yCAAyC;IAEnE;;;;;;OAMG;IACH,KAAK,yCAAyC;IAE9C;;;;;;OAMG;IACH,mBAAmB,yCAAyC;IAE5D;;;;;;OAMG;IACH,YAAY,yCAAyC;IAErD;;;;;;OAMG;IACH,mBAAmB,yCAAyC;IAE5D;;;;;;OAMG;IACH,QAAQ,yCAAyC;IAEjD;;;;;;OAMG;IACH,KAAK,yCAAyC;CAC/C;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;;;OAKG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,eAAe,GAAG,WAAW,CAAC,CAAC;CAC5D"}
@@ -24,7 +24,12 @@
24
24
  "assemblyId": { "$ref": "any-value.schema.json" },
25
25
  "safeWithCustomScriptDisabled": { "$ref": "any-value.schema.json" },
26
26
  "requiresCustomScript": { "$ref": "any-value.schema.json" },
27
- "hasSuiteNav": { "$ref": "any-value.schema.json" }
27
+ "hasSuiteNav": { "$ref": "any-value.schema.json" },
28
+ "experimentalData": {
29
+ "type": "object",
30
+ "title": "Experimental property bag",
31
+ "description": "Only use for properties not ready for production."
32
+ }
28
33
  },
29
34
  "additionalProperties": false
30
35
  },
@@ -138,6 +138,11 @@
138
138
  "TeamsMeetingApp"
139
139
  ]
140
140
  }
141
+ },
142
+ "supportsSelfFramingInTeams": {
143
+ "type": "boolean",
144
+ "title": "Allow to iframe pages from the same SharePoint tenant (domain)",
145
+ "description": "If set to \"true\", this web part can have iframed pages from the same tenant (domain). The flag is only applicable to web parts that are hosted as Teams applications."
141
146
  }
142
147
  },
143
148
  "additionalProperties": false
@@ -162,13 +167,13 @@
162
167
 
163
168
  "linkPropertyNames": {
164
169
  "title": "Link Property Names",
165
- "description": "List of names of Web Part properties that are links and need to be link fixed up. Link fixup is a SharePoint feature to help make sure SharePoint internal links in the content are correct. Pages and content can be moved around within SharePoint site hierarchy.",
170
+ "description": "(Deprecated) Please use Web Part propertiesMetadata field instead.",
166
171
  "$ref": "#/definitions/propertyNamesArray"
167
172
  },
168
173
 
169
174
  "imageLinkPropertyNames": {
170
175
  "title": "Image Link Property Names",
171
- "description": "List of names of Web Part properties that are image sources and need to be link fixed up and potentially preloaded for performance reasons.",
176
+ "description": "(Deprecated) Please use Web Part propertiesMetadata field instead.",
172
177
  "$ref": "#/definitions/propertyNamesArray"
173
178
  },
174
179
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@microsoft/sp-module-interfaces",
3
- "version": "1.16.1",
3
+ "version": "1.17.0-beta.3",
4
4
  "description": "SharePoint Framework module interfaces",
5
5
  "license": "https://aka.ms/spfx/license",
6
6
  "homepage": "http://aka.ms/spfx",
@@ -14,12 +14,12 @@
14
14
  "tsdocFlavor": "AEDoc"
15
15
  },
16
16
  "dependencies": {
17
- "@rushstack/node-core-library": "3.52.0",
17
+ "@rushstack/node-core-library": "3.55.2",
18
18
  "z-schema": "4.2.4"
19
19
  },
20
20
  "devDependencies": {
21
- "@odsp-web-tools/internal-node-rig": "0.1.0",
22
- "@rushstack/heft": "0.47.11"
21
+ "@rushstack/heft": "0.49.7",
22
+ "@odsp-web-tools/internal-node-rig": "0.1.0"
23
23
  },
24
24
  "scripts": {
25
25
  "build": "heft test --clean",