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

Comparing version 1.4.1 to 1.5.0-plusbeta

CHANGELOG.json

@@ -5,2 +5,20 @@ {
     {
+      "version": "1.5.0",
+      "tag": "@microsoft/sp-module-interfaces_v1.5.0",
+      "date": "Fri, 01 Jun 2018 18:13:37 GMT",
+      "comments": {
+        "none": [
+          {
+            "comment": "Update the docs for the manifest group field."
+          },
+          {
+            "comment": "Update package to work with Node 8"
+          },
+          {
+            "comment": "Update JSON schema URLs to reference new server"
+          }
+        ]
+      }
+    },
+    {
       "version": "1.4.1",
@@ -7,0 +25,0 @@ "tag": "@microsoft/sp-module-interfaces_v1.4.1",

CHANGELOG.md

 # Change Log - @microsoft/sp-module-interfaces
 
-This log was last generated on Thu, 15 Feb 2018 01:56:14 GMT and should not be manually modified.
+This log was last generated on Fri, 01 Jun 2018 20:13:50 GMT and should not be manually modified.
 
+## 1.5.0
+Fri, 01 Jun 2018 18:13:37 GMT
+
+### Updates
+
+- Update the docs for the manifest group field.
+- Update package to work with Node 8
+- Update JSON schema URLs to reference new server
+
 ## 1.4.1
 Thu, 15 Feb 2018 01:56:14 GMT
 
-*Version update only*
+### Updates
 
+- Package version bump from 1.4.1-pr.2 to 1.4.1 by version policy
+
 ## 1.4.0
@@ -11,0 +22,0 @@ Mon, 04 Dec 2017 18:15:58 GMT

lib/index.js

@@ -6,4 +6,5 @@ "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+__export(require("./manifestSchemas/IClientSideWebPartManifest"));
 __export(require("./manifestSchemas/ManifestType"));
 
 //# sourceMappingURL=index.js.map

lib/manifestSchemas/IClientSideWebPartManifest.d.ts

@@ -48,2 +48,31 @@ /**
     /**
+     * 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.
+     *
+     * Required: no
+     * Localized: no
+     * Supported values: the ICapabilityCollection object
+     * Example { "BingMapKey": true, "AuthModel": ["OpenIDConnect"] }
+     *
+     * @internalremarks This API is currently not available to 3rd parties. This feature is still in experimental stages.
+     * Only when the final design is ready, will we consider opening it to 3rd parties.
+     *
+     * @alpha
+     */
+    requiredCapabilities?: ICapabilityCollection;
+    /**
+     * Describes the level of isolation needed for the web part.
+     * 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.
+     *
+     * Required: no
+     * Supported values: "None", "DOMIsolation"
+     *
+     * @alpha
+     */
+    isolationLevel?: 'None' | 'DomIsolation';
+    /**
      * Definition: A Web Part can have pre-configured properties like the title, description, toolbox group name and Web
@@ -156,7 +185,9 @@ *  Part specific custom properties. And there can be multiple instances of these pre-configured properties. This
     /**
-     * Definition: The group ID determines which toolbox group will contain the web part. The client-side framework has
-     *  reserved group IDs for predefined groups. The developer can pick one of those groups.
+     * Definition: 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.
+     *
      * Required: yes
      * Localized: no
-     * Supported values: any GUID
+     * Supported values: the GUID from PredefinedGroup list
      * Example: "cf066440-0614-43d6-98ae-0b31cf14c7c3"
@@ -168,5 +199,5 @@ *
     /**
-     * Definition: This field is used to determine which toolbox group will contain the web part in the authoring
-     *  experience. On classic pages, the web part gallery is equivalent to the toolbox. When you choose a GUID as a group
-     *  ID, use the corresponding classic page category name from the predefined group. See {@link PredefinedGroup}.
+     * Definition: 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.
+     *
      * Required: no
@@ -224,10 +255,7 @@ * Localized: yes
  */
-export declare type PredefinedGroup = PredefinedGroup.TextMediaAndContent | PredefinedGroup.Discovery | PredefinedGroup.CommunicationAndCollaboration | PredefinedGroup.PlanningAndProcess | PredefinedGroup.BusinessAndIntelligence | PredefinedGroup.SiteTools | PredefinedGroup.Other;
-export declare namespace PredefinedGroup {
+export declare const enum PredefinedGroup {
     /**
      * Text, media and content.
      *
-     * Corresponding classic page category name: Media and Content
-     *
-     * This category includes web parts that display text, multi-media, documents, information from the web, and other
+     * This group includes web parts that display text, multi-media, documents, information from the web, and other
      * rich content.
@@ -237,63 +265,76 @@ *
      */
-    type TextMediaAndContent = 'cf066440-0614-43d6-98ae-0b31cf14c7c3';
+    TextMediaAndContent = "cf066440-0614-43d6-98ae-0b31cf14c7c3",
     /**
      * Discovery.
      *
-     * Corresponding classic page category name: Discovery
+     * This group includes web parts that organize, group, and filter content to help users discover information.
      *
-     * This category includes web parts that organize, group, and filter content to help users discover information.
-     *
      * @beta
      */
-    type Discovery = '1edbd9a8-0bfb-4aa2-9afd-14b8c45dd489';
+    Discovery = "1edbd9a8-0bfb-4aa2-9afd-14b8c45dd489",
     /**
      * Communication and collaboration.
      *
-     * Corresponding classic page category name: Social Collaboration
+     * This group includes web parts that facilitate information sharing, team work, and social interactions.
      *
-     * This category includes web parts that facilitate information sharing, team work, and social interactions.
-     *
      * @beta
      */
-    type CommunicationAndCollaboration = '75e22ed5-fa14-4829-850a-c890608aca2d';
+    CommunicationAndCollaboration = "75e22ed5-fa14-4829-850a-c890608aca2d",
     /**
      * Planning and process.
      *
-     * Corresponding classic page category name: Business Data
+     * This group includes web parts that empower team productivity with the use of planning and process tools.
      *
-     * This category includes web parts that empower team productivity with the use of planning and process tools.
-     *
      * @beta
      */
-    type PlanningAndProcess = '1bc7927e-4a5e-4520-b540-71305c79c20a';
+    PlanningAndProcess = "1bc7927e-4a5e-4520-b540-71305c79c20a",
     /**
      * Business and intelligence.
      *
-     * Corresponding classic page category name: Business Data
+     * This group includes web parts for tracking and analyzing data, and for integrating business flow with pages.
      *
-     * This category includes web parts for tracking and analyzing data, and for integrating business flow with pages.
-     *
      * @beta
      */
-    type BusinessAndIntelligence = '4aca9e90-eff5-4fa1-bac7-728f5f157b66';
+    BusinessAndIntelligence = "4aca9e90-eff5-4fa1-bac7-728f5f157b66",
     /**
      * Site tools.
      *
-     * Corresponding classic page category name: Site Tools
+     * This group includes web parts for site information and management.
      *
-     * This category includes web parts for site information and management.
-     *
      * @beta
      */
-    type SiteTools = '070951d7-94da-4db8-b06e-9d581f1f55b1';
+    SiteTools = "070951d7-94da-4db8-b06e-9d581f1f55b1",
     /**
      * Other.
      *
-     * Corresponding classic page category name: Other
+     * This group includes web parts not in other groups.
      *
-     * This category includes web parts not in other categories.
-     *
      * @beta
      */
-    type Other = '5c03119e-3074-46fd-976b-c60198311f70';
+    Other = "5c03119e-3074-46fd-976b-c60198311f70",
 }
+/**
+ * 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.
+ *
+ * @internalremarks This API is currently not available to 3rd parties. This feature is still in experimental stages.
+ * Only when the final design is ready, will we consider opening it to 3rd parties.
+ *
+ * @alpha
+ */
+export 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'>;
+}

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

@@ -20,3 +20,3 @@ {
           "title": "Text, media, and content",
-          "description": "This category includes web parts that display text, multi-media, documents, information from the web, and other rich content.",
+          "description": "This group includes web parts that display text, multi-media, documents, information from the web, and other rich content.",
           "type": "string",
@@ -27,3 +27,3 @@ "pattern": "^cf066440-0614-43d6-98ae-0b31cf14c7c3$"
           "title": "Discovery",
-          "description": "This category includes web parts that organize, group, and filter content to help users discover information.",
+          "description": "This group includes web parts that organize, group, and filter content to help users discover information.",
           "type": "string",
@@ -34,3 +34,3 @@ "pattern": "^1edbd9a8-0bfb-4aa2-9afd-14b8c45dd489$"
           "title": "Communication and collaboration",
-          "description": "This category includes web parts that facilitate information sharing, team work, and social interactions.",
+          "description": "This group includes web parts that facilitate information sharing, team work, and social interactions.",
           "type": "string",
@@ -41,3 +41,3 @@ "pattern": "^75e22ed5-fa14-4829-850a-c890608aca2d$"
           "title": "Planning and process",
-          "description": "This category includes web parts that empower team productivity with the use of planning and process tools.",
+          "description": "This group includes web parts that empower team productivity with the use of planning and process tools.",
           "type": "string",
@@ -48,3 +48,3 @@ "pattern": "^1bc7927e-4a5e-4520-b540-71305c79c20a$"
           "title": "Business and intelligence",
-          "description": "This category includes web parts for tracking and analyzing data, and for integrating business flow with pages.",
+          "description": "This group includes web parts for tracking and analyzing data, and for integrating business flow with pages.",
           "type": "string",
@@ -55,3 +55,3 @@ "pattern": "^4aca9e90-eff5-4fa1-bac7-728f5f157b66$"
           "title": "Site tools",
-          "description": "This category includes web parts for site information and management.",
+          "description": "This group includes web parts for site information and management.",
           "type": "string",
@@ -62,3 +62,3 @@ "pattern": "^070951d7-94da-4db8-b06e-9d581f1f55b1$"
           "title": "Other",
-          "description": "This category includes web parts not in other categories.",
+          "description": "This group includes web parts not in other categories.",
           "type": "string",
@@ -89,2 +89,3 @@ "pattern": "^5c03119e-3074-46fd-976b-c60198311f70$"
         "preloadComponents": { "$ref": "any-value.schema.json" },
+        "requiredCapabilities": { "$ref": "any-value.schema.json" },
         "requiresCustomScript": { "$ref": "any-value.schema.json"},
@@ -106,2 +107,11 @@ "safeWithCustomScriptDisabled": { "$ref": "any-value.schema.json" },
           "description": "If set to \"true\", this web part supports and has been tested for full bleed experience."
+        },
+        "isolationLevel": {
+          "type": "string",
+          "title": "Isolation Level",
+          "description": "Describes the level of isolation (\"None\", \"DOMIsolation\") needed for the \"WebPart\".",
+          "enum": [
+            "None",
+            "DOMIsolation"
+          ]
         }
@@ -146,2 +156,26 @@ },
 
+        "requiredCapabilities": {
+          "title": "Required Capabilities",
+          "description": "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.",
+          "type": "object",
+          "additionalProperties": false,
+          "properties": {
+            "BingMapsKey": {
+              "description": "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.",
+              "type": "boolean"
+            },
+            "AuthenticationModel": {
+              "description": "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.",
+              "type": "array",
+              "items": {
+                "type": "string",
+                "enum": [
+                  "OpenIDConnect",
+                  "Federated"
+                ]
+              }
+            }
+          }
+        },
+
         "preconfiguredEntries": {
@@ -185,3 +219,3 @@ "title": "Pre-configured Entries",
                 "title": "Group ID",
-                "description": "This field is used to determine which toolbox group will contain the web part in the authoring experience. On classic pages, the web part gallery is equivalent to the toolbox. When you choose a GUID as a group ID (as in the table below), use the corresponding classic page category name from the predefined group.",
+                "description": "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.",
                 "type": "string",
@@ -194,4 +228,3 @@ "anyOf":[
                   {
-                    "title": "Customized Group",
-                    "description": "The customized group is a unique id with a group name. The toolbox will then show the web part in its own group.",
+                    "description": "If the group ID is not from the predefined group list, the web part will go to Other group.",
                     "$ref": "guid.schema.json"
@@ -204,3 +237,3 @@ }
                 "title": "Group",
-                "description": "This field is used to determine which toolbox group will contain the web part in the authoring experience. On classic pages, the web part gallery is equivalent to the toolbox. When you choose a GUID as a group ID, use the corresponding classic page category name from the predefined group.",
+                "description": "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.",
                 "$ref": "localized-string.schema.json"
@@ -207,0 +240,0 @@ },

package.json

 {
   "name": "@microsoft/sp-module-interfaces",
-  "version": "1.4.1",
+  "version": "1.5.0-plusbeta",
   "description": "SharePoint Framework module interfaces",
@@ -14,6 +14,9 @@ "license": "SEE LICENSE IN \"EULA\" FOLDER",
   "main": "lib/index.js",
-  "typings": "lib/index.d.ts",
+  "typings": "dist/index-internal.d.ts",
+  "tsdoc": {
+    "tsdocFlavor": "AEDoc"
+  },
   "devDependencies": {
     "gulp": "~3.9.1",
-    "@microsoft/sp-build-node": "1.4.1",
+    "@microsoft/sp-build-node": "1.5.0-plusbeta",
     "chai": "~3.5.0",
@@ -26,3 +29,3 @@ "@types/chai": "3.4.34",
   "dependencies": {
-    "@types/node": "6.0.64",
+    "@types/node": "8.5.8",
     "z-schema": "~3.18.3",
@@ -29,0 +32,0 @@ "@types/z-schema": "3.16.31"

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This 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

2183469

increased by2.45%

Number of package files

133

increased by0.76%

Lines of code

8280

increased by14.92%

Worsened metrics

Number of low quality alerts

1

increased byInfinity%

Dependency changes

• + Added@types/node@8.5.8(transitive)

• - Removed@types/node@6.0.64(transitive)

• Updated@types/node@8.5.8