@microsoft/sp-module-interfaces 1.21.0-beta.0 → 1.21.0-beta.2

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

@@ -0,0 +1,39 @@
+{
+  "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.",
+
+  "type": "object",
+  "allOf": [
+    {
+      "type": "object",
+      "properties": {
+        "$schema": { "type": "string" },
+
+        "manifestVersion": { "$ref": "any-value.schema.json" },
+        "id": { "$ref": "any-value.schema.json" },
+        "alias": { "$ref": "any-value.schema.json" },
+        "version": { "$ref": "any-value.schema.json" },
+        "loaderConfig": { "$ref": "any-value.schema.json" },
+        "componentType": { "$ref": "any-value.schema.json" },
+        "preloadComponents": { "$ref": "any-value.schema.json" }
+      },
+      "additionalProperties": false
+    },
+    {
+      "$ref": "client-side-component-manifest.schema.json#/definitions/clientSideComponentManifest"
+    },
+    {
+      "type": "object",
+      "required": ["componentType"],
+      "properties": {
+        "componentType": {
+          "type": "string",
+          "enum": ["Library"]
+        }
+      },
+
+      "additionalProperties": true
+    }
+  ]
+}

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

@@ -0,0 +1,25 @@
+{
+  "id": "client-side-manifest-base.schema.json",
+  "title": "Client-side component manifest base",
+  "description": "Properties common to all deployable manifests.",
+
+  "type": "object",
+  "required": ["id", "manifestVersion"],
+
+  "properties": {
+    "manifestVersion": {
+      "type": "integer",
+      "title": "Manifest Version",
+      "description": "Version of the component manifest schema. The value of this field is controlled by Microsoft. The purpose of this field is to help manage upgrades of the component manifest schema. A component developer needs to only confirm that they are using the correct value per the manifest schema. Please read the \"manifest upgrade rules\" for more details on when the schema could change. Note, manifest schema version upgrade will be considered a big API change event and will be advertised broadly.",
+      "minimum": 2
+    },
+
+    "id": {
+      "$ref": "guid.schema.json",
+      "title": "ID",
+      "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."
+    }
+  },
+
+  "additionalProperties": true
+}

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

@@ -0,0 +1,118 @@
+{
+  "id": "client-side-multi-version-manifest.schema.json",
+  "title": "Client-side multi-version manifest",
+  "description": "Multi-version manifests are defined by this schema.",
+
+  "type": "object",
+  "allOf": [
+    {
+      "oneOf": [
+        {
+          "type": "object",
+          "required": ["versions"],
+          "additionalProperties": true,
+          "properties": {
+            "versions": {
+              "title": "Versions",
+              "description": "A mapping of version numbers to manifests. This field is used to roll all versions of a component together into a single manifest.",
+              "type": "object",
+              "patternProperties": {
+                "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$": {
+                  "$ref": "client-side-application-manifest.schema.json"
+                }
+              }
+            }
+          }
+        },
+        {
+          "type": "object",
+          "required": ["versions"],
+          "additionalProperties": true,
+          "properties": {
+            "versions": {
+              "title": "Versions",
+              "description": "A mapping of version numbers to manifests. This field is used to roll all versions of a component together into a single manifest.",
+              "type": "object",
+              "patternProperties": {
+                "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$": {
+                  "$ref": "client-side-assembly-manifest.schema.json"
+                }
+              }
+            }
+          }
+        },
+        {
+          "type": "object",
+          "required": ["versions"],
+          "additionalProperties": true,
+          "properties": {
+            "versions": {
+              "title": "Versions",
+              "description": "A mapping of version numbers to manifests. This field is used to roll all versions of a component together into a single manifest.",
+              "type": "object",
+              "patternProperties": {
+                "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$": {
+                  "$ref": "client-side-extension-manifest.schema.json"
+                }
+              }
+            }
+          }
+        },
+        {
+          "type": "object",
+          "required": ["versions"],
+          "additionalProperties": true,
+          "properties": {
+            "versions": {
+              "title": "Versions",
+              "description": "A mapping of version numbers to manifests. This field is used to roll all versions of a component together into a single manifest.",
+              "type": "object",
+              "patternProperties": {
+                "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$": {
+                  "$ref": "client-side-library-manifest.schema.json"
+                }
+              }
+            }
+          }
+        },
+        {
+          "type": "object",
+          "required": ["versions"],
+          "additionalProperties": true,
+          "properties": {
+            "versions": {
+              "title": "Versions",
+              "description": "A mapping of version numbers to manifests. This field is used to roll all versions of a component together into a single manifest.",
+              "type": "object",
+              "patternProperties": {
+                "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$": {
+                  "$ref": "client-side-web-part-manifest.schema.json"
+                }
+              }
+            }
+          }
+        },
+        {
+          "type": "object",
+          "required": ["versions"],
+          "additionalProperties": true,
+          "properties": {
+            "versions": {
+              "title": "Versions",
+              "description": "A mapping of version numbers to manifests. This field is used to roll all versions of a component together into a single manifest.",
+              "type": "object",
+              "patternProperties": {
+                "^(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)\\.(?:0|[1-9]\\d*)$": {
+                  "$ref": "command-set-extension-manifest.schema.json"
+                }
+              }
+            }
+          }
+        }
+      ]
+    },
+    {
+      "$ref": "client-side-manifest-base.schema.json"
+    }
+  ]
+}

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

@@ -0,0 +1,348 @@
+{
+  "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.",
+
+  "definitions": {
+    "propertyNamesArray": {
+      "type": "array",
+      "minItems": 0,
+      "items": {
+        "type": "string",
+        "minLength": 1
+      }
+    },
+
+    "predefinedGroups": {
+      "oneOf": [
+        {
+          "title": "Text, media, and content",
+          "description": "This group 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": "Documents, lists, and libraries",
+          "description": "This group includes web parts that organize, group, and filter content to help users discover information.",
+          "type": "string",
+          "pattern": "^1edbd9a8-0bfb-4aa2-9afd-14b8c45dd489$"
+        },
+        {
+          "title": "Feeds",
+          "description": "This group includes web parts that facilitate information sharing, team work, and social interactions.",
+          "type": "string",
+          "pattern": "^75e22ed5-fa14-4829-850a-c890608aca2d$"
+        },
+        {
+          "title": "News, people and events",
+          "description": "This group includes web parts that empower team productivity with the use of planning and process tools.",
+          "type": "string",
+          "pattern": "^1bc7927e-4a5e-4520-b540-71305c79c20a$"
+        },
+        {
+          "title": "Data Analysis",
+          "description": "This group includes web parts for tracking and analyzing data, and for integrating business flow with pages.",
+          "type": "string",
+          "pattern": "^4aca9e90-eff5-4fa1-bac7-728f5f157b66$"
+        },
+        {
+          "title": "Regional information",
+          "description": "This group includes web parts that display information based on current region and geographical location",
+          "type": "string",
+          "pattern": "^cfc8bda5-cb9b-49e3-8526-2ee6e52b256a$"
+        },
+        {
+          "title": "Advanced",
+          "description": "This group includes web parts not in other categories.",
+          "type": "string",
+          "pattern": "^5c03119e-3074-46fd-976b-c60198311f70$"
+        }
+      ]
+    }
+  },
+
+  "type": "object",
+  "allOf": [
+    {
+      "type": "object",
+      "properties": {
+        "$schema": { "type": "string" },
+
+        "manifestVersion": { "$ref": "any-value.schema.json" },
+        "id": { "$ref": "any-value.schema.json" },
+        "alias": { "$ref": "any-value.schema.json" },
+        "properties": { "$ref": "any-value.schema.json" },
+        "version": { "$ref": "any-value.schema.json" },
+        "loaderConfig": { "$ref": "any-value.schema.json" },
+        "preconfiguredEntries": { "$ref": "any-value.schema.json" },
+        "componentType": { "$ref": "any-value.schema.json" },
+        "searchablePropertyNames": { "$ref": "any-value.schema.json" },
+        "linkPropertyNames": { "$ref": "any-value.schema.json" },
+        "imageLinkPropertyNames": { "$ref": "any-value.schema.json" },
+        "preloadComponents": { "$ref": "any-value.schema.json" },
+        "requiredCapabilities": { "$ref": "any-value.schema.json" },
+        "requiresCustomScript": { "$ref": "any-value.schema.json" },
+        "safeWithCustomScriptDisabled": { "$ref": "any-value.schema.json" },
+        "loadLegacyFabricCss": { "$ref": "any-value.schema.json" },
+        "canUpdateConfiguration": {
+          "type": "boolean",
+          "title": "Can Update Configuration",
+          "description": "If set to \"true\", this web part uses the property pane to update the configuration of a web part."
+        },
+        "disabledOnClassicSharepoint": {
+          "type": "boolean",
+          "title": "Disabled On Classic Sharepoint",
+          "description": "If set to \"true\", this web part is disabled on Classic Sharepoint pages."
+        },
+        "experimentalData": {
+          "type": "object",
+          "title": "Experimental property bag",
+          "description": "Only use for properties not ready for production."
+        },
+        "hiddenFromToolbox": {
+          "type": "boolean",
+          "title": "Hidden from the modern SharePoint toolbox",
+          "description": "If set to \"true\", this web part will not be visible on the modern SharePoint toolbox."
+        },
+        "supportsFullBleed": {
+          "type": "boolean",
+          "title": "Supports full bleed display experience",
+          "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 needed for the \"WebPart\".",
+          "enum": ["None", "DOMIsolation", "DomainIsolation"]
+        },
+        "supportsThemeVariants": {
+          "type": "boolean",
+          "title": "Supports theme variants experience",
+          "description": "If set to \"true\", this web part supports and has been tested for the theme variants experience."
+        },
+        "useFallbackWhenPropertiesUpdatedExternally": {
+          "type": "boolean",
+          "title": "Use fallback when properties updated externally",
+          "description": "If true, the web part will be disposed and reloaded when the web part data is updated by an external source. If false, the web part data will be deserialized and the properties of the web part will be updated, onAfterPropertiesUpdatedExternally will be executed. If undefined, web parts developed with SPFx version below 1.9 will default to true and web parts developed with a SPFx version 1.9 or greater will default to false."
+        },
+        "supportedHosts": {
+          "description": "An array indicates the web part supports any of following hosts. If this property is missing the default is SharePointFullPage",
+          "type": "array",
+          "items": {
+            "type": "string",
+            "enum": [
+              "SharePointFullPage",
+              "SharePointWebPart",
+              "TeamsTab",
+              "TeamsPersonalApp",
+              "TeamsMeetingApp"
+            ]
+          }
+        },
+        "supportsSelfFramingInTeams": {
+          "type": "boolean",
+          "title": "Allow to iframe pages from the same SharePoint tenant (domain)",
+          "description": "If set to \"true\", this web part can have iframed pages from the same tenant (domain). The flag is only applicable to web parts that are hosted as Teams applications."
+        },
+        "flexibleLayoutSizing": {
+          "type": "object",
+          "title": "Flexible Layout Sizing Data",
+          "description": "Defines the default column width, row height, and dynamic resize support for the webpart when in a flexible layout.",
+          "properties": {
+            "supportsDynamicResizing": {
+              "type": "boolean",
+              "title": "Supports Dynamic Resizing",
+              "description": "If set to \"true\", this web part can resize to any width between minimum and total number of columns. Otherwise, it follows slot sizing logic."
+            },
+            "defaultColumnWidth": {
+              "type": "number",
+              "title": "Default Column Width",
+              "description": "The default width for the web part measured in number of flexible layout columns"
+            },
+            "defaultRowHeight": {
+              "type": "number",
+              "title": "Default Row Height",
+              "description": "The default height for the web part measured in number of flexible layout rows."
+            }
+          },
+          "additionalProperties": false
+        }
+      },
+      "additionalProperties": false
+    },
+    {
+      "$ref": "client-side-component-manifest.schema.json#/definitions/clientSideComponentManifest"
+    },
+    {
+      "type": "object",
+      "required": ["preconfiguredEntries", "componentType"],
+      "properties": {
+        "componentType": {
+          "type": "string",
+          "enum": ["WebPart"]
+        },
+
+        "searchablePropertyNames": {
+          "title": "Searchable Property Names",
+          "description": "List of names of Web Part properties that need to be indexed for search.",
+          "$ref": "#/definitions/propertyNamesArray"
+        },
+
+        "linkPropertyNames": {
+          "title": "Link Property Names",
+          "description": "(Deprecated) Please use Web Part propertiesMetadata field instead.",
+          "$ref": "#/definitions/propertyNamesArray"
+        },
+
+        "imageLinkPropertyNames": {
+          "title": "Image Link Property Names",
+          "description": "(Deprecated) Please use Web Part propertiesMetadata field instead.",
+          "$ref": "#/definitions/propertyNamesArray"
+        },
+
+        "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": {
+          "title": "Pre-configured Entries",
+          "description": "A Web Part can have pre-configured properties like the title, description, toolbox group name and Web Part specific custom properties.",
+          "type": "array",
+          "minItems": 1,
+          "items": {
+            "description": "This interface specifies the set of properties that can be pre-configured by a Web Part developer. Each pre-configured instance of the Web Part will need a copy of these properties. Organization admins and content authors can modify these properties on a need basis.",
+            "type": "object",
+
+            "properties": {
+              "title": {
+                "title": "Title",
+                "description": "Title of the web part represented as a single a dictionary of locale keys to title values. This value will be displayed to the user in the toolbox. A dictionary must contain a \"default\" key. This title should be used in the Toolbox and other display areas. The Web Part developer may give an initial title to the webpart. The organization admin and page author will have the ability to change this title as per need.",
+                "$ref": "localized-string.schema.json"
+              },
+
+              "description": {
+                "title": "Description",
+                "description": "Description of the web part represented as a dictionary of locale keys to description values. This value will be displayed to the user in the toolbox. A dictionary must contain a 'default' key. This description should be used in the Toolbox tooltip and other display areas. The Web Part developer may give an initial description to the webpart. The organization admin and page author will have the ability to change this description as per need.",
+                "$ref": "localized-string.schema.json"
+              },
+
+              "officeFabricIconFontName": {
+                "title": "Office Fabric Icon Name",
+                "description": " The icon for the Web Part, to be displayed in the toolbox, represented as a character name in the Office 365 icon font file. The icon font is specified here: https://aka.ms/uifabric-icons. If this field has a value, the 'iconImageUrl' field will be ignored.",
+                "type": "string",
+                "minLength": 1
+              },
+
+              "iconImageUrl": {
+                "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. If the 'officeFabricIconName' field does not have a value, this field must have a value.",
+                "type": "string",
+                "minLength": 10
+              },
+
+              "fullPageAppIconImageUrl": {
+                "title": "App Page Icon Image URL",
+                "description": "The icon for the Application pages, to be displayed in the new Page experience, represented an image URL. The image at the URL should be approximately 195x110 px. If this field is not defined then the iconimageUrl is used instead.",
+                "type": "string",
+                "minLength": 10
+              },
+
+              "groupId": {
+                "title": "Group ID",
+                "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",
+                "anyOf": [
+                  {
+                    "title": "Predefined Group",
+                    "$ref": "#/definitions/predefinedGroups"
+                  },
+                  {
+                    "description": "If the group ID is not from the predefined group list, the web part will go to Other group.",
+                    "$ref": "guid.schema.json"
+                  }
+                ]
+              },
+
+              "group": {
+                "title": "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"
+              },
+
+              "tags": {
+                "title": "Tags",
+                "description": "This field is used to tag a web part with keywords that are different from the web part group name. Tags can be used for categorization and searching of web parts. For example, in the web part toolbox.",
+                "type": "array",
+                "maxItems": 10,
+                "items": {
+                  "$ref": "localized-string.schema.json"
+                }
+              },
+
+              "properties": {
+                "title": "Properties",
+                "description": "Every Web Part is expected to have some custom properties. e.g. an image Web Part may have the image url and caption text as custom properties, a list Web Part may have the list id and list title as custom properties, and so on.",
+                "$ref": "any-value.schema.json"
+              },
+
+              "dataVersion": {
+                "title": "Data Version",
+                "description": "Set a data version for this preconfigured entry. This is optional and can be used in cases where the SPPKG is updated independently from code (e.g. hosted on a CDN). Web Parts can read this value for backwards compatibility with out of date default properties.",
+                "$ref": "any-value.schema.json"
+              }
+            },
+
+            "anyOf": [
+              {
+                "required": ["title", "description", "officeFabricIconFontName", "groupId", "properties"]
+              },
+              {
+                "required": ["title", "description", "iconImageUrl", "groupId", "properties"]
+              },
+              {
+                "required": ["title", "description", "fullPageAppIconImageUrl", "groupId", "properties"]
+              }
+            ],
+
+            "additionalProperties": false
+          }
+        },
+
+        "propertiesMetadata": {
+          "additionalProperties": false,
+          "type": "object",
+          "required": ["current"],
+          "properties": {
+            "current": {
+              "type": "object",
+              "additionalProperties": true
+            }
+          }
+        },
+        "jsonSchema": {
+          "additionalProperties": true,
+          "type": "object"
+        }
+      },
+
+      "additionalProperties": true
+    }
+  ]
+}

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

@@ -0,0 +1,81 @@
+{
+  "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.",
+
+  "type": "object",
+  "allOf": [
+    {
+      "type": "object",
+      "properties": {
+        "$schema": { "type": "string" },
+
+        "manifestVersion": { "$ref": "any-value.schema.json" },
+        "id": { "$ref": "any-value.schema.json" },
+        "alias": { "$ref": "any-value.schema.json" },
+        "version": { "$ref": "any-value.schema.json" },
+        "loaderConfig": { "$ref": "any-value.schema.json" },
+        "componentType": { "$ref": "any-value.schema.json" },
+        "preloadComponents": { "$ref": "any-value.schema.json" },
+        "requiresCustomScript": { "$ref": "any-value.schema.json" },
+        "safeWithCustomScriptDisabled": { "$ref": "any-value.schema.json" },
+        "extensionType": {
+          "title": "Client-side Extension Type",
+          "description": "For a command set, the extension type must be one of these values: ListViewCommandSet",
+          "type": "string",
+          "enum": ["ListViewCommandSet"]
+        },
+        "items": { "$ref": "any-value.schema.json" }
+      },
+      "additionalProperties": false
+    },
+    {
+      "$ref": "client-side-component-manifest.schema.json#/definitions/clientSideComponentManifest"
+    },
+    {
+      "$ref": "client-side-extension-manifest.schema.json#/definitions/clientSideExtensionManifest"
+    },
+    {
+      "type": "object",
+      "required": ["items"],
+      "properties": {
+        "items": {
+          "type": "object",
+          "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": {
+            "^[A-Z0-9_]+$": {
+              "type": "object",
+              "required": ["title", "type"],
+              "properties": {
+                "title": {
+                  "title": "Title",
+                  "description": "A short label to be displayed by the associated button, menu item, etc. Example: \"Show information\"",
+                  "$ref": "localized-string.schema.json"
+                },
+                "type": {
+                  "type": "string",
+                  "enum": ["command"],
+                  "title": "Type",
+                  "description": "Type of the item. Currently only \"command\" is allowed."
+                },
+                "ariaLabel": {
+                  "title": "ARIA Label",
+                  "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"
+                },
+                "iconImageUrl": {
+                  "type": "string",
+                  "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."
+                }
+              },
+              "additionalProperties": false
+            }
+          }
+        }
+      },
+      "additionalProperties": true
+    }
+  ]
+}

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

@@ -0,0 +1,6 @@
+{
+  "id": "guid.schema.json",
+
+  "type": "string",
+  "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"
+}

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

@@ -0,0 +1,33 @@
+{
+  "id": "localized-string.schema.json",
+
+  "type": "object",
+  "oneOf": [
+    {
+      "required": ["default"]
+    },
+    {
+      "required": ["id"]
+    }
+  ],
+  "properties": {
+    "default": {
+      "title": "Default string",
+      "description": "String to be used if a locale doesn't exist",
+      "type": "string",
+      "minLength": 1
+    },
+    "id": {
+      "title": "Id for the localized string",
+      "description": "Id for the localized string in the form '$<moduleName>:<expression>;'",
+      "type": "string",
+      "minLength": 1,
+      "pattern": "^\\$[^:]+:.+;$"
+    }
+  },
+  "additionalProperties": {
+    "title": "Localized string",
+    "type": "string",
+    "minLength": 1
+  }
+}