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

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

@@ -0,0 +1,138 @@
+{
+  "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.",
+
+  "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" },
+        "preloadOptions": { "$ref": "any-value.schema.json" },
+        "title": { "$ref": "any-value.schema.json" },
+        "description": { "$ref": "any-value.schema.json" },
+        "preloadComponents": { "$ref": "any-value.schema.json" },
+        "assemblyId": { "$ref": "any-value.schema.json" },
+        "safeWithCustomScriptDisabled": { "$ref": "any-value.schema.json" },
+        "requiresCustomScript": { "$ref": "any-value.schema.json" },
+        "hasSuiteNav": { "$ref": "any-value.schema.json" },
+        "experimentalData": {
+          "type": "object",
+          "title": "Experimental property bag",
+          "description": "Only use for properties not ready for production."
+        }
+      },
+      "additionalProperties": false
+    },
+    {
+      "$ref": "client-side-component-manifest.schema.json#/definitions/clientSideComponentManifest"
+    },
+    {
+      "type": "object",
+      "required": ["preloadOptions", "componentType", "title", "description"],
+      "properties": {
+        "componentType": {
+          "type": "string",
+          "enum": ["Application"]
+        },
+
+        "preloadOptions": {
+          "title": "Preload Options",
+          "description": "Represents flags to preload information in host aspx page.",
+          "type": "object",
+          "properties": {
+            "shouldPreloadWeb": {
+              "title": "Should Preload Web",
+              "description": "A value indicating whether or not to preload the web object when loading the application page. If not present, defaults to false.",
+              "type": "boolean"
+            },
+
+            "shouldPreloadUser": {
+              "title": "Should Preload User",
+              "description": "A value indicating whether or not to preload the user object when loading the application page. If not present, defaults to false.",
+              "type": "boolean"
+            },
+
+            "shouldPreloadList": {
+              "title": "Should Preload List",
+              "description": "A value indicating whether or not to preload the list object when loading the application page. If not present, defaults to false.",
+              "type": "boolean"
+            },
+
+            "shouldPreloadItem": {
+              "title": "Should Preload List Item",
+              "description": "A value indicating whether or not to preload the list item object when loading the application page. If not present, defaults to false.",
+              "type": "boolean"
+            },
+
+            "shouldPreloadQuickLaunch": {
+              "title": "Should Preload Quick Launch",
+              "description": "A value indicating whether or not to preload the quick launch navigation menu items when loading the application page. If not present, defaults to false.",
+              "type": "boolean"
+            },
+
+            "preloadListItemQueryOption": {
+              "title": "Preload List Item Query Options",
+              "description": "This specifies an optional OData query expression with the syntax that would be used in the URL query parameter for a REST API call that fetches a SharePoint list item.",
+              "type": "string"
+            },
+
+            "preloadListItemQueryOptionOverride": {
+              "title": "Preload List Item Query Options (flighted)",
+              "description": "This specifies an optional OData query expression with the syntax that would be used in the URL query parameter for a REST API call that fetches a SharePoint list item.",
+              "type": "string"
+            },
+
+            "preloadListItemProperties": {
+              "title": "Preload List Item Properties",
+              "description": "This specifies what to fetch from a SharePoint list item Properties property.",
+              "type": "array",
+              "uniqueItems": true,
+              "minItems": 0,
+              "items": {
+                "type": "string",
+                "minLength": 0
+              }
+            }
+          },
+
+          "additionalProperties": false
+        },
+
+        "title": {
+          "title": "Title",
+          "description": "Title of the application as a dictionary of locale keys to title values. This value will be displayed to the user in the (page creation) interface. A dictionary must contain a \"default\" key.",
+          "$ref": "localized-string.schema.json"
+        },
+
+        "description": {
+          "title": "Description",
+          "description": "Description of the application represented as a dictionary of locale keys to description values. This value will be displayed to the user in the (page creation) interface. A dictionary must contain a \"default\" key.",
+          "$ref": "localized-string.schema.json"
+        },
+
+        "assemblyId": {
+          "title": "Assembly id",
+          "description": "Id of the preferred assembly to use to load the application. If no assembly id is provided SPFx will be loaded with the default assembly.",
+          "$ref": "guid.schema.json"
+        },
+        "hasSuiteNav": {
+          "title": "Has suite nav",
+          "description": "True if the application has a suite nav.",
+          "type": "boolean"
+        }
+      },
+
+      "additionalProperties": true
+    }
+  ]
+}

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

@@ -0,0 +1,45 @@
+{
+  "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.",
+
+  "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" },
+        "rootComponentId": { "$ref": "any-value.schema.json" }
+      },
+      "additionalProperties": false
+    },
+    {
+      "$ref": "client-side-component-manifest.schema.json#/definitions/clientSideComponentManifest"
+    },
+    {
+      "type": "object",
+      "required": ["componentType", "rootComponentId"],
+      "properties": {
+        "componentType": {
+          "type": "string",
+          "enum": ["Library"]
+        },
+
+        "rootComponentId": {
+          "$ref": "guid.schema.json",
+          "title": "ID",
+          "description": "The ID of the component from which the assembly is built."
+        }
+      },
+
+      "additionalProperties": true
+    }
+  ]
+}

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

@@ -0,0 +1,273 @@
+{
+  "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.",
+
+      "required": ["type"],
+      "properties": {
+        "type": {
+          "type": "string",
+          "enum": ["component", "path", "localizedPath"]
+        },
+
+        "shouldNotPreload": {
+          "type": "boolean",
+          "title": "Should Not Preload",
+          "description": "If set to \"true\", this module should not be preloaded when loading the component."
+        }
+      },
+
+      "additionalProperties": true
+    },
+
+    "path": {
+      "oneOf": [
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["path"],
+          "properties": {
+            "path": {
+              "type": "string",
+              "title": "Path",
+              "description": "The path to the resource."
+            },
+            "integrity": {
+              "type": "string",
+              "title": "Integrity",
+              "description": "The subresource integrity hash of the resource referenced in \"path\"."
+            }
+          }
+        },
+        {
+          "type": "string"
+        }
+      ]
+    }
+  },
+
+  "oneOf": [
+    {
+      "type": "object",
+      "required": ["internalModuleBaseUrls"],
+      "properties": {
+        "internalModuleBaseUrls": {
+          "type": "array",
+          "title": "Internal Module Base URLs",
+          "description": "This is an array of fully-qualified paths to be prepended to each of the script resource paths with the \"internal\" or \"localized\" type. If one fails to load, the loader will attempt to load from the next until there are no base paths remaining. All \"internal\" and \"localized\" script resources that do not have fully-qualified URLs as their \"path\" field values must be hosted under each of the paths listed in this property.",
+          "minItems": 1,
+          "items": {
+            "type": "string",
+            "minLength": 10
+          }
+        },
+
+        "entryModuleId": {
+          "type": "string",
+          "title": "Entry Module ID",
+          "description": "This is the ID of one of the entries in the \"scriptResources\" dictionary. The loader will download and evaluate the script resource referenced in this field, resolve all dependencies against the keys in the \"scriptResources\", and return the exported object to the loader's calling function. The entry referenced in the \"scriptResources\" dictionary must be of the \"internal\" or the \"localized\" type.",
+          "minLength": 1,
+          "maxLength": 100
+        },
+
+        "exportName": {
+          "type": "string",
+          "title": "Export Name",
+          "description": "This value points to a top-level field from the entryModuleId module's export. If this parameter is set, the field referenced in the entryModuleId module's export is returned by the module loader when this manifest is loaded, instead of the top-level export.",
+          "minLength": 1,
+          "maxLength": 100
+        },
+
+        "scriptResources": {
+          "type": "object",
+          "title": "Script Resources",
+          "description": "This is a dictionary of named script resources. \"internal\" and \"localized\" modules may reference each other and \"framework\" modules are expected to be provided by the framework runtime. The resource named in the \"entryModuleId\" must contain the component's exported object.",
+          "minProperties": 1,
+          "patternProperties": {
+            ".{1,}": {
+              "oneOf": [
+                {
+                  "title": "Framework Module Configuration",
+                  "description": "This is the interface for a script module with the \"framework\" type. Modules of this type will be provided by the framework runtime. The key in the \"scriptResources\" dictionary must be the name of a standard framework library.",
+                  "type": "object",
+                  "allOf": [
+                    {
+                      "type": "object",
+                      "properties": {
+                        "type": { "$ref": "any-value.schema.json" },
+                        "shouldNotPreload": { "$ref": "any-value.schema.json" },
+                        "version": { "$ref": "any-value.schema.json" },
+                        "id": { "$ref": "any-value.schema.json" },
+                        "failoverPath": { "$ref": "any-value.schema.json" }
+                      },
+                      "additionalProperties": false
+                    },
+                    {
+                      "$ref": "#/definitions/moduleConfiguration"
+                    },
+                    {
+                      "type": "object",
+                      "required": ["type", "version", "id"],
+                      "properties": {
+                        "type": {
+                          "type": "string",
+                          "enum": ["component"]
+                        },
+
+                        "version": {
+                          "title": "Version",
+                          "description": "The version of the framework-supplied component to be loaded. For framework runtime component such as \"@microsoft/sp-client-base,\" it is recommended the version of the framework component the component was developed against be specified.",
+                          "oneOf": [
+                            {
+                              "$ref": "semver.schema.json"
+                            },
+                            {
+                              "type": "string",
+                              "enum": ["latest"]
+                            }
+                          ]
+                        },
+
+                        "id": {
+                          "title": "ID",
+                          "description": "The ID of the framework-supplied component to be loaded.",
+                          "$ref": "guid.schema.json"
+                        },
+
+                        "failoverPath": {
+                          "title": "Failover Path",
+                          "description": "A path to the framework-supplied module in case the framework fails to load the requested version. This must be either a fully-qualified URL, or a path under the paths specified in the \"internalModuleBaseUrls\" field. If this field is not specified and the version is not available in the framework runtime, the closest matching version of the module will be provided instead.",
+                          "$ref": "#/definitions/path"
+                        }
+                      },
+                      "additionalProperties": true
+                    }
+                  ]
+                },
+
+                {
+                  "title": "Internal Module Configuration",
+                  "description": "This is the interface for a script module with the \"internal\" type. Modules of this type must be provided by the component developer.",
+                  "type": "object",
+                  "allOf": [
+                    {
+                      "type": "object",
+                      "properties": {
+                        "type": { "$ref": "any-value.schema.json" },
+                        "shouldNotPreload": { "$ref": "any-value.schema.json" },
+                        "path": { "$ref": "any-value.schema.json" },
+                        "globalName": { "$ref": "any-value.schema.json" },
+                        "globalDependencies": { "$ref": "any-value.schema.json" }
+                      },
+                      "additionalProperties": false
+                    },
+                    {
+                      "$ref": "#/definitions/moduleConfiguration"
+                    },
+                    {
+                      "type": "object",
+                      "required": ["type", "path"],
+                      "properties": {
+                        "type": {
+                          "type": "string",
+                          "enum": ["path"]
+                        },
+
+                        "path": {
+                          "title": "Path",
+                          "description": "A path to this module's javascript resource either as a fully-qualified URL or as a path under the paths provided in the \"internalModuleBaseUrls\" field.",
+                          "$ref": "#/definitions/path"
+                        },
+
+                        "globalName": {
+                          "title": "Global Name",
+                          "description": "In order to load scripts that don't follow the AMD/module-pattern where \"define\" or \"require\" is called and dependencies are explicitly listed and exports are explicitly returned, the module loader needs to know which global variable must be examined. If this property is specified, this module is considered non-AMD and the module loader will not expect \"define\" or \"require\" to be called. Instead, it will wait for the script to finish loading and examine the global variable specified in this field.",
+                          "type": "string",
+                          "minLength": 1
+                        },
+
+                        "globalDependencies": {
+                          "title": "Global Dependencies",
+                          "description": "For non-AMD/module-pattern scripts that have dependencies (for example, jQuery plugins), the module loader will ensure that those dependencies are already loaded. Entries in the array specified in this field must refer to other non-AMD modules in this component. This field is not required to have a value for non-AMD modules. If any values are specified that do not refer to other modules in the same component manifest that this module is specified, the module loader will throw an exception and the component will fail to load.",
+                          "type": "array",
+                          "minItems": 1,
+                          "items": {
+                            "type": "string",
+                            "minLength": 1
+                          }
+                        }
+                      },
+                      "additionalProperties": true
+                    }
+                  ]
+                },
+
+                {
+                  "title": "Localized Internal Module Configuration",
+                  "description": "This is the interface for a script module with the \"localized\" type. Modules of this type must be provided by the component developer. These script resources are similar to those of the \"internal\" type, but they may be present at a number of different paths, to be selected by the user's locale. Paths in this module type are loaded exactly the same way as \"internal\" modules are.",
+                  "type": "object",
+                  "allOf": [
+                    {
+                      "type": "object",
+                      "properties": {
+                        "type": { "$ref": "any-value.schema.json" },
+                        "shouldNotPreload": { "$ref": "any-value.schema.json" },
+                        "defaultPath": { "$ref": "any-value.schema.json" },
+                        "paths": { "$ref": "any-value.schema.json" }
+                      },
+                      "additionalProperties": false
+                    },
+                    {
+                      "$ref": "#/definitions/moduleConfiguration"
+                    },
+                    {
+                      "type": "object",
+                      "required": ["type", "defaultPath"],
+                      "properties": {
+                        "type": {
+                          "type": "string",
+                          "enum": ["localizedPath"]
+                        },
+
+                        "defaultPath": {
+                          "title": "Default Path",
+                          "description": "A path to this module's default locale javascript resource either as a fully-qualified URL or as a path under the paths provided in the \"internalModuleBaseUrls\" field. If the user's locale does not resolve to one of the paths specified in the \"paths\" field, the path in this field is used. Paths in this module type are treated exactly the same way paths in modules of the \"internal\" type are treated.",
+                          "$ref": "#/definitions/path"
+                        },
+
+                        "paths": {
+                          "title": "Paths",
+                          "description": "This is a dictionary of locale keys (in the \"ll-cc\" format) to paths to this module's locale javascript resource either as a fully-qualified URL or as a path under the paths provided in the \"internalModuleBaseUrls\" field. The loader will attempt to resolve the user's locale to one of the paths provided by this field, and will load the script resource under that path. If the user's locale does not resolve to one of the paths specified in this field, the path in \"defaultPath\" field is used.",
+                          "type": "object",
+                          "patternProperties": {
+                            ".+": {
+                              "$ref": "#/definitions/path"
+                            }
+                          }
+                        }
+                      },
+                      "additionalProperties": true
+                    }
+                  ]
+                }
+              ]
+            }
+          },
+          "additionalProperties": false
+        }
+      },
+
+      "additionalProperties": false
+    },
+    {
+      "type": "null"
+    }
+  ]
+}

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

@@ -0,0 +1,131 @@
+{
+  "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": {
+    "clientSideComponentManifest": {
+      "type": "object",
+      "allOf": [
+        {
+          "type": "object",
+          "required": ["componentType", "alias", "version"],
+
+          "not": {
+            "description": "If both properties are missing, this succeeds since it BOTH schemas are NOT matched. If only one property exists, this succeeds since BOTH schemas are NOT matched. If both properties are specified, this fails since BOTH schemas ARE matched",
+            "type": "object",
+            "allOf": [
+              {
+                "type": "object",
+                "additionalProperties": true,
+                "required": ["requiresCustomScript"],
+                "properties": {
+                  "requiresCustomScript": { "type": "boolean" }
+                }
+              },
+              {
+                "type": "object",
+                "additionalProperties": true,
+                "required": ["safeWithCustomScriptDisabled"],
+                "properties": {
+                  "safeWithCustomScriptDisabled": { "type": "boolean" }
+                }
+              }
+            ]
+          },
+
+          "properties": {
+            "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
+            },
+
+            "componentType": {
+              "type": "string",
+              "title": "Component Type",
+              "description": "Type of client side component (\"Application\", \"Prefab\", \"Extension\", \"Library\", \"WebPart\", or \"AdaptiveCardExtension\"). Components with the \"Application\" type are defined by the \"IClientSideApplicationManifest\" interface; components with the \"WebPart\" type are defined by the \"IClientSideWebPartManifest\" interface; and so forth.",
+              "enum": ["Application", "WebPart", "Library", "Extension", "AdaptiveCardExtension", "Prefab"]
+            },
+
+            "loadLegacyFabricCss": {
+              "type": "boolean",
+              "title": "Load Legacy Fabric CSS",
+              "description": "Indicates whether to use the legacy Fabric CSS load sequence. Components after 1.1 can leave this false, unless there are visual regressions after updating your SPFx version."
+            },
+
+            "properties": {
+              "type": "object",
+              "title": "Properties",
+              "description": "Property bag for the component manifest."
+            },
+
+            "version": {
+              "title": "Version",
+              "description": "Client side component version. The value of this field is expected to be controlled by the developer of the client side component. The purpose of this field is to help client side component developers upgrade their client side components in a managed way. This helps the consumers of the client side component make decisions about when and how to upgrade the client side component. As the developer evolves the code for their client side component, they can decide to bump the MAJOR, MINOR or PATCH version of the component. All incompatible API changes should result in a MAJOR version bump. Backwards compatible functionality changes should result in a MINOR version bump, and backwards compatible bug fixes should result in a PATCH version bump. Please see http://semver.org for more details on how to manage the version of your components.",
+              "oneOf": [
+                {
+                  "$ref": "semver.schema.json"
+                },
+                {
+                  "type": "string",
+                  "enum": ["*"]
+                }
+              ]
+            },
+
+            "preloadComponents": {
+              "title": "Preload Components",
+              "description": "A list of component manifests that must be preloaded alongside this component. These may include external resources that are needed during initial render, or components that should be loaded only on demand.",
+              "type": "array",
+              "uniqueItems": true,
+              "minItems": 0,
+              "items": {
+                "type": "string",
+                "minLength": 10
+              }
+            },
+
+            "loaderConfig": {
+              "$ref": "client-side-component-loader-configuration.schema.json"
+            }
+          },
+
+          "additionalProperties": true
+        },
+        {
+          "$ref": "client-side-manifest-base.schema.json"
+        }
+      ]
+    }
+  },
+
+  "oneOf": [
+    {
+      "$ref": "adaptive-card-extension-manifest.schema.json"
+    },
+    {
+      "$ref": "client-side-application-manifest.schema.json"
+    },
+    {
+      "$ref": "client-side-extension-manifest.schema.json"
+    },
+    {
+      "$ref": "client-side-library-manifest.schema.json"
+    },
+    {
+      "$ref": "client-side-web-part-manifest.schema.json"
+    },
+    {
+      "$ref": "command-set-extension-manifest.schema.json"
+    },
+    {
+      "$ref": "client-side-assembly-manifest.schema.json"
+    },
+    {
+      "$ref": "prefab-app-manifest.schema.json"
+    }
+  ]
+}

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

@@ -0,0 +1,61 @@
+{
+  "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.",
+
+  "definitions": {
+    "clientSideExtensionManifest": {
+      "type": "object",
+      "required": ["componentType", "extensionType"],
+      "properties": {
+        "componentType": {
+          "type": "string",
+          "enum": ["Extension"]
+        },
+        "extensionType": {
+          "title": "Client-side Extension Type",
+          "description": "Specifies the type of client-side extension. Some types have their own JSON schemas supporting additional fields.",
+          "type": "string",
+          "enum": [
+            "Unknown",
+            "ApplicationCustomizer",
+            "FieldCustomizer",
+            "ListViewCommandSet",
+            "SearchQueryModifier",
+            "FormCustomizer"
+          ]
+        }
+      },
+      "additionalProperties": true
+    }
+  },
+
+  "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" },
+        "extensionType": { "$ref": "any-value.schema.json" },
+        "preloadComponents": { "$ref": "any-value.schema.json" },
+        "safeWithCustomScriptDisabled": { "$ref": "any-value.schema.json" },
+        "requiresCustomScript": { "$ref": "any-value.schema.json" },
+        "loadLegacyFabricCss": { "$ref": "any-value.schema.json" }
+      },
+      "additionalProperties": false
+    },
+    {
+      "$ref": "client-side-component-manifest.schema.json#/definitions/clientSideComponentManifest"
+    },
+    {
+      "$ref": "#/definitions/clientSideExtensionManifest"
+    }
+  ]
+}