@dhis2/app-service-data 3.3.0 → 3.4.0

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

@@ -14,6 +14,11 @@ describe('getMutationFetchType', () => {
       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)({

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

@@ -8,7 +8,7 @@ exports.validateResourceQuery = exports.validateResourceQueries = exports.getRes
 var _InvalidQueryError = require("../types/InvalidQueryError");
 
 const validQueryKeys = ['resource', 'id', 'params', 'data'];
-const validTypes = ['read', 'create', 'update', 'replace', 'delete'];
+const validTypes = ['read', 'create', 'update', 'replace', 'delete', 'json-patch'];
 
 const getResourceQueryErrors = (type, query) => {
   if (!validTypes.includes(type)) {
@@ -41,6 +41,10 @@ const getResourceQueryErrors = (type, query) => {
     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 ".concat(k, " is not supported"));

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

@@ -76,6 +76,14 @@ describe('query validation', () => {
       expect(errors).toHaveLength(1);
       expect(errors).toMatchInlineSnapshot("\n                Array [\n                  \"Mutation type 'delete' does not support property 'data'\",\n                ]\n            ");
     });
+    it('should fail if query is json-patch mutation with non-array data prop', () => {
+      const errors = (0, _validate.getResourceQueryErrors)('json-patch', {
+        resource: 'metadata',
+        data: {}
+      });
+      expect(errors).toHaveLength(1);
+      expect(errors).toMatchInlineSnapshot("\n                Array [\n                  \"Mutation type 'json-patch' requires property 'data' to be of type Array\",\n                ]\n            ");
+    });
     it('should fail if unrecognized keys are passed to query', () => {
       const errors = (0, _validate.getResourceQueryErrors)('update', {
         resource: 'indicators',

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

@@ -38,6 +38,10 @@ const requestContentType = (type, query) => {
     return null;
   }
 
+  if (type === 'json-patch') {
+    return 'application/json-patch+json';
+  }
+
   if (resourceExpectsTextPlain(type, query)) {
     return 'text/plain';
   }
@@ -77,7 +81,7 @@ const requestBodyForContentType = (contentType, {
     return undefined;
   }
 
-  if (contentType === 'application/json') {
+  if (contentType === 'application/json' || contentType === 'application/json-patch+json') {
     return JSON.stringify(data);
   }
 

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

@@ -9,6 +9,12 @@ describe('requestContentType', () => {
       data: 'test'
     })).toEqual('application/json');
   });
+  it('returns "application/json-patch+json" when the fetch type is "json-patch"', () => {
+    expect((0, _requestContentType.requestContentType)('json-patch', {
+      resource: 'test',
+      data: 'test'
+    })).toEqual('application/json-patch+json');
+  });
   it('returns "multipart/form-data" for a specific resource that expects it', () => {
     expect((0, _requestContentType.requestContentType)('create', {
       resource: 'fileResources',

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

@@ -16,6 +16,7 @@ const getMethod = type => {
       return 'GET';
 
     case 'update':
+    case 'json-patch':
       return 'PATCH';
 
     case 'replace':
@@ -23,6 +24,9 @@ const getMethod = type => {
 
     case 'delete':
       return 'DELETE';
+
+    default:
+      throw new Error("Unknown type ".concat(type));
   }
 };
 

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

@@ -29,6 +29,16 @@ describe('queryToRequestOptions', () => {
     });
     expect(options).toMatchInlineSnapshot("\n            Object {\n              \"body\": \"{\\\"answer\\\":42,\\\"foo\\\":\\\"bar\\\"}\",\n              \"headers\": Object {\n                \"Content-Type\": \"application/json\",\n              },\n              \"method\": \"PATCH\",\n              \"signal\": undefined,\n            }\n        ");
   });
+  it('should return a valid Fetch option object for json-patch request', () => {
+    const options = (0, _queryToRequestOptions.queryToRequestOptions)('json-patch', {
+      resource: 'test',
+      data: {
+        answer: 42,
+        foo: 'bar'
+      }
+    });
+    expect(options).toMatchInlineSnapshot("\n            Object {\n              \"body\": \"{\\\"answer\\\":42,\\\"foo\\\":\\\"bar\\\"}\",\n              \"headers\": Object {\n                \"Content-Type\": \"application/json-patch+json\",\n              },\n              \"method\": \"PATCH\",\n              \"signal\": undefined,\n            }\n        ");
+  });
   it('should return a valid Fetch option object for replace request', () => {
     const options = (0, _queryToRequestOptions.queryToRequestOptions)('replace', {
       resource: 'test',

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

@@ -11,6 +11,11 @@ describe('getMutationFetchType', () => {
       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({

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

@@ -1,6 +1,6 @@
 import { InvalidQueryError } from '../types/InvalidQueryError';
 const validQueryKeys = ['resource', 'id', 'params', 'data'];
-const validTypes = ['read', 'create', 'update', 'replace', 'delete'];
+const validTypes = ['read', 'create', 'update', 'replace', 'delete', 'json-patch'];
 export const getResourceQueryErrors = (type, query) => {
   if (!validTypes.includes(type)) {
     return ["Unknown query or mutation type ".concat(type)];
@@ -32,6 +32,10 @@ export const getResourceQueryErrors = (type, query) => {
     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 ".concat(k, " is not supported"));

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

@@ -73,6 +73,14 @@ describe('query validation', () => {
       expect(errors).toHaveLength(1);
       expect(errors).toMatchInlineSnapshot("\n                Array [\n                  \"Mutation type 'delete' does not support property 'data'\",\n                ]\n            ");
     });
+    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("\n                Array [\n                  \"Mutation type 'json-patch' requires property 'data' to be of type Array\",\n                ]\n            ");
+    });
     it('should fail if unrecognized keys are passed to query', () => {
       const errors = getResourceQueryErrors('update', {
         resource: 'indicators',

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

@@ -25,6 +25,10 @@ export const requestContentType = (type, query) => {
     return null;
   }
 
+  if (type === 'json-patch') {
+    return 'application/json-patch+json';
+  }
+
   if (resourceExpectsTextPlain(type, query)) {
     return 'text/plain';
   }
@@ -58,7 +62,7 @@ export const requestBodyForContentType = (contentType, {
     return undefined;
   }
 
-  if (contentType === 'application/json') {
+  if (contentType === 'application/json' || contentType === 'application/json-patch+json') {
     return JSON.stringify(data);
   }
 

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

@@ -6,6 +6,12 @@ describe('requestContentType', () => {
       data: 'test'
     })).toEqual('application/json');
   });
+  it('returns "application/json-patch+json" when the fetch type is "json-patch"', () => {
+    expect(requestContentType('json-patch', {
+      resource: 'test',
+      data: 'test'
+    })).toEqual('application/json-patch+json');
+  });
   it('returns "multipart/form-data" for a specific resource that expects it', () => {
     expect(requestContentType('create', {
       resource: 'fileResources',

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

@@ -9,6 +9,7 @@ const getMethod = type => {
       return 'GET';
 
     case 'update':
+    case 'json-patch':
       return 'PATCH';
 
     case 'replace':
@@ -16,6 +17,9 @@ const getMethod = type => {
 
     case 'delete':
       return 'DELETE';
+
+    default:
+      throw new Error("Unknown type ".concat(type));
   }
 };
 

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

@@ -26,6 +26,16 @@ describe('queryToRequestOptions', () => {
     });
     expect(options).toMatchInlineSnapshot("\n            Object {\n              \"body\": \"{\\\"answer\\\":42,\\\"foo\\\":\\\"bar\\\"}\",\n              \"headers\": Object {\n                \"Content-Type\": \"application/json\",\n              },\n              \"method\": \"PATCH\",\n              \"signal\": undefined,\n            }\n        ");
   });
+  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("\n            Object {\n              \"body\": \"{\\\"answer\\\":42,\\\"foo\\\":\\\"bar\\\"}\",\n              \"headers\": Object {\n                \"Content-Type\": \"application/json-patch+json\",\n              },\n              \"method\": \"PATCH\",\n              \"signal\": undefined,\n            }\n        ");
+  });
   it('should return a valid Fetch option object for replace request', () => {
     const options = queryToRequestOptions('replace', {
       resource: 'test',

package/build/types/engine/types/ExecuteOptions.d.ts

@@ -1,6 +1,6 @@
 import { FetchError } from './FetchError';
 import { QueryVariables } from './Query';
-export declare type FetchType = 'create' | 'read' | 'update' | 'replace' | 'delete';
+export declare type FetchType = 'create' | 'read' | 'update' | 'json-patch' | 'replace' | 'delete';
 export interface QueryExecuteOptions {
     variables?: QueryVariables;
     signal?: AbortSignal;

package/build/types/engine/types/Mutation.d.ts

@@ -1,6 +1,6 @@
 import { FetchError } from './FetchError';
 import { ResourceQuery, QueryVariables } from './Query';
-export declare type MutationType = 'create' | 'update' | 'replace' | 'delete';
+export declare type MutationType = 'create' | 'update' | 'json-patch' | 'replace' | 'delete';
 export interface MutationData {
     [key: string]: any;
 }
@@ -12,7 +12,7 @@ export interface CreateMutation extends BaseMutation {
     data: MutationData;
 }
 export interface UpdateMutation extends BaseMutation {
-    type: 'update' | 'replace';
+    type: 'update' | 'replace' | 'json-patch';
     id: string;
     partial?: boolean;
     data: MutationData;

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

@@ -1,9 +1,7 @@
 import { ResolvedResourceQuery, FetchType } from '../../../engine';
-declare type RequestContentType = 'application/json' | 'text/plain' | 'multipart/form-data' | null;
+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";
-export declare const requestContentType: (type: FetchType, query: ResolvedResourceQuery) => "application/json" | "text/plain" | "multipart/form-data" | null;
-export declare const requestHeadersForContentType: (contentType: RequestContentType) => {
-    'Content-Type': "application/json" | "text/plain";
-} | undefined;
-export declare const requestBodyForContentType: (contentType: RequestContentType, { data }: ResolvedResourceQuery) => any;
+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 {};

package/package.json

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