@dhis2/app-service-data 3.11.3 → 3.12.0-alpha.2

package/build/es/react/hooks/useQueryExecutor.js

@@ -1,7 +1,7 @@
 import { useState, useCallback, useRef, useEffect } from 'react';
 import { FetchError } from '../../engine';
 import { useStaticInput } from './useStaticInput';
-export const useQueryExecutor = (_ref) => {
+export const useQueryExecutor = _ref => {
   let {
     execute,
     variables: initialVariables,
@@ -38,14 +38,13 @@ export const useQueryExecutor = (_ref) => {
       called: true,
       loading: true
     } : state);
-
     if (singular) {
       abort(); // Cleanup any in-progress fetches
     }
-
     const controller = new AbortController();
     abortControllersRef.current.push(controller);
-    variables.current = { ...variables.current,
+    variables.current = {
+      ...variables.current,
       ...newVariables
     };
     const options = {
@@ -63,7 +62,6 @@ export const useQueryExecutor = (_ref) => {
         });
         return data;
       }
-
       return new Promise(() => undefined); // Wait forever
     }).catch(error => {
       if (!controller.signal.aborted) {
@@ -73,17 +71,16 @@ export const useQueryExecutor = (_ref) => {
           error
         });
       }
-
       return new Promise(() => undefined); // Don't throw errors in refetch promises, wait forever
     });
-  }, [abort, onComplete, onError, singular, theExecute]); // Don't include immediate or refetch as deps, otherwise unintentional refetches
-  // may be triggered by changes to input, i.e. recreating the onComplete callback
+  }, [abort, onComplete, onError, singular, theExecute]);
 
+  // Don't include immediate or refetch as deps, otherwise unintentional refetches
+  // may be triggered by changes to input, i.e. recreating the onComplete callback
   useEffect(() => {
     if (immediate) {
       refetch();
     }
-
     return abort;
   }, []); // eslint-disable-line react-hooks/exhaustive-deps
 

package/build/es/react/hooks/useQueryExecutor.test.js

@@ -1,8 +1,8 @@
-import { renderHook, act } from '@testing-library/react-hooks';
+import { renderHook, act, waitFor } from '@testing-library/react';
 import { useQueryExecutor } from './useQueryExecutor';
 const testError = new Error('TEST ERROR');
 let theSignal;
-const execute = jest.fn(async (_ref) => {
+const execute = jest.fn(async _ref => {
   let {
     signal
   } = _ref;
@@ -33,8 +33,7 @@ describe('useQueryExecutor', () => {
   });
   it('When immediate, should start with called true and loading true', async () => {
     const {
-      result,
-      waitForNextUpdate
+      result
     } = renderHook(() => useQueryExecutor({
       execute,
       immediate: true,
@@ -45,17 +44,17 @@ describe('useQueryExecutor', () => {
       called: true,
       loading: true
     });
-    await waitForNextUpdate();
-    expect(result.current).toMatchObject({
-      called: true,
-      loading: false,
-      data: 42
+    await waitFor(() => {
+      expect(result.current).toMatchObject({
+        called: true,
+        loading: false,
+        data: 42
+      });
     });
   });
   it('Should start when refetch called (if not immediate)', async () => {
     const {
-      result,
-      waitForNextUpdate
+      result
     } = renderHook(() => useQueryExecutor({
       execute,
       immediate: false,
@@ -73,17 +72,17 @@ describe('useQueryExecutor', () => {
       called: true,
       loading: true
     });
-    await waitForNextUpdate();
-    expect(result.current).toMatchObject({
-      called: true,
-      loading: false,
-      data: 42
+    await waitFor(() => {
+      expect(result.current).toMatchObject({
+        called: true,
+        loading: false,
+        data: 42
+      });
     });
   });
   it('Should report an error when execute fails', async () => {
     const {
-      result,
-      waitForNextUpdate
+      result
     } = renderHook(() => useQueryExecutor({
       execute: failingExecute,
       immediate: false,
@@ -101,19 +100,19 @@ describe('useQueryExecutor', () => {
       called: true,
       loading: true
     });
-    await waitForNextUpdate();
-    expect(result.current).toMatchObject({
-      called: true,
-      loading: false,
-      error: testError
+    await waitFor(() => {
+      expect(result.current).toMatchObject({
+        called: true,
+        loading: false,
+        error: testError
+      });
     });
   });
   it("Shouldn't abort+refetch when inputs change on subsequent renders", async () => {
     const {
       result,
-      waitForNextUpdate,
       rerender
-    } = renderHook((_ref2) => {
+    } = renderHook(_ref2 => {
       let {
         onComplete
       } = _ref2;
@@ -136,19 +135,19 @@ describe('useQueryExecutor', () => {
     rerender({
       onComplete: () => null
     });
-    await waitForNextUpdate();
-    expect(result.current).toMatchObject({
-      called: true,
-      loading: false,
-      data: 42
+    await waitFor(() => {
+      expect(result.current).toMatchObject({
+        called: true,
+        loading: false,
+        data: 42
+      });
+      expect(theSignal && theSignal.aborted).toBe(false);
+      expect(execute).toHaveBeenCalledTimes(1);
     });
-    expect(theSignal && theSignal.aborted).toBe(false);
-    expect(execute).toHaveBeenCalledTimes(1);
   });
   it('Should respect abort signal', async () => {
     const {
-      result,
-      waitForNextUpdate
+      result
     } = renderHook(() => useQueryExecutor({
       execute,
       immediate: false,

package/build/es/react/hooks/useStaticInput.test.js

@@ -1,4 +1,4 @@
-import { renderHook, act } from '@testing-library/react-hooks';
+import { renderHook, act } from '@testing-library/react';
 import { useStaticInput } from './useStaticInput';
 describe('useStaticInput', () => {
   const originalWarn = console.warn;
@@ -19,7 +19,7 @@ describe('useStaticInput', () => {
     const {
       result,
       rerender
-    } = renderHook((_ref) => {
+    } = renderHook(_ref => {
       let {
         value
       } = _ref;
@@ -40,7 +40,7 @@ describe('useStaticInput', () => {
     const {
       result,
       rerender
-    } = renderHook((_ref2) => {
+    } = renderHook(_ref2 => {
       let {
         value
       } = _ref2;
@@ -68,7 +68,7 @@ describe('useStaticInput', () => {
     const {
       result,
       rerender
-    } = renderHook((_ref3) => {
+    } = renderHook(_ref3 => {
       let {
         value
       } = _ref3;
@@ -93,7 +93,7 @@ describe('useStaticInput', () => {
     const {
       result,
       rerender
-    } = renderHook((_ref4) => {
+    } = renderHook(_ref4 => {
       let {
         value
       } = _ref4;
@@ -129,7 +129,7 @@ describe('useStaticInput', () => {
     const {
       result,
       rerender
-    } = renderHook((_ref5) => {
+    } = renderHook(_ref5 => {
       let {
         value
       } = _ref5;

package/build/es/setupRTL.js

@@ -1,4 +1,4 @@
-import '@testing-library/jest-dom/extend-expect';
+import '@testing-library/jest-dom';
 process.on('unhandledRejection', err => {
   throw err;
 });

package/build/types/engine/types/ExecuteOptions.d.ts

@@ -1,6 +1,6 @@
 import { FetchError } from './FetchError';
 import { QueryVariables } from './Query';
-export declare type FetchType = 'create' | 'read' | 'update' | 'json-patch' | 'replace' | 'delete';
+export type FetchType = 'create' | 'read' | 'update' | 'json-patch' | 'replace' | 'delete';
 export interface QueryExecuteOptions {
     variables?: QueryVariables;
     signal?: AbortSignal;

package/build/types/engine/types/FetchError.d.ts

@@ -1,5 +1,5 @@
-export declare type FetchErrorTypeName = 'network' | 'unknown' | 'access' | 'aborted';
-export declare type FetchErrorDetails = {
+export type FetchErrorTypeName = 'network' | 'unknown' | 'access' | 'aborted';
+export type FetchErrorDetails = {
     httpStatus?: string;
     httpStatusCode?: number;
     status?: string;

package/build/types/engine/types/JsonValue.d.ts

@@ -1,4 +1,4 @@
-export declare type JsonValue = boolean | number | string | null | JsonArray | JsonMap;
+export type JsonValue = boolean | number | string | null | JsonArray | JsonMap;
 export interface JsonMap {
     [key: string]: JsonValue;
 }

package/build/types/engine/types/Mutation.d.ts

@@ -1,6 +1,6 @@
 import { FetchError } from './FetchError';
 import { ResourceQuery, QueryVariables } from './Query';
-export declare type MutationType = 'create' | 'update' | 'json-patch' | 'replace' | 'delete';
+export type MutationType = 'create' | 'update' | 'json-patch' | 'replace' | 'delete';
 export interface MutationData {
     [key: string]: any;
 }
@@ -21,7 +21,7 @@ export interface DeleteMutation extends BaseMutation {
     type: 'delete';
     id: string;
 }
-export declare type Mutation = CreateMutation | UpdateMutation | DeleteMutation;
+export type Mutation = CreateMutation | UpdateMutation | DeleteMutation;
 export interface MutationOptions {
     variables?: QueryVariables;
     onError?: (error: FetchError) => any;

package/build/types/engine/types/PossiblyDynamic.d.ts

@@ -1 +1 @@
-export declare type PossiblyDynamic<Type, InputType> = Type | ((input: InputType) => Type);
+export type PossiblyDynamic<Type, InputType> = Type | ((input: InputType) => Type);

package/build/types/engine/types/Query.d.ts

@@ -2,7 +2,7 @@ import { FetchError } from './FetchError';
 import { JsonMap } from './JsonValue';
 import { PossiblyDynamic } from './PossiblyDynamic';
 import { QueryParameters } from './QueryParameters';
-export declare type QueryVariables = Record<string, any>;
+export type QueryVariables = Record<string, any>;
 export interface ResourceQuery {
     resource: string;
     id?: PossiblyDynamic<string, QueryVariables>;
@@ -14,8 +14,8 @@ export interface ResolvedResourceQuery extends ResourceQuery {
     data?: any;
     params?: QueryParameters;
 }
-export declare type Query = Record<string, ResourceQuery>;
-export declare type QueryResult = JsonMap;
+export type Query = Record<string, ResourceQuery>;
+export type QueryResult = JsonMap;
 export interface QueryOptions<TQueryResult = QueryResult> {
     variables?: QueryVariables;
     onComplete?: (data: TQueryResult) => void;

package/build/types/engine/types/QueryParameters.d.ts

@@ -1,10 +1,10 @@
-declare type QueryParameterSingularValue = string | number | boolean;
+type QueryParameterSingularValue = string | number | boolean;
 interface QueryParameterAliasedValue {
     [name: string]: QueryParameterSingularValue;
 }
-declare type QueryParameterSingularOrAliasedValue = QueryParameterSingularValue | QueryParameterAliasedValue;
-declare type QueryParameterMultipleValue = QueryParameterSingularOrAliasedValue[];
-export declare type QueryParameterValue = QueryParameterSingularValue | QueryParameterAliasedValue | QueryParameterMultipleValue | undefined;
+type QueryParameterSingularOrAliasedValue = QueryParameterSingularValue | QueryParameterAliasedValue;
+type QueryParameterMultipleValue = QueryParameterSingularOrAliasedValue[];
+export type QueryParameterValue = QueryParameterSingularValue | QueryParameterAliasedValue | QueryParameterMultipleValue | undefined;
 export interface QueryParameters {
     pageSize?: number;
     [key: string]: QueryParameterValue;

package/build/types/links/CustomDataLink.d.ts

@@ -1,6 +1,6 @@
 import { DataEngineLink, DataEngineLinkExecuteOptions, FetchType, JsonValue, ResolvedResourceQuery } from '../engine';
-export declare type CustomResourceFactory = (type: FetchType, query: ResolvedResourceQuery, options?: DataEngineLinkExecuteOptions) => Promise<JsonValue | undefined>;
-export declare type CustomResource = JsonValue | CustomResourceFactory;
+export type CustomResourceFactory = (type: FetchType, query: ResolvedResourceQuery, options?: DataEngineLinkExecuteOptions) => Promise<JsonValue | undefined>;
+export type CustomResource = JsonValue | CustomResourceFactory;
 export interface CustomData {
     [resourceName: string]: CustomResource;
 }

package/build/types/links/RestAPILink/queryToRequestOptions/requestContentType.d.ts

@@ -1,5 +1,5 @@
 import { ResolvedResourceQuery, FetchType } from '../../../engine';
-declare type RequestContentType = 'application/json' | 'application/json-patch+json' | 'text/plain' | 'multipart/form-data' | 'application/x-www-form-urlencoded' | null;
+type RequestContentType = 'application/json' | 'application/json-patch+json' | 'text/plain' | 'multipart/form-data' | 'application/x-www-form-urlencoded' | null;
 export declare const requestContentType: (type: FetchType, query: ResolvedResourceQuery) => null | RequestContentType;
 export declare const requestHeadersForContentType: (contentType: RequestContentType) => undefined | Record<'Content-Type', string>;
 export declare const requestBodyForContentType: (contentType: RequestContentType, { data }: ResolvedResourceQuery) => undefined | string | FormData | URLSearchParams;

package/build/types/links/RestAPILink/queryToRequestOptions.d.ts

@@ -1,2 +1,2 @@
 import { ResolvedResourceQuery, FetchType } from '../../engine';
-export declare const queryToRequestOptions: (type: FetchType, query: ResolvedResourceQuery, signal?: AbortSignal | undefined) => RequestInit;
+export declare const queryToRequestOptions: (type: FetchType, query: ResolvedResourceQuery, signal?: AbortSignal) => RequestInit;

package/build/types/react/components/DataProvider.d.ts

@@ -1,18 +1,9 @@
+import { type QueryClientConfig } from '@tanstack/react-query';
 import React from 'react';
 export interface ProviderInput {
     baseUrl?: string;
     apiVersion?: number;
     children: React.ReactNode;
 }
-export declare const queryClientOptions: {
-    defaultOptions: {
-        queries: {
-            retry: boolean;
-            retryOnMount: boolean;
-            refetchOnMount: boolean;
-            refetchOnWindowFocus: boolean;
-            refetchOnReconnect: boolean;
-        };
-    };
-};
+export declare const queryClientOptions: QueryClientConfig;
 export declare const DataProvider: (props: ProviderInput) => JSX.Element;

package/build/types/react/hooks/mergeAndCompareVariables.d.ts

@@ -1,5 +1,5 @@
 import type { QueryVariables } from '../../engine';
-export declare const mergeAndCompareVariables: (previousVariables?: QueryVariables | undefined, newVariables?: QueryVariables | undefined, previousHash?: string | undefined) => {
+export declare const mergeAndCompareVariables: (previousVariables?: QueryVariables, newVariables?: QueryVariables, previousHash?: string) => {
     identical: boolean;
     mergedVariablesHash: string | undefined;
     mergedVariables: QueryVariables | undefined;

package/build/types/types.d.ts

@@ -10,11 +10,11 @@ export interface ContextInput {
     baseUrl: string;
     apiVersion: number;
 }
-export declare type RefetchOptions = QueryVariables;
-export declare type RefetchFunction<ReturnType> = (options?: RefetchOptions) => Promise<ReturnType>;
-export declare type QueryRefetchFunction = RefetchFunction<QueryResult>;
-export declare type MutationFunction = RefetchFunction<JsonValue>;
-export declare type ExecuteFunction<T> = (options: QueryExecuteOptions) => Promise<T>;
+export type RefetchOptions = QueryVariables;
+export type RefetchFunction<ReturnType> = (options?: RefetchOptions) => Promise<ReturnType>;
+export type QueryRefetchFunction = RefetchFunction<QueryResult>;
+export type MutationFunction = RefetchFunction<JsonValue>;
+export type ExecuteFunction<T> = (options: QueryExecuteOptions) => Promise<T>;
 export interface ExecuteHookInput<ReturnType> {
     execute: ExecuteFunction<ReturnType>;
     variables: QueryVariables;
@@ -50,4 +50,4 @@ export interface MutationState {
     error?: FetchError;
     data?: JsonValue;
 }
-export declare type MutationRenderInput = [MutationFunction, MutationState];
+export type MutationRenderInput = [MutationFunction, MutationState];

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@dhis2/app-service-data",
-    "version": "3.11.3",
+    "version": "3.12.0-alpha.2",
     "main": "./build/cjs/index.js",
     "module": "./build/es/index.js",
     "types": "build/types/index.d.ts",
@@ -32,12 +32,12 @@
         "coverage": "yarn test --coverage"
     },
     "dependencies": {
-        "react-query": "^3.13.11"
+        "@tanstack/react-query": "^4.36.1"
     },
     "peerDependencies": {
-        "@dhis2/app-service-config": "3.11.3",
+        "@dhis2/app-service-config": "3.12.0-alpha.2",
         "prop-types": "^15.7.2",
-        "react": "^16.8",
-        "react-dom": "^16.8"
+        "react": "^16.8 || ^18",
+        "react-dom": "^16.8 || ^18"
     }
 }