@openmrs/esm-globals 4.0.0-pre.0 → 4.0.0-pre.1

package/.turbo/turbo-build.log

@@ -1,12 +1,12 @@
-@openmrs/esm-globals:build: cache hit, replaying output f68983b4aad6321a
-@openmrs/esm-globals:build: $ webpack --mode=production
-@openmrs/esm-globals:build: asset openmrs-esm-globals.js 3.52 KiB [emitted] [minimized] (name: main) 1 related asset
-@openmrs/esm-globals:build: runtime modules 1.76 KiB 6 modules
-@openmrs/esm-globals:build: orphan modules 2.91 KiB [orphan] 3 modules
-@openmrs/esm-globals:build: cacheable modules 6.25 KiB
-@openmrs/esm-globals:build:   modules by path ../../../node_modules/systemjs-webpack-interop/auto-public-path/*.js 935 bytes
-@openmrs/esm-globals:build:     ../../../node_modules/systemjs-webpack-interop/auto-public-path/1.js 89 bytes [built] [code generated]
-@openmrs/esm-globals:build:     ../../../node_modules/systemjs-webpack-interop/auto-public-path/auto-public-path.js 846 bytes [built] [code generated]
-@openmrs/esm-globals:build:   ./src/index.ts + 2 modules 2.97 KiB [built] [code generated]
-@openmrs/esm-globals:build:   ../../../node_modules/systemjs-webpack-interop/public-path.js 2.36 KiB [built] [code generated]
-@openmrs/esm-globals:build: webpack 5.70.0 compiled successfully in 6750 ms
+@openmrs/esm-globals:build: cache hit, replaying output cfa64264ff6d658c
+@openmrs/esm-globals:build: $ webpack --mode=production
+@openmrs/esm-globals:build: asset openmrs-esm-globals.js 3.52 KiB [emitted] [minimized] (name: main) 1 related asset
+@openmrs/esm-globals:build: runtime modules 1.76 KiB 6 modules
+@openmrs/esm-globals:build: orphan modules 2.91 KiB [orphan] 3 modules
+@openmrs/esm-globals:build: cacheable modules 6.25 KiB
+@openmrs/esm-globals:build:   modules by path ../../../node_modules/systemjs-webpack-interop/auto-public-path/*.js 935 bytes
+@openmrs/esm-globals:build:     ../../../node_modules/systemjs-webpack-interop/auto-public-path/1.js 89 bytes [built] [code generated]
+@openmrs/esm-globals:build:     ../../../node_modules/systemjs-webpack-interop/auto-public-path/auto-public-path.js 846 bytes [built] [code generated]
+@openmrs/esm-globals:build:   ./src/index.ts + 2 modules 2.97 KiB [built] [code generated]
+@openmrs/esm-globals:build:   ../../../node_modules/systemjs-webpack-interop/public-path.js 2.36 KiB [built] [code generated]
+@openmrs/esm-globals:build: webpack 5.70.0 compiled successfully in 21988 ms

package/.turbo/turbo-lint.log

@@ -1,2 +1,2 @@
-@openmrs/esm-globals:lint: cache hit, replaying output 76afcd8be8678481
-@openmrs/esm-globals:lint: $ eslint src --ext ts,tsx
+@openmrs/esm-globals:lint: cache hit, replaying output 99dc52c66e4f35f0
+@openmrs/esm-globals:lint: $ eslint src --ext ts,tsx

package/.turbo/turbo-typescript.log

@@ -1,2 +1,2 @@
-@openmrs/esm-globals:typescript: cache hit, replaying output 7eee13383623d7c0
+@openmrs/esm-globals:typescript: cache hit, replaying output 0a8841f46a788712
 @openmrs/esm-globals:typescript: $ tsc

package/dist/events.d.ts

@@ -0,0 +1,33 @@
+export interface ConnectivityChangedEvent {
+    online: boolean;
+}
+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;
+}
+/** @category UI */
+export interface ShowToastEvent {
+    description: any;
+    kind?: "error" | "info" | "info-square" | "success" | "warning" | "warning-alt";
+    title?: string;
+    millis?: number;
+}
+export declare function dispatchNotificationShown(data: ShowNotificationEvent): void;
+/** @category UI */
+export declare function subscribeNotificationShown(cb: (data: ShowNotificationEvent) => void): () => void;
+/** @category UI */
+export declare function subscribeToastShown(cb: (data: ShowToastEvent) => void): () => void;

package/dist/globals.d.ts

@@ -0,0 +1,3 @@
+import { SpaConfig } from "./types";
+export declare function setupPaths(config: SpaConfig): void;
+export declare function setupUtils(): void;

package/dist/index.d.ts

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

package/dist/public.d.ts

@@ -0,0 +1,2 @@
+export { ConnectivityChangedEvent, subscribeConnectivity, subscribeConnectivityChanged, subscribePrecacheStaticDependencies, PrecacheStaticDependenciesEvent, subscribeNotificationShown, subscribeToastShown, ShowNotificationEvent, ShowToastEvent, } from "./events";
+export * from "./types";

package/dist/types.d.ts

@@ -0,0 +1,137 @@
+import { LifeCycleFn } from "single-spa";
+declare global {
+    interface Window {
+        /**
+         * Easily copies a text from an element.
+         * @param source The source element carrying the text.
+         */
+        copyText(source: HTMLElement): void;
+        /**
+         * Gets the OpenMRS SPA base path with a trailing slash.
+         */
+        getOpenmrsSpaBase(): string;
+        /**
+         * Starts the OpenMRS SPA application.
+         * @param config The configuration to use for running.
+         */
+        initializeSpa(config: SpaConfig): void;
+        /**
+         * Gets the API base path.
+         */
+        openmrsBase: string;
+        /**
+         * Gets the SPA base path.
+         */
+        spaBase: string;
+        /**
+         * Gets the determined SPA environment.
+         */
+        spaEnv: SpaEnvironment;
+        /**
+         * Gets the published SPA version.
+         */
+        spaVersion?: string;
+        /**
+         * Gets a set of options from the import-map-overrides package.
+         */
+        importMapOverrides: {
+            getCurrentPageMap: () => Promise<ImportMap>;
+            addOverride(moduleName: string, url: string): void;
+        };
+        /**
+         * Gets the installed modules, which are tuples consisting of the module's name and exports.
+         */
+        installedModules: Array<[string, any]>;
+        /**
+         * The remotes from Webpack Module Federation.
+         */
+        __remotes__: Record<string, string>;
+    }
+}
+export declare type SpaEnvironment = "production" | "development" | "test";
+export interface ImportMap {
+    imports: Record<string, string>;
+}
+export interface Lifecycle {
+    bootstrap: LifeCycleFn<any>;
+    mount: LifeCycleFn<any>;
+    unmount: LifeCycleFn<any>;
+    update?: LifeCycleFn<any>;
+}
+export interface SpaConfig {
+    /**
+     * The base path or URL for the OpenMRS 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;
+}
+export interface ResourceLoader<T = any> {
+    (): Promise<T>;
+}
+export interface ComponentDefinition {
+    /**
+     * The module/app that defines the component
+     */
+    appName: string;
+    /**
+     * Defines a function to use for actually loading the component's lifecycle.
+     */
+    load(): Promise<any>;
+    /**
+     * Defines the online support / properties of the component.
+     */
+    online?: boolean | object;
+    /**
+     * Defines the offline support / properties of the component.
+     */
+    offline?: boolean | object;
+    /**
+     * Defines the access privilege required for this component, if any.
+     */
+    privilege?: string;
+    /**
+     * Defines resources that are loaded when the component should mount.
+     */
+    resources?: Record<string, ResourceLoader>;
+}
+export interface ExtensionDefinition extends ComponentDefinition {
+    /** The name of the extension being registered */
+    name: string;
+    /** A slot to attach to */
+    slot?: string;
+    /** Slots to attach to */
+    slots?: Array<string>;
+    /** The meta data used for reflection by other components */
+    meta?: Record<string, any>;
+    /** Specifies the relative order in which the extension renders in a slot */
+    order?: number;
+    /** @deprecated A confusing way to specify the name of the extension */
+    id?: string;
+}
+export interface PageDefinition extends ComponentDefinition {
+    /**
+     * The route of the page.
+     */
+    route: string;
+    /**
+     * The order in which to load the page. This determines DOM order.
+     */
+    order: number;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-globals",
-  "version": "4.0.0-pre.0",
+  "version": "4.0.0-pre.1",
   "license": "MPL-2.0",
   "browser": "dist/openmrs-esm-globals.js",
   "main": "src/index.ts",
@@ -38,5 +38,5 @@
   "devDependencies": {
     "single-spa": "^5.9.3"
   },
-  "gitHead": "254a7226212aac82df4434639b2584e24ac240e4"
+  "gitHead": "9f58b801f07526083a9edc1cc5a1e58660d71eb0"
 }

package/src/types.ts

@@ -48,8 +48,6 @@ declare global {
      */
     __remotes__: Record<string, string>;
   }
-  const __webpack_init_sharing__: any;
-  const __webpack_share_scopes__: any;
 }
 
 export type SpaEnvironment = "production" | "development" | "test";