npm - @openmrs/esm-framework - Versions diffs - 4.1.1-pre.556 → 4.1.1-pre.558 - Mend

@openmrs/esm-framework 4.1.1-pre.556 → 4.1.1-pre.558

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 (6) hide show

package/.turbo/turbo-build.log +2 -2
package/dist/openmrs-esm-framework.js.map +1 -1
package/docs/API.md +10 -16
package/docs/interfaces/Config.md +0 -175
package/docs/interfaces/ConfigObject.md +0 -170
package/package.json +13 -13

package/docs/API.md CHANGED Viewed

@@ -1611,25 +1611,19 @@ ___
 ### useConfig
-▸ **useConfig**(): `Object`
+▸ **useConfig**<`T`\>(): `T`
 Use this React Hook to obtain your module's configuration.
-#### Returns
+#### Type parameters
-`Object`
+| Name | Type |
+| :------ | :------ |
+| `T` | `Omit`<[`ConfigObject`](interfaces/ConfigObject.md), ``"Display conditions"`` \| ``"Translation overrides"``\> |
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `Display conditions?` | [`DisplayConditionsConfigObject`](interfaces/DisplayConditionsConfigObject.md) | - |
-| `Translation overrides?` | `Record`<`string`, `Record`<`string`, `string`\>\> | - |
-| `constructor` | `Function` | The initial value of Object.prototype.constructor is the standard built-in Object constructor. |
-| `hasOwnProperty` | (`v`: `PropertyKey`) => `boolean` | Determines whether an object has a property with the specified name. |
-| `isPrototypeOf` | (`v`: `Object`) => `boolean` | Determines whether an object exists in another object's prototype chain. |
-| `propertyIsEnumerable` | (`v`: `PropertyKey`) => `boolean` | Determines whether a specified property is enumerable. |
-| `toLocaleString` | () => `string` | Returns a date converted to a string using the current locale. |
-| `toString` | () => `string` | Returns a string representation of an object. |
-| `valueOf` | () => `Object` | Returns the primitive value of the specified object. |
+#### Returns
+`T`
 #### Defined in
@@ -2114,7 +2108,7 @@ ___
 #### Defined in
-[packages/framework/esm-error-handling/src/index.ts:30](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-error-handling/src/index.ts#L30)
+[packages/framework/esm-error-handling/src/index.ts:31](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-error-handling/src/index.ts#L31)
 ___
@@ -2134,7 +2128,7 @@ ___
 #### Defined in
-[packages/framework/esm-error-handling/src/index.ts:23](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-error-handling/src/index.ts#L23)
+[packages/framework/esm-error-handling/src/index.ts:24](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-error-handling/src/index.ts#L24)
 ___

package/docs/interfaces/Config.md CHANGED Viewed

@@ -2,181 +2,6 @@
 # Interface: Config
-## Hierarchy
-- `Object`
-  ↳ **`Config`**
 ## Indexable
 ▪ [moduleName: `string`]: { `[key: string]`: `any`;  }
-## Table of contents
-### Properties
-- [constructor](Config.md#constructor)
-### Methods
-- [hasOwnProperty](Config.md#hasownproperty)
-- [isPrototypeOf](Config.md#isprototypeof)
-- [propertyIsEnumerable](Config.md#propertyisenumerable)
-- [toLocaleString](Config.md#tolocalestring)
-- [toString](Config.md#tostring)
-- [valueOf](Config.md#valueof)
-## Properties
-### constructor
-• **constructor**: `Function`
-The initial value of Object.prototype.constructor is the standard built-in Object constructor.
-#### Inherited from
-Object.constructor
-#### Defined in
-node_modules/typescript/lib/lib.es5.d.ts:124
-## Methods
-### hasOwnProperty
-▸ **hasOwnProperty**(`v`): `boolean`
-Determines whether an object has a property with the specified name.
-#### Parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `v` | `PropertyKey` | A property name. |
-#### Returns
-`boolean`
-#### Inherited from
-Object.hasOwnProperty
-#### Defined in
-node_modules/typescript/lib/lib.es5.d.ts:139
-___
-### isPrototypeOf
-▸ **isPrototypeOf**(`v`): `boolean`
-Determines whether an object exists in another object's prototype chain.
-#### Parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `v` | `Object` | Another object whose prototype chain is to be checked. |
-#### Returns
-`boolean`
-#### Inherited from
-Object.isPrototypeOf
-#### Defined in
-node_modules/typescript/lib/lib.es5.d.ts:145
-___
-### propertyIsEnumerable
-▸ **propertyIsEnumerable**(`v`): `boolean`
-Determines whether a specified property is enumerable.
-#### Parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `v` | `PropertyKey` | A property name. |
-#### Returns
-`boolean`
-#### Inherited from
-Object.propertyIsEnumerable
-#### Defined in
-node_modules/typescript/lib/lib.es5.d.ts:151
-___
-### toLocaleString
-▸ **toLocaleString**(): `string`
-Returns a date converted to a string using the current locale.
-#### Returns
-`string`
-#### Inherited from
-Object.toLocaleString
-#### Defined in
-node_modules/typescript/lib/lib.es5.d.ts:130
-___
-### toString
-▸ **toString**(): `string`
-Returns a string representation of an object.
-#### Returns
-`string`
-#### Inherited from
-Object.toString
-#### Defined in
-node_modules/typescript/lib/lib.es5.d.ts:127
-___
-### valueOf
-▸ **valueOf**(): `Object`
-Returns the primitive value of the specified object.
-#### Returns
-`Object`
-#### Inherited from
-Object.valueOf
-#### Defined in
-node_modules/typescript/lib/lib.es5.d.ts:133

package/docs/interfaces/ConfigObject.md CHANGED Viewed

@@ -2,12 +2,6 @@
 # Interface: ConfigObject
-## Hierarchy
-- `Object`
-  ↳ **`ConfigObject`**
 ## Indexable
 ▪ [key: `string`]: `any`
@@ -18,16 +12,6 @@
 - [Display conditions](ConfigObject.md#display conditions)
 - [Translation overrides](ConfigObject.md#translation overrides)
-- [constructor](ConfigObject.md#constructor)
-### Methods
-- [hasOwnProperty](ConfigObject.md#hasownproperty)
-- [isPrototypeOf](ConfigObject.md#isprototypeof)
-- [propertyIsEnumerable](ConfigObject.md#propertyisenumerable)
-- [toLocaleString](ConfigObject.md#tolocalestring)
-- [toString](ConfigObject.md#tostring)
-- [valueOf](ConfigObject.md#valueof)
 ## Properties
@@ -48,157 +32,3 @@ ___
 #### Defined in
 [packages/framework/esm-config/src/types.ts:31](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-config/src/types.ts#L31)
-___
-### constructor
-• **constructor**: `Function`
-The initial value of Object.prototype.constructor is the standard built-in Object constructor.
-#### Inherited from
-Object.constructor
-#### Defined in
-node_modules/typescript/lib/lib.es5.d.ts:124
-## Methods
-### hasOwnProperty
-▸ **hasOwnProperty**(`v`): `boolean`
-Determines whether an object has a property with the specified name.
-#### Parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `v` | `PropertyKey` | A property name. |
-#### Returns
-`boolean`
-#### Inherited from
-Object.hasOwnProperty
-#### Defined in
-node_modules/typescript/lib/lib.es5.d.ts:139
-___
-### isPrototypeOf
-▸ **isPrototypeOf**(`v`): `boolean`
-Determines whether an object exists in another object's prototype chain.
-#### Parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `v` | `Object` | Another object whose prototype chain is to be checked. |
-#### Returns
-`boolean`
-#### Inherited from
-Object.isPrototypeOf
-#### Defined in
-node_modules/typescript/lib/lib.es5.d.ts:145
-___
-### propertyIsEnumerable
-▸ **propertyIsEnumerable**(`v`): `boolean`
-Determines whether a specified property is enumerable.
-#### Parameters
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `v` | `PropertyKey` | A property name. |
-#### Returns
-`boolean`
-#### Inherited from
-Object.propertyIsEnumerable
-#### Defined in
-node_modules/typescript/lib/lib.es5.d.ts:151
-___
-### toLocaleString
-▸ **toLocaleString**(): `string`
-Returns a date converted to a string using the current locale.
-#### Returns
-`string`
-#### Inherited from
-Object.toLocaleString
-#### Defined in
-node_modules/typescript/lib/lib.es5.d.ts:130
-___
-### toString
-▸ **toString**(): `string`
-Returns a string representation of an object.
-#### Returns
-`string`
-#### Inherited from
-Object.toString
-#### Defined in
-node_modules/typescript/lib/lib.es5.d.ts:127
-___
-### valueOf
-▸ **valueOf**(): `Object`
-Returns the primitive value of the specified object.
-#### Returns
-`Object`
-#### Inherited from
-Object.valueOf
-#### Defined in
-node_modules/typescript/lib/lib.es5.d.ts:133

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-framework",
-  "version": "4.1.1-pre.556",
+  "version": "4.1.1-pre.558",
   "license": "MPL-2.0",
   "browser": "dist/openmrs-esm-framework.js",
   "main": "src/index.ts",
@@ -35,17 +35,17 @@
     "access": "public"
   },
   "dependencies": {
-    "@openmrs/esm-api": "^4.1.1-pre.556",
-    "@openmrs/esm-breadcrumbs": "^4.1.1-pre.556",
-    "@openmrs/esm-config": "^4.1.1-pre.556",
-    "@openmrs/esm-error-handling": "^4.1.1-pre.556",
-    "@openmrs/esm-extensions": "^4.1.1-pre.556",
-    "@openmrs/esm-globals": "^4.1.1-pre.556",
-    "@openmrs/esm-offline": "^4.1.1-pre.556",
-    "@openmrs/esm-react-utils": "^4.1.1-pre.556",
-    "@openmrs/esm-state": "^4.1.1-pre.556",
-    "@openmrs/esm-styleguide": "^4.1.1-pre.556",
-    "@openmrs/esm-utils": "^4.1.1-pre.556",
+    "@openmrs/esm-api": "^4.1.1-pre.558",
+    "@openmrs/esm-breadcrumbs": "^4.1.1-pre.558",
+    "@openmrs/esm-config": "^4.1.1-pre.558",
+    "@openmrs/esm-error-handling": "^4.1.1-pre.558",
+    "@openmrs/esm-extensions": "^4.1.1-pre.558",
+    "@openmrs/esm-globals": "^4.1.1-pre.558",
+    "@openmrs/esm-offline": "^4.1.1-pre.558",
+    "@openmrs/esm-react-utils": "^4.1.1-pre.558",
+    "@openmrs/esm-state": "^4.1.1-pre.558",
+    "@openmrs/esm-styleguide": "^4.1.1-pre.558",
+    "@openmrs/esm-utils": "^4.1.1-pre.558",
     "dayjs": "^1.10.7"
   },
   "devDependencies": {
@@ -53,5 +53,5 @@
     "jest-cli": "28.1.0",
     "jest-environment-jsdom": "28.1.0"
   },
-  "gitHead": "add26751e8e84bcc4a4301b4378c8c79e49f7cf8"
+  "gitHead": "65e3a5f3950d428ef38a9800cd35344a88cb18dd"
 }