Socket
Socket
Sign inDemoInstall

@microsoft/sp-module-interfaces

Package Overview
Dependencies
Maintainers
2
Versions
90
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@microsoft/sp-module-interfaces - npm Package Compare versions

Comparing version 1.7.1 to 1.8.0-plusbeta

dist/tsdoc-metadata.json

20

CHANGELOG.json

@@ -5,6 +5,18 @@ {

{
"version": "1.7.1",
"tag": "@microsoft/sp-module-interfaces_v1.7.1",
"date": "Tue, 18 Dec 2018 02:02:24 GMT",
"comments": {}
"version": "1.8.0",
"tag": "@microsoft/sp-module-interfaces_v1.8.0",
"date": "Thu, 14 Mar 2019 01:04:21 GMT",
"comments": {
"none": [
{
"comment": "Upgrade Typescript to 2.7.2"
},
{
"comment": "Upgrade Typescript to 2.7.2"
},
{
"comment": "Upgrade @types/lodash"
}
]
}
},

@@ -11,0 +23,0 @@ {

12

CHANGELOG.md
# Change Log - @microsoft/sp-module-interfaces
This log was last generated on Tue, 18 Dec 2018 02:02:24 GMT and should not be manually modified.
This log was last generated on Thu, 14 Mar 2019 01:04:21 GMT and should not be manually modified.
## 1.7.1
Tue, 18 Dec 2018 02:02:24 GMT
## 1.8.0
Thu, 14 Mar 2019 01:04:21 GMT
*Version update only*
### Updates
- Upgrade Typescript to 2.7.2
- Upgrade Typescript to 2.7.2
- Upgrade @types/lodash
## 1.7.0

@@ -11,0 +15,0 @@ Thu, 08 Nov 2018 17:05:51 GMT

869

dist/index-internal.d.ts
/**
* Type of client-side component.
* @public
*/

@@ -14,5 +15,97 @@ export declare type ComponentType = 'Application' | 'WebPart' | 'Library' | 'Extension';

/* Excluded from this release type: ICapabilityCollection */
/**
* 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: IClientSideApplicationManifest */
/**
* 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;
}

@@ -37,3 +130,116 @@ /**

/* 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;
};
}

@@ -97,5 +303,32 @@ /**

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

@@ -123,4 +356,22 @@ * 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.
* For the most part, webparts build after using spfx 1.1 don't need this.
*/
loadLegacyFabricCss?: boolean;
/**
* This property is provided for backwards compatibility. It no longer has any effect.

@@ -143,5 +394,39 @@ *

requiresCustomScript?: boolean;
/* Excluded from this release type: loaderConfig */
/* Excluded from this release type: isolatedDomain */
/* Excluded from this release type: properties */
/**
* 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;
/**
* 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;
};
}

@@ -212,3 +497,46 @@

/* Excluded from this release type: IClientSideMultiVersionManifest */
/**
* 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;
};
}

@@ -231,2 +559,10 @@ /**

/**
* Indicates whether the web part uses the property pane to update the configuration
* of the web part.
*
* @remarks
* Default value is `true` if the property is not explicitly defined.
*/
canUpdateConfiguration?: boolean;
/**
* If true, this web part is disabled on SharePoint classic pages

@@ -258,5 +594,32 @@ *

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.

@@ -304,2 +667,14 @@ *

preconfiguredEntries: IClientSideWebPartManifestEntry<TProperties>[];
/**
* Definition: An array defining what host types are supported
*
* @remarks
* Usage: Use this array to define all hosts that are supported. The default
* value is SharePointWebPart if nothing is provided. If SharePointFullPage is
* added the solution will be available when adding full page apps. If
* SharePointWebPart is added the solution will be available when adding webparts
* to a page. If TeamsTab is added the solution will be available when using teams.
*
*/
supportedHosts?: Array<'SharePointFullPage' | 'SharePointWebPart' | 'TeamsTab'>;
}

@@ -394,6 +769,39 @@

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.

@@ -515,5 +923,102 @@ * Note that data version is different from the version field in the manifest.

/* 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 IModuleConfiguration {
/**
* 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 | IPath;
}
/* 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 IModuleConfiguration {
/**
* 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 | IPath;
/**
* 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 | IPath;
};
}

@@ -566,12 +1071,330 @@ /**

/* Excluded from this release type: IModuleConfiguration */
/**
* This is the base interface for a script module's definition.
*
* @beta
*/
export declare interface IModuleConfiguration {
/**
* 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: IPath */
/**
* This is the base interface for a set of debug and non-debug/minimized paths. The paths in this object are
* loaded in exactly the same way as any other internal path.
*
* @beta
*/
export declare interface IPath {
/**
* 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. The script referenced by this field is loaded by default
* unless a debug version of the script is provided and explicitly requested.
*
* @remarks
*
* Supported values: The path to the default/non-debug script 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"`
*/
default: string;
/**
* A path to this module's debug javascript resource either as a fully-qualified URL or as a path under
* the paths provided in the "internalModuleBaseUrls" field. The script referenced by this field is only loaded if
* it is present and debug scripts are explicitly requested.
*
* @remarks
*
* Supported values: The path to the debug script 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_18182c39.debug.js"`
*/
debug?: string;
}
/* 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 IModuleConfiguration {
/**
* 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 | IPath;
/**
* 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 */
/**
* @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: ManifestType */
/**
* 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: 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
*/
Discovery = "1edbd9a8-0bfb-4aa2-9afd-14b8c45dd489",
/**
* Communication and collaboration.
*
* This group includes web parts that facilitate information sharing, team work, and social interactions.
*
* @beta
*/
CommunicationAndCollaboration = "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
*/
PlanningAndProcess = "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
*/
BusinessAndIntelligence = "4aca9e90-eff5-4fa1-bac7-728f5f157b66",
/**
* Site tools.
*
* This group includes web parts for site information and management.
*
* @beta
*/
SiteTools = "070951d7-94da-4db8-b06e-9d581f1f55b1",
/**
* Other.
*
* This group includes web parts not in other groups.
*
* @beta
*/
Other = "5c03119e-3074-46fd-976b-c60198311f70"
}
export { }

6

lib/manifestSchemas/IClientSideComponentManifest.d.ts

@@ -50,2 +50,3 @@ import { IClientSideComponentLoaderConfiguration } from './IClientSideComponentLoaderConfiguration';

* Type of client-side component.
* @public
*/

@@ -177,2 +178,7 @@ export declare type ComponentType = 'Application' | 'WebPart' | 'Library' | 'Extension';

/**
* This property is used to keep older components that don't explicitly use fabric CSS.
* For the most part, webparts build after using spfx 1.1 don't need this.
*/
loadLegacyFabricCss?: boolean;
/**
* This property is provided for backwards compatibility. It no longer has any effect.

@@ -179,0 +185,0 @@ *

22

lib/manifestSchemas/IClientSideWebPartManifest.d.ts

@@ -23,2 +23,10 @@ /**

/**
* Indicates whether the web part uses the property pane to update the configuration
* of the web part.
*
* @remarks
* Default value is `true` if the property is not explicitly defined.
*/
canUpdateConfiguration?: boolean;
/**
* If true, this web part is disabled on SharePoint classic pages

@@ -122,2 +130,14 @@ *

preconfiguredEntries: IClientSideWebPartManifestEntry<TProperties>[];
/**
* Definition: An array defining what host types are supported
*
* @remarks
* Usage: Use this array to define all hosts that are supported. The default
* value is SharePointWebPart if nothing is provided. If SharePointFullPage is
* added the solution will be available when adding full page apps. If
* SharePointWebPart is added the solution will be available when adding webparts
* to a page. If TeamsTab is added the solution will be available when using teams.
*
*/
supportedHosts?: Array<'SharePointFullPage' | 'SharePointWebPart' | 'TeamsTab'>;
}

@@ -351,3 +371,3 @@ /**

*/
Other = "5c03119e-3074-46fd-976b-c60198311f70",
Other = "5c03119e-3074-46fd-976b-c60198311f70"
}

@@ -354,0 +374,0 @@ /**

20

lib/manifestSchemas/jsonSchemas/client-side-component-manifest.schema.json

@@ -41,2 +41,11 @@ {

"properties": {
"alias": {
"type": "string",
"title": "Alias",
"description": "A short name usually given by developer. It does not need to be localized and is expected to stay the same through the lifetime of the component.",
"maxLength": 40,
"pattern": "^[a-zA-Z0-9-]*$",
"minLength": 5
},
"componentType": {

@@ -54,9 +63,6 @@ "type": "string",

"alias": {
"type": "string",
"title": "Alias",
"description": "A short name usually given by developer. It does not need to be localized and is expected to stay the same through the lifetime of the component.",
"maxLength": 40,
"pattern": "^[a-zA-Z0-9-]*$",
"minLength": 5
"loadLegacyFabricCss": {
"type": "boolean",
"title": "Load Legacy Fabric CSS",
"description": "Indicates whether to use the legacy Fabric CSS load sequence. Components after 1.1 can leave this false, unless there are visual regressions after updating your SPFx version."
},

@@ -63,0 +69,0 @@

17

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

@@ -86,2 +86,7 @@ {

"safeWithCustomScriptDisabled": { "$ref": "any-value.schema.json" },
"canUpdateConfiguration": {
"type": "boolean",
"title": "Can Update Configuration",
"description": "If set to \"true\", this web part uses the property pane to update the configuration of a web part."
},
"disabledOnClassicSharepoint": {

@@ -115,2 +120,14 @@ "type": "boolean",

"description": "If set to \"true\", this web part supports and has been tested for the theme variants experience."
},
"supportedHosts": {
"description": "An array indicates the web part supports any of following hosts. If this property is missing the default is SharePointFullPage",
"type": "array",
"items": {
"type": "string",
"enum": [
"SharePointFullPage",
"SharePointWebPart",
"TeamsTab"
]
}
}

@@ -117,0 +134,0 @@ },

2

lib/manifestSchemas/ManifestType.d.ts

@@ -14,3 +14,3 @@ /**

*/
container = "Container",
container = "Container"
}

2

lib/manifestSchemaValidator.d.ts

@@ -26,3 +26,3 @@ export import ZSchema = require('z-schema');

static getFormattedErrorMessage(errors: ZSchema.SchemaErrorDetail[]): string;
private static _validateManifest(manifest, schema);
private static _validateManifest;
}

4

lib/manifestSchemaValidator.js

@@ -75,4 +75,4 @@ "use strict";

static _validateManifest(
// tslint:disable-next-line:no-any
manifest, schema) {
// tslint:disable-next-line:no-any
manifest, schema) {
if (!schema) {

@@ -79,0 +79,0 @@ throw new Error('Unable to find the manifest schema.');

12

package.json
{
"name": "@microsoft/sp-module-interfaces",
"version": "1.7.1",
"version": "1.8.0-plusbeta",
"description": "SharePoint Framework module interfaces",

@@ -19,10 +19,8 @@ "license": "SEE LICENSE IN \"EULA\" FOLDER",

"devDependencies": {
"@microsoft/rush-stack-compiler": "0.1.18",
"@ms/sp-build-compiler-2.9": "1.8.0-plusbeta",
"gulp": "~3.9.1",
"@microsoft/sp-build-node": "1.7.1",
"chai": "~3.5.0",
"@types/chai": "3.4.34",
"@types/mocha": "2.2.38",
"@microsoft/sp-build-node": "1.8.0-plusbeta",
"lodash": "~4.17.5",
"@types/lodash": "4.14.74"
"@types/lodash": "4.14.117",
"@types/jest": "21.1.10"
},

@@ -29,0 +27,0 @@ "dependencies": {

dist/sp-module-interfaces.api.json
SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

About

Packages

npm

Go

Maven

PyPI

Rubygems

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc