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

Comparing version 1.2.0 to 1.3.0

CHANGELOG.json

@@ -5,2 +5,28 @@ {
     {
+      "version": "1.3.0",
+      "tag": "@microsoft/sp-module-interfaces_v1.3.0",
+      "date": "Fri, 22 Sep 2017 20:19:09 GMT",
+      "comments": {
+        "patch": [
+          {
+            "comment": "Update the group and groupId description."
+          },
+          {
+            "comment": "Remove deprecated property 'ICommandSetExtensionManifest.commands', use 'items' instead."
+          },
+          {
+            "comment": "Update the schema validator."
+          },
+          {
+            "comment": "Update guidance around the Web Part manifests' iconImageUrl size"
+          }
+        ],
+        "minor": [
+          {
+            "comment": "Provide the predefined group list in manifest schema."
+          }
+        ]
+      }
+    },
+    {
       "version": "1.2.0",
@@ -7,0 +33,0 @@ "tag": "@microsoft/sp-module-interfaces_v1.2.0",

CHANGELOG.md

 # Change Log - @microsoft/sp-module-interfaces
 
-This log was last generated on Fri, 25 Aug 2017 22:24:38 GMT and should not be manually modified.
+This log was last generated on Fri, 22 Sep 2017 21:14:03 GMT and should not be manually modified.
 
+## 1.3.0
+Fri, 22 Sep 2017 20:19:09 GMT
+
+### Minor changes
+
+- Provide the predefined group list in manifest schema.
+
+### Patches
+
+- Update the group and groupId description.
+- Remove deprecated property 'ICommandSetExtensionManifest.commands', use 'items' instead.
+- Update the schema validator.
+- Update guidance around the Web Part manifests' iconImageUrl size
+
 ## 1.2.0
@@ -6,0 +20,0 @@ Fri, 25 Aug 2017 20:31:17 GMT

dist/sp-module-interfaces.api.json

 {
   "kind": "package",
+  "name": "@microsoft/sp-module-interfaces",
   "summary": [],
@@ -469,3 +470,16 @@ "remarks": [],
               "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\" }"
+              "value": "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"
+            },
+            {
+              "kind": "linkDocElement",
+              "referenceType": "code",
+              "scopeName": "",
+              "packageName": "",
+              "exportName": "PredefinedGroup",
+              "memberName": "",
+              "value": "PredefinedGroup"
+            },
+            {
+              "kind": "textDocElement",
+              "value": ". Required: no Localized: yes Supported values: string Example: { \"default\": \"Media and Content\" }"
             }
@@ -481,3 +495,3 @@ ],
           "isStatic": false,
-          "type": "string",
+          "type": "PredefinedGroup | string",
           "deprecatedMessage": [],
@@ -487,3 +501,3 @@ "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\""
+              "value": "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. Required: yes Localized: no Supported values: any GUID Example: \"cf066440-0614-43d6-98ae-0b31cf14c7c3\""
             }
@@ -504,3 +518,3 @@ ],
               "kind": "textDocElement",
-              "value": "Definition: The icon for the web part, 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 '"
+              "value": "Definition: The icon for the web part, to be displayed in the toolbox, represented an image URL. The image at the URL must be exactly 40x28 px (SPPPLAT VSO#218660 to fix the size of the icon image). If the '"
             },
@@ -700,28 +714,2 @@ {
       "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": {
@@ -728,0 +716,0 @@ "kind": "property",

lib/manifestSchemas/examples/webpart_1.manifest.js

@@ -337,3 +337,3 @@ "use strict";
             properties: {},
-            groupId: '123123'
+            groupId: '75e22ed5-fa14-4829-850a-c890608aca2d' // Communication and Collaboration
         }]
@@ -340,0 +340,0 @@ };

lib/manifestSchemas/examples/webpart_2.manifest.js

@@ -336,3 +336,3 @@ "use strict";
             properties: {},
-            groupId: 'abc123'
+            groupId: '1bc7927e-4a5e-4520-b540-71305c79c20a' // Planning and Process
         },
@@ -348,3 +348,3 @@ {
             group: { default: 'asdf' },
-            groupId: 'abc123'
+            groupId: '0314dcd9-9acb-4ab2-886e-f8881ffb5192' // Customized Group
         },
@@ -360,3 +360,3 @@ {
             group: { default: 'asdf', 'en-us': 'asdfasdf' },
-            groupId: 'abc123'
+            groupId: '1db70b09-46dc-4fa1-9c97-dcce28dad5d9' // Customized Group
         }]
@@ -363,0 +363,0 @@ };

lib/manifestSchemas/examples/webpart.manifest.json

@@ -345,3 +345,4 @@ {
       "properties": {},
-      "groupId": "abc123"
+      "groupId": "1bc7927e-4a5e-4520-b540-71305c79c20a",
+      "group": { "default": "Planning and Process" }
     },
@@ -362,6 +363,4 @@ {
       },
-      "group": {
-        "default": "asdf"
-      },
-      "groupId": "abc123"
+      "groupId": "42224125-5d7a-4961-b14b-5e0e8c3900d2",
+      "group": { "default": "Customized Group" }
     },
@@ -382,9 +381,6 @@ {
       },
-      "group": {
-        "default": "asdf",
-        "en-us": "asdfasdf"
-      },
-      "groupId": "abc123"
+      "groupId": "29216ff5-4acd-473c-b465-20a1ea6a2393",
+      "group": { "default": "Customized Group", "en-us": "group" }
     }
   ]
 }

lib/manifestSchemas/IClientSideWebPartManifest.d.ts

@@ -140,3 +140,3 @@ /**
      * Definition: The icon for the web part, 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).
+     *  URL must be exactly 40x28 px (SPPPLAT VSO#218660 to fix the size of the icon image).
      *  If the '{@link IClientSideWebPartManifestEntry.officeFabricIconFontName}' field does not have a value,
@@ -152,24 +152,20 @@ *  this field must have a 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.
+     * 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.
      * Required: yes
      * Localized: no
      * Supported values: any GUID
-     * Example: "dbef608d-3ad5-4f8f-b139-d916f2f0a294"
+     * Example: "cf066440-0614-43d6-98ae-0b31cf14c7c3"
      *
      * @beta
      */
-    groupId: string;
+    groupId: PredefinedGroup | string;
     /**
-     * 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.
+     * 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}.
      * Required: no
      * Localized: yes
      * Supported values: string
-     * Example: { "default": "Media Web Parts" }
+     * Example: { "default": "Media and Content" }
      *
@@ -207,1 +203,80 @@ * @beta
 }
+/**
+ * Predefined web part group.
+ *
+ * @beta
+ */
+export declare type PredefinedGroup = PredefinedGroup.TextMediaAndContent | PredefinedGroup.Discovery | PredefinedGroup.CommunicationAndCollaboration | PredefinedGroup.PlanningAndProcess | PredefinedGroup.BusinessAndIntelligence | PredefinedGroup.SiteTools | PredefinedGroup.Other;
+export declare namespace 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
+     * rich content.
+     *
+     * @beta
+     */
+    type TextMediaAndContent = 'cf066440-0614-43d6-98ae-0b31cf14c7c3';
+    /**
+     * Discovery.
+     *
+     * Corresponding classic page category name: Discovery
+     *
+     * This category includes web parts that organize, group, and filter content to help users discover information.
+     *
+     * @beta
+     */
+    type Discovery = '1edbd9a8-0bfb-4aa2-9afd-14b8c45dd489';
+    /**
+     * Communication and collaboration.
+     *
+     * Corresponding classic page category name: Social Collaboration
+     *
+     * This category includes web parts that facilitate information sharing, team work, and social interactions.
+     *
+     * @beta
+     */
+    type CommunicationAndCollaboration = '75e22ed5-fa14-4829-850a-c890608aca2d';
+    /**
+     * Planning and process.
+     *
+     * Corresponding classic page category name: Business Data
+     *
+     * 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';
+    /**
+     * Business and intelligence.
+     *
+     * Corresponding classic page category name: Business Data
+     *
+     * 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';
+    /**
+     * Site tools.
+     *
+     * Corresponding classic page category name: Site Tools
+     *
+     * This category includes web parts for site information and management.
+     *
+     * @beta
+     */
+    type SiteTools = '070951d7-94da-4db8-b06e-9d581f1f55b1';
+    /**
+     * Other.
+     *
+     * Corresponding classic page category name: Other
+     *
+     * This category includes web parts not in other categories.
+     *
+     * @beta
+     */
+    type Other = '5c03119e-3074-46fd-976b-c60198311f70';
+}

lib/manifestSchemas/ICommandSetExtensionManifest.d.ts

@@ -26,16 +26,2 @@ import { ILocalizedString } from './IClientSideComponentManifest';
     /**
-     * A table of commands defined by this command set. The object key is the Command ID.
-     *
-     * @remarks
-     *
-     * 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"
-     *
-     * @deprecated - Use items instead
-     */
-    commands?: {
-        [commandId: string]: ICommandDefinition;
-    };
-    /**
      * A table of items defined by this command set. The object key is the Item ID.
@@ -42,0 +28,0 @@ *

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

@@ -14,2 +14,49 @@ {
       }
+    },
+
+    "predefinedGroups": {
+      "oneOf": [
+        {
+          "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.",
+          "type": "string",
+          "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.",
+          "type": "string",
+          "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.",
+          "type": "string",
+          "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.",
+          "type": "string",
+          "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.",
+          "type": "string",
+          "pattern": "^4aca9e90-eff5-4fa1-bac7-728f5f157b66$"
+        },
+        {
+          "title": "Site tools",
+          "description": "This category includes web parts for site information and management.",
+          "type": "string",
+          "pattern": "^070951d7-94da-4db8-b06e-9d581f1f55b1$"
+        },
+        {
+          "title": "Other",
+          "description": "This category includes web parts not in other categories.",
+          "type": "string",
+          "pattern": "^5c03119e-3074-46fd-976b-c60198311f70$"
+        }
+      ]
     }
@@ -128,5 +175,15 @@ },
                 "title": "Group ID",
-                "description": "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.",
+                "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.",
                 "type": "string",
-                "minLength": 5
+                "anyOf":[
+                  {
+                    "title": "Predefined Group",
+                    "$ref": "#/definitions/predefinedGroups"
+                  },
+                  {
+                    "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.",
+                    "$ref": "guid.schema.json"
+                  }
+                ]
               },
@@ -136,3 +193,3 @@
                 "title": "Group",
-                "description": "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.",
+                "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.",
                 "$ref": "localized-string.schema.json"
@@ -139,0 +196,0 @@ },

lib/manifestSchemas/jsonSchemas/command-set-extension-manifest.schema.json

@@ -31,3 +31,3 @@ {
       },
-      "additionalProperties": true
+      "additionalProperties": false
     },
@@ -34,0 +34,0 @@ {

lib/manifestSchemaValidator.d.ts

@@ -12,3 +12,3 @@ export import ZSchema = require('z-schema');
     result: boolean;
-    errors: ZSchema.SchemaError[];
+    errors: ZSchema.SchemaErrorDetail[];
 }
@@ -23,5 +23,5 @@ export default class ManifestValidator {
     static validateManifest(manifest: string | IClientSideComponentManifest): IManifestValidatorResult;
-    static extractInnerErrorMessages(errors: ZSchema.SchemaError[]): string[];
-    static getFormattedErrorMessage(errors: ZSchema.SchemaError[]): string;
+    static extractInnerErrorMessages(errors: ZSchema.SchemaErrorDetail[]): string[];
+    static getFormattedErrorMessage(errors: ZSchema.SchemaErrorDetail[]): string;
     private static _validateManifest(manifest, schema);
 }

lib/manifestSchemaValidator.js

@@ -30,4 +30,3 @@ "use strict";
 var schemaValidator = new exports.ZSchema(exports.zSchemaOptions);
-// @todo 272561 - update the z-schema typings
-schemaValidator.validateSchema(schemas); // tslint:disable-line:no-any
+schemaValidator.validateSchema(schemas);
 var ManifestValidator = (function () {
@@ -45,4 +44,4 @@ function ManifestValidator() {
     };
-    /* tslint:disable:no-any */
-    ManifestValidator.validateWebPartManifest = function (manifest) {
+    ManifestValidator.validateWebPartManifest = function (manifest // tslint:disable-line:no-any
+    ) {
         return ManifestValidator._validateManifest(manifest, webPartSchema);
@@ -61,3 +60,2 @@ };
         var printZSchemaError = function (error) {
-            /* tslint:disable:no-any */
             var innerErrors = [];
@@ -67,3 +65,2 @@ (error.inner || []).forEach(function (innerErr) {
             });
-            /* tslint:enable:no-any */
             return ["(" + error.path + ") " + error.message].concat(innerErrors);
@@ -70,0 +67,0 @@ };

package.json

 {
   "name": "@microsoft/sp-module-interfaces",
-  "version": "1.2.0",
+  "version": "1.3.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.2.0",
+    "@microsoft/sp-build-node": "~1.3.0",
     "chai": "~3.5.0",
@@ -29,5 +29,5 @@ "@types/chai": "3.4.34",
     "@types/node": "6.0.64",
-    "z-schema": "~3.17.0",
-    "@types/z-schema": "3.16.20-alpha"
+    "z-schema": "~3.18.3",
+    "@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

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

2127906

increased by0.34%

Lines of code

7023

increased by1.83%

Dependency changes

• + Added@types/z-schema@3.16.31(transitive)

• + Addedlodash.isequal@4.5.0(transitive)

• + Addedvalidator@8.2.0(transitive)

• + Addedz-schema@3.18.4(transitive)

• - Removed@types/z-schema@3.16.20-alpha(transitive)

• - Removedajv@6.12.6(transitive)

• - Removedasn1@0.2.6(transitive)

• - Removedassert-plus@1.0.0(transitive)

• - Removedasynckit@0.4.0(transitive)

• - Removedaws-sign2@0.7.0(transitive)

• - Removedaws4@1.13.2(transitive)

• - Removedbcrypt-pbkdf@1.0.2(transitive)

• - Removedcaseless@0.12.0(transitive)

• - Removedcombined-stream@1.0.8(transitive)

• - Removedcore-util-is@1.0.2(transitive)

• - Removeddashdash@1.14.1(transitive)

• - Removeddelayed-stream@1.0.0(transitive)

• - Removedecc-jsbn@0.1.2(transitive)

• - Removedextend@3.0.2(transitive)

• - Removedextsprintf@1.3.0(transitive)

• - Removedfast-deep-equal@3.1.3(transitive)

• - Removedfast-json-stable-stringify@2.1.0(transitive)

• - Removedforever-agent@0.6.1(transitive)

• - Removedform-data@2.3.3(transitive)

• - Removedgetpass@0.1.7(transitive)

• - Removedhar-schema@2.0.0(transitive)

• - Removedhar-validator@5.1.5(transitive)

• - Removedhttp-signature@1.2.0(transitive)

• - Removedis-typedarray@1.0.0(transitive)

• - Removedisstream@0.1.2(transitive)

• - Removedjsbn@0.1.1(transitive)

• - Removedjson-schema@0.4.0(transitive)

• - Removedjson-schema-traverse@0.4.1(transitive)

• - Removedjson-stringify-safe@5.0.1(transitive)

• - Removedjsprim@1.4.2(transitive)

• - Removedmime-db@1.52.0(transitive)

• - Removedmime-types@2.1.35(transitive)

• - Removedoauth-sign@0.9.0(transitive)

• - Removedperformance-now@2.1.0(transitive)

• - Removedpsl@1.10.0(transitive)

• - Removedpunycode@2.3.1(transitive)

• - Removedqs@6.5.3(transitive)

• - Removedrequest@2.88.2(transitive)

• - Removedsafe-buffer@5.2.1(transitive)

• - Removedsafer-buffer@2.1.2(transitive)

• - Removedsshpk@1.18.0(transitive)

• - Removedtough-cookie@2.5.0(transitive)

• - Removedtunnel-agent@0.6.0(transitive)

• - Removedtweetnacl@0.14.5(transitive)

• - Removeduri-js@4.4.1(transitive)

• - Removeduuid@3.4.0(transitive)

• - Removedvalidator@5.7.0(transitive)

• - Removedverror@1.10.0(transitive)

• - Removedz-schema@3.17.0(transitive)

• Updated@types/z-schema@3.16.31

• Updatedz-schema@~3.18.3