@dhis2/app-service-data 3.16.0 → 3.17.0-beta.2

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

@@ -1,15 +1,14 @@
+import { FetchError } from '@dhis2/data-engine';
 import { useState, useCallback, useRef, useEffect } from 'react';
-import { FetchError } from '../../engine';
 import { useStaticInput } from './useStaticInput';
-export const useQueryExecutor = _ref => {
-  let {
-    execute,
-    variables: initialVariables,
-    singular,
-    immediate,
-    onComplete,
-    onError
-  } = _ref;
+export const useQueryExecutor = ({
+  execute,
+  variables: initialVariables,
+  singular,
+  immediate,
+  onComplete,
+  onError
+}) => {
   const [theExecute] = useStaticInput(execute);
   const [state, setState] = useState({
     called: !!immediate,
@@ -32,8 +31,7 @@ export const useQueryExecutor = _ref => {
       })
     }));
   }, [abort]);
-  const refetch = useCallback(function () {
-    let newVariables = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
+  const refetch = useCallback((newVariables = {}) => {
     setState(state => !state.called || !state.loading ? {
       called: true,
       loading: true

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

@@ -2,10 +2,9 @@ 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 => {
-  let {
-    signal
-  } = _ref;
+const execute = jest.fn(async ({
+  signal
+}) => {
   theSignal = signal;
   return 42;
 });
@@ -112,18 +111,15 @@ describe('useQueryExecutor', () => {
     const {
       result,
       rerender
-    } = renderHook(_ref2 => {
-      let {
-        onComplete
-      } = _ref2;
-      return useQueryExecutor({
-        execute,
-        immediate: true,
-        singular: true,
-        variables: {},
-        onComplete
-      });
-    }, {
+    } = renderHook(({
+      onComplete
+    }) => useQueryExecutor({
+      execute,
+      immediate: true,
+      singular: true,
+      variables: {},
+      onComplete
+    }), {
       initialProps: {
         onComplete: () => null
       }

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

@@ -1,9 +1,8 @@
 import { useState, useEffect, useRef, useDebugValue } from 'react';
-export const useStaticInput = function (staticValue) {
-  let {
-    warn = false,
-    name = 'input'
-  } = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
+export const useStaticInput = (staticValue, {
+  warn = false,
+  name = 'input'
+} = {}) => {
   const originalValue = useRef(staticValue);
   const [value, setValue] = useState(() => originalValue.current);
   useDebugValue(value, debugValue => `${name}: ${JSON.stringify(debugValue)}`);

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

@@ -19,12 +19,9 @@ describe('useStaticInput', () => {
     const {
       result,
       rerender
-    } = renderHook(_ref => {
-      let {
-        value
-      } = _ref;
-      return useStaticInput(value);
-    }, {
+    } = renderHook(({
+      value
+    }) => useStaticInput(value), {
       initialProps: {
         value: 42
       }
@@ -40,14 +37,11 @@ describe('useStaticInput', () => {
     const {
       result,
       rerender
-    } = renderHook(_ref2 => {
-      let {
-        value
-      } = _ref2;
-      return useStaticInput(value, {
-        warn: true
-      });
-    }, {
+    } = renderHook(({
+      value
+    }) => useStaticInput(value, {
+      warn: true
+    }), {
       initialProps: {
         value: 42
       }
@@ -68,15 +62,12 @@ describe('useStaticInput', () => {
     const {
       result,
       rerender
-    } = renderHook(_ref3 => {
-      let {
-        value
-      } = _ref3;
-      return useStaticInput(value, {
-        warn: true,
-        name: 'TESTING THING'
-      });
-    }, {
+    } = renderHook(({
+      value
+    }) => useStaticInput(value, {
+      warn: true,
+      name: 'TESTING THING'
+    }), {
       initialProps: {
         value: 42
       }
@@ -93,14 +84,11 @@ describe('useStaticInput', () => {
     const {
       result,
       rerender
-    } = renderHook(_ref4 => {
-      let {
-        value
-      } = _ref4;
-      return useStaticInput(value, {
-        warn: true
-      });
-    }, {
+    } = renderHook(({
+      value
+    }) => useStaticInput(value, {
+      warn: true
+    }), {
       initialProps: {
         value: 42
       }
@@ -129,14 +117,11 @@ describe('useStaticInput', () => {
     const {
       result,
       rerender
-    } = renderHook(_ref5 => {
-      let {
-        value
-      } = _ref5;
-      return useStaticInput(value, {
-        warn: true
-      });
-    }, {
+    } = renderHook(({
+      value
+    }) => useStaticInput(value, {
+      warn: true
+    }), {
       initialProps: {
         value: fn
       }

package/build/es/react/index.js

@@ -1,11 +1,3 @@
-export { CustomDataProvider } from './components/CustomDataProvider';
-export { DataMutation } from './components/DataMutation';
-export { DataProvider } from './components/DataProvider';
-export { DataQuery } from './components/DataQuery';
-export { DataContext } from './context/DataContext';
-export { defaultContext } from './context/defaultContext';
-export { useDataEngine } from './hooks/useDataEngine';
-export { useDataMutation } from './hooks/useDataMutation';
-export { useDataQuery } from './hooks/useDataQuery';
-export { useQueryExecutor } from './hooks/useQueryExecutor';
-export { useStaticInput } from './hooks/useStaticInput';
+export * from './components';
+export * from './hooks';
+export {};

package/build/types/index.d.ts

@@ -1,4 +1,3 @@
-export { DataQuery, DataMutation, DataProvider, CustomDataProvider, } from './react';
-export { useDataEngine, useDataQuery, useDataMutation } from './react';
-export { FetchError } from './engine';
+export * from './react';
+export { FetchError } from '@dhis2/data-engine';
 export type * from './types';

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

@@ -1,5 +1,5 @@
+import type { CustomData, CustomLinkOptions } from '@dhis2/data-engine';
 import React from 'react';
-import { CustomData, CustomLinkOptions } from '../../links';
 interface CustomProviderInput {
     children: React.ReactNode;
     data: CustomData;

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

@@ -1,4 +1,4 @@
-import { Mutation, MutationOptions } from '../../engine';
+import type { Mutation, MutationOptions } from '@dhis2/data-engine';
 import { MutationRenderInput } from '../../types';
 interface MutationInput extends MutationOptions {
     mutation: Mutation;

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

@@ -1,4 +1,4 @@
-import { Query, QueryOptions } from '../../engine';
+import type { Query, QueryOptions } from '@dhis2/data-engine';
 import { QueryRenderInput } from '../../types';
 interface QueryInput extends QueryOptions {
     query: Query;

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

@@ -0,0 +1,4 @@
+export { CustomDataProvider } from './CustomDataProvider';
+export { DataMutation } from './DataMutation';
+export { DataProvider } from './DataProvider';
+export { DataQuery } from './DataQuery';

package/build/types/react/context/defaultDataContext.d.ts

@@ -0,0 +1,4 @@
+import { DataEngine } from '@dhis2/data-engine';
+export declare const defaultDataContext: {
+    engine: DataEngine;
+};

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

@@ -0,0 +1,3 @@
+export { useDataEngine } from './useDataEngine';
+export { useDataMutation } from './useDataMutation';
+export { useDataQuery } from './useDataQuery';

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

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

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

@@ -1 +1 @@
-export declare const useDataEngine: () => import("../../engine").DataEngine;
+export declare const useDataEngine: () => import("@dhis2/data-engine").DataEngine;

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

@@ -1,3 +1,3 @@
-import { QueryOptions, Mutation } from '../../engine';
+import type { QueryOptions, Mutation } from '@dhis2/data-engine';
 import { MutationRenderInput } from '../../types';
 export declare const useDataMutation: (mutation: Mutation, { onComplete, onError, variables, lazy }?: QueryOptions) => MutationRenderInput;

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

@@ -1,3 +1,3 @@
-import type { Query, QueryOptions, QueryResult } from '../../engine';
+import type { Query, QueryOptions, QueryResult } from '@dhis2/data-engine';
 import type { QueryRenderInput } from '../../types';
 export declare const useDataQuery: <TQueryResult = QueryResult>(query: Query, { onComplete: userOnSuccess, onError: userOnError, variables: initialVariables, lazy: initialLazy, }?: QueryOptions<TQueryResult>) => QueryRenderInput<TQueryResult>;

package/build/types/react/index.d.ts

@@ -1,11 +1,2 @@
-export { CustomDataProvider } from './components/CustomDataProvider';
-export { DataMutation } from './components/DataMutation';
-export { DataProvider } from './components/DataProvider';
-export { DataQuery } from './components/DataQuery';
-export { DataContext } from './context/DataContext';
-export { defaultContext } from './context/defaultContext';
-export { useDataEngine } from './hooks/useDataEngine';
-export { useDataMutation } from './hooks/useDataMutation';
-export { useDataQuery } from './hooks/useDataQuery';
-export { useQueryExecutor } from './hooks/useQueryExecutor';
-export { useStaticInput } from './hooks/useStaticInput';
+export * from './components';
+export * from './hooks';

package/build/types/types.d.ts

@@ -1,10 +1,5 @@
-import DataEngine from './engine/DataEngine';
-import { QueryExecuteOptions } from './engine/types/ExecuteOptions';
-import { FetchError } from './engine/types/FetchError';
-import { JsonValue } from './engine/types/JsonValue';
-import { QueryVariables, QueryResult } from './engine/types/Query';
-export type { Mutation } from './engine/types/Mutation';
-export type { Query } from './engine/types/Query';
+import type { DataEngine, QueryExecuteOptions, FetchError, JsonValue, QueryVariables, QueryResult } from '@dhis2/data-engine';
+export type { Mutation, Query } from '@dhis2/data-engine';
 export interface ContextType {
     engine: DataEngine;
 }

package/package.json

@@ -1,9 +1,9 @@
 {
     "name": "@dhis2/app-service-data",
-    "version": "3.16.0",
+    "version": "3.17.0-beta.2",
     "main": "./build/cjs/index.js",
     "module": "./build/es/index.js",
-    "types": "build/types/index.d.ts",
+    "types": "./build/types/index.d.ts",
     "exports": {
         "import": "./build/es/index.js",
         "require": "./build/cjs/index.js",
@@ -37,7 +37,8 @@
         "prop-types": "^15.7.2"
     },
     "peerDependencies": {
-        "@dhis2/app-service-config": "3.16.0",
+        "@dhis2/app-service-config": "3.17.0-beta.2",
+        "@dhis2/data-engine": "3.17.0-beta.2",
         "react": "^16.8.6 || ^18",
         "react-dom": "^16.8.6 || ^18"
     }

package/build/cjs/engine/DataEngine.js

@@ -1,73 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = exports.DataEngine = void 0;
-var _getMutationFetchType = require("./helpers/getMutationFetchType");
-var _resolveDynamicQuery = require("./helpers/resolveDynamicQuery");
-var _validate = require("./helpers/validate");
-function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
-function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
-function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
-const reduceResponses = (responses, names) => responses.reduce((out, response, idx) => {
-  out[names[idx]] = response;
-  return out;
-}, {});
-class DataEngine {
-  constructor(link) {
-    _defineProperty(this, "link", void 0);
-    this.link = link;
-  }
-
-  // Overload 1: When no generic is provided, accept any Query and return inferred type
-
-  // Overload 2: When generic is provided, enforce that query keys match the generic keys
-
-  query(query) {
-    let {
-      variables = {},
-      signal,
-      onComplete,
-      onError
-    } = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
-    const names = Object.keys(query);
-    const queries = names.map(name => query[name]).map(q => (0, _resolveDynamicQuery.resolveDynamicQuery)(q, variables));
-    (0, _validate.validateResourceQueries)(queries, names);
-    return Promise.all(queries.map(q => {
-      return this.link.executeResourceQuery('read', q, {
-        signal
-      });
-    })).then(results => {
-      const data = reduceResponses(results, names);
-      onComplete && onComplete(data);
-      return data;
-    }).catch(error => {
-      onError && onError(error);
-      throw error;
-    });
-  }
-  mutate(mutation) {
-    let {
-      variables = {},
-      signal,
-      onComplete,
-      onError
-    } = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
-    const query = (0, _resolveDynamicQuery.resolveDynamicQuery)(mutation, variables);
-    const type = (0, _getMutationFetchType.getMutationFetchType)(mutation);
-    (0, _validate.validateResourceQuery)(type, query);
-    const result = this.link.executeResourceQuery(type, query, {
-      signal
-    });
-    return result.then(data => {
-      onComplete && onComplete(data);
-      return data;
-    }).catch(error => {
-      onError && onError(error);
-      throw error;
-    });
-  }
-}
-exports.DataEngine = DataEngine;
-var _default = exports.default = DataEngine;

package/build/cjs/engine/DataEngine.test.js

@@ -1,156 +0,0 @@
-"use strict";
-
-var _DataEngine = require("./DataEngine");
-const mockQuery = {
-  test: {
-    resource: 'test'
-  }
-};
-const mockMutation = {
-  resource: 'test',
-  type: 'create',
-  data: {}
-};
-const mockLink = {
-  executeResourceQuery: jest.fn(async (type, query) => {
-    if (query.resource === 'ERROR') {
-      throw new Error('MOCK ERROR');
-    }
-    return {
-      type,
-      resource: query.resource,
-      answer: 42
-    };
-  })
-};
-describe('DataEngine', () => {
-  beforeEach(() => {
-    jest.clearAllMocks();
-  });
-  it('Should construct successfully with a mock Link', () => {
-    expect(() => {
-      new _DataEngine.DataEngine(mockLink);
-    }).not.toThrow();
-  });
-  it('Should call the mock link with the passed query and options', () => {
-    const controller = new AbortController();
-    const engine = new _DataEngine.DataEngine(mockLink);
-    engine.query(mockQuery, {
-      signal: controller.signal
-    });
-    expect(mockLink.executeResourceQuery).toHaveBeenCalledWith('read', mockQuery.test, {
-      signal: controller.signal
-    });
-  });
-  it('Should call the mock link with the passed mutation and options', async () => {
-    const controller = new AbortController();
-    const engine = new _DataEngine.DataEngine(mockLink);
-    const result = await engine.mutate(mockMutation, {
-      signal: controller.signal
-    });
-    expect(mockLink.executeResourceQuery).toHaveBeenCalledWith(mockMutation.type, {
-      resource: mockMutation.resource,
-      data: {}
-    }, {
-      signal: controller.signal
-    });
-    expect(result).toMatchObject({
-      type: mockMutation.type,
-      resource: mockMutation.resource,
-      answer: 42
-    });
-  });
-  it('Should call multilple queries in parallel', async () => {
-    const engine = new _DataEngine.DataEngine(mockLink);
-    const result = await engine.query({
-      test: {
-        resource: 'test'
-      },
-      test2: {
-        resource: 'test2'
-      },
-      test3: {
-        resource: 'test3'
-      }
-    });
-    expect(mockLink.executeResourceQuery).toHaveBeenCalledTimes(3);
-    expect(result).toMatchObject({
-      test: {
-        type: 'read',
-        resource: 'test',
-        answer: 42
-      },
-      test2: {
-        type: 'read',
-        resource: 'test2',
-        answer: 42
-      },
-      test3: {
-        type: 'read',
-        resource: 'test3',
-        answer: 42
-      }
-    });
-  });
-  it('Should call onComplete callback only once for multiple-query method', async () => {
-    const options = {
-      onComplete: jest.fn()
-    };
-    const engine = new _DataEngine.DataEngine(mockLink);
-    await engine.query({
-      test: {
-        resource: 'test'
-      },
-      test2: {
-        resource: 'test2'
-      },
-      test3: {
-        resource: 'test3'
-      }
-    }, options);
-    expect(mockLink.executeResourceQuery).toHaveBeenCalledTimes(3);
-    expect(options.onComplete).toHaveBeenCalledTimes(1);
-  });
-  it('Should call onComplete callback only once for multiple-query method', async () => {
-    const options = {
-      onComplete: jest.fn(),
-      onError: jest.fn()
-    };
-    const engine = new _DataEngine.DataEngine(mockLink);
-    await expect(engine.query({
-      test: {
-        resource: 'test'
-      },
-      test2: {
-        resource: 'ERROR'
-      },
-      test3: {
-        resource: 'test3'
-      }
-    }, options)).rejects.toBeTruthy();
-    expect(options.onComplete).toHaveBeenCalledTimes(0);
-    expect(options.onError).toHaveBeenCalledTimes(1);
-  });
-  it('Should call onComplete callback after mutation', async () => {
-    const options = {
-      onComplete: jest.fn()
-    };
-    const engine = new _DataEngine.DataEngine(mockLink);
-    await engine.mutate(mockMutation, options);
-    expect(options.onComplete).toHaveBeenCalledTimes(1);
-  });
-  it('Should call onError callback after failed mutation', async () => {
-    const options = {
-      onComplete: jest.fn(),
-      onError: jest.fn()
-    };
-    const engine = new _DataEngine.DataEngine(mockLink);
-    await expect(engine.mutate({
-      resource: 'ERROR',
-      type: 'delete',
-      id: '2'
-    }, options)).rejects.toBeTruthy();
-    expect(options.onComplete).toHaveBeenCalledTimes(0);
-    expect(options.onError).toHaveBeenCalledTimes(1);
-  });
-});

package/build/cjs/engine/helpers/getMutationFetchType.js

@@ -1,8 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.getMutationFetchType = void 0;
-const getMutationFetchType = mutation => mutation.type === 'update' ? mutation.partial ? 'update' : 'replace' : mutation.type;
-exports.getMutationFetchType = getMutationFetchType;

package/build/cjs/engine/helpers/getMutationFetchType.test.js

@@ -1,39 +0,0 @@
-"use strict";
-
-var _getMutationFetchType = require("./getMutationFetchType");
-describe('getMutationFetchType', () => {
-  it('should return the passed fetch type if not `update`', () => {
-    expect((0, _getMutationFetchType.getMutationFetchType)({
-      type: 'create',
-      resource: 'test',
-      data: {}
-    })).toBe('create');
-    expect((0, _getMutationFetchType.getMutationFetchType)({
-      type: 'delete',
-      resource: 'test',
-      id: 'id'
-    })).toBe('delete');
-    expect((0, _getMutationFetchType.getMutationFetchType)({
-      type: 'json-patch',
-      resource: 'test',
-      data: {}
-    })).toBe('json-patch');
-  });
-  it('should return `replace` for non-partial `update`', () => {
-    expect((0, _getMutationFetchType.getMutationFetchType)({
-      type: 'update',
-      resource: 'test',
-      id: 'id',
-      data: {}
-    })).toBe('replace');
-  });
-  it('should return `update` for partial `update`', () => {
-    expect((0, _getMutationFetchType.getMutationFetchType)({
-      type: 'update',
-      partial: true,
-      resource: 'test',
-      id: 'id',
-      data: {}
-    })).toBe('update');
-  });
-});

package/build/cjs/engine/helpers/resolveDynamicQuery.js

@@ -1,21 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.resolveDynamicQuery = void 0;
-const resolveDynamicQuery = (_ref, variables) => {
-  let {
-    resource,
-    id,
-    data,
-    params
-  } = _ref;
-  return {
-    resource,
-    id: typeof id === 'function' ? id(variables) : id,
-    data: typeof data === 'function' ? data(variables) : data,
-    params: typeof params === 'function' ? params(variables) : params
-  };
-};
-exports.resolveDynamicQuery = resolveDynamicQuery;