Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
@microsoft/sp-module-interfaces
Advanced tools
@microsoft/sp-module-interfaces - npm Package Compare versions
Comparing version 1.9.0-plusbeta to 1.9.1-plusbeta
@@ -5,2 +5,8 @@ { | ||
| { | ||
| "version": "1.9.1", | ||
| "tag": "@microsoft/sp-module-interfaces_v1.9.1", | ||
| "date": "Wed, 14 Aug 2019 06:49:49 GMT", | ||
| "comments": {} | ||
| }, | ||
| { | ||
| "version": "1.9.0", | ||
@@ -7,0 +13,0 @@ "tag": "@microsoft/sp-module-interfaces_v1.9.0", |
| # Change Log - @microsoft/sp-module-interfaces | ||
| This log was last generated on Mon, 22 Jul 2019 19:07:47 GMT and should not be manually modified. | ||
| This log was last generated on Wed, 14 Aug 2019 06:49:49 GMT and should not be manually modified. | ||
| ## 1.9.1 | ||
| Wed, 14 Aug 2019 06:49:49 GMT | ||
| *Version update only* | ||
| ## 1.9.0 | ||
@@ -6,0 +11,0 @@ Mon, 22 Jul 2019 19:07:47 GMT |
@@ -15,97 +15,5 @@ | ||
| /** | ||
| * The capability collection for the web part. It defines which capabilities are required for the web part. | ||
| * If the host does not support one of the required capabilities, the web part will not be visible in the toolbox. | ||
| * | ||
| * @privateRemarks | ||
| * This API is currently not available to third parties. This feature is still in experimental stages. | ||
| * Only when the final design is ready, will we consider opening it to third parties. | ||
| * | ||
| * @alpha | ||
| */ | ||
| export declare interface ICapabilityCollection { | ||
| /** | ||
| * A boolean flag indicates if the web part requires the Bing maps key to be available in the site. | ||
| * The Bing maps credential key can be used to show the Bing maps control according to a provided coordinate. | ||
| * | ||
| * @alpha | ||
| */ | ||
| BingMapsKey?: boolean; | ||
| /** | ||
| * An array indicates the web part requires any of following authentication models to be available in the site. | ||
| * The authentication model can be used to connect to Microsoft Graph, O365 connecter, etc. | ||
| * | ||
| * @alpha | ||
| */ | ||
| AuthenticationModel?: Array<'OpenIDConnect' | 'Federated'>; | ||
| } | ||
| /* Excluded from this release type: ICapabilityCollection */ | ||
| /** | ||
| * This is the manifest for a client-side application. | ||
| * | ||
| * @alpha | ||
| */ | ||
| export declare interface IClientSideApplicationManifest extends IClientSideComponentManifest { | ||
| /** | ||
| * Represents flags to preload information in host aspx page. | ||
| */ | ||
| preloadOptions: IPreloadOptions; | ||
| /** | ||
| * Title of the application as a dictionary of locale keys to title values. This value will be | ||
| * displayed to the user in the (page creation) interface. | ||
| * | ||
| * @remarks | ||
| * | ||
| * Supported values: a dictionary of locale keys to strings. Should always have a 'default' key. | ||
| * | ||
| * Example: `"My Application"` | ||
| * | ||
| * ``` | ||
| * { | ||
| * "default": "My Application" | ||
| * "en-us": "My Application", | ||
| * "fr-fr": "Ma demande", | ||
| * "zh": "我的應用程式" | ||
| * } | ||
| * ``` | ||
| */ | ||
| title: ILocalizedString; | ||
| /** | ||
| * Description of the application represented as a dictionary of locale keys to description values. | ||
| * This value will be displayed to the user in the (page creation) interface. | ||
| * | ||
| * @remarks | ||
| * | ||
| * Supported values: a dictionary of locale keys to strings. Should always have a 'default' key. | ||
| * | ||
| * Examples: | ||
| * | ||
| * ``` | ||
| * "An application for searching for things." | ||
| * ``` | ||
| * or | ||
| * ``` | ||
| * { | ||
| * "default": "An application for searching for things.", | ||
| * "en-us": "An application for searching for things.", | ||
| * "fr-fr": "Une demande pour la recherche de choses.", | ||
| * "zh": "申請尋找的東西。" | ||
| * } | ||
| * ``` | ||
| */ | ||
| description: ILocalizedString; | ||
| /** | ||
| * Id of the preferred assembly to use to load the application. | ||
| * | ||
| * @remarks | ||
| * If no assembly id is provided SPFx will be loaded with the default assembly. | ||
| * | ||
| * Supported values: a GUID string | ||
| * | ||
| * Example: `"44bae1a2-d2eb-4e10-8c21-a1dbdce1036f"` | ||
| * | ||
| * @internal | ||
| */ | ||
| assemblyId?: string; | ||
| } | ||
| /* Excluded from this release type: IClientSideApplicationManifest */ | ||
@@ -302,32 +210,5 @@ /** | ||
| alias: string; | ||
| /* Excluded from this release type: isInternal */ | ||
| /* Excluded from this release type: _isDebug */ | ||
| /** | ||
| * An auto-generated value for internal use. Do not add or use it. | ||
| * | ||
| * @remarks | ||
| * | ||
| * Usage: Not to be used by third-party developers. | ||
| * | ||
| * @privateRemarks | ||
| * | ||
| * this property indicates whether the component is first-party or third-party. IsInternal is true | ||
| * for first-party, false for third-party. The value is controlled by server side code. It is used when framework | ||
| * needs to differentiate between behaviors for first-party components and third-party, like in telemetry. | ||
| * | ||
| * @internal | ||
| */ | ||
| isInternal?: boolean; | ||
| /** | ||
| * An auto-generated value for internal use. Do not add or use it. | ||
| * | ||
| * @remarks | ||
| * | ||
| * Usage: Not to be used by third-party developers. | ||
| * | ||
| * @privateRemarks | ||
| * this property is true when the manifest comes from the debug query param. | ||
| * | ||
| * @internal | ||
| */ | ||
| _isDebug?: boolean; | ||
| /** | ||
| * Client-side component version. The value of this field is expected to be controlled by the developer | ||
@@ -355,17 +236,4 @@ * of the client-side component. | ||
| version: string; | ||
| /* Excluded from this release type: preloadComponents */ | ||
| /** | ||
| * A list of component manifests that must be preloaded alongside this component. | ||
| * These may include external resources that are needed during initial render, or components that should | ||
| * be loaded only on demand. | ||
| * | ||
| * @remarks | ||
| * | ||
| * Supported values: an array of manifest IDs | ||
| * | ||
| * Example: `[ "66665f5e-307f-41cf-9fec-17c5ea20f0ca", "2d02eafb-eb82-47d2-98ac-dcac4aa63969" ]` | ||
| * | ||
| * @alpha | ||
| */ | ||
| preloadComponents?: string[]; | ||
| /** | ||
| * This property is used to keep older components that don't explicitly use fabric CSS. | ||
@@ -406,26 +274,4 @@ * For the most part, webparts build after using spfx 1.1 don't need this. | ||
| loaderConfig: IClientSideComponentLoaderConfiguration; | ||
| /** | ||
| * The domain that the component should run on. | ||
| * | ||
| * @remarks | ||
| * | ||
| * Example: `'PrepSPO-appFEEAB5CE1CB0421FB1AAE5D09E0A8AAA.spgrid.com'` | ||
| * | ||
| * @alpha | ||
| */ | ||
| isolatedDomain?: string; | ||
| /** | ||
| * Property bag for the component manifest. | ||
| * | ||
| * @remarks | ||
| * | ||
| * Usage: Provide a set of properties for the component, that doesn't change across instances. | ||
| * | ||
| * Supported values: Key-value pairs with a string key. | ||
| * | ||
| * @internal | ||
| */ | ||
| properties?: { | ||
| [key: string]: any; | ||
| }; | ||
| /* Excluded from this release type: isolatedDomain */ | ||
| /* Excluded from this release type: properties */ | ||
| } | ||
@@ -496,46 +342,3 @@ | ||
| /** | ||
| * Multi-version manifests are defined by this interface. | ||
| * | ||
| * @remarks | ||
| * | ||
| * The schema of this manifest is owned and versioned by Microsoft. Following rules should be followed while changing | ||
| * this schema. This set of rules can also be called the "manifest upgrade rules". | ||
| * | ||
| * - For minor changes, new properties can be added to this schema in a backwards-compatible way. i.e. the code | ||
| * that processes the manifest should be able to handle the absence of those new properties. | ||
| * | ||
| * - Try to model your changes as minor SemVer increments. Major version changes should be avoided because they | ||
| * impose a migration cost on developers. | ||
| * | ||
| * - The 'manifestVersion' should be bumped for all small or big changes. | ||
| * | ||
| * @privateRemarks | ||
| * | ||
| * This schema should be at all times kept in sync with the server-side code file | ||
| * SPClientSideMultiVersionManifest.cs. | ||
| * | ||
| * @alpha | ||
| */ | ||
| export declare interface IClientSideMultiVersionManifest<TManifest extends IClientSideComponentManifest> extends IClientSideManifestBase { | ||
| /** | ||
| * A mapping of version numbers to manifests. This field is used to roll all versions of a component | ||
| * together into a single manifest. | ||
| * | ||
| * @remarks | ||
| * | ||
| * Supported values: Mapping of version strings to manifest bodies | ||
| * | ||
| * Example: | ||
| * ``` | ||
| * { | ||
| * "1.0.0": ...manifest, | ||
| * "2.0.0": ...manifest | ||
| * } | ||
| * ``` | ||
| */ | ||
| versions: { | ||
| [versionNumber: string]: TManifest; | ||
| }; | ||
| } | ||
| /* Excluded from this release type: IClientSideMultiVersionManifest */ | ||
@@ -592,32 +395,5 @@ /** | ||
| supportsFullBleed?: boolean; | ||
| /* Excluded from this release type: requiredCapabilities */ | ||
| /* Excluded from this release type: isolationLevel */ | ||
| /** | ||
| * The set of capabilities this web part requires from the host page in order to be usable. | ||
| * If the host does not support one of the required capabilities, the web part will not be visible in the toolbox. | ||
| * | ||
| * @remarks | ||
| * Example `{ "BingMapKey": true, "AuthModel": ["OpenIDConnect"] }` | ||
| * | ||
| * @privateRemarks | ||
| * | ||
| * This API is currently not available to third parties. This feature is still in experimental stages. | ||
| * Only when the final design is ready, will we consider opening it to third parties. | ||
| * | ||
| * @alpha | ||
| */ | ||
| requiredCapabilities?: ICapabilityCollection; | ||
| /** | ||
| * Describes the level of isolation needed for the web part. | ||
| * | ||
| * @remarks | ||
| * Defaults to `'None'`, meaning no isolation needed. `'DomIsolation'` will render the web part in a self | ||
| * contained environment, isolated from the main page's DOM but in the same domain as the main page. | ||
| * | ||
| * Usage: Use the flag if a web part needs an isolated environment. For example DOM isolation. | ||
| * | ||
| * Supported values: `"None", "DOMIsolation"` | ||
| * | ||
| * @alpha | ||
| */ | ||
| isolationLevel?: 'None' | 'DomIsolation'; | ||
| /** | ||
| * Definition: If true, this web part supports and has been tested for theme variants experience. | ||
@@ -633,17 +409,4 @@ * | ||
| supportsThemeVariants?: boolean; | ||
| /* Excluded from this release type: useFallbackWhenPropertiesUpdatedExternally */ | ||
| /** | ||
| * Definition: | ||
| * - If true, the web part will be disposed and reloaded when the web part data is updated by an external source. | ||
| * - If false, the web part data will be deserialized and the properties of the web part will be updated, | ||
| * onAfterPropertiesUpdatedExternally will be executed. | ||
| * - If undefined, web parts developed with SPFx version below 1.9 will default to true and web parts developed with | ||
| * a SPFx version 1.9 or greater will default to false. | ||
| * | ||
| * @alpha | ||
| * @remarks | ||
| * By default, onAfterPropertiesUpdatedExternally will re-render the web part. If your web part requires specialized | ||
| * logic, then it is recommended to override onAfterPropertiesUpdatedExternally. | ||
| */ | ||
| useFallbackWhenPropertiesUpdatedExternally?: boolean; | ||
| /** | ||
| * A Web Part can have pre-configured properties like the title, description, toolbox group name and Web | ||
@@ -1227,128 +990,5 @@ * Part specific custom properties. And there can be multiple instances of these pre-configured properties. | ||
| /** | ||
| * @alpha | ||
| */ | ||
| export declare interface IPreloadOptions { | ||
| /** | ||
| * Determines whether or not to preload the web object. | ||
| * | ||
| * @remarks | ||
| * | ||
| * A value indicating whether or not to preload the web object when loading the application page. | ||
| * If not present, defaults to false. | ||
| */ | ||
| shouldPreloadWeb?: boolean; | ||
| /** | ||
| * Determines whether or not to preload the user object. | ||
| * | ||
| * @remarks | ||
| * | ||
| * A value indicating whether or not to preload the user object when loading the application page. | ||
| * If not present, defaults to false. | ||
| */ | ||
| shouldPreloadUser?: boolean; | ||
| /** | ||
| * Determines whether or not to preload the SharePointlist object. | ||
| * | ||
| * @remarks | ||
| * A value indicating whether or not to preload the list object when loading the application page. | ||
| * If not present, defaults to false. | ||
| */ | ||
| shouldPreloadList?: boolean; | ||
| /** | ||
| * Determines whether or not to preload the SharePoint list item object. | ||
| * | ||
| * @remarks | ||
| * | ||
| * A value indicating whether or not to preload the list item object when loading the application page. | ||
| * If not present, defaults to false. | ||
| */ | ||
| shouldPreloadItem?: boolean; | ||
| /** | ||
| * Determines whether or not to preload the quick launch navigation menu items. | ||
| * | ||
| * @remarks | ||
| * | ||
| * A value indicating whether or not to preload the quick launch navigation menu items when loading the | ||
| * application page. If not present, defaults to false. | ||
| */ | ||
| shouldPreloadQuickLaunch?: boolean; | ||
| /** | ||
| * This specifies an optional OData query expression with the syntax that would be used | ||
| * in the URL query parameter for a REST API call that fetches a SharePoint list item. | ||
| * | ||
| * @remarks | ||
| * This property enables the application to tailor the way the preload object will be serialized. | ||
| * For example, if you want to include the custom fields MyField1 and MyField2 and expand | ||
| * the Folder property, the preloadListItemQueryOption would look like this | ||
| * `"$select=MyField1,MyField2&$expand=Folder"` | ||
| * | ||
| * Supported values: A query following the {@link | ||
| * https://docs.microsoft.com/en-us/sharepoint/dev/schema/collaborative-application-markup-language-caml-schemas | ||
| * | CAML standard} | ||
| * | ||
| * Example: `"$select=MyField1,MyField2&$expand=Folder"` | ||
| */ | ||
| preloadListItemQueryOption?: string; | ||
| /** | ||
| * This specifies an optional OData query expression with the syntax that would be used | ||
| * in the URL query parameter for a REST API call that fetches a SharePoint list item. | ||
| * | ||
| * @remarks | ||
| * This property enables the application to tailor the way the preload object will be serialized. | ||
| * For example, if you want to include the custom fields `MyField1` and `MyField2` and expand | ||
| * the `Folder` property, the `preloadListItemQueryOption` would look like this | ||
| * `"$select=MyField1,MyField2&$expand=Folder"` | ||
| * | ||
| * This currently provides a way to override the value of `preloadListItemQueryOption` | ||
| * Later we would like to have `preloadListItemQueryOption` and `preloadListItemQueryOptionFallback` | ||
| * with fallback being the one that is known and working and `preloadListItemQueryOption` would | ||
| * be the override, but we should discuss the exact names when we make the change. | ||
| * | ||
| * Supported values: A query following the {@link | ||
| * https://docs.microsoft.com/en-us/sharepoint/dev/schema/collaborative-application-markup-language-caml-schemas | ||
| * | CAML standard} | ||
| * | ||
| * Example: `"$select=MyField1,MyField2&$expand=Folder"` | ||
| */ | ||
| preloadListItemQueryOptionOverride?: string; | ||
| /** | ||
| * This specifies what to fetch from a SharePoint list item Properties property. | ||
| * | ||
| * @remarks | ||
| * For example, if you want to include `MyProperty1` and `MyProperty2` from item `Properties` property, | ||
| * the `preloadListItemProperties` would look like `"[MyProperty1,MyProperty2]"`. | ||
| * | ||
| * The main reason not to pass `"$expand=Properties&select=Properties/MyProperty1,Properties/MyProperty2"` | ||
| * to `PreloadListItemQueryOption` is to avoid multiple extra SQL roundtrips. | ||
| * | ||
| * SharePoint list item Properties property is a hashtable to store additional information of the item | ||
| * without modify list schema. For more infomation about item Properties property see the following link: | ||
| * | ||
| * {@link https://msdn.microsoft.com/en-us/library/microsoft.sharepoint.splistitem.properties.aspx} | ||
| * | ||
| * If the specified name doesn't exist in the item Properties property, it will not return the value. | ||
| * | ||
| * Supported values: array of property names. | ||
| * | ||
| * Example: `["DefaultCanvasContentVersion"]` | ||
| */ | ||
| preloadListItemProperties?: string[]; | ||
| } | ||
| /* Excluded from this release type: IPreloadOptions */ | ||
| /** | ||
| * The type of the manifest. | ||
| * | ||
| * @alpha | ||
| */ | ||
| export declare enum ManifestType { | ||
| /** | ||
| * The component manifest type. | ||
| */ | ||
| component = "Component", | ||
| /** | ||
| * The container manifest type. This is used for manifests that contain other manifests, like multiversion manifests. | ||
| */ | ||
| container = "Container" | ||
| } | ||
| /* Excluded from this release type: ManifestType */ | ||
@@ -1355,0 +995,0 @@ /** |
| { | ||
| "name": "@microsoft/sp-module-interfaces", | ||
| "version": "1.9.0-plusbeta", | ||
| "version": "1.9.1-plusbeta", | ||
| "description": "SharePoint Framework module interfaces", | ||
@@ -21,3 +21,3 @@ "license": "SEE LICENSE IN \"EULA\" FOLDER", | ||
| "gulp": "~3.9.1", | ||
| "@microsoft/sp-build-node": "1.9.0-plusbeta", | ||
| "@microsoft/sp-build-node": "1.9.1-plusbeta", | ||
| "lodash": "~4.17.5", | ||
@@ -24,0 +24,0 @@ "@types/lodash": "4.14.117", |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Worsened metrics
- Total package byte prevSize
- decreased by-0.64%
2030914
- Lines of code
- decreased by-3.95%
8611
No dependency changes