@dhis2/app-service-data 3.14.5 → 3.14.7

package/README.md

@@ -8,4 +8,4 @@ This library is intended for use with the [DHIS2 Application Platform](https://g
 
 This package is internal to `@dhis2/app-runtime` and generally should not be installed independently.
 
-See [the docs](https://runtime.dhis2.nu) for more.
+See [the docs](https://developers.dhis2.org/docs/app-runtime/getting-started) for more.

package/build/cjs/engine/DataEngine.js

@@ -19,6 +19,11 @@ class DataEngine {
     _defineProperty(this, "link", void 0);
     this.link = link;
   }
+
+  // Overload 1: When no generic is provided, accept any Query and return inferred type
+
+  // Overload 2: When generic is provided, enforce that query keys match the generic keys
+
   query(query) {
     let {
       variables = {},

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

@@ -128,13 +128,13 @@ const isMetadataPackageInstallation = (type, _ref9) => {
   return type === 'create' && resource === 'synchronization/metadataPull';
 };
 
-// POST to 'indicators/expression/description' or 'programIndicator/expression/description' (validate an expression)
+// POST to 'indicators/expression/description', 'programIndicator/expression/description', or 'validationRules/expression/description' (validate an expression)
 exports.isMetadataPackageInstallation = isMetadataPackageInstallation;
 const isExpressionDescriptionValidation = (type, _ref0) => {
   let {
     resource
   } = _ref0;
-  const pattern = /^(indicators|programIndicators)\/expression\/description$/;
+  const pattern = /^(indicators|programIndicators|validationRules)\/expression\/description$/;
   return type === 'create' && pattern.test(resource);
 };
 

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

@@ -187,6 +187,16 @@ describe('isExpressionDescriptionValidation', () => {
       resource: 'programIndicators/expression/somethingelse'
     })).toBe(false);
   });
+  it('returns true for a POST to "validationRules/expression/description"', () => {
+    expect((0, _textPlainMatchers.isExpressionDescriptionValidation)('create', {
+      resource: 'validationRules/expression/description'
+    })).toBe(true);
+  });
+  it('retuns false for a POST to a different validationRules resource', () => {
+    expect((0, _textPlainMatchers.isExpressionDescriptionValidation)('create', {
+      resource: 'validationRules/expression/somethingelse'
+    })).toBe(false);
+  });
 });
 describe('isFilterDescriptionValidation', () => {
   it('returns true for a POST to "programIndicators/filter/description"', () => {

package/build/es/engine/DataEngine.js

@@ -13,6 +13,11 @@ export class DataEngine {
     _defineProperty(this, "link", void 0);
     this.link = link;
   }
+
+  // Overload 1: When no generic is provided, accept any Query and return inferred type
+
+  // Overload 2: When generic is provided, enforce that query keys match the generic keys
+
   query(query) {
     let {
       variables = {},

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

@@ -114,12 +114,12 @@ export const isMetadataPackageInstallation = (type, _ref9) => {
   return type === 'create' && resource === 'synchronization/metadataPull';
 };
 
-// POST to 'indicators/expression/description' or 'programIndicator/expression/description' (validate an expression)
+// POST to 'indicators/expression/description', 'programIndicator/expression/description', or 'validationRules/expression/description' (validate an expression)
 export const isExpressionDescriptionValidation = (type, _ref0) => {
   let {
     resource
   } = _ref0;
-  const pattern = /^(indicators|programIndicators)\/expression\/description$/;
+  const pattern = /^(indicators|programIndicators|validationRules)\/expression\/description$/;
   return type === 'create' && pattern.test(resource);
 };
 

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

@@ -185,6 +185,16 @@ describe('isExpressionDescriptionValidation', () => {
       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);
+  });
 });
 describe('isFilterDescriptionValidation', () => {
   it('returns true for a POST to "programIndicators/filter/description"', () => {

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

@@ -1,12 +1,13 @@
 import { DataEngineLink } from './types/DataEngineLink';
 import { QueryExecuteOptions } from './types/ExecuteOptions';
-import { JsonMap, JsonValue } from './types/JsonValue';
+import { JsonValue } from './types/JsonValue';
 import { Mutation } from './types/Mutation';
-import { Query } from './types/Query';
+import type { Query, ResourceQuery } from './types/Query';
 export declare class DataEngine {
     private link;
     constructor(link: DataEngineLink);
-    query(query: Query, { variables, signal, onComplete, onError, }?: QueryExecuteOptions): Promise<JsonMap>;
+    query(query: Query, options?: QueryExecuteOptions): Promise<Record<keyof typeof query, unknown>>;
+    query<T extends Record<string, unknown>>(query: Record<keyof T, ResourceQuery>, options?: QueryExecuteOptions): Promise<T>;
     mutate(mutation: Mutation, { variables, signal, onComplete, onError, }?: QueryExecuteOptions): Promise<JsonValue>;
 }
 export default DataEngine;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@dhis2/app-service-data",
-    "version": "3.14.5",
+    "version": "3.14.7",
     "main": "./build/cjs/index.js",
     "module": "./build/es/index.js",
     "types": "build/types/index.d.ts",
@@ -37,7 +37,7 @@
         "prop-types": "^15.7.2"
     },
     "peerDependencies": {
-        "@dhis2/app-service-config": "3.14.5",
+        "@dhis2/app-service-config": "3.14.7",
         "react": "^16.8.6 || ^18",
         "react-dom": "^16.8.6 || ^18"
     }