@openmrs/esm-framework 6.3.1-pre.2965 → 6.3.1-pre.2997
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 +356 -280
- 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
|
|
@@ -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
|
|
@@ -2388,7 +2398,7 @@ is deprecated; it simply renders nothing.
|
|
2388
2398
|
|
2389
2399
|
#### Defined in
|
2390
2400
|
|
2391
|
-
[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)
|
2392
2402
|
|
2393
2403
|
___
|
2394
2404
|
|
@@ -2484,13 +2494,13 @@ ___
|
|
2484
2494
|
|
2485
2495
|
#### Defined in
|
2486
2496
|
|
2487
|
-
[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)
|
2488
2498
|
|
2489
2499
|
___
|
2490
2500
|
|
2491
2501
|
### createAttachment
|
2492
2502
|
|
2493
|
-
▸ **createAttachment**(`patientUuid`, `fileToUpload`): `Promise
|
2503
|
+
▸ **createAttachment**(`patientUuid`, `fileToUpload`): `Promise`<`FetchResponse`<`any`\>\>
|
2494
2504
|
|
2495
2505
|
#### Parameters
|
2496
2506
|
|
@@ -2501,17 +2511,17 @@ ___
|
|
2501
2511
|
|
2502
2512
|
#### Returns
|
2503
2513
|
|
2504
|
-
`Promise
|
2514
|
+
`Promise`<`FetchResponse`<`any`\>\>
|
2505
2515
|
|
2506
2516
|
#### Defined in
|
2507
2517
|
|
2508
|
-
[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)
|
2509
2519
|
|
2510
2520
|
___
|
2511
2521
|
|
2512
2522
|
### deleteAttachmentPermanently
|
2513
2523
|
|
2514
|
-
▸ **deleteAttachmentPermanently**(`attachmentUuid`, `abortController`): `Promise
|
2524
|
+
▸ **deleteAttachmentPermanently**(`attachmentUuid`, `abortController`): `Promise`<`FetchResponse`<`any`\>\>
|
2515
2525
|
|
2516
2526
|
#### Parameters
|
2517
2527
|
|
@@ -2522,11 +2532,11 @@ ___
|
|
2522
2532
|
|
2523
2533
|
#### Returns
|
2524
2534
|
|
2525
|
-
`Promise
|
2535
|
+
`Promise`<`FetchResponse`<`any`\>\>
|
2526
2536
|
|
2527
2537
|
#### Defined in
|
2528
2538
|
|
2529
|
-
[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)
|
2530
2540
|
|
2531
2541
|
___
|
2532
2542
|
|
@@ -2539,7 +2549,7 @@ ___
|
|
2539
2549
|
| Name | Type | Default value |
|
2540
2550
|
| :------ | :------ | :------ |
|
2541
2551
|
| `patientUuid` | [`PatientUuid`](API.md#patientuuid) | `undefined` |
|
2542
|
-
| `fetchInit?` |
|
2552
|
+
| `fetchInit?` | `FetchConfig` | `undefined` |
|
2543
2553
|
| `includeOfflinePatients` | `boolean` | `true` |
|
2544
2554
|
|
2545
2555
|
#### Returns
|
@@ -2548,13 +2558,13 @@ ___
|
|
2548
2558
|
|
2549
2559
|
#### Defined in
|
2550
2560
|
|
2551
|
-
[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)
|
2552
2562
|
|
2553
2563
|
___
|
2554
2564
|
|
2555
2565
|
### getAttachmentByUuid
|
2556
2566
|
|
2557
|
-
▸ **getAttachmentByUuid**(`attachmentUuid`, `abortController`): `Promise
|
2567
|
+
▸ **getAttachmentByUuid**(`attachmentUuid`, `abortController`): `Promise`<`FetchResponse`<`any`\>\>
|
2558
2568
|
|
2559
2569
|
#### Parameters
|
2560
2570
|
|
@@ -2565,17 +2575,17 @@ ___
|
|
2565
2575
|
|
2566
2576
|
#### Returns
|
2567
2577
|
|
2568
|
-
`Promise
|
2578
|
+
`Promise`<`FetchResponse`<`any`\>\>
|
2569
2579
|
|
2570
2580
|
#### Defined in
|
2571
2581
|
|
2572
|
-
[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)
|
2573
2583
|
|
2574
2584
|
___
|
2575
2585
|
|
2576
2586
|
### getAttachments
|
2577
2587
|
|
2578
|
-
▸ **getAttachments**(`patientUuid`, `includeEncounterless`, `abortController`): `Promise
|
2588
|
+
▸ **getAttachments**(`patientUuid`, `includeEncounterless`, `abortController`): `Promise`<`FetchResponse`<`any`\>\>
|
2579
2589
|
|
2580
2590
|
#### Parameters
|
2581
2591
|
|
@@ -2587,11 +2597,11 @@ ___
|
|
2587
2597
|
|
2588
2598
|
#### Returns
|
2589
2599
|
|
2590
|
-
`Promise
|
2600
|
+
`Promise`<`FetchResponse`<`any`\>\>
|
2591
2601
|
|
2592
2602
|
#### Defined in
|
2593
2603
|
|
2594
|
-
[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)
|
2595
2605
|
|
2596
2606
|
___
|
2597
2607
|
|
@@ -2636,7 +2646,7 @@ leak and source of bugs.
|
|
2636
2646
|
|
2637
2647
|
#### Defined in
|
2638
2648
|
|
2639
|
-
[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)
|
2640
2650
|
|
2641
2651
|
▸ **getCurrentUser**(`opts`): `Observable`<[`Session`](interfaces/Session.md)\>
|
2642
2652
|
|
@@ -2653,7 +2663,7 @@ leak and source of bugs.
|
|
2653
2663
|
|
2654
2664
|
#### Defined in
|
2655
2665
|
|
2656
|
-
[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)
|
2657
2667
|
|
2658
2668
|
▸ **getCurrentUser**(`opts`): `Observable`<[`LoggedInUser`](interfaces/LoggedInUser.md)\>
|
2659
2669
|
|
@@ -2670,7 +2680,7 @@ leak and source of bugs.
|
|
2670
2680
|
|
2671
2681
|
#### Defined in
|
2672
2682
|
|
2673
|
-
[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)
|
2674
2684
|
|
2675
2685
|
___
|
2676
2686
|
|
@@ -2691,7 +2701,7 @@ ___
|
|
2691
2701
|
|
2692
2702
|
#### Defined in
|
2693
2703
|
|
2694
|
-
[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)
|
2695
2705
|
|
2696
2706
|
___
|
2697
2707
|
|
@@ -2705,7 +2715,7 @@ ___
|
|
2705
2715
|
|
2706
2716
|
#### Defined in
|
2707
2717
|
|
2708
|
-
[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)
|
2709
2719
|
|
2710
2720
|
___
|
2711
2721
|
|
@@ -2719,7 +2729,7 @@ ___
|
|
2719
2729
|
|
2720
2730
|
#### Defined in
|
2721
2731
|
|
2722
|
-
[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)
|
2723
2733
|
|
2724
2734
|
___
|
2725
2735
|
|
@@ -2733,7 +2743,7 @@ ___
|
|
2733
2743
|
|
2734
2744
|
#### Defined in
|
2735
2745
|
|
2736
|
-
[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)
|
2737
2747
|
|
2738
2748
|
___
|
2739
2749
|
|
@@ -2747,7 +2757,7 @@ ___
|
|
2747
2757
|
|
2748
2758
|
#### Defined in
|
2749
2759
|
|
2750
|
-
[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)
|
2751
2761
|
|
2752
2762
|
___
|
2753
2763
|
|
@@ -2761,13 +2771,13 @@ ___
|
|
2761
2771
|
|
2762
2772
|
#### Defined in
|
2763
2773
|
|
2764
|
-
[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)
|
2765
2775
|
|
2766
2776
|
___
|
2767
2777
|
|
2768
2778
|
### getVisitsForPatient
|
2769
2779
|
|
2770
|
-
▸ **getVisitsForPatient**(`patientUuid`, `abortController`, `v?`): `Promise`<
|
2780
|
+
▸ **getVisitsForPatient**(`patientUuid`, `abortController`, `v?`): `Promise`<`FetchResponse`<{ `results`: [`Visit`](interfaces/Visit.md)[] }\>\>
|
2771
2781
|
|
2772
2782
|
**`deprecated`** Use the `useVisit` hook instead.
|
2773
2783
|
|
@@ -2781,11 +2791,11 @@ ___
|
|
2781
2791
|
|
2782
2792
|
#### Returns
|
2783
2793
|
|
2784
|
-
`Promise`<
|
2794
|
+
`Promise`<`FetchResponse`<{ `results`: [`Visit`](interfaces/Visit.md)[] }\>\>
|
2785
2795
|
|
2786
2796
|
#### Defined in
|
2787
2797
|
|
2788
|
-
[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)
|
2789
2799
|
|
2790
2800
|
___
|
2791
2801
|
|
@@ -2814,7 +2824,7 @@ makeUrl('/foo/bar');
|
|
2814
2824
|
|
2815
2825
|
#### Defined in
|
2816
2826
|
|
2817
|
-
[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)
|
2818
2828
|
|
2819
2829
|
___
|
2820
2830
|
|
@@ -2881,7 +2891,7 @@ free up memory and network resources and to prevent race conditions.
|
|
2881
2891
|
|
2882
2892
|
#### Defined in
|
2883
2893
|
|
2884
|
-
[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)
|
2885
2895
|
|
2886
2896
|
___
|
2887
2897
|
|
@@ -2932,7 +2942,7 @@ To cancel the network request, simply call `subscription.unsubscribe();`
|
|
2932
2942
|
|
2933
2943
|
#### Defined in
|
2934
2944
|
|
2935
|
-
[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)
|
2936
2946
|
|
2937
2947
|
___
|
2938
2948
|
|
@@ -2965,13 +2975,13 @@ refetchCurrentUser()
|
|
2965
2975
|
|
2966
2976
|
#### Defined in
|
2967
2977
|
|
2968
|
-
[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)
|
2969
2979
|
|
2970
2980
|
___
|
2971
2981
|
|
2972
2982
|
### saveVisit
|
2973
2983
|
|
2974
|
-
▸ **saveVisit**(`payload`, `abortController`): `Promise`<[`
|
2984
|
+
▸ **saveVisit**(`payload`, `abortController`): `Promise`<`FetchResponse`<[`Visit`](interfaces/Visit.md)\>\>
|
2975
2985
|
|
2976
2986
|
#### Parameters
|
2977
2987
|
|
@@ -2982,11 +2992,11 @@ ___
|
|
2982
2992
|
|
2983
2993
|
#### Returns
|
2984
2994
|
|
2985
|
-
`Promise`<[`
|
2995
|
+
`Promise`<`FetchResponse`<[`Visit`](interfaces/Visit.md)\>\>
|
2986
2996
|
|
2987
2997
|
#### Defined in
|
2988
2998
|
|
2989
|
-
[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)
|
2990
3000
|
|
2991
3001
|
___
|
2992
3002
|
|
@@ -3007,7 +3017,7 @@ ___
|
|
3007
3017
|
|
3008
3018
|
#### Defined in
|
3009
3019
|
|
3010
|
-
[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)
|
3011
3021
|
|
3012
3022
|
___
|
3013
3023
|
|
@@ -3028,7 +3038,7 @@ ___
|
|
3028
3038
|
|
3029
3039
|
#### Defined in
|
3030
3040
|
|
3031
|
-
[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)
|
3032
3042
|
|
3033
3043
|
___
|
3034
3044
|
|
@@ -3048,7 +3058,7 @@ ___
|
|
3048
3058
|
|
3049
3059
|
#### Defined in
|
3050
3060
|
|
3051
|
-
[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)
|
3052
3062
|
|
3053
3063
|
___
|
3054
3064
|
|
@@ -3070,7 +3080,7 @@ ___
|
|
3070
3080
|
|
3071
3081
|
#### Defined in
|
3072
3082
|
|
3073
|
-
[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)
|
3074
3084
|
|
3075
3085
|
___
|
3076
3086
|
|
@@ -3090,7 +3100,7 @@ ___
|
|
3090
3100
|
|
3091
3101
|
#### Defined in
|
3092
3102
|
|
3093
|
-
[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)
|
3094
3104
|
|
3095
3105
|
___
|
3096
3106
|
|
@@ -3110,13 +3120,13 @@ ___
|
|
3110
3120
|
|
3111
3121
|
#### Defined in
|
3112
3122
|
|
3113
|
-
[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)
|
3114
3124
|
|
3115
3125
|
___
|
3116
3126
|
|
3117
3127
|
### updateVisit
|
3118
3128
|
|
3119
|
-
▸ **updateVisit**(`uuid`, `payload`, `abortController`): `Promise`<[`
|
3129
|
+
▸ **updateVisit**(`uuid`, `payload`, `abortController`): `Promise`<`FetchResponse`<[`Visit`](interfaces/Visit.md)\>\>
|
3120
3130
|
|
3121
3131
|
#### Parameters
|
3122
3132
|
|
@@ -3128,11 +3138,11 @@ ___
|
|
3128
3138
|
|
3129
3139
|
#### Returns
|
3130
3140
|
|
3131
|
-
`Promise`<[`
|
3141
|
+
`Promise`<`FetchResponse`<[`Visit`](interfaces/Visit.md)\>\>
|
3132
3142
|
|
3133
3143
|
#### Defined in
|
3134
3144
|
|
3135
|
-
[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)
|
3136
3146
|
|
3137
3147
|
___
|
3138
3148
|
|
@@ -3153,15 +3163,15 @@ ___
|
|
3153
3163
|
|
3154
3164
|
| Name | Type |
|
3155
3165
|
| :------ | :------ |
|
3156
|
-
| `data` |
|
3166
|
+
| `data` | `AttachmentResponse`[] |
|
3157
3167
|
| `error` | `any` |
|
3158
3168
|
| `isLoading` | `boolean` |
|
3159
3169
|
| `isValidating` | `boolean` |
|
3160
|
-
| `mutate` | `KeyedMutator`<
|
3170
|
+
| `mutate` | `KeyedMutator`<`FetchResponse`<{ `results`: `AttachmentResponse`[] }\>\> |
|
3161
3171
|
|
3162
3172
|
#### Defined in
|
3163
3173
|
|
3164
|
-
[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)
|
3165
3175
|
|
3166
3176
|
___
|
3167
3177
|
|
@@ -3183,10 +3193,10 @@ Object containing:
|
|
3183
3193
|
|
3184
3194
|
| Name | Type |
|
3185
3195
|
| :------ | :------ |
|
3186
|
-
| `emrConfiguration` | `undefined` \| `EmrApiConfigurationResponse` |
|
3196
|
+
| `emrConfiguration` | `undefined` \| [`EmrApiConfigurationResponse`](interfaces/EmrApiConfigurationResponse.md) |
|
3187
3197
|
| `errorFetchingEmrConfiguration` | `undefined` \| `Error` |
|
3188
3198
|
| `isLoadingEmrConfiguration` | `boolean` |
|
3189
|
-
| `mutateEmrConfiguration` | `KeyedMutator`<[`
|
3199
|
+
| `mutateEmrConfiguration` | `KeyedMutator`<`FetchResponse`<[`EmrApiConfigurationResponse`](interfaces/EmrApiConfigurationResponse.md)\>\> |
|
3190
3200
|
|
3191
3201
|
#### Defined in
|
3192
3202
|
|
@@ -3196,7 +3206,7 @@ ___
|
|
3196
3206
|
|
3197
3207
|
### useLocations
|
3198
3208
|
|
3199
|
-
▸ **useLocations**(`tagUuidOrName?`, `query?`):
|
3209
|
+
▸ **useLocations**(`tagUuidOrName?`, `query?`): `Location`[]
|
3200
3210
|
|
3201
3211
|
#### Parameters
|
3202
3212
|
|
@@ -3207,11 +3217,11 @@ ___
|
|
3207
3217
|
|
3208
3218
|
#### Returns
|
3209
3219
|
|
3210
|
-
|
3220
|
+
`Location`[]
|
3211
3221
|
|
3212
3222
|
#### Defined in
|
3213
3223
|
|
3214
|
-
[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)
|
3215
3225
|
|
3216
3226
|
___
|
3217
3227
|
|
@@ -3269,7 +3279,7 @@ ___
|
|
3269
3279
|
|
3270
3280
|
### useSession
|
3271
3281
|
|
3272
|
-
▸ **useSession**():
|
3282
|
+
▸ **useSession**(): `Session`
|
3273
3283
|
|
3274
3284
|
Gets the current user session information. Returns an object with
|
3275
3285
|
property `authenticated` == `false` if the user is not logged in.
|
@@ -3279,7 +3289,7 @@ or throw for Suspense. It will never return `null`/`undefined`.
|
|
3279
3289
|
|
3280
3290
|
#### Returns
|
3281
3291
|
|
3282
|
-
|
3292
|
+
`Session`
|
3283
3293
|
|
3284
3294
|
Current user session information
|
3285
3295
|
|
@@ -3328,15 +3338,15 @@ ___
|
|
3328
3338
|
|
3329
3339
|
### useVisitTypes
|
3330
3340
|
|
3331
|
-
▸ **useVisitTypes**():
|
3341
|
+
▸ **useVisitTypes**(): `VisitType`[]
|
3332
3342
|
|
3333
3343
|
#### Returns
|
3334
3344
|
|
3335
|
-
|
3345
|
+
`VisitType`[]
|
3336
3346
|
|
3337
3347
|
#### Defined in
|
3338
3348
|
|
3339
|
-
[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)
|
3340
3350
|
|
3341
3351
|
___
|
3342
3352
|
|
@@ -3359,7 +3369,7 @@ ___
|
|
3359
3369
|
|
3360
3370
|
#### Defined in
|
3361
3371
|
|
3362
|
-
[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)
|
3363
3373
|
|
3364
3374
|
___
|
3365
3375
|
|
@@ -3591,7 +3601,7 @@ Use this React Hook to obtain your module's configuration.
|
|
3591
3601
|
|
3592
3602
|
| Name | Type | Description |
|
3593
3603
|
| :------ | :------ | :------ |
|
3594
|
-
| `options?` | `UseConfigOptions` | Additional options that can be passed to useConfig() |
|
3604
|
+
| `options?` | [`UseConfigOptions`](interfaces/UseConfigOptions.md) | Additional options that can be passed to useConfig() |
|
3595
3605
|
|
3596
3606
|
#### Returns
|
3597
3607
|
|
@@ -4053,7 +4063,7 @@ CalendarDate
|
|
4053
4063
|
|
4054
4064
|
#### Defined in
|
4055
4065
|
|
4056
|
-
|
4066
|
+
packages/framework/esm-utils/dist/dates/date-util.d.ts:144
|
4057
4067
|
|
4058
4068
|
___
|
4059
4069
|
|
@@ -4092,7 +4102,7 @@ locales.
|
|
4092
4102
|
|
4093
4103
|
#### Defined in
|
4094
4104
|
|
4095
|
-
|
4105
|
+
packages/framework/esm-utils/dist/dates/date-util.d.ts:124
|
4096
4106
|
|
4097
4107
|
___
|
4098
4108
|
|
@@ -4121,13 +4131,13 @@ output of `Date.prototype.toLocaleString` for *most* locales.
|
|
4121
4131
|
|
4122
4132
|
#### Defined in
|
4123
4133
|
|
4124
|
-
|
4134
|
+
packages/framework/esm-utils/dist/dates/date-util.d.ts:139
|
4125
4135
|
|
4126
4136
|
___
|
4127
4137
|
|
4128
4138
|
### formatPartialDate
|
4129
4139
|
|
4130
|
-
▸ **formatPartialDate**(`dateString`, `options?`): ``null``
|
4140
|
+
▸ **formatPartialDate**(`dateString`, `options?`): `string` \| ``null``
|
4131
4141
|
|
4132
4142
|
Formats the string representing a date, including partial representations of dates, according to the current
|
4133
4143
|
locale and the given options.
|
@@ -4152,15 +4162,15 @@ locales.
|
|
4152
4162
|
| Name | Type |
|
4153
4163
|
| :------ | :------ |
|
4154
4164
|
| `dateString` | `string` |
|
4155
|
-
| `options
|
4165
|
+
| `options?` | `Partial`<[`FormatDateOptions`](API.md#formatdateoptions)\> |
|
4156
4166
|
|
4157
4167
|
#### Returns
|
4158
4168
|
|
4159
|
-
``null``
|
4169
|
+
`string` \| ``null``
|
4160
4170
|
|
4161
4171
|
#### Defined in
|
4162
4172
|
|
4163
|
-
|
4173
|
+
packages/framework/esm-utils/dist/dates/date-util.d.ts:104
|
4164
4174
|
|
4165
4175
|
___
|
4166
4176
|
|
@@ -4183,13 +4193,13 @@ Formats the input as a time, according to the current locale.
|
|
4183
4193
|
|
4184
4194
|
#### Defined in
|
4185
4195
|
|
4186
|
-
|
4196
|
+
packages/framework/esm-utils/dist/dates/date-util.d.ts:129
|
4187
4197
|
|
4188
4198
|
___
|
4189
4199
|
|
4190
4200
|
### getDefaultCalendar
|
4191
4201
|
|
4192
|
-
▸ **getDefaultCalendar**(`locale`): `
|
4202
|
+
▸ **getDefaultCalendar**(`locale`): `CalendarIdentifier` \| `undefined`
|
4193
4203
|
|
4194
4204
|
Retrieves the default calendar for the specified locale if any.
|
4195
4205
|
|
@@ -4201,11 +4211,11 @@ Retrieves the default calendar for the specified locale if any.
|
|
4201
4211
|
|
4202
4212
|
#### Returns
|
4203
4213
|
|
4204
|
-
`
|
4214
|
+
`CalendarIdentifier` \| `undefined`
|
4205
4215
|
|
4206
4216
|
#### Defined in
|
4207
4217
|
|
4208
|
-
|
4218
|
+
packages/framework/esm-utils/dist/dates/date-util.d.ts:48
|
4209
4219
|
|
4210
4220
|
___
|
4211
4221
|
|
@@ -4228,7 +4238,7 @@ The format should be YYYY-MM-DDTHH:mm:ss.SSSZZ
|
|
4228
4238
|
|
4229
4239
|
#### Defined in
|
4230
4240
|
|
4231
|
-
|
4241
|
+
packages/framework/esm-utils/dist/dates/date-util.d.ts:11
|
4232
4242
|
|
4233
4243
|
___
|
4234
4244
|
|
@@ -4248,7 +4258,7 @@ ___
|
|
4248
4258
|
|
4249
4259
|
#### Defined in
|
4250
4260
|
|
4251
|
-
|
4261
|
+
packages/framework/esm-utils/dist/dates/date-util.d.ts:16
|
4252
4262
|
|
4253
4263
|
___
|
4254
4264
|
|
@@ -4271,7 +4281,7 @@ Uses `dayjs(dateString)`.
|
|
4271
4281
|
|
4272
4282
|
#### Defined in
|
4273
4283
|
|
4274
|
-
|
4284
|
+
packages/framework/esm-utils/dist/dates/date-util.d.ts:30
|
4275
4285
|
|
4276
4286
|
___
|
4277
4287
|
|
@@ -4299,7 +4309,7 @@ registerDefaultCalendar('en', 'buddhist') // sets the default calendar for the '
|
|
4299
4309
|
|
4300
4310
|
#### Defined in
|
4301
4311
|
|
4302
|
-
|
4312
|
+
packages/framework/esm-utils/dist/dates/date-util.d.ts:42
|
4303
4313
|
|
4304
4314
|
___
|
4305
4315
|
|
@@ -4322,7 +4332,7 @@ Otherwise returns null.
|
|
4322
4332
|
|
4323
4333
|
#### Defined in
|
4324
4334
|
|
4325
|
-
|
4335
|
+
packages/framework/esm-utils/dist/dates/date-util.d.ts:21
|
4326
4336
|
|
4327
4337
|
___
|
4328
4338
|
|
@@ -4334,10 +4344,10 @@ Formats the input to OpenMRS ISO format: "YYYY-MM-DDTHH:mm:ss.SSSZZ".
|
|
4334
4344
|
|
4335
4345
|
#### Parameters
|
4336
4346
|
|
4337
|
-
| Name | Type |
|
4338
|
-
| :------ | :------ |
|
4339
|
-
| `date` | [`DateInput`](API.md#dateinput) |
|
4340
|
-
| `toUTC
|
4347
|
+
| Name | Type |
|
4348
|
+
| :------ | :------ |
|
4349
|
+
| `date` | [`DateInput`](API.md#dateinput) |
|
4350
|
+
| `toUTC?` | `boolean` |
|
4341
4351
|
|
4342
4352
|
#### Returns
|
4343
4353
|
|
@@ -4345,7 +4355,7 @@ Formats the input to OpenMRS ISO format: "YYYY-MM-DDTHH:mm:ss.SSSZZ".
|
|
4345
4355
|
|
4346
4356
|
#### Defined in
|
4347
4357
|
|
4348
|
-
|
4358
|
+
packages/framework/esm-utils/dist/dates/date-util.d.ts:25
|
4349
4359
|
|
4350
4360
|
___
|
4351
4361
|
|
@@ -4387,54 +4397,6 @@ const { someComponent } = importDynamic("@openmrs/esm-template-app")
|
|
4387
4397
|
|
4388
4398
|
___
|
4389
4399
|
|
4390
|
-
## Error Handling Functions
|
4391
|
-
|
4392
|
-
### createErrorHandler
|
4393
|
-
|
4394
|
-
▸ **createErrorHandler**(): (`incomingErr`: `any`) => `void`
|
4395
|
-
|
4396
|
-
#### Returns
|
4397
|
-
|
4398
|
-
`fn`
|
4399
|
-
|
4400
|
-
▸ (`incomingErr`): `void`
|
4401
|
-
|
4402
|
-
##### Parameters
|
4403
|
-
|
4404
|
-
| Name | Type |
|
4405
|
-
| :------ | :------ |
|
4406
|
-
| `incomingErr` | `any` |
|
4407
|
-
|
4408
|
-
##### Returns
|
4409
|
-
|
4410
|
-
`void`
|
4411
|
-
|
4412
|
-
#### Defined in
|
4413
|
-
|
4414
|
-
[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)
|
4415
|
-
|
4416
|
-
___
|
4417
|
-
|
4418
|
-
### reportError
|
4419
|
-
|
4420
|
-
▸ **reportError**(`err`): `void`
|
4421
|
-
|
4422
|
-
#### Parameters
|
4423
|
-
|
4424
|
-
| Name | Type |
|
4425
|
-
| :------ | :------ |
|
4426
|
-
| `err` | `any` |
|
4427
|
-
|
4428
|
-
#### Returns
|
4429
|
-
|
4430
|
-
`void`
|
4431
|
-
|
4432
|
-
#### Defined in
|
4433
|
-
|
4434
|
-
[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)
|
4435
|
-
|
4436
|
-
___
|
4437
|
-
|
4438
4400
|
## Extension Functions
|
4439
4401
|
|
4440
4402
|
### ExtensionSlot
|
@@ -4694,7 +4656,7 @@ ___
|
|
4694
4656
|
|
4695
4657
|
### useAssignedExtensions
|
4696
4658
|
|
4697
|
-
▸ **useAssignedExtensions**(`slotName`):
|
4659
|
+
▸ **useAssignedExtensions**(`slotName`): `AssignedExtension`[]
|
4698
4660
|
|
4699
4661
|
Gets the assigned extensions for a given extension slot name.
|
4700
4662
|
|
@@ -4706,7 +4668,7 @@ Gets the assigned extensions for a given extension slot name.
|
|
4706
4668
|
|
4707
4669
|
#### Returns
|
4708
4670
|
|
4709
|
-
|
4671
|
+
`AssignedExtension`[]
|
4710
4672
|
|
4711
4673
|
#### Defined in
|
4712
4674
|
|
@@ -4716,7 +4678,7 @@ ___
|
|
4716
4678
|
|
4717
4679
|
### useConnectedExtensions
|
4718
4680
|
|
4719
|
-
▸ **useConnectedExtensions**(`slotName`):
|
4681
|
+
▸ **useConnectedExtensions**(`slotName`): `ConnectedExtension`[]
|
4720
4682
|
|
4721
4683
|
Gets the assigned extension for a given extension slot name.
|
4722
4684
|
|
@@ -4730,7 +4692,7 @@ Gets the assigned extension for a given extension slot name.
|
|
4730
4692
|
|
4731
4693
|
#### Returns
|
4732
4694
|
|
4733
|
-
|
4695
|
+
`ConnectedExtension`[]
|
4734
4696
|
|
4735
4697
|
#### Defined in
|
4736
4698
|
|
@@ -4748,7 +4710,7 @@ Extract meta data from all extension for a given extension slot.
|
|
4748
4710
|
|
4749
4711
|
| Name | Type |
|
4750
4712
|
| :------ | :------ |
|
4751
|
-
| `T` |
|
4713
|
+
| `T` | `ExtensionMeta` |
|
4752
4714
|
|
4753
4715
|
#### Parameters
|
4754
4716
|
|
@@ -4768,7 +4730,7 @@ ___
|
|
4768
4730
|
|
4769
4731
|
### useExtensionSlotStore
|
4770
4732
|
|
4771
|
-
▸ **useExtensionSlotStore**(`slot`):
|
4733
|
+
▸ **useExtensionSlotStore**(`slot`): `ExtensionSlotState`
|
4772
4734
|
|
4773
4735
|
#### Parameters
|
4774
4736
|
|
@@ -4778,7 +4740,7 @@ ___
|
|
4778
4740
|
|
4779
4741
|
#### Returns
|
4780
4742
|
|
4781
|
-
|
4743
|
+
`ExtensionSlotState`
|
4782
4744
|
|
4783
4745
|
#### Defined in
|
4784
4746
|
|
@@ -4804,7 +4766,7 @@ ___
|
|
4804
4766
|
|
4805
4767
|
| Name | Type |
|
4806
4768
|
| :------ | :------ |
|
4807
|
-
| `A` | extends [`Actions`](API.md#actions)
|
4769
|
+
| `A` | extends [`Actions`](API.md#actions)<`ExtensionStore`\> |
|
4808
4770
|
|
4809
4771
|
#### Parameters
|
4810
4772
|
|
@@ -4826,7 +4788,7 @@ ___
|
|
4826
4788
|
|
4827
4789
|
| Name | Type |
|
4828
4790
|
| :------ | :------ |
|
4829
|
-
| `A` | extends [`Actions`](API.md#actions)
|
4791
|
+
| `A` | extends [`Actions`](API.md#actions)<`ExtensionStore`\> |
|
4830
4792
|
|
4831
4793
|
#### Parameters
|
4832
4794
|
|
@@ -4977,7 +4939,7 @@ ___
|
|
4977
4939
|
|
4978
4940
|
### getAsyncExtensionLifecycle
|
4979
4941
|
|
4980
|
-
▸ **getAsyncExtensionLifecycle**<`T`\>(`lazy`, `options`): () => `Promise`<`
|
4942
|
+
▸ **getAsyncExtensionLifecycle**<`T`\>(`lazy`, `options`): () => `Promise`<`ReactAppOrParcel`<`T`\>\>
|
4981
4943
|
|
4982
4944
|
**`deprecated`** Use getAsyncLifecycle instead.
|
4983
4945
|
|
@@ -4998,11 +4960,11 @@ ___
|
|
4998
4960
|
|
4999
4961
|
`fn`
|
5000
4962
|
|
5001
|
-
▸ (): `Promise`<`
|
4963
|
+
▸ (): `Promise`<`ReactAppOrParcel`<`T`\>\>
|
5002
4964
|
|
5003
4965
|
##### Returns
|
5004
4966
|
|
5005
|
-
`Promise`<`
|
4967
|
+
`Promise`<`ReactAppOrParcel`<`T`\>\>
|
5006
4968
|
|
5007
4969
|
#### Defined in
|
5008
4970
|
|
@@ -5012,7 +4974,7 @@ ___
|
|
5012
4974
|
|
5013
4975
|
### getAsyncLifecycle
|
5014
4976
|
|
5015
|
-
▸ **getAsyncLifecycle**<`T`\>(`lazy`, `options`): () => `Promise`<`
|
4977
|
+
▸ **getAsyncLifecycle**<`T`\>(`lazy`, `options`): () => `Promise`<`ReactAppOrParcel`<`T`\>\>
|
5016
4978
|
|
5017
4979
|
#### Type parameters
|
5018
4980
|
|
@@ -5031,11 +4993,11 @@ ___
|
|
5031
4993
|
|
5032
4994
|
`fn`
|
5033
4995
|
|
5034
|
-
▸ (): `Promise`<`
|
4996
|
+
▸ (): `Promise`<`ReactAppOrParcel`<`T`\>\>
|
5035
4997
|
|
5036
4998
|
##### Returns
|
5037
4999
|
|
5038
|
-
`Promise`<`
|
5000
|
+
`Promise`<`ReactAppOrParcel`<`T`\>\>
|
5039
5001
|
|
5040
5002
|
#### Defined in
|
5041
5003
|
|
@@ -5045,7 +5007,7 @@ ___
|
|
5045
5007
|
|
5046
5008
|
### getLifecycle
|
5047
5009
|
|
5048
|
-
▸ **getLifecycle**<`T`\>(`Component`, `options`): `
|
5010
|
+
▸ **getLifecycle**<`T`\>(`Component`, `options`): `ReactAppOrParcel`<`T`\>
|
5049
5011
|
|
5050
5012
|
#### Type parameters
|
5051
5013
|
|
@@ -5062,7 +5024,7 @@ ___
|
|
5062
5024
|
|
5063
5025
|
#### Returns
|
5064
5026
|
|
5065
|
-
`
|
5027
|
+
`ReactAppOrParcel`<`T`\>
|
5066
5028
|
|
5067
5029
|
#### Defined in
|
5068
5030
|
|
@@ -5072,7 +5034,7 @@ ___
|
|
5072
5034
|
|
5073
5035
|
### getSyncLifecycle
|
5074
5036
|
|
5075
|
-
▸ **getSyncLifecycle**<`T`\>(`Component`, `options`): () => `Promise`<`
|
5037
|
+
▸ **getSyncLifecycle**<`T`\>(`Component`, `options`): () => `Promise`<`ReactAppOrParcel`<`T`\>\>
|
5076
5038
|
|
5077
5039
|
#### Type parameters
|
5078
5040
|
|
@@ -5091,11 +5053,11 @@ ___
|
|
5091
5053
|
|
5092
5054
|
`fn`
|
5093
5055
|
|
5094
|
-
▸ (): `Promise`<`
|
5056
|
+
▸ (): `Promise`<`ReactAppOrParcel`<`T`\>\>
|
5095
5057
|
|
5096
5058
|
##### Returns
|
5097
5059
|
|
5098
|
-
`Promise`<`
|
5060
|
+
`Promise`<`ReactAppOrParcel`<`T`\>\>
|
5099
5061
|
|
5100
5062
|
#### Defined in
|
5101
5063
|
|
@@ -5123,7 +5085,7 @@ A React link component which calls [navigate](API.md#navigate) when clicked
|
|
5123
5085
|
|
5124
5086
|
#### Defined in
|
5125
5087
|
|
5126
|
-
[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)
|
5127
5089
|
|
5128
5090
|
___
|
5129
5091
|
|
@@ -5370,7 +5332,7 @@ Generates a UUID-like string which is used for uniquely identifying objects whil
|
|
5370
5332
|
|
5371
5333
|
#### Defined in
|
5372
5334
|
|
5373
|
-
[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)
|
5374
5336
|
|
5375
5337
|
___
|
5376
5338
|
|
@@ -5610,7 +5572,7 @@ Checks whether the given string has the format of an offline UUID generated by [
|
|
5610
5572
|
|
5611
5573
|
#### Defined in
|
5612
5574
|
|
5613
|
-
[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)
|
5614
5576
|
|
5615
5577
|
___
|
5616
5578
|
|
@@ -5642,7 +5604,7 @@ ___
|
|
5642
5604
|
|
5643
5605
|
▸ **putDynamicOfflineData**(`type`, `identifier`): `Promise`<`void`\>
|
5644
5606
|
|
5645
|
-
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)
|
5646
5608
|
should be made available offline for the currently logged in user.
|
5647
5609
|
|
5648
5610
|
#### Parameters
|
@@ -5666,7 +5628,7 @@ ___
|
|
5666
5628
|
|
5667
5629
|
▸ **putDynamicOfflineDataFor**(`userId`, `type`, `identifier`): `Promise`<`void`\>
|
5668
5630
|
|
5669
|
-
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)
|
5670
5632
|
should be made available offline for the user with the given ID.
|
5671
5633
|
|
5672
5634
|
#### Parameters
|
@@ -5744,7 +5706,7 @@ ___
|
|
5744
5706
|
|
5745
5707
|
▸ **removeDynamicOfflineData**(`type`, `identifier`): `Promise`<`void`\>
|
5746
5708
|
|
5747
|
-
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)
|
5748
5710
|
no longer needs to be available offline for the currently logged in user.
|
5749
5711
|
|
5750
5712
|
#### Parameters
|
@@ -5768,7 +5730,7 @@ ___
|
|
5768
5730
|
|
5769
5731
|
▸ **removeDynamicOfflineDataFor**(`userId`, `type`, `identifier`): `Promise`<`void`\>
|
5770
5732
|
|
5771
|
-
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)
|
5772
5734
|
no longer needs to be available offline for the user with the given ID.
|
5773
5735
|
|
5774
5736
|
#### Parameters
|
@@ -5859,13 +5821,15 @@ ___
|
|
5859
5821
|
|
5860
5822
|
▸ (): `void`
|
5861
5823
|
|
5824
|
+
**`category`** Offline
|
5825
|
+
|
5862
5826
|
##### Returns
|
5863
5827
|
|
5864
5828
|
`void`
|
5865
5829
|
|
5866
5830
|
#### Defined in
|
5867
5831
|
|
5868
|
-
|
5832
|
+
packages/framework/esm-globals/dist/events.d.ts:9
|
5869
5833
|
|
5870
5834
|
___
|
5871
5835
|
|
@@ -5885,13 +5849,15 @@ ___
|
|
5885
5849
|
|
5886
5850
|
▸ (): `void`
|
5887
5851
|
|
5852
|
+
**`category`** Offline
|
5853
|
+
|
5888
5854
|
##### Returns
|
5889
5855
|
|
5890
5856
|
`void`
|
5891
5857
|
|
5892
5858
|
#### Defined in
|
5893
5859
|
|
5894
|
-
|
5860
|
+
packages/framework/esm-globals/dist/events.d.ts:7
|
5895
5861
|
|
5896
5862
|
___
|
5897
5863
|
|
@@ -5911,13 +5877,15 @@ ___
|
|
5911
5877
|
|
5912
5878
|
▸ (): `void`
|
5913
5879
|
|
5880
|
+
**`category`** Offline
|
5881
|
+
|
5914
5882
|
##### Returns
|
5915
5883
|
|
5916
5884
|
`void`
|
5917
5885
|
|
5918
5886
|
#### Defined in
|
5919
5887
|
|
5920
|
-
|
5888
|
+
packages/framework/esm-globals/dist/events.d.ts:14
|
5921
5889
|
|
5922
5890
|
___
|
5923
5891
|
|
@@ -6064,6 +6032,34 @@ This component also provides everything needed for workspace notifications to be
|
|
6064
6032
|
|
6065
6033
|
___
|
6066
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
|
+
|
6067
6063
|
### compile
|
6068
6064
|
|
6069
6065
|
▸ **compile**(`expression`): `jsep.Expression`
|
@@ -6095,6 +6091,72 @@ An executable AST representation of the expression
|
|
6095
6091
|
|
6096
6092
|
___
|
6097
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
|
+
|
6098
6160
|
### evaluate
|
6099
6161
|
|
6100
6162
|
▸ **evaluate**(`expression`, `variables?`): [`DefaultEvaluateReturnType`](API.md#defaultevaluatereturntype)
|
@@ -6501,7 +6563,21 @@ string
|
|
6501
6563
|
|
6502
6564
|
#### Defined in
|
6503
6565
|
|
6504
|
-
|
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)
|
6505
6581
|
|
6506
6582
|
___
|
6507
6583
|
|
@@ -6521,7 +6597,48 @@ ___
|
|
6521
6597
|
|
6522
6598
|
#### Defined in
|
6523
6599
|
|
6524
|
-
|
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
|
6525
6642
|
|
6526
6643
|
___
|
6527
6644
|
|
@@ -6607,7 +6724,7 @@ ___
|
|
6607
6724
|
|
6608
6725
|
### useVisitContextStore
|
6609
6726
|
|
6610
|
-
▸ **useVisitContextStore**(`mutateVisitCallback?`):
|
6727
|
+
▸ **useVisitContextStore**(`mutateVisitCallback?`): `VisitStoreState` & `BindFunctionsIn`<{ `mutateVisit`: (`currState`: `VisitStoreState`) => {} ; `setVisitContext`: (`_`: `VisitStoreState`, `newSelectedVisit`: ``null`` \| `Visit`) => { `manuallySetVisitUuid`: ``null`` \| `string` ; `patientUuid`: ``null`` \| `string` } }\>
|
6611
6728
|
|
6612
6729
|
A hook to return the visit context store and corresponding actions.
|
6613
6730
|
|
@@ -6619,7 +6736,7 @@ A hook to return the visit context store and corresponding actions.
|
|
6619
6736
|
|
6620
6737
|
#### Returns
|
6621
6738
|
|
6622
|
-
|
6739
|
+
`VisitStoreState` & `BindFunctionsIn`<{ `mutateVisit`: (`currState`: `VisitStoreState`) => {} ; `setVisitContext`: (`_`: `VisitStoreState`, `newSelectedVisit`: ``null`` \| `Visit`) => { `manuallySetVisitUuid`: ``null`` \| `string` ; `patientUuid`: ``null`` \| `string` } }\>
|
6623
6740
|
|
6624
6741
|
#### Defined in
|
6625
6742
|
|
@@ -6979,9 +7096,9 @@ invalid key to this function will result in a type error.
|
|
6979
7096
|
|
6980
7097
|
| Name | Type | Description |
|
6981
7098
|
| :------ | :------ | :------ |
|
6982
|
-
| `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"`` | - |
|
6983
7100
|
| `defaultText?` | `string` | - |
|
6984
|
-
| `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. |
|
6985
7102
|
|
6986
7103
|
#### Returns
|
6987
7104
|
|
@@ -7019,7 +7136,7 @@ load the module's translations if they have not already been loaded via `useTran
|
|
7019
7136
|
| `moduleName` | `string` | The module to get the translation from, e.g. '@openmrs/esm-login-app' |
|
7020
7137
|
| `key` | `string` | The i18next translation key |
|
7021
7138
|
| `fallback?` | `string` | Fallback text for if the lookup fails |
|
7022
|
-
| `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. |
|
7023
7140
|
|
7024
7141
|
#### Returns
|
7025
7142
|
|
@@ -7173,7 +7290,7 @@ A component which displays the patient photo https://zeroheight.com/23a080e38/p/
|
|
7173
7290
|
|
7174
7291
|
#### Defined in
|
7175
7292
|
|
7176
|
-
[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)
|
7177
7294
|
|
7178
7295
|
___
|
7179
7296
|
|
@@ -7292,7 +7409,7 @@ The dispose function to force closing the modal dialog.
|
|
7292
7409
|
|
7293
7410
|
#### Defined in
|
7294
7411
|
|
7295
|
-
[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)
|
7296
7413
|
|
7297
7414
|
___
|
7298
7415
|
|
@@ -7378,13 +7495,15 @@ ___
|
|
7378
7495
|
|
7379
7496
|
▸ (): `void`
|
7380
7497
|
|
7498
|
+
**`category`** UI
|
7499
|
+
|
7381
7500
|
##### Returns
|
7382
7501
|
|
7383
7502
|
`void`
|
7384
7503
|
|
7385
7504
|
#### Defined in
|
7386
7505
|
|
7387
|
-
|
7506
|
+
packages/framework/esm-globals/dist/events.d.ts:60
|
7388
7507
|
|
7389
7508
|
___
|
7390
7509
|
|
@@ -7404,13 +7523,15 @@ ___
|
|
7404
7523
|
|
7405
7524
|
▸ (): `void`
|
7406
7525
|
|
7526
|
+
**`category`** UI
|
7527
|
+
|
7407
7528
|
##### Returns
|
7408
7529
|
|
7409
7530
|
`void`
|
7410
7531
|
|
7411
7532
|
#### Defined in
|
7412
7533
|
|
7413
|
-
|
7534
|
+
packages/framework/esm-globals/dist/events.d.ts:58
|
7414
7535
|
|
7415
7536
|
___
|
7416
7537
|
|
@@ -7430,13 +7551,15 @@ ___
|
|
7430
7551
|
|
7431
7552
|
▸ (): `void`
|
7432
7553
|
|
7554
|
+
**`category`** UI
|
7555
|
+
|
7433
7556
|
##### Returns
|
7434
7557
|
|
7435
7558
|
`void`
|
7436
7559
|
|
7437
7560
|
#### Defined in
|
7438
7561
|
|
7439
|
-
|
7562
|
+
packages/framework/esm-globals/dist/events.d.ts:64
|
7440
7563
|
|
7441
7564
|
___
|
7442
7565
|
|
@@ -7456,13 +7579,15 @@ ___
|
|
7456
7579
|
|
7457
7580
|
▸ (): `void`
|
7458
7581
|
|
7582
|
+
**`category`** UI
|
7583
|
+
|
7459
7584
|
##### Returns
|
7460
7585
|
|
7461
7586
|
`void`
|
7462
7587
|
|
7463
7588
|
#### Defined in
|
7464
7589
|
|
7465
|
-
|
7590
|
+
packages/framework/esm-globals/dist/events.d.ts:62
|
7466
7591
|
|
7467
7592
|
___
|
7468
7593
|
|
@@ -7474,7 +7599,7 @@ ___
|
|
7474
7599
|
|
7475
7600
|
| Name | Type |
|
7476
7601
|
| :------ | :------ |
|
7477
|
-
| `name` | `
|
7602
|
+
| `name` | `string` |
|
7478
7603
|
|
7479
7604
|
#### Returns
|
7480
7605
|
|
@@ -7553,7 +7678,7 @@ This function is the FHIR counterpart of `useOpenmrsPagination`.
|
|
7553
7678
|
| `goToPrevious` | () => `void` | - |
|
7554
7679
|
| `isLoading` | `boolean` | - |
|
7555
7680
|
| `isValidating` | `boolean` | - |
|
7556
|
-
| `mutate` | `KeyedMutator
|
7681
|
+
| `mutate` | `KeyedMutator`<`FetchResponse`<`Bundle`\>\> | - |
|
7557
7682
|
| `paginated` | `boolean` | |
|
7558
7683
|
| `showNextButton` | `boolean` | |
|
7559
7684
|
| `showPreviousButton` | `boolean` | |
|
@@ -7729,7 +7854,7 @@ a UseServerInfiniteReturnObject object
|
|
7729
7854
|
|
7730
7855
|
#### Defined in
|
7731
7856
|
|
7732
|
-
[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)
|
7733
7858
|
|
7734
7859
|
___
|
7735
7860
|
|
@@ -7788,7 +7913,7 @@ of the data set. In that case, all data must be loaded onto client-side first.
|
|
7788
7913
|
| `goToPrevious` | () => `void` | - |
|
7789
7914
|
| `isLoading` | `boolean` | - |
|
7790
7915
|
| `isValidating` | `boolean` | - |
|
7791
|
-
| `mutate` | `KeyedMutator
|
7916
|
+
| `mutate` | `KeyedMutator`<`FetchResponse`<`OpenMRSPaginatedResponse`<`T`\>\>\> | - |
|
7792
7917
|
| `paginated` | `boolean` | |
|
7793
7918
|
| `showNextButton` | `boolean` | |
|
7794
7919
|
| `showPreviousButton` | `boolean` | |
|
@@ -7869,34 +7994,6 @@ ___
|
|
7869
7994
|
|
7870
7995
|
## Utility Functions
|
7871
7996
|
|
7872
|
-
### age
|
7873
|
-
|
7874
|
-
▸ **age**(`birthDate`, `currentDate?`): `string` \| ``null``
|
7875
|
-
|
7876
|
-
Gets a human readable and locale supported representation of a person's age, given their birthDate,
|
7877
|
-
The representation logic follows the guideline here:
|
7878
|
-
https://webarchive.nationalarchives.gov.uk/ukgwa/20160921162509mp_/http://systems.digital.nhs.uk/data/cui/uig/patben.pdf
|
7879
|
-
(See Tables 7 and 8)
|
7880
|
-
|
7881
|
-
#### Parameters
|
7882
|
-
|
7883
|
-
| Name | Type | Description |
|
7884
|
-
| :------ | :------ | :------ |
|
7885
|
-
| `birthDate` | `ConfigType` | The birthDate. If birthDate is null, returns null. |
|
7886
|
-
| `currentDate` | `ConfigType` | Optional. If provided, calculates the age of the person at the provided currentDate (instead of now). |
|
7887
|
-
|
7888
|
-
#### Returns
|
7889
|
-
|
7890
|
-
`string` \| ``null``
|
7891
|
-
|
7892
|
-
A human-readable string version of the age.
|
7893
|
-
|
7894
|
-
#### Defined in
|
7895
|
-
|
7896
|
-
[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)
|
7897
|
-
|
7898
|
-
___
|
7899
|
-
|
7900
7997
|
### canAccessStorage
|
7901
7998
|
|
7902
7999
|
▸ **canAccessStorage**(`storage?`): `boolean`
|
@@ -7907,9 +8004,9 @@ is actually available. Useful for testing the availability of `localStorage` or
|
|
7907
8004
|
|
7908
8005
|
#### Parameters
|
7909
8006
|
|
7910
|
-
| Name | Type |
|
7911
|
-
| :------ | :------ | :------ |
|
7912
|
-
| `storage
|
8007
|
+
| Name | Type | Description |
|
8008
|
+
| :------ | :------ | :------ |
|
8009
|
+
| `storage?` | `Storage` | The WebStorage API object to check. Defaults to `localStorage`. |
|
7913
8010
|
|
7914
8011
|
#### Returns
|
7915
8012
|
|
@@ -7919,7 +8016,7 @@ True if the WebStorage API object is able to be accessed, false otherwise
|
|
7919
8016
|
|
7920
8017
|
#### Defined in
|
7921
8018
|
|
7922
|
-
|
8019
|
+
packages/framework/esm-utils/dist/storage.d.ts:10
|
7923
8020
|
|
7924
8021
|
___
|
7925
8022
|
|
@@ -7941,7 +8038,7 @@ ___
|
|
7941
8038
|
|
7942
8039
|
#### Defined in
|
7943
8040
|
|
7944
|
-
|
8041
|
+
packages/framework/esm-utils/dist/patient-helpers.d.ts:15
|
7945
8042
|
|
7946
8043
|
___
|
7947
8044
|
|
@@ -7965,7 +8062,7 @@ The formatted display name or an empty string if name is undefined.
|
|
7965
8062
|
|
7966
8063
|
#### Defined in
|
7967
8064
|
|
7968
|
-
|
8065
|
+
packages/framework/esm-utils/dist/patient-helpers.d.ts:21
|
7969
8066
|
|
7970
8067
|
___
|
7971
8068
|
|
@@ -7987,7 +8084,7 @@ ___
|
|
7987
8084
|
|
7988
8085
|
#### Defined in
|
7989
8086
|
|
7990
|
-
|
8087
|
+
packages/framework/esm-utils/dist/patient-helpers.d.ts:23
|
7991
8088
|
|
7992
8089
|
___
|
7993
8090
|
|
@@ -8014,7 +8111,7 @@ need to override some of the default values.
|
|
8014
8111
|
|
8015
8112
|
| Name | Type |
|
8016
8113
|
| :------ | :------ |
|
8017
|
-
| `schema` | `
|
8114
|
+
| `schema` | `Record`<`string` \| `number` \| `symbol`, `unknown`\> |
|
8018
8115
|
|
8019
8116
|
#### Returns
|
8020
8117
|
|
@@ -8022,7 +8119,7 @@ need to override some of the default values.
|
|
8022
8119
|
|
8023
8120
|
#### Defined in
|
8024
8121
|
|
8025
|
-
|
8122
|
+
packages/framework/esm-utils/dist/test-helpers.d.ts:12
|
8026
8123
|
|
8027
8124
|
___
|
8028
8125
|
|
@@ -8049,28 +8146,7 @@ The patient's display name or an empty string if name is not present.
|
|
8049
8146
|
|
8050
8147
|
#### Defined in
|
8051
8148
|
|
8052
|
-
|
8053
|
-
|
8054
|
-
___
|
8055
|
-
|
8056
|
-
### isVersionSatisfied
|
8057
|
-
|
8058
|
-
▸ **isVersionSatisfied**(`requiredVersion`, `installedVersion`): `boolean`
|
8059
|
-
|
8060
|
-
#### Parameters
|
8061
|
-
|
8062
|
-
| Name | Type |
|
8063
|
-
| :------ | :------ |
|
8064
|
-
| `requiredVersion` | `string` |
|
8065
|
-
| `installedVersion` | `string` |
|
8066
|
-
|
8067
|
-
#### Returns
|
8068
|
-
|
8069
|
-
`boolean`
|
8070
|
-
|
8071
|
-
#### Defined in
|
8072
|
-
|
8073
|
-
[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
|
8074
8150
|
|
8075
8151
|
___
|
8076
8152
|
|
@@ -8098,7 +8174,7 @@ If not configured otherwise, this function uses the following default options:
|
|
8098
8174
|
| Name | Type | Description |
|
8099
8175
|
| :------ | :------ | :------ |
|
8100
8176
|
| `fn` | () => `Promise`<`T`\> | The function to be executed and retried on failure. |
|
8101
|
-
| `options
|
8177
|
+
| `options?` | [`RetryOptions`](interfaces/RetryOptions.md) | Additional options which configure the retry behavior. |
|
8102
8178
|
|
8103
8179
|
#### Returns
|
8104
8180
|
|
@@ -8108,7 +8184,7 @@ The result of successfully executing `fn`.
|
|
8108
8184
|
|
8109
8185
|
#### Defined in
|
8110
8186
|
|
8111
|
-
|
8187
|
+
packages/framework/esm-utils/dist/retry.d.ts:38
|
8112
8188
|
|
8113
8189
|
___
|
8114
8190
|
|
@@ -8146,7 +8222,7 @@ the preferred name for the patient, or undefined if no acceptable name could be
|
|
8146
8222
|
|
8147
8223
|
#### Defined in
|
8148
8224
|
|
8149
|
-
|
8225
|
+
packages/framework/esm-utils/dist/patient-helpers.d.ts:42
|
8150
8226
|
|
8151
8227
|
___
|
8152
8228
|
|
@@ -8174,7 +8250,7 @@ true if the objects are shallowly equal to each other
|
|
8174
8250
|
|
8175
8251
|
#### Defined in
|
8176
8252
|
|
8177
|
-
|
8253
|
+
packages/framework/esm-utils/dist/shallowEqual.d.ts:12
|
8178
8254
|
|
8179
8255
|
___
|
8180
8256
|
|
@@ -8266,7 +8342,7 @@ ___
|
|
8266
8342
|
|
8267
8343
|
### useOpenmrsSWR
|
8268
8344
|
|
8269
|
-
▸ **useOpenmrsSWR**<`DataType`, `ErrorType`\>(`key`, `options?`): `SWRResponse
|
8345
|
+
▸ **useOpenmrsSWR**<`DataType`, `ErrorType`\>(`key`, `options?`): `SWRResponse`<`FetchResponse`<`DataType`\>, `ErrorType`, `undefined` \| `SWRConfiguration`<`FetchResponse`<`DataType`\>, `ErrorType`, `BareFetcher`<`FetchResponse`<`DataType`\>\>\>\>
|
8270
8346
|
|
8271
8347
|
**`beta`**
|
8272
8348
|
|
@@ -8319,7 +8395,7 @@ function MyComponent() {
|
|
8319
8395
|
|
8320
8396
|
#### Returns
|
8321
8397
|
|
8322
|
-
`SWRResponse
|
8398
|
+
`SWRResponse`<`FetchResponse`<`DataType`\>, `ErrorType`, `undefined` \| `SWRConfiguration`<`FetchResponse`<`DataType`\>, `ErrorType`, `BareFetcher`<`FetchResponse`<`DataType`\>\>\>\>
|
8323
8399
|
|
8324
8400
|
#### Defined in
|
8325
8401
|
|
@@ -8348,7 +8424,7 @@ Function to close an opened workspace
|
|
8348
8424
|
|
8349
8425
|
#### Defined in
|
8350
8426
|
|
8351
|
-
[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)
|
8352
8428
|
|
8353
8429
|
___
|
8354
8430
|
|
@@ -8399,7 +8475,7 @@ prop named `workspaceTitle` will override the title of the workspace.
|
|
8399
8475
|
|
8400
8476
|
#### Defined in
|
8401
8477
|
|
8402
|
-
[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)
|
8403
8479
|
|
8404
8480
|
___
|
8405
8481
|
|
@@ -8430,7 +8506,7 @@ launchWorkspaceGroup("myGroup", {
|
|
8430
8506
|
|
8431
8507
|
#### Defined in
|
8432
8508
|
|
8433
|
-
[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)
|
8434
8510
|
|
8435
8511
|
___
|
8436
8512
|
|
@@ -8456,7 +8532,7 @@ Use this function to navigate to a new page and launch a workspace on that page.
|
|
8456
8532
|
|
8457
8533
|
#### Defined in
|
8458
8534
|
|
8459
|
-
[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)
|
8460
8536
|
|
8461
8537
|
___
|
8462
8538
|
|
@@ -8470,4 +8546,4 @@ ___
|
|
8470
8546
|
|
8471
8547
|
#### Defined in
|
8472
8548
|
|
8473
|
-
[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)
|