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

package/lib-esm/manifestSchemas/IClientSideAssemblyManifest.js

@@ -0,0 +1,7 @@
+/**
+ * A library is defined by this manifest. Libraries currently do not have any additional properties.
+ *
+ * @public
+ */ export { };
+
+//#sourceMappingUrl=./IClientSideAssemblyManifest.js.map

package/lib-esm/manifestSchemas/IClientSideComponentLoaderConfiguration.js

@@ -0,0 +1,17 @@
+/**
+ * This interface describes how a client-side component is to be loaded and initialized by a SharePoint client
+ * framework. It contains all data for loading an entrypoint script and its dependency scripts.
+ *
+ * @beta
+ */ /**
+ * This is the interface for a script module with the "localizedPath" type.
+ *
+ * @remarks
+ * Modules of this type must be provided by the component developer. These script resources are similar to those of
+ * the "path" 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.
+ *
+ * @beta
+ */ export { };
+
+//#sourceMappingUrl=./IClientSideComponentLoaderConfiguration.js.map

package/lib-esm/manifestSchemas/IClientSideComponentManifest.js

@@ -0,0 +1,27 @@
+/**
+ * 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.
+ *
+ * @remarks
+ *
+ * The schema of this manifest is owned and versioned by Microsoft. Following rules should be followed while changing
+ * this schema. This set of rules can also be called the "manifest upgrade rules".
+ *
+ * - For minor changes, new properties can be added to this schema in a backwards-compatible way. i.e. the code
+ *   that processes the manifest should be able to handle the absence of those new properties.
+ *
+ * - Try to model your changes as minor SemVer increments.  Major version changes should be avoided because they
+ *   impose a migration cost on developers.
+ *
+ * - The `'manifestVersion'` should be bumped for all small or big changes.
+ *
+ * @privateRemarks
+ *
+ * This schema should be at all times kept in sync with the server-side code file
+ * SPClientSideComponentManifest.cs.
+ *
+ * @public
+ */ export { };
+
+//#sourceMappingUrl=./IClientSideComponentManifest.js.map

package/lib-esm/manifestSchemas/IClientSideExtensionManifest.js

@@ -0,0 +1,7 @@
+/**
+ * This is the manifest for a client-side extension.
+ *
+ * @public
+ */ export { };
+
+//#sourceMappingUrl=./IClientSideExtensionManifest.js.map

package/lib-esm/manifestSchemas/IClientSideLibraryManifest.js

@@ -0,0 +1,7 @@
+/**
+ * A library is defined by this manifest. Libraries currently do not have any additional properties.
+ *
+ * @public
+ */ export { };
+
+//#sourceMappingUrl=./IClientSideLibraryManifest.js.map

package/lib-esm/manifestSchemas/IClientSideManifestBase.js

@@ -0,0 +1,7 @@
+/**
+ * This interface defines members that are common between all deployable manifests.
+ *
+ * @public
+ */ export { };
+
+//#sourceMappingUrl=./IClientSideManifestBase.js.map

package/lib-esm/manifestSchemas/IClientSideMultiVersionManifest.js

@@ -0,0 +1,25 @@
+/**
+ * Multi-version manifests are defined by this interface.
+ *
+ * @remarks
+ *
+ * The schema of this manifest is owned and versioned by Microsoft. Following rules should be followed while changing
+ * this schema. This set of rules can also be called the "manifest upgrade rules".
+ *
+ * -  For minor changes, new properties can be added to this schema in a backwards-compatible way. i.e. the code
+ *    that processes the manifest should be able to handle the absence of those new properties.
+ *
+ * -  Try to model your changes as minor SemVer increments.  Major version changes should be avoided because they
+ *    impose a migration cost on developers.
+ *
+ * -  The 'manifestVersion' should be bumped for all small or big changes.
+ *
+ * @privateRemarks
+ *
+ * This schema should be at all times kept in sync with the server-side code file
+ * SPClientSideMultiVersionManifest.cs.
+ *
+ * @alpha
+ */ export { };
+
+//#sourceMappingUrl=./IClientSideMultiVersionManifest.js.map

package/lib-esm/manifestSchemas/IClientSideWebPartManifest.js

@@ -0,0 +1,62 @@
+export var PredefinedGroup;
+(function(PredefinedGroup) {
+    /**
+   * Text, media and content.
+   *
+   * This group includes web parts that display text, multi-media, documents, information from the web, and other
+   * rich content.
+   *
+   * @beta
+   */ PredefinedGroup["TextMediaAndContent"] = "cf066440-0614-43d6-98ae-0b31cf14c7c3";
+    /**
+   * Discovery.
+   *
+   * This group includes web parts that organize, group, and filter content to help users discover information.
+   *
+   * @beta
+   */ PredefinedGroup["DocumentsListsAndLibraries"] = "1edbd9a8-0bfb-4aa2-9afd-14b8c45dd489";
+    /**
+   * Communication and collaboration.
+   *
+   * This group includes web parts that facilitate information sharing, team work, and social interactions.
+   *
+   * @beta
+   */ PredefinedGroup["Feeds"] = "75e22ed5-fa14-4829-850a-c890608aca2d";
+    /**
+   * Planning and process.
+   *
+   * This group includes web parts that empower team productivity with the use of planning and process tools.
+   *
+   * @beta
+   */ PredefinedGroup["NewsPeopleAndEvents"] = "1bc7927e-4a5e-4520-b540-71305c79c20a";
+    /**
+   * Business and intelligence.
+   *
+   * This group includes web parts for tracking and analyzing data, and for integrating business flow with pages.
+   *
+   * @beta
+   */ PredefinedGroup["DataAnalysis"] = "4aca9e90-eff5-4fa1-bac7-728f5f157b66";
+    /**
+   * Regional information
+   *
+   * This group includes web parts that display information based on current region and geographical location
+   *
+   * @beta
+   */ PredefinedGroup["RegionalInformation"] = "cfc8bda5-cb9b-49e3-8526-2ee6e52b256a";
+    /**
+   * Other.
+   *
+   * This group includes web parts not in other groups.
+   *
+   * @beta
+   */ PredefinedGroup["Advanced"] = "5c03119e-3074-46fd-976b-c60198311f70";
+    /**
+   * Other.
+   *
+   * This group includes local web parts.
+   *
+   * @beta
+   */ PredefinedGroup["Local"] = "8b7bf6f1-a56a-4aa3-8657-7eb6e7e6af61";
+})(PredefinedGroup || (PredefinedGroup = {}));
+
+//#sourceMappingUrl=./IClientSideWebPartManifest.js.map

package/lib-esm/manifestSchemas/ICommandSetExtensionManifest.js

@@ -0,0 +1,8 @@
+/**
+ * Used by ICommandSetExtensionManifest, this defines a command to be displayed by
+ * a UI surface such as a menu, tool bar, etc.
+ *
+ * @public
+ */ export { };
+
+//#sourceMappingUrl=./ICommandSetExtensionManifest.js.map

package/lib-esm/manifestSchemas/IPrefabAppManifest.js

@@ -0,0 +1,7 @@
+/**
+ * This interface specifies the set of that can be provided by a PREFAB developer if the application should be available in the modern SharePoint toolbox.
+ *
+ * @alpha
+ */ export { };
+
+//#sourceMappingUrl=./IPrefabAppManifest.js.map

package/lib-esm/manifestSchemas/ManifestType.js

@@ -0,0 +1,15 @@
+/**
+ * The type of the manifest.
+ *
+ * @alpha
+ */ export var ManifestType;
+(function(ManifestType) {
+    /**
+   * The component manifest type.
+   */ ManifestType["component"] = "Component";
+    /**
+   * The container manifest type. This is used for manifests that contain other manifests, like multiversion manifests.
+   */ ManifestType["container"] = "Container";
+})(ManifestType || (ManifestType = {}));
+
+//#sourceMappingUrl=./ManifestType.js.map

package/lib-esm/manifestSchemas/examples/application.manifest.json

@@ -0,0 +1,346 @@
+{
+  "$schema": "./../jsonSchemas/client-side-component-manifest.schema.json",
+
+  "manifestVersion": 2,
+  "componentType": "Application",
+  "id": "00000000-0000-0000-0000-000000000000",
+  "alias": "Application",
+  "version": "*",
+  "loaderConfig": {
+    "internalModuleBaseUrls": ["https://cdn.net/"],
+    "entryModuleId": "main.bundle",
+    "scriptResources": {
+      "frameworkA": {
+        "type": "component",
+        "id": "00000000-0000-0000-0000-000000000000",
+        "version": "1.2.3"
+      },
+      "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"]
+      }
+    }
+  },
+  "preloadOptions": {
+    "shouldPreloadWeb": true,
+    "shouldPreloadUser": true,
+    "shouldPreloadList": true,
+    "shouldPreloadItem": true,
+    "shouldPreloadQuickLaunch": true,
+    "preloadListItemQueryOption": "query"
+  },
+  "preloadComponents": ["framework1", "framework2"],
+  "title": {
+    "default": "Hello World",
+    "en-us": "ABC123",
+    "fr-fr": "123ABC"
+  },
+  "description": {
+    "default": "Hello, World!"
+  }
+}