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

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

@@ -1,154 +0,0 @@
-import { DataEngine } from './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(mockLink);
-    }).not.toThrow();
-  });
-  it('Should call the mock link with the passed query and options', () => {
-    const controller = new AbortController();
-    const engine = new 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(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(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(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(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(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(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/es/engine/helpers/getMutationFetchType.js

@@ -1 +0,0 @@
-export const getMutationFetchType = mutation => mutation.type === 'update' ? mutation.partial ? 'update' : 'replace' : mutation.type;

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

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

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

@@ -1,14 +0,0 @@
-export 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
-  };
-};

package/build/es/engine/helpers/resolveDynamicQuery.test.js

@@ -1,61 +0,0 @@
-import { resolveDynamicQuery } from './resolveDynamicQuery';
-describe('resolveDynamicQuery', () => {
-  it('Should return an unmodified query if no dynamic properties exist', () => {
-    const query = {
-      resource: 'test',
-      id: '42',
-      params: {
-        page: 3,
-        foo: 'bar'
-      },
-      data: {
-        bar: 'baz'
-      }
-    };
-    expect(resolveDynamicQuery(query, {})).toStrictEqual(query);
-  });
-  it('Should replace variables in all dynamic properties', () => {
-    const query = {
-      resource: 'test',
-      id: _ref => {
-        let {
-          id
-        } = _ref;
-        return id;
-      },
-      params: _ref2 => {
-        let {
-          page
-        } = _ref2;
-        return {
-          page,
-          foo: 'bar'
-        };
-      },
-      data: _ref3 => {
-        let {
-          bar
-        } = _ref3;
-        return {
-          bar
-        };
-      }
-    };
-    const vars = {
-      id: '42',
-      page: 3,
-      bar: 'baz'
-    };
-    expect(resolveDynamicQuery(query, vars)).toStrictEqual({
-      resource: 'test',
-      id: '42',
-      params: {
-        page: 3,
-        foo: 'bar'
-      },
-      data: {
-        bar: 'baz'
-      }
-    });
-  });
-});

package/build/es/engine/helpers/validate.js

@@ -1,53 +0,0 @@
-import { InvalidQueryError } from '../types/InvalidQueryError';
-const validQueryKeys = ['resource', 'id', 'params', 'data'];
-const validTypes = ['read', 'create', 'update', 'replace', 'delete', 'json-patch'];
-export const getResourceQueryErrors = (type, query) => {
-  if (!validTypes.includes(type)) {
-    return [`Unknown query or mutation type ${type}`];
-  }
-  if (typeof query !== 'object') {
-    return ['A query or mutation must be a javascript object'];
-  }
-  const errors = [];
-  if (!query.resource || typeof query.resource !== 'string') {
-    errors.push('Property resource must be a string');
-  }
-  if (type === 'create' && query.id) {
-    errors.push("Mutation type 'create' does not support property 'id'");
-  }
-  if (query.id && typeof query.id !== 'string') {
-    errors.push('Property id must be a string');
-  }
-  if (query.params && typeof query.params !== 'object') {
-    errors.push('Property params must be an object');
-  }
-  if (type === 'delete' && query.data) {
-    errors.push("Mutation type 'delete' does not support property 'data'");
-  }
-  if (type === 'json-patch' && !Array.isArray(query.data)) {
-    errors.push("Mutation type 'json-patch' requires property 'data' to be of type Array");
-  }
-  const invalidKeys = Object.keys(query).filter(k => !validQueryKeys.includes(k));
-  invalidKeys.forEach(k => {
-    errors.push(`Property ${k} is not supported`);
-  });
-  return errors;
-};
-export const validateResourceQueries = function (queries) {
-  let names = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : [];
-  if (names.length !== queries.length) {
-    for (let i = names.length; i < queries.length; ++i) {
-      names.push('query#' + i);
-    }
-  }
-  const errors = queries.reduce((errors, query, i) => errors.concat(getResourceQueryErrors('read', query).map(e => `[${names[i]}] ${e}`)), []);
-  if (errors.length) {
-    throw new InvalidQueryError(errors);
-  }
-};
-export const validateResourceQuery = (type, query) => {
-  const errors = getResourceQueryErrors(type, query);
-  if (errors.length) {
-    throw new InvalidQueryError(errors);
-  }
-};

package/build/es/engine/helpers/validate.test.js

@@ -1,204 +0,0 @@
-import { getResourceQueryErrors, validateResourceQuery, validateResourceQueries } from './validate';
-describe('query validation', () => {
-  describe('getResourceQueryErrors', () => {
-    it('should pass with a simple valid query', () => {
-      expect(getResourceQueryErrors('read', {
-        resource: 'me'
-      })).toHaveLength(0);
-    });
-    it('should pass with a simple valid mutation', () => {
-      expect(getResourceQueryErrors('create', {
-        resource: 'indicators',
-        data: {
-          this: 'is a test'
-        }
-      })).toHaveLength(0);
-    });
-    it('should fail if an unknown type is specified', () => {
-      const errors = getResourceQueryErrors('rainbow', {
-        resource: 'me'
-      });
-      expect(errors).toHaveLength(1);
-      expect(errors).toMatchInlineSnapshot(`
-                Array [
-                  "Unknown query or mutation type rainbow",
-                ]
-            `);
-    });
-    it('should fail if query is not an object', () => {
-      let errors = getResourceQueryErrors('read', 'query');
-      expect(errors).toHaveLength(1);
-      expect(errors).toMatchInlineSnapshot(`
-                Array [
-                  "A query or mutation must be a javascript object",
-                ]
-            `);
-      errors = getResourceQueryErrors('read', 42);
-      expect(errors).toHaveLength(1);
-      expect(errors).toMatchInlineSnapshot(`
-                Array [
-                  "A query or mutation must be a javascript object",
-                ]
-            `);
-    });
-    it('should fail if query is missing resource property', () => {
-      const errors = getResourceQueryErrors('read', {});
-      expect(errors).toHaveLength(1);
-      expect(errors).toMatchInlineSnapshot(`
-                Array [
-                  "Property resource must be a string",
-                ]
-            `);
-    });
-    it('should fail if query is missing resource property', () => {
-      const errors = getResourceQueryErrors('read', {});
-      expect(errors).toHaveLength(1);
-      expect(errors).toMatchInlineSnapshot(`
-                Array [
-                  "Property resource must be a string",
-                ]
-            `);
-    });
-    it('should fail if query is create mutation with id prop', () => {
-      const errors = getResourceQueryErrors('create', {
-        resource: 'indicators',
-        id: 'something'
-      });
-      expect(errors).toHaveLength(1);
-      expect(errors).toMatchInlineSnapshot(`
-                Array [
-                  "Mutation type 'create' does not support property 'id'",
-                ]
-            `);
-    });
-    it('should fail if id prop is not a string', () => {
-      const errors = getResourceQueryErrors('update', {
-        resource: 'indicators',
-        id: 42
-      });
-      expect(errors).toHaveLength(1);
-      expect(errors).toMatchInlineSnapshot(`
-                Array [
-                  "Property id must be a string",
-                ]
-            `);
-    });
-    it('should fail if params prop is not an object', () => {
-      const errors = getResourceQueryErrors('update', {
-        resource: 'indicators',
-        id: '42',
-        params: 'querystring=42'
-      });
-      expect(errors).toHaveLength(1);
-      expect(errors).toMatchInlineSnapshot(`
-                Array [
-                  "Property params must be an object",
-                ]
-            `);
-    });
-    it('should fail if query is delete mutation with data prop', () => {
-      const errors = getResourceQueryErrors('delete', {
-        resource: 'indicators',
-        id: '42',
-        data: 'querystring=42'
-      });
-      expect(errors).toHaveLength(1);
-      expect(errors).toMatchInlineSnapshot(`
-                Array [
-                  "Mutation type 'delete' does not support property 'data'",
-                ]
-            `);
-    });
-    it('should fail if query is json-patch mutation with non-array data prop', () => {
-      const errors = getResourceQueryErrors('json-patch', {
-        resource: 'metadata',
-        data: {}
-      });
-      expect(errors).toHaveLength(1);
-      expect(errors).toMatchInlineSnapshot(`
-                Array [
-                  "Mutation type 'json-patch' requires property 'data' to be of type Array",
-                ]
-            `);
-    });
-    it('should fail if unrecognized keys are passed to query', () => {
-      const errors = getResourceQueryErrors('update', {
-        resource: 'indicators',
-        id: '42',
-        query: 'something',
-        foo: 'bar'
-      });
-      expect(errors).toHaveLength(2);
-      expect(errors).toMatchInlineSnapshot(`
-                Array [
-                  "Property query is not supported",
-                  "Property foo is not supported",
-                ]
-            `);
-    });
-  });
-  describe('validateResourceQuery', () => {
-    it('should pass with a valid query', () => {
-      expect(() => validateResourceQuery('read', {
-        resource: 'me'
-      })).not.toThrowError();
-    });
-    it('should throw an error with an invalid query', () => {
-      expect(() => validateResourceQuery('create', {
-        resource: 'me',
-        id: '42'
-      })).toThrowErrorMatchingInlineSnapshot(`
-"Invalid query
- - Mutation type 'create' does not support property 'id'"
-`);
-    });
-    it('should throw an error with an invalid query', () => {
-      expect(() => validateResourceQuery('create', {
-        resource: 'me',
-        answer: 42
-      })).toThrowErrorMatchingInlineSnapshot(`
-"Invalid query
- - Property answer is not supported"
-`);
-    });
-  });
-  describe('validateResourceQueries', () => {
-    it('should pass with valid queries', () => {
-      expect(() => validateResourceQueries([{
-        resource: 'me'
-      }, {
-        resource: 'indicators'
-      }], ['me', 'ind'])).not.toThrowError();
-    });
-    it('should throw if any query is invalid', () => {
-      expect(() => validateResourceQueries([{
-        resource: 'me'
-      }, {
-        resource: 'indicators',
-        params: 'parameters'
-      }, {
-        resource: 'me',
-        id: 42
-      }])).toThrowErrorMatchingInlineSnapshot(`
-"Invalid query
- - [query#1] Property params must be an object
- - [query#2] Property id must be a string"
-`);
-    });
-    it('should throw if any query is invalid, prefixing with relevant name', () => {
-      expect(() => validateResourceQueries([{
-        resource: 'me'
-      }, {
-        resource: 'indicators',
-        params: 'parameters'
-      }, {
-        resource: 'me',
-        id: 42
-      }], ['me', 'inds'])).toThrowErrorMatchingInlineSnapshot(`
-"Invalid query
- - [inds] Property params must be an object
- - [query#2] Property id must be a string"
-`);
-    });
-  });
-});

package/build/es/engine/index.js

@@ -1,10 +0,0 @@
-export * from './DataEngine';
-export * from './types/DataEngineLink';
-export * from './types/ExecuteOptions';
-export * from './types/FetchError';
-export * from './types/JsonValue';
-export * from './types/Mutation';
-export * from './types/PossiblyDynamic';
-export * from './types/Query';
-export * from './types/QueryParameters';
-export {};

package/build/es/engine/types/DataEngineLink.js

@@ -1 +0,0 @@
-export {};

package/build/es/engine/types/ExecuteOptions.js

@@ -1 +0,0 @@
-export {};

package/build/es/engine/types/FetchError.js

@@ -1,17 +0,0 @@
-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); }
-export class FetchError extends Error {
-  constructor(_ref) {
-    let {
-      message,
-      type,
-      details = {}
-    } = _ref;
-    super(message);
-    _defineProperty(this, "type", void 0);
-    _defineProperty(this, "details", void 0);
-    this.type = type;
-    this.details = details;
-  }
-}

package/build/es/engine/types/FetchError.test.js

@@ -1,12 +0,0 @@
-import { FetchError } from './FetchError';
-describe('FetchError', () => {
-  it('should construct successfully', () => {
-    const message = 'this is a test';
-    const error = new FetchError({
-      message,
-      type: 'network'
-    });
-    expect(error.type).toBe('network');
-    expect(error.message).toBe(message);
-  });
-});

package/build/es/engine/types/InvalidQueryError.js

@@ -1,11 +0,0 @@
-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); }
-export class InvalidQueryError extends Error {
-  constructor(errors) {
-    super(`Invalid query\n${errors.map(e => ' - ' + e).join('\n')}`);
-    _defineProperty(this, "type", 'invalid-query');
-    _defineProperty(this, "details", void 0);
-    this.details = errors;
-  }
-}

package/build/es/engine/types/JsonValue.js

@@ -1 +0,0 @@
-export {};

package/build/es/engine/types/Mutation.js

@@ -1 +0,0 @@
-export {};

package/build/es/engine/types/PossiblyDynamic.js

@@ -1 +0,0 @@
-export {};

package/build/es/engine/types/Query.js

@@ -1 +0,0 @@
-export {};

package/build/es/engine/types/QueryParameters.js

@@ -1 +0,0 @@
-export {};

package/build/es/links/CustomDataLink.js

@@ -1,44 +0,0 @@
-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); }
-export class CustomDataLink {
-  constructor(customData) {
-    let {
-      failOnMiss = true,
-      loadForever = false
-    } = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {};
-    _defineProperty(this, "failOnMiss", void 0);
-    _defineProperty(this, "loadForever", void 0);
-    _defineProperty(this, "data", void 0);
-    this.data = customData;
-    this.failOnMiss = failOnMiss;
-    this.loadForever = loadForever;
-  }
-  async executeResourceQuery(type, query, options) {
-    if (this.loadForever) {
-      return new Promise(() => undefined);
-    }
-    const customResource = this.data[query.resource];
-    if (customResource === undefined) {
-      if (this.failOnMiss) {
-        throw new Error(`No data provided for resource type ${query.resource}!`);
-      }
-      return Promise.resolve(null);
-    }
-    switch (typeof customResource) {
-      case 'string':
-      case 'number':
-      case 'boolean':
-      case 'object':
-        return customResource;
-      case 'function':
-        {
-          const result = await customResource(type, query, options);
-          if (typeof result === 'undefined' && this.failOnMiss) {
-            throw new Error(`The custom function for resource ${query.resource} must always return a value but returned ${result}`);
-          }
-          return result || null;
-        }
-    }
-  }
-}