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

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

@@ -0,0 +1,379 @@
+{
+  "$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": {
+    "key1": {
+      "type": "onInstall",
+      "actions": [
+        {
+          "verb": "applyTheme",
+          "themeName": "Contoso"
+        }
+      ]
+    },
+    "key2": {
+      "type": "onDemand",
+      "actions": [
+        {
+          "verb": "applyTheme",
+          "themeName": "Contoso"
+        }
+      ]
+    }
+  },
+  "siteSettingsLinks": [
+    {
+      "viewId": "routeId",
+      "text": { "default": "text" }
+    }
+  ],
+  "toolboxEntries": [
+    {
+      "viewId": "routeId1",
+      "title": { "default": "title1" },
+      "description": { "default": "description1" },
+      "officeFabricIconFontName": "icon1"
+    },
+    {
+      "viewId": "routeId2",
+      "title": { "default": "title2" },
+      "description": { "default": "description2" },
+      "iconImageUrl": "https://cdn.net/icon2.png"
+    }
+  ]
+}

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

@@ -1,4 +1,13 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: function() {
+        return _default;
+    }
+});
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 const webpartManifest = {
     manifestVersion: 2,
@@ -9,7 +18,9 @@ const webpartManifest = {
     safeWithCustomScriptDisabled: true,
     disabledOnClassicSharepoint: true,
     loaderConfig: {
-        internalModuleBaseUrls: ['https://cdn.net/'],
+        internalModuleBaseUrls: [
+            'https://cdn.net/'
+        ],
         entryModuleId: 'main.bundle',
         scriptResources: {
             frameworkA: {
@@ -324,19 +335,26 @@ const webpartManifest = {
                 type: 'path',
                 path: 'nonAmdB.js',
                 globalName: 'nonAmdB',
-                globalDependencies: ['nonAmdB']
+                globalDependencies: [
+                    'nonAmdB'
+                ]
             }
         }
     },
     preconfiguredEntries: [
         {
-            title: { default: 'asdf' },
-            description: { default: 'asdf jkl' },
+            title: {
+                default: 'asdf'
+            },
+            description: {
+                default: 'asdf jkl'
+            },
             officeFabricIconFontName: 'chart',
             properties: {},
             groupId: '75e22ed5-fa14-4829-850a-c890608aca2d' // Communication and Collaboration
         }
     ]
 };
-module.exports = webpartManifest;
-//# sourceMappingURL=webpart_1.manifest.js.map
+const _default = webpartManifest;
+
+//#sourceMappingUrl=./webpart_1.manifest.js.map

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

@@ -1,4 +1,13 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+Object.defineProperty(exports, "default", {
+    enumerable: true,
+    get: function() {
+        return _default;
+    }
+});
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 const webpartManifest = {
     manifestVersion: 2,
@@ -8,7 +17,9 @@ const webpartManifest = {
     version: '0.0.1',
     requiresCustomScript: false,
     loaderConfig: {
-        internalModuleBaseUrls: ['https://cdn.net/'],
+        internalModuleBaseUrls: [
+            'https://cdn.net/'
+        ],
         entryModuleId: 'main.bundle',
         scriptResources: {
             frameworkA: {
@@ -323,41 +334,65 @@ const webpartManifest = {
                 type: 'path',
                 path: 'nonAmdB.js',
                 globalName: 'nonAmdB',
-                globalDependencies: ['nonAmdB']
+                globalDependencies: [
+                    'nonAmdB'
+                ]
             }
         }
     },
     preconfiguredEntries: [
         {
-            title: { default: 'asdf' },
-            description: { default: 'asdf jkl' },
+            title: {
+                default: 'asdf'
+            },
+            description: {
+                default: 'asdf jkl'
+            },
             iconImageUrl: 'https://contoso.com/chart.png',
             properties: {},
             groupId: '1bc7927e-4a5e-4520-b540-71305c79c20a' // Planning and Process
         },
         {
-            title: { default: 'asdf', 'en-us': 'foobar' },
-            description: { default: 'asdf jkl', 'en-us': 'asdf' },
+            title: {
+                default: 'asdf',
+                'en-us': 'foobar'
+            },
+            description: {
+                default: 'asdf jkl',
+                'en-us': 'asdf'
+            },
             iconImageUrl: 'https://contoso.com/chart.png',
             properties: {
                 a: 'b',
                 c: 'd'
             },
-            group: { default: 'asdf' },
+            group: {
+                default: 'asdf'
+            },
             groupId: '0314dcd9-9acb-4ab2-886e-f8881ffb5192' // Customized Group
         },
         {
-            title: { default: 'asdf', 'en-us': 'foobar' },
-            description: { default: 'asdf jkl', 'en-us': 'asdf' },
+            title: {
+                default: 'asdf',
+                'en-us': 'foobar'
+            },
+            description: {
+                default: 'asdf jkl',
+                'en-us': 'asdf'
+            },
             iconImageUrl: 'https://contoso.com/chart.png',
             properties: {
                 a: 'b',
                 c: 'd'
             },
-            group: { default: 'asdf', 'en-us': 'asdfasdf' },
+            group: {
+                default: 'asdf',
+                'en-us': 'asdfasdf'
+            },
             groupId: '1db70b09-46dc-4fa1-9c97-dcce28dad5d9' // Customized Group
         }
     ]
 };
-module.exports = webpartManifest;
-//# sourceMappingURL=webpart_2.manifest.js.map
+const _default = webpartManifest;
+
+//#sourceMappingUrl=./webpart_2.manifest.js.map

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