npm - @openmrs/esm-extensions - Versions diffs - 3.1.15-pre.692 → 3.1.15-pre.707 - Mend

@openmrs/esm-extensions 3.1.15-pre.692 → 3.1.15-pre.707

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (19) hide show

package/README.md +0 -2
package/dist/openmrs-esm-extensions.js +1 -1
package/dist/openmrs-esm-extensions.js.map +1 -1
package/jest.config.js +1 -0
package/package.json +9 -7
package/src/store.ts +11 -1
package/docs/API.md +0 -511
package/docs/interfaces/CancelLoading.md +0 -17
package/docs/interfaces/ExtensionDetails.md +0 -81
package/docs/interfaces/ExtensionInfo.md +0 -140
package/docs/interfaces/ExtensionInstance.md +0 -19
package/docs/interfaces/ExtensionMeta.md +0 -7
package/docs/interfaces/ExtensionRegistration.md +0 -98
package/docs/interfaces/ExtensionSlotInfo.md +0 -50
package/docs/interfaces/ExtensionSlotInstance.md +0 -51
package/docs/interfaces/ExtensionStore.md +0 -34
package/docs/interfaces/Lifecycle.md +0 -68
package/docs/interfaces/NavigationContext.md +0 -50
package/typedoc.json +0 -7

package/docs/API.md DELETED Viewed

@@ -1,511 +0,0 @@
-[Back to README.md](../README.md)
-# @openmrs/esm-extensions
-## Table of contents
-### Interfaces
-- [CancelLoading](interfaces/CancelLoading.md)
-- [ExtensionDetails](interfaces/ExtensionDetails.md)
-- [ExtensionInfo](interfaces/ExtensionInfo.md)
-- [ExtensionInstance](interfaces/ExtensionInstance.md)
-- [ExtensionMeta](interfaces/ExtensionMeta.md)
-- [ExtensionRegistration](interfaces/ExtensionRegistration.md)
-- [ExtensionSlotInfo](interfaces/ExtensionSlotInfo.md)
-- [ExtensionSlotInstance](interfaces/ExtensionSlotInstance.md)
-- [ExtensionStore](interfaces/ExtensionStore.md)
-- [Lifecycle](interfaces/Lifecycle.md)
-- [NavigationContext](interfaces/NavigationContext.md)
-### Type aliases
-- [MaybeAsync](API.md#maybeasync)
-- [NavigationContextType](API.md#navigationcontexttype)
-### Variables
-- [extensionStore](API.md#extensionstore)
-### Functions
-- [attach](API.md#attach)
-- [checkStatus](API.md#checkstatus)
-- [checkStatusFor](API.md#checkstatusfor)
-- [detach](API.md#detach)
-- [detachAll](API.md#detachall)
-- [getAssignedIds](API.md#getassignedids)
-- [getCustomProps](API.md#getcustomprops)
-- [getExtensionNameFromId](API.md#getextensionnamefromid)
-- [getExtensionRegistration](API.md#getextensionregistration)
-- [getExtensionRegistrationFrom](API.md#getextensionregistrationfrom)
-- [getExtensionSlotsForModule](API.md#getextensionslotsformodule)
-- [getUpdatedExtensionSlotInfo](API.md#getupdatedextensionslotinfo)
-- [pushNavigationContext](API.md#pushnavigationcontext)
-- [registerExtension](API.md#registerextension)
-- [registerExtensionSlot](API.md#registerextensionslot)
-- [renderExtension](API.md#renderextension)
-- [switchTo](API.md#switchto)
-- [unregisterExtensionSlot](API.md#unregisterextensionslot)
-- [updateExtensionStore](API.md#updateextensionstore)
-## Type aliases
-### MaybeAsync
-Ƭ **MaybeAsync**<`T`\>: `T` \| `Promise`<`T`\>
-#### Type parameters
-| Name |
-| :------ |
-| `T` |
-#### Defined in
-[store.ts:82](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L82)
-___
-### NavigationContextType
-Ƭ **NavigationContextType**: ``"workspace"`` \| ``"dialog"`` \| ``"link"``
-#### Defined in
-[contexts.ts:3](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/contexts.ts#L3)
-## Variables
-### extensionStore
-• `Const` **extensionStore**: `Store`<[`ExtensionStore`](interfaces/ExtensionStore.md)\>
-#### Defined in
-[store.ts:77](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L77)
-## Functions
-### attach
-▸ **attach**(`extensionSlotName`, `extensionId`): `void`
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `extensionSlotName` | `string` |
-| `extensionId` | `string` |
-#### Returns
-`void`
-#### Defined in
-[extensions.ts:71](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L71)
-___
-### checkStatus
-▸ **checkStatus**(`online?`, `offline?`): `boolean`
-#### Parameters
-| Name | Type | Default value |
-| :------ | :------ | :------ |
-| `online` | `boolean` \| `object` | `true` |
-| `offline` | `boolean` \| `object` | `false` |
-#### Returns
-`boolean`
-#### Defined in
-[helpers.ts:1](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/helpers.ts#L1)
-___
-### checkStatusFor
-▸ **checkStatusFor**(`status`, `online?`, `offline?`): `boolean`
-#### Parameters
-| Name | Type | Default value |
-| :------ | :------ | :------ |
-| `status` | `boolean` | `undefined` |
-| `online` | `boolean` \| `object` | `true` |
-| `offline` | `boolean` \| `object` | `false` |
-#### Returns
-`boolean`
-#### Defined in
-[helpers.ts:9](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/helpers.ts#L9)
-___
-### detach
-▸ **detach**(`extensionSlotName`, `extensionId`): `void`
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `extensionSlotName` | `string` |
-| `extensionId` | `string` |
-#### Returns
-`void`
-#### Defined in
-[extensions.ts:101](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L101)
-___
-### detachAll
-▸ **detachAll**(`extensionSlotName`): `void`
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `extensionSlotName` | `string` |
-#### Returns
-`void`
-#### Defined in
-[extensions.ts:124](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L124)
-___
-### getAssignedIds
-▸ **getAssignedIds**(`instance`, `attachedIds`): `string`[]
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `instance` | [`ExtensionSlotInstance`](interfaces/ExtensionSlotInstance.md) |
-| `attachedIds` | `string`[] |
-#### Returns
-`string`[]
-#### Defined in
-[extensions.ts:157](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L157)
-___
-### getCustomProps
-▸ **getCustomProps**(`online`, `offline`): `object`
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `online` | `boolean` \| `object` \| `undefined` |
-| `offline` | `boolean` \| `object` \| `undefined` |
-#### Returns
-`object`
-#### Defined in
-[helpers.ts:17](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/helpers.ts#L17)
-___
-### getExtensionNameFromId
-▸ **getExtensionNameFromId**(`extensionId`): `string`
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `extensionId` | `string` |
-#### Returns
-`string`
-#### Defined in
-[extensions.ts:29](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L29)
-___
-### getExtensionRegistration
-▸ **getExtensionRegistration**(`extensionId`): [`ExtensionRegistration`](interfaces/ExtensionRegistration.md) \| `undefined`
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `extensionId` | `string` |
-#### Returns
-[`ExtensionRegistration`](interfaces/ExtensionRegistration.md) \| `undefined`
-#### Defined in
-[extensions.ts:42](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L42)
-___
-### getExtensionRegistrationFrom
-▸ **getExtensionRegistrationFrom**(`state`, `extensionId`): [`ExtensionRegistration`](interfaces/ExtensionRegistration.md) \| `undefined`
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `state` | [`ExtensionStore`](interfaces/ExtensionStore.md) |
-| `extensionId` | `string` |
-#### Returns
-[`ExtensionRegistration`](interfaces/ExtensionRegistration.md) \| `undefined`
-#### Defined in
-[extensions.ts:34](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L34)
-___
-### getExtensionSlotsForModule
-▸ **getExtensionSlotsForModule**(`moduleName`): `string`[]
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `moduleName` | `string` |
-#### Returns
-`string`[]
-#### Defined in
-[extensions.ts:269](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L269)
-___
-### getUpdatedExtensionSlotInfo
-▸ **getUpdatedExtensionSlotInfo**(`slotName`, `moduleName`, `extensionSlot`): [`ExtensionSlotInfo`](interfaces/ExtensionSlotInfo.md)
-Returns information describing all extensions which can be rendered into an extension slot with
-the specified name.
-The returned information describe the extension itself, as well as the extension slot name(s)
-with which it has been attached.
-#### Parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `slotName` | `string` | The extension slot name for which matching extension info should be returned. |
-| `moduleName` | `string` | The module name. Used for applying extension-specific config values to the result. |
-| `extensionSlot` | [`ExtensionSlotInfo`](interfaces/ExtensionSlotInfo.md) | The extension slot information object. |
-#### Returns
-[`ExtensionSlotInfo`](interfaces/ExtensionSlotInfo.md)
-#### Defined in
-[extensions.ts:296](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L296)
-___
-### pushNavigationContext
-▸ **pushNavigationContext**(`_context`): () => `void`
-**`deprecated`** don't use
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `_context` | [`NavigationContext`](interfaces/NavigationContext.md) |
-#### Returns
-`fn`
-▸ (): `void`
-##### Returns
-`void`
-#### Defined in
-[contexts.ts:24](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/contexts.ts#L24)
-___
-### registerExtension
-▸ `Const` **registerExtension**(`name`, `details`): `void`
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `name` | `string` |
-| `details` | [`ExtensionDetails`](interfaces/ExtensionDetails.md) |
-#### Returns
-`void`
-#### Defined in
-[extensions.ts:58](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L58)
-___
-### registerExtensionSlot
-▸ **registerExtensionSlot**(`moduleName`, `slotName`): `void`
-#### Parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `moduleName` | `string` | The name of the module that contains the extension slot |
-| `slotName` | `string` | The extension slot name that is actually used |
-#### Returns
-`void`
-#### Defined in
-[extensions.ts:222](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L222)
-___
-### renderExtension
-▸ **renderExtension**(`domElement`, `extensionSlotName`, `extensionSlotModuleName`, `extensionId`, `renderFunction?`, `additionalProps?`): [`CancelLoading`](interfaces/CancelLoading.md)
-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.
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `domElement` | `HTMLElement` |
-| `extensionSlotName` | `string` |
-| `extensionSlotModuleName` | `string` |
-| `extensionId` | `string` |
-| `renderFunction` | (`lifecycle`: [`Lifecycle`](interfaces/Lifecycle.md)) => [`Lifecycle`](interfaces/Lifecycle.md) |
-| `additionalProps` | `Record`<`string`, `any`\> |
-#### Returns
-[`CancelLoading`](interfaces/CancelLoading.md)
-#### Defined in
-[render.ts:23](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/render.ts#L23)
-___
-### switchTo
-▸ **switchTo**<`T`\>(`_type`, `link`, `_state?`): `void`
-**`deprecated`** use `navigate` directly
-#### Type parameters
-| Name |
-| :------ |
-| `T` |
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `_type` | [`NavigationContextType`](API.md#navigationcontexttype) |
-| `link` | `string` |
-| `_state?` | `T` |
-#### Returns
-`void`
-#### Defined in
-[contexts.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/contexts.ts#L13)
-___
-### unregisterExtensionSlot
-▸ **unregisterExtensionSlot**(`moduleName`, `slotName`): `void`
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `moduleName` | `string` |
-| `slotName` | `string` |
-#### Returns
-`void`
-#### Defined in
-[extensions.ts:245](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L245)
-___
-### updateExtensionStore
-▸ **updateExtensionStore**(`updater`): `void`
-#### Parameters
-| Name | Type |
-| :------ | :------ |
-| `updater` | (`state`: [`ExtensionStore`](interfaces/ExtensionStore.md)) => [`MaybeAsync`](API.md#maybeasync)<[`ExtensionStore`](interfaces/ExtensionStore.md)\> |
-#### Returns
-`void`
-#### Defined in
-[store.ts:86](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/store.ts#L86)

package/docs/interfaces/CancelLoading.md DELETED Viewed

@@ -1,17 +0,0 @@
-[@openmrs/esm-extensions](../API.md) / CancelLoading
-# Interface: CancelLoading
-## Callable
-### CancelLoading
-▸ **CancelLoading**(): `void`
-#### Returns
-`void`
-#### Defined in
-[render.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/render.ts#L15)

package/docs/interfaces/ExtensionDetails.md DELETED Viewed

@@ -1,81 +0,0 @@
-[@openmrs/esm-extensions](../API.md) / ExtensionDetails
-# Interface: ExtensionDetails
-## Table of contents
-### Properties
-- [meta](ExtensionDetails.md#meta)
-- [moduleName](ExtensionDetails.md#modulename)
-- [offline](ExtensionDetails.md#offline)
-- [online](ExtensionDetails.md#online)
-- [order](ExtensionDetails.md#order)
-### Methods
-- [load](ExtensionDetails.md#load)
-## Properties
-### meta
-• **meta**: `Record`<`string`, `any`\>
-#### Defined in
-[extensions.ts:52](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L52)
-___
-### moduleName
-• **moduleName**: `string`
-#### Defined in
-[extensions.ts:50](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L50)
-___
-### offline
-• `Optional` **offline**: `boolean` \| `object`
-#### Defined in
-[extensions.ts:54](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L54)
-___
-### online
-• `Optional` **online**: `boolean` \| `object`
-#### Defined in
-[extensions.ts:53](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L53)
-___
-### order
-• `Optional` **order**: `number`
-#### Defined in
-[extensions.ts:55](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L55)
-## Methods
-### load
-▸ **load**(): `Promise`<`any`\>
-#### Returns
-`Promise`<`any`\>
-#### Defined in
-[extensions.ts:51](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-extensions/src/extensions.ts#L51)