@dhis2/app-service-data 3.4.0 → 3.4.1

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

@@ -63,13 +63,26 @@ const isAction = resource => resource.startsWith(actionPrefix);
 
 const makeActionPath = resource => (0, _path.joinPath)('dhis-web-commons', "".concat(resource.substr(actionPrefix.length), ".action"));
 
-const queryToResourcePath = (apiPath, query, type) => {
+const skipApiVersion = (resource, config) => {
+  if (resource === '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;
+    }
+  }
+
+  return false;
+};
+
+const queryToResourcePath = (link, query, type) => {
   const {
     resource,
     id,
     params = {}
   } = query;
-  const base = isAction(resource) ? makeActionPath(resource) : (0, _path.joinPath)(apiPath, resource, id);
+  const apiBase = skipApiVersion(resource, link.config) ? link.unversionedApiPath : link.versionedApiPath;
+  const base = isAction(resource) ? makeActionPath(resource) : (0, _path.joinPath)(apiBase, resource, id);
   (0, _validateQuery.validateResourceQuery)(query, type);
 
   if (Object.keys(params).length) {

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

@@ -1,8 +1,22 @@
 "use strict";
 
+var _RestAPILink = require("../RestAPILink");
+
 var _queryToResourcePath = require("./queryToResourcePath");
 
-const apiPath = '<api>';
+const createLink = config => new _RestAPILink.RestAPILink(config);
+
+const defaultConfig = {
+  basePath: '<base>',
+  apiVersion: '37',
+  serverVersion: {
+    major: 2,
+    minor: 37,
+    patch: 11
+  }
+};
+const link = createLink(defaultConfig);
+const apiPath = link.versionedApiPath;
 const actionPrefix = "dhis-web-commons/";
 const actionPostfix = '.action';
 describe('queryToResourcePath', () => {
@@ -11,7 +25,7 @@ describe('queryToResourcePath', () => {
       const query = {
         resource: 'action::test'
       };
-      expect((0, _queryToResourcePath.queryToResourcePath)(apiPath, query)).toBe("".concat(actionPrefix, "test").concat(actionPostfix));
+      expect((0, _queryToResourcePath.queryToResourcePath)(link, query, 'read')).toBe("".concat(actionPrefix, "test").concat(actionPostfix));
     });
     it('should return action URL with a simple querystring if query parameters are passed', () => {
       const query = {
@@ -20,7 +34,7 @@ describe('queryToResourcePath', () => {
           key: 'value'
         }
       };
-      expect((0, _queryToResourcePath.queryToResourcePath)(apiPath, query)).toBe("".concat(actionPrefix, "test").concat(actionPostfix, "?key=value"));
+      expect((0, _queryToResourcePath.queryToResourcePath)(link, query, 'read')).toBe("".concat(actionPrefix, "test").concat(actionPostfix, "?key=value"));
     });
   });
   describe('resource with dot', () => {
@@ -28,14 +42,14 @@ describe('queryToResourcePath', () => {
       const query = {
         resource: 'svg.pdf'
       };
-      expect((0, _queryToResourcePath.queryToResourcePath)(apiPath, query)).toBe("".concat(apiPath, "/svg.pdf"));
+      expect((0, _queryToResourcePath.queryToResourcePath)(link, query, 'read')).toBe("".concat(apiPath, "/svg.pdf"));
     });
   });
   it('should return resource url with no querystring if not query parameters are passed', () => {
     const query = {
       resource: 'test'
     };
-    expect((0, _queryToResourcePath.queryToResourcePath)(apiPath, query)).toBe("".concat(apiPath, "/test"));
+    expect((0, _queryToResourcePath.queryToResourcePath)(link, query, 'read')).toBe("".concat(apiPath, "/test"));
   });
   it('should return resource url and singular parameter separated by ?', () => {
     const query = {
@@ -44,7 +58,7 @@ describe('queryToResourcePath', () => {
         key: 'value'
       }
     };
-    expect((0, _queryToResourcePath.queryToResourcePath)(apiPath, query)).toBe("".concat(apiPath, "/test?key=value"));
+    expect((0, _queryToResourcePath.queryToResourcePath)(link, query, 'read')).toBe("".concat(apiPath, "/test?key=value"));
   });
   it('should return resource url and multiple parameters separated by ? and &', () => {
     const query = {
@@ -54,7 +68,7 @@ describe('queryToResourcePath', () => {
         param: 'value2'
       }
     };
-    expect((0, _queryToResourcePath.queryToResourcePath)(apiPath, query)).toBe("".concat(apiPath, "/test?key=value&param=value2"));
+    expect((0, _queryToResourcePath.queryToResourcePath)(link, query, 'read')).toBe("".concat(apiPath, "/test?key=value&param=value2"));
   });
   it('should url encode special characters in query keys', () => {
     const query = {
@@ -63,7 +77,7 @@ describe('queryToResourcePath', () => {
         'key=42&val': 'value'
       }
     };
-    expect((0, _queryToResourcePath.queryToResourcePath)(apiPath, query)).toBe("".concat(apiPath, "/test?key%3D42%26val=value"));
+    expect((0, _queryToResourcePath.queryToResourcePath)(link, query, 'read')).toBe("".concat(apiPath, "/test?key%3D42%26val=value"));
   });
   it('should url encode special characters in string parameters', () => {
     const query = {
@@ -73,7 +87,7 @@ describe('queryToResourcePath', () => {
         param: 'value2&& 53'
       }
     };
-    expect((0, _queryToResourcePath.queryToResourcePath)(apiPath, query)).toBe("".concat(apiPath, "/test?key=value%3F%3D42&param=value2%26%26%2053"));
+    expect((0, _queryToResourcePath.queryToResourcePath)(link, query, 'read')).toBe("".concat(apiPath, "/test?key=value%3F%3D42&param=value2%26%26%2053"));
   });
   it('should support numeric (integer and float) parameters', () => {
     const query = {
@@ -83,7 +97,7 @@ describe('queryToResourcePath', () => {
         param: 193.75
       }
     };
-    expect((0, _queryToResourcePath.queryToResourcePath)(apiPath, query)).toBe("".concat(apiPath, "/test?key=42&param=193.75"));
+    expect((0, _queryToResourcePath.queryToResourcePath)(link, query, 'read')).toBe("".concat(apiPath, "/test?key=42&param=193.75"));
   });
   it('should support boolean parameters', () => {
     const query = {
@@ -93,7 +107,7 @@ describe('queryToResourcePath', () => {
         someflag: true
       }
     };
-    expect((0, _queryToResourcePath.queryToResourcePath)(apiPath, query)).toBe("".concat(apiPath, "/test?key=42&someflag=true"));
+    expect((0, _queryToResourcePath.queryToResourcePath)(link, query, 'read')).toBe("".concat(apiPath, "/test?key=42&someflag=true"));
   });
   it('should join array parameters with commas', () => {
     const query = {
@@ -102,7 +116,7 @@ describe('queryToResourcePath', () => {
         key: ['asdf', 123]
       }
     };
-    expect((0, _queryToResourcePath.queryToResourcePath)(apiPath, query)).toBe("".concat(apiPath, "/test?key=asdf,123"));
+    expect((0, _queryToResourcePath.queryToResourcePath)(link, query, 'read')).toBe("".concat(apiPath, "/test?key=asdf,123"));
   });
   it('should include multiple filter parameters when array of filters provided', () => {
     const query = {
@@ -111,7 +125,7 @@ describe('queryToResourcePath', () => {
         filter: ['asdf', 123]
       }
     };
-    expect((0, _queryToResourcePath.queryToResourcePath)(apiPath, query)).toBe("".concat(apiPath, "/test?filter=asdf&filter=123"));
+    expect((0, _queryToResourcePath.queryToResourcePath)(link, query, 'read')).toBe("".concat(apiPath, "/test?filter=asdf&filter=123"));
   });
   it('should NOT YET support name-aliased parameters', () => {
     const query = {
@@ -122,7 +136,7 @@ describe('queryToResourcePath', () => {
         }
       }
     };
-    expect(() => (0, _queryToResourcePath.queryToResourcePath)(apiPath, query)).toThrow();
+    expect(() => (0, _queryToResourcePath.queryToResourcePath)(link, query, 'read')).toThrow();
   });
   it('should throw if passed something crazy like a function', () => {
     const query = {
@@ -131,6 +145,25 @@ describe('queryToResourcePath', () => {
         key: a => a
       }
     };
-    expect(() => (0, _queryToResourcePath.queryToResourcePath)(apiPath, query)).toThrow();
+    expect(() => (0, _queryToResourcePath.queryToResourcePath)(link, query, 'read')).toThrow();
+  });
+  it('should return an unversioned endpoint for the new tracker importer (in version 2.37)', () => {
+    const query = {
+      resource: 'tracker'
+    };
+    expect((0, _queryToResourcePath.queryToResourcePath)(link, query, 'read')).toBe("".concat(link.unversionedApiPath, "/tracker"));
+  });
+  it('should return a VERSIONED endpoint for the new tracker importer (in version 2.38)', () => {
+    const query = {
+      resource: 'tracker'
+    };
+    const v38config = { ...defaultConfig,
+      serverVersion: {
+        major: 2,
+        minor: 38,
+        patch: 0
+      }
+    };
+    expect((0, _queryToResourcePath.queryToResourcePath)(createLink(v38config), query, 'read')).toBe("".concat(link.versionedApiPath, "/tracker"));
   });
 });

package/build/cjs/links/RestAPILink.js

@@ -16,29 +16,26 @@ var _queryToResourcePath = require("./RestAPILink/queryToResourcePath");
 function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 
 class RestAPILink {
-  constructor({
-    baseUrl,
-    apiVersion
-  }) {
-    _defineProperty(this, "apiPath", void 0);
+  constructor(config) {
+    _defineProperty(this, "config", void 0);
 
-    _defineProperty(this, "baseUrl", void 0);
+    _defineProperty(this, "versionedApiPath", void 0);
 
-    _defineProperty(this, "apiVersion", void 0);
+    _defineProperty(this, "unversionedApiPath", void 0);
 
-    this.baseUrl = baseUrl;
-    this.apiVersion = apiVersion;
-    this.apiPath = (0, _path.joinPath)('api', String(apiVersion));
+    this.config = config;
+    this.versionedApiPath = (0, _path.joinPath)('api', String(config.apiVersion));
+    this.unversionedApiPath = (0, _path.joinPath)('api');
   }
 
   fetch(path, options) {
-    return (0, _fetchData.fetchData)((0, _path.joinPath)(this.baseUrl, path), options);
+    return (0, _fetchData.fetchData)((0, _path.joinPath)(this.config.baseUrl, path), options);
   }
 
   executeResourceQuery(type, query, {
     signal
   }) {
-    return this.fetch((0, _queryToResourcePath.queryToResourcePath)(this.apiPath, query, type), (0, _queryToRequestOptions.queryToRequestOptions)(type, query, signal));
+    return this.fetch((0, _queryToResourcePath.queryToResourcePath)(this, query, type), (0, _queryToRequestOptions.queryToRequestOptions)(type, query, signal));
   }
 
 }

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

@@ -55,13 +55,26 @@ const isAction = resource => resource.startsWith(actionPrefix);
 
 const makeActionPath = resource => joinPath('dhis-web-commons', "".concat(resource.substr(actionPrefix.length), ".action"));
 
-export const queryToResourcePath = (apiPath, query, type) => {
+const skipApiVersion = (resource, config) => {
+  if (resource === '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;
+    }
+  }
+
+  return false;
+};
+
+export const queryToResourcePath = (link, query, type) => {
   const {
     resource,
     id,
     params = {}
   } = query;
-  const base = isAction(resource) ? makeActionPath(resource) : joinPath(apiPath, resource, id);
+  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) {

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

@@ -1,5 +1,19 @@
+import { RestAPILink } from '../RestAPILink';
 import { queryToResourcePath } from './queryToResourcePath';
-const apiPath = '<api>';
+
+const createLink = config => new RestAPILink(config);
+
+const defaultConfig = {
+  basePath: '<base>',
+  apiVersion: '37',
+  serverVersion: {
+    major: 2,
+    minor: 37,
+    patch: 11
+  }
+};
+const link = createLink(defaultConfig);
+const apiPath = link.versionedApiPath;
 const actionPrefix = "dhis-web-commons/";
 const actionPostfix = '.action';
 describe('queryToResourcePath', () => {
@@ -8,7 +22,7 @@ describe('queryToResourcePath', () => {
       const query = {
         resource: 'action::test'
       };
-      expect(queryToResourcePath(apiPath, query)).toBe("".concat(actionPrefix, "test").concat(actionPostfix));
+      expect(queryToResourcePath(link, query, 'read')).toBe("".concat(actionPrefix, "test").concat(actionPostfix));
     });
     it('should return action URL with a simple querystring if query parameters are passed', () => {
       const query = {
@@ -17,7 +31,7 @@ describe('queryToResourcePath', () => {
           key: 'value'
         }
       };
-      expect(queryToResourcePath(apiPath, query)).toBe("".concat(actionPrefix, "test").concat(actionPostfix, "?key=value"));
+      expect(queryToResourcePath(link, query, 'read')).toBe("".concat(actionPrefix, "test").concat(actionPostfix, "?key=value"));
     });
   });
   describe('resource with dot', () => {
@@ -25,14 +39,14 @@ describe('queryToResourcePath', () => {
       const query = {
         resource: 'svg.pdf'
       };
-      expect(queryToResourcePath(apiPath, query)).toBe("".concat(apiPath, "/svg.pdf"));
+      expect(queryToResourcePath(link, query, 'read')).toBe("".concat(apiPath, "/svg.pdf"));
     });
   });
   it('should return resource url with no querystring if not query parameters are passed', () => {
     const query = {
       resource: 'test'
     };
-    expect(queryToResourcePath(apiPath, query)).toBe("".concat(apiPath, "/test"));
+    expect(queryToResourcePath(link, query, 'read')).toBe("".concat(apiPath, "/test"));
   });
   it('should return resource url and singular parameter separated by ?', () => {
     const query = {
@@ -41,7 +55,7 @@ describe('queryToResourcePath', () => {
         key: 'value'
       }
     };
-    expect(queryToResourcePath(apiPath, query)).toBe("".concat(apiPath, "/test?key=value"));
+    expect(queryToResourcePath(link, query, 'read')).toBe("".concat(apiPath, "/test?key=value"));
   });
   it('should return resource url and multiple parameters separated by ? and &', () => {
     const query = {
@@ -51,7 +65,7 @@ describe('queryToResourcePath', () => {
         param: 'value2'
       }
     };
-    expect(queryToResourcePath(apiPath, query)).toBe("".concat(apiPath, "/test?key=value&param=value2"));
+    expect(queryToResourcePath(link, query, 'read')).toBe("".concat(apiPath, "/test?key=value&param=value2"));
   });
   it('should url encode special characters in query keys', () => {
     const query = {
@@ -60,7 +74,7 @@ describe('queryToResourcePath', () => {
         'key=42&val': 'value'
       }
     };
-    expect(queryToResourcePath(apiPath, query)).toBe("".concat(apiPath, "/test?key%3D42%26val=value"));
+    expect(queryToResourcePath(link, query, 'read')).toBe("".concat(apiPath, "/test?key%3D42%26val=value"));
   });
   it('should url encode special characters in string parameters', () => {
     const query = {
@@ -70,7 +84,7 @@ describe('queryToResourcePath', () => {
         param: 'value2&& 53'
       }
     };
-    expect(queryToResourcePath(apiPath, query)).toBe("".concat(apiPath, "/test?key=value%3F%3D42&param=value2%26%26%2053"));
+    expect(queryToResourcePath(link, query, 'read')).toBe("".concat(apiPath, "/test?key=value%3F%3D42&param=value2%26%26%2053"));
   });
   it('should support numeric (integer and float) parameters', () => {
     const query = {
@@ -80,7 +94,7 @@ describe('queryToResourcePath', () => {
         param: 193.75
       }
     };
-    expect(queryToResourcePath(apiPath, query)).toBe("".concat(apiPath, "/test?key=42&param=193.75"));
+    expect(queryToResourcePath(link, query, 'read')).toBe("".concat(apiPath, "/test?key=42&param=193.75"));
   });
   it('should support boolean parameters', () => {
     const query = {
@@ -90,7 +104,7 @@ describe('queryToResourcePath', () => {
         someflag: true
       }
     };
-    expect(queryToResourcePath(apiPath, query)).toBe("".concat(apiPath, "/test?key=42&someflag=true"));
+    expect(queryToResourcePath(link, query, 'read')).toBe("".concat(apiPath, "/test?key=42&someflag=true"));
   });
   it('should join array parameters with commas', () => {
     const query = {
@@ -99,7 +113,7 @@ describe('queryToResourcePath', () => {
         key: ['asdf', 123]
       }
     };
-    expect(queryToResourcePath(apiPath, query)).toBe("".concat(apiPath, "/test?key=asdf,123"));
+    expect(queryToResourcePath(link, query, 'read')).toBe("".concat(apiPath, "/test?key=asdf,123"));
   });
   it('should include multiple filter parameters when array of filters provided', () => {
     const query = {
@@ -108,7 +122,7 @@ describe('queryToResourcePath', () => {
         filter: ['asdf', 123]
       }
     };
-    expect(queryToResourcePath(apiPath, query)).toBe("".concat(apiPath, "/test?filter=asdf&filter=123"));
+    expect(queryToResourcePath(link, query, 'read')).toBe("".concat(apiPath, "/test?filter=asdf&filter=123"));
   });
   it('should NOT YET support name-aliased parameters', () => {
     const query = {
@@ -119,7 +133,7 @@ describe('queryToResourcePath', () => {
         }
       }
     };
-    expect(() => queryToResourcePath(apiPath, query)).toThrow();
+    expect(() => queryToResourcePath(link, query, 'read')).toThrow();
   });
   it('should throw if passed something crazy like a function', () => {
     const query = {
@@ -128,6 +142,25 @@ describe('queryToResourcePath', () => {
         key: a => a
       }
     };
-    expect(() => queryToResourcePath(apiPath, query)).toThrow();
+    expect(() => queryToResourcePath(link, query, 'read')).toThrow();
+  });
+  it('should return an unversioned endpoint for the new tracker importer (in version 2.37)', () => {
+    const query = {
+      resource: 'tracker'
+    };
+    expect(queryToResourcePath(link, query, 'read')).toBe("".concat(link.unversionedApiPath, "/tracker"));
+  });
+  it('should return a VERSIONED endpoint for the new tracker importer (in version 2.38)', () => {
+    const query = {
+      resource: 'tracker'
+    };
+    const v38config = { ...defaultConfig,
+      serverVersion: {
+        major: 2,
+        minor: 38,
+        patch: 0
+      }
+    };
+    expect(queryToResourcePath(createLink(v38config), query, 'read')).toBe("".concat(link.versionedApiPath, "/tracker"));
   });
 });

package/build/es/links/RestAPILink.js

@@ -5,29 +5,26 @@ import { joinPath } from './RestAPILink/path';
 import { queryToRequestOptions } from './RestAPILink/queryToRequestOptions';
 import { queryToResourcePath } from './RestAPILink/queryToResourcePath';
 export class RestAPILink {
-  constructor({
-    baseUrl,
-    apiVersion
-  }) {
-    _defineProperty(this, "apiPath", void 0);
+  constructor(config) {
+    _defineProperty(this, "config", void 0);
 
-    _defineProperty(this, "baseUrl", void 0);
+    _defineProperty(this, "versionedApiPath", void 0);
 
-    _defineProperty(this, "apiVersion", void 0);
+    _defineProperty(this, "unversionedApiPath", void 0);
 
-    this.baseUrl = baseUrl;
-    this.apiVersion = apiVersion;
-    this.apiPath = joinPath('api', String(apiVersion));
+    this.config = config;
+    this.versionedApiPath = joinPath('api', String(config.apiVersion));
+    this.unversionedApiPath = joinPath('api');
   }
 
   fetch(path, options) {
-    return fetchData(joinPath(this.baseUrl, path), options);
+    return fetchData(joinPath(this.config.baseUrl, path), options);
   }
 
   executeResourceQuery(type, query, {
     signal
   }) {
-    return this.fetch(queryToResourcePath(this.apiPath, query, type), queryToRequestOptions(type, query, signal));
+    return this.fetch(queryToResourcePath(this, query, type), queryToRequestOptions(type, query, signal));
   }
 
 }

package/build/types/links/RestAPILink/queryToResourcePath.d.ts

@@ -1,2 +1,3 @@
 import { ResolvedResourceQuery, FetchType } from '../../engine';
-export declare const queryToResourcePath: (apiPath: string, query: ResolvedResourceQuery, type: FetchType) => string;
+import { RestAPILink } from '../RestAPILink';
+export declare const queryToResourcePath: (link: RestAPILink, query: ResolvedResourceQuery, type: FetchType) => string;

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

@@ -1,13 +1,10 @@
+import type { Config } from '@dhis2/app-service-config';
 import { DataEngineLink, DataEngineLinkExecuteOptions, FetchType, JsonValue, ResolvedResourceQuery } from '../engine/';
-export interface RestAPILinkInput {
-    baseUrl: string;
-    apiVersion: number;
-}
 export declare class RestAPILink implements DataEngineLink {
-    private apiPath;
-    private baseUrl;
-    private apiVersion;
-    constructor({ baseUrl, apiVersion }: RestAPILinkInput);
+    readonly config: Config;
+    readonly versionedApiPath: string;
+    readonly unversionedApiPath: string;
+    constructor(config: Config);
     private fetch;
     executeResourceQuery(type: FetchType, query: ResolvedResourceQuery, { signal }: DataEngineLinkExecuteOptions): Promise<JsonValue>;
 }

package/package.json

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