@openmrs/esm-framework 6.3.1-pre.2961 → 6.3.1-pre.2986
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.
- package/.turbo/turbo-build.log +3 -25
- package/dist/index.d.ts +17 -0
- package/dist/internal.d.ts +17 -0
- package/dist/openmrs-esm-framework.js +1 -2
- package/dist/openmrs-esm-framework.js.map +1 -1
- package/docs/API.md +369 -283
- package/docs/classes/OpenmrsFetchError.md +10 -10
- package/docs/enums/VisitMode.md +3 -3
- package/docs/enums/VisitStatus.md +2 -2
- package/docs/interfaces/AssignedExtension.md +1 -1
- package/docs/interfaces/Attachment.md +7 -7
- package/docs/interfaces/AttachmentResponse.md +6 -6
- package/docs/interfaces/CloseWorkspaceOptions.md +3 -3
- package/docs/interfaces/ConfigurableLinkProps.md +474 -317
- package/docs/interfaces/ConnectedExtension.md +1 -1
- package/docs/interfaces/ConnectivityChangedEvent.md +1 -1
- package/docs/interfaces/CurrentPatientOptions.md +1 -1
- package/docs/interfaces/DefaultWorkspaceProps.md +4 -4
- package/docs/interfaces/Diagnosis.md +25 -25
- package/docs/interfaces/EmrApiConfigurationResponse.md +596 -0
- package/docs/interfaces/Encounter.md +24 -24
- package/docs/interfaces/EncounterProvider.md +16 -16
- package/docs/interfaces/EncounterRole.md +16 -16
- package/docs/interfaces/EncounterType.md +16 -16
- package/docs/interfaces/ExtensionSlotBaseProps.md +3 -3
- package/docs/interfaces/FHIRCode.md +3 -3
- package/docs/interfaces/FHIRLocationResource.md +30 -0
- package/docs/interfaces/FHIRResource.md +1 -1
- package/docs/interfaces/FeatureFlagDefinition.md +3 -3
- package/docs/interfaces/FetchConfig.md +13 -13
- package/docs/interfaces/FetchError.md +2 -2
- package/docs/interfaces/FetchResponse.md +15 -15
- package/docs/interfaces/ImportMap.md +1 -1
- package/docs/interfaces/Location.md +370 -3
- package/docs/interfaces/LoggedInUserFetchResponse.md +15 -15
- package/docs/interfaces/NewVisitPayload.md +7 -7
- package/docs/interfaces/NotificationDescriptor.md +20 -2
- package/docs/interfaces/Obs.md +36 -36
- package/docs/interfaces/OldExtensionSlotBaseProps.md +3 -3
- package/docs/interfaces/OnlyThePatient.md +1 -1
- package/docs/interfaces/OpenWorkspace.md +29 -29
- package/docs/interfaces/OpenmrsAppRoutes.md +9 -9
- package/docs/interfaces/OpenmrsDatePickerProps.md +1 -1
- package/docs/interfaces/OpenmrsResource.md +0 -12
- package/docs/interfaces/OpenmrsResourceStrict.md +0 -6
- package/docs/interfaces/Patient.md +17 -17
- package/docs/interfaces/PatientIdentifier.md +18 -18
- package/docs/interfaces/PatientIdentifierType.md +22 -22
- package/docs/interfaces/PatientPhotoProps.md +0 -11
- package/docs/interfaces/PatientWithFullResponse.md +1 -1
- package/docs/interfaces/Prompt.md +5 -5
- package/docs/interfaces/ResourceLoader.md +1 -1
- package/docs/interfaces/RetryOptions.md +3 -3
- package/docs/interfaces/ShowActionableNotificationEvent.md +6 -6
- package/docs/interfaces/ShowNotificationEvent.md +5 -5
- package/docs/interfaces/ShowSnackbarEvent.md +8 -8
- package/docs/interfaces/ShowToastEvent.md +5 -5
- package/docs/interfaces/SpaConfig.md +5 -5
- package/docs/interfaces/StyleguideConfigObject.md +2 -2
- package/docs/interfaces/UploadedFile.md +7 -7
- package/docs/interfaces/UseConfigOptions.md +22 -0
- package/docs/interfaces/UseServerFetchAllOptions.md +5 -5
- package/docs/interfaces/UseServerInfiniteOptions.md +5 -5
- package/docs/interfaces/UseServerPaginationOptions.md +2 -2
- package/docs/interfaces/Visit.md +11 -11
- package/docs/interfaces/VisitItem.md +4 -4
- package/docs/interfaces/VisitReturnType.md +2 -2
- package/docs/interfaces/VisitStoreState.md +3 -3
- package/docs/interfaces/VisitType.md +3 -3
- package/docs/interfaces/WorkspaceGroupDefinition.md +2 -2
- package/docs/interfaces/WorkspaceRegistration.md +0 -6
- package/docs/interfaces/WorkspacesInfo.md +5 -5
- package/mock-jest.tsx +125 -0
- package/mock.tsx +44 -42
- package/package.json +58 -31
- package/rspack.config.cjs +96 -0
- package/{src/integration-tests/setup-tests.ts → setup-tests.ts} +6 -1
- package/src/declarations.d.ts +0 -1
- package/src/index.ts +2 -3
- package/src/integration-tests/extension-config.test.tsx +14 -12
- package/src/internal.ts +2 -3
- package/src/mock-test.test.ts +2 -2
- package/tsconfig.build.json +10 -0
- package/tsconfig.json +3 -24
- package/typedoc.json +1 -0
- package/vitest.config.ts +9 -0
- package/dist/278.openmrs-esm-framework.js +0 -2
- package/dist/278.openmrs-esm-framework.js.map +0 -1
- package/dist/530.openmrs-esm-framework.js +0 -2
- package/dist/530.openmrs-esm-framework.js.map +0 -1
- package/dist/588.openmrs-esm-framework.js +0 -2
- package/dist/588.openmrs-esm-framework.js.map +0 -1
- package/dist/619.openmrs-esm-framework.js +0 -2
- package/dist/619.openmrs-esm-framework.js.map +0 -1
- package/dist/645.openmrs-esm-framework.js +0 -2
- package/dist/645.openmrs-esm-framework.js.map +0 -1
- package/dist/735.openmrs-esm-framework.js +0 -3
- package/dist/735.openmrs-esm-framework.js.LICENSE.txt +0 -9
- package/dist/735.openmrs-esm-framework.js.map +0 -1
- package/dist/746.openmrs-esm-framework.js +0 -2
- package/dist/746.openmrs-esm-framework.js.map +0 -1
- package/dist/788.openmrs-esm-framework.js +0 -3
- package/dist/788.openmrs-esm-framework.js.LICENSE.txt +0 -19
- package/dist/788.openmrs-esm-framework.js.map +0 -1
- package/dist/openmrs-esm-framework.js.LICENSE.txt +0 -68
- package/jest.config.js +0 -22
- package/webpack.config.js +0 -80
package/docs/API.md
CHANGED
@@ -96,11 +96,6 @@
|
|
96
96
|
|
97
97
|
- [importDynamic](API.md#importdynamic)
|
98
98
|
|
99
|
-
### Error Handling Functions
|
100
|
-
|
101
|
-
- [createErrorHandler](API.md#createerrorhandler)
|
102
|
-
- [reportError](API.md#reporterror)
|
103
|
-
|
104
99
|
### Extension Functions
|
105
100
|
|
106
101
|
- [ExtensionSlot](API.md#extensionslot)
|
@@ -177,7 +172,11 @@
|
|
177
172
|
### Other Functions
|
178
173
|
|
179
174
|
- [WorkspaceContainer](API.md#workspacecontainer)
|
175
|
+
- [age](API.md#age)
|
180
176
|
- [compile](API.md#compile)
|
177
|
+
- [createErrorHandler](API.md#createerrorhandler)
|
178
|
+
- [dispatchNotificationShown](API.md#dispatchnotificationshown)
|
179
|
+
- [dispatchPrecacheStaticDependencies](API.md#dispatchprecachestaticdependencies)
|
181
180
|
- [evaluate](API.md#evaluate)
|
182
181
|
- [evaluateAsBoolean](API.md#evaluateasboolean)
|
183
182
|
- [evaluateAsBooleanAsync](API.md#evaluateasbooleanasync)
|
@@ -188,7 +187,10 @@
|
|
188
187
|
- [evaluateAsync](API.md#evaluateasync)
|
189
188
|
- [extractVariableNames](API.md#extractvariablenames)
|
190
189
|
- [getLocale](API.md#getlocale)
|
190
|
+
- [isDevEnabled](API.md#isdevenabled)
|
191
191
|
- [isOnline](API.md#isonline)
|
192
|
+
- [isVersionSatisfied](API.md#isversionsatisfied)
|
193
|
+
- [reportError](API.md#reporterror)
|
192
194
|
- [useFhirFetchAll](API.md#usefhirfetchall)
|
193
195
|
- [useFhirInfinite](API.md#usefhirinfinite)
|
194
196
|
- [useVisitContextStore](API.md#usevisitcontextstore)
|
@@ -243,14 +245,12 @@
|
|
243
245
|
|
244
246
|
### Utility Functions
|
245
247
|
|
246
|
-
- [age](API.md#age)
|
247
248
|
- [canAccessStorage](API.md#canaccessstorage)
|
248
249
|
- [displayName](API.md#displayname)
|
249
250
|
- [formatPatientName](API.md#formatpatientname)
|
250
251
|
- [formattedName](API.md#formattedname)
|
251
252
|
- [getDefaultsFromConfigSchema](API.md#getdefaultsfromconfigschema)
|
252
253
|
- [getPatientName](API.md#getpatientname)
|
253
|
-
- [isVersionSatisfied](API.md#isversionsatisfied)
|
254
254
|
- [retry](API.md#retry)
|
255
255
|
- [selectPreferredName](API.md#selectpreferredname)
|
256
256
|
- [shallowEqual](API.md#shallowequal)
|
@@ -270,11 +270,11 @@
|
|
270
270
|
|
271
271
|
### CurrentPatient
|
272
272
|
|
273
|
-
Ƭ **CurrentPatient**: `fhir.Patient` \|
|
273
|
+
Ƭ **CurrentPatient**: `fhir.Patient` \| `FetchResponse`<`fhir.Patient`\>
|
274
274
|
|
275
275
|
#### Defined in
|
276
276
|
|
277
|
-
[packages/framework/esm-api/src/
|
277
|
+
[packages/framework/esm-emr-api/src/current-patient.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/current-patient.ts#L5)
|
278
278
|
|
279
279
|
___
|
280
280
|
|
@@ -291,7 +291,7 @@ ___
|
|
291
291
|
|
292
292
|
#### Defined in
|
293
293
|
|
294
|
-
[packages/framework/esm-api/src/
|
294
|
+
[packages/framework/esm-api/src/current-user.ts:11](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L11)
|
295
295
|
|
296
296
|
___
|
297
297
|
|
@@ -311,7 +311,7 @@ ___
|
|
311
311
|
|
312
312
|
#### Defined in
|
313
313
|
|
314
|
-
[packages/framework/esm-api/src/
|
314
|
+
[packages/framework/esm-emr-api/src/current-patient.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/current-patient.ts#L19)
|
315
315
|
|
316
316
|
___
|
317
317
|
|
@@ -321,7 +321,7 @@ ___
|
|
321
321
|
|
322
322
|
#### Defined in
|
323
323
|
|
324
|
-
[packages/framework/esm-api/src/
|
324
|
+
[packages/framework/esm-api/src/current-user.ts:9](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L9)
|
325
325
|
|
326
326
|
___
|
327
327
|
|
@@ -338,7 +338,7 @@ ___
|
|
338
338
|
|
339
339
|
#### Defined in
|
340
340
|
|
341
|
-
[packages/framework/esm-api/src/
|
341
|
+
[packages/framework/esm-api/src/current-user.ts:16](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L16)
|
342
342
|
|
343
343
|
___
|
344
344
|
|
@@ -382,7 +382,7 @@ ___
|
|
382
382
|
|
383
383
|
#### Defined in
|
384
384
|
|
385
|
-
|
385
|
+
packages/framework/esm-utils/dist/dates/date-util.d.ts:6
|
386
386
|
|
387
387
|
___
|
388
388
|
|
@@ -392,7 +392,7 @@ ___
|
|
392
392
|
|
393
393
|
#### Defined in
|
394
394
|
|
395
|
-
|
395
|
+
packages/framework/esm-utils/dist/dates/date-util.d.ts:49
|
396
396
|
|
397
397
|
___
|
398
398
|
|
@@ -416,7 +416,7 @@ ___
|
|
416
416
|
|
417
417
|
#### Defined in
|
418
418
|
|
419
|
-
|
419
|
+
packages/framework/esm-utils/dist/dates/date-util.d.ts:50
|
420
420
|
|
421
421
|
___
|
422
422
|
|
@@ -434,7 +434,7 @@ ___
|
|
434
434
|
|
435
435
|
### ExtensionSlotProps
|
436
436
|
|
437
|
-
Ƭ **ExtensionSlotProps**: [`OldExtensionSlotBaseProps`](interfaces/OldExtensionSlotBaseProps.md) \| [`ExtensionSlotBaseProps`](interfaces/ExtensionSlotBaseProps.md) & `Omit`<`React.HTMLAttributes`<`HTMLDivElement`\>, ``"children"``\> & { `children?`: `React.ReactNode` \| (`extension`:
|
437
|
+
Ƭ **ExtensionSlotProps**: [`OldExtensionSlotBaseProps`](interfaces/OldExtensionSlotBaseProps.md) \| [`ExtensionSlotBaseProps`](interfaces/ExtensionSlotBaseProps.md) & `Omit`<`React.HTMLAttributes`<`HTMLDivElement`\>, ``"children"``\> & { `children?`: `React.ReactNode` \| (`extension`: `AssignedExtension`, `state?`: `Record`<`string`, `unknown`\>) => `React.ReactNode` }
|
438
438
|
|
439
439
|
#### Defined in
|
440
440
|
|
@@ -570,7 +570,7 @@ A definition of an extension as extracted from an app's routes.json
|
|
570
570
|
|
571
571
|
#### Defined in
|
572
572
|
|
573
|
-
|
573
|
+
packages/framework/esm-globals/dist/types.d.ts:171
|
574
574
|
|
575
575
|
___
|
576
576
|
|
@@ -600,7 +600,7 @@ A definition of a modal as extracted from an app's routes.json
|
|
600
600
|
|
601
601
|
#### Defined in
|
602
602
|
|
603
|
-
|
603
|
+
packages/framework/esm-globals/dist/types.d.ts:234
|
604
604
|
|
605
605
|
___
|
606
606
|
|
@@ -610,7 +610,7 @@ ___
|
|
610
610
|
|
611
611
|
#### Defined in
|
612
612
|
|
613
|
-
|
613
|
+
packages/framework/esm-globals/dist/types.d.ts:392
|
614
614
|
|
615
615
|
___
|
616
616
|
|
@@ -623,7 +623,7 @@ Basically, this is the same as the app routes, with each routes definition keyed
|
|
623
623
|
|
624
624
|
#### Defined in
|
625
625
|
|
626
|
-
|
626
|
+
packages/framework/esm-globals/dist/types.d.ts:388
|
627
627
|
|
628
628
|
___
|
629
629
|
|
@@ -635,7 +635,7 @@ A definition of a page extracted from an app's routes.json
|
|
635
635
|
|
636
636
|
#### Defined in
|
637
637
|
|
638
|
-
|
638
|
+
packages/framework/esm-globals/dist/types.d.ts:113
|
639
639
|
|
640
640
|
___
|
641
641
|
|
@@ -673,13 +673,23 @@ ___
|
|
673
673
|
|
674
674
|
___
|
675
675
|
|
676
|
+
### ResourceName
|
677
|
+
|
678
|
+
Ƭ **ResourceName**: ``"DomainResource"`` \| ``"Organization"`` \| ``"Location"`` \| ``"HealthcareService"`` \| ``"Practitioner"`` \| ``"Patient"`` \| ``"RelatedPerson"`` \| ``"Device"`` \| ``"Account"`` \| ``"AllergyIntolerance"`` \| ``"Schedule"`` \| ``"Slot"`` \| ``"Appointment"`` \| ``"AppointmentResponse"`` \| ``"AuditEvent"`` \| ``"Basic"`` \| ``"BodySite"`` \| ``"Substance"`` \| ``"Medication"`` \| ``"Group"`` \| ``"Specimen"`` \| ``"DeviceComponent"`` \| ``"DeviceMetric"`` \| ``"ValueSet"`` \| ``"Questionnaire"`` \| ``"QuestionnaireResponse"`` \| ``"Observation"`` \| ``"FamilyMemberHistory"`` \| ``"DocumentReference"`` \| ``"DiagnosticOrder"`` \| ``"ProcedureRequest"`` \| ``"ReferralRequest"`` \| ``"Procedure"`` \| ``"ImagingStudy"`` \| ``"ImagingObjectSelection"`` \| ``"Media"`` \| ``"DiagnosticReport"`` \| ``"CommunicationRequest"`` \| ``"DeviceUseRequest"`` \| ``"MedicationOrder"`` \| ``"NutritionOrder"`` \| ``"Order"`` \| ``"ProcessRequest"`` \| ``"SupplyRequest"`` \| ``"VisionPrescription"`` \| ``"ClinicalImpression"`` \| ``"Condition"`` \| ``"EpisodeOfCare"`` \| ``"Encounter"`` \| ``"MedicationStatement"`` \| ``"RiskAssessment"`` \| ``"Goal"`` \| ``"CarePlan"`` \| ``"Composition"`` \| ``"Contract"`` \| ``"Coverage"`` \| ``"ClaimResponse"`` \| ``"Claim"`` \| ``"Communication"`` \| ``"StructureDefinition"`` \| ``"ConceptMap"`` \| ``"OperationDefinition"`` \| ``"Conformance"`` \| ``"DataElement"`` \| ``"DetectedIssue"`` \| ``"DeviceUseStatement"`` \| ``"DocumentManifest"`` \| ``"EligibilityRequest"`` \| ``"EligibilityResponse"`` \| ``"EnrollmentRequest"`` \| ``"EnrollmentResponse"`` \| ``"ExplanationOfBenefit"`` \| ``"Flag"`` \| ``"Immunization"`` \| ``"ImmunizationRecommendation"`` \| ``"ImplementationGuide"`` \| ``"List"`` \| ``"MedicationAdministration"`` \| ``"MedicationDispense"`` \| ``"OperationOutcome"`` \| ``"MessageHeader"`` \| ``"NamingSystem"`` \| ``"OrderResponse"`` \| ``"PaymentNotice"`` \| ``"PaymentReconciliation"`` \| ``"Person"`` \| ``"ProcessResponse"`` \| ``"Provenance"`` \| ``"SearchParameter"`` \| ``"Subscription"`` \| ``"SupplyDelivery"`` \| ``"TestScript"`` \| ``"Binary"`` \| ``"Bundle"`` \| ``"Parameters"``
|
679
|
+
|
680
|
+
#### Defined in
|
681
|
+
|
682
|
+
[packages/framework/esm-emr-api/src/types/fhir.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/fhir.ts#L7)
|
683
|
+
|
684
|
+
___
|
685
|
+
|
676
686
|
### SpaEnvironment
|
677
687
|
|
678
688
|
Ƭ **SpaEnvironment**: ``"production"`` \| ``"development"`` \| ``"test"``
|
679
689
|
|
680
690
|
#### Defined in
|
681
691
|
|
682
|
-
|
692
|
+
packages/framework/esm-globals/dist/types.d.ts:73
|
683
693
|
|
684
694
|
___
|
685
695
|
|
@@ -713,7 +723,7 @@ ___
|
|
713
723
|
|
714
724
|
#### Defined in
|
715
725
|
|
716
|
-
[packages/framework/esm-styleguide/src/pictograms/pictograms.tsx:
|
726
|
+
[packages/framework/esm-styleguide/src/pictograms/pictograms.tsx:108](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/pictograms/pictograms.tsx#L108)
|
717
727
|
|
718
728
|
___
|
719
729
|
|
@@ -723,7 +733,7 @@ ___
|
|
723
733
|
|
724
734
|
#### Defined in
|
725
735
|
|
726
|
-
[packages/framework/esm-api/src/types/visit-resource.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/types/visit-resource.ts#L18)
|
736
|
+
[packages/framework/esm-emr-api/src/types/visit-resource.ts:18](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/types/visit-resource.ts#L18)
|
727
737
|
|
728
738
|
___
|
729
739
|
|
@@ -799,7 +809,7 @@ A definition of a workspace as extracted from an app's routes.json
|
|
799
809
|
|
800
810
|
#### Defined in
|
801
811
|
|
802
|
-
|
812
|
+
packages/framework/esm-globals/dist/types.d.ts:264
|
803
813
|
|
804
814
|
___
|
805
815
|
|
@@ -809,7 +819,7 @@ ___
|
|
809
819
|
|
810
820
|
#### Defined in
|
811
821
|
|
812
|
-
|
822
|
+
packages/framework/esm-globals/dist/types.d.ts:260
|
813
823
|
|
814
824
|
___
|
815
825
|
|
@@ -909,7 +919,7 @@ ___
|
|
909
919
|
|
910
920
|
#### Defined in
|
911
921
|
|
912
|
-
[packages/framework/esm-styleguide/src/notifications/notification.component.tsx:
|
922
|
+
[packages/framework/esm-styleguide/src/notifications/notification.component.tsx:23](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/notifications/notification.component.tsx#L23)
|
913
923
|
|
914
924
|
___
|
915
925
|
|
@@ -984,7 +994,7 @@ ___
|
|
984
994
|
| Name | Type |
|
985
995
|
| :------ | :------ |
|
986
996
|
| `abortController?` | `AbortController` |
|
987
|
-
| `fetchInit?` |
|
997
|
+
| `fetchInit?` | `FetchConfig` |
|
988
998
|
| `swrConfig?` | `SWRConfiguration` |
|
989
999
|
| `url?` | `string` \| (`key`: [`Key`](API.md#key)) => `string` |
|
990
1000
|
|
@@ -1039,7 +1049,7 @@ ___
|
|
1039
1049
|
|
1040
1050
|
#### Defined in
|
1041
1051
|
|
1042
|
-
[packages/framework/esm-api/src/attachments.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/attachments.ts#L5)
|
1052
|
+
[packages/framework/esm-emr-api/src/attachments.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/attachments.ts#L5)
|
1043
1053
|
|
1044
1054
|
___
|
1045
1055
|
|
@@ -1049,7 +1059,7 @@ ___
|
|
1049
1059
|
|
1050
1060
|
#### Defined in
|
1051
1061
|
|
1052
|
-
[packages/framework/esm-api/src/
|
1062
|
+
[packages/framework/esm-emr-api/src/visit-utils.ts:39](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-utils.ts#L39)
|
1053
1063
|
|
1054
1064
|
___
|
1055
1065
|
|
@@ -1059,7 +1069,7 @@ ___
|
|
1059
1069
|
|
1060
1070
|
#### Defined in
|
1061
1071
|
|
1062
|
-
[packages/framework/esm-api/src/openmrs-fetch.ts:
|
1072
|
+
[packages/framework/esm-api/src/openmrs-fetch.ts:9](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/openmrs-fetch.ts#L9)
|
1063
1073
|
|
1064
1074
|
___
|
1065
1075
|
|
@@ -1071,7 +1081,7 @@ ___
|
|
1071
1081
|
|
1072
1082
|
#### Defined in
|
1073
1083
|
|
1074
|
-
[packages/framework/esm-api/src/
|
1084
|
+
[packages/framework/esm-emr-api/src/visit-utils.ts:127](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-utils.ts#L127)
|
1075
1085
|
|
1076
1086
|
___
|
1077
1087
|
|
@@ -1081,7 +1091,7 @@ ___
|
|
1081
1091
|
|
1082
1092
|
#### Defined in
|
1083
1093
|
|
1084
|
-
[packages/framework/esm-api/src/openmrs-fetch.ts:
|
1094
|
+
[packages/framework/esm-api/src/openmrs-fetch.ts:8](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/openmrs-fetch.ts#L8)
|
1085
1095
|
|
1086
1096
|
___
|
1087
1097
|
|
@@ -1091,7 +1101,7 @@ ___
|
|
1091
1101
|
|
1092
1102
|
#### Defined in
|
1093
1103
|
|
1094
|
-
[packages/framework/esm-api/src/openmrs-fetch.ts:
|
1104
|
+
[packages/framework/esm-api/src/openmrs-fetch.ts:10](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/openmrs-fetch.ts#L10)
|
1095
1105
|
|
1096
1106
|
___
|
1097
1107
|
|
@@ -1144,7 +1154,7 @@ ___
|
|
1144
1154
|
|
1145
1155
|
#### Defined in
|
1146
1156
|
|
1147
|
-
[packages/framework/esm-offline/src/uuid.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/uuid.ts#L4)
|
1157
|
+
[packages/framework/esm-offline/src/uuid-support.ts:4](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/uuid-support.ts#L4)
|
1148
1158
|
|
1149
1159
|
___
|
1150
1160
|
|
@@ -1822,7 +1832,7 @@ is available. The goal is to make it easier to conditionally render configuratio
|
|
1822
1832
|
|
1823
1833
|
#### Defined in
|
1824
1834
|
|
1825
|
-
[packages/framework/esm-styleguide/src/pictograms/pictograms.tsx:
|
1835
|
+
[packages/framework/esm-styleguide/src/pictograms/pictograms.tsx:75](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/pictograms/pictograms.tsx#L75)
|
1826
1836
|
|
1827
1837
|
___
|
1828
1838
|
|
@@ -1978,7 +1988,7 @@ This is a utility type for custom pictograms. Please maintain alphabetical order
|
|
1978
1988
|
|
1979
1989
|
#### Defined in
|
1980
1990
|
|
1981
|
-
[packages/framework/esm-styleguide/src/pictograms/pictograms.tsx:
|
1991
|
+
[packages/framework/esm-styleguide/src/pictograms/pictograms.tsx:118](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/pictograms/pictograms.tsx#L118)
|
1982
1992
|
|
1983
1993
|
___
|
1984
1994
|
|
@@ -2177,6 +2187,16 @@ Used as action button to open ward in-patient note workspace
|
|
2177
2187
|
|
2178
2188
|
___
|
2179
2189
|
|
2190
|
+
### StockManagementPictogram
|
2191
|
+
|
2192
|
+
• `Const` **StockManagementPictogram**: `MemoExoticComponent`<`ForwardRefExoticComponent`<[`PictogramProps`](API.md#pictogramprops) & `RefAttributes`<`SVGSVGElement`\>\>\>
|
2193
|
+
|
2194
|
+
#### Defined in
|
2195
|
+
|
2196
|
+
[packages/framework/esm-styleguide/src/pictograms/pictograms.tsx:60](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/pictograms/pictograms.tsx#L60)
|
2197
|
+
|
2198
|
+
___
|
2199
|
+
|
2180
2200
|
### SwitcherIcon
|
2181
2201
|
|
2182
2202
|
• `Const` **SwitcherIcon**: `MemoExoticComponent`<`ForwardRefExoticComponent`<[`IconProps`](API.md#iconprops) & `RefAttributes`<`SVGSVGElement`\>\>\>
|
@@ -2378,7 +2398,7 @@ is deprecated; it simply renders nothing.
|
|
2378
2398
|
|
2379
2399
|
#### Defined in
|
2380
2400
|
|
2381
|
-
[packages/framework/esm-styleguide/src/left-nav/index.tsx:
|
2401
|
+
[packages/framework/esm-styleguide/src/left-nav/index.tsx:52](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/left-nav/index.tsx#L52)
|
2382
2402
|
|
2383
2403
|
___
|
2384
2404
|
|
@@ -2474,13 +2494,13 @@ ___
|
|
2474
2494
|
|
2475
2495
|
#### Defined in
|
2476
2496
|
|
2477
|
-
[packages/framework/esm-api/src/
|
2497
|
+
[packages/framework/esm-api/src/current-user.ts:177](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L177)
|
2478
2498
|
|
2479
2499
|
___
|
2480
2500
|
|
2481
2501
|
### createAttachment
|
2482
2502
|
|
2483
|
-
▸ **createAttachment**(`patientUuid`, `fileToUpload`): `Promise
|
2503
|
+
▸ **createAttachment**(`patientUuid`, `fileToUpload`): `Promise`<`FetchResponse`<`any`\>\>
|
2484
2504
|
|
2485
2505
|
#### Parameters
|
2486
2506
|
|
@@ -2491,17 +2511,17 @@ ___
|
|
2491
2511
|
|
2492
2512
|
#### Returns
|
2493
2513
|
|
2494
|
-
`Promise
|
2514
|
+
`Promise`<`FetchResponse`<`any`\>\>
|
2495
2515
|
|
2496
2516
|
#### Defined in
|
2497
2517
|
|
2498
|
-
[packages/framework/esm-api/src/attachments.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/attachments.ts#L19)
|
2518
|
+
[packages/framework/esm-emr-api/src/attachments.ts:19](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/attachments.ts#L19)
|
2499
2519
|
|
2500
2520
|
___
|
2501
2521
|
|
2502
2522
|
### deleteAttachmentPermanently
|
2503
2523
|
|
2504
|
-
▸ **deleteAttachmentPermanently**(`attachmentUuid`, `abortController`): `Promise
|
2524
|
+
▸ **deleteAttachmentPermanently**(`attachmentUuid`, `abortController`): `Promise`<`FetchResponse`<`any`\>\>
|
2505
2525
|
|
2506
2526
|
#### Parameters
|
2507
2527
|
|
@@ -2512,11 +2532,11 @@ ___
|
|
2512
2532
|
|
2513
2533
|
#### Returns
|
2514
2534
|
|
2515
|
-
`Promise
|
2535
|
+
`Promise`<`FetchResponse`<`any`\>\>
|
2516
2536
|
|
2517
2537
|
#### Defined in
|
2518
2538
|
|
2519
|
-
[packages/framework/esm-api/src/attachments.ts:38](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/attachments.ts#L38)
|
2539
|
+
[packages/framework/esm-emr-api/src/attachments.ts:38](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/attachments.ts#L38)
|
2520
2540
|
|
2521
2541
|
___
|
2522
2542
|
|
@@ -2529,7 +2549,7 @@ ___
|
|
2529
2549
|
| Name | Type | Default value |
|
2530
2550
|
| :------ | :------ | :------ |
|
2531
2551
|
| `patientUuid` | [`PatientUuid`](API.md#patientuuid) | `undefined` |
|
2532
|
-
| `fetchInit?` |
|
2552
|
+
| `fetchInit?` | `FetchConfig` | `undefined` |
|
2533
2553
|
| `includeOfflinePatients` | `boolean` | `true` |
|
2534
2554
|
|
2535
2555
|
#### Returns
|
@@ -2538,13 +2558,13 @@ ___
|
|
2538
2558
|
|
2539
2559
|
#### Defined in
|
2540
2560
|
|
2541
|
-
[packages/framework/esm-api/src/
|
2561
|
+
[packages/framework/esm-emr-api/src/current-patient.ts:21](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/current-patient.ts#L21)
|
2542
2562
|
|
2543
2563
|
___
|
2544
2564
|
|
2545
2565
|
### getAttachmentByUuid
|
2546
2566
|
|
2547
|
-
▸ **getAttachmentByUuid**(`attachmentUuid`, `abortController`): `Promise
|
2567
|
+
▸ **getAttachmentByUuid**(`attachmentUuid`, `abortController`): `Promise`<`FetchResponse`<`any`\>\>
|
2548
2568
|
|
2549
2569
|
#### Parameters
|
2550
2570
|
|
@@ -2555,17 +2575,17 @@ ___
|
|
2555
2575
|
|
2556
2576
|
#### Returns
|
2557
2577
|
|
2558
|
-
`Promise
|
2578
|
+
`Promise`<`FetchResponse`<`any`\>\>
|
2559
2579
|
|
2560
2580
|
#### Defined in
|
2561
2581
|
|
2562
|
-
[packages/framework/esm-api/src/attachments.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/attachments.ts#L7)
|
2582
|
+
[packages/framework/esm-emr-api/src/attachments.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/attachments.ts#L7)
|
2563
2583
|
|
2564
2584
|
___
|
2565
2585
|
|
2566
2586
|
### getAttachments
|
2567
2587
|
|
2568
|
-
▸ **getAttachments**(`patientUuid`, `includeEncounterless`, `abortController`): `Promise
|
2588
|
+
▸ **getAttachments**(`patientUuid`, `includeEncounterless`, `abortController`): `Promise`<`FetchResponse`<`any`\>\>
|
2569
2589
|
|
2570
2590
|
#### Parameters
|
2571
2591
|
|
@@ -2577,11 +2597,11 @@ ___
|
|
2577
2597
|
|
2578
2598
|
#### Returns
|
2579
2599
|
|
2580
|
-
`Promise
|
2600
|
+
`Promise`<`FetchResponse`<`any`\>\>
|
2581
2601
|
|
2582
2602
|
#### Defined in
|
2583
2603
|
|
2584
|
-
[packages/framework/esm-api/src/attachments.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/attachments.ts#L13)
|
2604
|
+
[packages/framework/esm-emr-api/src/attachments.ts:13](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/attachments.ts#L13)
|
2585
2605
|
|
2586
2606
|
___
|
2587
2607
|
|
@@ -2626,7 +2646,7 @@ leak and source of bugs.
|
|
2626
2646
|
|
2627
2647
|
#### Defined in
|
2628
2648
|
|
2629
|
-
[packages/framework/esm-api/src/
|
2649
|
+
[packages/framework/esm-api/src/current-user.ts:66](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L66)
|
2630
2650
|
|
2631
2651
|
▸ **getCurrentUser**(`opts`): `Observable`<[`Session`](interfaces/Session.md)\>
|
2632
2652
|
|
@@ -2643,7 +2663,7 @@ leak and source of bugs.
|
|
2643
2663
|
|
2644
2664
|
#### Defined in
|
2645
2665
|
|
2646
|
-
[packages/framework/esm-api/src/
|
2666
|
+
[packages/framework/esm-api/src/current-user.ts:67](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L67)
|
2647
2667
|
|
2648
2668
|
▸ **getCurrentUser**(`opts`): `Observable`<[`LoggedInUser`](interfaces/LoggedInUser.md)\>
|
2649
2669
|
|
@@ -2660,7 +2680,7 @@ leak and source of bugs.
|
|
2660
2680
|
|
2661
2681
|
#### Defined in
|
2662
2682
|
|
2663
|
-
[packages/framework/esm-api/src/
|
2683
|
+
[packages/framework/esm-api/src/current-user.ts:68](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L68)
|
2664
2684
|
|
2665
2685
|
___
|
2666
2686
|
|
@@ -2681,7 +2701,7 @@ ___
|
|
2681
2701
|
|
2682
2702
|
#### Defined in
|
2683
2703
|
|
2684
|
-
[packages/framework/esm-api/src/
|
2704
|
+
[packages/framework/esm-emr-api/src/location.ts:14](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/location.ts#L14)
|
2685
2705
|
|
2686
2706
|
___
|
2687
2707
|
|
@@ -2695,7 +2715,7 @@ ___
|
|
2695
2715
|
|
2696
2716
|
#### Defined in
|
2697
2717
|
|
2698
|
-
[packages/framework/esm-api/src/
|
2718
|
+
[packages/framework/esm-api/src/current-user.ts:201](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L201)
|
2699
2719
|
|
2700
2720
|
___
|
2701
2721
|
|
@@ -2709,7 +2729,7 @@ ___
|
|
2709
2729
|
|
2710
2730
|
#### Defined in
|
2711
2731
|
|
2712
|
-
[packages/framework/esm-api/src/
|
2732
|
+
[packages/framework/esm-api/src/current-user.ts:219](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L219)
|
2713
2733
|
|
2714
2734
|
___
|
2715
2735
|
|
@@ -2723,7 +2743,7 @@ ___
|
|
2723
2743
|
|
2724
2744
|
#### Defined in
|
2725
2745
|
|
2726
|
-
[packages/framework/esm-api/src/
|
2746
|
+
[packages/framework/esm-api/src/current-user.ts:93](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L93)
|
2727
2747
|
|
2728
2748
|
___
|
2729
2749
|
|
@@ -2737,7 +2757,7 @@ ___
|
|
2737
2757
|
|
2738
2758
|
#### Defined in
|
2739
2759
|
|
2740
|
-
[packages/framework/esm-api/src/
|
2760
|
+
[packages/framework/esm-emr-api/src/visit-utils.ts:57](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-utils.ts#L57)
|
2741
2761
|
|
2742
2762
|
___
|
2743
2763
|
|
@@ -2751,13 +2771,13 @@ ___
|
|
2751
2771
|
|
2752
2772
|
#### Defined in
|
2753
2773
|
|
2754
|
-
[packages/framework/esm-api/src/
|
2774
|
+
[packages/framework/esm-emr-api/src/visit-type.ts:15](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-type.ts#L15)
|
2755
2775
|
|
2756
2776
|
___
|
2757
2777
|
|
2758
2778
|
### getVisitsForPatient
|
2759
2779
|
|
2760
|
-
▸ **getVisitsForPatient**(`patientUuid`, `abortController`, `v?`): `Promise`<
|
2780
|
+
▸ **getVisitsForPatient**(`patientUuid`, `abortController`, `v?`): `Promise`<`FetchResponse`<{ `results`: [`Visit`](interfaces/Visit.md)[] }\>\>
|
2761
2781
|
|
2762
2782
|
**`deprecated`** Use the `useVisit` hook instead.
|
2763
2783
|
|
@@ -2771,11 +2791,11 @@ ___
|
|
2771
2791
|
|
2772
2792
|
#### Returns
|
2773
2793
|
|
2774
|
-
`Promise`<
|
2794
|
+
`Promise`<`FetchResponse`<{ `results`: [`Visit`](interfaces/Visit.md)[] }\>\>
|
2775
2795
|
|
2776
2796
|
#### Defined in
|
2777
2797
|
|
2778
|
-
[packages/framework/esm-api/src/
|
2798
|
+
[packages/framework/esm-emr-api/src/visit-utils.ts:110](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-utils.ts#L110)
|
2779
2799
|
|
2780
2800
|
___
|
2781
2801
|
|
@@ -2804,7 +2824,7 @@ makeUrl('/foo/bar');
|
|
2804
2824
|
|
2805
2825
|
#### Defined in
|
2806
2826
|
|
2807
|
-
[packages/framework/esm-api/src/openmrs-fetch.ts:
|
2827
|
+
[packages/framework/esm-api/src/openmrs-fetch.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/openmrs-fetch.ts#L22)
|
2808
2828
|
|
2809
2829
|
___
|
2810
2830
|
|
@@ -2871,7 +2891,7 @@ free up memory and network resources and to prevent race conditions.
|
|
2871
2891
|
|
2872
2892
|
#### Defined in
|
2873
2893
|
|
2874
|
-
[packages/framework/esm-api/src/openmrs-fetch.ts:
|
2894
|
+
[packages/framework/esm-api/src/openmrs-fetch.ts:82](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/openmrs-fetch.ts#L82)
|
2875
2895
|
|
2876
2896
|
___
|
2877
2897
|
|
@@ -2922,7 +2942,7 @@ To cancel the network request, simply call `subscription.unsubscribe();`
|
|
2922
2942
|
|
2923
2943
|
#### Defined in
|
2924
2944
|
|
2925
|
-
[packages/framework/esm-api/src/openmrs-fetch.ts:
|
2945
|
+
[packages/framework/esm-api/src/openmrs-fetch.ts:269](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/openmrs-fetch.ts#L269)
|
2926
2946
|
|
2927
2947
|
___
|
2928
2948
|
|
@@ -2955,13 +2975,13 @@ refetchCurrentUser()
|
|
2955
2975
|
|
2956
2976
|
#### Defined in
|
2957
2977
|
|
2958
|
-
[packages/framework/esm-api/src/
|
2978
|
+
[packages/framework/esm-api/src/current-user.ts:163](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L163)
|
2959
2979
|
|
2960
2980
|
___
|
2961
2981
|
|
2962
2982
|
### saveVisit
|
2963
2983
|
|
2964
|
-
▸ **saveVisit**(`payload`, `abortController`): `Promise`<[`
|
2984
|
+
▸ **saveVisit**(`payload`, `abortController`): `Promise`<`FetchResponse`<[`Visit`](interfaces/Visit.md)\>\>
|
2965
2985
|
|
2966
2986
|
#### Parameters
|
2967
2987
|
|
@@ -2972,11 +2992,11 @@ ___
|
|
2972
2992
|
|
2973
2993
|
#### Returns
|
2974
2994
|
|
2975
|
-
`Promise`<[`
|
2995
|
+
`Promise`<`FetchResponse`<[`Visit`](interfaces/Visit.md)\>\>
|
2976
2996
|
|
2977
2997
|
#### Defined in
|
2978
2998
|
|
2979
|
-
[packages/framework/esm-api/src/
|
2999
|
+
[packages/framework/esm-emr-api/src/visit-utils.ts:81](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-utils.ts#L81)
|
2980
3000
|
|
2981
3001
|
___
|
2982
3002
|
|
@@ -2997,7 +3017,7 @@ ___
|
|
2997
3017
|
|
2998
3018
|
#### Defined in
|
2999
3019
|
|
3000
|
-
[packages/framework/esm-api/src/
|
3020
|
+
[packages/framework/esm-emr-api/src/visit-utils.ts:61](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-utils.ts#L61)
|
3001
3021
|
|
3002
3022
|
___
|
3003
3023
|
|
@@ -3018,7 +3038,7 @@ ___
|
|
3018
3038
|
|
3019
3039
|
#### Defined in
|
3020
3040
|
|
3021
|
-
[packages/framework/esm-api/src/
|
3041
|
+
[packages/framework/esm-api/src/current-user.ts:228](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L228)
|
3022
3042
|
|
3023
3043
|
___
|
3024
3044
|
|
@@ -3038,7 +3058,7 @@ ___
|
|
3038
3058
|
|
3039
3059
|
#### Defined in
|
3040
3060
|
|
3041
|
-
[packages/framework/esm-api/src/
|
3061
|
+
[packages/framework/esm-api/src/current-user.ts:116](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L116)
|
3042
3062
|
|
3043
3063
|
___
|
3044
3064
|
|
@@ -3060,7 +3080,7 @@ ___
|
|
3060
3080
|
|
3061
3081
|
#### Defined in
|
3062
3082
|
|
3063
|
-
[packages/framework/esm-api/src/
|
3083
|
+
[packages/framework/esm-api/src/current-user.ts:241](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L241)
|
3064
3084
|
|
3065
3085
|
___
|
3066
3086
|
|
@@ -3080,7 +3100,7 @@ ___
|
|
3080
3100
|
|
3081
3101
|
#### Defined in
|
3082
3102
|
|
3083
|
-
[packages/framework/esm-api/src/
|
3103
|
+
[packages/framework/esm-emr-api/src/location.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/location.ts#L7)
|
3084
3104
|
|
3085
3105
|
___
|
3086
3106
|
|
@@ -3100,13 +3120,13 @@ ___
|
|
3100
3120
|
|
3101
3121
|
#### Defined in
|
3102
3122
|
|
3103
|
-
[packages/framework/esm-api/src/
|
3123
|
+
[packages/framework/esm-emr-api/src/visit-type.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-type.ts#L7)
|
3104
3124
|
|
3105
3125
|
___
|
3106
3126
|
|
3107
3127
|
### updateVisit
|
3108
3128
|
|
3109
|
-
▸ **updateVisit**(`uuid`, `payload`, `abortController`): `Promise`<[`
|
3129
|
+
▸ **updateVisit**(`uuid`, `payload`, `abortController`): `Promise`<`FetchResponse`<[`Visit`](interfaces/Visit.md)\>\>
|
3110
3130
|
|
3111
3131
|
#### Parameters
|
3112
3132
|
|
@@ -3118,11 +3138,11 @@ ___
|
|
3118
3138
|
|
3119
3139
|
#### Returns
|
3120
3140
|
|
3121
|
-
`Promise`<[`
|
3141
|
+
`Promise`<`FetchResponse`<[`Visit`](interfaces/Visit.md)\>\>
|
3122
3142
|
|
3123
3143
|
#### Defined in
|
3124
3144
|
|
3125
|
-
[packages/framework/esm-api/src/
|
3145
|
+
[packages/framework/esm-emr-api/src/visit-utils.ts:92](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-emr-api/src/visit-utils.ts#L92)
|
3126
3146
|
|
3127
3147
|
___
|
3128
3148
|
|
@@ -3143,15 +3163,15 @@ ___
|
|
3143
3163
|
|
3144
3164
|
| Name | Type |
|
3145
3165
|
| :------ | :------ |
|
3146
|
-
| `data` |
|
3166
|
+
| `data` | `AttachmentResponse`[] |
|
3147
3167
|
| `error` | `any` |
|
3148
3168
|
| `isLoading` | `boolean` |
|
3149
3169
|
| `isValidating` | `boolean` |
|
3150
|
-
| `mutate` | `KeyedMutator`<
|
3170
|
+
| `mutate` | `KeyedMutator`<`FetchResponse`<{ `results`: `AttachmentResponse`[] }\>\> |
|
3151
3171
|
|
3152
3172
|
#### Defined in
|
3153
3173
|
|
3154
|
-
[packages/framework/esm-react-utils/src/useAttachments.ts:
|
3174
|
+
[packages/framework/esm-react-utils/src/useAttachments.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useAttachments.ts#L7)
|
3155
3175
|
|
3156
3176
|
___
|
3157
3177
|
|
@@ -3173,10 +3193,10 @@ Object containing:
|
|
3173
3193
|
|
3174
3194
|
| Name | Type |
|
3175
3195
|
| :------ | :------ |
|
3176
|
-
| `emrConfiguration` | `undefined` \| `EmrApiConfigurationResponse` |
|
3196
|
+
| `emrConfiguration` | `undefined` \| [`EmrApiConfigurationResponse`](interfaces/EmrApiConfigurationResponse.md) |
|
3177
3197
|
| `errorFetchingEmrConfiguration` | `undefined` \| `Error` |
|
3178
3198
|
| `isLoadingEmrConfiguration` | `boolean` |
|
3179
|
-
| `mutateEmrConfiguration` | `KeyedMutator`<[`
|
3199
|
+
| `mutateEmrConfiguration` | `KeyedMutator`<`FetchResponse`<[`EmrApiConfigurationResponse`](interfaces/EmrApiConfigurationResponse.md)\>\> |
|
3180
3200
|
|
3181
3201
|
#### Defined in
|
3182
3202
|
|
@@ -3186,7 +3206,7 @@ ___
|
|
3186
3206
|
|
3187
3207
|
### useLocations
|
3188
3208
|
|
3189
|
-
▸ **useLocations**(`tagUuidOrName?`, `query?`):
|
3209
|
+
▸ **useLocations**(`tagUuidOrName?`, `query?`): `Location`[]
|
3190
3210
|
|
3191
3211
|
#### Parameters
|
3192
3212
|
|
@@ -3197,11 +3217,11 @@ ___
|
|
3197
3217
|
|
3198
3218
|
#### Returns
|
3199
3219
|
|
3200
|
-
|
3220
|
+
`Location`[]
|
3201
3221
|
|
3202
3222
|
#### Defined in
|
3203
3223
|
|
3204
|
-
[packages/framework/esm-react-utils/src/useLocations.tsx:
|
3224
|
+
[packages/framework/esm-react-utils/src/useLocations.tsx:5](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useLocations.tsx#L5)
|
3205
3225
|
|
3206
3226
|
___
|
3207
3227
|
|
@@ -3259,7 +3279,7 @@ ___
|
|
3259
3279
|
|
3260
3280
|
### useSession
|
3261
3281
|
|
3262
|
-
▸ **useSession**():
|
3282
|
+
▸ **useSession**(): `Session`
|
3263
3283
|
|
3264
3284
|
Gets the current user session information. Returns an object with
|
3265
3285
|
property `authenticated` == `false` if the user is not logged in.
|
@@ -3269,7 +3289,7 @@ or throw for Suspense. It will never return `null`/`undefined`.
|
|
3269
3289
|
|
3270
3290
|
#### Returns
|
3271
3291
|
|
3272
|
-
|
3292
|
+
`Session`
|
3273
3293
|
|
3274
3294
|
Current user session information
|
3275
3295
|
|
@@ -3318,15 +3338,15 @@ ___
|
|
3318
3338
|
|
3319
3339
|
### useVisitTypes
|
3320
3340
|
|
3321
|
-
▸ **useVisitTypes**():
|
3341
|
+
▸ **useVisitTypes**(): `VisitType`[]
|
3322
3342
|
|
3323
3343
|
#### Returns
|
3324
3344
|
|
3325
|
-
|
3345
|
+
`VisitType`[]
|
3326
3346
|
|
3327
3347
|
#### Defined in
|
3328
3348
|
|
3329
|
-
[packages/framework/esm-react-utils/src/useVisitTypes.ts:
|
3349
|
+
[packages/framework/esm-react-utils/src/useVisitTypes.ts:5](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useVisitTypes.ts#L5)
|
3330
3350
|
|
3331
3351
|
___
|
3332
3352
|
|
@@ -3349,7 +3369,7 @@ ___
|
|
3349
3369
|
|
3350
3370
|
#### Defined in
|
3351
3371
|
|
3352
|
-
[packages/framework/esm-api/src/
|
3372
|
+
[packages/framework/esm-api/src/current-user.ts:184](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/current-user.ts#L184)
|
3353
3373
|
|
3354
3374
|
___
|
3355
3375
|
|
@@ -3581,7 +3601,7 @@ Use this React Hook to obtain your module's configuration.
|
|
3581
3601
|
|
3582
3602
|
| Name | Type | Description |
|
3583
3603
|
| :------ | :------ | :------ |
|
3584
|
-
| `options?` | `UseConfigOptions` | Additional options that can be passed to useConfig() |
|
3604
|
+
| `options?` | [`UseConfigOptions`](interfaces/UseConfigOptions.md) | Additional options that can be passed to useConfig() |
|
3585
3605
|
|
3586
3606
|
#### Returns
|
3587
3607
|
|
@@ -4043,7 +4063,7 @@ CalendarDate
|
|
4043
4063
|
|
4044
4064
|
#### Defined in
|
4045
4065
|
|
4046
|
-
|
4066
|
+
packages/framework/esm-utils/dist/dates/date-util.d.ts:144
|
4047
4067
|
|
4048
4068
|
___
|
4049
4069
|
|
@@ -4082,7 +4102,7 @@ locales.
|
|
4082
4102
|
|
4083
4103
|
#### Defined in
|
4084
4104
|
|
4085
|
-
|
4105
|
+
packages/framework/esm-utils/dist/dates/date-util.d.ts:124
|
4086
4106
|
|
4087
4107
|
___
|
4088
4108
|
|
@@ -4111,13 +4131,13 @@ output of `Date.prototype.toLocaleString` for *most* locales.
|
|
4111
4131
|
|
4112
4132
|
#### Defined in
|
4113
4133
|
|
4114
|
-
|
4134
|
+
packages/framework/esm-utils/dist/dates/date-util.d.ts:139
|
4115
4135
|
|
4116
4136
|
___
|
4117
4137
|
|
4118
4138
|
### formatPartialDate
|
4119
4139
|
|
4120
|
-
▸ **formatPartialDate**(`dateString`, `options?`): ``null``
|
4140
|
+
▸ **formatPartialDate**(`dateString`, `options?`): `string` \| ``null``
|
4121
4141
|
|
4122
4142
|
Formats the string representing a date, including partial representations of dates, according to the current
|
4123
4143
|
locale and the given options.
|
@@ -4142,15 +4162,15 @@ locales.
|
|
4142
4162
|
| Name | Type |
|
4143
4163
|
| :------ | :------ |
|
4144
4164
|
| `dateString` | `string` |
|
4145
|
-
| `options
|
4165
|
+
| `options?` | `Partial`<[`FormatDateOptions`](API.md#formatdateoptions)\> |
|
4146
4166
|
|
4147
4167
|
#### Returns
|
4148
4168
|
|
4149
|
-
``null``
|
4169
|
+
`string` \| ``null``
|
4150
4170
|
|
4151
4171
|
#### Defined in
|
4152
4172
|
|
4153
|
-
|
4173
|
+
packages/framework/esm-utils/dist/dates/date-util.d.ts:104
|
4154
4174
|
|
4155
4175
|
___
|
4156
4176
|
|
@@ -4173,13 +4193,13 @@ Formats the input as a time, according to the current locale.
|
|
4173
4193
|
|
4174
4194
|
#### Defined in
|
4175
4195
|
|
4176
|
-
|
4196
|
+
packages/framework/esm-utils/dist/dates/date-util.d.ts:129
|
4177
4197
|
|
4178
4198
|
___
|
4179
4199
|
|
4180
4200
|
### getDefaultCalendar
|
4181
4201
|
|
4182
|
-
▸ **getDefaultCalendar**(`locale`): `
|
4202
|
+
▸ **getDefaultCalendar**(`locale`): `CalendarIdentifier` \| `undefined`
|
4183
4203
|
|
4184
4204
|
Retrieves the default calendar for the specified locale if any.
|
4185
4205
|
|
@@ -4191,11 +4211,11 @@ Retrieves the default calendar for the specified locale if any.
|
|
4191
4211
|
|
4192
4212
|
#### Returns
|
4193
4213
|
|
4194
|
-
`
|
4214
|
+
`CalendarIdentifier` \| `undefined`
|
4195
4215
|
|
4196
4216
|
#### Defined in
|
4197
4217
|
|
4198
|
-
|
4218
|
+
packages/framework/esm-utils/dist/dates/date-util.d.ts:48
|
4199
4219
|
|
4200
4220
|
___
|
4201
4221
|
|
@@ -4218,7 +4238,7 @@ The format should be YYYY-MM-DDTHH:mm:ss.SSSZZ
|
|
4218
4238
|
|
4219
4239
|
#### Defined in
|
4220
4240
|
|
4221
|
-
|
4241
|
+
packages/framework/esm-utils/dist/dates/date-util.d.ts:11
|
4222
4242
|
|
4223
4243
|
___
|
4224
4244
|
|
@@ -4238,7 +4258,7 @@ ___
|
|
4238
4258
|
|
4239
4259
|
#### Defined in
|
4240
4260
|
|
4241
|
-
|
4261
|
+
packages/framework/esm-utils/dist/dates/date-util.d.ts:16
|
4242
4262
|
|
4243
4263
|
___
|
4244
4264
|
|
@@ -4261,7 +4281,7 @@ Uses `dayjs(dateString)`.
|
|
4261
4281
|
|
4262
4282
|
#### Defined in
|
4263
4283
|
|
4264
|
-
|
4284
|
+
packages/framework/esm-utils/dist/dates/date-util.d.ts:30
|
4265
4285
|
|
4266
4286
|
___
|
4267
4287
|
|
@@ -4289,7 +4309,7 @@ registerDefaultCalendar('en', 'buddhist') // sets the default calendar for the '
|
|
4289
4309
|
|
4290
4310
|
#### Defined in
|
4291
4311
|
|
4292
|
-
|
4312
|
+
packages/framework/esm-utils/dist/dates/date-util.d.ts:42
|
4293
4313
|
|
4294
4314
|
___
|
4295
4315
|
|
@@ -4312,7 +4332,7 @@ Otherwise returns null.
|
|
4312
4332
|
|
4313
4333
|
#### Defined in
|
4314
4334
|
|
4315
|
-
|
4335
|
+
packages/framework/esm-utils/dist/dates/date-util.d.ts:21
|
4316
4336
|
|
4317
4337
|
___
|
4318
4338
|
|
@@ -4324,10 +4344,10 @@ Formats the input to OpenMRS ISO format: "YYYY-MM-DDTHH:mm:ss.SSSZZ".
|
|
4324
4344
|
|
4325
4345
|
#### Parameters
|
4326
4346
|
|
4327
|
-
| Name | Type |
|
4328
|
-
| :------ | :------ |
|
4329
|
-
| `date` | [`DateInput`](API.md#dateinput) |
|
4330
|
-
| `toUTC
|
4347
|
+
| Name | Type |
|
4348
|
+
| :------ | :------ |
|
4349
|
+
| `date` | [`DateInput`](API.md#dateinput) |
|
4350
|
+
| `toUTC?` | `boolean` |
|
4331
4351
|
|
4332
4352
|
#### Returns
|
4333
4353
|
|
@@ -4335,7 +4355,7 @@ Formats the input to OpenMRS ISO format: "YYYY-MM-DDTHH:mm:ss.SSSZZ".
|
|
4335
4355
|
|
4336
4356
|
#### Defined in
|
4337
4357
|
|
4338
|
-
|
4358
|
+
packages/framework/esm-utils/dist/dates/date-util.d.ts:25
|
4339
4359
|
|
4340
4360
|
___
|
4341
4361
|
|
@@ -4377,54 +4397,6 @@ const { someComponent } = importDynamic("@openmrs/esm-template-app")
|
|
4377
4397
|
|
4378
4398
|
___
|
4379
4399
|
|
4380
|
-
## Error Handling Functions
|
4381
|
-
|
4382
|
-
### createErrorHandler
|
4383
|
-
|
4384
|
-
▸ **createErrorHandler**(): (`incomingErr`: `any`) => `void`
|
4385
|
-
|
4386
|
-
#### Returns
|
4387
|
-
|
4388
|
-
`fn`
|
4389
|
-
|
4390
|
-
▸ (`incomingErr`): `void`
|
4391
|
-
|
4392
|
-
##### Parameters
|
4393
|
-
|
4394
|
-
| Name | Type |
|
4395
|
-
| :------ | :------ |
|
4396
|
-
| `incomingErr` | `any` |
|
4397
|
-
|
4398
|
-
##### Returns
|
4399
|
-
|
4400
|
-
`void`
|
4401
|
-
|
4402
|
-
#### Defined in
|
4403
|
-
|
4404
|
-
[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)
|
4405
|
-
|
4406
|
-
___
|
4407
|
-
|
4408
|
-
### reportError
|
4409
|
-
|
4410
|
-
▸ **reportError**(`err`): `void`
|
4411
|
-
|
4412
|
-
#### Parameters
|
4413
|
-
|
4414
|
-
| Name | Type |
|
4415
|
-
| :------ | :------ |
|
4416
|
-
| `err` | `any` |
|
4417
|
-
|
4418
|
-
#### Returns
|
4419
|
-
|
4420
|
-
`void`
|
4421
|
-
|
4422
|
-
#### Defined in
|
4423
|
-
|
4424
|
-
[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)
|
4425
|
-
|
4426
|
-
___
|
4427
|
-
|
4428
4400
|
## Extension Functions
|
4429
4401
|
|
4430
4402
|
### ExtensionSlot
|
@@ -4684,7 +4656,7 @@ ___
|
|
4684
4656
|
|
4685
4657
|
### useAssignedExtensions
|
4686
4658
|
|
4687
|
-
▸ **useAssignedExtensions**(`slotName`):
|
4659
|
+
▸ **useAssignedExtensions**(`slotName`): `AssignedExtension`[]
|
4688
4660
|
|
4689
4661
|
Gets the assigned extensions for a given extension slot name.
|
4690
4662
|
|
@@ -4696,7 +4668,7 @@ Gets the assigned extensions for a given extension slot name.
|
|
4696
4668
|
|
4697
4669
|
#### Returns
|
4698
4670
|
|
4699
|
-
|
4671
|
+
`AssignedExtension`[]
|
4700
4672
|
|
4701
4673
|
#### Defined in
|
4702
4674
|
|
@@ -4706,7 +4678,7 @@ ___
|
|
4706
4678
|
|
4707
4679
|
### useConnectedExtensions
|
4708
4680
|
|
4709
|
-
▸ **useConnectedExtensions**(`slotName`):
|
4681
|
+
▸ **useConnectedExtensions**(`slotName`): `ConnectedExtension`[]
|
4710
4682
|
|
4711
4683
|
Gets the assigned extension for a given extension slot name.
|
4712
4684
|
|
@@ -4720,7 +4692,7 @@ Gets the assigned extension for a given extension slot name.
|
|
4720
4692
|
|
4721
4693
|
#### Returns
|
4722
4694
|
|
4723
|
-
|
4695
|
+
`ConnectedExtension`[]
|
4724
4696
|
|
4725
4697
|
#### Defined in
|
4726
4698
|
|
@@ -4738,7 +4710,7 @@ Extract meta data from all extension for a given extension slot.
|
|
4738
4710
|
|
4739
4711
|
| Name | Type |
|
4740
4712
|
| :------ | :------ |
|
4741
|
-
| `T` |
|
4713
|
+
| `T` | `ExtensionMeta` |
|
4742
4714
|
|
4743
4715
|
#### Parameters
|
4744
4716
|
|
@@ -4758,7 +4730,7 @@ ___
|
|
4758
4730
|
|
4759
4731
|
### useExtensionSlotStore
|
4760
4732
|
|
4761
|
-
▸ **useExtensionSlotStore**(`slot`):
|
4733
|
+
▸ **useExtensionSlotStore**(`slot`): `ExtensionSlotState`
|
4762
4734
|
|
4763
4735
|
#### Parameters
|
4764
4736
|
|
@@ -4768,7 +4740,7 @@ ___
|
|
4768
4740
|
|
4769
4741
|
#### Returns
|
4770
4742
|
|
4771
|
-
|
4743
|
+
`ExtensionSlotState`
|
4772
4744
|
|
4773
4745
|
#### Defined in
|
4774
4746
|
|
@@ -4794,7 +4766,7 @@ ___
|
|
4794
4766
|
|
4795
4767
|
| Name | Type |
|
4796
4768
|
| :------ | :------ |
|
4797
|
-
| `A` | extends [`Actions`](API.md#actions)
|
4769
|
+
| `A` | extends [`Actions`](API.md#actions)<`ExtensionStore`\> |
|
4798
4770
|
|
4799
4771
|
#### Parameters
|
4800
4772
|
|
@@ -4816,7 +4788,7 @@ ___
|
|
4816
4788
|
|
4817
4789
|
| Name | Type |
|
4818
4790
|
| :------ | :------ |
|
4819
|
-
| `A` | extends [`Actions`](API.md#actions)
|
4791
|
+
| `A` | extends [`Actions`](API.md#actions)<`ExtensionStore`\> |
|
4820
4792
|
|
4821
4793
|
#### Parameters
|
4822
4794
|
|
@@ -4967,7 +4939,7 @@ ___
|
|
4967
4939
|
|
4968
4940
|
### getAsyncExtensionLifecycle
|
4969
4941
|
|
4970
|
-
▸ **getAsyncExtensionLifecycle**<`T`\>(`lazy`, `options`): () => `Promise`<`
|
4942
|
+
▸ **getAsyncExtensionLifecycle**<`T`\>(`lazy`, `options`): () => `Promise`<`ReactAppOrParcel`<`T`\>\>
|
4971
4943
|
|
4972
4944
|
**`deprecated`** Use getAsyncLifecycle instead.
|
4973
4945
|
|
@@ -4988,11 +4960,11 @@ ___
|
|
4988
4960
|
|
4989
4961
|
`fn`
|
4990
4962
|
|
4991
|
-
▸ (): `Promise`<`
|
4963
|
+
▸ (): `Promise`<`ReactAppOrParcel`<`T`\>\>
|
4992
4964
|
|
4993
4965
|
##### Returns
|
4994
4966
|
|
4995
|
-
`Promise`<`
|
4967
|
+
`Promise`<`ReactAppOrParcel`<`T`\>\>
|
4996
4968
|
|
4997
4969
|
#### Defined in
|
4998
4970
|
|
@@ -5002,7 +4974,7 @@ ___
|
|
5002
4974
|
|
5003
4975
|
### getAsyncLifecycle
|
5004
4976
|
|
5005
|
-
▸ **getAsyncLifecycle**<`T`\>(`lazy`, `options`): () => `Promise`<`
|
4977
|
+
▸ **getAsyncLifecycle**<`T`\>(`lazy`, `options`): () => `Promise`<`ReactAppOrParcel`<`T`\>\>
|
5006
4978
|
|
5007
4979
|
#### Type parameters
|
5008
4980
|
|
@@ -5021,11 +4993,11 @@ ___
|
|
5021
4993
|
|
5022
4994
|
`fn`
|
5023
4995
|
|
5024
|
-
▸ (): `Promise`<`
|
4996
|
+
▸ (): `Promise`<`ReactAppOrParcel`<`T`\>\>
|
5025
4997
|
|
5026
4998
|
##### Returns
|
5027
4999
|
|
5028
|
-
`Promise`<`
|
5000
|
+
`Promise`<`ReactAppOrParcel`<`T`\>\>
|
5029
5001
|
|
5030
5002
|
#### Defined in
|
5031
5003
|
|
@@ -5035,7 +5007,7 @@ ___
|
|
5035
5007
|
|
5036
5008
|
### getLifecycle
|
5037
5009
|
|
5038
|
-
▸ **getLifecycle**<`T`\>(`Component`, `options`): `
|
5010
|
+
▸ **getLifecycle**<`T`\>(`Component`, `options`): `ReactAppOrParcel`<`T`\>
|
5039
5011
|
|
5040
5012
|
#### Type parameters
|
5041
5013
|
|
@@ -5052,7 +5024,7 @@ ___
|
|
5052
5024
|
|
5053
5025
|
#### Returns
|
5054
5026
|
|
5055
|
-
`
|
5027
|
+
`ReactAppOrParcel`<`T`\>
|
5056
5028
|
|
5057
5029
|
#### Defined in
|
5058
5030
|
|
@@ -5062,7 +5034,7 @@ ___
|
|
5062
5034
|
|
5063
5035
|
### getSyncLifecycle
|
5064
5036
|
|
5065
|
-
▸ **getSyncLifecycle**<`T`\>(`Component`, `options`): () => `Promise`<`
|
5037
|
+
▸ **getSyncLifecycle**<`T`\>(`Component`, `options`): () => `Promise`<`ReactAppOrParcel`<`T`\>\>
|
5066
5038
|
|
5067
5039
|
#### Type parameters
|
5068
5040
|
|
@@ -5081,11 +5053,11 @@ ___
|
|
5081
5053
|
|
5082
5054
|
`fn`
|
5083
5055
|
|
5084
|
-
▸ (): `Promise`<`
|
5056
|
+
▸ (): `Promise`<`ReactAppOrParcel`<`T`\>\>
|
5085
5057
|
|
5086
5058
|
##### Returns
|
5087
5059
|
|
5088
|
-
`Promise`<`
|
5060
|
+
`Promise`<`ReactAppOrParcel`<`T`\>\>
|
5089
5061
|
|
5090
5062
|
#### Defined in
|
5091
5063
|
|
@@ -5113,7 +5085,7 @@ A React link component which calls [navigate](API.md#navigate) when clicked
|
|
5113
5085
|
|
5114
5086
|
#### Defined in
|
5115
5087
|
|
5116
|
-
[packages/framework/esm-react-utils/src/ConfigurableLink.tsx:
|
5088
|
+
[packages/framework/esm-react-utils/src/ConfigurableLink.tsx:52](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/ConfigurableLink.tsx#L52)
|
5117
5089
|
|
5118
5090
|
___
|
5119
5091
|
|
@@ -5360,7 +5332,7 @@ Generates a UUID-like string which is used for uniquely identifying objects whil
|
|
5360
5332
|
|
5361
5333
|
#### Defined in
|
5362
5334
|
|
5363
|
-
[packages/framework/esm-offline/src/uuid.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/uuid.ts#L7)
|
5335
|
+
[packages/framework/esm-offline/src/uuid-support.ts:7](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/uuid-support.ts#L7)
|
5364
5336
|
|
5365
5337
|
___
|
5366
5338
|
|
@@ -5600,7 +5572,7 @@ Checks whether the given string has the format of an offline UUID generated by [
|
|
5600
5572
|
|
5601
5573
|
#### Defined in
|
5602
5574
|
|
5603
|
-
[packages/framework/esm-offline/src/uuid.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/uuid.ts#L12)
|
5575
|
+
[packages/framework/esm-offline/src/uuid-support.ts:12](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-offline/src/uuid-support.ts#L12)
|
5604
5576
|
|
5605
5577
|
___
|
5606
5578
|
|
@@ -5632,7 +5604,7 @@ ___
|
|
5632
5604
|
|
5633
5605
|
▸ **putDynamicOfflineData**(`type`, `identifier`): `Promise`<`void`\>
|
5634
5606
|
|
5635
|
-
Declares that dynamic offline data of the given [type](interfaces/FetchResponse.md#type) with the given [identifier](interfaces/
|
5607
|
+
Declares that dynamic offline data of the given [type](interfaces/FetchResponse.md#type) with the given [identifier](interfaces/Session.md#identifier)
|
5636
5608
|
should be made available offline for the currently logged in user.
|
5637
5609
|
|
5638
5610
|
#### Parameters
|
@@ -5656,7 +5628,7 @@ ___
|
|
5656
5628
|
|
5657
5629
|
▸ **putDynamicOfflineDataFor**(`userId`, `type`, `identifier`): `Promise`<`void`\>
|
5658
5630
|
|
5659
|
-
Declares that dynamic offline data of the given [type](interfaces/FetchResponse.md#type) with the given [identifier](interfaces/
|
5631
|
+
Declares that dynamic offline data of the given [type](interfaces/FetchResponse.md#type) with the given [identifier](interfaces/Session.md#identifier)
|
5660
5632
|
should be made available offline for the user with the given ID.
|
5661
5633
|
|
5662
5634
|
#### Parameters
|
@@ -5734,7 +5706,7 @@ ___
|
|
5734
5706
|
|
5735
5707
|
▸ **removeDynamicOfflineData**(`type`, `identifier`): `Promise`<`void`\>
|
5736
5708
|
|
5737
|
-
Declares that dynamic offline data of the given [type](interfaces/FetchResponse.md#type) with the given [identifier](interfaces/
|
5709
|
+
Declares that dynamic offline data of the given [type](interfaces/FetchResponse.md#type) with the given [identifier](interfaces/Session.md#identifier)
|
5738
5710
|
no longer needs to be available offline for the currently logged in user.
|
5739
5711
|
|
5740
5712
|
#### Parameters
|
@@ -5758,7 +5730,7 @@ ___
|
|
5758
5730
|
|
5759
5731
|
▸ **removeDynamicOfflineDataFor**(`userId`, `type`, `identifier`): `Promise`<`void`\>
|
5760
5732
|
|
5761
|
-
Declares that dynamic offline data of the given [type](interfaces/FetchResponse.md#type) with the given [identifier](interfaces/
|
5733
|
+
Declares that dynamic offline data of the given [type](interfaces/FetchResponse.md#type) with the given [identifier](interfaces/Session.md#identifier)
|
5762
5734
|
no longer needs to be available offline for the user with the given ID.
|
5763
5735
|
|
5764
5736
|
#### Parameters
|
@@ -5849,13 +5821,15 @@ ___
|
|
5849
5821
|
|
5850
5822
|
▸ (): `void`
|
5851
5823
|
|
5824
|
+
**`category`** Offline
|
5825
|
+
|
5852
5826
|
##### Returns
|
5853
5827
|
|
5854
5828
|
`void`
|
5855
5829
|
|
5856
5830
|
#### Defined in
|
5857
5831
|
|
5858
|
-
|
5832
|
+
packages/framework/esm-globals/dist/events.d.ts:9
|
5859
5833
|
|
5860
5834
|
___
|
5861
5835
|
|
@@ -5875,13 +5849,15 @@ ___
|
|
5875
5849
|
|
5876
5850
|
▸ (): `void`
|
5877
5851
|
|
5852
|
+
**`category`** Offline
|
5853
|
+
|
5878
5854
|
##### Returns
|
5879
5855
|
|
5880
5856
|
`void`
|
5881
5857
|
|
5882
5858
|
#### Defined in
|
5883
5859
|
|
5884
|
-
|
5860
|
+
packages/framework/esm-globals/dist/events.d.ts:7
|
5885
5861
|
|
5886
5862
|
___
|
5887
5863
|
|
@@ -5901,13 +5877,15 @@ ___
|
|
5901
5877
|
|
5902
5878
|
▸ (): `void`
|
5903
5879
|
|
5880
|
+
**`category`** Offline
|
5881
|
+
|
5904
5882
|
##### Returns
|
5905
5883
|
|
5906
5884
|
`void`
|
5907
5885
|
|
5908
5886
|
#### Defined in
|
5909
5887
|
|
5910
|
-
|
5888
|
+
packages/framework/esm-globals/dist/events.d.ts:14
|
5911
5889
|
|
5912
5890
|
___
|
5913
5891
|
|
@@ -6054,6 +6032,34 @@ This component also provides everything needed for workspace notifications to be
|
|
6054
6032
|
|
6055
6033
|
___
|
6056
6034
|
|
6035
|
+
### age
|
6036
|
+
|
6037
|
+
▸ **age**(`birthDate`, `currentDate?`): `string` \| ``null``
|
6038
|
+
|
6039
|
+
Gets a human readable and locale supported representation of a person's age, given their birthDate,
|
6040
|
+
The representation logic follows the guideline here:
|
6041
|
+
https://webarchive.nationalarchives.gov.uk/ukgwa/20160921162509mp_/http://systems.digital.nhs.uk/data/cui/uig/patben.pdf
|
6042
|
+
(See Tables 7 and 8)
|
6043
|
+
|
6044
|
+
#### Parameters
|
6045
|
+
|
6046
|
+
| Name | Type | Description |
|
6047
|
+
| :------ | :------ | :------ |
|
6048
|
+
| `birthDate` | `undefined` \| ``null`` \| `string` \| `number` \| `Date` \| `Dayjs` | The birthDate. If birthDate is null, returns null. |
|
6049
|
+
| `currentDate?` | ``null`` \| `string` \| `number` \| `Date` \| `Dayjs` | Optional. If provided, calculates the age of the person at the provided currentDate (instead of now). |
|
6050
|
+
|
6051
|
+
#### Returns
|
6052
|
+
|
6053
|
+
`string` \| ``null``
|
6054
|
+
|
6055
|
+
A human-readable string version of the age.
|
6056
|
+
|
6057
|
+
#### Defined in
|
6058
|
+
|
6059
|
+
packages/framework/esm-utils/dist/age-helpers.d.ts:12
|
6060
|
+
|
6061
|
+
___
|
6062
|
+
|
6057
6063
|
### compile
|
6058
6064
|
|
6059
6065
|
▸ **compile**(`expression`): `jsep.Expression`
|
@@ -6085,6 +6091,72 @@ An executable AST representation of the expression
|
|
6085
6091
|
|
6086
6092
|
___
|
6087
6093
|
|
6094
|
+
### createErrorHandler
|
6095
|
+
|
6096
|
+
▸ **createErrorHandler**(): (`incomingErr`: `unknown`) => `void`
|
6097
|
+
|
6098
|
+
#### Returns
|
6099
|
+
|
6100
|
+
`fn`
|
6101
|
+
|
6102
|
+
▸ (`incomingErr`): `void`
|
6103
|
+
|
6104
|
+
##### Parameters
|
6105
|
+
|
6106
|
+
| Name | Type |
|
6107
|
+
| :------ | :------ |
|
6108
|
+
| `incomingErr` | `unknown` |
|
6109
|
+
|
6110
|
+
##### Returns
|
6111
|
+
|
6112
|
+
`void`
|
6113
|
+
|
6114
|
+
#### Defined in
|
6115
|
+
|
6116
|
+
packages/framework/esm-error-handling/dist/index.d.ts:2
|
6117
|
+
|
6118
|
+
___
|
6119
|
+
|
6120
|
+
### dispatchNotificationShown
|
6121
|
+
|
6122
|
+
▸ **dispatchNotificationShown**(`data`): `void`
|
6123
|
+
|
6124
|
+
#### Parameters
|
6125
|
+
|
6126
|
+
| Name | Type |
|
6127
|
+
| :------ | :------ |
|
6128
|
+
| `data` | [`ShowNotificationEvent`](interfaces/ShowNotificationEvent.md) |
|
6129
|
+
|
6130
|
+
#### Returns
|
6131
|
+
|
6132
|
+
`void`
|
6133
|
+
|
6134
|
+
#### Defined in
|
6135
|
+
|
6136
|
+
packages/framework/esm-globals/dist/events.d.ts:50
|
6137
|
+
|
6138
|
+
___
|
6139
|
+
|
6140
|
+
### dispatchPrecacheStaticDependencies
|
6141
|
+
|
6142
|
+
▸ **dispatchPrecacheStaticDependencies**(`data?`): `void`
|
6143
|
+
|
6144
|
+
#### Parameters
|
6145
|
+
|
6146
|
+
| Name | Type |
|
6147
|
+
| :------ | :------ |
|
6148
|
+
| `data?` | [`PrecacheStaticDependenciesEvent`](interfaces/PrecacheStaticDependenciesEvent.md) |
|
6149
|
+
|
6150
|
+
#### Returns
|
6151
|
+
|
6152
|
+
`void`
|
6153
|
+
|
6154
|
+
#### Defined in
|
6155
|
+
|
6156
|
+
packages/framework/esm-globals/dist/events.d.ts:12
|
6157
|
+
|
6158
|
+
___
|
6159
|
+
|
6088
6160
|
### evaluate
|
6089
6161
|
|
6090
6162
|
▸ **evaluate**(`expression`, `variables?`): [`DefaultEvaluateReturnType`](API.md#defaultevaluatereturntype)
|
@@ -6491,7 +6563,21 @@ string
|
|
6491
6563
|
|
6492
6564
|
#### Defined in
|
6493
6565
|
|
6494
|
-
|
6566
|
+
packages/framework/esm-utils/dist/get-locale.d.ts:5
|
6567
|
+
|
6568
|
+
___
|
6569
|
+
|
6570
|
+
### isDevEnabled
|
6571
|
+
|
6572
|
+
▸ **isDevEnabled**(): `boolean`
|
6573
|
+
|
6574
|
+
#### Returns
|
6575
|
+
|
6576
|
+
`boolean`
|
6577
|
+
|
6578
|
+
#### Defined in
|
6579
|
+
|
6580
|
+
[packages/framework/esm-api/src/environment.ts:3](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-api/src/environment.ts#L3)
|
6495
6581
|
|
6496
6582
|
___
|
6497
6583
|
|
@@ -6511,7 +6597,48 @@ ___
|
|
6511
6597
|
|
6512
6598
|
#### Defined in
|
6513
6599
|
|
6514
|
-
|
6600
|
+
packages/framework/esm-utils/dist/is-online.d.ts:1
|
6601
|
+
|
6602
|
+
___
|
6603
|
+
|
6604
|
+
### isVersionSatisfied
|
6605
|
+
|
6606
|
+
▸ **isVersionSatisfied**(`requiredVersion`, `installedVersion`): `boolean`
|
6607
|
+
|
6608
|
+
#### Parameters
|
6609
|
+
|
6610
|
+
| Name | Type |
|
6611
|
+
| :------ | :------ |
|
6612
|
+
| `requiredVersion` | `string` |
|
6613
|
+
| `installedVersion` | `string` |
|
6614
|
+
|
6615
|
+
#### Returns
|
6616
|
+
|
6617
|
+
`boolean`
|
6618
|
+
|
6619
|
+
#### Defined in
|
6620
|
+
|
6621
|
+
packages/framework/esm-utils/dist/version.d.ts:1
|
6622
|
+
|
6623
|
+
___
|
6624
|
+
|
6625
|
+
### reportError
|
6626
|
+
|
6627
|
+
▸ **reportError**(`err`): `void`
|
6628
|
+
|
6629
|
+
#### Parameters
|
6630
|
+
|
6631
|
+
| Name | Type |
|
6632
|
+
| :------ | :------ |
|
6633
|
+
| `err` | `unknown` |
|
6634
|
+
|
6635
|
+
#### Returns
|
6636
|
+
|
6637
|
+
`void`
|
6638
|
+
|
6639
|
+
#### Defined in
|
6640
|
+
|
6641
|
+
packages/framework/esm-error-handling/dist/index.d.ts:1
|
6515
6642
|
|
6516
6643
|
___
|
6517
6644
|
|
@@ -6597,7 +6724,7 @@ ___
|
|
6597
6724
|
|
6598
6725
|
### useVisitContextStore
|
6599
6726
|
|
6600
|
-
▸ **useVisitContextStore**(`mutateVisitCallback?`):
|
6727
|
+
▸ **useVisitContextStore**(`mutateVisitCallback?`): `VisitStoreState` & `BindFunctionsIn`<{ `mutateVisit`: (`currState`: `VisitStoreState`) => {} ; `setVisitContext`: (`_`: `VisitStoreState`, `newSelectedVisit`: ``null`` \| `Visit`) => { `manuallySetVisitUuid`: ``null`` \| `string` ; `patientUuid`: ``null`` \| `string` } }\>
|
6601
6728
|
|
6602
6729
|
A hook to return the visit context store and corresponding actions.
|
6603
6730
|
|
@@ -6609,7 +6736,7 @@ A hook to return the visit context store and corresponding actions.
|
|
6609
6736
|
|
6610
6737
|
#### Returns
|
6611
6738
|
|
6612
|
-
|
6739
|
+
`VisitStoreState` & `BindFunctionsIn`<{ `mutateVisit`: (`currState`: `VisitStoreState`) => {} ; `setVisitContext`: (`_`: `VisitStoreState`, `newSelectedVisit`: ``null`` \| `Visit`) => { `manuallySetVisitUuid`: ``null`` \| `string` ; `patientUuid`: ``null`` \| `string` } }\>
|
6613
6740
|
|
6614
6741
|
#### Defined in
|
6615
6742
|
|
@@ -6969,9 +7096,9 @@ invalid key to this function will result in a type error.
|
|
6969
7096
|
|
6970
7097
|
| Name | Type | Description |
|
6971
7098
|
| :------ | :------ | :------ |
|
6972
|
-
| `key` | ``"error"`` \| ``"
|
7099
|
+
| `key` | ``"error"`` \| ``"actions"`` \| ``"address"`` \| ``"age"`` \| ``"cancel"`` \| ``"change"`` \| ``"Clinic"`` \| ``"close"`` \| ``"confirm"`` \| ``"contactAdministratorIfIssuePersists"`` \| ``"contactDetails"`` \| ``"delete"`` \| ``"edit"`` \| ``"errorCopy"`` \| ``"female"`` \| ``"loading"`` \| ``"male"`` \| ``"other"`` \| ``"patientIdentifierSticker"`` \| ``"patientLists"`` \| ``"print"`` \| ``"printError"`` \| ``"printErrorExplainer"`` \| ``"printIdentifierSticker"`` \| ``"printing"`` \| ``"relationships"`` \| ``"resetOverrides"`` \| ``"save"`` \| ``"scriptLoadingFailed"`` \| ``"scriptLoadingError"`` \| ``"seeMoreLists"`` \| ``"sex"`` \| ``"showLess"`` \| ``"showMore"`` \| ``"toggleDevTools"`` \| ``"unknown"`` \| ``"closeAllOpenedWorkspaces"`` \| ``"closingAllWorkspacesPromptBody"`` \| ``"closingAllWorkspacesPromptTitle"`` \| ``"discard"`` \| ``"hide"`` \| ``"maximize"`` \| ``"minimize"`` \| ``"openAnyway"`` \| ``"unsavedChangesInOpenedWorkspace"`` \| ``"unsavedChangesInWorkspace"`` \| ``"unsavedChangesTitleText"`` \| ``"workspaceHeader"`` \| ``"address1"`` \| ``"address2"`` \| ``"address3"`` \| ``"address4"`` \| ``"address5"`` \| ``"address6"`` \| ``"city"`` \| ``"cityVillage"`` \| ``"country"`` \| ``"countyDistrict"`` \| ``"district"`` \| ``"postalCode"`` \| ``"state"`` \| ``"stateProvince"`` | - |
|
6973
7100
|
| `defaultText?` | `string` | - |
|
6974
|
-
| `options?` | `Omit`<`TOptions`<`StringMap`\>, ``"
|
7101
|
+
| `options?` | `Omit`<`TOptions`<`StringMap`\>, ``"ns"`` \| ``"defaultValue"``\> | Object passed to the i18next `t` function. See https://www.i18next.com/translation-function/essentials#overview-options for more information. `ns` and `defaultValue` are already set and may not be used. |
|
6975
7102
|
|
6976
7103
|
#### Returns
|
6977
7104
|
|
@@ -7009,7 +7136,7 @@ load the module's translations if they have not already been loaded via `useTran
|
|
7009
7136
|
| `moduleName` | `string` | The module to get the translation from, e.g. '@openmrs/esm-login-app' |
|
7010
7137
|
| `key` | `string` | The i18next translation key |
|
7011
7138
|
| `fallback?` | `string` | Fallback text for if the lookup fails |
|
7012
|
-
| `options?` | `Omit`<`TOptions`<`StringMap`\>, ``"
|
7139
|
+
| `options?` | `Omit`<`TOptions`<`StringMap`\>, ``"ns"`` \| ``"defaultValue"``\> | Options object passed to the i18next `t` function. See https://www.i18next.com/translation-function/essentials#overview-options for more information. `ns` and `defaultValue` are already set and may not be used. |
|
7013
7140
|
|
7014
7141
|
#### Returns
|
7015
7142
|
|
@@ -7163,7 +7290,7 @@ A component which displays the patient photo https://zeroheight.com/23a080e38/p/
|
|
7163
7290
|
|
7164
7291
|
#### Defined in
|
7165
7292
|
|
7166
|
-
[packages/framework/esm-styleguide/src/patient-photo/patient-photo.component.tsx:
|
7293
|
+
[packages/framework/esm-styleguide/src/patient-photo/patient-photo.component.tsx:19](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/patient-photo/patient-photo.component.tsx#L19)
|
7167
7294
|
|
7168
7295
|
___
|
7169
7296
|
|
@@ -7282,7 +7409,7 @@ The dispose function to force closing the modal dialog.
|
|
7282
7409
|
|
7283
7410
|
#### Defined in
|
7284
7411
|
|
7285
|
-
[packages/framework/esm-styleguide/src/modals/index.tsx:
|
7412
|
+
[packages/framework/esm-styleguide/src/modals/index.tsx:200](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/modals/index.tsx#L200)
|
7286
7413
|
|
7287
7414
|
___
|
7288
7415
|
|
@@ -7368,13 +7495,15 @@ ___
|
|
7368
7495
|
|
7369
7496
|
▸ (): `void`
|
7370
7497
|
|
7498
|
+
**`category`** UI
|
7499
|
+
|
7371
7500
|
##### Returns
|
7372
7501
|
|
7373
7502
|
`void`
|
7374
7503
|
|
7375
7504
|
#### Defined in
|
7376
7505
|
|
7377
|
-
|
7506
|
+
packages/framework/esm-globals/dist/events.d.ts:60
|
7378
7507
|
|
7379
7508
|
___
|
7380
7509
|
|
@@ -7394,13 +7523,15 @@ ___
|
|
7394
7523
|
|
7395
7524
|
▸ (): `void`
|
7396
7525
|
|
7526
|
+
**`category`** UI
|
7527
|
+
|
7397
7528
|
##### Returns
|
7398
7529
|
|
7399
7530
|
`void`
|
7400
7531
|
|
7401
7532
|
#### Defined in
|
7402
7533
|
|
7403
|
-
|
7534
|
+
packages/framework/esm-globals/dist/events.d.ts:58
|
7404
7535
|
|
7405
7536
|
___
|
7406
7537
|
|
@@ -7420,13 +7551,15 @@ ___
|
|
7420
7551
|
|
7421
7552
|
▸ (): `void`
|
7422
7553
|
|
7554
|
+
**`category`** UI
|
7555
|
+
|
7423
7556
|
##### Returns
|
7424
7557
|
|
7425
7558
|
`void`
|
7426
7559
|
|
7427
7560
|
#### Defined in
|
7428
7561
|
|
7429
|
-
|
7562
|
+
packages/framework/esm-globals/dist/events.d.ts:64
|
7430
7563
|
|
7431
7564
|
___
|
7432
7565
|
|
@@ -7446,13 +7579,15 @@ ___
|
|
7446
7579
|
|
7447
7580
|
▸ (): `void`
|
7448
7581
|
|
7582
|
+
**`category`** UI
|
7583
|
+
|
7449
7584
|
##### Returns
|
7450
7585
|
|
7451
7586
|
`void`
|
7452
7587
|
|
7453
7588
|
#### Defined in
|
7454
7589
|
|
7455
|
-
|
7590
|
+
packages/framework/esm-globals/dist/events.d.ts:62
|
7456
7591
|
|
7457
7592
|
___
|
7458
7593
|
|
@@ -7464,7 +7599,7 @@ ___
|
|
7464
7599
|
|
7465
7600
|
| Name | Type |
|
7466
7601
|
| :------ | :------ |
|
7467
|
-
| `name` | `
|
7602
|
+
| `name` | `string` |
|
7468
7603
|
|
7469
7604
|
#### Returns
|
7470
7605
|
|
@@ -7543,7 +7678,7 @@ This function is the FHIR counterpart of `useOpenmrsPagination`.
|
|
7543
7678
|
| `goToPrevious` | () => `void` | - |
|
7544
7679
|
| `isLoading` | `boolean` | - |
|
7545
7680
|
| `isValidating` | `boolean` | - |
|
7546
|
-
| `mutate` | `KeyedMutator
|
7681
|
+
| `mutate` | `KeyedMutator`<`FetchResponse`<`Bundle`\>\> | - |
|
7547
7682
|
| `paginated` | `boolean` | |
|
7548
7683
|
| `showNextButton` | `boolean` | |
|
7549
7684
|
| `showPreviousButton` | `boolean` | |
|
@@ -7719,7 +7854,7 @@ a UseServerInfiniteReturnObject object
|
|
7719
7854
|
|
7720
7855
|
#### Defined in
|
7721
7856
|
|
7722
|
-
[packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts:
|
7857
|
+
[packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts:102](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-react-utils/src/useOpenmrsInfinite.ts#L102)
|
7723
7858
|
|
7724
7859
|
___
|
7725
7860
|
|
@@ -7778,7 +7913,7 @@ of the data set. In that case, all data must be loaded onto client-side first.
|
|
7778
7913
|
| `goToPrevious` | () => `void` | - |
|
7779
7914
|
| `isLoading` | `boolean` | - |
|
7780
7915
|
| `isValidating` | `boolean` | - |
|
7781
|
-
| `mutate` | `KeyedMutator
|
7916
|
+
| `mutate` | `KeyedMutator`<`FetchResponse`<`OpenMRSPaginatedResponse`<`T`\>\>\> | - |
|
7782
7917
|
| `paginated` | `boolean` | |
|
7783
7918
|
| `showNextButton` | `boolean` | |
|
7784
7919
|
| `showPreviousButton` | `boolean` | |
|
@@ -7859,34 +7994,6 @@ ___
|
|
7859
7994
|
|
7860
7995
|
## Utility Functions
|
7861
7996
|
|
7862
|
-
### age
|
7863
|
-
|
7864
|
-
▸ **age**(`birthDate`, `currentDate?`): `string` \| ``null``
|
7865
|
-
|
7866
|
-
Gets a human readable and locale supported representation of a person's age, given their birthDate,
|
7867
|
-
The representation logic follows the guideline here:
|
7868
|
-
https://webarchive.nationalarchives.gov.uk/ukgwa/20160921162509mp_/http://systems.digital.nhs.uk/data/cui/uig/patben.pdf
|
7869
|
-
(See Tables 7 and 8)
|
7870
|
-
|
7871
|
-
#### Parameters
|
7872
|
-
|
7873
|
-
| Name | Type | Description |
|
7874
|
-
| :------ | :------ | :------ |
|
7875
|
-
| `birthDate` | `ConfigType` | The birthDate. If birthDate is null, returns null. |
|
7876
|
-
| `currentDate` | `ConfigType` | Optional. If provided, calculates the age of the person at the provided currentDate (instead of now). |
|
7877
|
-
|
7878
|
-
#### Returns
|
7879
|
-
|
7880
|
-
`string` \| ``null``
|
7881
|
-
|
7882
|
-
A human-readable string version of the age.
|
7883
|
-
|
7884
|
-
#### Defined in
|
7885
|
-
|
7886
|
-
[packages/framework/esm-utils/src/age-helpers.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/age-helpers.ts#L22)
|
7887
|
-
|
7888
|
-
___
|
7889
|
-
|
7890
7997
|
### canAccessStorage
|
7891
7998
|
|
7892
7999
|
▸ **canAccessStorage**(`storage?`): `boolean`
|
@@ -7897,9 +8004,9 @@ is actually available. Useful for testing the availability of `localStorage` or
|
|
7897
8004
|
|
7898
8005
|
#### Parameters
|
7899
8006
|
|
7900
|
-
| Name | Type |
|
7901
|
-
| :------ | :------ | :------ |
|
7902
|
-
| `storage
|
8007
|
+
| Name | Type | Description |
|
8008
|
+
| :------ | :------ | :------ |
|
8009
|
+
| `storage?` | `Storage` | The WebStorage API object to check. Defaults to `localStorage`. |
|
7903
8010
|
|
7904
8011
|
#### Returns
|
7905
8012
|
|
@@ -7909,7 +8016,7 @@ True if the WebStorage API object is able to be accessed, false otherwise
|
|
7909
8016
|
|
7910
8017
|
#### Defined in
|
7911
8018
|
|
7912
|
-
|
8019
|
+
packages/framework/esm-utils/dist/storage.d.ts:10
|
7913
8020
|
|
7914
8021
|
___
|
7915
8022
|
|
@@ -7931,7 +8038,7 @@ ___
|
|
7931
8038
|
|
7932
8039
|
#### Defined in
|
7933
8040
|
|
7934
|
-
|
8041
|
+
packages/framework/esm-utils/dist/patient-helpers.d.ts:15
|
7935
8042
|
|
7936
8043
|
___
|
7937
8044
|
|
@@ -7955,7 +8062,7 @@ The formatted display name or an empty string if name is undefined.
|
|
7955
8062
|
|
7956
8063
|
#### Defined in
|
7957
8064
|
|
7958
|
-
|
8065
|
+
packages/framework/esm-utils/dist/patient-helpers.d.ts:21
|
7959
8066
|
|
7960
8067
|
___
|
7961
8068
|
|
@@ -7977,7 +8084,7 @@ ___
|
|
7977
8084
|
|
7978
8085
|
#### Defined in
|
7979
8086
|
|
7980
|
-
|
8087
|
+
packages/framework/esm-utils/dist/patient-helpers.d.ts:23
|
7981
8088
|
|
7982
8089
|
___
|
7983
8090
|
|
@@ -8004,7 +8111,7 @@ need to override some of the default values.
|
|
8004
8111
|
|
8005
8112
|
| Name | Type |
|
8006
8113
|
| :------ | :------ |
|
8007
|
-
| `schema` | `
|
8114
|
+
| `schema` | `Record`<`string` \| `number` \| `symbol`, `unknown`\> |
|
8008
8115
|
|
8009
8116
|
#### Returns
|
8010
8117
|
|
@@ -8012,7 +8119,7 @@ need to override some of the default values.
|
|
8012
8119
|
|
8013
8120
|
#### Defined in
|
8014
8121
|
|
8015
|
-
|
8122
|
+
packages/framework/esm-utils/dist/test-helpers.d.ts:12
|
8016
8123
|
|
8017
8124
|
___
|
8018
8125
|
|
@@ -8039,28 +8146,7 @@ The patient's display name or an empty string if name is not present.
|
|
8039
8146
|
|
8040
8147
|
#### Defined in
|
8041
8148
|
|
8042
|
-
|
8043
|
-
|
8044
|
-
___
|
8045
|
-
|
8046
|
-
### isVersionSatisfied
|
8047
|
-
|
8048
|
-
▸ **isVersionSatisfied**(`requiredVersion`, `installedVersion`): `boolean`
|
8049
|
-
|
8050
|
-
#### Parameters
|
8051
|
-
|
8052
|
-
| Name | Type |
|
8053
|
-
| :------ | :------ |
|
8054
|
-
| `requiredVersion` | `string` |
|
8055
|
-
| `installedVersion` | `string` |
|
8056
|
-
|
8057
|
-
#### Returns
|
8058
|
-
|
8059
|
-
`boolean`
|
8060
|
-
|
8061
|
-
#### Defined in
|
8062
|
-
|
8063
|
-
[packages/framework/esm-utils/src/version.ts:22](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-utils/src/version.ts#L22)
|
8149
|
+
packages/framework/esm-utils/dist/patient-helpers.d.ts:13
|
8064
8150
|
|
8065
8151
|
___
|
8066
8152
|
|
@@ -8088,7 +8174,7 @@ If not configured otherwise, this function uses the following default options:
|
|
8088
8174
|
| Name | Type | Description |
|
8089
8175
|
| :------ | :------ | :------ |
|
8090
8176
|
| `fn` | () => `Promise`<`T`\> | The function to be executed and retried on failure. |
|
8091
|
-
| `options
|
8177
|
+
| `options?` | [`RetryOptions`](interfaces/RetryOptions.md) | Additional options which configure the retry behavior. |
|
8092
8178
|
|
8093
8179
|
#### Returns
|
8094
8180
|
|
@@ -8098,7 +8184,7 @@ The result of successfully executing `fn`.
|
|
8098
8184
|
|
8099
8185
|
#### Defined in
|
8100
8186
|
|
8101
|
-
|
8187
|
+
packages/framework/esm-utils/dist/retry.d.ts:38
|
8102
8188
|
|
8103
8189
|
___
|
8104
8190
|
|
@@ -8136,7 +8222,7 @@ the preferred name for the patient, or undefined if no acceptable name could be
|
|
8136
8222
|
|
8137
8223
|
#### Defined in
|
8138
8224
|
|
8139
|
-
|
8225
|
+
packages/framework/esm-utils/dist/patient-helpers.d.ts:42
|
8140
8226
|
|
8141
8227
|
___
|
8142
8228
|
|
@@ -8164,7 +8250,7 @@ true if the objects are shallowly equal to each other
|
|
8164
8250
|
|
8165
8251
|
#### Defined in
|
8166
8252
|
|
8167
|
-
|
8253
|
+
packages/framework/esm-utils/dist/shallowEqual.d.ts:12
|
8168
8254
|
|
8169
8255
|
___
|
8170
8256
|
|
@@ -8256,7 +8342,7 @@ ___
|
|
8256
8342
|
|
8257
8343
|
### useOpenmrsSWR
|
8258
8344
|
|
8259
|
-
▸ **useOpenmrsSWR**<`DataType`, `ErrorType`\>(`key`, `options?`): `SWRResponse
|
8345
|
+
▸ **useOpenmrsSWR**<`DataType`, `ErrorType`\>(`key`, `options?`): `SWRResponse`<`FetchResponse`<`DataType`\>, `ErrorType`, `undefined` \| `SWRConfiguration`<`FetchResponse`<`DataType`\>, `ErrorType`, `BareFetcher`<`FetchResponse`<`DataType`\>\>\>\>
|
8260
8346
|
|
8261
8347
|
**`beta`**
|
8262
8348
|
|
@@ -8309,7 +8395,7 @@ function MyComponent() {
|
|
8309
8395
|
|
8310
8396
|
#### Returns
|
8311
8397
|
|
8312
|
-
`SWRResponse
|
8398
|
+
`SWRResponse`<`FetchResponse`<`DataType`\>, `ErrorType`, `undefined` \| `SWRConfiguration`<`FetchResponse`<`DataType`\>, `ErrorType`, `BareFetcher`<`FetchResponse`<`DataType`\>\>\>\>
|
8313
8399
|
|
8314
8400
|
#### Defined in
|
8315
8401
|
|
@@ -8338,7 +8424,7 @@ Function to close an opened workspace
|
|
8338
8424
|
|
8339
8425
|
#### Defined in
|
8340
8426
|
|
8341
|
-
[packages/framework/esm-styleguide/src/workspaces/workspaces.ts:
|
8427
|
+
[packages/framework/esm-styleguide/src/workspaces/workspaces.ts:432](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L432)
|
8342
8428
|
|
8343
8429
|
___
|
8344
8430
|
|
@@ -8389,7 +8475,7 @@ prop named `workspaceTitle` will override the title of the workspace.
|
|
8389
8475
|
|
8390
8476
|
#### Defined in
|
8391
8477
|
|
8392
|
-
[packages/framework/esm-styleguide/src/workspaces/workspaces.ts:
|
8478
|
+
[packages/framework/esm-styleguide/src/workspaces/workspaces.ts:296](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L296)
|
8393
8479
|
|
8394
8480
|
___
|
8395
8481
|
|
@@ -8420,7 +8506,7 @@ launchWorkspaceGroup("myGroup", {
|
|
8420
8506
|
|
8421
8507
|
#### Defined in
|
8422
8508
|
|
8423
|
-
[packages/framework/esm-styleguide/src/workspaces/workspaces.ts:
|
8509
|
+
[packages/framework/esm-styleguide/src/workspaces/workspaces.ts:210](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L210)
|
8424
8510
|
|
8425
8511
|
___
|
8426
8512
|
|
@@ -8446,7 +8532,7 @@ Use this function to navigate to a new page and launch a workspace on that page.
|
|
8446
8532
|
|
8447
8533
|
#### Defined in
|
8448
8534
|
|
8449
|
-
[packages/framework/esm-styleguide/src/workspaces/workspaces.ts:
|
8535
|
+
[packages/framework/esm-styleguide/src/workspaces/workspaces.ts:389](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L389)
|
8450
8536
|
|
8451
8537
|
___
|
8452
8538
|
|
@@ -8460,4 +8546,4 @@ ___
|
|
8460
8546
|
|
8461
8547
|
#### Defined in
|
8462
8548
|
|
8463
|
-
[packages/framework/esm-styleguide/src/workspaces/workspaces.ts:
|
8549
|
+
[packages/framework/esm-styleguide/src/workspaces/workspaces.ts:543](https://github.com/openmrs/openmrs-esm-core/blob/main/packages/framework/esm-styleguide/src/workspaces/workspaces.ts#L543)
|