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

Comparing version 0.3.0 to 0.4.0

CHANGELOG.md

 > ## Overview
-> When we release packages, we want to be able to quickly tell what changed and what kind of version bump to
-> make. Therefore, we need a smple way of tracking those changes.
->
 > We break changes into three categories (following [semver](http://semver.org/)), corresponding to the types of version
 >  bumps we may make:
 > - **`PATCH`** A patch change should be released when a backwards-compatible bugfix is made.
-> - **`MINOR`** A minor change should be released when functionality is added, but backwards-compatibility is
-                  maintained.
+> - **`MINOR`** A minor change should be released when functionality is added, but backwards-compatibility is maintained.
 > - **`MAJOR`** A major change should be released whenever backwards compatibility is broken.
@@ -23,2 +19,11 @@ >
 
+# Unreleased changes
+
+# 0.4.0
+
+  - `MINOR` Adds a field to WebPart manifest for disabling the WebPart on a Classic page
+  - `MINOR` IClientSideWebPartManifestInstance doesn't extend IClientSideWebPartManifestEntry anymore
+  - `MINOR` For manifests, the `id` field should be a GUID
+  - `PATCH` Updates standard library modules list to include `@microsoft/sp-webpart-base`
+
 # 0.3.0
@@ -25,0 +30,0 @@

lib/manifestSchemas/examples/application_1.manifest.js

@@ -5,3 +5,4 @@ "use strict";
     componentType: 'Application',
-    id: 'myApplicationId',
+    id: '00000000-0000-0000-0000-000000000000',
+    alias: 'myApplication',
     version: '0.0.1',
@@ -8,0 +9,0 @@ loaderConfig: {

lib/manifestSchemas/examples/application_2.manifest.js

@@ -5,3 +5,4 @@ "use strict";
     componentType: 'Application',
-    id: 'myApplicationId',
+    id: '00000000-0000-0000-0000-000000000000',
+    alias: 'myApplication',
     version: '0.0.1',
@@ -8,0 +9,0 @@ loaderConfig: {

lib/manifestSchemas/examples/application_3.manifest.js

@@ -5,3 +5,4 @@ "use strict";
     componentType: 'Application',
-    id: 'myApplicationId',
+    id: '00000000-0000-0000-0000-000000000000',
+    alias: 'myApplication',
     version: '0.0.1',
@@ -8,0 +9,0 @@ loaderConfig: {

lib/manifestSchemas/examples/application.manifest.json

@@ -6,3 +6,3 @@ {
   "componentType": "Application",
-  "id": "myApplicationId",
+  "id": "00000000-0000-0000-0000-000000000000",
   "version": "0.0.1",
@@ -9,0 +9,0 @@ "loaderConfig": {

lib/manifestSchemas/examples/library_1.manifest.js

@@ -5,3 +5,4 @@ "use strict";
     componentType: 'Library',
-    id: 'myLibraryId',
+    id: '00000000-0000-0000-0000-000000000000',
+    alias: 'myLibrary',
     version: '0.0.1',
@@ -8,0 +9,0 @@ loaderConfig: {

lib/manifestSchemas/examples/library.manifest.json

@@ -6,3 +6,3 @@ {
   "componentType": "Library",
-  "id": "myLibraryId",
+  "id": "00000000-0000-0000-0000-000000000000",
   "version": "0.0.1",
@@ -9,0 +9,0 @@ "loaderConfig": {

lib/manifestSchemas/examples/webpart_1.manifest.js

@@ -7,3 +7,4 @@ "use strict";
     componentType: 'WebPart',
-    id: 'myLibraryId',
+    id: '00000000-0000-0000-0000-000000000000',
+    alias: 'myWebPart',
     version: '0.0.1',
@@ -10,0 +11,0 @@ loaderConfig: {

lib/manifestSchemas/examples/webpart_2.manifest.js

@@ -7,3 +7,4 @@ "use strict";
     componentType: 'WebPart',
-    id: 'myLibraryId',
+    id: '00000000-0000-0000-0000-000000000000',
+    alias: 'myWebPart',
     version: '0.0.1',
@@ -10,0 +11,0 @@ loaderConfig: {

lib/manifestSchemas/examples/webpart.manifest.json

@@ -6,3 +6,3 @@ {
   "componentType": "WebPart",
-  "id": "myLibraryId",
+  "id": "00000000-0000-0000-0000-000000000000",
   "version": "0.0.1",
@@ -9,0 +9,0 @@ "loaderConfig": {

lib/manifestSchemas/IClientSideComponentManifest.d.ts

@@ -96,2 +96,27 @@ /**
     /**
+     * Definition: A short name usually given by developer. It does not need to be localized and is expected to stay
+     * the same through the lifetime of the component.
+     * Usage: A short name to identify a client side component by developer.
+     * Required: no
+     * Localized: no
+     * Supported values: Allowed characters are a-z, A-Z, and '-'. Not longer than 40 characters.
+     * Example: "NewFeed"
+     *
+     * @internalremarks - telemetry data is categorized based on alias. If alias changes, new telemetry date for this
+     * component will be put in a new category. It breaks history data if alias changes.
+     */
+    alias: string;
+    /**
+     * Definition: An auto-generated value for internal use. Do not add or use it.
+     * Usage: Not to be used by third party developers.
+     * Required: no
+     *
+     * @internal
+     *
+     * @internalremarks - this property indicates whether the component is first-party or third-party. IsInternal is true
+     * for first-party, false for third-party. The value is controlled by server side code. It is used when framework
+     * needs to differentiate between behaviors for first-party components and third-party, like in telemetry.
+     */
+    isInternal?: boolean;
+    /**
      * Definition: Client side component version. The value of this field is expected to be controlled by the developer
@@ -98,0 +123,0 @@ *  of the client side component. The purpose of this field is to help client side component developers upgrade their

lib/manifestSchemas/IClientSideWebPartManifest.d.ts

@@ -20,2 +20,11 @@ /**
     /**
+     * Definition: If true, this web part is disabled on Classic Sharepoint pages ?
+     * Usage: Certain web parts may not be required on or apply to Classic Sharepoint pages. This flag helps control
+     *  that. If this flag is true, the web part will not appear in the classic page web part gallery.
+     * Required: no
+     * Type: boolean
+     * Example: false
+     */
+    disabledOnClassicSharepoint?: boolean;
+    /**
      * Definition: A Web Part can have pre-configured properties like the title, description, toolbox group name and Web
@@ -52,3 +61,3 @@ *  Part specific custom properties. And there can be multiple instances of these pre-configured properties. This
  */
-export interface IClientSideWebPartManifestInstance<TProperties> extends IClientSideComponentManifest, IClientSideWebPartManifestSharedProperties, IClientSideWebPartManifestEntry<TProperties> {
+export interface IClientSideWebPartManifestInstance<TProperties> extends IClientSideComponentManifest, IClientSideWebPartManifestSharedProperties {
 }
@@ -55,0 +64,0 @@ /**

lib/manifestSchemas/jsonSchemas/clientSideApplicationManifestSchema.json

@@ -15,2 +15,3 @@ {
         "id": { "$ref": "anyValue.json" },
+        "alias": { "$ref": "anyValue.json" },
         "version": { "$ref": "anyValue.json" },
@@ -17,0 +18,0 @@ "loaderConfig": { "$ref": "anyValue.json" },

lib/manifestSchemas/jsonSchemas/clientSideComponentManifestSchema.json

@@ -38,6 +38,16 @@ {
           "description": "A universally unique component id. Each client side component is required to have this id. Once an id has been used for a component, it cannot be changed. A change in this value is treated same as the creation of a new component. Two components are never expected to have the same id.",
-          "minLength": 10,
-          "maxLength": 100
+          "minLength": 36,
+          "maxLength": 36,
+          "pattern": "^[a-z0-9]{8}(-([0-9a-f]){4}){3}-[a-z0-9]{12}$"
         },
 
+        "alias": {
+          "type": "string",
+          "title": "Alias",
+          "description": "A short name usually given by developer. It does not need to be localized and is expected to stay the same through the lifetime of the component.",
+          "maxLength": 40,
+          "pattern": "^[a-zA-Z0-9-]*$",
+          "minLength": 5
+        },
+
         "version": {
@@ -44,0 +54,0 @@ "$ref": "semver.json",

lib/manifestSchemas/jsonSchemas/clientSideLibraryManifestSchema.json

@@ -15,2 +15,3 @@ {
         "id": { "$ref": "anyValue.json" },
+        "alias": { "$ref": "anyValue.json" },
         "version": { "$ref": "anyValue.json" },
@@ -17,0 +18,0 @@ "loaderConfig": { "$ref": "anyValue.json" },

lib/manifestSchemas/jsonSchemas/clientSideWebPartManifestSchema.json

@@ -26,2 +26,3 @@ {
         "id": { "$ref": "anyValue.json" },
+        "alias": { "$ref": "anyValue.json" },
         "version": { "$ref": "anyValue.json" },
@@ -28,0 +29,0 @@ "loaderConfig": { "$ref": "anyValue.json" },

lib/standardLibraryModules.js

@@ -75,3 +75,3 @@ "use strict";
     },
-    '@ms/sp-webpart-base': {
+    '@microsoft/sp-webpart-base': {
         bundleReference: {
@@ -78,0 +78,0 @@ id: '974a7777-0990-4136-8fa6-95d80114c2e0'

package.json

 {
   "name": "@microsoft/sp-module-interfaces",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "SharePoint Framework module interfaces",
@@ -5,0 +5,0 @@ "license": "SEE LICENSE IN LICENSE.docx",

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

346813

increased by1.42%

Lines of code

4301

increased by1.22%

No dependency changes