@microsoft/sp-module-interfaces 1.22.1 → 1.23.0-beta.0

package/lib-commonjs/manifestSchemaValidator.js

@@ -26,36 +26,22 @@ function _interop_require_default(obj) {
     };
 }
 // Discover the schema files
+// use internal site-design-script-actions schema for validation instead of remote URL
+// as this schema is only used for Prefab, which is currently only internal. When we enable Prefab
+// for external use, we can switch back to the remote URL with appropriate changes.
 const schemasDirectory = `${__dirname}/manifestSchemas/jsonSchemas`;
 const schemaFiles = _nodecorelibrary.FileSystem.readFolderItemNames(schemasDirectory);
 const schemas = schemaFiles.map((schemaFile)=>require(`${schemasDirectory}/${schemaFile}`));
-const SITE_SCRIPTS_SCHEMA_URL = 'https://developer.microsoft.com/json-schemas/sp/site-design-script-actions.schema.json';
-const siteScriptsSchemaPromise = fetch(SITE_SCRIPTS_SCHEMA_URL).then((response)=>{
-    return response.text();
-}).catch((error)=>{
-    // eslint-disable-next-line no-console
-    console.error(`Failed to fetch remote schema: ${error}`);
-    // fallback to local copy
-    return JSON.stringify(_sitedesignscriptactionsschemajson.default);
-});
 const schemaValidator = new _ajv.default();
-siteScriptsSchemaPromise.then((remoteSchema)=>{
-    schemaValidator.addSchema(JSON.parse(remoteSchema), SITE_SCRIPTS_SCHEMA_URL);
-    schemas.forEach((schema, index)=>{
-        // Use the schema's id property as the key to avoid "schema id ignored" warnings
-        const schemaId = schema.id || `schema-${index}`;
-        schemaValidator.addSchema(schema, schemaId);
-    });
-}).catch((error)=>{
-// swallowing the error here
+schemaValidator.addSchema(_sitedesignscriptactionsschemajson.default, _sitedesignscriptactionsschemajson.default.$id);
+schemas.forEach((schema, index)=>{
+    // Use the schema's $id property as the key
+    const schemaId = schema.$id || `schema-${index}`;
+    schemaValidator.addSchema(schema, schemaId);
 });
 class ManifestValidator {
     static registerRemoteSchemaReferences() {
-        return siteScriptsSchemaPromise.then(()=>{
-        // no-op;
-        }).catch(()=>{
-        // no-op;
-        });
+        return Promise.resolve();
     }
     static validateApplicationManifest(manifest) {
         return ManifestValidator._validateManifest(manifest, _clientsideapplicationmanifestschemajson.default);
@@ -64,7 +50,26 @@ class ManifestValidator {
         return ManifestValidator._validateManifest(manifest, _prefabappmanifestschemajson.default);
     }
     static validateCommandSetManifest(manifest) {
-        return ManifestValidator._validateManifest(manifest, _commandsetextensionmanifestschemajson.default);
+        // First, run JSON Schema validation
+        const schemaValidationResult = ManifestValidator._validateManifest(manifest, _commandsetextensionmanifestschemajson.default);
+        // If schema validation failed, return early
+        if (!schemaValidationResult.result) {
+            return schemaValidationResult;
+        }
+        // Parse manifest if it's a string
+        const manifestObject = typeof manifest === 'string' ? JSON.parse(manifest) : manifest;
+        // Perform custom validation for command set specific rules
+        const customErrors = ManifestValidator._validateCommandSetHierarchy(manifestObject);
+        if (customErrors.length > 0) {
+            return {
+                result: false,
+                errors: [
+                    ...schemaValidationResult.errors,
+                    ...customErrors
+                ]
+            };
+        }
+        return schemaValidationResult;
     }
     static validateExtensionManifest(manifest) {
         return ManifestValidator._validateManifest(manifest, _clientsideextensionmanifestschemajson.default);
@@ -90,7 +95,7 @@ class ManifestValidator {
         const printAjvError = (error)=>{
             // AJV errors don't have nested inner errors
             // Each error is flat and represents a single validation failure
-            const path = error.dataPath || error.schemaPath || 'root';
+            const path = error.instancePath || error.schemaPath || 'root';
             const message = error.message || 'Validation error';
             return [
                 `(${path}) ${message}`
@@ -123,6 +128,101 @@ class ManifestValidator {
             errors: schemaValidator.errors || []
         };
     }
+    /**
+   * Validates command set hierarchy rules that cannot be expressed in JSON Schema:
+   * - Group references must point to existing items with type 'group'
+   * - Maximum nesting depth is 2 levels
+   * - No circular references in group hierarchy
+   */ static _validateCommandSetHierarchy(manifest) {
+        const errors = [];
+        const items = manifest.items;
+        if (!items) {
+            return errors;
+        }
+        const itemIds = Object.keys(items);
+        // Validate each item
+        for (const itemId of itemIds){
+            const item = items[itemId];
+            // Check if parent group exists and is a group
+            if (item.group) {
+                if (!items[item.group]) {
+                    errors.push({
+                        keyword: 'group-reference',
+                        instancePath: `/items/${itemId}/group`,
+                        schemaPath: '#/properties/items/patternProperties/group',
+                        params: {
+                            groupId: item.group
+                        },
+                        message: `Parent group '${item.group}' does not exist in manifest`
+                    });
+                } else if (items[item.group].type !== 'group') {
+                    errors.push({
+                        keyword: 'group-type',
+                        instancePath: `/items/${itemId}/group`,
+                        schemaPath: '#/properties/items/patternProperties/group',
+                        params: {
+                            groupId: item.group
+                        },
+                        message: `Parent '${item.group}' is not a group (type must be 'group')`
+                    });
+                }
+            }
+            // Check nesting depth and circular references for groups only
+            if (item.type === 'group') {
+                const visited = new Set();
+                const depth = ManifestValidator._getGroupDepth(itemId, items, visited);
+                if (depth === Infinity) {
+                    errors.push({
+                        keyword: 'circular-reference',
+                        instancePath: `/items/${itemId}`,
+                        schemaPath: '#/properties/items',
+                        params: {
+                            itemId
+                        },
+                        message: `Circular reference detected in group hierarchy for '${itemId}'`
+                    });
+                } else if (depth > 2) {
+                    errors.push({
+                        keyword: 'max-depth',
+                        instancePath: `/items/${itemId}`,
+                        schemaPath: '#/properties/items',
+                        params: {
+                            depth,
+                            itemId
+                        },
+                        message: `Group '${itemId}' has nesting depth ${depth}, which exceeds maximum of 2`
+                    });
+                }
+            }
+        }
+        return errors;
+    }
+    /**
+   * Calculates the depth of an item in the group hierarchy.
+   * Returns Infinity if a circular reference is detected.
+   */ static _getGroupDepth(itemId, items, visited) {
+        // Circular reference detection
+        if (visited.has(itemId)) {
+            return Infinity;
+        }
+        const item = items[itemId];
+        if (!item) {
+            return 0;
+        }
+        // If no parent group, depth is 1
+        if (!item.group) {
+            return 1;
+        }
+        // If parent doesn't exist, treat as depth 1
+        if (!items[item.group]) {
+            return 1;
+        }
+        // Mark as visited before recursing
+        visited.add(itemId);
+        // Recursively calculate parent's depth and add 1
+        const parentDepth = ManifestValidator._getGroupDepth(item.group, items, visited);
+        return parentDepth + 1;
+    }
 }
 
 //# sourceMappingURL=./manifestSchemaValidator.js.map

package/lib-commonjs/manifestSchemas/examples/commandSet_2.manifest.js

@@ -0,0 +1,59 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: function() {
+        return _default;
+    }
+});
+/**
+ * Example manifest with single-level groups.
+ * Commands are organized under a parent group.
+ */ const extensionManifest = {
+    manifestVersion: 2,
+    componentType: 'Extension',
+    id: '00000000-0000-0000-0000-000000000001',
+    alias: 'singleLevelGroupExtension',
+    version: '0.0.1',
+    extensionType: 'ListViewCommandSet',
+    items: {
+        EXPORT_GROUP: {
+            title: {
+                default: 'Export'
+            },
+            type: 'group',
+            iconImageUrl: 'icons/export.png'
+        },
+        EXPORT_PDF: {
+            title: {
+                default: 'Export to PDF'
+            },
+            type: 'command',
+            group: 'EXPORT_GROUP'
+        },
+        EXPORT_EXCEL: {
+            title: {
+                default: 'Export to Excel'
+            },
+            type: 'command',
+            group: 'EXPORT_GROUP'
+        }
+    },
+    loaderConfig: {
+        internalModuleBaseUrls: [
+            'https://cdn.net/'
+        ],
+        entryModuleId: 'main.bundle',
+        scriptResources: {
+            'main.bundle': {
+                type: 'path',
+                path: 'bundle.script.js'
+            }
+        }
+    }
+};
+const _default = extensionManifest;
+
+//# sourceMappingURL=./commandSet_2.manifest.js.map

package/lib-commonjs/manifestSchemas/examples/commandSet_3.manifest.js

@@ -0,0 +1,66 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: function() {
+        return _default;
+    }
+});
+/**
+ * Example manifest with nested groups (2 levels).
+ * Demonstrates a parent group containing a child group with commands.
+ */ const extensionManifest = {
+    manifestVersion: 2,
+    componentType: 'Extension',
+    id: '00000000-0000-0000-0000-000000000002',
+    alias: 'nestedGroupExtension',
+    version: '0.0.1',
+    extensionType: 'ListViewCommandSet',
+    items: {
+        TOOLS_GROUP: {
+            title: {
+                default: 'Tools'
+            },
+            type: 'group',
+            iconImageUrl: 'icons/tools.png'
+        },
+        ANALYSIS_GROUP: {
+            title: {
+                default: 'Analysis'
+            },
+            type: 'group',
+            group: 'TOOLS_GROUP'
+        },
+        RUN_ANALYSIS: {
+            title: {
+                default: 'Run Analysis'
+            },
+            type: 'command',
+            group: 'ANALYSIS_GROUP'
+        },
+        VIEW_REPORT: {
+            title: {
+                default: 'View Report'
+            },
+            type: 'command',
+            group: 'ANALYSIS_GROUP'
+        }
+    },
+    loaderConfig: {
+        internalModuleBaseUrls: [
+            'https://cdn.net/'
+        ],
+        entryModuleId: 'main.bundle',
+        scriptResources: {
+            'main.bundle': {
+                type: 'path',
+                path: 'bundle.script.js'
+            }
+        }
+    }
+};
+const _default = extensionManifest;
+
+//# sourceMappingURL=./commandSet_3.manifest.js.map

package/lib-commonjs/manifestSchemas/examples/commandSet_4.manifest.js

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: function() {
+        return _default;
+    }
+});
+/**
+ * Example manifest with mixed structure.
+ * Demonstrates top-level commands alongside grouped commands.
+ */ const extensionManifest = {
+    manifestVersion: 2,
+    componentType: 'Extension',
+    id: '00000000-0000-0000-0000-000000000003',
+    alias: 'mixedStructureExtension',
+    version: '0.0.1',
+    extensionType: 'ListViewCommandSet',
+    items: {
+        QUICK_VIEW: {
+            title: {
+                default: 'Quick View'
+            },
+            type: 'command',
+            iconImageUrl: 'icons/quickview.png'
+        },
+        SHARE_GROUP: {
+            title: {
+                default: 'Share'
+            },
+            type: 'group',
+            iconImageUrl: 'icons/share.png'
+        },
+        SHARE_EMAIL: {
+            title: {
+                default: 'Share via Email'
+            },
+            type: 'command',
+            group: 'SHARE_GROUP'
+        },
+        SHARE_LINK: {
+            title: {
+                default: 'Copy Link'
+            },
+            type: 'command',
+            group: 'SHARE_GROUP'
+        },
+        SETTINGS: {
+            title: {
+                default: 'Settings'
+            },
+            type: 'command',
+            iconImageUrl: 'icons/settings.png'
+        }
+    },
+    loaderConfig: {
+        internalModuleBaseUrls: [
+            'https://cdn.net/'
+        ],
+        entryModuleId: 'main.bundle',
+        scriptResources: {
+            'main.bundle': {
+                type: 'path',
+                path: 'bundle.script.js'
+            }
+        }
+    }
+};
+const _default = extensionManifest;
+
+//# sourceMappingURL=./commandSet_4.manifest.js.map

package/lib-commonjs/manifestSchemas/examples/commandSet_5.manifest.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: function() {
+        return _default;
+    }
+});
+/**
+ * Example manifest with an empty group (no children).
+ * Empty groups are valid at schema level - they simply won't render at runtime.
+ */ const extensionManifest = {
+    manifestVersion: 2,
+    componentType: 'Extension',
+    id: '00000000-0000-0000-0000-000000000004',
+    alias: 'emptyGroupExtension',
+    version: '0.0.1',
+    extensionType: 'ListViewCommandSet',
+    items: {
+        EMPTY_GROUP: {
+            title: {
+                default: 'Empty Group'
+            },
+            type: 'group'
+        },
+        STANDALONE_COMMAND: {
+            title: {
+                default: 'Standalone Command'
+            },
+            type: 'command',
+            iconImageUrl: 'icons/standalone.png'
+        }
+    },
+    loaderConfig: {
+        internalModuleBaseUrls: [
+            'https://cdn.net/'
+        ],
+        entryModuleId: 'main.bundle',
+        scriptResources: {
+            'main.bundle': {
+                type: 'path',
+                path: 'bundle.script.js'
+            }
+        }
+    }
+};
+const _default = extensionManifest;
+
+//# sourceMappingURL=./commandSet_5.manifest.js.map

package/lib-commonjs/manifestSchemas/jsonSchemas/adaptive-card-extension-manifest.schema.json

@@ -1,5 +1,5 @@
 {
-  "id": "adaptive-card-extension-manifest.schema.json",
+  "$id": "adaptive-card-extension-manifest.schema.json",
   "title": "Adaptive Card Extension manifest",
   "description": "All Adaptive Card Extension built on the SharePoint framework need a valid component manifest. This interface represents properties that are required by all types of BaseAdaptiveCardExtension. Adaptive Card Extension specific manifests will extend this interface to add properties required by that component type.",
   "definitions": {

package/lib-commonjs/manifestSchemas/jsonSchemas/any-value.schema.json

@@ -1,5 +1,5 @@
 {
-  "id": "any-value.schema.json",
+  "$id": "any-value.schema.json",
 
   "type": ["array", "boolean", "integer", "number", "object", "string"],
   "items": {

package/lib-commonjs/manifestSchemas/jsonSchemas/client-side-application-manifest.schema.json

@@ -1,5 +1,5 @@
 {
-  "id": "client-side-application-manifest.schema.json",
+  "$id": "client-side-application-manifest.schema.json",
   "title": "Client-side application manifest",
   "description": "A client-side application is the architectural component that manages the appearance and behavior of an entire web page.",
 

package/lib-commonjs/manifestSchemas/jsonSchemas/client-side-assembly-manifest.schema.json

@@ -1,5 +1,5 @@
 {
-  "id": "client-side-assembly-manifest.schema.json",
+  "$id": "client-side-assembly-manifest.schema.json",
   "title": "Client-side assembly manifest",
   "description": "A client-side assembly is a standalone-executable bundle containing a component, the loader, and all of their dependencies.",
 

package/lib-commonjs/manifestSchemas/jsonSchemas/client-side-component-loader-configuration.schema.json

@@ -1,11 +1,10 @@
 {
-  "id": "client-side-component-loader-configuration.schema.json",
+  "$id": "client-side-component-loader-configuration.schema.json",
   "title": "Client-side component manifest",
   "description": "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.",
 
   "definitions": {
     "moduleConfiguration": {
-      "id": "moduleConfiguration",
       "type": "object",
       "title": "Module Configuration",
       "description": "This is the base interface for a script module's definition.",

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

@@ -1,5 +1,5 @@
 {
-  "id": "client-side-component-manifest.schema.json",
+  "$id": "client-side-component-manifest.schema.json",
   "title": "Client-side component manifest",
   "description": "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.",
   "definitions": {

package/lib-commonjs/manifestSchemas/jsonSchemas/client-side-extension-manifest.schema.json

@@ -1,5 +1,5 @@
 {
-  "id": "client-side-extension-manifest.schema.json",
+  "$id": "client-side-extension-manifest.schema.json",
   "title": "Client-side extension manifest",
   "description": "A client-side extension is a plug-in component that customizes or augments the functionality of a client-side application.",
 

package/lib-commonjs/manifestSchemas/jsonSchemas/client-side-library-manifest.schema.json

@@ -1,5 +1,5 @@
 {
-  "id": "client-side-library-manifest.schema.json",
+  "$id": "client-side-library-manifest.schema.json",
   "title": "Client-side library manifest",
   "description": "A client-side library is a library containing reusable JavaScript code and/or resources.",
 

package/lib-commonjs/manifestSchemas/jsonSchemas/client-side-manifest-base.schema.json

@@ -1,5 +1,5 @@
 {
-  "id": "client-side-manifest-base.schema.json",
+  "$id": "client-side-manifest-base.schema.json",
   "title": "Client-side component manifest base",
   "description": "Properties common to all deployable manifests.",
 

package/lib-commonjs/manifestSchemas/jsonSchemas/client-side-multi-version-manifest.schema.json

@@ -1,5 +1,5 @@
 {
-  "id": "client-side-multi-version-manifest.schema.json",
+  "$id": "client-side-multi-version-manifest.schema.json",
   "title": "Client-side multi-version manifest",
   "description": "Multi-version manifests are defined by this schema.",
 

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

@@ -1,5 +1,5 @@
 {
-  "id": "client-side-web-part-manifest.schema.json",
+  "$id": "client-side-web-part-manifest.schema.json",
   "title": "Client-side webpart manifest",
   "description": "A client-side webpart is a drop-in control that is part of the end user page authoring experience.",
 

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

@@ -1,5 +1,5 @@
 {
-  "id": "command-set-extension-manifest.schema.json",
+  "$id": "command-set-extension-manifest.schema.json",
   "title": "Command set extension manifest",
   "description": "A client-side extension that defines a set of custom commands that can be shown in a menu, tool bar, etc.",
 
@@ -58,9 +58,9 @@
                 },
                 "type": {
                   "type": "string",
-                  "enum": ["command"],
+                  "enum": ["command", "group"],
                   "title": "Type",
-                  "description": "Type of the item. Currently only \"command\" is allowed."
+                  "description": "Type of the item. Use 'command' for executable commands, or 'group' for containers that organize commands into submenus."
                 },
                 "ariaLabel": {
                   "title": "ARIA Label",
@@ -72,6 +72,12 @@
                   "minLength": 1,
                   "title": "Icon Image URL",
                   "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."
+                },
+                "group": {
+                  "type": "string",
+                  "pattern": "^[A-Z0-9_]+$",
+                  "title": "Group",
+                  "description": "Optional ID of a parent group item this command/group belongs to. The parent must be defined in the same manifest with type 'group'. Maximum nesting depth is 2 levels."
                 }
               },
               "additionalProperties": false

package/lib-commonjs/manifestSchemas/jsonSchemas/component-fallback-version.schema.json

@@ -1,5 +1,5 @@
 {
-  "id": "component-fallback-version.schema.json",
+  "$id": "component-fallback-version.schema.json",
   "title": "Component Fallback Version",
   "description": "Represents a fallback version of a component that can be used under certain logical conditions, including flight and killswitch checks.",
   "type": "object",

package/lib-commonjs/manifestSchemas/jsonSchemas/guid.schema.json

@@ -1,5 +1,5 @@
 {
-  "id": "guid.schema.json",
+  "$id": "guid.schema.json",
 
   "type": "string",
   "minLength": 1,

package/lib-commonjs/manifestSchemas/jsonSchemas/localized-string.schema.json

@@ -1,5 +1,5 @@
 {
-  "id": "localized-string.schema.json",
+  "$id": "localized-string.schema.json",
 
   "type": "object",
   "oneOf": [

package/lib-commonjs/manifestSchemas/jsonSchemas/prefab-app-manifest.schema.json

@@ -1,5 +1,5 @@
 {
-  "id": "prefab-app-manifest.schema.json",
+  "$id": "prefab-app-manifest.schema.json",
   "title": "PREFAB application manifest",
   "description": "A PREFAB application is the architectural component that allows developers to declaratively specify behavior of a full page application.",
 
@@ -17,7 +17,7 @@
                 "enum": ["onInstall", "onDemand"]
               },
               "actions": {
-                "$ref": "https://developer.microsoft.com/json-schemas/sp/site-design-script-actions.schema.json#/properties/actions"
+                "$ref": "remote/site-design-script-actions.schema.json#/properties/actions"
               }
             },
             "required": ["type", "actions"],

package/lib-commonjs/manifestSchemas/jsonSchemas/semver.schema.json

@@ -1,5 +1,5 @@
 {
-  "id": "semver.schema.json",
+  "$id": "semver.schema.json",
 
   "type": "string",
   "minLength": 5,

package/lib-commonjs/manifestSchemas/remote/site-design-script-actions.schema.json

@@ -1,5 +1,6 @@
 {
   "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "remote/site-design-script-actions.schema.json",
   "title": "JSON Schema for SiteScript Extensions",
   "definitions": {
     "activateSPFeature": {
@@ -197,8 +198,7 @@
                 "$ref": "#/definitions/SPListSubactions/associateListViewCommandSet"
               }
             ]
-          },
-          "additionalItems": false
+          }
         }
       },
       "required": ["listName", "templateType", "verb"],
@@ -884,8 +884,7 @@
                 "$ref": "#/definitions/SPContentTypeSubactions/removeSiteColumn"
               }
             ]
-          },
-          "additionalItems": false
+          }
         }
       },
       "required": ["verb", "name", "hidden"],
@@ -1147,8 +1146,7 @@
             "$ref": "#/definitions/setFooterLogo"
           }
         ]
-      },
-      "additionalItems": false
+      }
     },
     "$schema": {
       "type": "string"