@squide/firefly 11.0.0 → 12.0.1

package/src/useCanFetchProtectedData.ts

@@ -1,4 +1,25 @@
 import { useAppRouterState } from "./AppRouterContext.ts";
+import type { ActiveRouteVisiblity } from "./AppRouterReducer.ts";
+
+// This function is exported for external integration, like the integration
+// with the Platform Widgets. Do not remove.
+export function canFetchProtectedData(
+    waitForMsw: boolean,
+    areModulesRegistered: boolean,
+    areModulesReady: boolean,
+    activeRouteVisibility: ActiveRouteVisiblity,
+    isMswReady: boolean
+) {
+    return (
+        // Wait until the modules has been registered, but do not wait for the deferred registrations to be registered as they will probably
+        // depends on the protected data.
+        (areModulesRegistered || areModulesReady)
+        // Only fetch the protected data for protected routes, aka do not fetch the protected data for public routes.
+        && activeRouteVisibility === "protected"
+        // Wait for MSW since the endpoints for the protected data might be an MSW endpoint when in development.
+        && (!waitForMsw || isMswReady)
+    );
+}
 
 export function useCanFetchProtectedData() {
     const {
@@ -10,17 +31,12 @@ export function useCanFetchProtectedData() {
         activeRouteVisibility
     } = useAppRouterState();
 
-    return (
-        // Always return true when the protected data has already been fetched sucessfully so TanStack Query can update the data in the background.
-        isProtectedDataReady
-        || (
-            // Wait until the modules has been registered, but do not wait for the deferred registrations to be registered as they will probably
-            // depends on the protected data.
-            (areModulesRegistered || areModulesReady)
-            // Only fetch the protected data for protected routes, aka do not fetch the protected data for public routes.
-            && activeRouteVisibility === "protected"
-            // Wait for MSW since the endpoints for the protected data might be an MSW endpoint when in development.
-            && (!waitForMsw || isMswReady)
-        )
+    // Always return true when the protected data has already been fetched sucessfully so TanStack Query can update the data in the background.
+    return isProtectedDataReady || canFetchProtectedData(
+        waitForMsw,
+        areModulesRegistered,
+        areModulesReady,
+        activeRouteVisibility,
+        isMswReady
     );
 }

package/dist/boostrap.d.ts

@@ -1,14 +0,0 @@
-import { type ModuleRegisterFunction, type RegisterModulesOptions } from "@squide/core";
-import { type RemoteDefinition } from "@squide/module-federation";
-import type { FireflyRuntime } from "./FireflyRuntime.tsx";
-export declare const ApplicationBootstrappingStartedEvent = "squide-app-bootstrapping-started";
-export type StartMswFunction<TRuntime = FireflyRuntime> = (runtime: TRuntime) => Promise<void>;
-export type OnBootstrapErrorFunction = (error: unknown) => void;
-export interface BootstrapAppOptions<TRuntime extends FireflyRuntime = FireflyRuntime, TContext = unknown, TData = unknown> extends RegisterModulesOptions<TContext> {
-    localModules?: ModuleRegisterFunction<TRuntime, TContext, TData>[];
-    remotes?: RemoteDefinition[];
-    startMsw?: StartMswFunction<TRuntime>;
-    onError?: OnBootstrapErrorFunction;
-}
-export declare function bootstrap<TRuntime extends FireflyRuntime = FireflyRuntime, TContext = unknown, TData = unknown>(runtime: TRuntime, options?: BootstrapAppOptions<TRuntime, TContext, TData>): void;
-export declare function __resetHasExecuteGuard(): void;

package/dist/boostrap.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"boostrap.js","sources":["webpack://@squide/firefly/./src/boostrap.ts"],"sourcesContent":["import { isFunction, registerLocalModules, type ModuleRegisterFunction, type RegisterModulesOptions } from \"@squide/core\";\nimport { registerRemoteModules, type RemoteDefinition } from \"@squide/module-federation\";\nimport { setMswAsReady } from \"@squide/msw\";\nimport type { FireflyRuntime } from \"./FireflyRuntime.tsx\";\n\nexport const ApplicationBootstrappingStartedEvent = \"squide-app-bootstrapping-started\";\n\nexport type StartMswFunction<TRuntime = FireflyRuntime> = (runtime: TRuntime) => Promise<void>;\n\nexport type OnBootstrapErrorFunction = (error: unknown) => void;\n\nexport interface BootstrapAppOptions<TRuntime extends FireflyRuntime = FireflyRuntime, TContext = unknown, TData = unknown> extends RegisterModulesOptions<TContext> {\n    localModules?: ModuleRegisterFunction<TRuntime, TContext, TData>[];\n    remotes?: RemoteDefinition[];\n    startMsw?: StartMswFunction<TRuntime>;\n    onError?: OnBootstrapErrorFunction;\n}\n\nfunction propagateRegistrationErrors(results: PromiseSettledResult<unknown[]>, onError: OnBootstrapErrorFunction) {\n    if (results) {\n        if (results.status === \"fulfilled\") {\n            results.value.forEach(x => {\n                onError(x);\n            });\n        }\n    }\n}\n\nlet hasExecuted = false;\n\nexport function bootstrap<TRuntime extends FireflyRuntime = FireflyRuntime, TContext = unknown, TData = unknown>(runtime: TRuntime, options: BootstrapAppOptions<TRuntime, TContext, TData> = {}) {\n    const {\n        localModules = [],\n        remotes = [],\n        context,\n        startMsw,\n        onError\n    } = options;\n\n    if (hasExecuted) {\n        throw new Error(\"[squide] A squide application can only be bootstrapped once. Did you call the \\\"bootstrap\\\" function twice?\");\n    }\n\n    hasExecuted = true;\n\n    runtime.eventBus.dispatch(ApplicationBootstrappingStartedEvent);\n\n    Promise.allSettled([\n        registerLocalModules<TRuntime, TContext, TData>(localModules, runtime, { context }),\n        registerRemoteModules(remotes, runtime, { context })\n    ]).then(results => {\n        if (runtime.isMswEnabled) {\n            if (!isFunction(startMsw)) {\n                throw new Error(\"[squide] When MSW is enabled, the \\\"startMsw\\\" function must be provided.\");\n            }\n\n            startMsw(runtime)\n                .then(() => {\n                    setMswAsReady();\n                })\n                .catch((error: unknown) => {\n                    runtime.logger.debug(\"[squide] An error occured while starting MSW.\", error);\n                });\n        }\n\n        if (onError) {\n            propagateRegistrationErrors(results[0], onError);\n            propagateRegistrationErrors(results[1], onError);\n        }\n    });\n}\n\nexport function __resetHasExecuteGuard() {\n    hasExecuted = false;\n}\n"],"names":["isFunction","registerLocalModules","registerRemoteModules","setMswAsReady","ApplicationBootstrappingStartedEvent","propagateRegistrationErrors","results","onError","x","hasExecuted","bootstrap","runtime","options","localModules","remotes","context","startMsw","Error","Promise","error","__resetHasExecuteGuard"],"mappings":";;;;;;;;;;;AAA0H;AACjC;AAC7C;AAGrC,MAAMI,uCAAuC,mCAAmC;AAavF,SAASC,4BAA4BC,OAAwC,EAAEC,OAAiC;IAC5G,IAAID,SAAS;QACT,IAAIA,QAAQ,MAAM,KAAK,aAAa;YAChCA,QAAQ,KAAK,CAAC,OAAO,CAACE,CAAAA;gBAClBD,QAAQC;YACZ;QACJ;IACJ;AACJ;AAEA,IAAIC,cAAc;AAEX,SAASC,UAAiGC,OAAiB,EAAEC,UAA0D,CAAC,CAAC;IAC5L,MAAM,EACFC,eAAe,EAAE,EACjBC,UAAU,EAAE,EACZC,OAAO,EACPC,QAAQ,EACRT,OAAO,EACV,GAAGK;IAEJ,IAAIH,aAAa;QACb,MAAM,IAAIQ,MAAM;IACpB;IAEAR,cAAc;IAEdE,QAAQ,QAAQ,CAAC,QAAQ,CAACP;IAE1Bc,QAAQ,UAAU,CAAC;QACfjB,0EAAoBA,CAA4BY,cAAcF,SAAS;YAAEI;QAAQ;QACjFb,wFAAqBA,CAACY,SAASH,SAAS;YAAEI;QAAQ;KACrD,EAAE,IAAI,CAACT,CAAAA;QACJ,IAAIK,QAAQ,YAAY,EAAE;YACtB,IAAI,CAACX,gEAAUA,CAACgB,WAAW;gBACvB,MAAM,IAAIC,MAAM;YACpB;YAEAD,SAASL,SACJ,IAAI,CAAC;gBACFR,kEAAaA;YACjB,GACC,KAAK,CAAC,CAACgB;gBACJR,QAAQ,MAAM,CAAC,KAAK,CAAC,iDAAiDQ;YAC1E;QACR;QAEA,IAAIZ,SAAS;YACTF,4BAA4BC,OAAO,CAAC,EAAE,EAAEC;YACxCF,4BAA4BC,OAAO,CAAC,EAAE,EAAEC;QAC5C;IACJ;AACJ;AAEO,SAASa;IACZX,cAAc;AAClB"}