@egen-civitas/esm-globals 1.0.0

package/README.md

@@ -0,0 +1,4 @@
+# egen-esm-globals
+
+egen-esm-globals provides events, variables, and types which are used
+throughout the rest of egen-esm-core.

package/dist/events.d.ts

@@ -0,0 +1,65 @@
+export interface ConnectivityChangedEvent {
+    online: boolean;
+}
+/** @internal */
+export declare function dispatchConnectivityChanged(online: boolean): void;
+/** @category Offline */
+export declare function subscribeConnectivityChanged(cb: (ev: ConnectivityChangedEvent) => void): () => void;
+/** @category Offline */
+export declare function subscribeConnectivity(cb: (ev: ConnectivityChangedEvent) => void): () => void;
+export interface PrecacheStaticDependenciesEvent {
+}
+export declare function dispatchPrecacheStaticDependencies(data?: PrecacheStaticDependenciesEvent): void;
+/** @category Offline */
+export declare function subscribePrecacheStaticDependencies(cb: (data: PrecacheStaticDependenciesEvent) => void): () => void;
+/** @category UI */
+export interface ShowNotificationEvent {
+    description: any;
+    kind?: 'error' | 'info' | 'info-square' | 'success' | 'warning' | 'warning-alt';
+    title?: string;
+    action?: any;
+    millis?: number;
+}
+export interface ShowActionableNotificationEvent {
+    subtitle: any;
+    kind?: 'error' | 'info' | 'info-square' | 'success' | 'warning' | 'warning-alt';
+    title?: string;
+    actionButtonLabel: string | any;
+    onActionButtonClick: () => void;
+    progressActionLabel?: string;
+}
+/** @category UI */
+export interface ShowToastEvent {
+    description: any;
+    kind?: 'error' | 'info' | 'info-square' | 'success' | 'warning' | 'warning-alt';
+    title?: string;
+    actionButtonLabel?: string | any;
+    onActionButtonClick?: () => void;
+}
+/** @category UI */
+export interface ShowSnackbarEvent {
+    subtitle?: any;
+    kind?: 'error' | 'info' | 'info-square' | 'success' | 'warning' | 'warning-alt';
+    title: string;
+    actionButtonLabel?: string | any;
+    onActionButtonClick?: () => void;
+    progressActionLabel?: string;
+    isLowContrast?: boolean;
+    timeoutInMs?: number;
+}
+export declare function dispatchNotificationShown(data: ShowNotificationEvent): void;
+/** @internal */
+export declare function dispatchActionableNotificationShown(data: ShowActionableNotificationEvent): void;
+/** @internal */
+export declare function dispatchSnackbarShown(data: ShowSnackbarEvent): void;
+/** @internal */
+export declare function dispatchToastShown(data: ShowToastEvent): void;
+/** @category UI */
+export declare function subscribeNotificationShown(cb: (data: ShowNotificationEvent) => void): () => void;
+/** @category UI */
+export declare function subscribeActionableNotificationShown(cb: (data: ShowActionableNotificationEvent) => void): () => void;
+/** @category UI */
+export declare function subscribeToastShown(cb: (data: ShowToastEvent) => void): () => void;
+/** @category UI */
+export declare function subscribeSnackbarShown(cb: (data: ShowSnackbarEvent) => void): () => void;
+//# sourceMappingURL=events.d.ts.map

package/dist/events.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../src/events.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,wBAAwB;IACvC,MAAM,EAAE,OAAO,CAAC;CACjB;AAID,gBAAgB;AAChB,wBAAgB,2BAA2B,CAAC,MAAM,EAAE,OAAO,QAE1D;AAED,wBAAwB;AACxB,wBAAgB,4BAA4B,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,wBAAwB,KAAK,IAAI,cAQtF;AAED,wBAAwB;AACxB,wBAAgB,qBAAqB,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,wBAAwB,KAAK,IAAI,cAG/E;AAGD,MAAM,WAAW,+BAA+B;CAAG;AAInD,wBAAgB,kCAAkC,CAAC,IAAI,GAAE,+BAAoC,QAE5F;AAED,wBAAwB;AACxB,wBAAgB,mCAAmC,CAAC,EAAE,EAAE,CAAC,IAAI,EAAE,+BAA+B,KAAK,IAAI,cAItG;AAED,mBAAmB;AACnB,MAAM,WAAW,qBAAqB;IACpC,WAAW,EAAE,GAAG,CAAC;IACjB,IAAI,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,aAAa,GAAG,SAAS,GAAG,SAAS,GAAG,aAAa,CAAC;IAChF,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,GAAG,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,+BAA+B;IAC9C,QAAQ,EAAE,GAAG,CAAC;IACd,IAAI,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,aAAa,GAAG,SAAS,GAAG,SAAS,GAAG,aAAa,CAAC;IAChF,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,iBAAiB,EAAE,MAAM,GAAG,GAAG,CAAC;IAChC,mBAAmB,EAAE,MAAM,IAAI,CAAC;IAChC,mBAAmB,CAAC,EAAE,MAAM,CAAC;CAC9B;AAED,mBAAmB;AACnB,MAAM,WAAW,cAAc;IAC7B,WAAW,EAAE,GAAG,CAAC;IACjB,IAAI,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,aAAa,GAAG,SAAS,GAAG,SAAS,GAAG,aAAa,CAAC;IAChF,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,iBAAiB,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC;IACjC,mBAAmB,CAAC,EAAE,MAAM,IAAI,CAAC;CAClC;AAED,mBAAmB;AACnB,MAAM,WAAW,iBAAiB;IAChC,QAAQ,CAAC,EAAE,GAAG,CAAC;IACf,IAAI,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,aAAa,GAAG,SAAS,GAAG,SAAS,GAAG,aAAa,CAAC;IAChF,KAAK,EAAE,MAAM,CAAC;IACd,iBAAiB,CAAC,EAAE,MAAM,GAAG,GAAG,CAAC;IACjC,mBAAmB,CAAC,EAAE,MAAM,IAAI,CAAC;IACjC,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAC7B,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAOD,wBAAgB,yBAAyB,CAAC,IAAI,EAAE,qBAAqB,QAEpE;AAED,gBAAgB;AAChB,wBAAgB,mCAAmC,CAAC,IAAI,EAAE,+BAA+B,QAExF;AAED,gBAAgB;AAChB,wBAAgB,qBAAqB,CAAC,IAAI,EAAE,iBAAiB,QAE5D;AAED,gBAAgB;AAChB,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,cAAc,QAEtD;AAED,mBAAmB;AACnB,wBAAgB,0BAA0B,CAAC,EAAE,EAAE,CAAC,IAAI,EAAE,qBAAqB,KAAK,IAAI,cAInF;AAED,mBAAmB;AACnB,wBAAgB,oCAAoC,CAAC,EAAE,EAAE,CAAC,IAAI,EAAE,+BAA+B,KAAK,IAAI,cAIvG;AAED,mBAAmB;AACnB,wBAAgB,mBAAmB,CAAC,EAAE,EAAE,CAAC,IAAI,EAAE,cAAc,KAAK,IAAI,cAIrE;AAED,mBAAmB;AACnB,wBAAgB,sBAAsB,CAAC,EAAE,EAAE,CAAC,IAAI,EAAE,iBAAiB,KAAK,IAAI,cAI3E"}

package/dist/events.js

@@ -0,0 +1,77 @@
+const connectivityChangedEventName = 'egen:connectivity-changed';
+/** @internal */ export function dispatchConnectivityChanged(online) {
+    window.dispatchEvent(new CustomEvent(connectivityChangedEventName, {
+        detail: {
+            online
+        }
+    }));
+}
+/** @category Offline */ export function subscribeConnectivityChanged(cb) {
+    if (!window.offlineEnabled) {
+        return ()=>{};
+    }
+    const handler = (ev)=>cb(ev.detail);
+    window.addEventListener(connectivityChangedEventName, handler);
+    return ()=>window.removeEventListener(connectivityChangedEventName, handler);
+}
+/** @category Offline */ export function subscribeConnectivity(cb) {
+    cb({
+        online: window.offlineEnabled ? navigator.onLine : true
+    });
+    return subscribeConnectivityChanged(cb);
+}
+const precacheStaticDependenciesEventName = 'egen:precache-static-dependencies';
+export function dispatchPrecacheStaticDependencies(data = {}) {
+    window.dispatchEvent(new CustomEvent(precacheStaticDependenciesEventName, {
+        detail: data
+    }));
+}
+/** @category Offline */ export function subscribePrecacheStaticDependencies(cb) {
+    const handler = (ev)=>cb(ev.detail);
+    window.addEventListener(precacheStaticDependenciesEventName, handler);
+    return ()=>window.removeEventListener(precacheStaticDependenciesEventName, handler);
+}
+const notificationShownName = 'egen:notification-shown';
+const actionableNotificationShownName = 'egen:actionable-notification-shown';
+const toastShownName = 'egen:toast-shown';
+const snackbarShownName = 'egen:snack-bar-shown';
+export function dispatchNotificationShown(data) {
+    window.dispatchEvent(new CustomEvent(notificationShownName, {
+        detail: data
+    }));
+}
+/** @internal */ export function dispatchActionableNotificationShown(data) {
+    window.dispatchEvent(new CustomEvent(actionableNotificationShownName, {
+        detail: data
+    }));
+}
+/** @internal */ export function dispatchSnackbarShown(data) {
+    window.dispatchEvent(new CustomEvent(snackbarShownName, {
+        detail: data
+    }));
+}
+/** @internal */ export function dispatchToastShown(data) {
+    window.dispatchEvent(new CustomEvent(toastShownName, {
+        detail: data
+    }));
+}
+/** @category UI */ export function subscribeNotificationShown(cb) {
+    const handler = (ev)=>cb(ev.detail);
+    window.addEventListener(notificationShownName, handler);
+    return ()=>window.removeEventListener(notificationShownName, handler);
+}
+/** @category UI */ export function subscribeActionableNotificationShown(cb) {
+    const handler = (ev)=>cb(ev.detail);
+    window.addEventListener(actionableNotificationShownName, handler);
+    return ()=>window.removeEventListener(actionableNotificationShownName, handler);
+}
+/** @category UI */ export function subscribeToastShown(cb) {
+    const handler = (ev)=>cb(ev.detail);
+    window.addEventListener(toastShownName, handler);
+    return ()=>window.removeEventListener(toastShownName, handler);
+}
+/** @category UI */ export function subscribeSnackbarShown(cb) {
+    const handler = (ev)=>cb(ev.detail);
+    window.addEventListener(snackbarShownName, handler);
+    return ()=>window.removeEventListener(snackbarShownName, handler);
+}

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export * from './events.js';
+export * from './types.js';
+export * from './type-utils.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAC;AAC5B,cAAc,YAAY,CAAC;AAC3B,cAAc,iBAAiB,CAAC"}

package/dist/index.js

@@ -0,0 +1,3 @@
+export * from "./events.js";
+export * from "./types.js";
+export * from "./type-utils.js";

package/dist/public.d.ts

@@ -0,0 +1,3 @@
+export { type ConnectivityChangedEvent, type PrecacheStaticDependenciesEvent, type ShowNotificationEvent, type ShowActionableNotificationEvent, type ShowToastEvent, type ShowSnackbarEvent, subscribeConnectivity, subscribeConnectivityChanged, subscribePrecacheStaticDependencies, subscribeNotificationShown, subscribeActionableNotificationShown, subscribeToastShown, subscribeSnackbarShown, } from './events.js';
+export * from './types.js';
+//# sourceMappingURL=public.d.ts.map

package/dist/public.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"public.d.ts","sourceRoot":"","sources":["../src/public.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,KAAK,wBAAwB,EAC7B,KAAK,+BAA+B,EACpC,KAAK,qBAAqB,EAC1B,KAAK,+BAA+B,EACpC,KAAK,cAAc,EACnB,KAAK,iBAAiB,EACtB,qBAAqB,EACrB,4BAA4B,EAC5B,mCAAmC,EACnC,0BAA0B,EAC1B,oCAAoC,EACpC,mBAAmB,EACnB,sBAAsB,GACvB,MAAM,aAAa,CAAC;AACrB,cAAc,YAAY,CAAC"}

package/dist/public.js

@@ -0,0 +1,2 @@
+export { subscribeConnectivity, subscribeConnectivityChanged, subscribePrecacheStaticDependencies, subscribeNotificationShown, subscribeActionableNotificationShown, subscribeToastShown, subscribeSnackbarShown } from "./events.js";
+export * from "./types.js";

package/dist/type-utils.d.ts

@@ -0,0 +1,18 @@
+import type { EgenAppRoutes, EgenRoutes } from './types.js';
+/**
+ * Simple type-predicate to ensure that the value can be treated as an EgenAppRoutes
+ * object.
+ *
+ * @param routes the object to check to see if it is an EgenAppRoutes object
+ * @returns true if the routes value is an EgenAppRoutes
+ */
+export declare function isEgenAppRoutes(routes: EgenAppRoutes | unknown): routes is EgenAppRoutes;
+/**
+ * Simple type-predicate to ensure that the value can be treated as an EgenRoutes
+ * object.
+ *
+ * @param routes the object to check to see if it is an EgenRoutes object
+ * @returns true if the routes value is an EgenRoutes
+ */
+export declare function isEgenRoutes(routes: EgenRoutes | unknown): routes is EgenRoutes;
+//# sourceMappingURL=type-utils.d.ts.map

package/dist/type-utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"type-utils.d.ts","sourceRoot":"","sources":["../src/type-utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAE5D;;;;;;GAMG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,aAAa,GAAG,OAAO,GAAG,MAAM,IAAI,aAAa,CAiCxF;AAED;;;;;;GAMG;AACH,wBAAgB,YAAY,CAAC,MAAM,EAAE,UAAU,GAAG,OAAO,GAAG,MAAM,IAAI,UAAU,CAQ/E"}

package/dist/type-utils.js

@@ -0,0 +1,47 @@
+/**
+ * Simple type-predicate to ensure that the value can be treated as an EgenAppRoutes
+ * object.
+ *
+ * @param routes the object to check to see if it is an EgenAppRoutes object
+ * @returns true if the routes value is an EgenAppRoutes
+ */ export function isEgenAppRoutes(routes) {
+    if (routes && typeof routes === 'object') {
+        const maybeRoutes = routes;
+        if (Object.hasOwn(routes, 'pages')) {
+            if (!Boolean(maybeRoutes.pages) || !Array.isArray(maybeRoutes.pages)) {
+                return false;
+            }
+        }
+        if (Object.hasOwn(routes, 'extensions')) {
+            if (!Boolean(maybeRoutes.extensions) || !Array.isArray(maybeRoutes.extensions)) {
+                return false;
+            }
+        }
+        if (Object.hasOwn(routes, 'workspaces')) {
+            if (!Boolean(maybeRoutes.workspaces) || !Array.isArray(maybeRoutes.workspaces)) {
+                return false;
+            }
+        }
+        if (Object.hasOwn(routes, 'modals')) {
+            if (!Boolean(maybeRoutes.modals) || !Array.isArray(maybeRoutes.modals)) {
+                return false;
+            }
+        }
+        // A completely empty object is a valid EgenAppRoutes object.
+        return true;
+    }
+    return false;
+}
+/**
+ * Simple type-predicate to ensure that the value can be treated as an EgenRoutes
+ * object.
+ *
+ * @param routes the object to check to see if it is an EgenRoutes object
+ * @returns true if the routes value is an EgenRoutes
+ */ export function isEgenRoutes(routes) {
+    if (routes && typeof routes === 'object') {
+        const maybeRoutes = routes;
+        return Object.entries(maybeRoutes).every(([key, value])=>typeof key === 'string' && isEgenAppRoutes(value));
+    }
+    return false;
+}

package/dist/types.d.ts

@@ -0,0 +1,414 @@
+import type { i18n } from 'i18next';
+declare global {
+    const __webpack_share_scopes__: Record<string, Record<string, {
+        loaded?: 1;
+        get: () => Promise<unknown>;
+        from: string;
+        eager: boolean;
+    }>>;
+    var __webpack_init_sharing__: (scope: string) => Promise<void>;
+    interface Window {
+        /**
+         * Easily copies a text from an element.
+         * @param source The source element carrying the text.
+         */
+        copyText(source: HTMLElement): void;
+        /**
+         * Gets the Egen SPA base path with a trailing slash.
+         */
+        getEgenSpaBase(): string;
+        /**
+         * Starts the Egen SPA application.
+         * @param config The configuration to use for running.
+         */
+        initializeSpa(config: SpaConfig): void;
+        /**
+         * Indicates whether offline mode is enabled in this install or not.
+         * This is used to determine whether offline functionality is present or not.
+         */
+        offlineEnabled: boolean;
+        /**
+         * Gets the API base path, e.g. /egen
+         */
+        egenBase: string;
+        /**
+         * Gets the SPA base path, e.g. /egen-civitas/spa
+         */
+        spaBase: string;
+        /**
+         * Set by the app shell. Indicates whether the app shell is running in production, development, or test mode.
+         */
+        spaEnv: SpaEnvironment;
+        /**
+         * The build number of the app shell. Set when the app shell is built by webpack.
+         */
+        spaVersion: string;
+        /**
+         * Gets the installed modules, which are tuples consisting of the module's name and exports.
+         */
+        installedModules: Array<[string, EgenAppRoutes]>;
+        /**
+         * The i18next instance for the app.
+         */
+        i18next: i18n;
+        /**
+         * Mode du système tenant : "off" | "single" | "multi".
+         * Depuis EGEN_TENANT_MODE.
+         * @default "off"
+         */
+        egenTenantMode?: 'off' | 'single' | 'multi';
+        /**
+         * Identifiant du tenant actif (mode "single") ou tenant par défaut.
+         * Depuis EGEN_TENANT_ID.
+         */
+        egenTenantId?: string;
+        /**
+         * "true" | "false" — active la persistance localStorage du tenant actif.
+         * Depuis EGEN_TENANT_PERSIST.
+         */
+        egenTenantPersist?: string;
+        /**
+         * Ordre des stratégies de résolution, CSV.
+         * Ex: "subdomain,jwt,localStorage"
+         * Depuis EGEN_TENANT_RESOLUTION_ORDER.
+         */
+        egenTenantResolutionOrder?: string;
+        /**
+         * Préfixe de path URL pour la stratégie "path".
+         * Ex: "/t/" pour /t/{tenantSlug}/...
+         * Depuis EGEN_TENANT_PATH_PREFIX.
+         */
+        egenTenantPathPrefix?: string;
+        /**
+         * Claim JWT portant l'ID tenant. Ex: "tenantId", "tid", "org".
+         * Depuis EGEN_TENANT_JWT_CLAIM.
+         */
+        egenTenantJwtClaim?: string;
+        /**
+         * Domaine racine explicite (ex: "egen.gabon.gov.ga"), utilisé pour toute
+         * dérivation hostname ↔ sous-domaine tenant (voir
+         * @egen-civitas/esm-tenant utils/domain-utils.ts). Depuis EGEN_TENANT_ROOT_DOMAIN.
+         */
+        egenTenantRootDomain?: string;
+    }
+}
+export type SpaEnvironment = 'production' | 'development' | 'test';
+export interface ImportMap {
+    imports: Record<string, string>;
+}
+/**
+ * The configuration passed to the app shell initialization function
+ */
+export interface SpaConfig {
+    /**
+     * The base path or URL for the Egen API / endpoints.
+     */
+    apiUrl: string;
+    /**
+     * The base path for the SPA root path.
+     */
+    spaPath: string;
+    /**
+     * The environment to use.
+     * @default production
+     */
+    env?: SpaEnvironment;
+    /**
+     * URLs of configurations to load in the system.
+     */
+    configUrls?: Array<string>;
+    /**
+     * Defines if offline should be supported by installing a service worker.
+     * @default true
+     */
+    offline?: boolean;
+}
+/** @internal */
+export type RouteDefinition = RegExp | string | boolean;
+/** @internal */
+type AppComponent = {
+    appName: string;
+};
+/**
+ * A definition of a page extracted from an app's routes.json
+ */
+export type PageDefinition = {
+    /**
+     * The name of the component exported by this frontend module.
+     */
+    component: string;
+    /**
+     * If supplied, the page will only be rendered when this feature flag is enabled.
+     */
+    featureFlag?: string;
+    /**
+     * Determines whether the component renders while the browser is connected to the internet. If false, this page will never render while online.
+     */
+    online?: boolean;
+    /**
+     * Determines whether the component renders while the browser is not connected to the internet. If false, this page will never render while offline.
+     */
+    offline?: boolean;
+    /**
+     * If supplied, the page will be rendered within the DOM element with the specified ID. Defaults to "egen-apps-container" if not supplied.
+     */
+    containerDomId?: string;
+} & ({
+    /**
+     * Either a string or a boolean.
+     *
+     * If a string value, this is used to indicate that this page should be rendered. For example, \"name\" will match when the current page is ${window.spaBase}/name.
+     *
+     * If a boolean, this either indicates that the component should always be rendered or should never be rendered.
+     */
+    route: string | boolean;
+    /**
+     * A regular expression used to match against the current route to determine whether this page should be rendered. Note that ${window.spaBase} will be removed before attempting to match, so setting this to \"^name.+\" will match any route that starts with ${window.spaBase}/name.
+     */
+    routeRegex?: never;
+} | {
+    /**
+     * Either a string or a boolean.
+     *
+     * If a string value, this is used to indicate that this page should be rendered. For example, \"name\" will match when the current page is ${window.spaBase}/name.
+     *
+     * If a boolean, this either indicates that the component should always be rendered or should never be rendered.
+     */
+    route?: never;
+    /**
+     * A regular expression used to match against the current route to determine whether this page should be rendered. Note that ${window.spaBase} will be removed before attempting to match, so setting this to \"^name.+\" will match any route that starts with ${window.spaBase}/name.
+     */
+    routeRegex: string;
+});
+/**
+ * @internal
+ * A definition of a page after the app has been registered.
+ */
+export type RegisteredPageDefinition = PageDefinition & AppComponent;
+/**
+ * A definition of an extension as extracted from an app's routes.json
+ */
+export type ExtensionDefinition = {
+    /**
+     * The name of this extension. This is used to refer to the extension in configuration.
+     */
+    name: string;
+    /**
+     * If supplied, the slot that this extension is rendered into by default.
+     */
+    slot?: string;
+    /**
+     * If supplied, the slots that this extension is rendered into by default.
+     */
+    slots?: Array<string>;
+    /**
+     * Determines whether the component renders while the browser is connected to the internet. If false, this page will never render while online.
+     */
+    online?: boolean;
+    /**
+     * Determines whether the component renders while the browser is not connected to the internet. If false, this page will never render while offline.
+     */
+    offline?: boolean;
+    /**
+     * Determines the order in which this component renders in its default extension slot. Note that this can be overridden by configuration.
+     */
+    order?: number;
+    /**
+     * The user must have ANY of these privileges to see this extension.
+     */
+    privileges?: string | Array<string>;
+    /**
+     * The expression that determines whether the extension is displayed.
+     */
+    displayExpression?: string;
+    /**
+     * If supplied, the extension will only be rendered when this feature flag is enabled.
+     */
+    featureFlag?: string;
+    /**
+     * Meta describes any properties that are passed down to the extension when it is loaded
+     */
+    meta?: {
+        [k: string]: unknown;
+    };
+    /**
+     * The name of the component exported by this frontend module.
+     */
+    component: string;
+};
+/**
+ * A definition of a modal as extracted from an app's routes.json
+ */
+export type ModalDefinition = {
+    /**
+     * The name of this modal. This is used to launch the modal.
+     */
+    name: string;
+    /**
+     * The name of the component exported by this frontend module.
+     */
+    component: string;
+};
+export type WorkspaceWindowState = 'maximized' | 'hidden' | 'normal';
+/**
+ * A definition of a workspace as extracted from an app's routes.json
+ */
+export type WorkspaceDefinition = {
+    /**
+     * The name of this workspace. This is used to launch the workspace.
+     */
+    name: string;
+    /**
+     * The title of the workspace. This will be looked up as a key in the translations of the module
+     * defining the workspace.
+     */
+    title: string;
+    /**
+     * The type of the workspace. Only one of each "type" of workspace is allowed to be open at a
+     * time. The default is "form". If the right sidebar is in use, then the type determines which
+     * right sidebar icon corresponds to the workspace.
+     */
+    type: string;
+    canHide?: boolean;
+    canMaximize?: boolean;
+    /**
+     * Controls the width of the workspace. The default is "narrow" and this should only be
+     * changed to "wider" if the workspace itself has internal navigation, like the form editor.
+     * The width "extra-wide" is for workspaces that contain their own sidebar.
+     */
+    width?: 'narrow' | 'wider' | 'extra-wide';
+    /**
+     * Launches the workspace in the preferred size, it defaults to the 'narrow' width
+     */
+    preferredWindowSize?: WorkspaceWindowState;
+    /**
+     * Workspaces can open either independently or as part of a "workspace group". A
+     * "workspace group" groups related workspaces together, so that only one is visible
+     * at a time. For example,
+     *
+     * @example
+     *
+     * {
+     *  name: 'order-basket',
+     *  type: 'order',
+     *  groups: ['entity-workspace-group']
+     * }
+     *
+     * This means that the 'order-basket' workspace can be opened independently, or only
+     * in the 'entity-workspace-group'.
+     * If a workspace group is already open and a new workspace is launched, and the
+     * groups in the newly launched workspace do not include the currently open group’s
+     * name, the entire workspace group will close, and the new workspace will launch independently.
+     *
+     */
+    groups: Array<string>;
+    /**
+     * The name of the component exported by this frontend module.
+     */
+    component: string;
+};
+export interface WorkspaceGroupDefinition {
+    /**
+     * Name of the workspace group. This is used to launch the workspace group
+     */
+    name: string;
+    /**
+     * List of workspace names which are part of the workspace group.
+     */
+    members?: Array<string>;
+}
+export interface WorkspaceGroupDefinition2 {
+    name: string;
+    closeable?: boolean;
+    overlay?: boolean;
+    /**
+     * In app-wide persistence mode, a workspace group renders its
+     * action menu without a close button. This is for
+     * workspace groups that are meant to be opened for the entire duration of the app
+     *
+     * In closable persistence mode, a workspace group renders its
+     * action menu with a close button. User may explicitly close the group, along
+     * with any opened windows / workspaces.
+     */
+    persistence?: 'app-wide' | 'closable';
+    /**
+     * URL pattern that defines the scope where workspaces in this group should persist.
+     * - If not defined: workspaces close only when navigating to a different app
+     * - If defined without capture groups: workspaces close when URL doesn't match pattern
+     * - If defined with capture groups: workspaces close when captured values change
+     *
+     * @example "^/home/appointments" - static scope for appointments dashboard
+     * @example "^/entity/([^/]+)/detail" - dynamic scope by entity UUID
+     */
+    scopePattern?: string;
+}
+export interface WorkspaceWindowDefinition2 {
+    name: string;
+    icon?: string;
+    canMaximize?: boolean;
+    group: string;
+    order?: number;
+    width?: 'narrow' | 'wider' | 'extra-wide';
+}
+export interface WorkspaceDefinition2 {
+    name: string;
+    component: string;
+    window: string;
+}
+/**
+ * A definition of a feature flag extracted from the routes.json
+ */
+export interface FeatureFlagDefinition {
+    /** A code-friendly name for the flag, which will be used to reference it in code */
+    flagName: string;
+    /** A human-friendly name which will be displayed in the Implementer Tools */
+    label: string;
+    /** An explanation of what the flag does, which will be displayed in the Implementer Tools */
+    description: string;
+}
+/** This interface describes the format of the routes provided by an app */
+export interface EgenAppRoutes {
+    /** The version of this frontend module. */
+    version?: string;
+    /** A list of backend modules necessary for this frontend module and the corresponding required versions. */
+    backendDependencies?: Record<string, string>;
+    /** A list of backend modules that may enable optional functionality in this frontend module if available and the corresponding required versions. */
+    optionalBackendDependencies?: {
+        /** The name of the backend dependency and either the required version or an object describing the required version */
+        [key: string]: string | {
+            /** The minimum version of this optional dependency that must be present. */
+            version: string;
+            /** The feature flag to enable if this backend dependency is present */
+            feature?: FeatureFlagDefinition;
+        };
+    };
+    /** An array of all pages supported by this frontend module. Pages are automatically mounted based on a route. */
+    pages?: Array<PageDefinition>;
+    /**  An array of all extensions supported by this frontend module. Extensions can be mounted in extension slots, either via declarations in this file or configuration. */
+    extensions?: Array<ExtensionDefinition>;
+    /** An array of all feature flags for any beta-stage features this module provides. */
+    featureFlags?: Array<FeatureFlagDefinition>;
+    /** An array of all modals supported by this frontend module. Modals can be launched by name. */
+    modals?: Array<ModalDefinition>;
+    /** An array of all workspaces supported by this frontend module. Workspaces can be launched by name. */
+    workspaces?: Array<WorkspaceDefinition>;
+    /** An array of all workspace groups supported by this frontend module. */
+    workspaceGroups?: Array<WorkspaceGroupDefinition>;
+    /** An array of all workspace groups (v2) supported by this frontend module. */
+    workspaceGroups2?: Array<WorkspaceGroupDefinition2>;
+    /** An array of all workspace windows (v2) supported by this frontend module. */
+    workspaceWindows2?: Array<WorkspaceWindowDefinition2>;
+    /** An array of all workspaces (v2) supported by this frontend module. */
+    workspaces2?: Array<WorkspaceDefinition2>;
+}
+/**
+ * This interfaces describes the format of the overall routes.json loaded by the app shell.
+ * Basically, this is the same as the app routes, with each routes definition keyed by the app's name
+ */
+export type EgenRoutes = Record<string, EgenAppRoutes>;
+export interface ResourceLoader<T = any> {
+    (): Promise<T>;
+}
+export type NameUse = 'usual' | 'official' | 'temp' | 'nickname' | 'anonymous' | 'old' | 'maiden';
+export {};
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,SAAS,CAAC;AAEpC,OAAO,CAAC,MAAM,CAAC;IACb,MAAM,wBAAwB,EAAE,MAAM,CACpC,MAAM,EACN,MAAM,CAAC,MAAM,EAAE;QAAE,MAAM,CAAC,EAAE,CAAC,CAAC;QAAC,GAAG,EAAE,MAAM,OAAO,CAAC,OAAO,CAAC,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,OAAO,CAAA;KAAE,CAAC,CAC1F,CAAC;IAGF,IAAI,wBAAwB,EAAE,CAAC,KAAK,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;IAE/D,UAAU,MAAM;QACd;;;WAGG;QACH,QAAQ,CAAC,MAAM,EAAE,WAAW,GAAG,IAAI,CAAC;QACpC;;WAEG;QACH,cAAc,IAAI,MAAM,CAAC;QACzB;;;WAGG;QACH,aAAa,CAAC,MAAM,EAAE,SAAS,GAAG,IAAI,CAAC;QACvC;;;WAGG;QACH,cAAc,EAAE,OAAO,CAAC;QACxB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QACjB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAChB;;WAEG;QACH,MAAM,EAAE,cAAc,CAAC;QACvB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QACnB;;WAEG;QACH,gBAAgB,EAAE,KAAK,CAAC,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC,CAAC;QACjD;;WAEG;QACH,OAAO,EAAE,IAAI,CAAC;QAad;;;;WAIG;QACH,cAAc,CAAC,EAAE,KAAK,GAAG,QAAQ,GAAG,OAAO,CAAC;QAE5C;;;WAGG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;;WAGG;QACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAE3B;;;;WAIG;QACH,yBAAyB,CAAC,EAAE,MAAM,CAAC;QAEnC;;;;WAIG;QACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAE9B;;;WAGG;QACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;QAE5B;;;;WAIG;QACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;KAC/B;CACF;AAED,MAAM,MAAM,cAAc,GAAG,YAAY,GAAG,aAAa,GAAG,MAAM,CAAC;AAEnE,MAAM,WAAW,SAAS;IACxB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,GAAG,CAAC,EAAE,cAAc,CAAC;IACrB;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAC3B;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,gBAAgB;AAChB,MAAM,MAAM,eAAe,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;AAExD,gBAAgB;AAChB,KAAK,YAAY,GAAG;IAClB,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB,GAAG,CACA;IACE;;;;;;OAMG;IACH,KAAK,EAAE,MAAM,GAAG,OAAO,CAAC;IACxB;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC;CACpB,GACD;IACE;;;;;;OAMG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC;IACd;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB,CACJ,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAAG,cAAc,GAAG,YAAY,CAAC;AAErE;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACtB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;IACpC;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAC3B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,IAAI,CAAC,EAAE;QACL,CAAC,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;KACtB,CAAC;IACF;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAGF,MAAM,MAAM,oBAAoB,GAAG,WAAW,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAErE;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;;;OAIG;IACH,KAAK,CAAC,EAAE,QAAQ,GAAG,OAAO,GAAG,YAAY,CAAC;IAC1C;;OAEG;IACH,mBAAmB,CAAC,EAAE,oBAAoB,CAAC;IAE3C;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IACtB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACzB;AAED,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;;;;;;OAQG;IACH,WAAW,CAAC,EAAE,UAAU,GAAG,UAAU,CAAC;IAEtC;;;;;;;;OAQG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,0BAA0B;IACzC,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,QAAQ,GAAG,OAAO,GAAG,YAAY,CAAC;CAC3C;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,oFAAoF;IACpF,QAAQ,EAAE,MAAM,CAAC;IACjB,6EAA6E;IAC7E,KAAK,EAAE,MAAM,CAAC;IACd,6FAA6F;IAC7F,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,2EAA2E;AAC3E,MAAM,WAAW,aAAa;IAC5B,2CAA2C;IAC3C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,4GAA4G;IAC5G,mBAAmB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC7C,qJAAqJ;IACrJ,2BAA2B,CAAC,EAAE;QAC5B,sHAAsH;QACtH,CAAC,GAAG,EAAE,MAAM,GACR,MAAM,GACN;YACE,4EAA4E;YAC5E,OAAO,EAAE,MAAM,CAAC;YAChB,uEAAuE;YACvE,OAAO,CAAC,EAAE,qBAAqB,CAAC;SACjC,CAAC;KACP,CAAC;IACF,iHAAiH;IACjH,KAAK,CAAC,EAAE,KAAK,CAAC,cAAc,CAAC,CAAC;IAC9B,0KAA0K;IAC1K,UAAU,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;IACxC,sFAAsF;IACtF,YAAY,CAAC,EAAE,KAAK,CAAC,qBAAqB,CAAC,CAAC;IAC5C,gGAAgG;IAChG,MAAM,CAAC,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;IAChC,wGAAwG;IACxG,UAAU,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;IACxC,0EAA0E;IAC1E,eAAe,CAAC,EAAE,KAAK,CAAC,wBAAwB,CAAC,CAAC;IAElD,+EAA+E;IAC/E,gBAAgB,CAAC,EAAE,KAAK,CAAC,yBAAyB,CAAC,CAAC;IAEpD,gFAAgF;IAChF,iBAAiB,CAAC,EAAE,KAAK,CAAC,0BAA0B,CAAC,CAAC;IAEtD,yEAAyE;IACzE,WAAW,CAAC,EAAE,KAAK,CAAC,oBAAoB,CAAC,CAAC;CAC3C;AAED;;;GAGG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;AAEvD,MAAM,WAAW,cAAc,CAAC,CAAC,GAAG,GAAG;IACrC,IAAI,OAAO,CAAC,CAAC,CAAC,CAAC;CAChB;AAKD,MAAM,MAAM,OAAO,GAAG,OAAO,GAAG,UAAU,GAAG,MAAM,GAAG,UAAU,GAAG,WAAW,GAAG,KAAK,GAAG,QAAQ,CAAC"}

package/dist/types.js

@@ -0,0 +1,3 @@
+/*
+ * Supported values for FHIR HumanName.use as defined by https://hl7.org/fhir/R4/valueset-name-use.html
+ */ export { };

package/package.json

@@ -0,0 +1,67 @@
+{
+  "name": "@egen-civitas/esm-globals",
+  "version": "1.0.0",
+  "license": "MPL-2.0",
+  "type": "module",
+  "main": "dist/index.js",
+  "files": [
+    "dist"
+  ],
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./src/public": {
+      "types": "./dist/public.d.ts",
+      "default": "./dist/public.js"
+    }
+  },
+  "source": true,
+  "scripts": {
+    "build": "rimraf dist && concurrently \"swc --strip-leading-paths src -d dist\" \"tsc --project tsconfig.build.json\"",
+    "build:development": "rimraf dist && concurrently \"swc --strip-leading-paths src -d dist\" \"tsc --project tsconfig.build.json\"",
+    "test": "vitest run --passWithNoTests",
+    "test:watch": "cross-env TZ=UTC vitest watch --passWithNoTests",
+    "coverage": "cross-env TZ=UTC vitest run --coverage --passWithNoTests",
+    "typescript": "tsc --project tsconfig.build.json",
+    "lint": "eslint src --ext ts,tsx"
+  },
+  "keywords": [
+    "egen",
+    "framework",
+    "frontend",
+    "ui",
+    "microfrontends"
+  ],
+  "browserslist": [
+    "extends browserslist-config-egen"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/egen-civitas/egen-esm-core.git"
+  },
+  "bugs": {
+    "url": "https://github.com/egen-civitas/egen-esm-core/issues"
+  },
+  "homepage": "https://github.com/egen-civitas/egen-esm-core#readme",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@types/fhir": "0.0.31"
+  },
+  "peerDependencies": {
+    "single-spa": "6.x"
+  },
+  "devDependencies": {
+    "@swc/cli": "0.8.1",
+    "@swc/core": "1.15.21",
+    "concurrently": "^9.2.1",
+    "rimraf": "^6.1.3",
+    "single-spa": "^6.0.3",
+    "vitest": "^4.1.2"
+  }
+}