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.1.1 to 1.2.0
@@ -5,10 +5,21 @@ { | ||
| { | ||
| "version": "1.1.1", | ||
| "tag": "@microsoft/sp-module-interfaces_v1.1.1", | ||
| "date": "Thu, 03 Aug 2017 19:20:14 GMT", | ||
| "version": "1.2.0", | ||
| "tag": "@microsoft/sp-module-interfaces_v1.2.0", | ||
| "date": "Fri, 25 Aug 2017 20:31:17 GMT", | ||
| "comments": { | ||
| "patch": [ | ||
| { | ||
| "comment": "Update the component schema to support version \"*\"." | ||
| }, | ||
| { | ||
| "comment": "Deprecate \"safeWithCustomScriptDisabled\" in favor of \"requiresCustomScript\"" | ||
| } | ||
| ], | ||
| "minor": [ | ||
| { | ||
| "comment": "Use lockstep version for all SPFx packages" | ||
| }, | ||
| { | ||
| "comment": "Introduce manifest schemas for extensions (beta)" | ||
| } | ||
| ] | ||
@@ -15,0 +26,0 @@ } |
| # Change Log - @microsoft/sp-module-interfaces | ||
| This log was last generated on Thu, 03 Aug 2017 19:20:14 GMT and should not be manually modified. | ||
| This log was last generated on Fri, 25 Aug 2017 22:24:38 GMT and should not be manually modified. | ||
| ## 1.1.1 | ||
| Thu, 03 Aug 2017 19:20:14 GMT | ||
| ## 1.2.0 | ||
| Fri, 25 Aug 2017 20:31:17 GMT | ||
| ### Minor changes | ||
| - Use lockstep version for all SPFx packages | ||
| - Introduce manifest schemas for extensions (beta) | ||
| ### Patches | ||
| - Update the component schema to support version "*". | ||
| - Deprecate "safeWithCustomScriptDisabled" in favor of "requiresCustomScript" | ||
@@ -11,0 +17,0 @@ |
@@ -6,2 +6,116 @@ { | ||
| "exports": { | ||
| "IClientSideAssemblyManifest": { | ||
| "kind": "interface", | ||
| "extends": "IClientSideComponentManifest", | ||
| "implements": "", | ||
| "typeParameters": [], | ||
| "deprecatedMessage": [], | ||
| "summary": [ | ||
| { | ||
| "kind": "textDocElement", | ||
| "value": "A library is defined by this manifest. Libraries currently do not have any additional properties." | ||
| } | ||
| ], | ||
| "remarks": [], | ||
| "isBeta": false, | ||
| "members": { | ||
| "rootComponentId": { | ||
| "kind": "property", | ||
| "isOptional": false, | ||
| "isReadOnly": false, | ||
| "isStatic": false, | ||
| "type": "string", | ||
| "deprecatedMessage": [], | ||
| "summary": [ | ||
| { | ||
| "kind": "textDocElement", | ||
| "value": "Definition: The ID of the component from which the assembly is built. Required: yes Localized: no Supported values: any GUID Example: \"dbef608d-3ad5-4f8f-b139-d916f2f0a294\"" | ||
| } | ||
| ], | ||
| "remarks": [], | ||
| "isBeta": false | ||
| } | ||
| } | ||
| }, | ||
| "IClientSideComponentLoaderConfiguration": { | ||
| "kind": "interface", | ||
| "extends": "", | ||
| "implements": "", | ||
| "typeParameters": [], | ||
| "deprecatedMessage": [], | ||
| "summary": [ | ||
| { | ||
| "kind": "textDocElement", | ||
| "value": "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." | ||
| } | ||
| ], | ||
| "remarks": [], | ||
| "isBeta": true, | ||
| "members": { | ||
| "entryModuleId": { | ||
| "kind": "property", | ||
| "isOptional": false, | ||
| "isReadOnly": false, | ||
| "isStatic": false, | ||
| "type": "string", | ||
| "deprecatedMessage": [], | ||
| "summary": [ | ||
| { | ||
| "kind": "textDocElement", | ||
| "value": "Definition: This is the ID of one of the entries in the \"scriptResources\" dictionary. 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. Required: yes Localized: no Supported values: An entry in the \"scriptResources\" dictionary that defines the base exported module of the component. Example: \"myApplication.bundle\"" | ||
| } | ||
| ], | ||
| "remarks": [], | ||
| "isBeta": false | ||
| }, | ||
| "exportName": { | ||
| "kind": "property", | ||
| "isOptional": true, | ||
| "isReadOnly": false, | ||
| "isStatic": false, | ||
| "type": "string", | ||
| "deprecatedMessage": [], | ||
| "summary": [ | ||
| { | ||
| "kind": "textDocElement", | ||
| "value": "Definition: The module referenced by the \"entryModuleId\" field may export an object with several fields. 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). Usage: To reference a field in the top-level export. Required: no Example: mySpWebpart" | ||
| } | ||
| ], | ||
| "remarks": [], | ||
| "isBeta": false | ||
| }, | ||
| "internalModuleBaseUrls": { | ||
| "kind": "property", | ||
| "isOptional": false, | ||
| "isReadOnly": false, | ||
| "isStatic": false, | ||
| "type": "string[]", | ||
| "deprecatedMessage": [], | ||
| "summary": [ | ||
| { | ||
| "kind": "textDocElement", | ||
| "value": "Definition: 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. 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. Required: yes Localized: no 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/\" ]" | ||
| } | ||
| ], | ||
| "remarks": [], | ||
| "isBeta": false | ||
| }, | ||
| "scriptResources": { | ||
| "kind": "property", | ||
| "isOptional": false, | ||
| "isReadOnly": false, | ||
| "isStatic": false, | ||
| "type": "{ [name: string]: IModuleConfiguration }", | ||
| "deprecatedMessage": [], | ||
| "summary": [ | ||
| { | ||
| "kind": "textDocElement", | ||
| "value": "Definition: 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. Required: yes Localized: no 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\" } } }" | ||
| } | ||
| ], | ||
| "remarks": [], | ||
| "isBeta": false | ||
| } | ||
| } | ||
| }, | ||
| "IClientSideComponentManifest": { | ||
@@ -16,3 +130,3 @@ "kind": "interface", | ||
| "kind": "textDocElement", | ||
| "value": "All client side components built on the SharePoint framework need a valid component manifest. This interface represents properties that are required by all types of client side components like Applications and Web Parts. Component specific manifests will extend this interface to add properties required by that component type. The schema of this manifest is owned and vesioned 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 absense 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." | ||
| "value": "All client side components built on the SharePoint framework need a valid component manifest. This interface represents properties that are required by all types of client side components like Applications and Web Parts. Component specific manifests will extend this interface to add properties required by that component type. 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." | ||
| } | ||
@@ -167,2 +281,35 @@ ], | ||
| }, | ||
| "IClientSideExtensionManifest": { | ||
| "kind": "interface", | ||
| "extends": "IClientSideComponentManifest", | ||
| "implements": "", | ||
| "typeParameters": [], | ||
| "deprecatedMessage": [], | ||
| "summary": [ | ||
| { | ||
| "kind": "textDocElement", | ||
| "value": "This is the manifest for a client-side extension." | ||
| } | ||
| ], | ||
| "remarks": [], | ||
| "isBeta": true, | ||
| "members": { | ||
| "extensionType": { | ||
| "kind": "property", | ||
| "isOptional": false, | ||
| "isReadOnly": false, | ||
| "isStatic": false, | ||
| "type": "ExtensionType", | ||
| "deprecatedMessage": [], | ||
| "summary": [ | ||
| { | ||
| "kind": "textDocElement", | ||
| "value": "Specifies the type of client-side extension. Some extension types support additional manifest fields beyond SPClientSideExtensionManifest." | ||
| } | ||
| ], | ||
| "remarks": [], | ||
| "isBeta": false | ||
| } | ||
| } | ||
| }, | ||
| "IClientSideLibraryManifest": { | ||
@@ -242,3 +389,3 @@ "kind": "interface", | ||
| "kind": "textDocElement", | ||
| "value": "Definition: A Web Part can have pre-configured properties like the title, description, toolbox group name and Web Part specific custom properties. And there can be multiple instances of these pre-configured properties. This helps support scenarios where an organization may want to present multiple pre-configured entries for a Web Part in the Toolbox. Each entry is expected to configure the Web Part 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 Web Part in the Tooblox, PropertyPane and the initial rendering of the Web Part. Required: yes Type: JSON object Localized: Depends on the property. Supported values: Array of IClientSideWebPartManifestEntry objects. Example: \"[{ title:\"Image Web Part\", description: \"This Web Part displays an image\", group: \"Media\", iconFontName: \"image\", properties: { imageSource: \"https://contoso.akamaihd.net/files/mountRainier.jpg\", captionText: \"Mount Rainier\" } }]\"" | ||
| "value": "Definition: A Web Part can have pre-configured properties like the title, description, toolbox group name and Web Part specific custom properties. And there can be multiple instances of these pre-configured properties. This helps support scenarios where an organization may want to present multiple pre-configured entries for a Web Part in the Toolbox. Each entry is expected to configure the Web Part 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 Web Part in the Toolbox, PropertyPane and the initial rendering of the Web Part. Required: yes Type: JSON object Localized: Depends on the property. Supported values: Array of IClientSideWebPartManifestEntry objects. Example: \"[{ title:\"Image Web Part\", description: \"This Web Part displays an image\", group: \"Media\", iconFontName: \"image\", properties: { imageSource: \"https://contoso.akamaihd.net/files/mountRainier.jpg\", captionText: \"Mount Rainier\" } }]\"" | ||
| } | ||
@@ -316,2 +463,18 @@ ], | ||
| }, | ||
| "group": { | ||
| "kind": "property", | ||
| "isOptional": true, | ||
| "isReadOnly": false, | ||
| "isStatic": false, | ||
| "type": "ILocalizedString", | ||
| "deprecatedMessage": [], | ||
| "summary": [ | ||
| { | ||
| "kind": "textDocElement", | ||
| "value": "Definition: This field is used to help decide the Toolbox group for the Web Part in the authoring experience. In the server rendered page, the Web Part gallery is equivalent of the Toolbox. If no value is provided, the Web Part will be displayed in the \"Custom\" group. Usage: display of the Web Part icon in a specific group in the authoring toolbox. Required: no Localized: yes Supported values: string Example: { \"default\": \"Media Web Parts\" }" | ||
| } | ||
| ], | ||
| "remarks": [], | ||
| "isBeta": true | ||
| }, | ||
| "groupId": { | ||
@@ -324,5 +487,10 @@ "kind": "property", | ||
| "deprecatedMessage": [], | ||
| "summary": [], | ||
| "summary": [ | ||
| { | ||
| "kind": "textDocElement", | ||
| "value": "Definition: A group id. This group id should be used to decide which toolbox group the web part should be placed into. The client side framework has reserved group ids for default groups. The developer can pick one of those groups. In that case the group field will be ignored. Alternatively, the developer can pick a completely unique id and a group name. The toolbox will then show the web part in its own group. Usage: display of the Web Part icon in a specific group in the authoring toolbox. Required: yes Localized: no Supported values: any GUID Example: \"dbef608d-3ad5-4f8f-b139-d916f2f0a294\"" | ||
| } | ||
| ], | ||
| "remarks": [], | ||
| "isBeta": false | ||
| "isBeta": true | ||
| }, | ||
@@ -347,3 +515,4 @@ "iconImageUrl": { | ||
| "exportName": "IClientSideWebPartManifestEntry", | ||
| "memberName": "officeFabricIconFontName" | ||
| "memberName": "officeFabricIconFontName", | ||
| "value": "IClientSideWebPartManifestEntry.officeFabricIconFontName" | ||
| }, | ||
@@ -376,3 +545,4 @@ { | ||
| "exportName": "IClientSideWebPartManifestEntry", | ||
| "memberName": "iconImageUrl" | ||
| "memberName": "iconImageUrl", | ||
| "value": "IClientSideWebPartManifestEntry.iconImageUrl" | ||
| }, | ||
@@ -438,2 +608,277 @@ { | ||
| }, | ||
| "ICommandDefinition": { | ||
| "kind": "interface", | ||
| "extends": "", | ||
| "implements": "", | ||
| "typeParameters": [], | ||
| "deprecatedMessage": [], | ||
| "summary": [ | ||
| { | ||
| "kind": "textDocElement", | ||
| "value": "Used by ICommandSetExtensionManifest, this defines a command to be displayed by a UI surface such as a menu, tool bar, etc." | ||
| } | ||
| ], | ||
| "remarks": [], | ||
| "isBeta": true, | ||
| "members": { | ||
| "ariaLabel": { | ||
| "kind": "property", | ||
| "isOptional": true, | ||
| "isReadOnly": false, | ||
| "isStatic": false, | ||
| "type": "ILocalizedString", | ||
| "deprecatedMessage": [], | ||
| "summary": [ | ||
| { | ||
| "kind": "textDocElement", | ||
| "value": "Custom accessibility text for the browser's \"aria-label\" attribute. If omitted, the title property will be used by default. Example: \"Show information. Press ENTER to select.\"" | ||
| } | ||
| ], | ||
| "remarks": [], | ||
| "isBeta": false | ||
| }, | ||
| "iconImageUrl": { | ||
| "kind": "property", | ||
| "isOptional": true, | ||
| "isReadOnly": false, | ||
| "isStatic": false, | ||
| "type": "string", | ||
| "deprecatedMessage": [], | ||
| "summary": [ | ||
| { | ||
| "kind": "textDocElement", | ||
| "value": "An optional URL for an image to be displayed next to the command. The requirements for this image are defined by the type of extension; some extension types may not display the image at all." | ||
| } | ||
| ], | ||
| "remarks": [], | ||
| "isBeta": false | ||
| }, | ||
| "title": { | ||
| "kind": "property", | ||
| "isOptional": false, | ||
| "isReadOnly": false, | ||
| "isStatic": false, | ||
| "type": "ILocalizedString", | ||
| "deprecatedMessage": [], | ||
| "summary": [ | ||
| { | ||
| "kind": "textDocElement", | ||
| "value": "A short label to be displayed by the associated button, menu item, etc. Example: \"Show information\"" | ||
| } | ||
| ], | ||
| "remarks": [], | ||
| "isBeta": false | ||
| }, | ||
| "type": { | ||
| "kind": "property", | ||
| "isOptional": false, | ||
| "isReadOnly": false, | ||
| "isStatic": false, | ||
| "type": "'command'", | ||
| "deprecatedMessage": [], | ||
| "summary": [ | ||
| { | ||
| "kind": "textDocElement", | ||
| "value": "Type of the item. Currently only \"command\" is allowed." | ||
| } | ||
| ], | ||
| "remarks": [], | ||
| "isBeta": false | ||
| } | ||
| } | ||
| }, | ||
| "ICommandSetExtensionManifest": { | ||
| "kind": "interface", | ||
| "extends": "IClientSideExtensionManifest", | ||
| "implements": "", | ||
| "typeParameters": [], | ||
| "deprecatedMessage": [], | ||
| "summary": [ | ||
| { | ||
| "kind": "textDocElement", | ||
| "value": "This is the manifest for a client-side extension that defines a set of custom commands that can be shown in a menu, tool bar, etc." | ||
| } | ||
| ], | ||
| "remarks": [], | ||
| "isBeta": true, | ||
| "members": { | ||
| "commands": { | ||
| "kind": "property", | ||
| "isOptional": true, | ||
| "isReadOnly": false, | ||
| "isStatic": false, | ||
| "type": "{ [commandId: string]: ICommandDefinition }", | ||
| "deprecatedMessage": [ | ||
| { | ||
| "kind": "textDocElement", | ||
| "value": "- Use items instead" | ||
| } | ||
| ], | ||
| "summary": [ | ||
| { | ||
| "kind": "textDocElement", | ||
| "value": "A table of commands defined by this command set. The object key is the Command ID." | ||
| } | ||
| ], | ||
| "remarks": [ | ||
| { | ||
| "kind": "textDocElement", | ||
| "value": "The Command ID is a unique identifier that event handlers use to recognize the command The identifier must consist of upper-case letters, numbers, and underscores. Example: \"SHOW_INFO\"" | ||
| } | ||
| ], | ||
| "isBeta": false | ||
| }, | ||
| "extensionType": { | ||
| "kind": "property", | ||
| "isOptional": false, | ||
| "isReadOnly": false, | ||
| "isStatic": false, | ||
| "type": "'ListViewCommandSet'", | ||
| "deprecatedMessage": [], | ||
| "summary": [ | ||
| { | ||
| "kind": "textDocElement", | ||
| "value": "Specifies the type of client-side extension. Some extension types support additional manifest fields beyond SPClientSideExtensionManifest." | ||
| } | ||
| ], | ||
| "remarks": [], | ||
| "isBeta": false | ||
| }, | ||
| "items": { | ||
| "kind": "property", | ||
| "isOptional": false, | ||
| "isReadOnly": false, | ||
| "isStatic": false, | ||
| "type": "{ [itemId: string]: ICommandDefinition }", | ||
| "deprecatedMessage": [], | ||
| "summary": [ | ||
| { | ||
| "kind": "textDocElement", | ||
| "value": "A table of items defined by this command set. The object key is the Item ID." | ||
| } | ||
| ], | ||
| "remarks": [ | ||
| { | ||
| "kind": "textDocElement", | ||
| "value": "The Item ID is a unique identifier that event handlers use to recognize the command The identifier must consist of upper-case letters, numbers, and underscores. Example: \"SHOW_INFO\"" | ||
| } | ||
| ], | ||
| "isBeta": false | ||
| } | ||
| } | ||
| }, | ||
| "IComponentModuleConfiguration": { | ||
| "kind": "interface", | ||
| "extends": "IModuleConfiguration", | ||
| "implements": "", | ||
| "typeParameters": [], | ||
| "deprecatedMessage": [], | ||
| "summary": [ | ||
| { | ||
| "kind": "textDocElement", | ||
| "value": "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." | ||
| } | ||
| ], | ||
| "remarks": [], | ||
| "isBeta": true, | ||
| "members": { | ||
| "failoverPath": { | ||
| "kind": "property", | ||
| "isOptional": true, | ||
| "isReadOnly": false, | ||
| "isStatic": false, | ||
| "type": "string | IPath", | ||
| "deprecatedMessage": [], | ||
| "summary": [ | ||
| { | ||
| "kind": "textDocElement", | ||
| "value": "Definition: A path to the framework-supplied component in case the framework fails to load the requested version. 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. Required: no Localized: no 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\"" | ||
| } | ||
| ], | ||
| "remarks": [], | ||
| "isBeta": false | ||
| }, | ||
| "id": { | ||
| "kind": "property", | ||
| "isOptional": false, | ||
| "isReadOnly": false, | ||
| "isStatic": false, | ||
| "type": "string", | ||
| "deprecatedMessage": [], | ||
| "summary": [ | ||
| { | ||
| "kind": "textDocElement", | ||
| "value": "Definition: The ID of the framework-supplied component to be loaded. Required: yes Localized: no Supported values: string representing a component's ID. Example: \"0d910c1c-13b9-4e1c-9aa4-b008c5e42d7d\"" | ||
| } | ||
| ], | ||
| "remarks": [], | ||
| "isBeta": false | ||
| }, | ||
| "version": { | ||
| "kind": "property", | ||
| "isOptional": false, | ||
| "isReadOnly": false, | ||
| "isStatic": false, | ||
| "type": "string", | ||
| "deprecatedMessage": [], | ||
| "summary": [ | ||
| { | ||
| "kind": "textDocElement", | ||
| "value": "Definition: 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. Required: yes Localized: no Supported values: string representing a semantic version (http://semver.org), or \"latest\". Example: \"2.2.4\"" | ||
| } | ||
| ], | ||
| "remarks": [], | ||
| "isBeta": false | ||
| } | ||
| } | ||
| }, | ||
| "ILocalizedPathModuleConfiguration": { | ||
| "kind": "interface", | ||
| "extends": "IModuleConfiguration", | ||
| "implements": "", | ||
| "typeParameters": [], | ||
| "deprecatedMessage": [], | ||
| "summary": [ | ||
| { | ||
| "kind": "textDocElement", | ||
| "value": "This is the interface for a script module with the \"localizedPath\" type. 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." | ||
| } | ||
| ], | ||
| "remarks": [], | ||
| "isBeta": true, | ||
| "members": { | ||
| "defaultPath": { | ||
| "kind": "property", | ||
| "isOptional": false, | ||
| "isReadOnly": false, | ||
| "isStatic": false, | ||
| "type": "string | IPath", | ||
| "deprecatedMessage": [], | ||
| "summary": [ | ||
| { | ||
| "kind": "textDocElement", | ||
| "value": "Definition: 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. 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. Required: yes Localized: no 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\"" | ||
| } | ||
| ], | ||
| "remarks": [], | ||
| "isBeta": false | ||
| }, | ||
| "paths": { | ||
| "kind": "property", | ||
| "isOptional": true, | ||
| "isReadOnly": false, | ||
| "isStatic": false, | ||
| "type": "{ [locale: string]: string | IPath }", | ||
| "deprecatedMessage": [], | ||
| "summary": [ | ||
| { | ||
| "kind": "textDocElement", | ||
| "value": "Definition: 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. 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. Required: no Localized: no 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\" }" | ||
| } | ||
| ], | ||
| "remarks": [], | ||
| "isBeta": false | ||
| } | ||
| } | ||
| }, | ||
| "ILocalizedString": { | ||
@@ -493,4 +938,167 @@ "kind": "interface", | ||
| } | ||
| }, | ||
| "IModuleConfiguration": { | ||
| "kind": "interface", | ||
| "extends": "", | ||
| "implements": "", | ||
| "typeParameters": [], | ||
| "deprecatedMessage": [], | ||
| "summary": [ | ||
| { | ||
| "kind": "textDocElement", | ||
| "value": "This is the base interface for a script module's definition." | ||
| } | ||
| ], | ||
| "remarks": [], | ||
| "isBeta": true, | ||
| "members": { | ||
| "shouldNotPreload": { | ||
| "kind": "property", | ||
| "isOptional": true, | ||
| "isReadOnly": false, | ||
| "isStatic": false, | ||
| "type": "boolean", | ||
| "deprecatedMessage": [], | ||
| "summary": [ | ||
| { | ||
| "kind": "textDocElement", | ||
| "value": "Definition: If set to \"true\", this module should not be preloaded when loading the component. 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. Required: no Example: true" | ||
| } | ||
| ], | ||
| "remarks": [], | ||
| "isBeta": false | ||
| }, | ||
| "type": { | ||
| "kind": "property", | ||
| "isOptional": false, | ||
| "isReadOnly": false, | ||
| "isStatic": false, | ||
| "type": "'component' | 'path' | 'localizedPath'", | ||
| "deprecatedMessage": [], | ||
| "summary": [ | ||
| { | ||
| "kind": "textDocElement", | ||
| "value": "Definition: 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. 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. Required: yes Localized: no Supported values: \"component\", \"path\", \"localizedPath\" Example: \"localized\"" | ||
| } | ||
| ], | ||
| "remarks": [], | ||
| "isBeta": false | ||
| } | ||
| } | ||
| }, | ||
| "IPath": { | ||
| "kind": "interface", | ||
| "extends": "", | ||
| "implements": "", | ||
| "typeParameters": [], | ||
| "deprecatedMessage": [], | ||
| "summary": [ | ||
| { | ||
| "kind": "textDocElement", | ||
| "value": "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." | ||
| } | ||
| ], | ||
| "remarks": [], | ||
| "isBeta": true, | ||
| "members": { | ||
| "debug": { | ||
| "kind": "property", | ||
| "isOptional": true, | ||
| "isReadOnly": false, | ||
| "isStatic": false, | ||
| "type": "string", | ||
| "deprecatedMessage": [], | ||
| "summary": [ | ||
| { | ||
| "kind": "textDocElement", | ||
| "value": "Definition: 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. Required: no 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\"" | ||
| } | ||
| ], | ||
| "remarks": [], | ||
| "isBeta": false | ||
| }, | ||
| "default": { | ||
| "kind": "property", | ||
| "isOptional": false, | ||
| "isReadOnly": false, | ||
| "isStatic": false, | ||
| "type": "string", | ||
| "deprecatedMessage": [], | ||
| "summary": [ | ||
| { | ||
| "kind": "textDocElement", | ||
| "value": "Definition: 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. Required: yes 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\"" | ||
| } | ||
| ], | ||
| "remarks": [], | ||
| "isBeta": false | ||
| } | ||
| } | ||
| }, | ||
| "IPathModuleConfiguration": { | ||
| "kind": "interface", | ||
| "extends": "IModuleConfiguration", | ||
| "implements": "", | ||
| "typeParameters": [], | ||
| "deprecatedMessage": [], | ||
| "summary": [ | ||
| { | ||
| "kind": "textDocElement", | ||
| "value": "This is the interface for a script module with the \"path\" type. Modules of this type must be provided by the component developer." | ||
| } | ||
| ], | ||
| "remarks": [], | ||
| "isBeta": true, | ||
| "members": { | ||
| "globalDependencies": { | ||
| "kind": "property", | ||
| "isOptional": true, | ||
| "isReadOnly": false, | ||
| "isStatic": false, | ||
| "type": "string[]", | ||
| "deprecatedMessage": [], | ||
| "summary": [ | ||
| { | ||
| "kind": "textDocElement", | ||
| "value": "Definition: For non-AMD/module-pattern scripts that have dependencies (for example, jQuery plugins), the module loader will ensure that those dependencies are already loaded. 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. Required: no Supported values: Names of other non-AMD-pattern modules in this loader configuration, as specified by the key IClientSideComponentLoaderConfiguration.scriptResources[] Example: [\"jquery\"]" | ||
| } | ||
| ], | ||
| "remarks": [], | ||
| "isBeta": false | ||
| }, | ||
| "globalName": { | ||
| "kind": "property", | ||
| "isOptional": true, | ||
| "isReadOnly": false, | ||
| "isStatic": false, | ||
| "type": "string", | ||
| "deprecatedMessage": [], | ||
| "summary": [ | ||
| { | ||
| "kind": "textDocElement", | ||
| "value": "Definition: 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. Required: no Localized: no 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: \"$\"" | ||
| } | ||
| ], | ||
| "remarks": [], | ||
| "isBeta": false | ||
| }, | ||
| "path": { | ||
| "kind": "property", | ||
| "isOptional": false, | ||
| "isReadOnly": false, | ||
| "isStatic": false, | ||
| "type": "string | IPath", | ||
| "deprecatedMessage": [], | ||
| "summary": [ | ||
| { | ||
| "kind": "textDocElement", | ||
| "value": "Definition: 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. 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. Required: yes Localized: no 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\"" | ||
| } | ||
| ], | ||
| "remarks": [], | ||
| "isBeta": false | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |
@@ -8,1 +8,3 @@ export * from './manifestSchemas/IClientSideApplicationManifest'; | ||
| export * from './manifestSchemas/ICommandSetExtensionManifest'; | ||
| export * from './manifestSchemas/IClientSideAssemblyManifest'; | ||
| export * from './manifestSchemas/ManifestType'; |
| "use strict"; | ||
| function __export(m) { | ||
| for (var p in m) if (!exports.hasOwnProperty(p)) exports[p] = m[p]; | ||
| } | ||
| Object.defineProperty(exports, "__esModule", { value: true }); | ||
| __export(require("./manifestSchemas/ManifestType")); | ||
| //# sourceMappingURL=index.js.map |
@@ -8,3 +8,3 @@ { | ||
| "alias": "Application", | ||
| "version": "0.0.1", | ||
| "version": "*", | ||
| "loaderConfig": { | ||
@@ -11,0 +11,0 @@ "internalModuleBaseUrls": [ |
@@ -22,17 +22,20 @@ { | ||
| "extensionType": "ListViewCommandSet", | ||
| "commands": { | ||
| "items": { | ||
| "REQUEST_AUDIT": { | ||
| "title": "Request audit", | ||
| "ariaLabel": "Request an audit. Press ENTER to select.", | ||
| "iconImageUrl": "icons/request.png" | ||
| "title": { "default": "Request audit" }, | ||
| "ariaLabel": { "default": "Request an audit. Press ENTER to select." }, | ||
| "iconImageUrl": "icons/request.png", | ||
| "type": "command" | ||
| }, | ||
| "CANCEL_AUDIT": { | ||
| "title": "Cancel audit", | ||
| "iconImageUrl": "icons/cancel.png" | ||
| "title": { "default": "Cancel audit" }, | ||
| "iconImageUrl": "icons/cancel.png", | ||
| "type": "command" | ||
| }, | ||
| "CHECK": { | ||
| "title": "Check for auditing issues", | ||
| "iconImageUrl": "icons/check.png" | ||
| "title": { "default": "Check for auditing issues" }, | ||
| "iconImageUrl": "icons/check.png", | ||
| "type": "command" | ||
| } | ||
| } | ||
| } |
@@ -0,1 +1,2 @@ | ||
| "use strict"; | ||
| /** | ||
@@ -6,5 +7,4 @@ * @Copyright (c) Microsoft Corporation. All rights reserved. | ||
| */ | ||
| "use strict"; | ||
| Object.defineProperty(exports, "__esModule", { value: true }); | ||
| //# sourceMappingURL=IClientSideApplicationManifest.js.map |
@@ -7,3 +7,3 @@ /** | ||
| /** | ||
| * This interface describes how a client side component is to be loaded and initailized by a SharePoint client | ||
| * 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. | ||
@@ -17,3 +17,3 @@ * | ||
| * "internal" or "localized" type. If one fails to load, the loader will attempt to load from the next until there | ||
| * are no base paths remaning. All "internal" and "localized" script resources that do not have fully-qualified URLs | ||
| * are no base paths remaining. 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 | ||
@@ -55,5 +55,5 @@ * internal module's "path" field value is "master_2015-04-20/my-application.bundle_1928f8a0.js" and this field's | ||
| * "{ foo: 'bar', baz: 123 }" and: | ||
| * - if this field is unset, the value returned by the modue loader is "{ foo: 'bar', baz: 123 }" | ||
| * - if this field is set to "foo", the value returned by the modue loader is "bar" | ||
| * - if this field is set to "bar", the value returned by the modue loader is undefined (as "bar" is not a key in | ||
| * - 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). | ||
@@ -122,3 +122,3 @@ * | ||
| * Supported values: The path to the default/non-debug script either as a fully-qualified URL or as a path under the | ||
| * paths providedin the "internalModuleBaseUrls" field. | ||
| * paths provided in the "internalModuleBaseUrls" field. | ||
| * Example: "master_2015-04-20/my-application.bundle_1928f8a0.js" | ||
@@ -133,3 +133,3 @@ */ | ||
| * Supported values: The path to the debug script either as a fully-qualified URL or as a path under the | ||
| * paths providedin the "internalModuleBaseUrls" field. | ||
| * paths provided in the "internalModuleBaseUrls" field. | ||
| * Example: "master_2015-04-20/my-application.bundle_18182c39.debug.js" | ||
@@ -201,3 +201,3 @@ */ | ||
| * Supported values: The path to the component either as a fully-qualified URL or as a path under the | ||
| * paths providedin the "internalModuleBaseUrls" field. | ||
| * paths provided in the "internalModuleBaseUrls" field. | ||
| * Example: "https://code.jquery.com/jquery-2.2.4.min.js" | ||
@@ -227,3 +227,3 @@ */ | ||
| * Supported values: The path to the module either as a fully-qualified URL or as a path under the | ||
| * paths providedin the "internalModuleBaseUrls" field. | ||
| * paths provided in the "internalModuleBaseUrls" field. | ||
| * Example: "master_2015-04-20/my-application.bundle_1928f8a0.js" | ||
@@ -235,3 +235,3 @@ */ | ||
| * 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 propery is specified, this module is considered non-AMD and | ||
| * 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 | ||
@@ -277,3 +277,3 @@ * finish loading and examine the global variable specified in this field. | ||
| * 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 providedin the "internalModuleBaseUrls" field. | ||
| * under the paths provided in the "internalModuleBaseUrls" field. | ||
| * Example: "master_2015-04-20/my-application_strings_default_af378e0d.js" | ||
@@ -283,3 +283,3 @@ */ | ||
| /** | ||
| * Definition: This is a dictionary of locale keys (in the "ll-cc" format) to paths to this module's localed | ||
| * Definition: 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 | ||
@@ -286,0 +286,0 @@ * "internalModuleBaseUrls" field. The loader will attempt to resolve the user's locale to one of the paths provided |
@@ -0,1 +1,2 @@ | ||
| "use strict"; | ||
| /** | ||
@@ -6,5 +7,4 @@ * @Copyright (c) Microsoft Corporation. All rights reserved. | ||
| */ | ||
| "use strict"; | ||
| Object.defineProperty(exports, "__esModule", { value: true }); | ||
| //# sourceMappingURL=IClientSideComponentLoaderConfiguration.js.map |
@@ -45,7 +45,7 @@ /** | ||
| * | ||
| * The schema of this manifest is owned and vesioned by Microsoft. Following rules should be followed while changing | ||
| * 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 absense of those new properties. | ||
| * 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 | ||
@@ -52,0 +52,0 @@ * impose a migration cost on developers. |
@@ -0,1 +1,2 @@ | ||
| "use strict"; | ||
| /** | ||
@@ -6,5 +7,4 @@ * @Copyright (c) Microsoft Corporation. All rights reserved. | ||
| */ | ||
| "use strict"; | ||
| Object.defineProperty(exports, "__esModule", { value: true }); | ||
| //# sourceMappingURL=IClientSideComponentManifest.js.map |
@@ -0,1 +1,2 @@ | ||
| "use strict"; | ||
| /** | ||
@@ -6,5 +7,4 @@ * @Copyright (c) Microsoft Corporation. All rights reserved. | ||
| */ | ||
| "use strict"; | ||
| Object.defineProperty(exports, "__esModule", { value: true }); | ||
| //# sourceMappingURL=IClientSideLibraryManifest.js.map |
@@ -55,3 +55,3 @@ /** | ||
| * by the author of the page. | ||
| * Usage: help display a Web Part in the Tooblox, PropertyPane and the initial rendering of the Web Part. | ||
| * Usage: help display a Web Part in the Toolbox, PropertyPane and the initial rendering of the Web Part. | ||
| * Required: yes | ||
@@ -151,2 +151,15 @@ * Type: JSON object | ||
| iconImageUrl?: string; | ||
| /** | ||
| * Definition: A group id. This group id should be used to decide which toolbox group the web part should be | ||
| * placed into. The client side framework has reserved group ids for default groups. The developer can pick | ||
| * one of those groups. In that case the group field will be ignored. Alternatively, the developer can pick | ||
| * a completely unique id and a group name. The toolbox will then show the web part in its own group. | ||
| * Usage: display of the Web Part icon in a specific group in the authoring toolbox. | ||
| * Required: yes | ||
| * Localized: no | ||
| * Supported values: any GUID | ||
| * Example: "dbef608d-3ad5-4f8f-b139-d916f2f0a294" | ||
| * | ||
| * @beta | ||
| */ | ||
| groupId: string; | ||
@@ -153,0 +166,0 @@ /** |
@@ -0,1 +1,2 @@ | ||
| "use strict"; | ||
| /** | ||
@@ -6,5 +7,4 @@ * @Copyright (c) Microsoft Corporation. All rights reserved. | ||
| */ | ||
| "use strict"; | ||
| Object.defineProperty(exports, "__esModule", { value: true }); | ||
| //# sourceMappingURL=IClientSideWebPartManifest.js.map |
@@ -0,1 +1,2 @@ | ||
| import { ILocalizedString } from './IClientSideComponentManifest'; | ||
| import { IClientSideExtensionManifest } from './IClientSideExtensionManifest'; | ||
@@ -32,6 +33,20 @@ /** | ||
| * Example: "SHOW_INFO" | ||
| * | ||
| * @deprecated - Use items instead | ||
| */ | ||
| commands: { | ||
| commands?: { | ||
| [commandId: string]: ICommandDefinition; | ||
| }; | ||
| /** | ||
| * A table of items defined by this command set. The object key is the Item ID. | ||
| * | ||
| * @remarks | ||
| * | ||
| * The Item ID is a unique identifier that event handlers use to recognize the command | ||
| * The identifier must consist of upper-case letters, numbers, and underscores. | ||
| * Example: "SHOW_INFO" | ||
| */ | ||
| items: { | ||
| [itemId: string]: ICommandDefinition; | ||
| }; | ||
| } | ||
@@ -49,4 +64,9 @@ /** | ||
| */ | ||
| title: string; | ||
| title: ILocalizedString; | ||
| /** | ||
| * Type of the item. | ||
| * Currently only "command" is allowed. | ||
| */ | ||
| type: 'command'; | ||
| /** | ||
| * Custom accessibility text for the browser's "aria-label" attribute. If omitted, the title property | ||
@@ -56,3 +76,3 @@ * will be used by default. | ||
| */ | ||
| ariaLabel?: string; | ||
| ariaLabel?: ILocalizedString; | ||
| /** | ||
@@ -59,0 +79,0 @@ * An optional URL for an image to be displayed next to the command. The requirements for this image |
@@ -80,3 +80,3 @@ { | ||
| "title": "Internal Module Base URLs", | ||
| "description": "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 remaning. 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.", | ||
| "description": "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. 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.", | ||
| "minItems": 1, | ||
@@ -100,3 +100,3 @@ "items": { | ||
| "title": "Export Name", | ||
| "description": "This value points to a top-level field from the entryModuleId module's export. If this parameter is set, the field referenced in the entryModuleId module's export is returned by the module loader when this manfiest is loaded, instead of the top-level export.", | ||
| "description": "This value points to a top-level field from the entryModuleId module's export. If this parameter is set, the field referenced in the entryModuleId module's export is returned by the module loader when this manifest is loaded, instead of the top-level export.", | ||
| "minLength": 1, | ||
@@ -222,3 +222,3 @@ "maxLength": 100 | ||
| "title": "Global Name", | ||
| "description": "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 propery 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.", | ||
| "description": "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.", | ||
| "type": "string", | ||
@@ -284,3 +284,3 @@ "minLength": 1 | ||
| "title": "Paths", | ||
| "description": "This is a dictionary of locale keys (in the \"ll-cc\" format) to paths to this module's localed javascript resource either as a fully-qualified URL or as a path under the paths provided in the \"internalModuleBaseUrls\" field. 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.", | ||
| "description": "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. 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.", | ||
| "type": "object", | ||
@@ -287,0 +287,0 @@ "patternProperties": { |
@@ -77,5 +77,15 @@ { | ||
| "version": { | ||
| "$ref": "semver.schema.json", | ||
| "title": "Version", | ||
| "description": "Client side component version. The value of this field is expected to be controlled by the developer of the client side component. The purpose of this field is to help client side component developers upgrade their client side components in a managed way. This helps the consumers of the client side component make decisions about when and how to upgrade the client side component. As the developer evolves the code for their client side component, they can decide to bump the MAJOR, MINOR or PATCH version of the component. All incompatible API changes should result in a MAJOR version bump. Backwards compatible functionality changes should result in a MINOR version bump, and backwards compatible bug fixes should result in a PATCH version bump. Please see http://semver.org for more details on how to manage the version of your components." | ||
| "description": "Client side component version. The value of this field is expected to be controlled by the developer of the client side component. The purpose of this field is to help client side component developers upgrade their client side components in a managed way. This helps the consumers of the client side component make decisions about when and how to upgrade the client side component. As the developer evolves the code for their client side component, they can decide to bump the MAJOR, MINOR or PATCH version of the component. All incompatible API changes should result in a MAJOR version bump. Backwards compatible functionality changes should result in a MINOR version bump, and backwards compatible bug fixes should result in a PATCH version bump. Please see http://semver.org for more details on how to manage the version of your components.", | ||
| "oneOf": [ | ||
| { | ||
| "$ref": "semver.schema.json" | ||
| }, | ||
| { | ||
| "type": "string", | ||
| "enum": [ | ||
| "*" | ||
| ] | ||
| } | ||
| ] | ||
| }, | ||
@@ -107,4 +117,7 @@ | ||
| "$ref": "command-set-extension-manifest.schema.json" | ||
| }, | ||
| { | ||
| "$ref": "client-side-assembly-manifest.schema.json" | ||
| } | ||
| ] | ||
| } |
@@ -120,3 +120,3 @@ { | ||
| "title": "Icon Image URL", | ||
| "description": " The icon for the WebPart, to be displayed in the toolbox, represented an image URL. The image at the URL must be exactly 38x38 px (SPPPLAT VSO#218660 to fix the size of the icon image). If the 'officeFabricIconName' field does not have a value, this field must have a value.", | ||
| "description": " The icon for the WebPart, to be displayed in the toolbox, represented an image URL. The image at the URL must be exactly 38x38 px. If the 'officeFabricIconName' field does not have a value, this field must have a value.", | ||
| "type": "string", | ||
@@ -123,0 +123,0 @@ "minLength": 10 |
@@ -29,5 +29,5 @@ { | ||
| }, | ||
| "commands": { "$ref": "any-value.schema.json" } | ||
| "items": { "$ref": "any-value.schema.json" } | ||
| }, | ||
| "additionalProperties": false | ||
| "additionalProperties": true | ||
| }, | ||
@@ -43,9 +43,9 @@ { | ||
| "required": [ | ||
| "commands" | ||
| "items" | ||
| ], | ||
| "properties": { | ||
| "commands": { | ||
| "items": { | ||
| "type": "object", | ||
| "title": "Commands", | ||
| "description": "A table of commands defined by this command set. The object key is the Command ID. The Command ID is a unique identifier that event handlers use to recognize the command. The identifier must consist of upper-case letters, numbers, and underscores. Example: \"SHOW_INFO\"", | ||
| "title": "Items", | ||
| "description": "A table of items defined by this command set. The object key is the Item ID. The Item ID is a unique identifier that event handlers use to recognize the item. The identifier must consist of upper-case letters, numbers, and underscores. Example: \"SHOW_INFO\"", | ||
| "patternProperties": { | ||
@@ -55,15 +55,23 @@ "^[A-Z0-9_]+$": { | ||
| "required": [ | ||
| "title" | ||
| "title", | ||
| "type" | ||
| ], | ||
| "properties": { | ||
| "title": { | ||
| "type": "string", | ||
| "title": "Title", | ||
| "description": "A short label to be displayed by the associated button, menu item, etc. Example: \"Show information\"", | ||
| "maxLength": 50 | ||
| "$ref": "localized-string.schema.json" | ||
| }, | ||
| "type": { | ||
| "type": "string", | ||
| "enum": [ | ||
| "command" | ||
| ], | ||
| "title": "Type", | ||
| "description": "Type of the item. Currently only \"command\" is allowed." | ||
| }, | ||
| "ariaLabel": { | ||
| "type": "string", | ||
| "title": "ARIA Label", | ||
| "description": "Custom accessibility text for the browser's \"aria-label\" attribute. If omitted, the title property will be used by default." | ||
| "description": "Custom accessibility text for the browser's \"aria-label\" attribute. If omitted, the title property will be used by default.", | ||
| "$ref": "localized-string.schema.json" | ||
| }, | ||
@@ -73,3 +81,3 @@ "iconImageUrl": { | ||
| "title": "Icon Image URL", | ||
| "description": "An optional URL for an image to be displayed next to the command. The requirements for this image are defined by the type of extension; some extension types may not display the image at all." | ||
| "description": "An optional URL for an image to be displayed next to the item. The requirements for this image are defined by the type of extension; some extension types may not display the image at all." | ||
| } | ||
@@ -76,0 +84,0 @@ }, |
@@ -8,2 +8,3 @@ export import ZSchema = require('z-schema'); | ||
| import { ICommandSetExtensionManifest } from './manifestSchemas/ICommandSetExtensionManifest'; | ||
| import { IClientSideAssemblyManifest } from './manifestSchemas/IClientSideAssemblyManifest'; | ||
| export declare const zSchemaOptions: ZSchema.Options; | ||
@@ -20,2 +21,3 @@ export interface IManifestValidatorResult { | ||
| static validateLibraryManifest(manifest: string | IClientSideLibraryManifest): IManifestValidatorResult; | ||
| static validateAssemblyManifest(manifest: string | IClientSideAssemblyManifest): IManifestValidatorResult; | ||
| static validateManifest(manifest: string | IClientSideComponentManifest): IManifestValidatorResult; | ||
@@ -22,0 +24,0 @@ static extractInnerErrorMessages(errors: ZSchema.SchemaError[]): string[]; |
@@ -18,2 +18,3 @@ "use strict"; | ||
| var librarySchema = require('./manifestSchemas/jsonSchemas/client-side-library-manifest.schema.json'); | ||
| var assemblySchema = require('./manifestSchemas/jsonSchemas/client-side-assembly-manifest.schema.json'); | ||
| exports.zSchemaOptions = { | ||
@@ -51,2 +52,5 @@ breakOnFirstError: true, | ||
| }; | ||
| ManifestValidator.validateAssemblyManifest = function (manifest) { | ||
| return ManifestValidator._validateManifest(manifest, assemblySchema); | ||
| }; | ||
| ManifestValidator.validateManifest = function (manifest) { | ||
@@ -53,0 +57,0 @@ return ManifestValidator._validateManifest(manifest, manifestSchema); |
| { | ||
| "name": "@microsoft/sp-module-interfaces", | ||
| "version": "1.1.1", | ||
| "version": "1.2.0", | ||
| "description": "SharePoint Framework module interfaces", | ||
@@ -19,3 +19,3 @@ "license": "SEE LICENSE IN \"EULA\" FOLDER", | ||
| "gulp": "~3.9.1", | ||
| "@microsoft/sp-build-node": "~1.1.0", | ||
| "@microsoft/sp-build-node": "~1.2.0", | ||
| "chai": "~3.5.0", | ||
@@ -22,0 +22,0 @@ "@types/chai": "3.4.34", |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
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
Improved metrics
- Total package byte prevSize
- increased by3.82%
2120708
- Number of package files
- increased by8.87%
135
- Lines of code
- increased by27.94%
6897
- Number of low supply chain risk alerts
- decreased by-28.57%
5
No dependency changes