@dhis2/app-service-data 3.4.3 → 3.4.4

package/build/cjs/links/RestAPILink/queryToRequestOptions/multipartFormDataMatchers.js

@@ -3,7 +3,7 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.isSvgConversion = exports.isAppInstall = exports.isStaticContentUpload = exports.isMessageConversationAttachment = exports.isFileResourceUpload = exports.isDataValue = void 0;
+exports.isAppInstall = exports.isStaticContentUpload = exports.isMessageConversationAttachment = exports.isFileResourceUpload = exports.isDataValue = void 0;
 
 /*
  * Requests that expect a "multipart/form-data" Content-Type have been collected by scanning
@@ -45,13 +45,6 @@ exports.isStaticContentUpload = isStaticContentUpload;
 
 const isAppInstall = (type, {
   resource
-}) => type === 'create' && resource === 'apps'; // POST to convert an SVG file
+}) => type === 'create' && resource === 'apps';
 
-
-exports.isAppInstall = isAppInstall;
-
-const isSvgConversion = (type, {
-  resource
-}) => type === 'create' && (resource === 'svg.png' || resource === 'svg.pdf');
-
-exports.isSvgConversion = isSvgConversion;
+exports.isAppInstall = isAppInstall;

package/build/cjs/links/RestAPILink/queryToRequestOptions/multipartFormDataMatchers.test.js

@@ -71,21 +71,4 @@ describe('isAppInstall', () => {
       resource: 'notApps'
     })).toEqual(false);
   });
-});
-describe('isSvgConversion', () => {
-  it('returns true for a POST to "svg.png"', () => {
-    expect((0, _multipartFormDataMatchers.isSvgConversion)('create', {
-      resource: 'svg.png'
-    })).toEqual(true);
-  });
-  it('returns true for a POST to "svg.pdf"', () => {
-    expect((0, _multipartFormDataMatchers.isSvgConversion)('create', {
-      resource: 'svg.pdf'
-    })).toEqual(true);
-  });
-  it('retuns false for a POST to a different resource', () => {
-    expect((0, _multipartFormDataMatchers.isSvgConversion)('create', {
-      resource: 'notSvg'
-    })).toEqual(false);
-  });
 });

package/build/cjs/links/RestAPILink/queryToRequestOptions/requestContentType.js

@@ -3,12 +3,14 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.requestBodyForContentType = exports.requestHeadersForContentType = exports.requestContentType = exports.FORM_DATA_ERROR_MSG = void 0;
+exports.requestBodyForContentType = exports.requestHeadersForContentType = exports.requestContentType = exports.getConversionErrorMessage = void 0;
 
 var multipartFormDataMatchers = _interopRequireWildcard(require("./multipartFormDataMatchers"));
 
 var textPlainMatchers = _interopRequireWildcard(require("./textPlainMatchers"));
 
+var xWwwFormUrlencodedMatchers = _interopRequireWildcard(require("./xWwwFormUrlencodedMatchers"));
+
 function _getRequireWildcardCache() { if (typeof WeakMap !== "function") return null; var cache = new WeakMap(); _getRequireWildcardCache = function () { return cache; }; return cache; }
 
 function _interopRequireWildcard(obj) { if (obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
@@ -17,20 +19,23 @@ const resourceExpectsTextPlain = (type, query) => Object.values(textPlainMatcher
 
 const resourceExpectsMultipartFormData = (type, query) => Object.values(multipartFormDataMatchers).some(multipartFormDataMatcher => multipartFormDataMatcher(type, query));
 
-const FORM_DATA_ERROR_MSG = 'Could not convert data to FormData: object does not have own enumerable string-keyed properties';
-exports.FORM_DATA_ERROR_MSG = FORM_DATA_ERROR_MSG;
+const resourceExpectsXWwwFormUrlencoded = (type, query) => Object.values(xWwwFormUrlencodedMatchers).some(xWwwFormUrlencodedMatcher => xWwwFormUrlencodedMatcher(type, query));
+
+const getConversionErrorMessage = outputType => "Could not convert data to ".concat(outputType, ": object does not have own enumerable string-keyed properties");
 
-const convertToFormData = data => {
+exports.getConversionErrorMessage = getConversionErrorMessage;
+
+const convertData = (data, initialValue) => {
   const dataEntries = Object.entries(data);
 
   if (dataEntries.length === 0) {
-    throw new Error(FORM_DATA_ERROR_MSG);
+    throw new Error(getConversionErrorMessage(initialValue.constructor.name));
   }
 
-  return dataEntries.reduce((formData, [key, value]) => {
-    formData.append(key, value);
-    return formData;
-  }, new FormData());
+  return dataEntries.reduce((convertedData, [key, value]) => {
+    convertedData.append(key, value);
+    return convertedData;
+  }, initialValue);
 };
 
 const requestContentType = (type, query) => {
@@ -50,6 +55,10 @@ const requestContentType = (type, query) => {
     return 'multipart/form-data';
   }
 
+  if (resourceExpectsXWwwFormUrlencoded(type, query)) {
+    return 'application/x-www-form-urlencoded';
+  }
+
   return 'application/json';
 };
 
@@ -86,7 +95,11 @@ const requestBodyForContentType = (contentType, {
   }
 
   if (contentType === 'multipart/form-data') {
-    return convertToFormData(data);
+    return convertData(data, new FormData());
+  }
+
+  if (contentType === 'application/x-www-form-urlencoded') {
+    return convertData(data, new URLSearchParams());
   } // 'text/plain'
 
 

package/build/cjs/links/RestAPILink/queryToRequestOptions/requestContentType.test.js

@@ -88,7 +88,28 @@ describe('requestBodyForContentType', () => {
           type: 'text/plain'
         })
       });
-    }).toThrow(new Error(_requestContentType.FORM_DATA_ERROR_MSG));
+    }).toThrow(new Error('Could not convert data to FormData: object does not have own enumerable string-keyed properties'));
+  });
+  it('converts to URLSearchParams if contentType is "application/x-www-form-urlencoded"', () => {
+    const data = {
+      a: 'AAA'
+    };
+    const result = (0, _requestContentType.requestBodyForContentType)('application/x-www-form-urlencoded', {
+      resource: 'test',
+      data
+    });
+    expect(result instanceof URLSearchParams).toEqual(true);
+    expect(result.get('a')).toEqual('AAA');
+  });
+  it('throws an error if contentType is "application/x-www-form-urlencoded" and data does have own string-keyd properties', () => {
+    expect(() => {
+      (0, _requestContentType.requestBodyForContentType)('application/x-www-form-urlencoded', {
+        resource: 'test',
+        data: new File(['foo'], 'foo.txt', {
+          type: 'text/plain'
+        })
+      });
+    }).toThrow(new Error('Could not convert data to URLSearchParams: object does not have own enumerable string-keyed properties'));
   });
   it('returns the data as received if contentType is "text/plain"', () => {
     const data = 'Something';

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

@@ -0,0 +1,13 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.isSvgConversion = void 0;
+
+// POST to convert an SVG file
+const isSvgConversion = (type, {
+  resource
+}) => type === 'create' && (resource === 'svg.png' || resource === 'svg.pdf');
+
+exports.isSvgConversion = isSvgConversion;

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

@@ -0,0 +1,21 @@
+"use strict";
+
+var _xWwwFormUrlencodedMatchers = require("./xWwwFormUrlencodedMatchers");
+
+describe('isSvgConversion', () => {
+  it('returns true for a POST to "svg.png"', () => {
+    expect((0, _xWwwFormUrlencodedMatchers.isSvgConversion)('create', {
+      resource: 'svg.png'
+    })).toEqual(true);
+  });
+  it('returns true for a POST to "svg.pdf"', () => {
+    expect((0, _xWwwFormUrlencodedMatchers.isSvgConversion)('create', {
+      resource: 'svg.pdf'
+    })).toEqual(true);
+  });
+  it('retuns false for a POST to a different resource', () => {
+    expect((0, _xWwwFormUrlencodedMatchers.isSvgConversion)('create', {
+      resource: 'notSvg'
+    })).toEqual(false);
+  });
+});

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

@@ -26,8 +26,4 @@ export const isStaticContentUpload = (type, {
 
 export const isAppInstall = (type, {
   resource
-}) => type === 'create' && resource === 'apps'; // POST to convert an SVG file
-
-export const isSvgConversion = (type, {
-  resource
-}) => type === 'create' && (resource === 'svg.png' || resource === 'svg.pdf');
+}) => type === 'create' && resource === 'apps';

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

@@ -1,4 +1,4 @@
-import { isFileResourceUpload, isMessageConversationAttachment, isStaticContentUpload, isAppInstall, isSvgConversion, isDataValue } from './multipartFormDataMatchers';
+import { isFileResourceUpload, isMessageConversationAttachment, isStaticContentUpload, isAppInstall, isDataValue } from './multipartFormDataMatchers';
 describe('isDataValue', () => {
   it('returns true for a POST to "dataValues"', () => {
     expect(isDataValue('create', {
@@ -68,21 +68,4 @@ describe('isAppInstall', () => {
       resource: 'notApps'
     })).toEqual(false);
   });
-});
-describe('isSvgConversion', () => {
-  it('returns true for a POST to "svg.png"', () => {
-    expect(isSvgConversion('create', {
-      resource: 'svg.png'
-    })).toEqual(true);
-  });
-  it('returns true for a POST to "svg.pdf"', () => {
-    expect(isSvgConversion('create', {
-      resource: 'svg.pdf'
-    })).toEqual(true);
-  });
-  it('retuns false for a POST to a different resource', () => {
-    expect(isSvgConversion('create', {
-      resource: 'notSvg'
-    })).toEqual(false);
-  });
 });

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

@@ -1,23 +1,26 @@
 import * as multipartFormDataMatchers from './multipartFormDataMatchers';
 import * as textPlainMatchers from './textPlainMatchers';
+import * as xWwwFormUrlencodedMatchers from './xWwwFormUrlencodedMatchers';
 
 const resourceExpectsTextPlain = (type, query) => Object.values(textPlainMatchers).some(textPlainMatcher => textPlainMatcher(type, query));
 
 const resourceExpectsMultipartFormData = (type, query) => Object.values(multipartFormDataMatchers).some(multipartFormDataMatcher => multipartFormDataMatcher(type, query));
 
-export const FORM_DATA_ERROR_MSG = 'Could not convert data to FormData: object does not have own enumerable string-keyed properties';
+const resourceExpectsXWwwFormUrlencoded = (type, query) => Object.values(xWwwFormUrlencodedMatchers).some(xWwwFormUrlencodedMatcher => xWwwFormUrlencodedMatcher(type, query));
 
-const convertToFormData = data => {
+export const getConversionErrorMessage = outputType => "Could not convert data to ".concat(outputType, ": object does not have own enumerable string-keyed properties");
+
+const convertData = (data, initialValue) => {
   const dataEntries = Object.entries(data);
 
   if (dataEntries.length === 0) {
-    throw new Error(FORM_DATA_ERROR_MSG);
+    throw new Error(getConversionErrorMessage(initialValue.constructor.name));
   }
 
-  return dataEntries.reduce((formData, [key, value]) => {
-    formData.append(key, value);
-    return formData;
-  }, new FormData());
+  return dataEntries.reduce((convertedData, [key, value]) => {
+    convertedData.append(key, value);
+    return convertedData;
+  }, initialValue);
 };
 
 export const requestContentType = (type, query) => {
@@ -37,6 +40,10 @@ export const requestContentType = (type, query) => {
     return 'multipart/form-data';
   }
 
+  if (resourceExpectsXWwwFormUrlencoded(type, query)) {
+    return 'application/x-www-form-urlencoded';
+  }
+
   return 'application/json';
 };
 export const requestHeadersForContentType = contentType => {
@@ -67,7 +74,11 @@ export const requestBodyForContentType = (contentType, {
   }
 
   if (contentType === 'multipart/form-data') {
-    return convertToFormData(data);
+    return convertData(data, new FormData());
+  }
+
+  if (contentType === 'application/x-www-form-urlencoded') {
+    return convertData(data, new URLSearchParams());
   } // 'text/plain'
 
 

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

@@ -1,4 +1,4 @@
-import { requestContentType, requestHeadersForContentType, requestBodyForContentType, FORM_DATA_ERROR_MSG } from './requestContentType';
+import { requestContentType, requestHeadersForContentType, requestBodyForContentType } from './requestContentType';
 describe('requestContentType', () => {
   it('returns "application/json" for a normal resource', () => {
     expect(requestContentType('create', {
@@ -85,7 +85,28 @@ describe('requestBodyForContentType', () => {
           type: 'text/plain'
         })
       });
-    }).toThrow(new Error(FORM_DATA_ERROR_MSG));
+    }).toThrow(new Error('Could not convert data to FormData: object does not have own enumerable string-keyed properties'));
+  });
+  it('converts to URLSearchParams if contentType is "application/x-www-form-urlencoded"', () => {
+    const data = {
+      a: 'AAA'
+    };
+    const result = requestBodyForContentType('application/x-www-form-urlencoded', {
+      resource: 'test',
+      data
+    });
+    expect(result instanceof URLSearchParams).toEqual(true);
+    expect(result.get('a')).toEqual('AAA');
+  });
+  it('throws an error if contentType is "application/x-www-form-urlencoded" and data does have own string-keyd properties', () => {
+    expect(() => {
+      requestBodyForContentType('application/x-www-form-urlencoded', {
+        resource: 'test',
+        data: new File(['foo'], 'foo.txt', {
+          type: 'text/plain'
+        })
+      });
+    }).toThrow(new Error('Could not convert data to URLSearchParams: object does not have own enumerable string-keyed properties'));
   });
   it('returns the data as received if contentType is "text/plain"', () => {
     const data = 'Something';

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

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

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

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

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

@@ -4,4 +4,3 @@ export declare const isFileResourceUpload: (type: FetchType, { resource }: Resol
 export declare const isMessageConversationAttachment: (type: FetchType, { resource }: ResolvedResourceQuery) => boolean;
 export declare const isStaticContentUpload: (type: FetchType, { resource }: ResolvedResourceQuery) => boolean;
 export declare const isAppInstall: (type: FetchType, { resource }: ResolvedResourceQuery) => boolean;
-export declare const isSvgConversion: (type: FetchType, { resource }: ResolvedResourceQuery) => boolean;

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

@@ -1,7 +1,7 @@
 import { ResolvedResourceQuery, FetchType } from '../../../engine';
-declare type RequestContentType = 'application/json' | 'application/json-patch+json' | 'text/plain' | 'multipart/form-data' | null;
-export declare const FORM_DATA_ERROR_MSG = "Could not convert data to FormData: object does not have own enumerable string-keyed properties";
+declare type RequestContentType = 'application/json' | 'application/json-patch+json' | 'text/plain' | 'multipart/form-data' | 'application/x-www-form-urlencoded' | null;
+export declare const getConversionErrorMessage: (outputType: string) => string;
 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;
+export declare const requestBodyForContentType: (contentType: RequestContentType, { data }: ResolvedResourceQuery) => undefined | string | FormData | URLSearchParams;
 export {};

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

@@ -0,0 +1,2 @@
+import { ResolvedResourceQuery, FetchType } from '../../../engine';
+export declare const isSvgConversion: (type: FetchType, { resource }: ResolvedResourceQuery) => boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@dhis2/app-service-data",
-    "version": "3.4.3",
+    "version": "3.4.4",
     "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.4.3",
+        "@dhis2/app-service-config": "3.4.4",
         "@dhis2/cli-app-scripts": "^7.1.1",
         "prop-types": "^15.7.2",
         "react": "^16.8",