@microsoft/sp-module-interfaces 1.15.2 → 1.16.0-beta.1

package/dist/index-internal-beta.d.ts

@@ -713,6 +713,7 @@ export declare interface IClientSideWebPartManifest<TProperties> extends IClient
      * url
      */
     imagePreviewUrl?: string;
+    /* Excluded from this release type: propertiesMetadata */
 }
 
 /**

package/dist/index-internal-public.d.ts

@@ -339,6 +339,7 @@ export declare interface IClientSideWebPartManifest<TProperties> extends IClient
      * url
      */
     imagePreviewUrl?: string;
+    /* Excluded from this release type: propertiesMetadata */
 }
 
 /**

package/dist/index-internal.d.ts

@@ -11,9 +11,258 @@ export declare type ComponentType = 'Application' | 'WebPart' | 'Library' | 'Ext
  */
 export declare type ExtensionType = 'Unknown' | 'ApplicationCustomizer' | 'FieldCustomizer' | 'ListViewCommandSet' | 'SearchQueryModifier';
 
-/* Excluded from this release type: IAdaptiveCardExtensionManifest */
+/**
+ * @beta
+ */
+export declare interface IAdaptiveCardExtensionManifest<TProperties> extends IClientSideComponentManifest {
+    /**
+     * Id matching the Teams SaaS application that the ACE will redirect to when a “full page” experience is required
+     */
+    connectedTeamsAppId?: string;
+    /**
+     * Id of the SPFx application that the ACE will redirect to when a “full page” experience is required
+     */
+    connectedSPFXAppId?: string;
+    /**
+     * Definition: An array defining what host types are supported
+     *
+     *
+     * @remarks
+     * Usage: Use this array to define all hosts that are supported.
+     *
+     */
+    supportedHosts?: ReadonlyArray<'Dashboard'>;
+    /**
+     * Definition: If true, this ACE supports and has been tested for theme variants experience.
+     *
+     * @remarks
+     * Usage: Use this flag if a ACE supports theme variants and has been tested as such.
+     * In order to support theme variants, ACEs must have the capability to render correctly in the context
+     * of a theme variant. An ACE may or may not need to be updated to support theme variants, but should
+     * always be tested before enabling this flag. By default no ACEs support theme variants.
+     *
+     */
+    supportsThemeVariants?: boolean;
+    /**
+     * An untyped property bag for experimental flags not ready for production.
+     *
+     */
+    experimentalData?: {
+        [key: string]: any;
+    };
+    /**
+     * If true, this AdaptiveCardExtension should not be displayed in the modern SharePoint toolbox.
+     *
+     * @remarks
+     * Usage: Use this flag if it is not appropriate to display a AdaptiveCardExtension in the modern toolbox. By default,
+     * all AdaptiveCardExtensions are enabled to be displayed in the toolbox if supportedHosts contains 'SharePointWebPart'
+     * Such AdaptiveCardExtensions can be provisioned on pages though API or be added to the page in a pre configured way.
+     */
+    hiddenFromToolbox?: boolean;
+    /* Excluded from this release type: isolationLevel */
+    /**
+     * Definition:
+     * - If true, the AdaptiveCardExtension will be disposed and reloaded when the AdaptiveCardExtension data is updated by an external source.
+     * - If false, the AdaptiveCardExtension data will be deserialized and the properties of the AdaptiveCardExtension will be updated,
+     *   onAfterPropertiesUpdatedExternally will be executed.
+     * - If undefined, AdaptiveCardExtensions developed with SPFx version below 1.9 will default to true and AdaptiveCardExtensions developed with
+     *   a SPFx version 1.9 or greater will default to false.
+     *
+     * @remarks
+     * By default, onAfterPropertiesUpdatedExternally will re-render the AdaptiveCardExtension. If your AdaptiveCardExtension requires specialized
+     * logic, then it is recommended to override onAfterPropertiesUpdatedExternally.
+     */
+    useFallbackWhenPropertiesUpdatedExternally?: boolean;
+    /**
+     * A AdaptiveCardExtension can have pre-configured properties like the title, description, iconImageUrl, officeFabricIconFontName, toolbox group name
+     * and AdaptiveCardExtension specific custom properties. And there can be multiple instances of these pre-configured properties.
+     *
+     * @remarks
+     * This helps support scenarios where an organization may want to present multiple pre-configured entries
+     * for a AdaptiveCardExtension in the Toolbox. Each entry is expected to configure the AdaptiveCardExtension with a different set
+     * of pre-configured properties. A developer may decide to seed some initial values for these properties
+     * but an organization admin can go ahead and customize these properties per the needs of his/her organization.
+     * The properties can also be modified by the author of the page.
+     *
+     * Usage: help display a AdaptiveCardExtension in the Toolbox, PropertyPane and the initial rendering of the AdaptiveCardExtension.
+     *
+     * Type: JSON object
+     *
+     * Supported values: Array of `IClientSideWebPartManifestEntry` objects.
+     *
+     * Example:
+     * ```
+     *   [{
+     *      "groupId": "5c03119e-3074-46fd-976b-c60198311f70",
+     *      "group": { "default": "Advanced" },
+     *      "title": { "id": "$./ManifestStrings.resx:PrimaryTextL1Template;" },
+     *      "description": { "id": "$./ManifestStrings.resx:PrimaryTextL1TemplateDescription;" },
+     *      "officeFabricIconFontName": "Balloons",
+     *      "properties": {
+     *        "templateType": "primaryText",
+     *        "title": "Primary Text",
+     *        "primaryText": "Basic card",
+     *        "description": "This is an example.",
+     *        "cardSize": "Medium"
+     *      }
+     *    }]
+     * ```
+     */
+    preconfiguredEntries: IAdaptiveCardExtensionManifestEntry<TProperties>[];
+}
 
-/* Excluded from this release type: IAdaptiveCardExtensionManifestEntry */
+/**
+ * This interface specifies the set of properties that can be pre-configured by a AdaptiveCardExtension developer. Each
+ * pre-configured instance of the AdaptiveCardExtension will need a copy of these properties. Organization admins and
+ * content authors can modify these properties on a need basis.
+ *
+ * @beta
+ */
+export declare interface IAdaptiveCardExtensionManifestEntry<TProperties> {
+    /**
+     * Size of the AdaptiveCardExtension when it is rendered. This is value must be one of the supported CardSizes
+     * ["Medium", "Large"] defined in the sp-adaptive-card-base project.
+     */
+    cardSize: string;
+    /**
+     * Title of the AdaptiveCardExtension represented as a single a dictionary of locale keys to title values. This
+     * value will be displayed to the user in the toolbox.
+     *
+     * @remarks
+     * This title should be used in the Toolbox and other display areas. The AdaptiveCardExtension developer may give
+     * an initial title to the AdaptiveCardExtension. The organization admin and page author will have the ability to
+     * change this title as per need.
+     *
+     * Usage: display the name of the AdaptiveCardExtension in the toolbox, web part gallery and the page.
+     *
+     * Supported values: a dictionary of locale keys to strings. Should always have a `'default'` key.
+     *
+     * Example: `"My Webpart"`
+     * ```
+     *          {
+     *            "default": "My WebPart"
+     *            "en-us": "My WebPart",
+     *            "fr-fr": "Ma WebPart",
+     *            "zh": "我的 web 部件"
+     *          }
+     * ```
+     */
+    title: ILocalizedString;
+    /**
+     * Description of the AdaptiveCardExtension represented as a dictionary of locale keys to description values. This
+     * value will be displayed to the user in the toolbox. This description should be used in the Toolbox tooltip and
+     * other display areas.
+     *
+     * @remarks
+     * The AdaptiveCardExtension developer may give an initial description to the AdaptiveCardExtension. The organization
+     * admin and page author will have the ability to change this description as per need.
+     *
+     * Usage: display the description of the AdaptiveCardExtension in the toolbox tooltip, web part gallery and the page.
+     *
+     * Supported values: a dictionary of locale keys to strings. Should always have a `'default'` key.
+     *
+     * Example: `"A tool for displaying neat information."`
+     *
+     * ```
+     *          {
+     *            "default": "A tool for displaying neat information.",
+     *            "en-us": "A tool for displaying neat information.",
+     *            "fr-fr": "Un outil d'affichage des informations soignées.",
+     *            "zh": "用於顯示整潔資訊的工具。"
+     *          }
+     * ```
+     */
+    description: ILocalizedString;
+    /**
+     * The icon for the AdaptiveCardExtension, to be displayed in the toolbox, represented as a character name in the
+     * Office 365 icon font file.
+     *
+     * @remarks
+     * The icon font is specified here: {@link https://aka.ms/uifabric-icons}  If this field has
+     * a value, the {@link IClientSideWebPartManifestEntry.iconImageUrl} field will be ignored.
+     *
+     * Supported values: Any character name in the Office 365 Icon Font.
+     *
+     * Example: "graph"
+     */
+    officeFabricIconFontName?: string;
+    /**
+     * The icon for the AdaptiveCardExtension, to be displayed in the toolbox, represented an image URL. The image at the
+     * URL must be exactly 40x28 px (SPPPLAT VSO#218660 to fix the size of the icon image).
+     *
+     * @remarks
+     *  If the {@link IClientSideWebPartManifestEntry.officeFabricIconFontName} field does not have a value,
+     *  this field must have a value. This value can be an absolute URL (e.g. `"http://example.com/icons/my-icon.png"`) or
+     *  a relative file path (e.g. `"./icons/my-icon.png"`). In the latter case, the path will be resolved relative to
+     *  the folder containing the input manifest. The icon file will be copied to the deployment folder like an asset,
+     *  and the output manifest's iconImageUrl will be replaced with a URL relative to the URL used to load all other
+     *  assets (the loaderConfig.internalModuleBaseUrls property).
+     *
+     * Supported values: Any absolute URL.
+     *
+     * Example: `"https://contoso.akamaihd.net/files/myWebpartIcon.png"`
+     */
+    iconImageUrl?: string;
+    /**
+     * The group id to determine which modern group contains the AdaptiveCardExtension in modern site page. The SharePoint
+     * Framework reserves group ids for predefined groups. The developer can pick one from those groups. If the developer
+     * fills an id not in the predefined groups, it falls back to Other group.
+     *
+     * @remarks
+     *
+     * Supported values: the GUID from PredefinedGroup list
+     *
+     * Example: `"cf066440-0614-43d6-98ae-0b31cf14c7c3"`
+     *
+     * @beta
+     */
+    groupId: PredefinedGroup | string;
+    /**
+     * This field is used to tag a AdaptiveCardExtension with keywords that are different from the AdaptiveCardExtension group name.
+     * Tags can be used for categorization and searching of AdaptiveCardExtensions. For example, in the toolbox.
+     *
+     * @remarks
+     *
+     * Example `[{ "default": "image" }, { "default": "media" }, { "default": "picture" }, ...]`
+     *
+     * @beta
+     */
+    tags?: ILocalizedString[];
+    /**
+     * Definition: Use this field to specify the data version of the pre-configured data provided to the AdaptiveCardExtension.
+     * Note that data version is different from the version field in the manifest.
+     *
+     * @remarks
+     * The manifest version is used to control the versioning of the AdaptiveCardExtension code, while data version is used
+     * to control the versioning of the serialized data of the AdaptiveCardExtension. Refer to dataVersion field of your
+     * AdaptiveCardExtension for more information.
+     *
+     * Usage: versioning and evolving the serialized data of the AdaptiveCardExtension
+     *
+     * Type: string representing a {@link http://semver.org | semantic version} with only two parts
+     *
+     * Supported values: MAJOR.MINOR
+     *
+     * Example: `"1.0"`
+     */
+    dataVersion?: string;
+    /**
+     * Every AdaptiveCardExtension is expected to have some custom properties.  For example, a page AdaptiveCardExtension might define
+     * properties for the page URL and caption text. A list AdaptiveCardExtension may have the list ID and list title as its
+     * properties, and so on.
+     *
+     * @remarks
+     *
+     * The SharePoint Framework passes these properties to the AdaptiveCardExtensions when they are loaded. The AdaptiveCardExtension developer
+     * fully controls the schema for these properties. The AdaptiveCardExtension developer should follow versioning rules when
+     * updating the properties.
+     *
+     * Usage: rendering of the AdaptiveCardExtension
+     *
+     * Example: `{"imageSource": "https://contoso.akamaihd.net/files/contosoLogo.jpg", "captionText": "Contoso logo"}"`
+     */
+    properties: TProperties;
+}
 
 /* Excluded from this release type: ICapabilityCollection */
 
@@ -37,7 +286,120 @@ export declare interface IClientSideAssemblyManifest extends IClientSideComponen
     rootComponentId: string;
 }
 
-/* Excluded from this release type: IClientSideComponentLoaderConfiguration */
+/**
+ * This interface describes how a client-side component is to be loaded and initialized by a SharePoint client
+ * framework. It contains all data for loading an entrypoint script and its dependency scripts.
+ *
+ * @beta
+ */
+export declare interface IClientSideComponentLoaderConfiguration {
+    /**
+     * This is an array of fully-qualified paths to be prepended to each of the script resource paths with the
+     * "internal" or "localized" type. If one fails to load, the loader will attempt to load from the next until there
+     * are no base paths remaining.
+     *
+     * @remarks
+     * All "internal" and "localized" script resources that do not have fully-qualified URLs
+     * as their "path" field values must be hosted under each of the paths listed in this property. For example, if an
+     * internal module's "path" field value is `"master_2015-04-20/my-application.bundle_1928f8a0.js"` and this field's
+     * value is `[ "https://contoso.akamaihd.net/files/", "https://contoso.msecnd.net/files/" ]`, the loader will first
+     * attempt to load this script resource from the URL
+     * `"https://contoso.akamaihd.net/files/master_2015-04-20/my-application.bundle_1928f8a0.js"`. If loading from
+     * that URL fails, the loader will then attempt to load this script resource from
+     * `"https://contoso.msecnd.net/files/master_2015-04-20/my-application.bundle_1928f8a0.js"`. If that URL fails
+     * to load, the component will fail to load and an error will be returned. It is important to note that the support
+     * for multiple base URLs is purely for failover support. This means that all files must be present on all hosts
+     * listed in this field.
+     *
+     * Usage: Base URLs for script resources with the "internal" or "localized" type.
+     *
+     * Supported values: Any URL that contains all internal scripts referenced in the "scriptResources" dictionary.
+     *
+     * Example: `[ "https://contoso.akamaihd.net/files/", "https://contoso.msecnd.net/files/" ]`
+     */
+    internalModuleBaseUrls: string[];
+    /**
+     * This is the ID of one of the entries in the "scriptResources" dictionary.
+     *
+     * @remarks
+     * The loader will download and evaluate the script resource referenced in this field, resolve all dependencies
+     * against the keys in the "scriptResources", and return the exported object to the loader's calling function.
+     * The entry referenced in the "scriptResources" dictionary must be of the "internal" or the "localized" type.
+     *
+     * Supported values: An entry in the "scriptResources" dictionary that defines the base exported module of the
+     * component.
+     *
+     * Example: `"myApplication.bundle"`
+     */
+    entryModuleId: string;
+    /**
+     * The module referenced by the "entryModuleId" field may export an object with several fields.
+     *
+     * @remarks
+     * This value optionally references the name of a field on the object exported by the module referenced by the
+     * `entryModuleId` field. When this field has a value, the value of the referenced field on the object exported
+     * by the module referenced by the `entryModuleId` field is returned when this manifest is loaded instead of
+     * the base exported object. For example, if entryModuleId refers to a module with with a top-level export of
+     * `{ foo: 'bar', baz: 123 }` and:
+     *
+     *    - if this field is unset, the value returned by the module loader is `{ foo: 'bar', baz: 123 }`
+     *
+     *    - if this field is set to `foo`, the value returned by the module loader is `bar`
+     *
+     *    - if this field is set to `bar`, the value returned by the module loader is undefined (as `bar` is not a key in
+     *        the top-level export).
+     *
+     * Example: `mySpWebpart`
+     */
+    exportName?: string;
+    /**
+     * This is a dictionary of named script resources. `path` and `localizedPath` modules may reference each
+     * other and `manifest` modules are expected to be provided by the framework runtime. The resource named in the
+     * `entryModuleId` must contain the component's exported object.
+     *
+     * @remarks
+     *
+     * Supported values: A dictionary of named script resources.
+     *
+     * Example:
+     *
+     * ```
+     *  {
+     *    "myApplication.bundle": {
+     *      "type": "path",
+     *      "path": "master_2015-04-20/my-application.bundle_1928f8a0.js"
+     *    },
+     *    "@microsoft/sp-client-base": {
+     *      "type": "component",
+     *      "id": "af59c2b3-2da7-41fd-8b72-3939817960af",
+     *      "version": "latest"
+     *    },
+     *    "@microsoft/sp-client-preview": {
+     *      "type": "component",
+     *      "id": "4d5eb168-6729-49a8-aec7-0e397f486b6e",
+     *      "version": "latest"
+     *    },
+     *    "jQuery": {
+     *      "type": "component",
+     *      "id": "00000000-0000-0000-0000-000000000000",
+     *      "version": "2.2.4",
+     *      "path": "https://code.jquery.com/jquery-2.2.4.min.js"
+     *    },
+     *    "myApplication_strings": {
+     *      "type": "localizedPath",
+     *      "defaultPath": "master_2015-04-20/my-application_strings_default_af378e0d.js",
+     *      "paths": {
+     *        "en-us": "master_2015-04-20/my-application_strings_en-us_d38ff012.js",
+     *        "fr-fr": "master_2015-04-20/my-application_strings_fr-fr_138af7e4.js"
+     *      }
+     *    }
+     *  }
+     * ```
+     */
+    scriptResources: {
+        [name: string]: IModuleConfiguration;
+    };
+}
 
 /**
  * All client-side components built on the SharePoint framework need a valid component manifest. This interface
@@ -146,7 +508,19 @@ export declare interface IClientSideComponentManifest extends IClientSideManifes
      * Usage: Requires Custom Script to be allowed in order for this component to be installed and run.
      */
     requiresCustomScript?: boolean;
-    /* Excluded from this release type: loaderConfig */
+    /**
+     * This portion of the configuration describes how the component is to be loaded and initialized by a
+     * client.  It contains an enumeration of scripts that the component requires along with a single
+     * entry point script.
+     *
+     * @remarks
+     * Usage: Loading a component.
+     *
+     * See `IClientSideComponentLoaderConfiguration` for more information and examples.
+     *
+     * @beta
+     */
+    loaderConfig: IClientSideComponentLoaderConfiguration;
     /* Excluded from this release type: isolatedDomain */
     /* Excluded from this release type: storeAppId */
     /* Excluded from this release type: mpnId */
@@ -339,6 +713,7 @@ export declare interface IClientSideWebPartManifest<TProperties> extends IClient
      * url
      */
     imagePreviewUrl?: string;
+    /* Excluded from this release type: propertiesMetadata */
 }
 
 /**
@@ -428,9 +803,42 @@ export declare interface IClientSideWebPartManifestEntry<TProperties> {
      * Example: `"https://contoso.akamaihd.net/files/myWebpartIcon.png"`
      */
     iconImageUrl?: string;
-    /* Excluded from this release type: groupId */
-    /* Excluded from this release type: group */
-    /* Excluded from this release type: tags */
+    /**
+     * The group id to determine which modern group contains the web part in modern site page. The SharePoint
+     * Framework reserves group ids for predefined groups. The developer can pick one from those groups. If the developer
+     * fills an id not in the predefined groups, it falls back to Other group.
+     *
+     * @remarks
+     *
+     * Supported values: the GUID from PredefinedGroup list
+     *
+     * Example: `"cf066440-0614-43d6-98ae-0b31cf14c7c3"`
+     *
+     * @beta
+     */
+    groupId: PredefinedGroup | string;
+    /**
+     * The group name in web part picker to contain the web part in the classic page. If no value is provided,
+     * then the web part will be displayed in the Miscellaneous group.
+     *
+     * @remarks
+     *
+     * Example: `{ "default": "Media and Content" }`
+     *
+     * @beta
+     */
+    group?: ILocalizedString;
+    /**
+     * This field is used to tag a web part with keywords that are different from the web part group name.
+     * Tags can be used for categorization and searching of web parts. For example, in the web part toolbox.
+     *
+     * @remarks
+     *
+     * Example `[{ "default": "image" }, { "default": "media" }, { "default": "picture" }, ...]`
+     *
+     * @beta
+     */
+    tags?: ILocalizedString[];
     /**
      * Definition: Use this field to specify the data version of the pre-configured data provided to the web part.
      * Note that data version is different from the version field in the manifest.
@@ -562,11 +970,124 @@ export declare interface ICommandSetExtensionManifest extends IClientSideExtensi
     };
 }
 
-/* Excluded from this release type: IComponentModuleConfiguration */
+/**
+ * This is the interface for a script module with the "component" type. Modules of this type will be provided via
+ * manifests. In order for the dependency to be loaded, the manifest must be available on the site.
+ *
+ * @beta
+ */
+export declare interface IComponentModuleConfiguration extends IModuleConfigurationBase {
+    type: 'component';
+    /**
+     * The version of the framework-supplied component to be loaded. For framework runtime component such as
+     * `@microsoft/sp-client-base`, it is recommended the version of the framework component the component was developed
+     * against be specified.
+     *
+     * @remarks
+     *
+     * Supported values: string representing a {@link http://semver.org | semantic version}, or "latest".
+     *
+     * Example: `"2.2.4"`
+     */
+    version: string;
+    /**
+     * The ID of the framework-supplied component to be loaded.
+     *
+     * @remarks
+     *
+     * Supported values: string representing a component's ID.
+     *
+     * Example: `"0d910c1c-13b9-4e1c-9aa4-b008c5e42d7d"`
+     */
+    id: string;
+    /**
+     * A path to the framework-supplied component in case the framework fails to load the requested version.
+     *
+     * @remarks
+     * This must be either a fully-qualified URL, or a path under the paths specified in the `internalModuleBaseUrls`
+     * field. If this field is not specified and the version is not available in the framework runtime, the closest
+     * matching version of the component will be provided instead.
+     *
+     * Supported values: The path to the component either as a fully-qualified URL or as a path under the
+     * paths provided in the "internalModuleBaseUrls" field.
+     *
+     * Example: `"https://code.jquery.com/jquery-2.2.4.min.js"`
+     */
+    failoverPath?: string | IIntegrityPath;
+}
 
-/* Excluded from this release type: IIntegrityPath */
+/**
+ * A path with the subresource integrity hash of the resource.
+ *
+ * @beta
+ */
+export declare interface IIntegrityPath {
+    /**
+     * The path to the resource.
+     */
+    path: string;
+    /**
+     * The subresource integrity hash of the resource referenced in {@link IIntegrityPath.path}.
+     */
+    integrity?: string;
+}
 
-/* Excluded from this release type: ILocalizedPathModuleConfiguration */
+/**
+ * This is the interface for a script module with the "localizedPath" type.
+ *
+ * @remarks
+ * Modules of this type must be provided by the component developer. These script resources are similar to those of
+ * the "path" type, but they may be present at a number of different paths, to be selected by the user's locale.
+ * Paths in this module type are loaded exactly the same way as "internal" modules are.
+ *
+ * @beta
+ */
+export declare interface ILocalizedPathModuleConfiguration extends IModuleConfigurationBase {
+    type: 'localizedPath';
+    /**
+     * A path to this module's default locale javascript resource either as a fully-qualified URL or as a
+     * path under the paths provided in the "internalModuleBaseUrls" field.
+     *
+     * @remarks
+     * If the user's locale does not resolve to one of the paths specified in the "paths" field, the path in this
+     * field is used. Paths in this module type are treated exactly the same way paths in modules of the "internal"
+     * type are treated.
+     *
+     * Supported values: The path to the default locale version of the module either as a fully-qualified URL or as a path
+     * under the paths provided in the "internalModuleBaseUrls" field.
+     *
+     * Example: `"master_2015-04-20/my-application_strings_default_af378e0d.js"`
+     */
+    defaultPath: string | IIntegrityPath;
+    /**
+     * This is a dictionary of locale keys (in the `"ll-cc"` format) to paths to this module's locale
+     * javascript resource either as a fully-qualified URL or as a path under the paths provided in the
+     * `"internalModuleBaseUrls"` field.
+     *
+     * @remarks
+     * The loader will attempt to resolve the user's locale to one of the paths provided by this field, and will load
+     * the script resource under that path. If the user's locale does not resolve to one of the paths specified in this
+     * field, the path in `"defaultPath"` field is used. For example, if the user's locale is `"en-gb"`, and this field's
+     * value contains the keys `[ "en-us", "en-gb", "fr-fr" ]`, the path specified by the `"en-gb"` key will be used.
+     * If the user's locale is "en-gb", and this field's value contains the keys `[ "en-us", "fr-fr" ]`, the path
+     * specified by the `"en-us"` key will be used. If the user's locale is `"en-gb"`, and this field's value contains
+     * the keys `[ "es-es", "fr-fr" ]`, the path specified by the "defaultPath" field will be used.
+     * Paths in this module type are treated exactly the same way paths in modules of the "internal" type are treated.
+     *
+     * Supported values: A dictionary of locale-to-path mappings.
+     *
+     * Example:
+     * ```
+     *  {
+     *    "en-us": "master_2015-04-20/my-application_strings_en-us_d38ff012.js",
+     *    "fr-fr": "master_2015-04-20/my-application_strings_fr-fr_138af7e4.js"
+     *  }
+     * ```
+     */
+    paths?: {
+        [locale: string]: string | IIntegrityPath;
+    };
+}
 
 /**
  * A set of localized strings.
@@ -614,16 +1135,188 @@ export declare interface ILocalizedString {
     [locale: string]: string | undefined;
 }
 
-/* Excluded from this release type: IModuleConfiguration */
+/**
+ * @beta
+ */
+export declare type IModuleConfiguration = IComponentModuleConfiguration | IPathModuleConfiguration | ILocalizedPathModuleConfiguration;
 
-/* Excluded from this release type: IModuleConfigurationBase */
+/**
+ * This is the base interface for a script module's definition.
+ *
+ * @beta
+ */
+export declare interface IModuleConfigurationBase {
+    /**
+     * The type of the script block. `"component"` modules come from a component,
+     * `"path"` and `"localizedPath"` modules must be available on the paths provided in
+     * the `"internalModuleBaseUrls"` field.
+     *
+     * @remarks
+     *
+     * Modules with the `"path"` type use the `IPathModuleConfiguration` interface.
+     *
+     * Modules with the `"component"` type use the `IComponentModuleConfiguration` interface.
+     * Modules with the "localizedPath" type use the `ILocalizedPathModuleConfiguration` interface.
+     *
+     * Supported values: `"component"`, `"path"`, `"localizedPath"`
+     *
+     * Example: `"localized"`
+     */
+    type: 'component' | 'path' | 'localizedPath';
+    /**
+     * If set to `true`, this module should not be preloaded when loading the component.
+     *
+     * @remarks
+     * The most common case for setting this property to "true" is when a module is defined in a manifest,
+     * but is not required for the module referenced in "entryModuleId" to load. Modules may be defined that
+     * are loaded asynchronously, and these modules do not need to be preloaded. This field implicitly defaults
+     * to `false`.
+     *
+     * Usage: Instructs the module loader to not preload this module.
+     */
+    shouldNotPreload?: boolean;
+}
 
-/* Excluded from this release type: IPathModuleConfiguration */
+/**
+ * This is the interface for a script module with the "path" type. Modules of this type must be provided by the
+ * component developer.
+ *
+ * @beta
+ */
+export declare interface IPathModuleConfiguration extends IModuleConfigurationBase {
+    type: 'path';
+    /**
+     * A path to this module's javascript resource either as a fully-qualified URL or as a path under the
+     * paths provided in the `internalModuleBaseUrls` field.
+     *
+     * @remarks
+     *
+     * For example, if this field's value is `"master_2015-04-20/my-application.bundle_1928f8a0.js"` and
+     * the `"internalModuleBaseUrls"` field's value is
+     * `[ "https://contoso.akamaihd.net/files/", "https://contoso.msecnd.net/files/" ]`, the loader will
+     * first attempt to load this script resource from the URL
+     * `"https://contoso.akamaihd.net/files/master_2015-04-20/my-application.bundle_1928f8a0.js"`.
+     * If loading from that URL fails, the loader will then attempt to load this script resource from
+     * `"https://contoso.msecnd.net/files/master_2015-04-20/my-application.bundle_1928f8a0.js"`.
+     * If that URL fails to load, the component will fail to load and an error will be returned.
+     *
+     * Supported values: The path to the module either as a fully-qualified URL or as a path under the
+     *  paths provided in the "internalModuleBaseUrls" field.
+     *
+     * Example: `"master_2015-04-20/my-application.bundle_1928f8a0.js"`
+     */
+    path: string | IIntegrityPath;
+    /**
+     * If this property is specified, this module is considered non-AMD and
+     * the module loader will not expect "define" or "require" to be called.
+     *
+     * @remarks
+     * In order to load scripts that don't follow the AMD/module-pattern where "define" or "require" is
+     * called and dependencies are explicitly listed and exports are explicitly returned, the module loader needs to
+     * know which global variable must be examined. If this property is specified, this module is considered non-AMD and
+     * the module loader will not expect "define" or "require" to be called. Instead, it will wait for the script to
+     * finish loading and examine the global variable specified in this field.
+     *
+     * Supported values: Variable names that are expected to be populated after this module is loaded. For example,
+     * if this module is describing jQuery, this value should probably be "$". If an empty string is specified,
+     * the module loader will throw an exception and the component will fail to load.
+     *
+     * Example: `"$"`
+     */
+    globalName?: string;
+    /**
+     * For non-AMD/module-pattern scripts that have dependencies (for example, jQuery plugins), the module
+     * loader will ensure that those dependencies are already loaded.
+     *
+     * @remarks
+     * Entries in the array specified in this field must refer to other non-AMD modules in this component. This field
+     * is not required to have a value for non-AMD modules. If any values are specified that do not refer to other
+     * modules in the same component manifest that this module is specified, the module loader will throw an exception
+     * and the component will fail to load.
+     *
+     * Supported values: Names of other non-AMD-pattern modules in this loader configuration, as specified by the key
+     * `IClientSideComponentLoaderConfiguration.scriptResources[]`
+     *
+     * Example: `["jquery"]`
+     */
+    globalDependencies?: string[];
+}
 
 /* Excluded from this release type: IPreloadOptions */
 
 /* Excluded from this release type: ManifestType */
 
-/* Excluded from this release type: PredefinedGroup */
+/**
+ * Predefined web part group.
+ *
+ * @beta
+ */
+export declare const enum PredefinedGroup {
+    /**
+     * Text, media and content.
+     *
+     * This group includes web parts that display text, multi-media, documents, information from the web, and other
+     * rich content.
+     *
+     * @beta
+     */
+    TextMediaAndContent = "cf066440-0614-43d6-98ae-0b31cf14c7c3",
+    /**
+     * Discovery.
+     *
+     * This group includes web parts that organize, group, and filter content to help users discover information.
+     *
+     * @beta
+     */
+    DocumentsListsAndLibraries = "1edbd9a8-0bfb-4aa2-9afd-14b8c45dd489",
+    /**
+     * Communication and collaboration.
+     *
+     * This group includes web parts that facilitate information sharing, team work, and social interactions.
+     *
+     * @beta
+     */
+    Feeds = "75e22ed5-fa14-4829-850a-c890608aca2d",
+    /**
+     * Planning and process.
+     *
+     * This group includes web parts that empower team productivity with the use of planning and process tools.
+     *
+     * @beta
+     */
+    NewsPeopleAndEvents = "1bc7927e-4a5e-4520-b540-71305c79c20a",
+    /**
+     * Business and intelligence.
+     *
+     * This group includes web parts for tracking and analyzing data, and for integrating business flow with pages.
+     *
+     * @beta
+     */
+    DataAnalysis = "4aca9e90-eff5-4fa1-bac7-728f5f157b66",
+    /**
+     * Regional information
+     *
+     * This group includes web parts that display information based on current region and geographical location
+     *
+     * @beta
+     */
+    RegionalInformation = "cfc8bda5-cb9b-49e3-8526-2ee6e52b256a",
+    /**
+     * Other.
+     *
+     * This group includes web parts not in other groups.
+     *
+     * @beta
+     */
+    Advanced = "5c03119e-3074-46fd-976b-c60198311f70",
+    /**
+     * Other.
+     *
+     * This group includes local web parts.
+     *
+     * @beta
+     */
+    Local = "8b7bf6f1-a56a-4aa3-8657-7eb6e7e6af61"
+}
 
 export { }

package/dist/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.24.1"
+      "packageVersion": "7.29.0"
     }
   ]
 }

package/lib-commonjs/manifestSchemas/IClientSideWebPartManifest.d.ts

@@ -169,6 +169,12 @@ export interface IClientSideWebPartManifest<TProperties> extends IClientSideComp
      * url
      */
     imagePreviewUrl?: string;
+    /**
+     * @internal
+     */
+    propertiesMetadata?: {
+        current: any;
+    };
 }
 /**
  * Manifest that is relevant to a Web Part instance.

package/lib-commonjs/manifestSchemas/IClientSideWebPartManifest.d.ts.map

@@ -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;CAC1B;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"}
+{"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"}

package/lib-commonjs/manifestSchemas/IClientSideWebPartManifest.js

@@ -5,4 +5,78 @@
  * @file Client-side Web Part manifest definition.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.PredefinedGroup = void 0;
+/**
+ * Predefined web part group.
+ *
+ * @beta
+ */
+var PredefinedGroup;
+(function (PredefinedGroup) {
+    /**
+     * Text, media and content.
+     *
+     * This group includes web parts that display text, multi-media, documents, information from the web, and other
+     * rich content.
+     *
+     * @beta
+     */
+    PredefinedGroup["TextMediaAndContent"] = "cf066440-0614-43d6-98ae-0b31cf14c7c3";
+    /**
+     * Discovery.
+     *
+     * This group includes web parts that organize, group, and filter content to help users discover information.
+     *
+     * @beta
+     */
+    PredefinedGroup["DocumentsListsAndLibraries"] = "1edbd9a8-0bfb-4aa2-9afd-14b8c45dd489";
+    /**
+     * Communication and collaboration.
+     *
+     * This group includes web parts that facilitate information sharing, team work, and social interactions.
+     *
+     * @beta
+     */
+    PredefinedGroup["Feeds"] = "75e22ed5-fa14-4829-850a-c890608aca2d";
+    /**
+     * Planning and process.
+     *
+     * This group includes web parts that empower team productivity with the use of planning and process tools.
+     *
+     * @beta
+     */
+    PredefinedGroup["NewsPeopleAndEvents"] = "1bc7927e-4a5e-4520-b540-71305c79c20a";
+    /**
+     * Business and intelligence.
+     *
+     * This group includes web parts for tracking and analyzing data, and for integrating business flow with pages.
+     *
+     * @beta
+     */
+    PredefinedGroup["DataAnalysis"] = "4aca9e90-eff5-4fa1-bac7-728f5f157b66";
+    /**
+     * Regional information
+     *
+     * This group includes web parts that display information based on current region and geographical location
+     *
+     * @beta
+     */
+    PredefinedGroup["RegionalInformation"] = "cfc8bda5-cb9b-49e3-8526-2ee6e52b256a";
+    /**
+     * Other.
+     *
+     * This group includes web parts not in other groups.
+     *
+     * @beta
+     */
+    PredefinedGroup["Advanced"] = "5c03119e-3074-46fd-976b-c60198311f70";
+    /**
+     * Other.
+     *
+     * This group includes local web parts.
+     *
+     * @beta
+     */
+    PredefinedGroup["Local"] = "8b7bf6f1-a56a-4aa3-8657-7eb6e7e6af61";
+})(PredefinedGroup = exports.PredefinedGroup || (exports.PredefinedGroup = {}));
 //# sourceMappingURL=IClientSideWebPartManifest.js.map

package/lib-commonjs/manifestSchemas/jsonSchemas/client-side-web-part-manifest.schema.json

@@ -217,7 +217,7 @@
 
               "officeFabricIconFontName": {
                 "title": "Office Fabric Icon Name",
-                "description": " The icon for the Web Part, to be displayed in the toolbox, represented as a character name in the Office 365 icon font file. The icon font is specified here: http://o365icons.cloudapp.net/. If this field has a value, the 'iconImageUrl' field will be ignored.",
+                "description": " The icon for the Web Part, to be displayed in the toolbox, represented as a character name in the Office 365 icon font file. The icon font is specified here: https://aka.ms/uifabric-icons. If this field has a value, the 'iconImageUrl' field will be ignored.",
                 "type": "string",
                 "minLength": 1
               },
@@ -289,6 +289,18 @@
 
             "additionalProperties": false
           }
+        },
+
+        "propertiesMetadata": {
+          "additionalProperties": false,
+          "type": "object",
+          "required": ["current"],
+          "properties": {
+            "current": {
+              "type": "object",
+              "additionalProperties": true
+            }
+          }
         }
       },
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@microsoft/sp-module-interfaces",
-  "version": "1.15.2",
+  "version": "1.16.0-beta.1",
   "description": "SharePoint Framework module interfaces",
   "license": "SEE LICENSE IN \"EULA\" FOLDER",
   "homepage": "http://aka.ms/spfx",
@@ -15,7 +15,7 @@
     "tsdocFlavor": "AEDoc"
   },
   "dependencies": {
-    "@rushstack/node-core-library": "3.45.5",
+    "@rushstack/node-core-library": "3.50.1",
     "z-schema": "4.2.4"
   }
 }