@openmrs/esm-extensions 3.4.1-pre.96 → 4.0.0-pre.1

package/.turbo/turbo-build.log

@@ -1,17 +1,17 @@
-@openmrs/esm-extensions:build: cache hit, replaying output aaba4bc9d7de9857
+@openmrs/esm-extensions:build: cache hit, replaying output 0a81417206c990fd
 @openmrs/esm-extensions:build: $ webpack --mode=production
-@openmrs/esm-extensions:build: asset openmrs-esm-extensions.js 22.5 KiB [emitted] [minimized] (name: main) 1 related asset
-@openmrs/esm-extensions:build: orphan modules 88 KiB [orphan] 93 modules
+@openmrs/esm-extensions:build: asset openmrs-esm-extensions.js 22.5 KiB [emitted] [minimized] (name: main) 1 related asset
+@openmrs/esm-extensions:build: orphan modules 88 KiB [orphan] 93 modules
 @openmrs/esm-extensions:build: runtime modules 1.76 KiB 6 modules
-@openmrs/esm-extensions:build: built modules 91.8 KiB [built]
+@openmrs/esm-extensions:build: built modules 91.8 KiB [built]
 @openmrs/esm-extensions:build:   cacheable modules 91.7 KiB
-@openmrs/esm-extensions:build:     modules by path ../../../node_modules/systemjs-webpack-interop/auto-public-path/*.js 935 bytes
-@openmrs/esm-extensions:build:       ../../../node_modules/systemjs-webpack-interop/auto-public-path/1.js 89 bytes [built] [code generated]
-@openmrs/esm-extensions:build:       ../../../node_modules/systemjs-webpack-interop/auto-public-path/auto-public-path.js 846 bytes [built] [code generated]
-@openmrs/esm-extensions:build:     ./src/index.ts + 93 modules 88.4 KiB [built] [code generated]
-@openmrs/esm-extensions:build:     ../../../node_modules/systemjs-webpack-interop/public-path.js 2.36 KiB [built] [code generated]
-@openmrs/esm-extensions:build:   modules by path external "@openmrs/ 84 bytes
-@openmrs/esm-extensions:build:     external "@openmrs/esm-config" 42 bytes [built] [code generated]
-@openmrs/esm-extensions:build:     external "@openmrs/esm-state" 42 bytes [built] [code generated]
-@openmrs/esm-extensions:build:   external "single-spa" 42 bytes [built] [code generated]
-@openmrs/esm-extensions:build: webpack 5.70.0 compiled successfully in 6489 ms
+@openmrs/esm-extensions:build:     modules by path ../../../node_modules/systemjs-webpack-interop/auto-public-path/*.js 935 bytes
+@openmrs/esm-extensions:build:       ../../../node_modules/systemjs-webpack-interop/auto-public-path/1.js 89 bytes [built] [code generated]
+@openmrs/esm-extensions:build:       ../../../node_modules/systemjs-webpack-interop/auto-public-path/auto-public-path.js 846 bytes [built] [code generated]
+@openmrs/esm-extensions:build:     ./src/index.ts + 93 modules 88.4 KiB [built] [code generated]
+@openmrs/esm-extensions:build:     ../../../node_modules/systemjs-webpack-interop/public-path.js 2.36 KiB [built] [code generated]
+@openmrs/esm-extensions:build:   modules by path external "@openmrs/ 84 bytes
+@openmrs/esm-extensions:build:     external "@openmrs/esm-config" 42 bytes [built] [code generated]
+@openmrs/esm-extensions:build:     external "@openmrs/esm-state" 42 bytes [built] [code generated]
+@openmrs/esm-extensions:build:   external "single-spa" 42 bytes [built] [code generated]
+@openmrs/esm-extensions:build: webpack 5.70.0 compiled successfully in 14185 ms

package/.turbo/turbo-lint.log

@@ -0,0 +1,2 @@
+@openmrs/esm-extensions:lint: cache hit, replaying output 7286e3a9b320f231
+@openmrs/esm-extensions:lint: $ eslint src --ext ts,tsx

package/.turbo/turbo-test.log

@@ -0,0 +1,11 @@
+@openmrs/esm-extensions:test: cache hit, replaying output f89b505cbba66733
+@openmrs/esm-extensions:test: $ jest --config jest.config.js --passWithNoTests
+@openmrs/esm-extensions:test: PASS src/extensions.test.ts
+@openmrs/esm-extensions:test:   extensions system
+@openmrs/esm-extensions:test:     ✓ shouldn't crash when a slot is registered before the extensions that go in it (30 ms)
+@openmrs/esm-extensions:test: 
+@openmrs/esm-extensions:test: Test Suites: 1 passed, 1 total
+@openmrs/esm-extensions:test: Tests:       1 passed, 1 total
+@openmrs/esm-extensions:test: Snapshots:   0 total
+@openmrs/esm-extensions:test: Time:        6.626 s
+@openmrs/esm-extensions:test: Ran all test suites.

package/.turbo/turbo-typescript.log

@@ -0,0 +1,2 @@
+@openmrs/esm-extensions:typescript: cache hit, replaying output a8c48928509ca20d
+@openmrs/esm-extensions:typescript: $ tsc

package/dist/extensions.d.ts

@@ -0,0 +1,73 @@
+/** @module @category Extension */
+import { AssignedExtension, ConnectedExtension } from ".";
+import { ExtensionRegistration, ExtensionInternalStore } from "./store";
+/**
+ * Given an extension ID, which is a string uniquely identifying
+ * an instance of an extension within an extension slot, this
+ * returns the extension name.
+ *
+ * @example
+ * ```js
+ * getExtensionNameFromId("foo#bar")
+ *  --> "foo"
+ * getExtensionNameFromId("baz")
+ *  --> "baz"
+ * ```
+ */
+export declare function getExtensionNameFromId(extensionId: string): string;
+export declare function getExtensionRegistrationFrom(state: ExtensionInternalStore, extensionId: string): ExtensionRegistration | undefined;
+export declare function getExtensionRegistration(extensionId: string): ExtensionRegistration | undefined;
+/**
+ * Extensions must be registered in order to be rendered.
+ * This is handled by the app shell, when extensions are provided
+ * via the `setupOpenMRS` return object.
+ * @internal
+ */
+export declare const registerExtension: (extensionRegistration: ExtensionRegistration) => void;
+/**
+ * Attach an extension to an extension slot.
+ *
+ * This will cause the extension to be rendered into the specified
+ * extension slot, unless it is removed by configuration. Using
+ * `attach` is an alternative to specifying the `slot` or `slots`
+ * in the extension declaration.
+ *
+ * It is particularly useful when creating a slot into which
+ * you want to render an existing extension. This enables you
+ * to do so without modifying the extension's declaration, which
+ * may be impractical or inappropriate, for example if you are
+ * writing a module for a specific implementation.
+ *
+ * @param slotName a name uniquely identifying the slot
+ * @param extensionId an extension name, with an optional #-suffix
+ *    to distinguish it from other instances of the same extension
+ *    attached to the same slot.
+ */
+export declare function attach(slotName: string, extensionId: string): void;
+/** Avoid using this. Extension attachments should be considered declarative. */
+export declare function detach(extensionSlotName: string, extensionId: string): void;
+/** Avoid using this. Extension attachments should be considered declarative. */
+export declare function detachAll(extensionSlotName: string): void;
+/**
+ * Filters a list of extensions according to whether they support the
+ * current connectivity status.
+ *
+ * @param assignedExtensions The list of extensions to filter.
+ * @param online Whether the app is currently online. If `null`, uses `navigator.onLine`.
+ * @returns A list of extensions that should be rendered
+ */
+export declare function getConnectedExtensions(assignedExtensions: Array<AssignedExtension>, online?: boolean | null): Array<ConnectedExtension>;
+export declare function getAssignedExtensions(slotName: string): Array<AssignedExtension>;
+/**
+ * Used by by extension slots at mount time.
+ *
+ * @param moduleName The name of the module that contains the extension slot
+ * @param slotName The extension slot name that is actually used
+ * @internal
+ */
+export declare const registerExtensionSlot: (moduleName: string, slotName: string) => void;
+/**
+ * @internal
+ * Just for testing.
+ */
+export declare const reset: () => void;

package/dist/extensions.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/helpers.d.ts

@@ -0,0 +1,3 @@
+export declare function checkStatus(online?: boolean | object, offline?: boolean | object): boolean;
+export declare function checkStatusFor(status: boolean, online?: boolean | object, offline?: boolean | object): boolean;
+export declare function getCustomProps(online: boolean | object | undefined, offline: boolean | object | undefined): object;

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+export * from "./store";
+export * from "./extensions";
+export * from "./helpers";
+export * from "./render";
+/** @deprecated Use `getExtensionStore`. The structure of this store has also changed. */
+declare const internalStore: import("unistore").Store<import("./store").ExtensionInternalStore>;
+export { internalStore as extensionStore };

package/dist/public.d.ts

@@ -0,0 +1,3 @@
+export { getExtensionNameFromId, registerExtension, attach, detach, detachAll, getConnectedExtensions, getAssignedExtensions, registerExtensionSlot, } from "./extensions";
+export { renderExtension, CancelLoading } from "./render";
+export { ExtensionMeta, ExtensionRegistration, AssignedExtension, ConnectedExtension, ExtensionStore, ExtensionSlotState, getExtensionStore, } from "./store";

package/dist/render.d.ts

@@ -0,0 +1,11 @@
+/** @module @category Extension */
+import { Lifecycle } from "@openmrs/esm-globals";
+export interface CancelLoading {
+    (): void;
+}
+/**
+ * Mounts into a DOM node (representing an extension slot)
+ * a lazy-loaded component from *any* frontend module
+ * that registered an extension component for this slot.
+ */
+export declare function renderExtension(domElement: HTMLElement, extensionSlotName: string, extensionSlotModuleName: string, extensionId: string, renderFunction?: (lifecycle: Lifecycle) => Lifecycle, additionalProps?: Record<string, any>): CancelLoading;

package/dist/store.d.ts

@@ -0,0 +1,87 @@
+import { ConfigObject, ExtensionSlotConfigObject } from "@openmrs/esm-config";
+export interface ExtensionMeta {
+    [_: string]: any;
+}
+export interface ExtensionRegistration {
+    name: string;
+    load(): Promise<any>;
+    moduleName: string;
+    meta: ExtensionMeta;
+    order?: number;
+    online?: boolean | object;
+    offline?: boolean | object;
+}
+export interface ExtensionInfo extends ExtensionRegistration {
+    /**
+     * The instances where the extension has been rendered using `renderExtension`.
+     */
+    instances: Array<ExtensionInstance>;
+}
+export interface ExtensionInstance {
+    id: string;
+    slotName: string;
+    slotModuleName: string;
+}
+export interface ExtensionInternalStore {
+    /** Slots indexed by name */
+    slots: Record<string, ExtensionSlotInfo>;
+    /** Extensions indexed by name */
+    extensions: Record<string, ExtensionInfo>;
+}
+export interface ExtensionSlotInfo {
+    /**
+     * The module in which the extension slot exists. Undefined if the slot
+     * hasn't been registered yet (but it has been attached or assigned to
+     * an extension.
+     */
+    moduleName?: string;
+    /** The name under which the extension slot has been registered. */
+    name: string;
+    /**
+     * The set of extension IDs which have been attached to this slot using `attach`.
+     * However, not all of these extension IDs should be rendered.
+     * `assignedIds` is the set defining those.
+     */
+    attachedIds: Array<string>;
+    /** The configuration provided for this slot. `null` if not yet loaded. */
+    config: ExtensionSlotConfigObject | null;
+}
+export interface ExtensionStore {
+    slots: Record<string, ExtensionSlotState>;
+}
+export interface ExtensionSlotState {
+    moduleName?: string;
+    assignedExtensions: Array<AssignedExtension>;
+}
+export interface AssignedExtension {
+    id: string;
+    name: string;
+    moduleName: string;
+    meta: ExtensionMeta;
+    /** The extension's config. Note that this will be `null` until the slot is mounted. */
+    config: ConfigObject | null;
+    online?: boolean | object;
+    offline?: boolean | object;
+}
+export interface ConnectedExtension {
+    id: string;
+    name: string;
+    meta: ExtensionMeta;
+    /** The extension's config. Note that this will be `null` until the slot is mounted. */
+    config: ConfigObject | null;
+}
+/**
+ * This gets the extension system's internal store. It is subject
+ * to change radically and without warning. It should not be used
+ * outside esm-core.
+ * @internal
+ */
+export declare const getExtensionInternalStore: () => import("unistore").Store<ExtensionInternalStore>;
+/** @internal */
+export declare function updateInternalExtensionStore(updater: (state: ExtensionInternalStore) => ExtensionInternalStore): void;
+/**
+ * This returns a [store](https://github.com/developit/unistore#store)
+ * that modules can use to get information about the state of the
+ * extension system.
+ */
+export declare const getExtensionStore: () => import("unistore").Store<ExtensionStore>;

package/jest.config.js

@@ -5,4 +5,5 @@ module.exports = {
   moduleNameMapper: {
     "lodash-es/(.*)": "lodash/$1",
   },
+  testEnvironment: "jsdom",
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-extensions",
-  "version": "3.4.1-pre.96",
+  "version": "4.0.0-pre.1",
   "license": "MPL-2.0",
   "description": "Coordinates extensions and extension points in the OpenMRS Frontend",
   "browser": "dist/openmrs-esm-extensions.js",
@@ -36,19 +36,19 @@
     "access": "public"
   },
   "peerDependencies": {
-    "@openmrs/esm-api": "3.x",
-    "@openmrs/esm-config": "3.x",
-    "@openmrs/esm-state": "3.x",
+    "@openmrs/esm-api": "4.x",
+    "@openmrs/esm-config": "4.x",
+    "@openmrs/esm-state": "4.x",
     "single-spa": "5.x"
   },
   "devDependencies": {
-    "@openmrs/esm-api": "^3.4.1-pre.96",
-    "@openmrs/esm-config": "^3.4.1-pre.96",
-    "@openmrs/esm-state": "^3.4.1-pre.96",
+    "@openmrs/esm-api": "^4.0.0-pre.1",
+    "@openmrs/esm-config": "^4.0.0-pre.1",
+    "@openmrs/esm-state": "^4.0.0-pre.1",
     "single-spa": "^5.9.2"
   },
   "dependencies": {
     "lodash-es": "^4.17.21"
   },
-  "gitHead": "593214cd88408e07e9c18eab4c204be4a3722c73"
+  "gitHead": "9f58b801f07526083a9edc1cc5a1e58660d71eb0"
 }