piral-core 1.6.2-beta.7421 → 1.6.2-beta.7472

package/lib/components/Mediator.js

@@ -6,13 +6,17 @@ import { none } from '../utils';
  * The Mediator component for interfacing with pilets loading.
  */
 export const Mediator = ({ options }) => {
-    const { initialize, readState } = useGlobalStateContext();
+    const { initialize, readState, emit } = useGlobalStateContext();
     React.useEffect(() => {
-        const shouldLoad = readState(s => s.app.loading);
+        const shouldLoad = readState((s) => s.app.loading);
         if (shouldLoad) {
             const { connect, disconnect } = startLoadingPilets(options);
+            emit('loading-pilets', { options });
             const notifier = (error, pilets, loaded) => {
                 initialize(!loaded, error, pilets);
+                if (loaded) {
+                    emit('loaded-pilets', { pilets, error });
+                }
             };
             connect(notifier);
             return () => disconnect(notifier);

package/lib/components/Mediator.js.map

@@ -1 +1 @@
-{"version":3,"file":"Mediator.js","sourceRoot":"","sources":["../../src/components/Mediator.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAqB,kBAAkB,EAAiB,MAAM,YAAY,CAAC;AAClF,OAAO,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAC;AACjD,OAAO,EAAE,IAAI,EAAE,MAAM,UAAU,CAAC;AAYhC;;GAEG;AACH,MAAM,CAAC,MAAM,QAAQ,GAA4B,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE;IAC/D,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,GAAG,qBAAqB,EAAE,CAAC;IAE1D,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,MAAM,UAAU,GAAG,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAEjD,IAAI,UAAU,EAAE;YACd,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAC;YAC5D,MAAM,QAAQ,GAAkB,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE;gBACxD,UAAU,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;YACrC,CAAC,CAAC;YACF,OAAO,CAAC,QAAQ,CAAC,CAAC;YAClB,OAAO,GAAG,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;SACnC;IAEH,CAAC,EAAE,IAAI,CAAC,CAAC;IAET,2CAA2C;IAC3C,OAAO,IAAI,CAAC;AACd,CAAC,CAAC"}
+{"version":3,"file":"Mediator.js","sourceRoot":"","sources":["../../src/components/Mediator.tsx"],"names":[],"mappings":"AAAA,OAAO,KAAK,KAAK,MAAM,OAAO,CAAC;AAC/B,OAAO,EAAqB,kBAAkB,EAAiB,MAAM,YAAY,CAAC;AAClF,OAAO,EAAE,qBAAqB,EAAE,MAAM,UAAU,CAAC;AACjD,OAAO,EAAE,IAAI,EAAE,MAAM,UAAU,CAAC;AAYhC;;GAEG;AACH,MAAM,CAAC,MAAM,QAAQ,GAA4B,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE;IAC/D,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,IAAI,EAAE,GAAG,qBAAqB,EAAE,CAAC;IAEhE,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE;QACnB,MAAM,UAAU,GAAG,SAAS,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAEnD,IAAI,UAAU,EAAE;YACd,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAC;YAE5D,IAAI,CAAC,gBAAgB,EAAE,EAAE,OAAO,EAAE,CAAC,CAAC;YAEpC,MAAM,QAAQ,GAAkB,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE;gBACxD,UAAU,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC;gBAEnC,IAAI,MAAM,EAAE;oBACV,IAAI,CAAC,eAAe,EAAE,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC;iBAC1C;YACH,CAAC,CAAC;YACF,OAAO,CAAC,QAAQ,CAAC,CAAC;YAClB,OAAO,GAAG,EAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,CAAC;SACnC;IACH,CAAC,EAAE,IAAI,CAAC,CAAC;IAET,2CAA2C;IAC3C,OAAO,IAAI,CAAC;AACd,CAAC,CAAC"}

package/lib/types/utils.d.ts

@@ -1,3 +1,4 @@
+import type { Pilet, LoadPiletsOptions } from 'piral-base';
 import type { PiralCustomEventMap } from './custom';
 /**
  * A key value store that can be abstracted onto a storage solution (e.g. cookie).
@@ -76,9 +77,33 @@ export interface PiralUnhandledErrorEvent {
      */
     pilet: string;
 }
+/**
+ * Gets fired when all pilets have been loaded.
+ */
+export interface PiralLoadedPiletsEvent {
+    /**
+     * The pilets that have been loaded.
+     */
+    pilets: Array<Pilet>;
+    /**
+     * The loading error, if any.
+     */
+    error?: Error;
+}
+/**
+ * Gets fired when the loading of pilets is triggered.
+ */
+export interface PiralLoadingPiletsEvent {
+    /**
+     * The options that have been supplied for loading the pilets.
+     */
+    options: LoadPiletsOptions;
+}
 declare module 'piral-base/lib/types/api' {
     interface PiralEventMap extends PiralCustomEventMap {
         'store-data': PiralStoreDataEvent;
         'unhandled-error': PiralUnhandledErrorEvent;
+        'loading-pilets': PiralLoadingPiletsEvent;
+        'loaded-pilets': PiralLoadedPiletsEvent;
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "piral-core",
-  "version": "1.6.2-beta.7421",
+  "version": "1.6.2-beta.7472",
   "description": "The core library for creating a Piral instance.",
   "keywords": [
     "portal",
@@ -61,8 +61,8 @@
     "test": "echo \"Error: run tests from root\" && exit 1"
   },
   "dependencies": {
-    "piral-base": "1.6.2-beta.7421",
-    "piral-debug-utils": "1.6.2-beta.7421",
+    "piral-base": "1.6.2-beta.7472",
+    "piral-debug-utils": "1.6.2-beta.7472",
     "zustand": "^3.0.0"
   },
   "devDependencies": {
@@ -82,5 +82,5 @@
     "react-router-dom",
     "tslib"
   ],
-  "gitHead": "a225faea9c8d36d92ac81066ebb40db97a65fd34"
+  "gitHead": "3dd0674c8a6af8b5e1ab66fed6813ee7565f0ed9"
 }

package/src/components/Mediator.tsx

@@ -17,20 +17,26 @@ export interface MediatorProps {
  * The Mediator component for interfacing with pilets loading.
  */
 export const Mediator: React.FC<MediatorProps> = ({ options }) => {
-  const { initialize, readState } = useGlobalStateContext();
+  const { initialize, readState, emit } = useGlobalStateContext();
 
   React.useEffect(() => {
-    const shouldLoad = readState(s => s.app.loading);
+    const shouldLoad = readState((s) => s.app.loading);
 
     if (shouldLoad) {
       const { connect, disconnect } = startLoadingPilets(options);
+
+      emit('loading-pilets', { options });
+
       const notifier: PiletsLoading = (error, pilets, loaded) => {
         initialize(!loaded, error, pilets);
+
+        if (loaded) {
+          emit('loaded-pilets', { pilets, error });
+        }
       };
       connect(notifier);
       return () => disconnect(notifier);
     }
-
   }, none);
 
   // tslint:disable-next-line:no-null-keyword

package/src/types/utils.ts

@@ -1,4 +1,4 @@
-import type {} from 'piral-base';
+import type { Pilet, LoadPiletsOptions } from 'piral-base';
 import type { PiralCustomEventMap } from './custom';
 
 /**
@@ -82,9 +82,35 @@ export interface PiralUnhandledErrorEvent {
   pilet: string;
 }
 
+/**
+ * Gets fired when all pilets have been loaded.
+ */
+export interface PiralLoadedPiletsEvent {
+  /**
+   * The pilets that have been loaded.
+   */
+  pilets: Array<Pilet>;
+  /**
+   * The loading error, if any.
+   */
+  error?: Error;
+}
+
+/**
+ * Gets fired when the loading of pilets is triggered.
+ */
+export interface PiralLoadingPiletsEvent {
+  /**
+   * The options that have been supplied for loading the pilets.
+   */
+  options: LoadPiletsOptions;
+}
+
 declare module 'piral-base/lib/types/api' {
   interface PiralEventMap extends PiralCustomEventMap {
     'store-data': PiralStoreDataEvent;
     'unhandled-error': PiralUnhandledErrorEvent;
+    'loading-pilets': PiralLoadingPiletsEvent;
+    'loaded-pilets': PiralLoadedPiletsEvent;
   }
 }