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

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

@@ -1,151 +0,0 @@
-/*
- * Requests that expect a "text/plain" Content-Type have been collected by scanning
- * the developer documentation:
- * https://docs.dhis2.org/master/en/developer/html/dhis2_developer_manual_full.html
- *
- * Note that currently it is not allowed to include an id property on a "create"
- * mutation object. This means that currently the `id` will always be included in
- * the resource property (string). If we decide to allow the `id` property for
- * "create" mutation-objects, we will have to include additional checks below.
- */
-
-// POST to `messageConversations/${id}` (reply to a messagConversation)
-export const isReplyToMessageConversation = (type, _ref) => {
-  let {
-    resource
-  } = _ref;
-  const pattern = /^messageConversations\/[a-zA-Z0-9]{11}$/;
-  return type === 'create' && pattern.test(resource);
-};
-
-// POST to 'messageConversations/feedback' (create a feedback message)
-export const isCreateFeedbackMessage = (type, _ref2) => {
-  let {
-    resource
-  } = _ref2;
-  return type === 'create' && resource === 'messageConversations/feedback';
-};
-
-// POST `interpretations/${objectType}/${id}` (add an interpretation to a visualization)
-export const isCreateInterpretation = (type, _ref3) => {
-  let {
-    resource
-  } = _ref3;
-  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)
-export const isUpdateInterpretation = (type, _ref4) => {
-  let {
-    resource,
-    id
-  } = _ref4;
-  if (type !== 'replace') {
-    return false;
-  }
-  let resourcePattern;
-  if (id) {
-    resourcePattern = /^interpretations$/;
-    const idPattern = /^[a-zA-Z0-9]{11}$/;
-    return resourcePattern.test(resource) && idPattern.test(id);
-  }
-  resourcePattern = /^interpretations\/[a-zA-Z0-9]{11}$/;
-  return resourcePattern.test(resource);
-};
-
-// POST to `interpretations/${id}/comments` (comment on an interpretation)
-export const isCommentOnInterpretation = (type, _ref5) => {
-  let {
-    resource
-  } = _ref5;
-  const pattern = /^interpretations\/[a-zA-Z0-9]{11}\/comments$/;
-  return type === 'create' && pattern.test(resource);
-};
-
-// PUT to `interpretations/${interpretationId}/comments/${commentId}`
-// (update an interpretation comment)
-export const isInterpretationCommentUpdate = (type, _ref6) => {
-  let {
-    resource,
-    id
-  } = _ref6;
-  if (type !== 'replace') {
-    return false;
-  }
-  if (id) {
-    const idPatternLong = /^[a-zA-Z0-9]{11}\/comments\/[a-zA-Z0-9]{11}$/;
-    const idPatternShort = /^[a-zA-Z0-9]{11}$/;
-    const resourcePattern = /^interpretations\/[a-zA-Z0-9]{11}\/comments$/;
-    return resource === 'interpretations' && idPatternLong.test(id) || resourcePattern.test(resource) && idPatternShort.test(id);
-  }
-  const pattern = /^interpretations\/[a-zA-Z0-9]{11}\/comments\/[a-zA-Z0-9]{11}$/;
-  return pattern.test(resource);
-};
-
-// POST to `systemSettings/${settingKey}` or `userSettings/${settingKey}`
-// (add or update a single system or user setting)
-export const isAddOrUpdateSystemOrUserSetting = (type, _ref7) => {
-  let {
-    resource
-  } = _ref7;
-  // At least 4 chars because the all start with 'key' (i.e. keyStyle)
-  const pattern = /^(?:systemSettings|userSettings)\/[a-zA-Z]{4,}$/;
-  return type === 'create' && pattern.test(resource);
-};
-
-// POST to `configuration/${configurationProperty}`
-// (add or update a single configuration property)
-export const addOrUpdateConfigurationProperty = (type, _ref8) => {
-  let {
-    resource
-  } = _ref8;
-  // NOTE: The corsWhitelist property does expect "application/json"
-  const pattern = /^(configuration)\/([a-zA-Z]{1,50})$/;
-  const match = resource.match(pattern);
-  return type === 'create' && !!match && match[2] !== 'corsWhitelist';
-};
-
-// POST to 'synchronization/metadataPull' (install a metadata package)
-export const isMetadataPackageInstallation = (type, _ref9) => {
-  let {
-    resource
-  } = _ref9;
-  return type === 'create' && resource === 'synchronization/metadataPull';
-};
-
-// POST to '*/expression/description', (indicators,programIndicators,validationRules,predictors) (validate an expression)
-export const isExpressionDescriptionValidation = (type, _ref0) => {
-  let {
-    resource
-  } = _ref0;
-  const pattern = /^(indicators|programIndicators|validationRules|predictors)\/expression\/description$/;
-  return type === 'create' && pattern.test(resource);
-};
-
-// POST to 'programIndicator/filter/description' (validate a filter)
-export const isFilterDescriptionValidation = (type, _ref1) => {
-  let {
-    resource
-  } = _ref1;
-  const pattern = /^programIndicators\/filter\/description$/;
-  return type === 'create' && pattern.test(resource);
-};
-
-// POST to 'predictors/skipTest/description' (validate a filter)
-export const isSkipTestDescriptionValid = (type, _ref10) => {
-  let {
-    resource
-  } = _ref10;
-  const pattern = /^predictors\/skipTest\/description$/;
-  return type === 'create' && pattern.test(resource);
-};
-
-// POST to 'programRules/condition/description' (validate a program rule condition)
-export const isConditionDescriptionValidation = (type, _ref11) => {
-  let {
-    resource
-  } = _ref11;
-  const pattern = /^programRules\/condition\/description$/;
-  return type === 'create' && pattern.test(resource);
-};

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

@@ -1,244 +0,0 @@
-import { isReplyToMessageConversation, isCreateFeedbackMessage, isCreateInterpretation, isUpdateInterpretation, isCommentOnInterpretation, isInterpretationCommentUpdate, isAddOrUpdateSystemOrUserSetting, addOrUpdateConfigurationProperty, isMetadataPackageInstallation, isExpressionDescriptionValidation, isFilterDescriptionValidation, isSkipTestDescriptionValid, isConditionDescriptionValidation } from './textPlainMatchers';
-describe('isReplyToMessageConversation', () => {
-  it('retuns true for POST to `messageConversations/${id}`', () => {
-    expect(isReplyToMessageConversation('create', {
-      resource: 'messageConversations/oXD88WWSQpR'
-    })).toBe(true);
-  });
-  it('retuns false for a POST to a different resource', () => {
-    expect(isReplyToMessageConversation('create', {
-      resource: 'test/oXD88WWSQpR'
-    })).toBe(false);
-  });
-});
-describe('isCreateFeedbackMessage', () => {
-  it('returns true for a POST to "messageConversations/feedback"', () => {
-    expect(isCreateFeedbackMessage('create', {
-      resource: 'messageConversations/feedback'
-    })).toBe(true);
-  });
-  it('retuns false for a POST to a different resource', () => {
-    expect(isCreateFeedbackMessage('create', {
-      resource: 'messageConversations/somethingelse'
-    })).toBe(false);
-  });
-});
-describe('isCreateInterpretation', () => {
-  it('returns true for a POST to "interpretations/chart/${id}"', () => {
-    expect(isCreateInterpretation('create', {
-      resource: 'interpretations/chart/oXD88WWSQpR'
-    })).toBe(true);
-  });
-  it('returns false for a PUT to "interpretations/chart/${id}"', () => {
-    expect(isCreateInterpretation('replace', {
-      resource: 'interpretations/chart/oXD88WWSQpR'
-    })).toBe(false);
-  });
-  it('retuns false for PATCH requests with a valid query', () => {
-    expect(isCreateInterpretation('update', {
-      resource: 'interpretations/chart/oXD88WWSQpR'
-    })).toBe(false);
-  });
-  it('returns false for a request to a different resource', () => {
-    expect(isCreateInterpretation('create', {
-      resource: 'interpretations/dummy/oXD88WWSQpR'
-    })).toBe(false);
-  });
-});
-describe('isUpdateInterpretation', () => {
-  it('returns true for a PUT to "interpretations/${id}"', () => {
-    expect(isUpdateInterpretation('replace', {
-      resource: 'interpretations/oXD88WWSQpR'
-    })).toBe(true);
-  });
-  it('returns true for PUT with populated query.id', () => {
-    expect(isUpdateInterpretation('replace', {
-      resource: 'interpretations',
-      id: 'oXD88WWSQpR'
-    })).toBe(true);
-  });
-  it('returns false for a POST to "interpretations/${id}"', () => {
-    expect(isUpdateInterpretation('create', {
-      resource: 'interpretations/oXD88WWSQpR'
-    })).toBe(false);
-  });
-  it('returns false for a PATCH to "interpretations/${id}"', () => {
-    expect(isUpdateInterpretation('update', {
-      resource: 'interpretations/oXD88WWSQpR'
-    })).toBe(false);
-  });
-  it('returns false for PATCH with populated query.id', () => {
-    expect(isUpdateInterpretation('update', {
-      resource: 'interpretations',
-      id: 'oXD88WWSQpR'
-    })).toBe(false);
-  });
-  it('returns false for a request to a different resource', () => {
-    expect(isUpdateInterpretation('create', {
-      resource: 'interpretations/dummy/oXD88WWSQpR'
-    })).toBe(false);
-  });
-});
-describe('isCommentOnInterpretation', () => {
-  it('retuns true for POST to `interpretations/${id}/comments`', () => {
-    expect(isCommentOnInterpretation('create', {
-      resource: 'interpretations/oXD88WWSQpR/comments'
-    })).toBe(true);
-  });
-  it('retuns false for a POST to a different resource', () => {
-    expect(isCommentOnInterpretation('create', {
-      resource: 'test/oXD88WWSQpR/comments'
-    })).toBe(false);
-  });
-});
-describe('isInterpretationCommentUpdate', () => {
-  it('returns true for a PUT to `interpretations/${interpretationId}/comments/${commentId}`', () => {
-    expect(isInterpretationCommentUpdate('replace', {
-      resource: 'interpretations/oXD88WWSQpR/comments/oXD88WWSQpR'
-    })).toBe(true);
-  });
-  it('returns true for PUT with populated query.id', () => {
-    expect(isInterpretationCommentUpdate('replace', {
-      resource: 'interpretations',
-      id: 'oXD88WWSQpR/comments/oXD88WWSQpR'
-    })).toBe(true);
-    expect(isInterpretationCommentUpdate('replace', {
-      resource: 'interpretations/oXD88WWSQpR/comments',
-      id: 'oXD88WWSQpR'
-    })).toBe(true);
-  });
-  it('retuns false for PATCH requests with a valid query', () => {
-    expect(isInterpretationCommentUpdate('update', {
-      resource: 'interpretations/oXD88WWSQpR/comments/oXD88WWSQpR'
-    })).toBe(false);
-  });
-  it('returns false for a request to a different resource', () => {
-    expect(isInterpretationCommentUpdate('create', {
-      resource: 'interpretations/oXD88WWSQpR/dummy/oXD88WWSQpR'
-    })).toBe(false);
-  });
-});
-describe('isAddOrUpdateSystemOrUserSetting', () => {
-  it('retuns true for POST to `systemSettings/${settingKey}`', () => {
-    expect(isAddOrUpdateSystemOrUserSetting('create', {
-      resource: 'systemSettings/keyWhatever'
-    })).toBe(true);
-  });
-  it('retuns true for POST to `userSettings/${settingKey}`', () => {
-    expect(isAddOrUpdateSystemOrUserSetting('create', {
-      resource: 'userSettings/keyWhatever'
-    })).toBe(true);
-  });
-  it('retuns false for a POST to a different resource', () => {
-    expect(isAddOrUpdateSystemOrUserSetting('create', {
-      resource: 'test/keyWhatever'
-    })).toBe(false);
-  });
-});
-describe('addOrUpdateConfigurationProperty', () => {
-  it('retuns true for POST to `configuration/${property}`', () => {
-    expect(addOrUpdateConfigurationProperty('create', {
-      resource: 'configuration/whatever'
-    })).toBe(true);
-  });
-  it('retuns false for POST to `configuration/corsWhitelist`, which needs "application/json"', () => {
-    expect(addOrUpdateConfigurationProperty('create', {
-      resource: 'configuration/corsWhitelist'
-    })).toBe(false);
-  });
-  it('retuns false for a POST to a different resource', () => {
-    expect(addOrUpdateConfigurationProperty('create', {
-      resource: 'test/whatever'
-    })).toBe(false);
-  });
-});
-describe('isMetadataPackageInstallation', () => {
-  it('returns true for a POST to "synchronization/metadataPull"', () => {
-    expect(isMetadataPackageInstallation('create', {
-      resource: 'synchronization/metadataPull'
-    })).toBe(true);
-  });
-  it('retuns false for a POST to a different resource', () => {
-    expect(isMetadataPackageInstallation('create', {
-      resource: 'synchronization/somethingelse'
-    })).toBe(false);
-  });
-});
-describe('isExpressionDescriptionValidation', () => {
-  it('returns true for a POST to "indicators/expression/description"', () => {
-    expect(isExpressionDescriptionValidation('create', {
-      resource: 'indicators/expression/description'
-    })).toBe(true);
-  });
-  it('retuns false for a POST to a different resource', () => {
-    expect(isExpressionDescriptionValidation('create', {
-      resource: 'indicators/expression/somethingelse'
-    })).toBe(false);
-  });
-  it('returns true for a POST to "programIndicators/expression/description"', () => {
-    expect(isExpressionDescriptionValidation('create', {
-      resource: 'programIndicators/expression/description'
-    })).toBe(true);
-  });
-  it('retuns false for a POST to a different resource', () => {
-    expect(isExpressionDescriptionValidation('create', {
-      resource: 'programIndicators/expression/somethingelse'
-    })).toBe(false);
-  });
-  it('returns true for a POST to "validationRules/expression/description"', () => {
-    expect(isExpressionDescriptionValidation('create', {
-      resource: 'validationRules/expression/description'
-    })).toBe(true);
-  });
-  it('retuns false for a POST to a different validationRules resource', () => {
-    expect(isExpressionDescriptionValidation('create', {
-      resource: 'validationRules/expression/somethingelse'
-    })).toBe(false);
-  });
-  it('returns true for a POST to "predictors/expression/description"', () => {
-    expect(isExpressionDescriptionValidation('create', {
-      resource: 'predictors/expression/description'
-    })).toBe(true);
-  });
-  it('retuns false for a POST to a different predictors resource', () => {
-    expect(isExpressionDescriptionValidation('create', {
-      resource: 'predictors/expression/somethingelse'
-    })).toBe(false);
-  });
-});
-describe('isFilterDescriptionValidation', () => {
-  it('returns true for a POST to "programIndicators/filter/description"', () => {
-    expect(isFilterDescriptionValidation('create', {
-      resource: 'programIndicators/filter/description'
-    })).toBe(true);
-  });
-  it('retuns false for a POST to a different resource', () => {
-    expect(isFilterDescriptionValidation('create', {
-      resource: 'programIndicators/filter/somethingelse'
-    })).toBe(false);
-  });
-});
-describe('isSkipTestDescriptionValid', () => {
-  it('returns true for a POST to "predictors/skipTest/description"', () => {
-    expect(isSkipTestDescriptionValid('create', {
-      resource: 'predictors/skipTest/description'
-    })).toBe(true);
-  });
-  it('retuns false for a POST to a different resource', () => {
-    expect(isSkipTestDescriptionValid('create', {
-      resource: 'predictors/skipTest/somethingelse'
-    })).toBe(false);
-  });
-});
-describe('isConditionDescriptionValidation', () => {
-  it('returns true for a POST to "programRules/condition/description"', () => {
-    expect(isConditionDescriptionValidation('create', {
-      resource: 'programRules/condition/description'
-    })).toBe(true);
-  });
-  it('retuns false for a POST to a different resource', () => {
-    expect(isConditionDescriptionValidation('create', {
-      resource: 'programRules/condition/somethingelse'
-    })).toBe(false);
-  });
-});

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

@@ -1,7 +0,0 @@
-// POST to convert an SVG file
-export const isSvgConversion = (type, _ref) => {
-  let {
-    resource
-  } = _ref;
-  return type === 'create' && (resource === 'svg.png' || resource === 'svg.pdf');
-};

package/build/es/links/RestAPILink/queryToRequestOptions/xWwwFormUrlencodedMatchers.test.js

@@ -1,18 +0,0 @@
-import { isSvgConversion } from './xWwwFormUrlencodedMatchers';
-describe('isSvgConversion', () => {
-  it('returns true for a POST to "svg.png"', () => {
-    expect(isSvgConversion('create', {
-      resource: 'svg.png'
-    })).toBe(true);
-  });
-  it('returns true for a POST to "svg.pdf"', () => {
-    expect(isSvgConversion('create', {
-      resource: 'svg.pdf'
-    })).toBe(true);
-  });
-  it('retuns false for a POST to a different resource', () => {
-    expect(isSvgConversion('create', {
-      resource: 'notSvg'
-    })).toBe(false);
-  });
-});

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

@@ -1,27 +0,0 @@
-import { requestContentType, requestBodyForContentType, requestHeadersForContentType } from './queryToRequestOptions/requestContentType';
-const getMethod = type => {
-  switch (type) {
-    case 'create':
-      return 'POST';
-    case 'read':
-      return 'GET';
-    case 'update':
-    case 'json-patch':
-      return 'PATCH';
-    case 'replace':
-      return 'PUT';
-    case 'delete':
-      return 'DELETE';
-    default:
-      throw new Error(`Unknown type ${type}`);
-  }
-};
-export const queryToRequestOptions = (type, query, signal) => {
-  const contentType = requestContentType(type, query);
-  return {
-    method: getMethod(type),
-    body: requestBodyForContentType(contentType, query),
-    headers: requestHeadersForContentType(contentType),
-    signal
-  };
-};

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

@@ -1,105 +0,0 @@
-import { queryToRequestOptions } from './queryToRequestOptions';
-describe('queryToRequestOptions', () => {
-  it('should return a valid Fetch option object for read request', () => {
-    const options = queryToRequestOptions('read', {
-      resource: 'test'
-    });
-    expect(options).toMatchInlineSnapshot(`
-            Object {
-              "body": undefined,
-              "headers": undefined,
-              "method": "GET",
-              "signal": undefined,
-            }
-        `);
-  });
-  it('should return a valid Fetch option object for create request', () => {
-    const options = queryToRequestOptions('create', {
-      resource: 'test',
-      data: {
-        answer: 42,
-        foo: 'bar'
-      }
-    });
-    expect(options).toMatchInlineSnapshot(`
-            Object {
-              "body": "{\\"answer\\":42,\\"foo\\":\\"bar\\"}",
-              "headers": Object {
-                "Content-Type": "application/json",
-              },
-              "method": "POST",
-              "signal": undefined,
-            }
-        `);
-  });
-  it('should return a valid Fetch option object for update request', () => {
-    const options = queryToRequestOptions('update', {
-      resource: 'test',
-      data: {
-        answer: 42,
-        foo: 'bar'
-      }
-    });
-    expect(options).toMatchInlineSnapshot(`
-            Object {
-              "body": "{\\"answer\\":42,\\"foo\\":\\"bar\\"}",
-              "headers": Object {
-                "Content-Type": "application/json",
-              },
-              "method": "PATCH",
-              "signal": undefined,
-            }
-        `);
-  });
-  it('should return a valid Fetch option object for json-patch request', () => {
-    const options = queryToRequestOptions('json-patch', {
-      resource: 'test',
-      data: {
-        answer: 42,
-        foo: 'bar'
-      }
-    });
-    expect(options).toMatchInlineSnapshot(`
-            Object {
-              "body": "{\\"answer\\":42,\\"foo\\":\\"bar\\"}",
-              "headers": Object {
-                "Content-Type": "application/json-patch+json",
-              },
-              "method": "PATCH",
-              "signal": undefined,
-            }
-        `);
-  });
-  it('should return a valid Fetch option object for replace request', () => {
-    const options = queryToRequestOptions('replace', {
-      resource: 'test',
-      data: {
-        answer: 42,
-        foo: 'bar'
-      }
-    });
-    expect(options).toMatchInlineSnapshot(`
-            Object {
-              "body": "{\\"answer\\":42,\\"foo\\":\\"bar\\"}",
-              "headers": Object {
-                "Content-Type": "application/json",
-              },
-              "method": "PUT",
-              "signal": undefined,
-            }
-        `);
-  });
-  it('should return a valid Fetch option object for delete request', () => {
-    const options = queryToRequestOptions('delete', {
-      resource: 'test'
-    });
-    expect(options).toMatchInlineSnapshot(`
-            Object {
-              "body": undefined,
-              "headers": undefined,
-              "method": "DELETE",
-              "signal": undefined,
-            }
-        `);
-  });
-});

package/build/es/links/RestAPILink/queryToResourcePath.js

@@ -1,75 +0,0 @@
-import { joinPath } from './path';
-import { validateResourceQuery } from './validateQuery';
-const encodeQueryParameter = param => {
-  if (Array.isArray(param)) {
-    return param.map(encodeQueryParameter).join(',');
-  }
-  if (typeof param === 'string') {
-    return encodeURIComponent(param);
-  }
-  if (typeof param === 'number' || typeof param === 'boolean') {
-    return String(param);
-  }
-  if (typeof param === 'object') {
-    throw new Error('Object parameter mappings not yet implemented');
-  }
-  throw new Error('Unknown parameter type');
-};
-const queryParametersMapToArray = params => Object.keys(params).reduce((out, key) => {
-  const value = params[key];
-  if (key === 'filter' && Array.isArray(value)) {
-    value.forEach(item => {
-      out.push({
-        key: 'filter',
-        value: item
-      });
-    });
-  } else if (params[key] !== null && params[key] !== undefined) {
-    out.push({
-      key,
-      value: params[key]
-    });
-  }
-  return out;
-}, []);
-const queryParametersToQueryString = params => {
-  const expandedParams = queryParametersMapToArray(params);
-  return expandedParams.map(_ref => {
-    let {
-      key,
-      value
-    } = _ref;
-    return `${encodeURIComponent(key)}=${encodeQueryParameter(value)}`;
-  }).join('&');
-};
-const actionPrefix = 'action::';
-const isAction = resource => resource.startsWith(actionPrefix);
-const makeActionPath = resource => joinPath('dhis-web-commons', `${resource.substr(actionPrefix.length)}.action`);
-const skipApiVersion = (resource, config) => {
-  if (resource === 'tracker' || resource.startsWith('tracker/')) {
-    var _config$serverVersion, _config$serverVersion2;
-    if (!((_config$serverVersion = config.serverVersion) !== null && _config$serverVersion !== void 0 && _config$serverVersion.minor) || ((_config$serverVersion2 = config.serverVersion) === null || _config$serverVersion2 === void 0 ? void 0 : _config$serverVersion2.minor) < 38) {
-      return true;
-    }
-  }
-
-  // The `/api/ping` endpoint is unversioned
-  if (resource === 'ping') {
-    return true;
-  }
-  return false;
-};
-export const queryToResourcePath = (link, query, type) => {
-  const {
-    resource,
-    id,
-    params = {}
-  } = query;
-  const apiBase = skipApiVersion(resource, link.config) ? link.unversionedApiPath : link.versionedApiPath;
-  const base = isAction(resource) ? makeActionPath(resource) : joinPath(apiBase, resource, id);
-  validateResourceQuery(query, type);
-  if (Object.keys(params).length) {
-    return `${base}?${queryParametersToQueryString(params)}`;
-  }
-  return base;
-};