@qiankunjs/single-spa 0.0.1-rc.0

package/LICENSE

@@ -0,0 +1,21 @@
+License (MIT)
+
+Copyright (c) 2020 single-spa
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,52 @@
+# @qiankunjs/single-spa
+
+qiankun's vendored fork of [single-spa](https://github.com/single-spa/single-spa), consumed by the `qiankun` package as its application/parcel lifecycle router. See the vendoring RFC in [umijs/qiankun#3168](https://github.com/umijs/qiankun/issues/3168) for the full rationale and plan.
+
+## Fork baseline
+
+- Upstream: `single-spa/single-spa`, `7.0` branch @ [`ce0f925a`](https://github.com/single-spa/single-spa/commit/ce0f925a40a81809c598de21b36ad79706222a73) (tag `v7.0.0-beta.13`, 2025-09-22).
+- Imported verbatim (`src/`, `spec/`, `node-spec/`, `LICENSE`), then naturalized to this monorepo's toolchain (Vite 8 build, `tsc` declarations, vitest). Upstream rollup/babel/jest configs were not carried over; the compile-time constants they injected (`__DEV__`, `__PROFILE__`, `process.env.BABEL_ENV`) are provided by `vite.library.config.ts` (build) and the root `vitest.config.ts` (tests).
+- The profile variant entry (`src/single-spa.profile.ts` + `src/devtools/profiler-api.ts`) is kept in the tree but not built or published yet; `__PROFILE__` is compiled to `false`.
+- Versioning is independent of upstream beta numbering and follows this monorepo's changesets flow.
+
+## Behavioral divergences from upstream
+
+Maintained deliberately; this list is the contract (keep it in sync when adding divergences):
+
+1. **The upstream `bootstrap` → `init` rename ([single-spa#1307](https://github.com/single-spa/single-spa/pull/1307), completed by [#1333](https://github.com/single-spa/single-spa/pull/1333)) is reverted wholesale — this fork speaks pure v6 vocabulary, with no `init` aliases.** qiankun's ecosystem was built on the bootstrap vocabulary and there was no reason to break it. Concretely:
+   - the `bootstrap` lifecycle is the only recognized name for applications and parcels (a v7-style `init` export is ignored, exactly as v6 ignored unknown fields);
+   - `parcel.bootstrapPromise`, `setBootstrapMaxTime` and the `timeouts.bootstrap` key are back; `initPromise`, `setInitMaxTime` and `timeouts.init` do not exist;
+   - the `NOT_BOOTSTRAPPED` / `BOOTSTRAPPING` statuses are restored, both as `AppOrParcelStatus` member names and as the raw `getStatus()` string values (v7's `NOT_INITIALIZED` / `INITIALIZING` strings do not exist in this fork);
+   - error message texts use the bootstrap vocabulary again;
+   - the vendored upstream specs were migrated back to the bootstrap vocabulary along with the sources.
+
+   If upstream ever ships a stable (non-beta) v7 that still carries the rename, re-evaluate aligning with it then — until that day this fork does not track it.
+
+## Invariant contracts (never break)
+
+- All `single-spa:*` window events (`single-spa:before-routing-event`, `single-spa:routing-event`, `single-spa:no-app-change`, `single-spa:first-mount`, …) — qiankun and the wider ecosystem listen to them.
+- The `window.__SINGLE_SPA_DEVTOOLS__` hook (single-spa-inspector support).
+- Public API and type signatures stay 1:1 with the upstream baseline during phase one, except for the bootstrap-naming revert above — qiankun-observable behavior stays 1:1 with what its ecosystem shipped against, which is the higher-priority contract.
+- Zero runtime dependencies; this package sits at the bottom of the workspace dependency graph and must not import `@qiankunjs/shared`, `@qiankunjs/sandbox` or `@qiankunjs/loader`.
+
+## Known semantics now owned by this fork
+
+- `urlRerouteOnly` (documented at length in qiankun's `docs/api/start.md`) — qiankun passes it through untouched; the implementation and its semantics live here now.
+- **Single-instance assumption**: single-spa is a stateful routing singleton. Loading both the ESM and CJS builds in one page (or mixing this fork with a separately installed npm `single-spa`) silently creates two independent routers — two history patches, two event streams, two `started` flags. Don't.
+
+## Upstream sync
+
+Expected cadence ≈ zero (upstream is dormant). If a fix is worth absorbing:
+
+```bash
+git remote add single-spa-upstream https://github.com/single-spa/single-spa.git
+git fetch single-spa-upstream 7.0
+git log ce0f925a..single-spa-upstream/7.0 --oneline   # review the delta
+# apply selected commits manually onto packages/single-spa/src/ (path prefixes differ)
+```
+
+Update the baseline note above after absorbing anything; on conflict with the divergence list, the divergence list wins.
+
+## License
+
+MIT — upstream's [LICENSE](./LICENSE) is preserved.

package/dist/cjs/applications/app-errors.d.ts

@@ -0,0 +1,11 @@
+import { AppOrParcel } from '../lifecycles/lifecycle.helpers';
+import { AppOrParcelStatus } from './app.helpers';
+export type SingleSpaError = Error & {
+    appOrParcelName: string;
+};
+export type ErrorHandler = (err: SingleSpaError) => any;
+export declare function handleAppError(err: Error, app: AppOrParcel, newStatus: AppOrParcelStatus): void;
+export declare function addErrorHandler(handler: any): void;
+export declare function removeErrorHandler(handler: any): boolean;
+export declare function formatErrorMessage(code: any, msg: any, ...args: any[]): string;
+export declare function transformErr(ogErr: Error, appOrParcel: AppOrParcel, newStatus: AppOrParcelStatus): SingleSpaError;

package/dist/cjs/applications/app-errors.js

@@ -0,0 +1,57 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_applications_app_helpers = require("./app.helpers.js");
+//#region src/applications/app-errors.ts
+var errorHandlers = [];
+function handleAppError(err, app, newStatus) {
+	const transformedErr = transformErr(err, app, newStatus);
+	if (errorHandlers.length) errorHandlers.forEach((handler) => handler(transformedErr));
+	else setTimeout(() => {
+		throw transformedErr;
+	});
+}
+function addErrorHandler(handler) {
+	if (typeof handler !== "function") throw Error(formatErrorMessage(28, process.env.NODE_ENV !== "production" && "a single-spa error handler must be a function"));
+	errorHandlers.push(handler);
+}
+function removeErrorHandler(handler) {
+	if (typeof handler !== "function") throw Error(formatErrorMessage(29, process.env.NODE_ENV !== "production" && "a single-spa error handler must be a function"));
+	let removedSomething = false;
+	errorHandlers = errorHandlers.filter((h) => {
+		const isHandler = h === handler;
+		removedSomething = removedSomething || isHandler;
+		return !isHandler;
+	});
+	return removedSomething;
+}
+function formatErrorMessage(code, msg, ...args) {
+	return `single-spa minified message #${code}: ${msg ? msg + " " : ""}See https://single-spa.js.org/error/?code=${code}${args.length ? `&arg=${args.join("&arg=")}` : ""}`;
+}
+function transformErr(ogErr, appOrParcel, newStatus) {
+	const errPrefix = `${require_applications_app_helpers.objectType(appOrParcel)} '${require_applications_app_helpers.toName(appOrParcel)}' died in status ${appOrParcel.status}: `;
+	let result;
+	if (ogErr instanceof Error) {
+		try {
+			ogErr.message = errPrefix + ogErr.message;
+		} catch (err) {}
+		result = ogErr;
+	} else {
+		console.warn(formatErrorMessage(30, process.env.NODE_ENV !== "production" && `While ${appOrParcel.status}, '${require_applications_app_helpers.toName(appOrParcel)}' rejected its lifecycle function promise with a non-Error. This will cause stack traces to not be accurate.`, appOrParcel.status, require_applications_app_helpers.toName(appOrParcel)));
+		try {
+			result = Error(errPrefix + JSON.stringify(ogErr));
+		} catch (err) {
+			result = ogErr;
+		}
+	}
+	const singleSpaErr = result;
+	singleSpaErr.appOrParcelName = require_applications_app_helpers.toName(appOrParcel);
+	appOrParcel.status = newStatus;
+	return singleSpaErr;
+}
+//#endregion
+exports.addErrorHandler = addErrorHandler;
+exports.formatErrorMessage = formatErrorMessage;
+exports.handleAppError = handleAppError;
+exports.removeErrorHandler = removeErrorHandler;
+exports.transformErr = transformErr;
+
+//# sourceMappingURL=app-errors.js.map

package/dist/cjs/applications/app-errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"app-errors.js","names":[],"sources":["../../../src/applications/app-errors.ts"],"sourcesContent":["import { AppOrParcel } from '../lifecycles/lifecycle.helpers';\nimport { AppOrParcelStatus, objectType, toName } from './app.helpers';\n\nlet errorHandlers: ErrorHandler[] = [];\n\nexport type SingleSpaError = Error & {\n  appOrParcelName: string;\n};\n\nexport type ErrorHandler = (err: SingleSpaError) => any;\n\nexport function handleAppError(err: Error, app: AppOrParcel, newStatus: AppOrParcelStatus) {\n  const transformedErr = transformErr(err, app, newStatus);\n\n  if (errorHandlers.length) {\n    errorHandlers.forEach((handler) => handler(transformedErr));\n  } else {\n    setTimeout(() => {\n      throw transformedErr;\n    });\n  }\n}\n\nexport function addErrorHandler(handler) {\n  if (typeof handler !== 'function') {\n    throw Error(formatErrorMessage(28, __DEV__ && 'a single-spa error handler must be a function'));\n  }\n\n  errorHandlers.push(handler);\n}\n\nexport function removeErrorHandler(handler) {\n  if (typeof handler !== 'function') {\n    throw Error(formatErrorMessage(29, __DEV__ && 'a single-spa error handler must be a function'));\n  }\n\n  let removedSomething = false;\n  errorHandlers = errorHandlers.filter((h) => {\n    const isHandler = h === handler;\n    removedSomething = removedSomething || isHandler;\n    return !isHandler;\n  });\n\n  return removedSomething;\n}\n\nexport function formatErrorMessage(code, msg, ...args) {\n  return `single-spa minified message #${code}: ${\n    msg ? msg + ' ' : ''\n  }See https://single-spa.js.org/error/?code=${code}${args.length ? `&arg=${args.join('&arg=')}` : ''}`;\n}\n\nexport function transformErr(ogErr: Error, appOrParcel: AppOrParcel, newStatus: AppOrParcelStatus): SingleSpaError {\n  const errPrefix = `${objectType(appOrParcel)} '${toName(appOrParcel)}' died in status ${appOrParcel.status}: `;\n\n  let result: Error;\n\n  if (ogErr instanceof Error) {\n    try {\n      ogErr.message = errPrefix + ogErr.message;\n    } catch (err) {\n      /* Some errors have read-only message properties, in which case there is nothing\n       * that we can do.\n       */\n    }\n    result = ogErr;\n  } else {\n    console.warn(\n      formatErrorMessage(\n        30,\n        __DEV__ &&\n          `While ${appOrParcel.status}, '${toName(\n            appOrParcel,\n          )}' rejected its lifecycle function promise with a non-Error. This will cause stack traces to not be accurate.`,\n        appOrParcel.status,\n        toName(appOrParcel),\n      ),\n    );\n    try {\n      result = Error(errPrefix + JSON.stringify(ogErr));\n    } catch (err) {\n      // If it's not an Error and you can't stringify it, then what else can you even do to it?\n      result = ogErr;\n    }\n  }\n\n  const singleSpaErr = result as SingleSpaError;\n  singleSpaErr.appOrParcelName = toName(appOrParcel);\n\n  // We set the status after transforming the error so that the error message\n  // references the state the application was in before the status change.\n  appOrParcel.status = newStatus;\n\n  return singleSpaErr;\n}\n"],"mappings":";;;AAGA,IAAI,gBAAgC,CAAC;AAQrC,SAAgB,eAAe,KAAY,KAAkB,WAA8B;CACzF,MAAM,iBAAiB,aAAa,KAAK,KAAK,SAAS;CAEvD,IAAI,cAAc,QAChB,cAAc,SAAS,YAAY,QAAQ,cAAc,CAAC;MAE1D,iBAAiB;EACf,MAAM;CACR,CAAC;AAEL;AAEA,SAAgB,gBAAgB,SAAS;CACvC,IAAI,OAAO,YAAY,YACrB,MAAM,MAAM,mBAAmB,IAAA,QAAA,IAAA,aAAA,gBAAe,+CAA+C,CAAC;CAGhG,cAAc,KAAK,OAAO;AAC5B;AAEA,SAAgB,mBAAmB,SAAS;CAC1C,IAAI,OAAO,YAAY,YACrB,MAAM,MAAM,mBAAmB,IAAA,QAAA,IAAA,aAAA,gBAAe,+CAA+C,CAAC;CAGhG,IAAI,mBAAmB;CACvB,gBAAgB,cAAc,QAAQ,MAAM;EAC1C,MAAM,YAAY,MAAM;EACxB,mBAAmB,oBAAoB;EACvC,OAAO,CAAC;CACV,CAAC;CAED,OAAO;AACT;AAEA,SAAgB,mBAAmB,MAAM,KAAK,GAAG,MAAM;CACrD,OAAO,gCAAgC,KAAK,IAC1C,MAAM,MAAM,MAAM,GACnB,4CAA4C,OAAO,KAAK,SAAS,QAAQ,KAAK,KAAK,OAAO,MAAM;AACnG;AAEA,SAAgB,aAAa,OAAc,aAA0B,WAA8C;CACjH,MAAM,YAAY,GAAG,iCAAA,WAAW,WAAW,EAAE,IAAI,iCAAA,OAAO,WAAW,EAAE,mBAAmB,YAAY,OAAO;CAE3G,IAAI;CAEJ,IAAI,iBAAiB,OAAO;EAC1B,IAAI;GACF,MAAM,UAAU,YAAY,MAAM;EACpC,SAAS,KAAK,CAId;EACA,SAAS;CACX,OAAO;EACL,QAAQ,KACN,mBACE,IAAA,QAAA,IAAA,aAAA,gBAEE,SAAS,YAAY,OAAO,KAAK,iCAAA,OAC/B,WACF,EAAE,+GACJ,YAAY,QACZ,iCAAA,OAAO,WAAW,CACpB,CACF;EACA,IAAI;GACF,SAAS,MAAM,YAAY,KAAK,UAAU,KAAK,CAAC;EAClD,SAAS,KAAK;GAEZ,SAAS;EACX;CACF;CAEA,MAAM,eAAe;CACrB,aAAa,kBAAkB,iCAAA,OAAO,WAAW;CAIjD,YAAY,SAAS;CAErB,OAAO;AACT"}

package/dist/cjs/applications/app.helpers.d.ts

@@ -0,0 +1,52 @@
+import { ActivityFn, AppOrParcel, CustomProps, InternalParcel, LoadApp, ParcelMap } from '../lifecycles/lifecycle.helpers';
+import { AppOrParcelTimeouts } from './timeouts';
+export declare enum AppOrParcelStatus {
+    NOT_LOADED = "NOT_LOADED",
+    LOADING_SOURCE_CODE = "LOADING_SOURCE_CODE",
+    NOT_BOOTSTRAPPED = "NOT_BOOTSTRAPPED",
+    BOOTSTRAPPING = "BOOTSTRAPPING",
+    NOT_MOUNTED = "NOT_MOUNTED",
+    MOUNTING = "MOUNTING",
+    MOUNTED = "MOUNTED",
+    UPDATING = "UPDATING",
+    UNMOUNTING = "UNMOUNTING",
+    UNLOADING = "UNLOADING",
+    LOAD_ERROR = "LOAD_ERROR",
+    SKIP_BECAUSE_BROKEN = "SKIP_BECAUSE_BROKEN"
+}
+export declare function isActive(app: any): boolean;
+export declare function shouldBeActive(app: any): any;
+export declare function toName(app: any): any;
+export declare function isParcel(appOrParcel: AppOrParcel): appOrParcel is InternalParcel;
+export declare function objectType(appOrParcel: AppOrParcel): 'parcel' | 'application';
+export interface InternalApplication {
+    name: string;
+    activeWhen: ActivityFn;
+    loadApp: LoadApp;
+    status: AppOrParcelStatus;
+    loadErrorTime: number;
+    parcels: ParcelMap;
+    customProps?: CustomProps;
+    timeouts?: AppOrParcelTimeouts;
+    devtools: AppDevtools;
+}
+export interface AppDevtools {
+    overlays: {
+        options: OverlayOptions;
+        selectors: string[];
+    };
+}
+interface OverlayOptions {
+    color?: string;
+    background?: string;
+    classes?: string[];
+    height?: string;
+    left?: string;
+    position?: string;
+    top?: string;
+    width?: string;
+    zIndex?: string | number;
+    textColor?: string;
+    textBlocks?: string[];
+}
+export {};

package/dist/cjs/applications/app.helpers.js

@@ -0,0 +1,47 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_applications_app_errors = require("./app-errors.js");
+//#region src/applications/app.helpers.ts
+var AppOrParcelStatus = /* @__PURE__ */ function(AppOrParcelStatus) {
+	AppOrParcelStatus["NOT_LOADED"] = "NOT_LOADED";
+	AppOrParcelStatus["LOADING_SOURCE_CODE"] = "LOADING_SOURCE_CODE";
+	AppOrParcelStatus["NOT_BOOTSTRAPPED"] = "NOT_BOOTSTRAPPED";
+	AppOrParcelStatus["BOOTSTRAPPING"] = "BOOTSTRAPPING";
+	AppOrParcelStatus["NOT_MOUNTED"] = "NOT_MOUNTED";
+	AppOrParcelStatus["MOUNTING"] = "MOUNTING";
+	AppOrParcelStatus["MOUNTED"] = "MOUNTED";
+	AppOrParcelStatus["UPDATING"] = "UPDATING";
+	AppOrParcelStatus["UNMOUNTING"] = "UNMOUNTING";
+	AppOrParcelStatus["UNLOADING"] = "UNLOADING";
+	AppOrParcelStatus["LOAD_ERROR"] = "LOAD_ERROR";
+	AppOrParcelStatus["SKIP_BECAUSE_BROKEN"] = "SKIP_BECAUSE_BROKEN";
+	return AppOrParcelStatus;
+}({});
+function isActive(app) {
+	return app.status === "MOUNTED";
+}
+function shouldBeActive(app) {
+	try {
+		return app.activeWhen(window.location);
+	} catch (err) {
+		require_applications_app_errors.handleAppError(err, app, "SKIP_BECAUSE_BROKEN");
+		return false;
+	}
+}
+function toName(app) {
+	return app.name;
+}
+function isParcel(appOrParcel) {
+	return Boolean(appOrParcel.unmountThisParcel);
+}
+function objectType(appOrParcel) {
+	return isParcel(appOrParcel) ? "parcel" : "application";
+}
+//#endregion
+exports.AppOrParcelStatus = AppOrParcelStatus;
+exports.isActive = isActive;
+exports.isParcel = isParcel;
+exports.objectType = objectType;
+exports.shouldBeActive = shouldBeActive;
+exports.toName = toName;
+
+//# sourceMappingURL=app.helpers.js.map

package/dist/cjs/applications/app.helpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"app.helpers.js","names":[],"sources":["../../../src/applications/app.helpers.ts"],"sourcesContent":["import {\n  ActivityFn,\n  AppOrParcel,\n  CustomProps,\n  InternalParcel,\n  LoadApp,\n  ParcelMap,\n} from '../lifecycles/lifecycle.helpers';\nimport { handleAppError } from './app-errors';\nimport { AppOrParcelTimeouts } from './timeouts';\n\n// App statuses\nexport enum AppOrParcelStatus {\n  NOT_LOADED = 'NOT_LOADED',\n  LOADING_SOURCE_CODE = 'LOADING_SOURCE_CODE',\n  NOT_BOOTSTRAPPED = 'NOT_BOOTSTRAPPED',\n  BOOTSTRAPPING = 'BOOTSTRAPPING',\n  NOT_MOUNTED = 'NOT_MOUNTED',\n  MOUNTING = 'MOUNTING',\n  MOUNTED = 'MOUNTED',\n  UPDATING = 'UPDATING',\n  UNMOUNTING = 'UNMOUNTING',\n  UNLOADING = 'UNLOADING',\n  LOAD_ERROR = 'LOAD_ERROR',\n  SKIP_BECAUSE_BROKEN = 'SKIP_BECAUSE_BROKEN',\n}\n\nexport function isActive(app) {\n  return app.status === AppOrParcelStatus.MOUNTED;\n}\n\nexport function shouldBeActive(app) {\n  try {\n    return app.activeWhen(window.location);\n  } catch (err) {\n    handleAppError(err, app, AppOrParcelStatus.SKIP_BECAUSE_BROKEN);\n    return false;\n  }\n}\n\nexport function toName(app) {\n  return app.name;\n}\n\nexport function isParcel(appOrParcel: AppOrParcel): appOrParcel is InternalParcel {\n  return Boolean((appOrParcel as InternalParcel).unmountThisParcel);\n}\n\nexport function objectType(appOrParcel: AppOrParcel): 'parcel' | 'application' {\n  return isParcel(appOrParcel) ? 'parcel' : 'application';\n}\n\nexport interface InternalApplication {\n  name: string;\n  activeWhen: ActivityFn;\n  loadApp: LoadApp;\n  status: AppOrParcelStatus;\n  loadErrorTime: number;\n  parcels: ParcelMap;\n  customProps?: CustomProps;\n  // The ensureValidAppTimeouts function gets called once the app is loaded\n  timeouts?: AppOrParcelTimeouts;\n  devtools: AppDevtools;\n}\n\nexport interface AppDevtools {\n  overlays: {\n    options: OverlayOptions;\n    selectors: string[];\n  };\n}\n\n// https://github.com/single-spa/single-spa-inspector/blob/ac3e1ded68e94239dd02d04f8a094ed8e6dfefc2/src/inspected-window-helpers/overlay-helpers.js#L53\ninterface OverlayOptions {\n  color?: string;\n  background?: string;\n  classes?: string[];\n  height?: string;\n  left?: string;\n  position?: string;\n  top?: string;\n  width?: string;\n  zIndex?: string | number;\n  textColor?: string;\n  textBlocks?: string[];\n}\n"],"mappings":";;;AAYA,IAAY,oBAAL,yBAAA,mBAAA;CACL,kBAAA,gBAAA;CACA,kBAAA,yBAAA;CACA,kBAAA,sBAAA;CACA,kBAAA,mBAAA;CACA,kBAAA,iBAAA;CACA,kBAAA,cAAA;CACA,kBAAA,aAAA;CACA,kBAAA,cAAA;CACA,kBAAA,gBAAA;CACA,kBAAA,eAAA;CACA,kBAAA,gBAAA;CACA,kBAAA,yBAAA;;AACF,EAAA,CAAA,CAAA;AAEA,SAAgB,SAAS,KAAK;CAC5B,OAAO,IAAI,WAAA;AACb;AAEA,SAAgB,eAAe,KAAK;CAClC,IAAI;EACF,OAAO,IAAI,WAAW,OAAO,QAAQ;CACvC,SAAS,KAAK;EACZ,gCAAA,eAAe,KAAK,KAAA,qBAA0C;EAC9D,OAAO;CACT;AACF;AAEA,SAAgB,OAAO,KAAK;CAC1B,OAAO,IAAI;AACb;AAEA,SAAgB,SAAS,aAAyD;CAChF,OAAO,QAAS,YAA+B,iBAAiB;AAClE;AAEA,SAAgB,WAAW,aAAoD;CAC7E,OAAO,SAAS,WAAW,IAAI,WAAW;AAC5C"}

package/dist/cjs/applications/apps.d.ts

@@ -0,0 +1,23 @@
+import { InternalApplication, AppOrParcelStatus } from './app.helpers';
+import { Activity, ActivityFn, Application, CustomProps, CustomPropsFn, RegisterApplicationConfig, SingleSpaLocation } from '../lifecycles/lifecycle.helpers';
+interface AppChanges {
+    appsToUnload: InternalApplication[];
+    appsToUnmount: InternalApplication[];
+    appsToLoad: InternalApplication[];
+    appsToMount: InternalApplication[];
+}
+export declare function getAppChanges(): AppChanges;
+export declare function getMountedApps(): string[];
+export declare function getAppNames(): string[];
+export declare function getRawAppData(): InternalApplication[];
+export declare function getAppStatus(appName: any): AppOrParcelStatus | null;
+export declare function registerApplication<ExtraProps extends CustomProps = {}>(RegisterApplicationConfig: any): void;
+export declare function registerApplication<ExtraProps extends CustomProps = {}>(appName: string, app: Application, activeWhen: Activity, customProps: ExtraProps | CustomPropsFn<ExtraProps>): void;
+export declare function checkActivityFunctions(location?: SingleSpaLocation): string[];
+export declare function unregisterApplication(appName: string): Promise<void>;
+export declare function unloadApplication(appName: string, opts?: {
+    waitForUnmount: boolean;
+}): Promise<void>;
+export declare function validateRegisterWithConfig(config: Partial<RegisterApplicationConfig>): void;
+export declare function pathToActiveWhen(path: string, exactMatch?: boolean): ActivityFn;
+export {};

package/dist/cjs/applications/apps.js

@@ -0,0 +1,234 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_applications_app_helpers = require("./app.helpers.js");
+const require_applications_app_errors = require("./app-errors.js");
+const require_utils_runtime_environment = require("../utils/runtime-environment.js");
+const require_start = require("../start.js");
+const require_lifecycles_unmount = require("../lifecycles/unmount.js");
+const require_lifecycles_unload = require("../lifecycles/unload.js");
+const require_navigation_reroute = require("../navigation/reroute.js");
+const require_jquery_support = require("../jquery-support.js");
+//#region src/applications/apps.ts
+var apps = [];
+function getAppChanges() {
+	const appsToUnload = [], appsToUnmount = [], appsToLoad = [], appsToMount = [];
+	const currentTime = (/* @__PURE__ */ new Date()).getTime();
+	apps.forEach((app) => {
+		const appShouldBeActive = app.status !== require_applications_app_helpers.AppOrParcelStatus.SKIP_BECAUSE_BROKEN && require_applications_app_helpers.shouldBeActive(app);
+		switch (app.status) {
+			case require_applications_app_helpers.AppOrParcelStatus.LOAD_ERROR:
+				if (appShouldBeActive && currentTime - app.loadErrorTime >= 200) appsToLoad.push(app);
+				break;
+			case require_applications_app_helpers.AppOrParcelStatus.NOT_LOADED:
+			case require_applications_app_helpers.AppOrParcelStatus.LOADING_SOURCE_CODE:
+				if (appShouldBeActive) appsToLoad.push(app);
+				break;
+			case require_applications_app_helpers.AppOrParcelStatus.NOT_BOOTSTRAPPED:
+			case require_applications_app_helpers.AppOrParcelStatus.NOT_MOUNTED:
+				if (!appShouldBeActive && require_lifecycles_unload.getAppUnloadInfo(require_applications_app_helpers.toName(app))) appsToUnload.push(app);
+				else if (appShouldBeActive) appsToMount.push(app);
+				break;
+			case require_applications_app_helpers.AppOrParcelStatus.MOUNTED:
+				if (!appShouldBeActive) appsToUnmount.push(app);
+				break;
+		}
+	});
+	return {
+		appsToUnload,
+		appsToUnmount,
+		appsToLoad,
+		appsToMount
+	};
+}
+function getMountedApps() {
+	return apps.filter(require_applications_app_helpers.isActive).map(require_applications_app_helpers.toName);
+}
+function getAppNames() {
+	return apps.map(require_applications_app_helpers.toName);
+}
+function getRawAppData() {
+	return [...apps];
+}
+function getAppStatus(appName) {
+	const app = apps.find((app) => require_applications_app_helpers.toName(app) === appName);
+	return app ? app.status : null;
+}
+var startWarningInitialized = false;
+function registerApplication(appNameOrConfig, appOrLoadApp, activeWhen, customProps) {
+	const registration = sanitizeArguments(appNameOrConfig, appOrLoadApp, activeWhen, customProps);
+	if (!require_start.isStarted() && !startWarningInitialized) {
+		startWarningInitialized = true;
+		setTimeout(() => {
+			if (!require_start.isStarted()) console.warn(require_applications_app_errors.formatErrorMessage(1, process.env.NODE_ENV !== "production" && `singleSpa.start() has not been called, 5000ms after single-spa was loaded. Before start() is called, apps can be declared and loaded, but not initialized or mounted.`));
+		}, 5e3);
+	}
+	if (getAppNames().indexOf(registration.name) !== -1) throw Error(require_applications_app_errors.formatErrorMessage(21, process.env.NODE_ENV !== "production" && `There is already an app registered with name ${registration.name}`, registration.name));
+	apps.push(Object.assign({
+		loadErrorTime: null,
+		status: require_applications_app_helpers.AppOrParcelStatus.NOT_LOADED,
+		parcels: {},
+		devtools: { overlays: {
+			options: {},
+			selectors: []
+		} }
+	}, registration));
+	if (require_utils_runtime_environment.isInBrowser) {
+		require_jquery_support.ensureJQuerySupport();
+		require_navigation_reroute.reroute();
+	}
+}
+function checkActivityFunctions(location = window.location) {
+	return apps.filter((app) => app.activeWhen(location)).map(require_applications_app_helpers.toName);
+}
+function unregisterApplication(appName) {
+	if (apps.filter((app) => require_applications_app_helpers.toName(app) === appName).length === 0) throw Error(require_applications_app_errors.formatErrorMessage(25, process.env.NODE_ENV !== "production" && `Cannot unregister application '${appName}' because no such application has been registered`, appName));
+	return (require_utils_runtime_environment.isInBrowser ? unloadApplication(appName, { waitForUnmount: false }) : Promise.resolve()).then(() => {
+		const appIndex = apps.map(require_applications_app_helpers.toName).indexOf(appName);
+		apps.splice(appIndex, 1);
+	});
+}
+function unloadApplication(appName, opts = { waitForUnmount: false }) {
+	if (typeof appName !== "string") throw Error(require_applications_app_errors.formatErrorMessage(26, process.env.NODE_ENV !== "production" && `unloadApplication requires a string 'appName'`));
+	const app = apps.find((app) => require_applications_app_helpers.toName(app) === appName);
+	if (!app) throw Error(require_applications_app_errors.formatErrorMessage(27, process.env.NODE_ENV !== "production" && `Could not unload application '${appName}' because no such application has been registered`, appName));
+	const appUnloadInfo = require_lifecycles_unload.getAppUnloadInfo(require_applications_app_helpers.toName(app));
+	if (opts === null || opts === void 0 ? void 0 : opts.waitForUnmount) if (appUnloadInfo) return appUnloadInfo.promise;
+	else {
+		const promise = new Promise((resolve, reject) => {
+			require_lifecycles_unload.addAppToUnload(app, () => promise, resolve, reject);
+		});
+		return promise;
+	}
+	else {
+		let resultPromise;
+		if (appUnloadInfo) {
+			resultPromise = appUnloadInfo.promise;
+			immediatelyUnloadApp(app, appUnloadInfo.resolve, appUnloadInfo.reject);
+		} else resultPromise = new Promise((resolve, reject) => {
+			require_lifecycles_unload.addAppToUnload(app, () => resultPromise, resolve, reject);
+			immediatelyUnloadApp(app, resolve, reject);
+		});
+		return resultPromise;
+	}
+}
+function immediatelyUnloadApp(app, resolve, reject) {
+	Promise.resolve().then(() => {
+		if (checkActivityFunctions().find((activeApp) => activeApp === require_applications_app_helpers.toName(app))) return require_navigation_reroute.triggerAppChange();
+	}).then(() => {
+		return require_lifecycles_unmount.toUnmountPromise(app).then(require_lifecycles_unload.toUnloadPromise).then(() => {
+			resolve();
+			setTimeout(() => {
+				require_navigation_reroute.reroute();
+			});
+		});
+	}).catch(reject);
+}
+function validateRegisterWithArguments(name, appOrLoadApp, activeWhen, customProps) {
+	if (typeof name !== "string" || name.length === 0) throw Error(require_applications_app_errors.formatErrorMessage(20, process.env.NODE_ENV !== "production" && `The 1st argument to registerApplication must be a non-empty string 'appName'`));
+	if (!appOrLoadApp) throw Error(require_applications_app_errors.formatErrorMessage(23, process.env.NODE_ENV !== "production" && "The 2nd argument to registerApplication must be an application or loading application function"));
+	if (typeof activeWhen !== "function") throw Error(require_applications_app_errors.formatErrorMessage(24, process.env.NODE_ENV !== "production" && "The 3rd argument to registerApplication must be an activeWhen function"));
+	if (!validCustomProps(customProps)) throw Error(require_applications_app_errors.formatErrorMessage(22, process.env.NODE_ENV !== "production" && "The optional 4th argument is a customProps and must be an object"));
+}
+function validateRegisterWithConfig(config) {
+	if (Array.isArray(config) || config === null) throw Error(require_applications_app_errors.formatErrorMessage(39, process.env.NODE_ENV !== "production" && "Configuration object can't be an Array or null!"));
+	const validKeys = [
+		"name",
+		"app",
+		"activeWhen",
+		"customProps"
+	];
+	const invalidKeys = Object.keys(config).reduce((invalidKeys, prop) => validKeys.indexOf(prop) >= 0 ? invalidKeys : invalidKeys.concat(prop), []);
+	if (invalidKeys.length !== 0) throw Error(require_applications_app_errors.formatErrorMessage(38, process.env.NODE_ENV !== "production" && `The configuration object accepts only: ${validKeys.join(", ")}. Invalid keys: ${invalidKeys.join(", ")}.`, validKeys.join(", "), invalidKeys.join(", ")));
+	if (typeof config.name !== "string" || config.name.length === 0) throw Error(require_applications_app_errors.formatErrorMessage(20, process.env.NODE_ENV !== "production" && "The config.name on registerApplication must be a non-empty string"));
+	if (typeof config.app !== "object" && typeof config.app !== "function") throw Error(require_applications_app_errors.formatErrorMessage(20, process.env.NODE_ENV !== "production" && "The config.app on registerApplication must be an application or a loading function"));
+	const allowsStringAndFunction = (activeWhen) => typeof activeWhen === "string" || typeof activeWhen === "function";
+	if (!allowsStringAndFunction(config.activeWhen) && !(Array.isArray(config.activeWhen) && config.activeWhen.every(allowsStringAndFunction))) throw Error(require_applications_app_errors.formatErrorMessage(24, process.env.NODE_ENV !== "production" && "The config.activeWhen on registerApplication must be a string, function or an array with both"));
+	if (!validCustomProps(config.customProps)) throw Error(require_applications_app_errors.formatErrorMessage(22, process.env.NODE_ENV !== "production" && "The optional config.customProps must be an object"));
+}
+function validCustomProps(customProps) {
+	return !customProps || typeof customProps === "function" || typeof customProps === "object" && customProps !== null && !Array.isArray(customProps);
+}
+function sanitizeArguments(appNameOrConfig, appOrLoadApp, activeWhen, customProps) {
+	const usingObjectAPI = typeof appNameOrConfig === "object";
+	let unsanitizedRegistration;
+	if (usingObjectAPI) {
+		validateRegisterWithConfig(appNameOrConfig);
+		unsanitizedRegistration = {
+			name: appNameOrConfig.name,
+			app: appNameOrConfig.app,
+			activeWhen: appNameOrConfig.activeWhen,
+			customProps: appNameOrConfig.customProps
+		};
+	} else {
+		validateRegisterWithArguments(appNameOrConfig, appOrLoadApp, activeWhen, customProps);
+		unsanitizedRegistration = {
+			name: appNameOrConfig,
+			app: appOrLoadApp,
+			activeWhen,
+			customProps
+		};
+	}
+	return {
+		name: unsanitizedRegistration.name,
+		loadApp: sanitizeLoadApp(unsanitizedRegistration.app),
+		customProps: sanitizeCustomProps(unsanitizedRegistration.customProps),
+		activeWhen: sanitizeActiveWhen(unsanitizedRegistration.activeWhen)
+	};
+}
+function sanitizeLoadApp(loadApp) {
+	if (typeof loadApp !== "function") return () => Promise.resolve(loadApp);
+	return loadApp;
+}
+function sanitizeCustomProps(customProps) {
+	return customProps ? customProps : {};
+}
+function sanitizeActiveWhen(activeWhen) {
+	const activityFnArray = (Array.isArray(activeWhen) ? activeWhen : [activeWhen]).map((activeWhenOrPath) => typeof activeWhenOrPath === "function" ? activeWhenOrPath : pathToActiveWhen(activeWhenOrPath, false));
+	return (location) => activityFnArray.some((activeWhen) => activeWhen(location));
+}
+function pathToActiveWhen(path, exactMatch) {
+	const regex = toDynamicPathValidatorRegex(path, exactMatch);
+	return (location) => {
+		const route = location.href.replace(location.origin, "").replace(location.search, "").split("?")[0];
+		return regex.test(route);
+	};
+}
+function toDynamicPathValidatorRegex(path, exactMatch) {
+	let lastIndex = 0, inDynamic = false, regexStr = "^";
+	if (path[0] !== "/") path = "/" + path;
+	for (let charIndex = 0; charIndex < path.length; charIndex++) {
+		const char = path[charIndex];
+		if (!inDynamic && char === ":" || inDynamic && char === "/") appendToRegex(charIndex);
+	}
+	appendToRegex(path.length);
+	return new RegExp(regexStr, "i");
+	function appendToRegex(index) {
+		const anyCharMaybeTrailingSlashRegex = "[^/]+/?";
+		const commonStringSubPath = escapeStrRegex(path.slice(lastIndex, index));
+		regexStr += inDynamic ? anyCharMaybeTrailingSlashRegex : commonStringSubPath;
+		if (index === path.length) if (inDynamic) {
+			if (exactMatch) regexStr += "$";
+		} else {
+			const suffix = exactMatch ? "" : ".*";
+			regexStr = regexStr.charAt(regexStr.length - 1) === "/" ? `${regexStr}${suffix}$` : `${regexStr}(/${suffix})?(#.*)?$`;
+		}
+		inDynamic = !inDynamic;
+		lastIndex = index;
+	}
+	function escapeStrRegex(str) {
+		return str.replace(/[|\\{}()[\]^$+*?.]/g, "\\$&");
+	}
+}
+//#endregion
+exports.checkActivityFunctions = checkActivityFunctions;
+exports.getAppChanges = getAppChanges;
+exports.getAppNames = getAppNames;
+exports.getAppStatus = getAppStatus;
+exports.getMountedApps = getMountedApps;
+exports.getRawAppData = getRawAppData;
+exports.pathToActiveWhen = pathToActiveWhen;
+exports.registerApplication = registerApplication;
+exports.unloadApplication = unloadApplication;
+exports.unregisterApplication = unregisterApplication;
+exports.validateRegisterWithConfig = validateRegisterWithConfig;
+
+//# sourceMappingURL=apps.js.map

package/dist/cjs/applications/apps.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"apps.js","names":[],"sources":["../../../src/applications/apps.ts"],"sourcesContent":["import { ensureJQuerySupport } from '../jquery-support';\nimport { isActive, toName, shouldBeActive, InternalApplication, AppOrParcelStatus } from './app.helpers';\nimport { reroute, triggerAppChange } from '../navigation/reroute';\nimport { toUnmountPromise } from '../lifecycles/unmount';\nimport { toUnloadPromise, getAppUnloadInfo, addAppToUnload } from '../lifecycles/unload';\nimport { formatErrorMessage } from './app-errors';\nimport { isInBrowser } from '../utils/runtime-environment';\nimport { isStarted } from '../start';\nimport {\n  Activity,\n  ActivityFn,\n  AppProps,\n  Application,\n  CustomProps,\n  CustomPropsFn,\n  LifeCycles,\n  LoadApp,\n  LoadedApp,\n  RegisterApplicationConfig,\n  SingleSpaLocation,\n} from '../lifecycles/lifecycle.helpers';\n\nconst apps: InternalApplication[] = [];\n\ninterface AppChanges {\n  appsToUnload: InternalApplication[];\n  appsToUnmount: InternalApplication[];\n  appsToLoad: InternalApplication[];\n  appsToMount: InternalApplication[];\n}\n\nexport function getAppChanges(): AppChanges {\n  const appsToUnload: InternalApplication[] = [],\n    appsToUnmount: InternalApplication[] = [],\n    appsToLoad: InternalApplication[] = [],\n    appsToMount: InternalApplication[] = [];\n\n  // We re-attempt to download applications in LOAD_ERROR after a timeout of 200 milliseconds\n  const currentTime: number = new Date().getTime();\n\n  apps.forEach((app) => {\n    const appShouldBeActive = app.status !== AppOrParcelStatus.SKIP_BECAUSE_BROKEN && shouldBeActive(app);\n\n    switch (app.status) {\n      case AppOrParcelStatus.LOAD_ERROR:\n        if (appShouldBeActive && currentTime - app.loadErrorTime >= 200) {\n          appsToLoad.push(app);\n        }\n        break;\n      case AppOrParcelStatus.NOT_LOADED:\n      case AppOrParcelStatus.LOADING_SOURCE_CODE:\n        if (appShouldBeActive) {\n          appsToLoad.push(app);\n        }\n        break;\n      case AppOrParcelStatus.NOT_BOOTSTRAPPED:\n      case AppOrParcelStatus.NOT_MOUNTED:\n        if (!appShouldBeActive && getAppUnloadInfo(toName(app))) {\n          appsToUnload.push(app);\n        } else if (appShouldBeActive) {\n          appsToMount.push(app);\n        }\n        break;\n      case AppOrParcelStatus.MOUNTED:\n        if (!appShouldBeActive) {\n          appsToUnmount.push(app);\n        }\n        break;\n      // all other statuses are ignored\n    }\n  });\n\n  return { appsToUnload, appsToUnmount, appsToLoad, appsToMount };\n}\n\nexport function getMountedApps(): string[] {\n  return apps.filter(isActive).map(toName);\n}\n\nexport function getAppNames(): string[] {\n  return apps.map(toName);\n}\n\n// used in devtools, not (currently) exposed as a single-spa API\nexport function getRawAppData(): InternalApplication[] {\n  return [...apps];\n}\n\nexport function getAppStatus(appName): AppOrParcelStatus | null {\n  const app = apps.find((app) => toName(app) === appName);\n  return app ? app.status : null;\n}\n\nlet startWarningInitialized: boolean = false;\n\nexport function registerApplication<ExtraProps extends CustomProps = {}>(RegisterApplicationConfig): void;\nexport function registerApplication<ExtraProps extends CustomProps = {}>(\n  appName: string,\n  app: Application,\n  activeWhen: Activity,\n  customProps: ExtraProps | CustomPropsFn<ExtraProps>,\n): void;\nexport function registerApplication<ExtraProps extends CustomProps = {}>(\n  appNameOrConfig: string | RegisterApplicationConfig,\n  appOrLoadApp?: Application,\n  activeWhen?: Activity,\n  customProps?: ExtraProps | CustomPropsFn<ExtraProps>,\n): void {\n  const registration = sanitizeArguments(appNameOrConfig, appOrLoadApp, activeWhen, customProps);\n\n  if (!isStarted() && !startWarningInitialized) {\n    startWarningInitialized = true;\n\n    setTimeout(() => {\n      if (!isStarted()) {\n        console.warn(\n          formatErrorMessage(\n            1,\n            __DEV__ &&\n              `singleSpa.start() has not been called, 5000ms after single-spa was loaded. Before start() is called, apps can be declared and loaded, but not initialized or mounted.`,\n          ),\n        );\n      }\n    }, 5000);\n  }\n\n  if (getAppNames().indexOf(registration.name) !== -1)\n    throw Error(\n      formatErrorMessage(\n        21,\n        __DEV__ && `There is already an app registered with name ${registration.name}`,\n        registration.name,\n      ),\n    );\n\n  apps.push(\n    Object.assign(\n      {\n        loadErrorTime: null,\n        status: AppOrParcelStatus.NOT_LOADED,\n        parcels: {},\n        devtools: {\n          overlays: {\n            options: {},\n            selectors: [],\n          },\n        },\n      },\n      registration,\n    ),\n  );\n\n  if (isInBrowser) {\n    ensureJQuerySupport();\n    reroute();\n  }\n}\n\nexport function checkActivityFunctions(location: SingleSpaLocation = window.location): string[] {\n  return apps.filter((app) => app.activeWhen(location)).map(toName);\n}\n\nexport function unregisterApplication(appName: string): Promise<void> {\n  if (apps.filter((app) => toName(app) === appName).length === 0) {\n    throw Error(\n      formatErrorMessage(\n        25,\n        __DEV__ && `Cannot unregister application '${appName}' because no such application has been registered`,\n        appName,\n      ),\n    );\n  }\n\n  const unloadPromise = isInBrowser\n    ? // See https://github.com/single-spa/single-spa/issues/871 for why waitForUnmount is false\n      unloadApplication(appName, { waitForUnmount: false })\n    : Promise.resolve();\n\n  return unloadPromise.then(() => {\n    const appIndex = apps.map(toName).indexOf(appName);\n    apps.splice(appIndex, 1);\n  });\n}\n\nexport function unloadApplication(\n  appName: string,\n  opts: { waitForUnmount: boolean } = { waitForUnmount: false },\n): Promise<void> {\n  if (typeof appName !== 'string') {\n    throw Error(formatErrorMessage(26, __DEV__ && `unloadApplication requires a string 'appName'`));\n  }\n  const app = apps.find((app) => toName(app) === appName);\n  if (!app) {\n    throw Error(\n      formatErrorMessage(\n        27,\n        __DEV__ && `Could not unload application '${appName}' because no such application has been registered`,\n        appName,\n      ),\n    );\n  }\n\n  const appUnloadInfo = getAppUnloadInfo(toName(app));\n  if (opts?.waitForUnmount) {\n    // We need to wait for unmount before unloading the app\n\n    if (appUnloadInfo) {\n      // Someone else is already waiting for this, too\n      return appUnloadInfo.promise;\n    } else {\n      // We're the first ones wanting the app to be resolved.\n      const promise = new Promise<void>((resolve, reject) => {\n        addAppToUnload(app, () => promise, resolve, reject);\n      });\n      return promise;\n    }\n  } else {\n    /* We should unmount the app, unload it, and remount it immediately.\n     */\n\n    let resultPromise;\n\n    if (appUnloadInfo) {\n      // Someone else is already waiting for this app to unload\n      resultPromise = appUnloadInfo.promise;\n      immediatelyUnloadApp(app, appUnloadInfo.resolve, appUnloadInfo.reject);\n    } else {\n      // We're the first ones wanting the app to be resolved.\n      resultPromise = new Promise((resolve, reject) => {\n        addAppToUnload(app, () => resultPromise, resolve, reject);\n        immediatelyUnloadApp(app, resolve, reject);\n      });\n    }\n\n    return resultPromise;\n  }\n}\n\nfunction immediatelyUnloadApp(\n  app: InternalApplication,\n  resolve: (value?: any) => void,\n  reject: (value?: any) => void,\n): void {\n  Promise.resolve()\n    .then(() => {\n      // Before unmounting the application, we first must wait for it to finish mounting\n      // Otherwise, the test for issue 871 in unregister-application.spec.js fails because\n      // the application isn't really unmounted.\n      if (checkActivityFunctions().find((activeApp) => activeApp === toName(app))) {\n        return triggerAppChange();\n      }\n    })\n    .then(() => {\n      return toUnmountPromise(app as LoadedApp)\n        .then(toUnloadPromise)\n        .then(() => {\n          resolve();\n          setTimeout(() => {\n            // reroute, but the unload promise is done\n            reroute();\n          });\n        });\n    })\n    .catch(reject);\n}\n\nfunction validateRegisterWithArguments(\n  name: string,\n  appOrLoadApp: Application,\n  activeWhen: Activity,\n  customProps?: CustomProps | CustomPropsFn,\n): void {\n  if (typeof name !== 'string' || name.length === 0)\n    throw Error(\n      formatErrorMessage(20, __DEV__ && `The 1st argument to registerApplication must be a non-empty string 'appName'`),\n    );\n\n  if (!appOrLoadApp)\n    throw Error(\n      formatErrorMessage(\n        23,\n        __DEV__ && 'The 2nd argument to registerApplication must be an application or loading application function',\n      ),\n    );\n\n  if (typeof activeWhen !== 'function')\n    throw Error(\n      formatErrorMessage(24, __DEV__ && 'The 3rd argument to registerApplication must be an activeWhen function'),\n    );\n\n  if (!validCustomProps(customProps))\n    throw Error(formatErrorMessage(22, __DEV__ && 'The optional 4th argument is a customProps and must be an object'));\n}\n\nexport function validateRegisterWithConfig(config: Partial<RegisterApplicationConfig>): void {\n  if (Array.isArray(config) || config === null)\n    throw Error(formatErrorMessage(39, __DEV__ && \"Configuration object can't be an Array or null!\"));\n  const validKeys = ['name', 'app', 'activeWhen', 'customProps'];\n  const invalidKeys = Object.keys(config).reduce(\n    (invalidKeys, prop) => (validKeys.indexOf(prop) >= 0 ? invalidKeys : invalidKeys.concat(prop)),\n    [],\n  );\n  if (invalidKeys.length !== 0)\n    throw Error(\n      formatErrorMessage(\n        38,\n        __DEV__ &&\n          `The configuration object accepts only: ${validKeys.join(', ')}. Invalid keys: ${invalidKeys.join(', ')}.`,\n        validKeys.join(', '),\n        invalidKeys.join(', '),\n      ),\n    );\n  if (typeof config.name !== 'string' || config.name.length === 0)\n    throw Error(formatErrorMessage(20, __DEV__ && 'The config.name on registerApplication must be a non-empty string'));\n  if (typeof config.app !== 'object' && typeof config.app !== 'function')\n    throw Error(\n      formatErrorMessage(\n        20,\n        __DEV__ && 'The config.app on registerApplication must be an application or a loading function',\n      ),\n    );\n  const allowsStringAndFunction = (activeWhen) => typeof activeWhen === 'string' || typeof activeWhen === 'function';\n  if (\n    !allowsStringAndFunction(config.activeWhen) &&\n    !(Array.isArray(config.activeWhen) && config.activeWhen.every(allowsStringAndFunction))\n  )\n    throw Error(\n      formatErrorMessage(\n        24,\n        __DEV__ && 'The config.activeWhen on registerApplication must be a string, function or an array with both',\n      ),\n    );\n  if (!validCustomProps(config.customProps))\n    throw Error(formatErrorMessage(22, __DEV__ && 'The optional config.customProps must be an object'));\n}\n\nfunction validCustomProps(customProps: unknown): boolean {\n  return (\n    !customProps ||\n    typeof customProps === 'function' ||\n    (typeof customProps === 'object' && customProps !== null && !Array.isArray(customProps))\n  );\n}\n\ninterface ApplicationRegistration {\n  name: string;\n  loadApp: LoadApp;\n  activeWhen: ActivityFn;\n  customProps?: CustomProps;\n}\n\nfunction sanitizeArguments<ExtraProps extends CustomProps = {}>(\n  appNameOrConfig: string | RegisterApplicationConfig,\n  appOrLoadApp: Application,\n  activeWhen: Activity,\n  customProps?: ExtraProps | CustomPropsFn<ExtraProps>,\n): ApplicationRegistration {\n  const usingObjectAPI = typeof appNameOrConfig === 'object';\n\n  let unsanitizedRegistration: {\n    name: string;\n    app: Application;\n    activeWhen: Activity;\n    customProps: CustomProps | CustomPropsFn<CustomProps>;\n  };\n\n  if (usingObjectAPI) {\n    validateRegisterWithConfig(appNameOrConfig);\n    unsanitizedRegistration = {\n      name: appNameOrConfig.name,\n      app: appNameOrConfig.app,\n      activeWhen: appNameOrConfig.activeWhen,\n      customProps: appNameOrConfig.customProps,\n    };\n  } else {\n    validateRegisterWithArguments(appNameOrConfig, appOrLoadApp, activeWhen, customProps);\n    unsanitizedRegistration = {\n      name: appNameOrConfig,\n      app: appOrLoadApp,\n      activeWhen,\n      customProps,\n    };\n  }\n\n  return {\n    name: unsanitizedRegistration.name,\n    loadApp: sanitizeLoadApp(unsanitizedRegistration.app),\n    customProps: sanitizeCustomProps(unsanitizedRegistration.customProps),\n    activeWhen: sanitizeActiveWhen(unsanitizedRegistration.activeWhen),\n  };\n}\n\nfunction sanitizeLoadApp<ExtraProps extends CustomProps = {}>(\n  loadApp: Application,\n): (config: ExtraProps & AppProps) => Promise<LifeCycles<ExtraProps>> {\n  if (typeof loadApp !== 'function') {\n    return () => Promise.resolve(loadApp);\n  }\n\n  return loadApp;\n}\n\nfunction sanitizeCustomProps(customProps?: CustomProps): CustomProps {\n  return customProps ? customProps : {};\n}\n\nfunction sanitizeActiveWhen(activeWhen: Activity): ActivityFn {\n  const activeWhenArray: (ActivityFn | string)[] = Array.isArray(activeWhen) ? activeWhen : [activeWhen];\n  const activityFnArray: ActivityFn[] = activeWhenArray.map((activeWhenOrPath) =>\n    typeof activeWhenOrPath === 'function' ? activeWhenOrPath : pathToActiveWhen(activeWhenOrPath, false),\n  );\n\n  return (location) => activityFnArray.some((activeWhen) => activeWhen(location));\n}\n\nexport function pathToActiveWhen(path: string, exactMatch?: boolean): ActivityFn {\n  const regex = toDynamicPathValidatorRegex(path, exactMatch);\n\n  return (location: Location) => {\n    const route = location.href.replace(location.origin, '').replace(location.search, '').split('?')[0];\n    return regex.test(route);\n  };\n}\n\nfunction toDynamicPathValidatorRegex(path: string, exactMatch?: boolean) {\n  let lastIndex: number = 0,\n    inDynamic: boolean = false,\n    regexStr: string = '^';\n\n  if (path[0] !== '/') {\n    path = '/' + path;\n  }\n\n  for (let charIndex = 0; charIndex < path.length; charIndex++) {\n    const char = path[charIndex];\n    const startOfDynamic = !inDynamic && char === ':';\n    const endOfDynamic = inDynamic && char === '/';\n    if (startOfDynamic || endOfDynamic) {\n      appendToRegex(charIndex);\n    }\n  }\n\n  appendToRegex(path.length);\n  return new RegExp(regexStr, 'i');\n\n  function appendToRegex(index) {\n    const anyCharMaybeTrailingSlashRegex = '[^/]+/?';\n    const commonStringSubPath = escapeStrRegex(path.slice(lastIndex, index));\n\n    regexStr += inDynamic ? anyCharMaybeTrailingSlashRegex : commonStringSubPath;\n\n    if (index === path.length) {\n      if (inDynamic) {\n        if (exactMatch) {\n          // Ensure exact match paths that end in a dynamic portion don't match\n          // urls with characters after a slash after the dynamic portion.\n          regexStr += '$';\n        }\n      } else {\n        // For exact matches, expect no more characters. Otherwise, allow\n        // any characters.\n        const suffix = exactMatch ? '' : '.*';\n\n        regexStr =\n          // use charAt instead as we could not use es6 method endsWith\n          regexStr.charAt(regexStr.length - 1) === '/' ? `${regexStr}${suffix}$` : `${regexStr}(/${suffix})?(#.*)?$`;\n      }\n    }\n\n    inDynamic = !inDynamic;\n    lastIndex = index;\n  }\n\n  function escapeStrRegex(str) {\n    // borrowed from https://github.com/sindresorhus/escape-string-regexp/blob/master/index.js\n    return str.replace(/[|\\\\{}()[\\]^$+*?.]/g, '\\\\$&');\n  }\n}\n"],"mappings":";;;;;;;;;;AAsBA,IAAM,OAA8B,CAAC;AASrC,SAAgB,gBAA4B;CAC1C,MAAM,eAAsC,CAAC,GAC3C,gBAAuC,CAAC,GACxC,aAAoC,CAAC,GACrC,cAAqC,CAAC;CAGxC,MAAM,+BAAsB,IAAI,KAAK,EAAC,CAAC,QAAQ;CAE/C,KAAK,SAAS,QAAQ;EACpB,MAAM,oBAAoB,IAAI,WAAW,iCAAA,kBAAkB,uBAAuB,iCAAA,eAAe,GAAG;EAEpG,QAAQ,IAAI,QAAZ;GACE,KAAK,iCAAA,kBAAkB;IACrB,IAAI,qBAAqB,cAAc,IAAI,iBAAiB,KAC1D,WAAW,KAAK,GAAG;IAErB;GACF,KAAK,iCAAA,kBAAkB;GACvB,KAAK,iCAAA,kBAAkB;IACrB,IAAI,mBACF,WAAW,KAAK,GAAG;IAErB;GACF,KAAK,iCAAA,kBAAkB;GACvB,KAAK,iCAAA,kBAAkB;IACrB,IAAI,CAAC,qBAAqB,0BAAA,iBAAiB,iCAAA,OAAO,GAAG,CAAC,GACpD,aAAa,KAAK,GAAG;SAChB,IAAI,mBACT,YAAY,KAAK,GAAG;IAEtB;GACF,KAAK,iCAAA,kBAAkB;IACrB,IAAI,CAAC,mBACH,cAAc,KAAK,GAAG;IAExB;EAEJ;CACF,CAAC;CAED,OAAO;EAAE;EAAc;EAAe;EAAY;CAAY;AAChE;AAEA,SAAgB,iBAA2B;CACzC,OAAO,KAAK,OAAO,iCAAA,QAAQ,CAAC,CAAC,IAAI,iCAAA,MAAM;AACzC;AAEA,SAAgB,cAAwB;CACtC,OAAO,KAAK,IAAI,iCAAA,MAAM;AACxB;AAGA,SAAgB,gBAAuC;CACrD,OAAO,CAAC,GAAG,IAAI;AACjB;AAEA,SAAgB,aAAa,SAAmC;CAC9D,MAAM,MAAM,KAAK,MAAM,QAAQ,iCAAA,OAAO,GAAG,MAAM,OAAO;CACtD,OAAO,MAAM,IAAI,SAAS;AAC5B;AAEA,IAAI,0BAAmC;AASvC,SAAgB,oBACd,iBACA,cACA,YACA,aACM;CACN,MAAM,eAAe,kBAAkB,iBAAiB,cAAc,YAAY,WAAW;CAE7F,IAAI,CAAC,cAAA,UAAU,KAAK,CAAC,yBAAyB;EAC5C,0BAA0B;EAE1B,iBAAiB;GACf,IAAI,CAAC,cAAA,UAAU,GACb,QAAQ,KACN,gCAAA,mBACE,GAAA,QAAA,IAAA,aAAA,gBAEE,uKACJ,CACF;EAEJ,GAAG,GAAI;CACT;CAEA,IAAI,YAAY,CAAC,CAAC,QAAQ,aAAa,IAAI,MAAM,IAC/C,MAAM,MACJ,gCAAA,mBACE,IAAA,QAAA,IAAA,aAAA,gBACW,gDAAgD,aAAa,QACxE,aAAa,IACf,CACF;CAEF,KAAK,KACH,OAAO,OACL;EACE,eAAe;EACf,QAAQ,iCAAA,kBAAkB;EAC1B,SAAS,CAAC;EACV,UAAU,EACR,UAAU;GACR,SAAS,CAAC;GACV,WAAW,CAAC;EACd,EACF;CACF,GACA,YACF,CACF;CAEA,IAAI,kCAAA,aAAa;EACf,uBAAA,oBAAoB;EACpB,2BAAA,QAAQ;CACV;AACF;AAEA,SAAgB,uBAAuB,WAA8B,OAAO,UAAoB;CAC9F,OAAO,KAAK,QAAQ,QAAQ,IAAI,WAAW,QAAQ,CAAC,CAAC,CAAC,IAAI,iCAAA,MAAM;AAClE;AAEA,SAAgB,sBAAsB,SAAgC;CACpE,IAAI,KAAK,QAAQ,QAAQ,iCAAA,OAAO,GAAG,MAAM,OAAO,CAAC,CAAC,WAAW,GAC3D,MAAM,MACJ,gCAAA,mBACE,IAAA,QAAA,IAAA,aAAA,gBACW,kCAAkC,QAAQ,oDACrD,OACF,CACF;CAQF,QALsB,kCAAA,cAElB,kBAAkB,SAAS,EAAE,gBAAgB,MAAM,CAAC,IACpD,QAAQ,QAAQ,EAEb,CAAc,WAAW;EAC9B,MAAM,WAAW,KAAK,IAAI,iCAAA,MAAM,CAAC,CAAC,QAAQ,OAAO;EACjD,KAAK,OAAO,UAAU,CAAC;CACzB,CAAC;AACH;AAEA,SAAgB,kBACd,SACA,OAAoC,EAAE,gBAAgB,MAAM,GAC7C;CACf,IAAI,OAAO,YAAY,UACrB,MAAM,MAAM,gCAAA,mBAAmB,IAAA,QAAA,IAAA,aAAA,gBAAe,+CAA+C,CAAC;CAEhG,MAAM,MAAM,KAAK,MAAM,QAAQ,iCAAA,OAAO,GAAG,MAAM,OAAO;CACtD,IAAI,CAAC,KACH,MAAM,MACJ,gCAAA,mBACE,IAAA,QAAA,IAAA,aAAA,gBACW,iCAAiC,QAAQ,oDACpD,OACF,CACF;CAGF,MAAM,gBAAgB,0BAAA,iBAAiB,iCAAA,OAAO,GAAG,CAAC;CAClD,IAAA,SAAA,QAAA,SAAA,KAAA,IAAA,KAAA,IAAI,KAAM,gBAGR,IAAI,eAEF,OAAO,cAAc;MAChB;EAEL,MAAM,UAAU,IAAI,SAAe,SAAS,WAAW;GACrD,0BAAA,eAAe,WAAW,SAAS,SAAS,MAAM;EACpD,CAAC;EACD,OAAO;CACT;MACK;EAIL,IAAI;EAEJ,IAAI,eAAe;GAEjB,gBAAgB,cAAc;GAC9B,qBAAqB,KAAK,cAAc,SAAS,cAAc,MAAM;EACvE,OAEE,gBAAgB,IAAI,SAAS,SAAS,WAAW;GAC/C,0BAAA,eAAe,WAAW,eAAe,SAAS,MAAM;GACxD,qBAAqB,KAAK,SAAS,MAAM;EAC3C,CAAC;EAGH,OAAO;CACT;AACF;AAEA,SAAS,qBACP,KACA,SACA,QACM;CACN,QAAQ,QAAQ,CAAC,CACd,WAAW;EAIV,IAAI,uBAAuB,CAAC,CAAC,MAAM,cAAc,cAAc,iCAAA,OAAO,GAAG,CAAC,GACxE,OAAO,2BAAA,iBAAiB;CAE5B,CAAC,CAAC,CACD,WAAW;EACV,OAAO,2BAAA,iBAAiB,GAAgB,CAAC,CACtC,KAAK,0BAAA,eAAe,CAAC,CACrB,WAAW;GACV,QAAQ;GACR,iBAAiB;IAEf,2BAAA,QAAQ;GACV,CAAC;EACH,CAAC;CACL,CAAC,CAAC,CACD,MAAM,MAAM;AACjB;AAEA,SAAS,8BACP,MACA,cACA,YACA,aACM;CACN,IAAI,OAAO,SAAS,YAAY,KAAK,WAAW,GAC9C,MAAM,MACJ,gCAAA,mBAAmB,IAAA,QAAA,IAAA,aAAA,gBAAe,8EAA8E,CAClH;CAEF,IAAI,CAAC,cACH,MAAM,MACJ,gCAAA,mBACE,IAAA,QAAA,IAAA,aAAA,gBACW,gGACb,CACF;CAEF,IAAI,OAAO,eAAe,YACxB,MAAM,MACJ,gCAAA,mBAAmB,IAAA,QAAA,IAAA,aAAA,gBAAe,wEAAwE,CAC5G;CAEF,IAAI,CAAC,iBAAiB,WAAW,GAC/B,MAAM,MAAM,gCAAA,mBAAmB,IAAA,QAAA,IAAA,aAAA,gBAAe,kEAAkE,CAAC;AACrH;AAEA,SAAgB,2BAA2B,QAAkD;CAC3F,IAAI,MAAM,QAAQ,MAAM,KAAK,WAAW,MACtC,MAAM,MAAM,gCAAA,mBAAmB,IAAA,QAAA,IAAA,aAAA,gBAAe,iDAAiD,CAAC;CAClG,MAAM,YAAY;EAAC;EAAQ;EAAO;EAAc;CAAa;CAC7D,MAAM,cAAc,OAAO,KAAK,MAAM,CAAC,CAAC,QACrC,aAAa,SAAU,UAAU,QAAQ,IAAI,KAAK,IAAI,cAAc,YAAY,OAAO,IAAI,GAC5F,CAAC,CACH;CACA,IAAI,YAAY,WAAW,GACzB,MAAM,MACJ,gCAAA,mBACE,IAAA,QAAA,IAAA,aAAA,gBAEE,0CAA0C,UAAU,KAAK,IAAI,EAAE,kBAAkB,YAAY,KAAK,IAAI,EAAE,IAC1G,UAAU,KAAK,IAAI,GACnB,YAAY,KAAK,IAAI,CACvB,CACF;CACF,IAAI,OAAO,OAAO,SAAS,YAAY,OAAO,KAAK,WAAW,GAC5D,MAAM,MAAM,gCAAA,mBAAmB,IAAA,QAAA,IAAA,aAAA,gBAAe,mEAAmE,CAAC;CACpH,IAAI,OAAO,OAAO,QAAQ,YAAY,OAAO,OAAO,QAAQ,YAC1D,MAAM,MACJ,gCAAA,mBACE,IAAA,QAAA,IAAA,aAAA,gBACW,oFACb,CACF;CACF,MAAM,2BAA2B,eAAe,OAAO,eAAe,YAAY,OAAO,eAAe;CACxG,IACE,CAAC,wBAAwB,OAAO,UAAU,KAC1C,EAAE,MAAM,QAAQ,OAAO,UAAU,KAAK,OAAO,WAAW,MAAM,uBAAuB,IAErF,MAAM,MACJ,gCAAA,mBACE,IAAA,QAAA,IAAA,aAAA,gBACW,+FACb,CACF;CACF,IAAI,CAAC,iBAAiB,OAAO,WAAW,GACtC,MAAM,MAAM,gCAAA,mBAAmB,IAAA,QAAA,IAAA,aAAA,gBAAe,mDAAmD,CAAC;AACtG;AAEA,SAAS,iBAAiB,aAA+B;CACvD,OACE,CAAC,eACD,OAAO,gBAAgB,cACtB,OAAO,gBAAgB,YAAY,gBAAgB,QAAQ,CAAC,MAAM,QAAQ,WAAW;AAE1F;AASA,SAAS,kBACP,iBACA,cACA,YACA,aACyB;CACzB,MAAM,iBAAiB,OAAO,oBAAoB;CAElD,IAAI;CAOJ,IAAI,gBAAgB;EAClB,2BAA2B,eAAe;EAC1C,0BAA0B;GACxB,MAAM,gBAAgB;GACtB,KAAK,gBAAgB;GACrB,YAAY,gBAAgB;GAC5B,aAAa,gBAAgB;EAC/B;CACF,OAAO;EACL,8BAA8B,iBAAiB,cAAc,YAAY,WAAW;EACpF,0BAA0B;GACxB,MAAM;GACN,KAAK;GACL;GACA;EACF;CACF;CAEA,OAAO;EACL,MAAM,wBAAwB;EAC9B,SAAS,gBAAgB,wBAAwB,GAAG;EACpD,aAAa,oBAAoB,wBAAwB,WAAW;EACpE,YAAY,mBAAmB,wBAAwB,UAAU;CACnE;AACF;AAEA,SAAS,gBACP,SACoE;CACpE,IAAI,OAAO,YAAY,YACrB,aAAa,QAAQ,QAAQ,OAAO;CAGtC,OAAO;AACT;AAEA,SAAS,oBAAoB,aAAwC;CACnE,OAAO,cAAc,cAAc,CAAC;AACtC;AAEA,SAAS,mBAAmB,YAAkC;CAE5D,MAAM,mBAD2C,MAAM,QAAQ,UAAU,IAAI,aAAa,CAAC,UAAU,EAC/D,CAAgB,KAAK,qBACzD,OAAO,qBAAqB,aAAa,mBAAmB,iBAAiB,kBAAkB,KAAK,CACtG;CAEA,QAAQ,aAAa,gBAAgB,MAAM,eAAe,WAAW,QAAQ,CAAC;AAChF;AAEA,SAAgB,iBAAiB,MAAc,YAAkC;CAC/E,MAAM,QAAQ,4BAA4B,MAAM,UAAU;CAE1D,QAAQ,aAAuB;EAC7B,MAAM,QAAQ,SAAS,KAAK,QAAQ,SAAS,QAAQ,EAAE,CAAC,CAAC,QAAQ,SAAS,QAAQ,EAAE,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;EACjG,OAAO,MAAM,KAAK,KAAK;CACzB;AACF;AAEA,SAAS,4BAA4B,MAAc,YAAsB;CACvE,IAAI,YAAoB,GACtB,YAAqB,OACrB,WAAmB;CAErB,IAAI,KAAK,OAAO,KACd,OAAO,MAAM;CAGf,KAAK,IAAI,YAAY,GAAG,YAAY,KAAK,QAAQ,aAAa;EAC5D,MAAM,OAAO,KAAK;EAGlB,IAFuB,CAAC,aAAa,SAAS,OACzB,aAAa,SAAS,KAEzC,cAAc,SAAS;CAE3B;CAEA,cAAc,KAAK,MAAM;CACzB,OAAO,IAAI,OAAO,UAAU,GAAG;CAE/B,SAAS,cAAc,OAAO;EAC5B,MAAM,iCAAiC;EACvC,MAAM,sBAAsB,eAAe,KAAK,MAAM,WAAW,KAAK,CAAC;EAEvE,YAAY,YAAY,iCAAiC;EAEzD,IAAI,UAAU,KAAK,QACjB,IAAI,WACF;OAAI,YAGF,YAAY;EACd,OACK;GAGL,MAAM,SAAS,aAAa,KAAK;GAEjC,WAEE,SAAS,OAAO,SAAS,SAAS,CAAC,MAAM,MAAM,GAAG,WAAW,OAAO,KAAK,GAAG,SAAS,IAAI,OAAO;EACpG;EAGF,YAAY,CAAC;EACb,YAAY;CACd;CAEA,SAAS,eAAe,KAAK;EAE3B,OAAO,IAAI,QAAQ,uBAAuB,MAAM;CAClD;AACF"}

package/dist/cjs/applications/timeouts.d.ts

@@ -0,0 +1,19 @@
+import { AppOrParcel } from '../lifecycles/lifecycle.helpers';
+export interface AppOrParcelTimeouts {
+    bootstrap: Timeout;
+    mount: Timeout;
+    unmount: Timeout;
+    unload: Timeout;
+    update: Timeout;
+}
+export interface Timeout {
+    millis: number;
+    dieOnTimeout: boolean;
+    warningMillis: number;
+}
+export declare function setBootstrapMaxTime(time: number, dieOnTimeout: boolean, warningMillis: number): void;
+export declare function setMountMaxTime(time: number, dieOnTimeout: boolean, warningMillis: number): void;
+export declare function setUnmountMaxTime(time: number, dieOnTimeout: boolean, warningMillis: number): void;
+export declare function setUnloadMaxTime(time: number, dieOnTimeout: boolean, warningMillis: number): void;
+export declare function reasonableTime(appOrParcel: AppOrParcel, lifecycle: 'bootstrap' | 'mount' | 'update' | 'unmount' | 'unload'): Promise<any>;
+export declare function ensureValidAppTimeouts(timeouts: Partial<AppOrParcelTimeouts>): AppOrParcelTimeouts;