@spfx-extensions/package 1.6.2 → 1.6.5

package/src/extensions/spfxExtension/SpfxExtensionApplicationCustomizer.ts

@@ -1,70 +1,70 @@
-import {
-  BaseApplicationCustomizer,
-  PlaceholderProvider
-} from '@microsoft/sp-application-base';
-import { SPFXPREFIX } from '../../utilities/constants';
-//import * as strings from 'SpfxExtensionApplicationCustomizerStrings';
-
-/**
- * If your command set uses the ClientSideComponentProperties JSON input,
- * it will be deserialized into the BaseExtension.properties object.
- * You can define an interface to describe it.
- */
-export interface ISpfxExtensionApplicationCustomizerProperties {
-  // This is an example; replace with your own property
-  _noProps: boolean;
-}
-
-/** A Custom Action which can be run during execution of a Client Side Application */
-export default class SpfxExtensionApplicationCustomizer
-  extends BaseApplicationCustomizer<ISpfxExtensionApplicationCustomizerProperties> {
-
-  corePromise = new Promise((resolve) => {
-    import(/* webpackChunkName: "spfx-extension-loader" */"../../services/initCoreService").then(({ initCore, registerPlaceHolderProvider }) => {
-      initCore("SharePoint").then(() => {
-        registerPlaceHolderProvider(this.context.placeholderProvider, this);
-        resolve(true);
-      }).catch((e) => {
-        console.error(SPFXPREFIX, "Error while initializing core from application customizer", e);
-      })
-    }).catch((e) => {
-      console.error(SPFXPREFIX, "Error while importing core from application customizer", e);
-    })
-  });
-
-
-  // private async ensureCoreAndRegister() {
-  //   const { initCore, registerPlaceHolderProvider } = await import(/* webpackChunkName: "spfx-extension-loader" */"../../services/initCoreService");
-  //   await initCore("SharePoint");
-  //   registerPlaceHolderProvider(this.context.placeholderProvider, this);
-  // }
-
-  public async onInit(): Promise<void> {
-    await this.corePromise;
-  }
-
-  waitAndNotifyPlaceholderChanged(placeholderProvider: PlaceholderProvider) {
-    this.corePromise!.then(() => {
-      window.__SPFxExtensions.Apps.forEach((app) => {
-        app.instances.forEach((instance) => {
-          instance.executeListeners("onPlaceholdersChanged", placeholderProvider)
-        });
-      });
-    }).catch(() => {
-      //swallow
-    });
-  }
-
-  protected onPlaceholdersChanged(placeholderProvider: PlaceholderProvider) {
-    // this fires before onInit
-    this.waitAndNotifyPlaceholderChanged(placeholderProvider);
-  }
-
-  protected onDispose(): void {
-    window.__SPFxExtensions?.Apps?.forEach((app) => {
-      app.instances.forEach((instance) => {
-        instance.executeListeners("onAppCustomizerDisposed", undefined);
-      });
-    });
-  }
-}
+import {
+  BaseApplicationCustomizer,
+  PlaceholderProvider
+} from '@microsoft/sp-application-base';
+import { SPFXPREFIX } from '../../utilities/constants';
+//import * as strings from 'SpfxExtensionApplicationCustomizerStrings';
+
+/**
+ * If your command set uses the ClientSideComponentProperties JSON input,
+ * it will be deserialized into the BaseExtension.properties object.
+ * You can define an interface to describe it.
+ */
+export interface ISpfxExtensionApplicationCustomizerProperties {
+  // This is an example; replace with your own property
+  _noProps: boolean;
+}
+
+/** A Custom Action which can be run during execution of a Client Side Application */
+export default class SpfxExtensionApplicationCustomizer
+  extends BaseApplicationCustomizer<ISpfxExtensionApplicationCustomizerProperties> {
+
+  corePromise = new Promise((resolve) => {
+    import(/* webpackChunkName: "spfx-extensions-loader" */"../../services/initCoreService").then(({ initCore, registerPlaceHolderProvider }) => {
+      initCore("SharePoint").then(() => {
+        registerPlaceHolderProvider(this.context.placeholderProvider, this);
+        resolve(true);
+      }).catch((e) => {
+        console.error(SPFXPREFIX, "Error while initializing core from application customizer", e);
+      })
+    }).catch((e) => {
+      console.error(SPFXPREFIX, "Error while importing core from application customizer", e);
+    })
+  });
+
+
+  // private async ensureCoreAndRegister() {
+  //   const { initCore, registerPlaceHolderProvider } = await import(/* webpackChunkName: "spfx-extension-loader" */"../../services/initCoreService");
+  //   await initCore("SharePoint");
+  //   registerPlaceHolderProvider(this.context.placeholderProvider, this);
+  // }
+
+  public async onInit(): Promise<void> {
+    await this.corePromise;
+  }
+
+  waitAndNotifyPlaceholderChanged(placeholderProvider: PlaceholderProvider) {
+    this.corePromise!.then(() => {
+      window.__SPFxExtensions.Apps.forEach((app) => {
+        app.instances.forEach((instance) => {
+          instance.executeListeners("onPlaceholdersChanged", placeholderProvider)
+        });
+      });
+    }).catch(() => {
+      //swallow
+    });
+  }
+
+  protected onPlaceholdersChanged(placeholderProvider: PlaceholderProvider) {
+    // this fires before onInit
+    this.waitAndNotifyPlaceholderChanged(placeholderProvider);
+  }
+
+  protected onDispose(): void {
+    window.__SPFxExtensions?.Apps?.forEach((app) => {
+      app.instances.forEach((instance) => {
+        instance.executeListeners("onAppCustomizerDisposed", undefined);
+      });
+    });
+  }
+}

package/src/extensions/spfxExtension/loc/en-us.js

@@ -1,5 +1,5 @@
-define([], function() {
-  return {
-    "Title": "SpfxExtensionApplicationCustomizer"
-  }
+define([], function() {
+  return {
+    "Title": "SpfxExtensionApplicationCustomizer"
+  }
 });

package/src/extensions/spfxExtension/loc/myStrings.d.ts

@@ -1,8 +1,8 @@
-declare interface ISpfxExtensionApplicationCustomizerStrings {
-  Title: string;
-}
-
-declare module 'SpfxExtensionApplicationCustomizerStrings' {
-  const strings: ISpfxExtensionApplicationCustomizerStrings;
-  export = strings;
-}
+declare interface ISpfxExtensionApplicationCustomizerStrings {
+  Title: string;
+}
+
+declare module 'SpfxExtensionApplicationCustomizerStrings' {
+  const strings: ISpfxExtensionApplicationCustomizerStrings;
+  export = strings;
+}

package/src/index.ts

@@ -1 +1 @@
-// A file is required to be in the root of the /src directory by the TypeScript compiler
+// A file is required to be in the root of the /src directory by the TypeScript compiler

package/src/services/initCoreService.ts

@@ -1,60 +1,68 @@
-import {
-  CompatibleEnvironmentType,
-} from "@spfx-extensions/core";
-import { PlaceholderProvider } from "@microsoft/sp-application-base";
-import { ISPEventObserver } from "@microsoft/sp-core-library";
-import { SPFXPREFIX } from "../utilities/constants";
-import { loadCoreForSPFxOrClassic } from "@spfx-extensions/core/spfxLoader"
-import coreUrl from "__spfxCore.js";
-import configuratorUrl from "__spfxCoreConfigurator.js";
-import wrapperUrl from "__spfxWrapperClassic.js";
-
-let placeHolderResolved = false;
-
-async function getSuggestedCoreUrl() {
-  return Promise.resolve({ coreUrl, configuratorUrl, wrapperUrl });
-}
-
-/**
- * WILL FAIL IF CALLED BEFORE `initCore`
- * 
- * Registers a placeholder provider to be used by the core library
- * @returns void
- */
-export function registerPlaceHolderProvider(placeHolderProvider: PlaceholderProvider, eventObserver: ISPEventObserver) {
-  //resolve once, i.e. modern webpart was loaded before app customizer
-  if (!placeHolderResolved) {
-    placeHolderResolved = true;
-    window.__SPFxExtensions.Utils.placeHolderResolver({
-      //eslint-disable-next-line @typescript-eslint/no-explicit-any
-      placeHolderProvider: placeHolderProvider as any,
-      //eslint-disable-next-line @typescript-eslint/no-explicit-any
-      eventObserver: eventObserver as any,
-    });
-  }
-}
-
-
-export async function initCore(
-  envType: CompatibleEnvironmentType,
-) {
-  if (window.__SPFxExtensions?.__CoreInitializationPromise) {
-    //only repopulate if these were not initialized through modern context
-    if (window.__SPFxExtensions.Utils && !window.__SPFxExtensions.Utils.initializedThroughSPFX) {
-      window.__SPFxExtensions.Utils.environmentType = envType;
-      window.__SPFxExtensions.Utils.initializedThroughSPFX = true;
-    }
-    return window.__SPFxExtensions.__CoreInitializationPromise;
-  }
-
-  const { promise, resolve } = Promise.withResolvers<void>();
-  //eslint-disable-next-line @typescript-eslint/no-explicit-any
-  (window.__SPFxExtensions as any) = {
-    __CoreInitializationPromise: promise,
-    __CoreInitializationResolver: resolve
-  }
-  const buildDate = BUILD_DATE;
-  console.info(SPFXPREFIX, "Initializing Core from SPFx Built:", buildDate);
-  await loadCoreForSPFxOrClassic(getSuggestedCoreUrl, envType, true);
-  window.__SPFxExtensions.__CoreInitializationResolver();
-}
+import { CompatibleEnvironmentType } from "@spfx-extensions/core";
+import { PlaceholderProvider } from "@microsoft/sp-application-base";
+import { ISPEventObserver } from "@microsoft/sp-core-library";
+import { SPFXPREFIX } from "../utilities/constants";
+import { loadCoreForSPFxOrClassic } from "@spfx-extensions/core/spfx-extensions-loader";
+import coreUrl from "@spfx-extensions/core/spfx-extensions-core";
+import configuratorUrl from "@spfx-extensions/core/spfx-extensions-coreconfigurator";
+import wrapperUrl from "@spfx-extensions/core/spfx-extensions-classicwrapper";
+import customActionUrl from "@spfx-extensions/core/spfx-extensions-classiccustomaction";
+
+let placeHolderResolved = false;
+
+async function getSuggestedCoreUrl() {
+  // return Promise.resolve({ coreUrl, configuratorUrl, wrapperUrl });
+  return Promise.resolve({
+    coreUrl: coreUrl as string,
+    configuratorUrl: configuratorUrl as unknown as string,
+    wrapperUrl: wrapperUrl as unknown as string,
+    customActionUrl: customActionUrl as unknown as string,
+  });
+}
+
+/**
+ * WILL FAIL IF CALLED BEFORE `initCore`
+ *
+ * Registers a placeholder provider to be used by the core library
+ * @returns void
+ */
+export function registerPlaceHolderProvider(
+  placeHolderProvider: PlaceholderProvider,
+  eventObserver: ISPEventObserver,
+) {
+  //resolve once, i.e. modern webpart was loaded before app customizer
+  if (!placeHolderResolved) {
+    placeHolderResolved = true;
+    window.__SPFxExtensions.Utils.placeHolderResolver({
+      //eslint-disable-next-line @typescript-eslint/no-explicit-any
+      placeHolderProvider: placeHolderProvider as any,
+      //eslint-disable-next-line @typescript-eslint/no-explicit-any
+      eventObserver: eventObserver as any,
+    });
+  }
+}
+
+export async function initCore(envType: CompatibleEnvironmentType) {
+  if (window.__SPFxExtensions?.__CoreInitializationPromise) {
+    //only repopulate if these were not initialized through modern context
+    if (
+      window.__SPFxExtensions.Utils &&
+      !window.__SPFxExtensions.Utils.initializedThroughSPFX
+    ) {
+      window.__SPFxExtensions.Utils.environmentType = envType;
+      window.__SPFxExtensions.Utils.initializedThroughSPFX = true;
+    }
+    return window.__SPFxExtensions.__CoreInitializationPromise;
+  }
+
+  const { promise, resolve } = Promise.withResolvers<void>();
+  //eslint-disable-next-line @typescript-eslint/no-explicit-any
+  (window.__SPFxExtensions as any) = {
+    __CoreInitializationPromise: promise,
+    __CoreInitializationResolver: resolve,
+  };
+  const buildDate = BUILD_DATE;
+  console.info(SPFXPREFIX, "Initializing Core from SPFx Built:", buildDate);
+  await loadCoreForSPFxOrClassic(getSuggestedCoreUrl, envType, true);
+  window.__SPFxExtensions.__CoreInitializationResolver();
+}

package/src/utilities/constants.ts

@@ -1,4 +1,4 @@
-export const SELECT_WEBPART = "Select one of these web parts for this column.";
-export const EDIT_PAGE_AND_SELECT_WEBPART = "Edit page and select webpart.";
-export const APP_BUTTON_LABEL = "Webpart that loads an app of your choice.";
+export const SELECT_WEBPART = "Select one of these web parts for this column.";
+export const EDIT_PAGE_AND_SELECT_WEBPART = "Edit page and select webpart.";
+export const APP_BUTTON_LABEL = "Webpart that loads an app of your choice.";
 export const SPFXPREFIX = "[SPFxExtensions]";

package/src/webparts/spfxExtensionloader/SpfxExtensionloaderWebPart.manifest.json

@@ -1,35 +1,35 @@
-{
-  "$schema": "https://developer.microsoft.com/json-schemas/spfx/client-side-web-part-manifest.schema.json",
-  "id": "d6ca1fc2-0591-4c6d-8a25-cae3262c017b",
-  "alias": "SpfxExtensionloaderWebPart",
-  "componentType": "WebPart",
-  "version": "*",
-  "manifestVersion": 2,
-  "requiresCustomScript": false,
-  "supportedHosts": [
-    "SharePointWebPart",
-    "TeamsPersonalApp",
-    "TeamsTab",
-    "SharePointFullPage"
-  ],
-  "supportsThemeVariants": true,
-  "supportsFullBleed": true,
-  "preconfiguredEntries": [
-    {
-      "groupId": "5c03119e-3074-46fd-976b-c60198311f70",
-      "group": {
-        "default": "Advanced"
-      },
-      "title": {
-        "default": "SPFx Extension Loader"
-      },
-      "description": {
-        "default": "Allows you to add a custom developed app"
-      },
-      "officeFabricIconFontName": "Page",
-      "properties": {
-        "description": "Select an app to load from the dropdown below"
-      }
-    }
-  ]
+{
+  "$schema": "https://developer.microsoft.com/json-schemas/spfx/client-side-web-part-manifest.schema.json",
+  "id": "d6ca1fc2-0591-4c6d-8a25-cae3262c017b",
+  "alias": "SpfxExtensionloaderWebPart",
+  "componentType": "WebPart",
+  "version": "*",
+  "manifestVersion": 2,
+  "requiresCustomScript": false,
+  "supportedHosts": [
+    "SharePointWebPart",
+    "TeamsPersonalApp",
+    "TeamsTab",
+    "SharePointFullPage"
+  ],
+  "supportsThemeVariants": true,
+  "supportsFullBleed": true,
+  "preconfiguredEntries": [
+    {
+      "groupId": "5c03119e-3074-46fd-976b-c60198311f70",
+      "group": {
+        "default": "Advanced"
+      },
+      "title": {
+        "default": "SPFx Extension Loader"
+      },
+      "description": {
+        "default": "Allows you to add a custom developed app"
+      },
+      "officeFabricIconFontName": "Page",
+      "properties": {
+        "description": "Select an app to load from the dropdown below"
+      }
+    }
+  ]
 }