@microsoft/sp-module-interfaces 1.18.0-beta.5 → 1.18.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -11,258 +11,9 @@ export declare type ComponentType = 'Application' | 'WebPart' | 'Library' | 'Ext
11
11
  */
12
12
  export declare type ExtensionType = 'Unknown' | 'ApplicationCustomizer' | 'FieldCustomizer' | 'ListViewCommandSet' | 'SearchQueryModifier';
13
13
 
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
- }
14
+ /* Excluded from this release type: IAdaptiveCardExtensionManifest */
113
15
 
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
- }
16
+ /* Excluded from this release type: IAdaptiveCardExtensionManifestEntry */
266
17
 
267
18
  /* Excluded from this release type: ICapabilityCollection */
268
19
 
@@ -286,120 +37,7 @@ export declare interface IClientSideAssemblyManifest extends IClientSideComponen
286
37
  rootComponentId: string;
287
38
  }
288
39
 
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
- }
40
+ /* Excluded from this release type: IClientSideComponentLoaderConfiguration */
403
41
 
404
42
  /**
405
43
  * All client-side components built on the SharePoint framework need a valid component manifest. This interface
@@ -508,19 +146,7 @@ export declare interface IClientSideComponentManifest extends IClientSideManifes
508
146
  * Usage: Requires Custom Script to be allowed in order for this component to be installed and run.
509
147
  */
510
148
  requiresCustomScript?: boolean;
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;
149
+ /* Excluded from this release type: loaderConfig */
524
150
  /* Excluded from this release type: isolatedDomain */
525
151
  /* Excluded from this release type: storeAppId */
526
152
  /* Excluded from this release type: mpnId */
@@ -811,42 +437,9 @@ export declare interface IClientSideWebPartManifestEntry<TProperties> {
811
437
  * Example: `"https://contoso.akamaihd.net/files/myWebpartIcon.png"`
812
438
  */
813
439
  iconImageUrl?: string;
814
- /**
815
- * The group id to determine which modern group contains the web part in modern site page. The SharePoint
816
- * Framework reserves group ids for predefined groups. The developer can pick one from those groups. If the developer
817
- * fills an id not in the predefined groups, it falls back to Other group.
818
- *
819
- * @remarks
820
- *
821
- * Supported values: the GUID from PredefinedGroup list
822
- *
823
- * Example: `"cf066440-0614-43d6-98ae-0b31cf14c7c3"`
824
- *
825
- * @beta
826
- */
827
- groupId: PredefinedGroup | string;
828
- /**
829
- * The group name in web part picker to contain the web part in the classic page. If no value is provided,
830
- * then the web part will be displayed in the Miscellaneous group.
831
- *
832
- * @remarks
833
- *
834
- * Example: `{ "default": "Media and Content" }`
835
- *
836
- * @beta
837
- */
838
- group?: ILocalizedString;
839
- /**
840
- * This field is used to tag a web part with keywords that are different from the web part group name.
841
- * Tags can be used for categorization and searching of web parts. For example, in the web part toolbox.
842
- *
843
- * @remarks
844
- *
845
- * Example `[{ "default": "image" }, { "default": "media" }, { "default": "picture" }, ...]`
846
- *
847
- * @beta
848
- */
849
- tags?: ILocalizedString[];
440
+ /* Excluded from this release type: groupId */
441
+ /* Excluded from this release type: group */
442
+ /* Excluded from this release type: tags */
850
443
  /**
851
444
  * Definition: Use this field to specify the data version of the pre-configured data provided to the web part.
852
445
  * Note that data version is different from the version field in the manifest.
@@ -978,124 +571,11 @@ export declare interface ICommandSetExtensionManifest extends IClientSideExtensi
978
571
  };
979
572
  }
980
573
 
981
- /**
982
- * This is the interface for a script module with the "component" type. Modules of this type will be provided via
983
- * manifests. In order for the dependency to be loaded, the manifest must be available on the site.
984
- *
985
- * @beta
986
- */
987
- export declare interface IComponentModuleConfiguration extends IModuleConfigurationBase {
988
- type: 'component';
989
- /**
990
- * The version of the framework-supplied component to be loaded. For framework runtime component such as
991
- * `@microsoft/sp-client-base`, it is recommended the version of the framework component the component was developed
992
- * against be specified.
993
- *
994
- * @remarks
995
- *
996
- * Supported values: string representing a {@link http://semver.org | semantic version}, or "latest".
997
- *
998
- * Example: `"2.2.4"`
999
- */
1000
- version: string;
1001
- /**
1002
- * The ID of the framework-supplied component to be loaded.
1003
- *
1004
- * @remarks
1005
- *
1006
- * Supported values: string representing a component's ID.
1007
- *
1008
- * Example: `"0d910c1c-13b9-4e1c-9aa4-b008c5e42d7d"`
1009
- */
1010
- id: string;
1011
- /**
1012
- * A path to the framework-supplied component in case the framework fails to load the requested version.
1013
- *
1014
- * @remarks
1015
- * This must be either a fully-qualified URL, or a path under the paths specified in the `internalModuleBaseUrls`
1016
- * field. If this field is not specified and the version is not available in the framework runtime, the closest
1017
- * matching version of the component will be provided instead.
1018
- *
1019
- * Supported values: The path to the component either as a fully-qualified URL or as a path under the
1020
- * paths provided in the "internalModuleBaseUrls" field.
1021
- *
1022
- * Example: `"https://code.jquery.com/jquery-2.2.4.min.js"`
1023
- */
1024
- failoverPath?: string | IIntegrityPath;
1025
- }
574
+ /* Excluded from this release type: IComponentModuleConfiguration */
1026
575
 
1027
- /**
1028
- * A path with the subresource integrity hash of the resource.
1029
- *
1030
- * @beta
1031
- */
1032
- export declare interface IIntegrityPath {
1033
- /**
1034
- * The path to the resource.
1035
- */
1036
- path: string;
1037
- /**
1038
- * The subresource integrity hash of the resource referenced in {@link IIntegrityPath.path}.
1039
- */
1040
- integrity?: string;
1041
- }
576
+ /* Excluded from this release type: IIntegrityPath */
1042
577
 
1043
- /**
1044
- * This is the interface for a script module with the "localizedPath" type.
1045
- *
1046
- * @remarks
1047
- * Modules of this type must be provided by the component developer. These script resources are similar to those of
1048
- * the "path" type, but they may be present at a number of different paths, to be selected by the user's locale.
1049
- * Paths in this module type are loaded exactly the same way as "internal" modules are.
1050
- *
1051
- * @beta
1052
- */
1053
- export declare interface ILocalizedPathModuleConfiguration extends IModuleConfigurationBase {
1054
- type: 'localizedPath';
1055
- /**
1056
- * A path to this module's default locale javascript resource either as a fully-qualified URL or as a
1057
- * path under the paths provided in the "internalModuleBaseUrls" field.
1058
- *
1059
- * @remarks
1060
- * If the user's locale does not resolve to one of the paths specified in the "paths" field, the path in this
1061
- * field is used. Paths in this module type are treated exactly the same way paths in modules of the "internal"
1062
- * type are treated.
1063
- *
1064
- * Supported values: The path to the default locale version of the module either as a fully-qualified URL or as a path
1065
- * under the paths provided in the "internalModuleBaseUrls" field.
1066
- *
1067
- * Example: `"master_2015-04-20/my-application_strings_default_af378e0d.js"`
1068
- */
1069
- defaultPath: string | IIntegrityPath;
1070
- /**
1071
- * This is a dictionary of locale keys (in the `"ll-cc"` format) to paths to this module's locale
1072
- * javascript resource either as a fully-qualified URL or as a path under the paths provided in the
1073
- * `"internalModuleBaseUrls"` field.
1074
- *
1075
- * @remarks
1076
- * The loader will attempt to resolve the user's locale to one of the paths provided by this field, and will load
1077
- * the script resource under that path. If the user's locale does not resolve to one of the paths specified in this
1078
- * field, the path in `"defaultPath"` field is used. For example, if the user's locale is `"en-gb"`, and this field's
1079
- * value contains the keys `[ "en-us", "en-gb", "fr-fr" ]`, the path specified by the `"en-gb"` key will be used.
1080
- * If the user's locale is "en-gb", and this field's value contains the keys `[ "en-us", "fr-fr" ]`, the path
1081
- * specified by the `"en-us"` key will be used. If the user's locale is `"en-gb"`, and this field's value contains
1082
- * the keys `[ "es-es", "fr-fr" ]`, the path specified by the "defaultPath" field will be used.
1083
- * Paths in this module type are treated exactly the same way paths in modules of the "internal" type are treated.
1084
- *
1085
- * Supported values: A dictionary of locale-to-path mappings.
1086
- *
1087
- * Example:
1088
- * ```
1089
- * {
1090
- * "en-us": "master_2015-04-20/my-application_strings_en-us_d38ff012.js",
1091
- * "fr-fr": "master_2015-04-20/my-application_strings_fr-fr_138af7e4.js"
1092
- * }
1093
- * ```
1094
- */
1095
- paths?: {
1096
- [locale: string]: string | IIntegrityPath;
1097
- };
1098
- }
578
+ /* Excluded from this release type: ILocalizedPathModuleConfiguration */
1099
579
 
1100
580
  /**
1101
581
  * A set of localized strings.
@@ -1143,188 +623,16 @@ export declare interface ILocalizedString {
1143
623
  [locale: string]: string | undefined;
1144
624
  }
1145
625
 
1146
- /**
1147
- * @beta
1148
- */
1149
- export declare type IModuleConfiguration = IComponentModuleConfiguration | IPathModuleConfiguration | ILocalizedPathModuleConfiguration;
626
+ /* Excluded from this release type: IModuleConfiguration */
1150
627
 
1151
- /**
1152
- * This is the base interface for a script module's definition.
1153
- *
1154
- * @beta
1155
- */
1156
- export declare interface IModuleConfigurationBase {
1157
- /**
1158
- * The type of the script block. `"component"` modules come from a component,
1159
- * `"path"` and `"localizedPath"` modules must be available on the paths provided in
1160
- * the `"internalModuleBaseUrls"` field.
1161
- *
1162
- * @remarks
1163
- *
1164
- * Modules with the `"path"` type use the `IPathModuleConfiguration` interface.
1165
- *
1166
- * Modules with the `"component"` type use the `IComponentModuleConfiguration` interface.
1167
- * Modules with the "localizedPath" type use the `ILocalizedPathModuleConfiguration` interface.
1168
- *
1169
- * Supported values: `"component"`, `"path"`, `"localizedPath"`
1170
- *
1171
- * Example: `"localized"`
1172
- */
1173
- type: 'component' | 'path' | 'localizedPath';
1174
- /**
1175
- * If set to `true`, this module should not be preloaded when loading the component.
1176
- *
1177
- * @remarks
1178
- * The most common case for setting this property to "true" is when a module is defined in a manifest,
1179
- * but is not required for the module referenced in "entryModuleId" to load. Modules may be defined that
1180
- * are loaded asynchronously, and these modules do not need to be preloaded. This field implicitly defaults
1181
- * to `false`.
1182
- *
1183
- * Usage: Instructs the module loader to not preload this module.
1184
- */
1185
- shouldNotPreload?: boolean;
1186
- }
628
+ /* Excluded from this release type: IModuleConfigurationBase */
1187
629
 
1188
- /**
1189
- * This is the interface for a script module with the "path" type. Modules of this type must be provided by the
1190
- * component developer.
1191
- *
1192
- * @beta
1193
- */
1194
- export declare interface IPathModuleConfiguration extends IModuleConfigurationBase {
1195
- type: 'path';
1196
- /**
1197
- * A path to this module's javascript resource either as a fully-qualified URL or as a path under the
1198
- * paths provided in the `internalModuleBaseUrls` field.
1199
- *
1200
- * @remarks
1201
- *
1202
- * For example, if this field's value is `"master_2015-04-20/my-application.bundle_1928f8a0.js"` and
1203
- * the `"internalModuleBaseUrls"` field's value is
1204
- * `[ "https://contoso.akamaihd.net/files/", "https://contoso.msecnd.net/files/" ]`, the loader will
1205
- * first attempt to load this script resource from the URL
1206
- * `"https://contoso.akamaihd.net/files/master_2015-04-20/my-application.bundle_1928f8a0.js"`.
1207
- * If loading from that URL fails, the loader will then attempt to load this script resource from
1208
- * `"https://contoso.msecnd.net/files/master_2015-04-20/my-application.bundle_1928f8a0.js"`.
1209
- * If that URL fails to load, the component will fail to load and an error will be returned.
1210
- *
1211
- * Supported values: The path to the module either as a fully-qualified URL or as a path under the
1212
- * paths provided in the "internalModuleBaseUrls" field.
1213
- *
1214
- * Example: `"master_2015-04-20/my-application.bundle_1928f8a0.js"`
1215
- */
1216
- path: string | IIntegrityPath;
1217
- /**
1218
- * If this property is specified, this module is considered non-AMD and
1219
- * the module loader will not expect "define" or "require" to be called.
1220
- *
1221
- * @remarks
1222
- * In order to load scripts that don't follow the AMD/module-pattern where "define" or "require" is
1223
- * called and dependencies are explicitly listed and exports are explicitly returned, the module loader needs to
1224
- * know which global variable must be examined. If this property is specified, this module is considered non-AMD and
1225
- * the module loader will not expect "define" or "require" to be called. Instead, it will wait for the script to
1226
- * finish loading and examine the global variable specified in this field.
1227
- *
1228
- * Supported values: Variable names that are expected to be populated after this module is loaded. For example,
1229
- * if this module is describing jQuery, this value should probably be "$". If an empty string is specified,
1230
- * the module loader will throw an exception and the component will fail to load.
1231
- *
1232
- * Example: `"$"`
1233
- */
1234
- globalName?: string;
1235
- /**
1236
- * For non-AMD/module-pattern scripts that have dependencies (for example, jQuery plugins), the module
1237
- * loader will ensure that those dependencies are already loaded.
1238
- *
1239
- * @remarks
1240
- * Entries in the array specified in this field must refer to other non-AMD modules in this component. This field
1241
- * is not required to have a value for non-AMD modules. If any values are specified that do not refer to other
1242
- * modules in the same component manifest that this module is specified, the module loader will throw an exception
1243
- * and the component will fail to load.
1244
- *
1245
- * Supported values: Names of other non-AMD-pattern modules in this loader configuration, as specified by the key
1246
- * `IClientSideComponentLoaderConfiguration.scriptResources[]`
1247
- *
1248
- * Example: `["jquery"]`
1249
- */
1250
- globalDependencies?: string[];
1251
- }
630
+ /* Excluded from this release type: IPathModuleConfiguration */
1252
631
 
1253
632
  /* Excluded from this release type: IPreloadOptions */
1254
633
 
1255
634
  /* Excluded from this release type: ManifestType */
1256
635
 
1257
- /**
1258
- * Predefined web part group.
1259
- *
1260
- * @beta
1261
- */
1262
- export declare const enum PredefinedGroup {
1263
- /**
1264
- * Text, media and content.
1265
- *
1266
- * This group includes web parts that display text, multi-media, documents, information from the web, and other
1267
- * rich content.
1268
- *
1269
- * @beta
1270
- */
1271
- TextMediaAndContent = "cf066440-0614-43d6-98ae-0b31cf14c7c3",
1272
- /**
1273
- * Discovery.
1274
- *
1275
- * This group includes web parts that organize, group, and filter content to help users discover information.
1276
- *
1277
- * @beta
1278
- */
1279
- DocumentsListsAndLibraries = "1edbd9a8-0bfb-4aa2-9afd-14b8c45dd489",
1280
- /**
1281
- * Communication and collaboration.
1282
- *
1283
- * This group includes web parts that facilitate information sharing, team work, and social interactions.
1284
- *
1285
- * @beta
1286
- */
1287
- Feeds = "75e22ed5-fa14-4829-850a-c890608aca2d",
1288
- /**
1289
- * Planning and process.
1290
- *
1291
- * This group includes web parts that empower team productivity with the use of planning and process tools.
1292
- *
1293
- * @beta
1294
- */
1295
- NewsPeopleAndEvents = "1bc7927e-4a5e-4520-b540-71305c79c20a",
1296
- /**
1297
- * Business and intelligence.
1298
- *
1299
- * This group includes web parts for tracking and analyzing data, and for integrating business flow with pages.
1300
- *
1301
- * @beta
1302
- */
1303
- DataAnalysis = "4aca9e90-eff5-4fa1-bac7-728f5f157b66",
1304
- /**
1305
- * Regional information
1306
- *
1307
- * This group includes web parts that display information based on current region and geographical location
1308
- *
1309
- * @beta
1310
- */
1311
- RegionalInformation = "cfc8bda5-cb9b-49e3-8526-2ee6e52b256a",
1312
- /**
1313
- * Other.
1314
- *
1315
- * This group includes web parts not in other groups.
1316
- *
1317
- * @beta
1318
- */
1319
- Advanced = "5c03119e-3074-46fd-976b-c60198311f70",
1320
- /**
1321
- * Other.
1322
- *
1323
- * This group includes local web parts.
1324
- *
1325
- * @beta
1326
- */
1327
- Local = "8b7bf6f1-a56a-4aa3-8657-7eb6e7e6af61"
1328
- }
636
+ /* Excluded from this release type: PredefinedGroup */
1329
637
 
1330
638
  export { }
package/package.json CHANGED
@@ -1,11 +1,11 @@
1
1
  {
2
2
  "name": "@microsoft/sp-module-interfaces",
3
- "version": "1.18.0-beta.5",
3
+ "version": "1.18.0",
4
4
  "description": "SharePoint Framework module interfaces",
5
5
  "license": "https://aka.ms/spfx/license",
6
6
  "homepage": "http://aka.ms/spfx",
7
7
  "engines": {
8
- "node": ">=12.13.0 <13.0.0 || >=14.15.0 <15.0.0 || >=16.13.0 <17.0.0"
8
+ "node": ">=16.13.0 <17.0.0 || >=18.17.1 <19.0.0"
9
9
  },
10
10
  "main": "lib-commonjs/index.js",
11
11
  "module": "lib/index.js",