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

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

@@ -0,0 +1,255 @@
+import type { IClientSideComponentManifest, ILocalizedString } from './IClientSideComponentManifest';
+/**
+ * This is the manifest for a PREFAB application.
+ *
+ * @alpha
+ */
+export interface IPrefabAppManifest extends IClientSideComponentManifest {
+    /**
+     * 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.
+     *
+     * @remarks
+     *
+     * Supported values: a dictionary of locale keys to strings. Should always have a 'default' key.
+     *
+     * Example: `"My Application"`
+     *
+     * ```
+     *          {
+     *            "default": "My Application"
+     *            "en-us": "My Application",
+     *            "fr-fr": "Ma demande",
+     *            "zh": "我的應用程式"
+     *          }
+     * ```
+     */
+    title: ILocalizedString;
+    /**
+     * 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.
+     *
+     * @remarks
+     *
+     * Supported values: a dictionary of locale keys to strings. Should always have a 'default' key.
+     *
+     * Examples:
+     *
+     * ```
+     * "An application for searching for things."
+     * ```
+     * or
+     * ```
+     *          {
+     *            "default": "An application for searching for things.",
+     *            "en-us": "An application for searching for things.",
+     *            "fr-fr": "Une demande pour la recherche de choses.",
+     *            "zh": "申請尋找的東西。"
+     *          }
+     * ```
+     */
+    description: ILocalizedString;
+    /**
+     * Specifies if there is a FCR (Finish Run Configuration) available for the app. True if no FCE is available.
+     */
+    isConfigured: boolean;
+    /**
+     * Describes how the PREFAB app can be installed: NewSite or ExistingSite. If omitted the app supports both.
+     */
+    appInstallationTypes?: Array<'NewSite' | 'ExistingSite'>;
+    /**
+     * Site Script actions.
+     *
+     * @remarks - See https://developer.microsoft.com/json-schemas/sp/site-design-script-actions.schema.json for a list of actions.
+     * - The `onInstall` actions will be run when the app is installed on a site.
+     * - The `onDemand` actions will not run automatically, but can be referenced by an App developer.
+     */
+    actions?: Record<string, PrefabAppSiteScript>;
+    /**
+     * Links to be rendered in the suite nav site settings menu for the PREFAB App.
+     */
+    siteSettingsLinks?: IPrefabAppSiteSettingsLink[];
+    /**
+     * Toolbox entries for the PREFAB app.
+     */
+    toolboxEntries?: IPrefabAppToolboxEntry[];
+}
+/**
+ * Available types of Site Scripts.
+ * - onInstall - Site Script that will be applied when the app is installed.
+ * - onDemand - Site Script that will be applied on demand by a PREFAB developer.
+ *
+ * @alpha
+ */
+export type SiteScriptType = 'onInstall' | 'onDemand';
+/**
+ * Base definition for Site Script.
+ *
+ * @alpha
+ */
+export interface IPrefabAppSiteScriptBase {
+    /**
+     * The type of the Site Script.
+     */
+    type: SiteScriptType;
+    /**
+     * Actions to run as part of the Site Script.
+     * @remarks - See https://developer.microsoft.com/json-schemas/sp/site-design-script-actions.schema.json for a list of actions.
+     */
+    actions: ISiteScriptActionBase[];
+}
+/**
+ * Site Script that will be applied when the app is installed.
+ *
+ * @alpha
+ */
+export interface IPrefabAppOnInstallSiteScript extends IPrefabAppSiteScriptBase {
+    /**
+     * The type of the Site Script - onInstall.
+     */
+    type: 'onInstall';
+}
+/**
+ * Site Script that will be applied by a PREFAB developer.
+ *
+ * @alpha
+ */
+export interface IPrefabAppOnDemandSiteScript extends IPrefabAppSiteScriptBase {
+    /**
+     * The type of the Site Script - onUpdate.
+     */
+    type: 'onDemand';
+}
+/**
+ * Site Script that will be applied when the app is installed or on demand by a PREFAB app developer.
+ *
+ * @alpha
+ */
+export type PrefabAppSiteScript = IPrefabAppOnInstallSiteScript | IPrefabAppOnDemandSiteScript;
+/**
+ * Base definition for Site Script action.
+ *
+ * @alpha
+ */
+export interface ISiteScriptActionBase {
+    verb: string;
+    [key: string]: any;
+}
+/**
+ * Represents an item that should be rendered in the suite nav site settings menu.
+ *
+ * @alpha
+ */
+export interface IPrefabAppSiteSettingsLink {
+    /**
+     * The unique identifier of the route to be rendered when the settings link is selected.
+     */
+    viewId: string;
+    /**
+     * Text of the link represented as a dictionary of locale keys to title values. This value will be displayed to the user in the suite nav site settings menu.
+     *
+     * @remarks
+     * This text should be used in the suite nav site settings menu.
+     *
+     * Supported values: a dictionary of locale keys to strings. Should always have a `'default'` key.
+     *
+     * Example: `"My App Settings"`
+     * ```
+     *          {
+     *            "default": "My App Settings",
+     *            "en-us": "My App Settings",
+     *            "fr-fr": "Mes paramètres d'application",
+     *            "zh": "我的應用程式設定"
+     *          }
+     * ```
+     *
+     */
+    text: ILocalizedString;
+}
+/**
+ * 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 interface IPrefabAppToolboxEntry {
+    /**
+     * The unique identifier of the route to be rendered if the entry is added to the page.
+     */
+    viewId: string;
+    /**
+     * Title of the PREFAB entry represented as a single a dictionary of locale keys to title values. This
+     * value will be displayed to the user in the toolbox.
+     *
+     * @remarks
+     * This title should be used in the Toolbox and other display areas.
+     *
+     * Usage: display the name of the PREFAB route in the toolbox, and the page.
+     *
+     * Supported values: a dictionary of locale keys to strings. Should always have a `'default'` key.
+     *
+     * Example: `"My PREFAB App"`
+     * ```
+     *          {
+     *            "default": "My PREFAB App"
+     *            "en-us": "My PREFAB App",
+     *            "fr-fr": "My PREFAB App",
+     *            "zh": "我的 PREFAB 應用程式"
+     *          }
+     * ```
+     */
+    title: ILocalizedString;
+    /**
+     * Description of the PREFAB entry represented as a dictionary of locale keys to description values. This
+     * value will be displayed to the user in the toolbox. This description should be used in the Toolbox tooltip and
+     * other display areas.
+     *
+     * @remarks
+     *
+     * Usage: display the description of the PREFAB route in the toolbox tooltip, and the page.
+     *
+     * Supported values: a dictionary of locale keys to strings. Should always have a `'default'` key.
+     *
+     * Example: `"A tool for displaying neat information."`
+     *
+     * ```
+     *          {
+     *            "default": "A tool for displaying neat information.",
+     *            "en-us": "A tool for displaying neat information.",
+     *            "fr-fr": "Un outil d'affichage des informations soignées.",
+     *            "zh": "用於顯示整潔資訊的工具。"
+     *          }
+     * ```
+     */
+    description: ILocalizedString;
+    /**
+     * The icon for the PREFAB entry, to be displayed in the toolbox, represented as a character name in the
+     * Office 365 icon font file.
+     *
+     * @remarks
+     * The icon font is specified here: {@link https://aka.ms/uifabric-icons}  If this field has
+     * a value, the {@link IPrefabAppToolboxEntry.iconImageUrl} field will be ignored.
+     *
+     * Supported values: Any character name in the Office 365 Icon Font.
+     *
+     * Example: "graph"
+     */
+    officeFabricIconFontName?: string;
+    /**
+     * The icon for the PREFAB app, to be displayed in the toolbox, represented as image URL. The image at the
+     * URL must be exactly 40x28 px (SPPPLAT VSO#218660 to fix the size of the icon image).
+     *
+     * @remarks
+     *  If the {@link IPrefabAppToolboxEntry.officeFabricIconFontName} field does not have a value,
+     *  this field must have a value. This value can be an absolute URL (e.g. `"http://example.com/icons/my-icon.png"`) or
+     *  a relative file path (e.g. `"./icons/my-icon.png"`). In the latter case, the path will be resolved relative to
+     *  the folder containing the input manifest. The icon file will be copied to the deployment folder like an asset,
+     *  and the output manifest's iconImageUrl will be replaced with a URL relative to the URL used to load all other
+     *  assets (the loaderConfig.internalModuleBaseUrls property).
+     *
+     * Supported values: Any absolute URL.
+     *
+     * Example: `"https://contoso.akamaihd.net/files/myPREFABIcon.png"`
+     */
+    iconImageUrl?: string;
+}
+//# sourceMappingURL=IPrefabAppManifest.d.ts.map

package/{lib-commonjs → lib-dts}/manifestSchemas/examples/application_1.manifest.d.ts

@@ -1,4 +1,4 @@
 import type { IClientSideApplicationManifest } from '../IClientSideApplicationManifest';
 declare const appManifest: IClientSideApplicationManifest;
-export = appManifest;
+export default appManifest;
 //# sourceMappingURL=application_1.manifest.d.ts.map

package/{lib-commonjs → lib-dts}/manifestSchemas/examples/application_2.manifest.d.ts

@@ -1,4 +1,4 @@
 import type { IClientSideApplicationManifest } from '../IClientSideApplicationManifest';
 declare const appManifest: IClientSideApplicationManifest;
-export = appManifest;
+export default appManifest;
 //# sourceMappingURL=application_2.manifest.d.ts.map

package/{lib-commonjs → lib-dts}/manifestSchemas/examples/application_3.manifest.d.ts

@@ -1,4 +1,4 @@
 import type { IClientSideApplicationManifest } from '../IClientSideApplicationManifest';
 declare const appManifest: IClientSideApplicationManifest;
-export = appManifest;
+export default appManifest;
 //# sourceMappingURL=application_3.manifest.d.ts.map

package/{lib-commonjs → lib-dts}/manifestSchemas/examples/assembly_1.manifest.d.ts

@@ -1,4 +1,4 @@
 import type { IClientSideAssemblyManifest } from '../IClientSideAssemblyManifest';
 declare const assemblyManifest: IClientSideAssemblyManifest;
-export = assemblyManifest;
+export default assemblyManifest;
 //# sourceMappingURL=assembly_1.manifest.d.ts.map

package/{lib-commonjs → lib-dts}/manifestSchemas/examples/commandSet_1.manifest.d.ts

@@ -1,4 +1,4 @@
 import type { ICommandSetExtensionManifest } from '../ICommandSetExtensionManifest';
 declare const extensionManifest: ICommandSetExtensionManifest;
-export = extensionManifest;
+export default extensionManifest;
 //# sourceMappingURL=commandSet_1.manifest.d.ts.map

package/{lib-commonjs → lib-dts}/manifestSchemas/examples/extension_1.manifest.d.ts

@@ -1,4 +1,4 @@
 import type { IClientSideExtensionManifest } from '../IClientSideExtensionManifest';
 declare const extensionManifest: IClientSideExtensionManifest;
-export = extensionManifest;
+export default extensionManifest;
 //# sourceMappingURL=extension_1.manifest.d.ts.map

package/{lib-commonjs → lib-dts}/manifestSchemas/examples/extension_2.manifest.d.ts

@@ -1,4 +1,4 @@
 import type { IClientSideExtensionManifest } from '../IClientSideExtensionManifest';
 declare const extensionManifest: IClientSideExtensionManifest;
-export = extensionManifest;
+export default extensionManifest;
 //# sourceMappingURL=extension_2.manifest.d.ts.map

package/{lib-commonjs → lib-dts}/manifestSchemas/examples/extension_3.manifest.d.ts

@@ -1,4 +1,4 @@
 import type { IClientSideExtensionManifest } from '../IClientSideExtensionManifest';
 declare const extensionManifest: IClientSideExtensionManifest;
-export = extensionManifest;
+export default extensionManifest;
 //# sourceMappingURL=extension_3.manifest.d.ts.map

package/{lib-commonjs → lib-dts}/manifestSchemas/examples/extension_4.manifest.d.ts

@@ -1,4 +1,4 @@
 import type { IClientSideExtensionManifest } from '../IClientSideExtensionManifest';
 declare const extensionManifest: IClientSideExtensionManifest;
-export = extensionManifest;
+export default extensionManifest;
 //# sourceMappingURL=extension_4.manifest.d.ts.map

package/{lib-commonjs → lib-dts}/manifestSchemas/examples/library_1.manifest.d.ts

@@ -1,4 +1,4 @@
 import type { IClientSideLibraryManifest } from '../IClientSideLibraryManifest';
 declare const libraryManifest: IClientSideLibraryManifest;
-export = libraryManifest;
+export default libraryManifest;
 //# sourceMappingURL=library_1.manifest.d.ts.map

package/{lib-commonjs → lib-dts}/manifestSchemas/examples/multi-version_1.manifest.d.ts

@@ -1,5 +1,5 @@
 import type { IClientSideMultiVersionManifest } from '../IClientSideMultiVersionManifest';
 import type { IClientSideLibraryManifest } from '../IClientSideLibraryManifest';
 declare const multiVersionManifest: IClientSideMultiVersionManifest<IClientSideLibraryManifest>;
-export = multiVersionManifest;
+export default multiVersionManifest;
 //# sourceMappingURL=multi-version_1.manifest.d.ts.map

package/{lib-commonjs → lib-dts}/manifestSchemas/examples/prefab_1.manifest.d.ts

@@ -1,4 +1,4 @@
 import type { IPrefabAppManifest } from '../IPrefabAppManifest';
 declare const prefabManifest: IPrefabAppManifest;
-export = prefabManifest;
+export default prefabManifest;
 //# sourceMappingURL=prefab_1.manifest.d.ts.map

package/{lib-commonjs → lib-dts}/manifestSchemas/examples/prefab_2.manifest.d.ts

@@ -1,4 +1,4 @@
 import type { IPrefabAppManifest } from '../IPrefabAppManifest';
 declare const prefabManifest: IPrefabAppManifest;
-export = prefabManifest;
+export default prefabManifest;
 //# sourceMappingURL=prefab_2.manifest.d.ts.map

package/{lib-commonjs → lib-dts}/manifestSchemas/examples/webpart_1.manifest.d.ts

@@ -1,4 +1,4 @@
 import type { IClientSideWebPartManifest } from '../IClientSideWebPartManifest';
 declare const webpartManifest: IClientSideWebPartManifest<any>;
-export = webpartManifest;
+export default webpartManifest;
 //# sourceMappingURL=webpart_1.manifest.d.ts.map

package/{lib-commonjs → lib-dts}/manifestSchemas/examples/webpart_2.manifest.d.ts

@@ -1,4 +1,4 @@
 import type { IClientSideWebPartManifest } from '../IClientSideWebPartManifest';
 declare const webpartManifest: IClientSideWebPartManifest<any>;
-export = webpartManifest;
+export default webpartManifest;
 //# sourceMappingURL=webpart_2.manifest.d.ts.map

package/{dist → lib-dts}/tsdoc-metadata.json

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

package/lib-esm/index.js

@@ -0,0 +1,15 @@
+export * from './manifestSchemas/IClientSideApplicationManifest';
+export * from './manifestSchemas/IClientSideAssemblyManifest';
+export * from './manifestSchemas/IClientSideComponentLoaderConfiguration';
+export * from './manifestSchemas/IClientSideComponentManifest';
+export * from './manifestSchemas/IClientSideExtensionManifest';
+export * from './manifestSchemas/IClientSideLibraryManifest';
+export * from './manifestSchemas/IClientSideManifestBase';
+export * from './manifestSchemas/IClientSideMultiVersionManifest';
+export * from './manifestSchemas/IClientSideWebPartManifest';
+export * from './manifestSchemas/ICommandSetExtensionManifest';
+export * from './manifestSchemas/ManifestType';
+export * from './manifestSchemas/IAdaptiveCardExtensionManifest';
+export * from './manifestSchemas/IPrefabAppManifest';
+
+//#sourceMappingUrl=./index.js.map

package/lib-esm/manifestHelpers.js

@@ -0,0 +1,21 @@
+/**
+ * Identifies if a component manifest is a multi-version manifest.
+ * @param manifest - The manifest for a component, which may have multiple versions
+ * @returns If the manifest has multiple versions
+ */ export function isMultiVersionManifest(manifest) {
+    return !!manifest.versions;
+}
+/**
+ * @param config - The module loader configuration for the module.
+ * @returns If the module loads as a localized path.
+ */ export function isLocalizedPath(config) {
+    return config.type === 'localizedPath';
+}
+/**
+ * @param config - The module loader configuration for the module.
+ * @returns If the module loads as a non-localized path.
+ */ export function isPath(config) {
+    return config.type === 'path';
+}
+
+//#sourceMappingUrl=./manifestHelpers.js.map

package/lib-esm/manifestSchemaValidator.js

@@ -0,0 +1,135 @@
+import ZSchema from 'z-schema';
+import { FileSystem } from '@rushstack/node-core-library';
+// Discover the schema files
+const schemasDirectory = `${__dirname}/manifestSchemas/jsonSchemas`;
+const schemaFiles = FileSystem.readFolderItemNames(schemasDirectory);
+const schemas = schemaFiles.map((schemaFile)=>require(`${schemasDirectory}/${schemaFile}`));
+import manifestSchema from './manifestSchemas/jsonSchemas/client-side-component-manifest.schema.json';
+import applicationSchema from './manifestSchemas/jsonSchemas/client-side-application-manifest.schema.json';
+import prefabAppSchema from './manifestSchemas/jsonSchemas/prefab-app-manifest.schema.json';
+import webPartSchema from './manifestSchemas/jsonSchemas/client-side-web-part-manifest.schema.json';
+import commandSetSchema from './manifestSchemas/jsonSchemas/command-set-extension-manifest.schema.json';
+import extensionSchema from './manifestSchemas/jsonSchemas/client-side-extension-manifest.schema.json';
+import librarySchema from './manifestSchemas/jsonSchemas/client-side-library-manifest.schema.json';
+import assemblySchema from './manifestSchemas/jsonSchemas/client-side-assembly-manifest.schema.json';
+import multiVersionSchema from './manifestSchemas/jsonSchemas/client-side-multi-version-manifest.schema.json';
+// local copy of site scripts schema and draft-07 schema
+import siteScriptsSchema from './manifestSchemas/remote/site-design-script-actions.schema.json';
+import draft04Schema from './manifestSchemas/remote/draft-04.schema.json';
+const SITE_SCRIPTS_SCHEMA_URL = 'https://developer.microsoft.com/json-schemas/sp/site-design-script-actions.schema.json';
+const DRAFT_07_SCHEMA_URL = 'http://json-schema.org/draft-07/schema#';
+const siteScriptsSchemaPromise = fetch(SITE_SCRIPTS_SCHEMA_URL).then((response)=>{
+    return response.text();
+}).catch((error)=>{
+    // eslint-disable-next-line no-console
+    console.error(`Failed to fetch remote schema: ${error}`);
+    // fallback to local copy
+    return JSON.stringify(siteScriptsSchema);
+});
+export const zSchemaOptions = {
+    breakOnFirstError: true,
+    forceAdditional: true,
+    forceItems: true,
+    forceMaxLength: false,
+    forceProperties: false,
+    noExtraKeywords: true,
+    noTypeless: true,
+    noEmptyStrings: true
+};
+const schemaValidator = new ZSchema(zSchemaOptions);
+const draft07ValidationOptions = {
+    strictMode: false,
+    ignoreUnresolvableReferences: true,
+    ignoreUnknownFormats: true
+};
+//
+// this one is needed for the site scripts reference.
+// We're faking draft-07 schema with draft-04 schema as z-schema doesn't support draft-07
+//
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+schemaValidator.setRemoteReference(DRAFT_07_SCHEMA_URL, draft04Schema, draft07ValidationOptions);
+siteScriptsSchemaPromise.then((remoteSchema)=>{
+    // ZSchema typedef doesn't contain setRemoteReference method. But it does exist in the implementation and referenced in the documentation.
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    schemaValidator.setRemoteReference(SITE_SCRIPTS_SCHEMA_URL, JSON.parse(remoteSchema), {
+        strictMode: false,
+        ignoreUnresolvableReferences: true
+    });
+    schemaValidator.validateSchema(schemas);
+}).catch((error)=>{
+// swallowing the error here
+});
+class ManifestValidator {
+    static registerRemoteSchemaReferences() {
+        return siteScriptsSchemaPromise.then(()=>{
+        // no-op;
+        }).catch(()=>{
+        // no-op;
+        });
+    }
+    static validateApplicationManifest(manifest) {
+        return ManifestValidator._validateManifest(manifest, applicationSchema);
+    }
+    static validatePrefabAppManifest(manifest) {
+        return ManifestValidator._validateManifest(manifest, prefabAppSchema);
+    }
+    static validateCommandSetManifest(manifest) {
+        return ManifestValidator._validateManifest(manifest, commandSetSchema);
+    }
+    static validateExtensionManifest(manifest) {
+        return ManifestValidator._validateManifest(manifest, extensionSchema);
+    }
+    static validateWebPartManifest(// eslint-disable-next-line @typescript-eslint/no-explicit-any
+    manifest) {
+        return ManifestValidator._validateManifest(manifest, webPartSchema);
+    }
+    static validateLibraryManifest(manifest) {
+        return ManifestValidator._validateManifest(manifest, librarySchema);
+    }
+    static validateAssemblyManifest(manifest) {
+        return ManifestValidator._validateManifest(manifest, assemblySchema);
+    }
+    static validateMultiVersionManifest(// eslint-disable-next-line @typescript-eslint/no-explicit-any
+    manifest) {
+        return ManifestValidator._validateManifest(manifest, multiVersionSchema);
+    }
+    static validateManifest(manifest) {
+        return ManifestValidator._validateManifest(manifest, manifestSchema);
+    }
+    static extractInnerErrorMessages(errors) {
+        const printZSchemaError = (error)=>{
+            let innerErrors = [];
+            (error.inner || []).forEach((innerErr)=>{
+                innerErrors = innerErrors.concat(printZSchemaError(innerErr));
+            });
+            return [
+                `(${error.path}) ${error.message}`
+            ].concat(innerErrors);
+        };
+        let errorList = [];
+        errors.map((error)=>{
+            errorList = errorList.concat(printZSchemaError(error));
+        });
+        return errorList;
+    }
+    static getFormattedErrorMessage(errors) {
+        return this.extractInnerErrorMessages(errors).join('\n');
+    }
+    static _validateManifest(// eslint-disable-next-line @typescript-eslint/no-explicit-any
+    manifest, schema) {
+        if (!schema) {
+            throw new Error('Unable to find the manifest schema.');
+        }
+        if (typeof manifest === 'string') {
+            manifest = JSON.parse(manifest);
+        }
+        const result = schemaValidator.validate(manifest, schema);
+        return {
+            result: result,
+            errors: schemaValidator.getLastErrors() || []
+        };
+    }
+}
+export { ManifestValidator as default };
+
+//#sourceMappingUrl=./manifestSchemaValidator.js.map

package/lib-esm/manifestSchemas/IAdaptiveCardExtensionManifest.js

@@ -0,0 +1,9 @@
+/**
+ * This interface specifies the set of properties that can be pre-configured by a AdaptiveCardExtension developer. Each
+ * pre-configured instance of the AdaptiveCardExtension will need a copy of these properties. Organization admins and
+ * content authors can modify these properties on a need basis.
+ *
+ * @beta
+ */ export { };
+
+//#sourceMappingUrl=./IAdaptiveCardExtensionManifest.js.map

package/lib-esm/manifestSchemas/IClientSideApplicationManifest.js

@@ -0,0 +1,5 @@
+/**
+ * @alpha
+ */ export { };
+
+//#sourceMappingUrl=./IClientSideApplicationManifest.js.map

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