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

package/lib-commonjs/manifestSchemas/examples/prefabapp.manifest.json

@@ -0,0 +1,345 @@
+{
+  "$schema": "./../jsonSchemas/prefab-app-manifest.schema.json",
+
+  "manifestVersion": 2,
+  "componentType": "Prefab",
+  "id": "00000000-0000-0000-0000-000000000000",
+  "alias": "Prefab",
+  "version": "0.0.1",
+  "loaderConfig": {
+    "internalModuleBaseUrls": ["https://cdn.net/"],
+    "entryModuleId": "main.bundle",
+    "scriptResources": {
+      "frameworkA": {
+        "type": "component",
+        "version": "1.2.3",
+        "id": "00000000-0000-0000-0000-000000000000"
+      },
+      "frameworkB": {
+        "type": "component",
+        "version": "1.2.3",
+        "id": "00000000-0000-0000-0000-000000000000",
+        "failoverPath": "script.js"
+      },
+      "frameworkC": {
+        "type": "component",
+        "version": "latest",
+        "id": "00000000-0000-0000-0000-000000000000",
+        "failoverPath": {
+          "path": "script.js"
+        }
+      },
+      "frameworkD": {
+        "type": "component",
+        "version": "latest",
+        "id": "00000000-0000-0000-0000-000000000000",
+        "failoverPath": {
+          "path": "script.js",
+          "integrity": "sha384-oqVuAfXRKap7fdgcCY5uykM6+R9GqQ8K/uxy9rx7HNQlGYl1kPzQho1wx4JwY8wC"
+        }
+      },
+      "frameworkE": {
+        "type": "component",
+        "version": "1.2.3",
+        "id": "00000000-0000-0000-0000-000000000000",
+        "shouldNotPreload": true
+      },
+      "frameworkF": {
+        "type": "component",
+        "version": "1.2.3",
+        "id": "00000000-0000-0000-0000-000000000000",
+        "failoverPath": "script.js",
+        "shouldNotPreload": true
+      },
+      "frameworkG": {
+        "type": "component",
+        "version": "latest",
+        "id": "00000000-0000-0000-0000-000000000000",
+        "failoverPath": {
+          "path": "script.js"
+        },
+        "shouldNotPreload": true
+      },
+      "frameworkI": {
+        "type": "component",
+        "version": "latest",
+        "id": "00000000-0000-0000-0000-000000000000",
+        "failoverPath": {
+          "path": "script.js",
+          "integrity": "sha384-oqVuAfXRKap7fdgcCY5uykM6+R9GqQ8K/uxy9rx7HNQlGYl1kPzQho1wx4JwY8wC"
+        },
+        "shouldNotPreload": true
+      },
+      "frameworkJ": {
+        "type": "component",
+        "version": "1.2.3",
+        "id": "00000000-0000-0000-0000-000000000000",
+        "shouldNotPreload": false
+      },
+      "frameworkK": {
+        "type": "component",
+        "version": "1.2.3",
+        "id": "00000000-0000-0000-0000-000000000000",
+        "failoverPath": "script.js",
+        "shouldNotPreload": false
+      },
+      "frameworkL": {
+        "type": "component",
+        "version": "latest",
+        "id": "00000000-0000-0000-0000-000000000000",
+        "failoverPath": {
+          "path": "script.js"
+        },
+        "shouldNotPreload": false
+      },
+      "frameworkM": {
+        "type": "component",
+        "version": "latest",
+        "id": "00000000-0000-0000-0000-000000000000",
+        "failoverPath": {
+          "path": "script.js",
+          "integrity": "sha384-oqVuAfXRKap7fdgcCY5uykM6+R9GqQ8K/uxy9rx7HNQlGYl1kPzQho1wx4JwY8wC"
+        },
+        "shouldNotPreload": false
+      },
+      "main.bundle": {
+        "type": "path",
+        "path": "bundle.script.js"
+      },
+      "dependencyA": {
+        "type": "path",
+        "path": {
+          "path": "dependencyA.script.js",
+          "integrity": "sha384-oqVuAfXRKap7fdgcCY5uykM6+R9GqQ8K/uxy9rx7HNQlGYl1kPzQho1wx4JwY8wC"
+        }
+      },
+      "dependencyB": {
+        "type": "path",
+        "path": {
+          "path": "dependencyB.script.js"
+        }
+      },
+      "dependencyC": {
+        "type": "path",
+        "path": "dependencyC.script.js"
+      },
+      "dependencyD": {
+        "type": "path",
+        "path": {
+          "path": "dependencyD.script.js",
+          "integrity": "sha384-oqVuAfXRKap7fdgcCY5uykM6+R9GqQ8K/uxy9rx7HNQlGYl1kPzQho1wx4JwY8wC"
+        },
+        "shouldNotPreload": true
+      },
+      "dependencyE": {
+        "type": "path",
+        "path": {
+          "path": "dependencyE.script.js"
+        },
+        "shouldNotPreload": true
+      },
+      "dependencyF": {
+        "type": "path",
+        "path": "dependencyF.script.js",
+        "shouldNotPreload": true
+      },
+      "dependencyG": {
+        "type": "path",
+        "path": {
+          "path": "dependencyG.script.js",
+          "integrity": "sha384-oqVuAfXRKap7fdgcCY5uykM6+R9GqQ8K/uxy9rx7HNQlGYl1kPzQho1wx4JwY8wC"
+        },
+        "shouldNotPreload": false
+      },
+      "dependencyH": {
+        "type": "path",
+        "path": {
+          "path": "dependencyH.script.js"
+        },
+        "shouldNotPreload": false
+      },
+      "dependencyI": {
+        "type": "path",
+        "path": "dependencyI.script.js",
+        "shouldNotPreload": false
+      },
+      "stringsA": {
+        "type": "localizedPath",
+        "defaultPath": "stringsA_default.js"
+      },
+      "stringsB": {
+        "type": "localizedPath",
+        "defaultPath": {
+          "path": "stringsB_default.js",
+          "integrity": "sha384-oqVuAfXRKap7fdgcCY5uykM6+R9GqQ8K/uxy9rx7HNQlGYl1kPzQho1wx4JwY8wC"
+        }
+      },
+      "stringsC": {
+        "type": "localizedPath",
+        "defaultPath": {
+          "path": "stringsC_default.js"
+        }
+      },
+      "stringsD": {
+        "type": "localizedPath",
+        "defaultPath": "stringsD_default.js",
+        "paths": {
+          "en-us": "stringsD_en-us.js",
+          "fr-fr": "stringsD_fr-fr.js"
+        }
+      },
+      "stringsE": {
+        "type": "localizedPath",
+        "defaultPath": "stringsE_default.js",
+        "paths": {
+          "en-us": {
+            "path": "stringsE_en-us.js"
+          },
+          "fr-fr": "stringsE_fr-fr.js"
+        }
+      },
+      "stringsF": {
+        "type": "localizedPath",
+        "defaultPath": "stringsF_default.js",
+        "paths": {
+          "en-us": {
+            "path": "stringsF_en-us.js",
+            "integrity": "sha384-oqVuAfXRKap7fdgcCY5uykM6+R9GqQ8K/uxy9rx7HNQlGYl1kPzQho1wx4JwY8wC"
+          },
+          "fr-fr": "stringsF_fr-fr.js"
+        }
+      },
+      "stringsG": {
+        "type": "localizedPath",
+        "defaultPath": "stringsG_default.js",
+        "shouldNotPreload": true
+      },
+      "stringsH": {
+        "type": "localizedPath",
+        "defaultPath": {
+          "path": "stringsH_default.js",
+          "integrity": "sha384-oqVuAfXRKap7fdgcCY5uykM6+R9GqQ8K/uxy9rx7HNQlGYl1kPzQho1wx4JwY8wC"
+        },
+        "shouldNotPreload": true
+      },
+      "stringsI": {
+        "type": "localizedPath",
+        "defaultPath": {
+          "path": "stringsI_default.js"
+        },
+        "shouldNotPreload": true
+      },
+      "stringsJ": {
+        "type": "localizedPath",
+        "defaultPath": "stringsJ_default.js",
+        "paths": {
+          "en-us": "stringsJ_en-us.js",
+          "fr-fr": "stringsJ_fr-fr.js"
+        },
+        "shouldNotPreload": true
+      },
+      "stringsK": {
+        "type": "localizedPath",
+        "defaultPath": "stringsK_default.js",
+        "paths": {
+          "en-us": {
+            "path": "stringsK_en-us.js"
+          },
+          "fr-fr": "stringsK_fr-fr.js"
+        },
+        "shouldNotPreload": true
+      },
+      "stringsL": {
+        "type": "localizedPath",
+        "defaultPath": "stringsL_default.js",
+        "paths": {
+          "en-us": {
+            "path": "stringsL_en-us.js",
+            "integrity": "sha384-oqVuAfXRKap7fdgcCY5uykM6+R9GqQ8K/uxy9rx7HNQlGYl1kPzQho1wx4JwY8wC"
+          },
+          "fr-fr": "stringsL_fr-fr.js"
+        },
+        "shouldNotPreload": true
+      },
+      "stringsM": {
+        "type": "localizedPath",
+        "defaultPath": "stringsM_default.js",
+        "shouldNotPreload": false
+      },
+      "stringsN": {
+        "type": "localizedPath",
+        "defaultPath": {
+          "path": "stringsN_default.js",
+          "integrity": "sha384-oqVuAfXRKap7fdgcCY5uykM6+R9GqQ8K/uxy9rx7HNQlGYl1kPzQho1wx4JwY8wC"
+        },
+        "shouldNotPreload": false
+      },
+      "stringsO": {
+        "type": "localizedPath",
+        "defaultPath": {
+          "path": "stringsO_default.js"
+        },
+        "shouldNotPreload": false
+      },
+      "stringsP": {
+        "type": "localizedPath",
+        "defaultPath": "stringsP_default.js",
+        "paths": {
+          "en-us": "stringsP_en-us.js",
+          "fr-fr": "stringsP_fr-fr.js"
+        },
+        "shouldNotPreload": false
+      },
+      "stringsQ": {
+        "type": "localizedPath",
+        "defaultPath": "stringsQ_default.js",
+        "paths": {
+          "en-us": {
+            "path": "stringsQ_en-us.js"
+          },
+          "fr-fr": "stringsQ_fr-fr.js"
+        },
+        "shouldNotPreload": false
+      },
+      "stringsR": {
+        "type": "localizedPath",
+        "defaultPath": "stringsR_default.js",
+        "paths": {
+          "en-us": {
+            "path": "stringsR_en-us.js",
+            "integrity": "sha384-oqVuAfXRKap7fdgcCY5uykM6+R9GqQ8K/uxy9rx7HNQlGYl1kPzQho1wx4JwY8wC"
+          },
+          "fr-fr": "stringsR_fr-fr.js"
+        },
+        "shouldNotPreload": false
+      },
+      "nonAmdA": {
+        "type": "path",
+        "path": "nonAmdA.js",
+        "globalName": "nonAmdA"
+      },
+      "nonAmdB": {
+        "type": "path",
+        "path": "nonAmdB.js",
+        "globalName": "nonAmdB",
+        "globalDependencies": ["nonAmdB"]
+      }
+    }
+  },
+  "title": {
+    "default": "Prefab App",
+    "en-us": "ABC123",
+    "fr-fr": "123ABC"
+  },
+  "description": {
+    "default": "This is a prefab app."
+  },
+  "isConfigured": true,
+  "appInstallationTypes": ["NewSite", "ExistingSite"],
+  "actions": [
+    {
+      "verb": "applyTheme",
+      "themeName": "Contoso"
+    }
+  ]
+}

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

@@ -98,6 +98,14 @@
             "type": "string",
             "enum": ["Dashboard"]
           }
+        },
+        "personalization": {
+          "description": "The scope of the personalization on how an AdaptiveCardExtension can be personalized by an end user.",
+          "type": "array",
+          "items": {
+            "type": "string",
+            "enum": ["Disallow", "Allow"]
+          }
         }
       },
       "additionalProperties": false

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

@@ -46,8 +46,8 @@
             "componentType": {
               "type": "string",
               "title": "Component Type",
-              "description": "Type of client side component (\"Application\", \"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"]
+              "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": {
@@ -123,6 +123,9 @@
     },
     {
       "$ref": "client-side-assembly-manifest.schema.json"
+    },
+    {
+      "$ref": "prefab-app-manifest.schema.json"
     }
   ]
 }

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

@@ -143,6 +143,29 @@
           "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

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

@@ -22,16 +22,12 @@
       "description": "Id for the localized string in the form '$<moduleName>:<expression>;'",
       "type": "string",
       "minLength": 1,
-      "pattern": "^\\$[^:]+\\:.+\\;$"
+      "pattern": "^\\$[^:]+:.+;$"
     }
   },
-  "patternProperties": {
-    ".+": {
-      "title": "Localized string",
-      "type": "string",
-      "minLength": 1
-    }
-  },
-
-  "additionalProperties": false
+  "additionalProperties": {
+    "title": "Localized string",
+    "type": "string",
+    "minLength": 1
+  }
 }

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

@@ -0,0 +1,72 @@
+{
+  "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.",
+
+  "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" },
+        "title": { "$ref": "any-value.schema.json" },
+        "description": { "$ref": "any-value.schema.json" },
+        "isConfigured": { "$ref": "any-value.schema.json" },
+        "appInstallationTypes": {
+          "description": "Describes how the PREFAB app can be installed: NewSite or ExistingSite. If omitted the app supports both.",
+          "type": "array",
+          "items": {
+            "type": "string",
+            "enum": ["NewSite", "ExistingSite"]
+          }
+        },
+        "actions": {
+          "$ref": "https://developer.microsoft.com/json-schemas/sp/site-design-script-actions.schema.json#/properties/actions"
+        }
+      },
+      "additionalProperties": false
+    },
+    {
+      "$ref": "client-side-component-manifest.schema.json#/definitions/clientSideComponentManifest"
+    },
+    {
+      "type": "object",
+      "required": ["componentType", "title", "description", "isConfigured"],
+      "properties": {
+        "componentType": {
+          "type": "string",
+          "enum": ["Prefab"]
+        },
+
+        "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"
+        },
+
+        "isConfigured": {
+          "title": "Is configured",
+          "description": "True if the application is configured and not need a FRC (First Run Configuration) step.",
+          "type": "boolean"
+        }
+      },
+
+      "additionalProperties": true
+    }
+  ]
+}

package/lib-commonjs/manifestSchemas/remote/draft-04.schema.json

@@ -0,0 +1,137 @@
+{
+  "id": "http://json-schema.org/draft-04/schema#",
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "description": "Core schema meta-schema",
+  "definitions": {
+    "schemaArray": {
+      "type": "array",
+      "minItems": 1,
+      "items": { "$ref": "#" }
+    },
+    "positiveInteger": {
+      "type": "integer",
+      "minimum": 0
+    },
+    "positiveIntegerDefault0": {
+      "allOf": [{ "$ref": "#/definitions/positiveInteger" }, { "default": 0 }]
+    },
+    "simpleTypes": {
+      "enum": ["array", "boolean", "integer", "null", "number", "object", "string"]
+    },
+    "stringArray": {
+      "type": "array",
+      "items": { "type": "string" },
+      "minItems": 1,
+      "uniqueItems": true
+    }
+  },
+  "type": "object",
+  "properties": {
+    "id": {
+      "type": "string"
+    },
+    "$schema": {
+      "type": "string"
+    },
+    "title": {
+      "type": "string"
+    },
+    "description": {
+      "type": "string"
+    },
+    "default": {},
+    "multipleOf": {
+      "type": "number",
+      "minimum": 0,
+      "exclusiveMinimum": true
+    },
+    "maximum": {
+      "type": "number"
+    },
+    "exclusiveMaximum": {
+      "type": "boolean",
+      "default": false
+    },
+    "minimum": {
+      "type": "number"
+    },
+    "exclusiveMinimum": {
+      "type": "boolean",
+      "default": false
+    },
+    "maxLength": { "$ref": "#/definitions/positiveInteger" },
+    "minLength": { "$ref": "#/definitions/positiveIntegerDefault0" },
+    "pattern": {
+      "type": "string",
+      "format": "regex"
+    },
+    "additionalItems": {
+      "anyOf": [{ "type": "boolean" }, { "$ref": "#" }],
+      "default": {}
+    },
+    "items": {
+      "anyOf": [{ "$ref": "#" }, { "$ref": "#/definitions/schemaArray" }],
+      "default": {}
+    },
+    "maxItems": { "$ref": "#/definitions/positiveInteger" },
+    "minItems": { "$ref": "#/definitions/positiveIntegerDefault0" },
+    "uniqueItems": {
+      "type": "boolean",
+      "default": false
+    },
+    "maxProperties": { "$ref": "#/definitions/positiveInteger" },
+    "minProperties": { "$ref": "#/definitions/positiveIntegerDefault0" },
+    "required": { "$ref": "#/definitions/stringArray" },
+    "additionalProperties": {
+      "anyOf": [{ "type": "boolean" }, { "$ref": "#" }],
+      "default": {}
+    },
+    "definitions": {
+      "type": "object",
+      "additionalProperties": { "$ref": "#" },
+      "default": {}
+    },
+    "properties": {
+      "type": "object",
+      "additionalProperties": { "$ref": "#" },
+      "default": {}
+    },
+    "patternProperties": {
+      "type": "object",
+      "additionalProperties": { "$ref": "#" },
+      "default": {}
+    },
+    "dependencies": {
+      "type": "object",
+      "additionalProperties": {
+        "anyOf": [{ "$ref": "#" }, { "$ref": "#/definitions/stringArray" }]
+      }
+    },
+    "enum": {
+      "type": "array",
+      "minItems": 1,
+      "uniqueItems": true
+    },
+    "type": {
+      "anyOf": [
+        { "$ref": "#/definitions/simpleTypes" },
+        {
+          "type": "array",
+          "items": { "$ref": "#/definitions/simpleTypes" },
+          "minItems": 1,
+          "uniqueItems": true
+        }
+      ]
+    },
+    "format": { "type": "string" },
+    "allOf": { "$ref": "#/definitions/schemaArray" },
+    "anyOf": { "$ref": "#/definitions/schemaArray" },
+    "oneOf": { "$ref": "#/definitions/schemaArray" },
+    "not": { "$ref": "#" }
+  },
+  "dependencies": {
+    "exclusiveMaximum": ["maximum"],
+    "exclusiveMinimum": ["minimum"]
+  },
+  "default": {}
+}