Skip to main content

changelog

3.14.5 (2025-07-08)​

Bug Fixes​

  • update dependencies to get rid of d2 init warnings (#1415) (ec044f3)

3.14.4 (2025-06-05)​

Bug Fixes​

  • expose Query, Mutation and ExecuteOptions types (#1414) (a1d2315)

3.14.3 (2025-06-02)​

Bug Fixes​

  • update cli-app-scripts to fix build issue (#1413) (ee2f7af)

3.14.2 (2025-05-29)​

Bug Fixes​

  • expose TS types internal to the data engine (#1412) (9803646)

3.14.1 (2025-03-17)​

Bug Fixes​

3.14.0 (2025-02-25)

Features​

3.13.2 (2025-02-11)​

Bug Fixes​

  • plugin: avoid sending prop updates when height and width values change (#1406) (d263c25)

3.13.1 (2025-02-04)​

Bug Fixes​

  • plugin: don't send prop update when changing plugin source (#1404) (3ae0295)

3.13.0 (2025-01-23)

Features​

3.12.1 (2025-01-16)​

Bug Fixes​

  • reference module types in package.json export declaration (#1400) (c266429)

3.12.0 (2024-12-04)

Bug Fixes​

  • cacheable-section: synchronously flush recording state for UI consistency (#1394) (50d216c)
  • deps: remove cli-app-scripts peer dep (7764439)
  • deps: update cli-app-scripts for package/types race condition (7980364)

Features​

3.12.0-alpha.2 (2024-12-03)

Features​

3.12.0-alpha.1 (2024-11-27)

Bug Fixes​

  • cacheable-section: synchronously flush recording state for UI consistency (#1394) (50d216c)
  • deps: remove cli-app-scripts peer dep (7764439)
  • deps: update cli-app-scripts for package/types race condition (7980364)

Features​

  • upgrade app-runtime React version to v18 (#1387) (0e4a3d5)

3.11.3 (2024-11-19)​

Bug Fixes​

3.11.2 (2024-10-14)​

Bug Fixes​

3.11.1 (2024-10-09)​

Bug Fixes​

  • handle alert returned async by parentAlertsAdd [LIBS-695] (#1388) (9c989b2)

3.11.0 (2024-09-10)

Features​

3.10.6 (2024-07-26)​

Bug Fixes​

  • cacheable-section: stable references to avoid loops [LIBS-642] (#1385) (e3a5fbf)

3.10.5 (2024-06-24)​

Bug Fixes​

3.10.4 (2024-04-09)​

Bug Fixes​

  • deps: remove cli-app-scripts peer dep [LIBS-587] (#1379) (3598375)

3.10.3 (2024-03-20)​

Bug Fixes​

3.10.2 (2024-01-04)​

Bug Fixes​

Features​

  • release experimental plugin wrappers [LIBS-397] [skip release] (#1366) (7895bb9)

3.11.0-alpha.1 (2023-12-21)

Bug Fixes​

  • add back plugin service dependency [LIBS-583] (ca10691)
  • add back plugin service dependency [LIBS-583] (6d43ae3)
  • add documentation, clean up (c537590)
  • add in plugin service in runtime package (#1343) (ed06a9f)
  • add width to plugin documentation [LIBS-487] (b2c6273)
  • check memomized props for postMessage communication [LIBS-514] (b1a3a0a)
  • clean up (e53ecbd)
  • clean up, add useless test (b14952b)
  • custom error handling (c72fc6e)
  • dependency array (03ce64f)
  • dependency resolution (2480c1c)
  • merge issues (496472a)
  • move eslint disable line (48912d7)
  • plugin experimental docs (be215b2)
  • prevent sending updated props to plugin when props do not change [LIBS-514] (86c6f75)
  • reset communication on either pluginSource or pluginShortName change (3fdae5b)
  • temporarily disable failing test (6664199)
  • trigger props resend when iframe src changes [LIBS-488] (f4a6680)
  • trigger props resend when iframe src changes [LIBS-488] #1344 (cea7600)
  • type error (9c17206)
  • update alpha branch [skip release] (ccb793c)
  • working autorsize width (2991045)

Features​

  • add autoresizing for height (dbb6e26)
  • experimental plugin release (f5cca86)
  • ideas for plugin wrappers [LIBS-397] (be38607)
  • implement plugin wrappers (alpha) (#1332) (56a9a3f)
  • plugin experimental export (25f02a6)
  • plugin wrappers, errors + alerts (bda6a43)
  • update plugin wrappers (30c963c)

3.10.0-alpha.8 (2023-12-20)

Bug Fixes​

  • plugin experimental docs (be215b2)

Features​

  • experimental plugin release (f5cca86)
  • plugin experimental export (25f02a6)

3.10.0-alpha.7 (2023-12-20)

Bug Fixes​

  • check memomized props for postMessage communication [LIBS-514] (b1a3a0a)
  • dependency array (03ce64f)
  • move eslint disable line (48912d7)
  • prevent sending updated props to plugin when props do not change [LIBS-514] (86c6f75)
  • type error (9c17206)

3.10.0-alpha.6 (2023-10-09)

Bug Fixes​

  • add back plugin service dependency [LIBS-583] (ca10691)
  • add back plugin service dependency [LIBS-583] (6d43ae3)

3.10.0-alpha.5 (2023-09-28)

Bug Fixes​

  • merge issues (496472a)
  • reset communication on either pluginSource or pluginShortName change (3fdae5b)
  • trigger props resend when iframe src changes [LIBS-488] (f4a6680)
  • trigger props resend when iframe src changes [LIBS-488] #1344 (cea7600)

3.10.0-alpha.2 (2023-03-15)

Bug Fixes​

  • add in plugin service in runtime package (#1343) (ed06a9f)

3.10.0-alpha.4 (2023-09-28)

Bug Fixes​

  • add width to plugin documentation [LIBS-487] (b2c6273)
  • clean up (e53ecbd)
  • temporarily disable failing test (6664199)
  • working autorsize width (2991045)

Features​

  • add autoresizing for height (dbb6e26)

3.10.0-alpha.3 (2023-08-22)

Bug Fixes​

  • connection-status: responsiveness to online events [LIBS-497] (#1348) (91a3d4d)
  • types: add generic result type to oncomplete param (#1350) (a069603)
  • [DHIS2] Type generic T = QueryResult to useDataQuery (#1297) (7c5c083)
  • account for daylight savings time [LIBS-490] (06eaa5d)
  • account for daylight savings time [LIBS-490] #1345 (fb00533)
  • add test for when time zones are the same [LIBS-490] (7911f8b)

3.9.4 (2023-06-19)​

Bug Fixes​

  • types: add generic result type to oncomplete param (#1350) (a069603)

3.9.3 (2023-05-16)​

Bug Fixes​

  • add documentation, clean up (c537590)
  • clean up, add useless test (b14952b)
  • custom error handling (c72fc6e)
  • dependency resolution (2480c1c)

Features​

  • ideas for plugin wrappers [LIBS-397] (be38607)
  • implement plugin wrappers (alpha) (#1332) (56a9a3f)
  • plugin wrappers, errors + alerts (bda6a43)
  • update plugin wrappers (30c963c)
  • connection-status: responsiveness to online events [LIBS-497] (#1348) (91a3d4d)

3.9.2 (2023-05-02)​

Bug Fixes​

  • [DHIS2] Type generic T = QueryResult to useDataQuery (#1297) (7c5c083)

3.9.1 (2023-04-11)​

Bug Fixes​

  • account for daylight savings time [LIBS-490] (06eaa5d)
  • account for daylight savings time [LIBS-490] #1345 (fb00533)
  • add test for when time zones are the same [LIBS-490] (7911f8b)

3.9.0 (2023-03-02)

Features​

3.8.0 (2023-01-19)

Features​

  • add hook to adjust for server time [LIBS-396] (#1308) (d511303)

3.7.0 (2022-11-17)

Features​

  • fetch-error: expose fetch-error (bcb913c)

3.6.2 (2022-11-16)​

Bug Fixes​

  • send POST body to indicators/expression/description as text plain (#1286) (82d26d4)

3.6.1 (2022-10-24)​

Bug Fixes​

  • offline: clear SWR caches betwen users [LIBS-358] (#1268) (fc0d143)

3.6.0 (2022-10-19)

Features​

3.5.0 (2022-10-06)

Features​

  • extended config type to include app name, version, and version strings (#1252) (4170674)

3.4.4 (2022-06-08)​

Bug Fixes​

  • data-service: application/x-www-form-urlencoded for svg conversion (5e2818c)

3.4.3 (2022-04-06)​

Bug Fixes​

  • use unversioned api endpoint for tracker sub-resources (#1158) (1af1ca7)

3.4.2 (2022-04-05)​

Bug Fixes​

  • ensure refetch function has stable identity (9fc3cb4)

3.4.1 (2022-03-22)​

Bug Fixes​

  • use unversioned api endpoint for tracker resource before 2.38 [LIBS-289] (#1144) (b696974)

3.4.0 (2022-03-15)

Features​

3.3.0 (2022-02-26)

Features​

3.2.9 (2022-02-08)​

Bug Fixes​

  • custom-data-link: allow falsey values for resources (#1112) (75f3528)

3.2.8 (2022-01-27)​

Bug Fixes​

  • match also eventVisualization in isCreateInterpretation (f630a78)

3.2.7 (2021-12-07)​

Bug Fixes​

  • use-data-query: prevent double request on refetch with new variables (#1086) (4f4663c)

3.2.6 (2021-11-23)​

Bug Fixes​

  • data-service: identify interpretation update requests correctly (38045a3)
  • data-service: identify interpretation update requests correctly (63d4ea2)

3.2.5 (2021-11-15)​

Bug Fixes​

  • use-data-query: memoize refetch function (1b7a42f)

3.2.4 (2021-10-20)​

Bug Fixes​

  • offline-provider: avoid side-effects if PWA is disabled (b56e9a4)

3.2.3 (2021-10-07)​

Bug Fixes​

  • offline: remove offlineInterface.init() functionality (01c4c49)

3.2.2 (2021-09-28)​

Bug Fixes​

  • offline-interface: improve SW update message (d2f4631)

3.2.1 (2021-09-27)​

Bug Fixes​

  • clear-caches: allow caches.keys to fail (885ff81)

3.2.0 (2021-09-17)

Bug Fixes​

  • offline: return correct value from clearSensitiveCaches (#1008) (4b68b22)

Features​

  • offline: add 'clear sensitive caches' function (01749aa)

3.1.0 (2021-09-13)

Features​

  • alerts-service: let useAlert return a hide function (LIBS-114) (3436312)

3.0.0 (2021-09-07)

Features​

  • custom-data-provider: include react-query provider in custom-data-provider (99ff732)
  • use-data-query: use react-query to cache and deduplicate queries (87fdcd8)

BREAKING CHANGES​

  • use-data-query: loading will only be set to true when fetching and if there is no data. If there is data, loading will be false during fetching. This means that stale data will be shown during fetches by default. If you'd like to opt out of showing stale data during loading you can use the new fetching attribute that is now returned by the useDataQuery hook instead.
  • use-data-query: If you're using cli-app-scripts, these changes need @dhis2/cli-app-scripts version 7.1.1 or above. Since this is an optional peer-dependency you'll need to ensure you're using the proper version.
  • use-data-query: The DataProvider is now a required parent for all components that use the useDataQuery hook. For apps that use the dhis2 app-platform this will be done automatically, but for libraries (and storybook testing) you'll have to do this manually.
  • use-data-query: The variables supplied to refetch are not allowed to contain circular references.
  • use-data-query: The data and error values will not be cleared during a refetch (this allows for the opt-in stale-while-revalidate). This means that logic that relies on data or error being cleared during a refetch will now behave differently. For example, placing an if condition that checks if there is an error before a condition that checks for loading will now keep showing the error during a refetch, instead of showing the loading spinner.
  • use-data-query: There have been issues reported where yarn v1 had trouble installing the correct babel dependencies. For the situations where that occured, deduplicating the yarn.lock resolved the issue.
  • use-data-query: There is a rare but unresolved issue where it's possible for the timing in tests to behave differently from the timing in apps. This happens for tests that expect loading to be set to true immediately after calling refetch. Changing such an assertion to an assertion that waits for loading to eventually be true, i.e. @testing-library/react's waitFor(), resolves this issue.

2.11.1 (2021-09-02)​

Bug Fixes​

2.11.0 (2021-08-31)

Features​

2.10.0 (2021-08-30)

Features​

  • track 'last online' time in localStorage (#974) (98d7cd3)

2.9.2 (2021-08-24)​

Bug Fixes​

  • online-status: handle debouncing across rerenders (#963) (e83bfd1)

2.9.1 (2021-08-16)​

Bug Fixes​

  • update useOnlineStatus debounce delay when options change (#960) (4f7c237)

2.9.0 (2021-08-13)

Features​

2.8.0 (2021-03-10)

Features​

  • warn in development mode when query is missing paging or explicit fields (#788) (5f28c79)

2.7.1 (2021-03-01)​

Bug Fixes​

  • support tree-shakable builds and upgrade dependencies (#780) (1b3ba1d)

2.7.0 (2021-01-28)

Bug Fixes​

  • fetch-data: improve regex for contentType text/* and test (7746543)

Features​

  • rest-api-link: parse response to JSON, text, or blob (d4028f2)
  • add support for svg conversion endpoint (61db63f)

2.6.1 (2020-11-12)​

Bug Fixes​

  • patch to fix missing package release (b190931)

2.6.0 (2020-11-12)

Bug Fixes​

  • alerts-service: adjust message type (58406e8)
  • alerts-service: adjust types for AlertContext and optional props (a5ad1f2)
  • alerts-service: any message to string (f24cc75)
  • alerts-service: bind id to remove (448a375)

Features​

2.5.1 (2020-11-11)​

Bug Fixes​

  • cut release to finish jira migration (8c030e5)

2.5.0 (2020-10-27)

Features​

  • rest-api-link: add support for text/plain and multipart/form-data (#651) (94e21ad)

2.4.0 (2020-10-12)

Features​

  • add explicit support for systemInfo and serverVersion config props (#652) (15b8344)

2.3.0 (2020-09-16)

Features​

  • add tabs, query persistance and ctrl/cmd+enter query execution (66ff1a5)

2.2.2 (2020-06-11)​

Bug Fixes​

  • support boolean values for query parameters (#582) (039e77e)

2.2.1 (2020-05-06)​

Bug Fixes​

  • declare services as runtime dependencies (76a55c7)

2.2.0 (2020-05-06)

Features​

  • build with app platform, publish independent services (#512) (70aa726)

2.1.2 (2020-04-22)​

Bug Fixes​

  • parsestatus: add response data to error (#510) (5c124db)

2.1.1 (2020-03-24)​

Bug Fixes​

  • expand array of filters to multiple filter querystring params (#462) (aee9993)

2.1.0 (2020-02-25)

Features​

  • support lazy query and mutation hook option (#412) (e9b73ca)

2.0.4 (2019-11-06)​

Bug Fixes​

  • stop infinite rerenders when prop identity changes (#253) [defer-release] (88f8333)
  • update loading and error state when manually aborting (#254) (68f717d)

2.0.3 (2019-10-21)​

Bug Fixes​

2.0.2 (2019-09-30)​

Bug Fixes​

2.0.1 (2019-09-24)​

Bug Fixes​

2.0.0 (2019-09-24)

BREAKING CHANGES​

  • mutations, dynamic queries, engine refactor (#127) (8677972), closes #115

1.5.1 (2019-08-25)​

Bug Fixes​

  • stop infinite rerenders by removing query from useEffect deps (#88) (ac9fa28)

1.5.0 (2019-08-15)

Bug Fixes​

  • don't silently ignore test failures, fix data reduce bug (95fd038)

Features​

  • support network request aborting and refetching (#34) (dcb4a70)

1.4.3 (2019-08-14)​

Bug Fixes​

  • support independent data provider, refactor example (#70) (7db27f6)

1.4.2 (2019-08-12)​

Bug Fixes​

  • update all babel deps to match latest (7.5.5) (#48) (1148d85)

1.4.1 (2019-08-08)​

Bug Fixes​

  • don't break app-runtime API, export DataProvider as well (#33) (14a33f0)

1.4.0 (2019-08-08)

Features​

  • expose application config as separate context (#13) (c9aa123)

1.3.0 (2019-07-09)

Features​

  • support action queries with prefixed resource names (#19) (c5c5dc7)

1.2.0 (2019-05-27)

Features​

  • support forever-loading CustomDataProvider (#11) (e80c7b7)

1.1.0 (2019-04-15)

Features​

  • rename MockProvider to CustomProvider and expose it (#8) (2411fbc)

1.0.0 (2019-04-09)

Features​

BREAKING CHANGES​

  • cut version 1.0

  • feat: update app-runtime exports, add readmes

  • docs: add root readme