@microsoft/sp-module-interfaces 1.21.1 → 1.22.0-beta.2

package/lib-dts/manifestSchemas/IClientSideComponentLoaderConfiguration.d.ts

@@ -211,6 +211,82 @@ export interface IComponentModuleConfiguration extends IModuleConfigurationBase
      * Example: `"https://code.jquery.com/jquery-2.2.4.min.js"`
      */
     failoverPath?: string | IIntegrityPath;
+    /**
+     * Used to specify an alternative version of the dependency to be used, under certain conditions.
+     * @internal
+     */
+    fallbackVersion?: IComponentFallbackVersion;
+}
+/**
+ * @internal
+ * Represents a fallback version of a component that can be used under certain conditions.
+ *
+ * @remarks
+ * This field is used to specify an alternative version of the dependency to load, provided certain conditions are met.
+ * The conditions are specified using the `condition` field, which allows an expression to be defined. This supports the following:
+ *   - AND
+ *   - OR
+ *   - NOT
+ *   - XOR
+ *   - Flight checks
+ *   - Killswitch checks
+ *
+ * This field should only be used if the component has a multi-version manifest.
+ */
+export interface IComponentFallbackVersion {
+    /**
+     * @internal
+     * The version of the component to be used as a fallback.
+     *
+     * @remarks
+     * This should be a string representing a semantic version.
+     */
+    version: string;
+    /**
+     * @internal
+     * The condition under which the fallback version should be used.
+     *
+     * @remarks
+     * This condition is expressed as a logical operator or switch, which can include AND, OR, NOT, XOR,
+     * Flight checks, and KillSwitch checks. The condition must evaluate to true for the fallback version to be used.
+     */
+    condition: IOperatorOrSwitch;
+}
+/**
+ * @internal
+ * Represents the logical operators used in the flighted manifest configuration.
+ */
+export type IOperatorOrSwitch = {
+    and: IOperatorOrSwitch[];
+} | {
+    or: IOperatorOrSwitch[];
+} | {
+    xor: [IOperatorOrSwitch, IOperatorOrSwitch];
+} | {
+    not: IOperatorOrSwitch;
+} | IFlightOrKillSwitch;
+/**
+ * @internal
+ * Represents a flighted component or a kill switch component.
+ * This type is used to define components that can be toggled on or off
+ * based on certain conditions in the configuration.
+ */
+export type IFlightOrKillSwitch = IFlightedComponent | IKillSwitchComponent;
+/**
+ * @internal
+ * Represents a Flight check definition.
+ */
+export interface IFlightedComponent {
+    switchType: 'flight';
+    id: number;
+}
+/**
+ * @internal
+ * Represents a Kill Switch check definition.
+ */
+export interface IKillSwitchComponent {
+    switchType: 'killswitch';
+    id: string;
 }
 /**
  * This is the interface for a script module with the "path" type. Modules of this type must be provided by the

package/lib-dts/manifestSchemas/IClientSideWebPartManifest.d.ts

@@ -109,6 +109,26 @@ export interface IClientSideWebPartManifest<TProperties> extends IClientSideComp
      * logic, then it is recommended to override onAfterPropertiesUpdatedExternally.
      */
     useFallbackWhenPropertiesUpdatedExternally?: boolean;
+    /**
+     * A list of components that can be loaded on idle for performance optimization. These components generally used to support
+     * rendering the web part.
+     *
+     * @internal
+     *
+     * @privateRemarks
+     * Note: All top level JavaScript logic for the loaded component will be run upon loading the component.
+     *   If the component exports a default function, it will be called.
+     *
+     * example:
+     * ```
+     * idleLoadComponents: [{
+     *   displayMode: 'edit' | 'read' | 'all',
+     *   priority: 'high' | 'low',
+     *   componentId: 'abc5-...',
+     * }];
+     * ```
+     */
+    idleLoadComponents?: _IIdleLoadComponent[];
     /**
      * A Web Part can have pre-configured properties like the title, description, toolbox group name and Web
      * Part specific custom properties. And there can be multiple instances of these pre-configured properties.
@@ -204,6 +224,34 @@ export interface IClientSideWebPartManifest<TProperties> extends IClientSideComp
      * Ensure this remains up to date with IFlexibleControlSizingData in FlexibleControl.types.ts
      */
     flexibleLayoutSizing?: IFlexibleLayoutSizing;
+    /**
+     * @alpha
+     * Optional AI properties for the web part including the structure of AI properties and the mapping between
+     * AI properties and the web part property bag.
+     * If provided, AI scenarios like LLM agent in SharePoint Pages will be able to interact with the web part. For example,
+     * Creating a web part, modifying existing web part, better understanding of the web part's data structure, etc.
+     */
+    aiProperties?: IAIProperties;
+}
+/**
+ * @internal
+ * Definition: A component that can be loaded in the background to improve performance.
+ */
+export interface _IIdleLoadComponent {
+    /**
+     * The display mode in which the component should be loaded.
+     * If not specified, the component will be loaded in all display modes.
+     */
+    displayMode?: 'edit' | 'read';
+    /**
+     * The priority of the component to be loaded.
+     * High priority components will be loaded before low priority components.
+     */
+    priority: 'high' | 'low';
+    /**
+     * Manifest ID of the component to be loaded.
+     */
+    componentId: string;
 }
 /**
  * Flexible layout sizing data
@@ -501,4 +549,36 @@ export interface ICapabilityCollection {
      */
     AuthenticationModel?: Array<'OpenIDConnect' | 'Federated'>;
 }
+/**
+ * @alpha
+ * Defines the AI properties for the web part, including their structure and the mapping to the web part's property bag.
+ * When provided, AI scenarios such as an LLM agent in SharePoint Pages can interact with the web part,
+ * e.g., creating it, modifying it, or understanding its data structure.
+ */
+export interface IAIProperties {
+    /**
+     * The structure of AI properties for the web part.
+     */
+    structure: {
+        /**
+         * A free-form nested object not intended for direct use by web part developers.
+         * It is interpreted internally by the system based on the conversion logic
+         * between web part AI properties and JSON.
+         * The contract for this structure is internal and not exposed to developers.
+         */
+        [key: string]: unknown;
+    };
+    /**
+     * The mapping of AI properties to existing property bag.
+     */
+    mapping: {
+        /**
+         * A free-form nested object not intended for direct use by web part developers.
+         * It is interpreted internally by the system based on the conversion logic
+         * between web part AI properties and JSON.
+         * The contract for this structure is internal and not exposed to developers.
+         */
+        [key: string]: unknown;
+    };
+}
 //# sourceMappingURL=IClientSideWebPartManifest.d.ts.map

package/lib-dts/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.52.1"
+      "packageVersion": "7.52.5"
     }
   ]
 }

package/lib-esm/index.js

@@ -1,6 +1,5 @@
 export * from './manifestSchemas/IClientSideApplicationManifest';
 export * from './manifestSchemas/IClientSideAssemblyManifest';
-export * from './manifestSchemas/IClientSideComponentLoaderConfiguration';
 export * from './manifestSchemas/IClientSideComponentManifest';
 export * from './manifestSchemas/IClientSideExtensionManifest';
 export * from './manifestSchemas/IClientSideLibraryManifest';
@@ -12,4 +11,4 @@ export * from './manifestSchemas/ManifestType';
 export * from './manifestSchemas/IAdaptiveCardExtensionManifest';
 export * from './manifestSchemas/IPrefabAppManifest';
 
-//#sourceMappingUrl=./index.js.map
+//# sourceMappingURL=./index.js.map

package/lib-esm/manifestHelpers.js

@@ -18,4 +18,4 @@
     return config.type === 'path';
 }
 
-//#sourceMappingUrl=./manifestHelpers.js.map
+//# sourceMappingURL=./manifestHelpers.js.map

package/lib-esm/manifestSchemaValidator.js

@@ -132,4 +132,4 @@ class ManifestValidator {
 }
 export { ManifestValidator as default };
 
-//#sourceMappingUrl=./manifestSchemaValidator.js.map
+//# sourceMappingURL=./manifestSchemaValidator.js.map

package/lib-esm/manifestSchemas/IAdaptiveCardExtensionManifest.js

@@ -6,4 +6,4 @@
  * @beta
  */ export { };
 
-//#sourceMappingUrl=./IAdaptiveCardExtensionManifest.js.map
+//# sourceMappingURL=./IAdaptiveCardExtensionManifest.js.map

package/lib-esm/manifestSchemas/IClientSideApplicationManifest.js

@@ -2,4 +2,4 @@
  * @alpha
  */ export { };
 
-//#sourceMappingUrl=./IClientSideApplicationManifest.js.map
+//# sourceMappingURL=./IClientSideApplicationManifest.js.map

package/lib-esm/manifestSchemas/IClientSideAssemblyManifest.js

@@ -4,4 +4,4 @@
  * @public
  */ export { };
 
-//#sourceMappingUrl=./IClientSideAssemblyManifest.js.map
+//# sourceMappingURL=./IClientSideAssemblyManifest.js.map

package/lib-esm/manifestSchemas/IClientSideComponentLoaderConfiguration.js

@@ -14,4 +14,4 @@
  * @beta
  */ export { };
 
-//#sourceMappingUrl=./IClientSideComponentLoaderConfiguration.js.map
+//# sourceMappingURL=./IClientSideComponentLoaderConfiguration.js.map

package/lib-esm/manifestSchemas/IClientSideComponentManifest.js

@@ -24,4 +24,4 @@
  * @public
  */ export { };
 
-//#sourceMappingUrl=./IClientSideComponentManifest.js.map
+//# sourceMappingURL=./IClientSideComponentManifest.js.map

package/lib-esm/manifestSchemas/IClientSideExtensionManifest.js

@@ -4,4 +4,4 @@
  * @public
  */ export { };
 
-//#sourceMappingUrl=./IClientSideExtensionManifest.js.map
+//# sourceMappingURL=./IClientSideExtensionManifest.js.map

package/lib-esm/manifestSchemas/IClientSideLibraryManifest.js

@@ -4,4 +4,4 @@
  * @public
  */ export { };
 
-//#sourceMappingUrl=./IClientSideLibraryManifest.js.map
+//# sourceMappingURL=./IClientSideLibraryManifest.js.map

package/lib-esm/manifestSchemas/IClientSideManifestBase.js

@@ -4,4 +4,4 @@
  * @public
  */ export { };
 
-//#sourceMappingUrl=./IClientSideManifestBase.js.map
+//# sourceMappingURL=./IClientSideManifestBase.js.map

package/lib-esm/manifestSchemas/IClientSideMultiVersionManifest.js

@@ -22,4 +22,4 @@
  * @alpha
  */ export { };
 
-//#sourceMappingUrl=./IClientSideMultiVersionManifest.js.map
+//# sourceMappingURL=./IClientSideMultiVersionManifest.js.map

package/lib-esm/manifestSchemas/IClientSideWebPartManifest.js

@@ -59,4 +59,4 @@ export var PredefinedGroup;
    */ PredefinedGroup["Local"] = "8b7bf6f1-a56a-4aa3-8657-7eb6e7e6af61";
 })(PredefinedGroup || (PredefinedGroup = {}));
 
-//#sourceMappingUrl=./IClientSideWebPartManifest.js.map
+//# sourceMappingURL=./IClientSideWebPartManifest.js.map

package/lib-esm/manifestSchemas/ICommandSetExtensionManifest.js

@@ -5,4 +5,4 @@
  * @public
  */ export { };
 
-//#sourceMappingUrl=./ICommandSetExtensionManifest.js.map
+//# sourceMappingURL=./ICommandSetExtensionManifest.js.map

package/lib-esm/manifestSchemas/IPrefabAppManifest.js

@@ -4,4 +4,4 @@
  * @alpha
  */ export { };
 
-//#sourceMappingUrl=./IPrefabAppManifest.js.map
+//# sourceMappingURL=./IPrefabAppManifest.js.map

package/lib-esm/manifestSchemas/ManifestType.js

@@ -12,4 +12,4 @@
    */ ManifestType["container"] = "Container";
 })(ManifestType || (ManifestType = {}));
 
-//#sourceMappingUrl=./ManifestType.js.map
+//# sourceMappingURL=./ManifestType.js.map

package/lib-esm/manifestSchemas/examples/application_1.manifest.js

@@ -341,4 +341,4 @@ const appManifest = {
 };
 export default appManifest;
 
-//#sourceMappingUrl=./application_1.manifest.js.map
+//# sourceMappingURL=./application_1.manifest.js.map

package/lib-esm/manifestSchemas/examples/application_2.manifest.js

@@ -44,4 +44,4 @@ const appManifest = {
 };
 export default appManifest;
 
-//#sourceMappingUrl=./application_2.manifest.js.map
+//# sourceMappingURL=./application_2.manifest.js.map

package/lib-esm/manifestSchemas/examples/application_3.manifest.js

@@ -39,4 +39,4 @@ const appManifest = {
 };
 export default appManifest;
 
-//#sourceMappingUrl=./application_3.manifest.js.map
+//# sourceMappingURL=./application_3.manifest.js.map

package/lib-esm/manifestSchemas/examples/assembly_1.manifest.js

@@ -333,4 +333,4 @@ const assemblyManifest = {
 };
 export default assemblyManifest;
 
-//#sourceMappingUrl=./assembly_1.manifest.js.map
+//# sourceMappingURL=./assembly_1.manifest.js.map

package/lib-esm/manifestSchemas/examples/commandSet_1.manifest.js

@@ -39,4 +39,4 @@ const extensionManifest = {
 };
 export default extensionManifest;
 
-//#sourceMappingUrl=./commandSet_1.manifest.js.map
+//# sourceMappingURL=./commandSet_1.manifest.js.map

package/lib-esm/manifestSchemas/examples/extension_1.manifest.js

@@ -22,4 +22,4 @@ const extensionManifest = {
 };
 export default extensionManifest;
 
-//#sourceMappingUrl=./extension_1.manifest.js.map
+//# sourceMappingURL=./extension_1.manifest.js.map

package/lib-esm/manifestSchemas/examples/extension_2.manifest.js

@@ -21,4 +21,4 @@ const extensionManifest = {
 };
 export default extensionManifest;
 
-//#sourceMappingUrl=./extension_2.manifest.js.map
+//# sourceMappingURL=./extension_2.manifest.js.map

package/lib-esm/manifestSchemas/examples/extension_3.manifest.js

@@ -20,4 +20,4 @@ const extensionManifest = {
 };
 export default extensionManifest;
 
-//#sourceMappingUrl=./extension_3.manifest.js.map
+//# sourceMappingURL=./extension_3.manifest.js.map

package/lib-esm/manifestSchemas/examples/extension_4.manifest.js

@@ -20,4 +20,4 @@ const extensionManifest = {
 };
 export default extensionManifest;
 
-//#sourceMappingUrl=./extension_4.manifest.js.map
+//# sourceMappingURL=./extension_4.manifest.js.map

package/lib-esm/manifestSchemas/examples/library_1.manifest.js

@@ -332,4 +332,4 @@ const libraryManifest = {
 };
 export default libraryManifest;
 
-//#sourceMappingUrl=./library_1.manifest.js.map
+//# sourceMappingURL=./library_1.manifest.js.map

package/lib-esm/manifestSchemas/examples/multi-version_1.manifest.js

@@ -670,4 +670,4 @@ const multiVersionManifest = {
 };
 export default multiVersionManifest;
 
-//#sourceMappingUrl=./multi-version_1.manifest.js.map
+//# sourceMappingURL=./multi-version_1.manifest.js.map

package/lib-esm/manifestSchemas/examples/prefab_1.manifest.js

@@ -341,4 +341,4 @@ const prefabManifest = {
 };
 export default prefabManifest;
 
-//#sourceMappingUrl=./prefab_1.manifest.js.map
+//# sourceMappingURL=./prefab_1.manifest.js.map

package/lib-esm/manifestSchemas/examples/prefab_2.manifest.js

@@ -378,4 +378,4 @@ const prefabManifest = {
 };
 export default prefabManifest;
 
-//#sourceMappingUrl=./prefab_2.manifest.js.map
+//# sourceMappingURL=./prefab_2.manifest.js.map

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

@@ -323,6 +323,68 @@
         "path": "nonAmdB.js",
         "globalName": "nonAmdB",
         "globalDependencies": ["nonAmdB"]
+      },
+      "fallbackFlighted": {
+        "type": "component",
+        "version": "1.2.3",
+        "id": "00000000-0000-0000-0000-000000000000",
+        "fallbackVersion": {
+          "version": "0.0.1",
+          "condition": {
+            "switchType": "flight",
+            "id": 12345
+          }
+        }
+      },
+      "fallbackKillSwitched": {
+        "type": "component",
+        "version": "1.2.3",
+        "id": "00000000-0000-0000-0000-000000000000",
+        "fallbackVersion": {
+          "version": "0.0.1",
+          "condition": {
+            "switchType": "killswitch",
+            "id": "00000000-0000-0000-0000-000000000000"
+          }
+        }
+      },
+      "fallbackComplexExpression": {
+        "type": "component",
+        "version": "1.2.3",
+        "id": "00000000-0000-0000-0000-000000000000",
+        "fallbackVersion": {
+          "version": "0.0.1",
+          "condition": {
+            "xor": [
+              {
+                "or": [
+                  {
+                    "switchType": "flight",
+                    "id": 12345
+                  },
+                  {
+                    "not": {
+                      "switchType": "killswitch",
+                      "id": "00000000-0000-0000-0000-000000000000"
+                    }
+                  }
+                ]
+              },
+              {
+                "and": [
+                  {
+                    "switchType": "flight",
+                    "id": 67890
+                  },
+                  {
+                    "switchType": "killswitch",
+                    "id": "11111111-1111-1111-1111-111111111111"
+                  }
+                ]
+              }
+            ]
+          }
+        }
       }
     }
   },

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

@@ -328,6 +328,68 @@ const webpartManifest = {
                 globalDependencies: [
                     'nonAmdB'
                 ]
+            },
+            fallbackFlighted: {
+                type: 'component',
+                version: '1.2.3',
+                id: '00000000-0000-0000-0000-000000000000',
+                fallbackVersion: {
+                    version: '0.0.1',
+                    condition: {
+                        switchType: 'flight',
+                        id: 12345
+                    }
+                }
+            },
+            fallbackKillSwitched: {
+                type: 'component',
+                version: '1.2.3',
+                id: '00000000-0000-0000-0000-000000000000',
+                fallbackVersion: {
+                    version: '0.0.1',
+                    condition: {
+                        switchType: 'killswitch',
+                        id: '00000000-0000-0000-0000-000000000000'
+                    }
+                }
+            },
+            fallbackComplexExpression: {
+                type: 'component',
+                version: '1.2.3',
+                id: '00000000-0000-0000-0000-000000000000',
+                fallbackVersion: {
+                    version: '0.0.1',
+                    condition: {
+                        xor: [
+                            {
+                                or: [
+                                    {
+                                        switchType: 'flight',
+                                        id: 12345
+                                    },
+                                    {
+                                        not: {
+                                            switchType: 'killswitch',
+                                            id: '00000000-0000-0000-0000-000000000000'
+                                        }
+                                    }
+                                ]
+                            },
+                            {
+                                and: [
+                                    {
+                                        switchType: 'flight',
+                                        id: 67890
+                                    },
+                                    {
+                                        switchType: 'killswitch',
+                                        id: '11111111-1111-1111-1111-111111111111'
+                                    }
+                                ]
+                            }
+                        ]
+                    }
+                }
             }
         }
     },
@@ -347,4 +409,4 @@ const webpartManifest = {
 };
 export default webpartManifest;
 
-//#sourceMappingUrl=./webpart_1.manifest.js.map
+//# sourceMappingURL=./webpart_1.manifest.js.map

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

@@ -327,6 +327,68 @@ const webpartManifest = {
                 globalDependencies: [
                     'nonAmdB'
                 ]
+            },
+            fallbackFlighted: {
+                type: 'component',
+                version: '1.2.3',
+                id: '00000000-0000-0000-0000-000000000000',
+                fallbackVersion: {
+                    version: '0.0.1',
+                    condition: {
+                        switchType: 'flight',
+                        id: 12345
+                    }
+                }
+            },
+            fallbackKillSwitched: {
+                type: 'component',
+                version: '1.2.3',
+                id: '00000000-0000-0000-0000-000000000000',
+                fallbackVersion: {
+                    version: '0.0.1',
+                    condition: {
+                        switchType: 'killswitch',
+                        id: '00000000-0000-0000-0000-000000000000'
+                    }
+                }
+            },
+            fallbackComplexExpression: {
+                type: 'component',
+                version: '1.2.3',
+                id: '00000000-0000-0000-0000-000000000000',
+                fallbackVersion: {
+                    version: '0.0.1',
+                    condition: {
+                        xor: [
+                            {
+                                or: [
+                                    {
+                                        switchType: 'flight',
+                                        id: 12345
+                                    },
+                                    {
+                                        not: {
+                                            switchType: 'killswitch',
+                                            id: '00000000-0000-0000-0000-000000000000'
+                                        }
+                                    }
+                                ]
+                            },
+                            {
+                                and: [
+                                    {
+                                        switchType: 'flight',
+                                        id: 67890
+                                    },
+                                    {
+                                        switchType: 'killswitch',
+                                        id: '11111111-1111-1111-1111-111111111111'
+                                    }
+                                ]
+                            }
+                        ]
+                    }
+                }
             }
         }
     },
@@ -385,4 +447,4 @@ const webpartManifest = {
 };
 export default webpartManifest;
 
-//#sourceMappingUrl=./webpart_2.manifest.js.map
+//# sourceMappingURL=./webpart_2.manifest.js.map

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

@@ -105,7 +105,8 @@
                         "shouldNotPreload": { "$ref": "any-value.schema.json" },
                         "version": { "$ref": "any-value.schema.json" },
                         "id": { "$ref": "any-value.schema.json" },
-                        "failoverPath": { "$ref": "any-value.schema.json" }
+                        "failoverPath": { "$ref": "any-value.schema.json" },
+                        "fallbackVersion": { "$ref": "any-value.schema.json" }
                       },
                       "additionalProperties": false
                     },
@@ -145,6 +146,10 @@
                           "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"
+                        },
+
+                        "fallbackVersion": {
+                          "$ref": "component-fallback-version.schema.json"
                         }
                       },
                       "additionalProperties": true