@dhis2/app-service-data 3.2.7 → 3.3.0

package/build/es/links/RestAPILink/queryToRequestOptions/textPlainMatchers.js

@@ -23,7 +23,7 @@ export const isCreateFeedbackMessage = (type, {
 export const isCreateInterpretation = (type, {
   resource
 }) => {
-  const pattern = /^interpretations\/(?:reportTable|chart|visualization|map|eventReport|eventChart|dataSetReport)\/[a-zA-Z0-9]{11}$/;
+  const pattern = /^interpretations\/(?:reportTable|chart|visualization|map|eventVisualization|eventReport|eventChart|dataSetReport)\/[a-zA-Z0-9]{11}$/;
   return type === 'create' && pattern.test(resource);
 }; // PUT to `interpretations/${id}` (update an interpretation)
 

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

@@ -1,72 +1,337 @@
 import { renderHook, act } from '@testing-library/react-hooks';
-import React from 'react';
+import * as React from 'react';
 import { CustomDataProvider } from '../components/CustomDataProvider';
+import { useDataEngine } from './useDataEngine';
 import { useDataMutation } from './useDataMutation';
-const customData = {
-  answer: 42
-};
-
-const wrapper = ({
-  children
-}) => /*#__PURE__*/React.createElement(CustomDataProvider, {
-  data: customData
-}, children);
-
-const mutation = {
-  type: 'create',
-  resource: 'answer',
-  data: {
-    answer: 42
-  }
-};
-describe('useDataMustation', () => {
-  const originalError = console.error;
-  afterEach(() => {
-    console.error = originalError;
+describe('useDataMutation', () => {
+  it('should render without failing', async () => {
+    const mutation = {
+      type: 'create',
+      resource: 'answer',
+      data: {
+        answer: '?'
+      }
+    };
+    const data = {
+      answer: 42
+    };
+
+    const wrapper = ({
+      children
+    }) => /*#__PURE__*/React.createElement(CustomDataProvider, {
+      data: data
+    }, children);
+
+    const {
+      result,
+      waitFor
+    } = renderHook(() => useDataMutation(mutation), {
+      wrapper
+    });
+    const [mutate, beforeMutation] = result.current;
+    expect(beforeMutation).toMatchObject({
+      loading: false,
+      called: false
+    });
+    act(() => {
+      mutate();
+    });
+    await waitFor(() => {
+      const [, duringMutation] = result.current;
+      expect(duringMutation).toMatchObject({
+        loading: true,
+        called: true
+      });
+    });
+    await waitFor(() => {
+      const [, afterMutation] = result.current;
+      expect(afterMutation).toMatchObject({
+        loading: false,
+        called: true,
+        data: 42
+      });
+    });
+  });
+  it('should run immediately with lazy: false', async () => {
+    const mutation = {
+      type: 'create',
+      resource: 'answer',
+      data: {
+        answer: '?'
+      }
+    };
+    const data = {
+      answer: 42
+    };
+
+    const wrapper = ({
+      children
+    }) => /*#__PURE__*/React.createElement(CustomDataProvider, {
+      data: data
+    }, children);
+
+    const {
+      result,
+      waitFor
+    } = renderHook(() => useDataMutation(mutation, {
+      lazy: false
+    }), {
+      wrapper
+    });
+    const [, duringMutation] = result.current;
+    expect(duringMutation).toMatchObject({
+      loading: true,
+      called: true
+    });
+    await waitFor(() => {
+      const [, afterMutation] = result.current;
+      expect(afterMutation).toMatchObject({
+        loading: false,
+        called: true,
+        data: 42
+      });
+    });
   });
-  it('Should render without failing', async () => {
-    let hookState;
-    console.error = jest.fn();
+  it('should call onComplete on success', async () => {
+    const onComplete = jest.fn();
+    const mutation = {
+      type: 'create',
+      resource: 'answer',
+      data: {
+        answer: '?'
+      }
+    };
+    const data = {
+      answer: 42
+    };
+
+    const wrapper = ({
+      children
+    }) => /*#__PURE__*/React.createElement(CustomDataProvider, {
+      data: data
+    }, children);
+
+    const {
+      result,
+      waitFor
+    } = renderHook(() => useDataMutation(mutation, {
+      onComplete
+    }), {
+      wrapper
+    });
+    expect(onComplete).toHaveBeenCalledTimes(0);
+    const [mutate] = result.current;
     act(() => {
-      hookState = renderHook(() => useDataMutation(mutation), {
-        wrapper
+      mutate();
+    });
+    await waitFor(() => {
+      const [, state] = result.current;
+      expect(state).toMatchObject({
+        loading: false,
+        called: true,
+        data: 42
       });
+      expect(onComplete).toHaveBeenCalledTimes(1);
+      expect(onComplete).toHaveBeenLastCalledWith(42);
     });
-    let [mutate, state] = hookState.result.current;
-    expect(state).toMatchObject({
-      called: false,
-      loading: false
+  });
+  it('should call onError on error', async () => {
+    const error = new Error('Something went wrong');
+    const onError = jest.fn();
+    const mutation = {
+      type: 'create',
+      resource: 'answer',
+      data: {
+        answer: 42
+      }
+    };
+    const data = {
+      answer: () => {
+        throw error;
+      }
+    };
+
+    const wrapper = ({
+      children
+    }) => /*#__PURE__*/React.createElement(CustomDataProvider, {
+      data: data
+    }, children);
+
+    const {
+      result,
+      waitFor
+    } = renderHook(() => useDataMutation(mutation, {
+      onError
+    }), {
+      wrapper
     });
+    expect(onError).toHaveBeenCalledTimes(0);
+    const [mutate] = result.current;
     act(() => {
       mutate();
     });
-    mutate = hookState.result.current[0];
-    state = hookState.result.current[1];
-    expect(state).toMatchObject({
-      called: true,
-      loading: true
+    await waitFor(() => {
+      const [, state] = result.current;
+      expect(state).toMatchObject({
+        loading: false,
+        called: true,
+        error
+      });
     });
+    expect(onError).toHaveBeenCalledTimes(1);
+    expect(onError).toHaveBeenLastCalledWith(error);
   });
-  it('Should run immediately with lazy: false', async () => {
-    let hookState;
-    console.error = jest.fn();
+  it('should resolve variables', async () => {
+    const mutation = {
+      type: 'update',
+      resource: 'answer',
+      id: ({
+        id
+      }) => id,
+      data: {
+        answer: '?'
+      }
+    };
+    const answerSpy = jest.fn(() => 42);
+    const data = {
+      answer: answerSpy
+    };
+
+    const wrapper = ({
+      children
+    }) => /*#__PURE__*/React.createElement(CustomDataProvider, {
+      data: data
+    }, children);
+
+    const {
+      result,
+      waitFor
+    } = renderHook(() => useDataMutation(mutation, {
+      lazy: false,
+      variables: {
+        id: '1'
+      }
+    }), {
+      wrapper
+    });
+    await waitFor(() => {
+      expect(answerSpy).toHaveBeenLastCalledWith(expect.any(String), expect.objectContaining({
+        id: '1'
+      }), expect.any(Object));
+    });
+    const [mutate] = result.current;
     act(() => {
-      hookState = renderHook(() => useDataMutation(mutation, {
-        lazy: false
-      }), {
-        wrapper
+      mutate({
+        id: '2'
       });
     });
-    let [, state] = hookState.result.current;
-    expect(state).toMatchObject({
-      called: true,
-      loading: true
+    await waitFor(() => {
+      expect(answerSpy).toHaveBeenLastCalledWith(expect.any(String), expect.objectContaining({
+        id: '2'
+      }), expect.any(Object));
     });
-    await hookState.waitForNextUpdate();
-    state = hookState.result.current[1];
+  });
+  it('should return a reference to the engine', async () => {
+    const mutation = {
+      type: 'create',
+      resource: 'answer',
+      data: {
+        answer: '?'
+      }
+    };
+
+    const wrapper = ({
+      children
+    }) => /*#__PURE__*/React.createElement(CustomDataProvider, {
+      data: {}
+    }, children);
+
+    const engineHook = renderHook(() => useDataEngine(), {
+      wrapper
+    });
+    const mutationHook = renderHook(() => useDataMutation(mutation), {
+      wrapper
+    });
+    /**
+     * Ideally we'd check referential equality here with .toBe, but since
+     * both hooks run in a different context that doesn't work.
+     */
+
+    expect(mutationHook.result.current[1].engine).toStrictEqual(engineHook.result.current);
+  });
+  it('should return a stable mutate function', async () => {
+    const mutation = {
+      type: 'create',
+      resource: 'answer',
+      data: {
+        answer: '?'
+      }
+    };
+    const data = {
+      answer: 42
+    };
+
+    const wrapper = ({
+      children
+    }) => /*#__PURE__*/React.createElement(CustomDataProvider, {
+      data: data
+    }, children);
+
+    const {
+      result
+    } = renderHook(() => useDataMutation(mutation), {
+      wrapper
+    });
+    const [firstMutate] = result.current;
+    await act(async () => {
+      await firstMutate({
+        variable: 'variable'
+      });
+    });
+    const [secondMutate, state] = result.current;
     expect(state).toMatchObject({
       loading: false,
-      data: 42
+      called: true
+    });
+    expect(firstMutate).toBe(secondMutate);
+  });
+  it('should resolve with the data from mutate on success', async () => {
+    const mutation = {
+      type: 'create',
+      resource: 'answer',
+      data: {
+        answer: '?'
+      }
+    };
+    const data = {
+      answer: 42
+    };
+
+    const wrapper = ({
+      children
+    }) => /*#__PURE__*/React.createElement(CustomDataProvider, {
+      data: data
+    }, children);
+
+    const {
+      result,
+      waitFor
+    } = renderHook(() => useDataMutation(mutation), {
+      wrapper
+    });
+    let mutatePromise;
+    const [mutate] = result.current;
+    act(() => {
+      mutatePromise = mutate();
+    });
+    await waitFor(() => {
+      const [, state] = result.current;
+      expect(state).toMatchObject({
+        loading: false,
+        called: true,
+        data: 42
+      });
+      expect(mutatePromise).resolves.toBe(42);
     });
   });
 });

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

@@ -1,4 +1,5 @@
 import { ResolvedResourceQuery, FetchType } from '../../../engine';
+export declare const isDataValue: (type: FetchType, { resource }: ResolvedResourceQuery) => boolean;
 export declare const isFileResourceUpload: (type: FetchType, { resource }: ResolvedResourceQuery) => boolean;
 export declare const isMessageConversationAttachment: (type: FetchType, { resource }: ResolvedResourceQuery) => boolean;
 export declare const isStaticContentUpload: (type: FetchType, { resource }: ResolvedResourceQuery) => boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@dhis2/app-service-data",
-    "version": "3.2.7",
+    "version": "3.3.0",
     "main": "./build/cjs/index.js",
     "module": "./build/es/index.js",
     "types": "build/types/index.d.ts",
@@ -22,7 +22,7 @@
         "build/**"
     ],
     "peerDependencies": {
-        "@dhis2/app-service-config": "3.2.7",
+        "@dhis2/app-service-config": "3.3.0",
         "@dhis2/cli-app-scripts": "^7.1.1",
         "prop-types": "^15.7.2",
         "react": "^16.8",