@openmrs/esm-utils 3.1.15-pre.701 → 3.1.15-pre.707

package/README.md

@@ -1,5 +1,3 @@
 # openmrs-esm-utils
 
 openmrs-esm-utils provides helper functions.
-
-[API Docs](docs/API.md)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openmrs/esm-utils",
-  "version": "3.1.15-pre.701",
+  "version": "3.1.15-pre.707",
   "license": "MPL-2.0",
   "description": "Helper utilities for OpenMRS",
   "browser": "dist/openmrs-esm-utils.js",
@@ -8,7 +8,6 @@
   "source": true,
   "sideEffects": false,
   "scripts": {
-    "document": "../../../document.sh esm-utils",
     "test": "jest --config jest.config.js --passWithNoTests",
     "build": "webpack --mode=production",
     "analyze": "webpack --mode=production --env analyze=true",
@@ -49,5 +48,5 @@
   "dependencies": {
     "semver": "^7.3.2"
   },
-  "gitHead": "e328688472e77d868191c0a37c4555fbedb9aafa"
+  "gitHead": "99cb20e45f6d6ff7c7b8dc451a0cccd9c885083e"
 }

package/docs/API.md

@@ -1,394 +0,0 @@
-[Back to README.md](../README.md)
-
-# @openmrs/esm-utils
-
-## Table of contents
-
-### Interfaces
-
-- [RetryOptions](interfaces/RetryOptions.md)
-
-### Type aliases
-
-- [DateInput](API.md#dateinput)
-
-### Functions
-
-- [age](API.md#age)
-- [daysIntoYear](API.md#daysintoyear)
-- [isOmrsDateStrict](API.md#isomrsdatestrict)
-- [isOmrsDateToday](API.md#isomrsdatetoday)
-- [isSameDay](API.md#issameday)
-- [isVersionSatisfied](API.md#isversionsatisfied)
-- [retry](API.md#retry)
-- [toDateObjectStrict](API.md#todateobjectstrict)
-- [toOmrsDateFormat](API.md#toomrsdateformat)
-- [toOmrsDayDateFormat](API.md#toomrsdaydateformat)
-- [toOmrsIsoString](API.md#toomrsisostring)
-- [toOmrsTimeString](API.md#toomrstimestring)
-- [toOmrsTimeString24](API.md#toomrstimestring24)
-- [toOmrsYearlessDateFormat](API.md#toomrsyearlessdateformat)
-- [translateFrom](API.md#translatefrom)
-
-## Type aliases
-
-### DateInput
-
-Ƭ **DateInput**: `string` \| `number` \| `Date`
-
-#### Defined in
-
-[omrs-dates.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/omrs-dates.ts#L8)
-
-## Functions
-
-### age
-
-▸ **age**(`dateString`): `string`
-
-Gets a human readable age represention of the provided date string.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `dateString` | `string` | The stringified date. |
-
-#### Returns
-
-`string`
-
-A human-readable string version of the age.
-
-#### Defined in
-
-[age-helpers.tsx:37](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/age-helpers.tsx#L37)
-
-___
-
-### daysIntoYear
-
-▸ **daysIntoYear**(`date`): `number`
-
-Gets the number of days in the year of the given date.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `date` | `Date` | The date to compute the days within the year. |
-
-#### Returns
-
-`number`
-
-The number of days.
-
-#### Defined in
-
-[age-helpers.tsx:6](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/age-helpers.tsx#L6)
-
-___
-
-### isOmrsDateStrict
-
-▸ **isOmrsDateStrict**(`omrsPayloadString`): `boolean`
-
-This function is STRICT on checking whether a date string is the openmrs format.
-The format should be YYYY-MM-DDTHH:mm:ss.SSSZZ
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `omrsPayloadString` | `string` |
-
-#### Returns
-
-`boolean`
-
-#### Defined in
-
-[omrs-dates.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/omrs-dates.ts#L16)
-
-___
-
-### isOmrsDateToday
-
-▸ **isOmrsDateToday**(`date`): `boolean`
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `date` | [`DateInput`](API.md#dateinput) | Checks if the provided date is today. |
-
-#### Returns
-
-`boolean`
-
-#### Defined in
-
-[omrs-dates.ts:53](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/omrs-dates.ts#L53)
-
-___
-
-### isSameDay
-
-▸ **isSameDay**(`firstDate`, `secondDate`): `boolean`
-
-Checks if two dates are representing the same day.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `firstDate` | `Date` | The first date. |
-| `secondDate` | `Date` | The second date. |
-
-#### Returns
-
-`boolean`
-
-True if both are located on the same day.
-
-#### Defined in
-
-[age-helpers.tsx:23](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/age-helpers.tsx#L23)
-
-___
-
-### isVersionSatisfied
-
-▸ **isVersionSatisfied**(`requiredVersion`, `installedVersion`): `boolean`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `requiredVersion` | `string` |
-| `installedVersion` | `string` |
-
-#### Returns
-
-`boolean`
-
-#### Defined in
-
-[version.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/version.ts#L21)
-
-___
-
-### retry
-
-▸ **retry**<`T`\>(`fn`, `options?`): `Promise`<`T`\>
-
-Executes the specified function and retries executing on failure with a custom backoff strategy
-defined by the options.
-
-If not configured otherwise, this function uses the following default options:
-* Retries 5 times beyond the initial attempt.
-* Uses an exponential backoff starting with an initial delay of 1000ms.
-
-**`throws`** Rethrows the final error of running `fn` when the function stops retrying.
-
-#### Type parameters
-
-| Name |
-| :------ |
-| `T` |
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `fn` | () => `Promise`<`T`\> | The function to be executed and retried on failure. |
-| `options` | [`RetryOptions`](interfaces/RetryOptions.md) | Additional options which configure the retry behavior. |
-
-#### Returns
-
-`Promise`<`T`\>
-
-The result of successfully executing `fn`.
-
-#### Defined in
-
-[retry.ts:38](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/retry.ts#L38)
-
-___
-
-### toDateObjectStrict
-
-▸ **toDateObjectStrict**(`omrsDateString`): `Date` \| ``null``
-
-Converts the object to a date object if it is a valid ISO date time string.
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `omrsDateString` | `string` |
-
-#### Returns
-
-`Date` \| ``null``
-
-#### Defined in
-
-[omrs-dates.ts:60](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/omrs-dates.ts#L60)
-
-___
-
-### toOmrsDateFormat
-
-▸ **toOmrsDateFormat**(`date`, `format?`): `string`
-
-Formats the input as a date string. By default the format "YYYY-MMM-DD" is used.
-
-#### Parameters
-
-| Name | Type | Default value |
-| :------ | :------ | :------ |
-| `date` | [`DateInput`](API.md#dateinput) | `undefined` |
-| `format` | `string` | `"YYYY-MMM-DD"` |
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[omrs-dates.ts:112](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/omrs-dates.ts#L112)
-
-___
-
-### toOmrsDayDateFormat
-
-▸ **toOmrsDayDateFormat**(`date`): `string`
-
-Formats the input as a date string using the format "DD - MMM - YYYY".
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `date` | [`DateInput`](API.md#dateinput) |
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[omrs-dates.ts:98](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/omrs-dates.ts#L98)
-
-___
-
-### toOmrsIsoString
-
-▸ **toOmrsIsoString**(`date`, `toUTC?`): `string`
-
-Formats the input as a date time string using the format "YYYY-MM-DDTHH:mm:ss.SSSZZ".
-
-#### Parameters
-
-| Name | Type | Default value |
-| :------ | :------ | :------ |
-| `date` | [`DateInput`](API.md#dateinput) | `undefined` |
-| `toUTC` | `boolean` | `false` |
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[omrs-dates.ts:71](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/omrs-dates.ts#L71)
-
-___
-
-### toOmrsTimeString
-
-▸ **toOmrsTimeString**(`date`): `string`
-
-Formats the input as a time string using the format "HH:mm A".
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `date` | [`DateInput`](API.md#dateinput) |
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[omrs-dates.ts:91](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/omrs-dates.ts#L91)
-
-___
-
-### toOmrsTimeString24
-
-▸ **toOmrsTimeString24**(`date`): `string`
-
-Formats the input as a time string using the format "HH:mm".
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `date` | [`DateInput`](API.md#dateinput) |
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[omrs-dates.ts:84](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/omrs-dates.ts#L84)
-
-___
-
-### toOmrsYearlessDateFormat
-
-▸ **toOmrsYearlessDateFormat**(`date`): `string`
-
-Formats the input as a date string using the format "DD-MMM".
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `date` | [`DateInput`](API.md#dateinput) |
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[omrs-dates.ts:105](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/omrs-dates.ts#L105)
-
-___
-
-### translateFrom
-
-▸ **translateFrom**(`moduleName`, `key`, `fallback?`): `string`
-
-#### Parameters
-
-| Name | Type |
-| :------ | :------ |
-| `moduleName` | `string` |
-| `key` | `string` |
-| `fallback?` | `string` |
-
-#### Returns
-
-`string`
-
-#### Defined in
-
-[translate.ts:3](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/translate.ts#L3)

package/docs/interfaces/RetryOptions.md

@@ -1,83 +0,0 @@
-[@openmrs/esm-utils](../API.md) / RetryOptions
-
-# Interface: RetryOptions
-
-Options for configuring the behavior of the [retry](../API.md#retry) function.
-
-## Table of contents
-
-### Methods
-
-- [getDelay](RetryOptions.md#getdelay)
-- [onError](RetryOptions.md#onerror)
-- [shouldRetry](RetryOptions.md#shouldretry)
-
-## Methods
-
-### getDelay
-
-▸ `Optional` **getDelay**(`attempt`): `number`
-
-Calculates the next delay (in milliseconds) before a retry attempt.
-Returning a value for the inital attempt (`0`) delays the initial function invocation.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `attempt` | `number` | The current (zero-based) retry attempt. `0` indicates the initial attempt. |
-
-#### Returns
-
-`number`
-
-#### Defined in
-
-[retry.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/retry.ts#L16)
-
-___
-
-### onError
-
-▸ `Optional` **onError**(`e`, `attempt`): `void`
-
-Called when invoking the function resulted in an error.
-Allows running side-effects on errors, e.g. logging.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `e` | `any` | The error thrown by the function. |
-| `attempt` | `number` | The current (zero-based) retry attempt. `0` indicates the initial attempt. |
-
-#### Returns
-
-`void`
-
-#### Defined in
-
-[retry.ts:23](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/retry.ts#L23)
-
-___
-
-### shouldRetry
-
-▸ `Optional` **shouldRetry**(`attempt`): `any`
-
-Determines whether the retry function should retry executing the function after it failed
-with an error on the current attempt.
-
-#### Parameters
-
-| Name | Type | Description |
-| :------ | :------ | :------ |
-| `attempt` | `number` | The current (zero-based) retry attempt. `0` indicates the initial attempt. |
-
-#### Returns
-
-`any`
-
-#### Defined in
-
-[retry.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/master/packages/framework/esm-utils/src/retry.ts#L10)

package/typedoc.json

@@ -1,7 +0,0 @@
-{
-  "out": "docs",
-  "readme": "none",
-  "excludeInternal": true,
-  "gitRevision": "master",
-  "entryDocument": "API.md"
-}