@pgds/api-interface 1.3.2 → 1.3.4

package/lib/models/ReqUser.d.ts

@@ -24,9 +24,22 @@ export declare class ReqUser {
      * Returns the organizationIds in the hierarchy of the inputted organizationId
      * Input must be inside the user's organization hierarchy.
      * If no organization is inputted, it returns the ids in the user's organization hierarchy.
+     * If the organizationId is not in the user's hierarchy, it returns that id without any children. The reason for this is to prevent returning all organizations in the system if the result from this function is an empty array and used in a query.
      *
      * @param organizationId The organizationId to get the children of
+     * @param toOrganization Where to stop the search
+     * @returns {string[]} Organization tree ids in no particular order
+     *
+     * ```
+     *  const organizationTreeIds = getOrganizationTreeIds("org1");
+     * console.log(organizationTreeIds); // ["org1", "org2", "org3"]
+     *
+     * const organizationTreeIds = getOrganizationTreeIds("org1", "org2");
+     * console.log(organizationTreeIds); // ["org1", "org2"]
+     * ```
      */
-    getOrganizationTreeIds(organizationId?: string): string[];
+    getOrganizationTreeIds(organizationId?: string, toOrganization?: string): string[];
+    private getOrganizationTreeFromToIds;
+    private getCompleteOrganizationTreeIds;
 }
 export {};

package/lib/models/ReqUser.js

@@ -14,10 +14,57 @@ var ReqUser = /** @class */ (function () {
      * Returns the organizationIds in the hierarchy of the inputted organizationId
      * Input must be inside the user's organization hierarchy.
      * If no organization is inputted, it returns the ids in the user's organization hierarchy.
+     * If the organizationId is not in the user's hierarchy, it returns that id without any children. The reason for this is to prevent returning all organizations in the system if the result from this function is an empty array and used in a query.
      *
      * @param organizationId The organizationId to get the children of
+     * @param toOrganization Where to stop the search
+     * @returns {string[]} Organization tree ids in no particular order
+     *
+     * ```
+     *  const organizationTreeIds = getOrganizationTreeIds("org1");
+     * console.log(organizationTreeIds); // ["org1", "org2", "org3"]
+     *
+     * const organizationTreeIds = getOrganizationTreeIds("org1", "org2");
+     * console.log(organizationTreeIds); // ["org1", "org2"]
+     * ```
      */
-    ReqUser.prototype.getOrganizationTreeIds = function (organizationId) {
+    ReqUser.prototype.getOrganizationTreeIds = function (organizationId, toOrganization) {
+        if (toOrganization) {
+            return this.getOrganizationTreeFromToIds(organizationId, toOrganization);
+        }
+        else {
+            return this.getCompleteOrganizationTreeIds(organizationId);
+        }
+    };
+    ReqUser.prototype.getOrganizationTreeFromToIds = function (fromOrganization, toOrganization) {
+        if ((!this.organizationHierarchy[toOrganization] &&
+            !Object.values(this.organizationHierarchy).includes(toOrganization)) ||
+            (!this.organizationHierarchy[fromOrganization] &&
+                !Object.values(this.organizationHierarchy).includes(fromOrganization))) {
+            return [toOrganization];
+        }
+        var stack = [];
+        var visited = new Set();
+        var result = [];
+        stack.push(toOrganization);
+        while (stack.length > 0) {
+            var currentOrgId = stack.pop();
+            if (visited.has(currentOrgId) || currentOrgId === fromOrganization) {
+                continue;
+            }
+            visited.add(currentOrgId);
+            for (var _i = 0, _a = Object.entries(this.organizationHierarchy); _i < _a.length; _i++) {
+                var _b = _a[_i], childId = _b[0], parentId = _b[1];
+                if (childId === currentOrgId && !visited.has(parentId)) {
+                    stack.push(parentId);
+                    result.push(currentOrgId);
+                }
+            }
+        }
+        result.push(fromOrganization);
+        return result;
+    };
+    ReqUser.prototype.getCompleteOrganizationTreeIds = function (organizationId) {
         var stack = [];
         var visited = new Set();
         var result = [];
@@ -27,6 +74,11 @@ var ReqUser = /** @class */ (function () {
         else {
             stack.push(organizationId);
         }
+        if (organizationId !== undefined &&
+            organizationId !== this.organizationId &&
+            !Object.keys(this.organizationHierarchy).includes(organizationId)) {
+            return [];
+        }
         while (stack.length > 0) {
             var currentOrgId = stack.pop();
             if (visited.has(currentOrgId)) {

package/lib/models/ReqUser.js.map

@@ -1 +1 @@
-{"version":3,"file":"ReqUser.js","sourceRoot":"","sources":["ReqUser.ts"],"names":[],"mappings":";;;AAMA;IAaE,iBAAY,EAYX;YAXC,MAAM,YAAA,EACN,cAAc,oBAAA,EACd,UAAU,gBAAA,EACV,WAAW,iBAAA,EACX,qBAAqB,2BAAA;QAQrB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,qBAAqB,GAAG,qBAAqB,CAAC;IACrD,CAAC;IAED;;;;;;OAMG;IACI,wCAAsB,GAA7B,UAA8B,cAAuB;QACnD,IAAM,KAAK,GAAa,EAAE,CAAC;QAC3B,IAAM,OAAO,GAAG,IAAI,GAAG,EAAU,CAAC;QAClC,IAAM,MAAM,GAAa,EAAE,CAAC;QAE5B,IAAI,CAAC,cAAc,IAAI,cAAc,KAAK,IAAI,CAAC,cAAc,EAAE,CAAC;YAC9D,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAClC,CAAC;aAAM,CAAC;YACN,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC7B,CAAC;QAED,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxB,IAAM,YAAY,GAAG,KAAK,CAAC,GAAG,EAAG,CAAC;YAElC,IAAI,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,CAAC;gBAC9B,SAAS;YACX,CAAC;YAED,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;YAC1B,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YAE1B,KAAkC,UAA0C,EAA1C,KAAA,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,CAAC,EAA1C,cAA0C,EAA1C,IAA0C,EAAE,CAAC;gBAApE,IAAA,WAAmB,EAAlB,OAAO,QAAA,EAAE,QAAQ,QAAA;gBAC3B,IAAI,QAAQ,KAAK,YAAY,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;oBACvD,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBACtB,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IACH,cAAC;AAAD,CAAC,AAtED,IAsEC;AAtEY,0BAAO"}
+{"version":3,"file":"ReqUser.js","sourceRoot":"","sources":["ReqUser.ts"],"names":[],"mappings":";;;AAMA;IAaE,iBAAY,EAYX;YAXC,MAAM,YAAA,EACN,cAAc,oBAAA,EACd,UAAU,gBAAA,EACV,WAAW,iBAAA,EACX,qBAAqB,2BAAA;QAQrB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACrC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,qBAAqB,GAAG,qBAAqB,CAAC;IACrD,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACI,wCAAsB,GAA7B,UAA8B,cAAuB,EAAE,cAAuB;QAC5E,IAAI,cAAc,EAAE,CAAC;YACnB,OAAO,IAAI,CAAC,4BAA4B,CAAC,cAAe,EAAE,cAAc,CAAC,CAAC;QAC5E,CAAC;aAAM,CAAC;YACN,OAAO,IAAI,CAAC,8BAA8B,CAAC,cAAc,CAAC,CAAC;QAC7D,CAAC;IACH,CAAC;IAEO,8CAA4B,GAApC,UAAqC,gBAAwB,EAAE,cAAsB;QACnF,IACE,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC,cAAc,CAAC;YAC1C,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;YACtE,CAAC,CAAC,IAAI,CAAC,qBAAqB,CAAC,gBAAgB,CAAC;gBAC5C,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC,EACxE,CAAC;YACD,OAAO,CAAC,cAAc,CAAC,CAAC;QAC1B,CAAC;QAED,IAAM,KAAK,GAAa,EAAE,CAAC;QAC3B,IAAM,OAAO,GAAG,IAAI,GAAG,EAAU,CAAC;QAClC,IAAM,MAAM,GAAa,EAAE,CAAC;QAE5B,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAE3B,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxB,IAAM,YAAY,GAAG,KAAK,CAAC,GAAG,EAAG,CAAC;YAElC,IAAI,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,IAAI,YAAY,KAAK,gBAAgB,EAAE,CAAC;gBACnE,SAAS;YACX,CAAC;YAED,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;YAE1B,KAAkC,UAA0C,EAA1C,KAAA,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,CAAC,EAA1C,cAA0C,EAA1C,IAA0C,EAAE,CAAC;gBAApE,IAAA,WAAmB,EAAlB,OAAO,QAAA,EAAE,QAAQ,QAAA;gBAC3B,IAAI,OAAO,KAAK,YAAY,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC;oBACvD,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;oBACrB,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;gBAC5B,CAAC;YACH,CAAC;QACH,CAAC;QAED,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;QAC9B,OAAO,MAAM,CAAC;IAChB,CAAC;IAEO,gDAA8B,GAAtC,UAAuC,cAAuB;QAC5D,IAAM,KAAK,GAAa,EAAE,CAAC;QAC3B,IAAM,OAAO,GAAG,IAAI,GAAG,EAAU,CAAC;QAClC,IAAM,MAAM,GAAa,EAAE,CAAC;QAE5B,IAAI,CAAC,cAAc,IAAI,cAAc,KAAK,IAAI,CAAC,cAAc,EAAE,CAAC;YAC9D,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAClC,CAAC;aAAM,CAAC;YACN,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QAC7B,CAAC;QAED,IACE,cAAc,KAAK,SAAS;YAC5B,cAAc,KAAK,IAAI,CAAC,cAAc;YACtC,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAAC,CAAC,QAAQ,CAAC,cAAe,CAAC,EAClE,CAAC;YACD,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,OAAO,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxB,IAAM,YAAY,GAAG,KAAK,CAAC,GAAG,EAAG,CAAC;YAElC,IAAI,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,EAAE,CAAC;gBAC9B,SAAS;YACX,CAAC;YAED,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC;YAC1B,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;YAE1B,KAAkC,UAA0C,EAA1C,KAAA,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,CAAC,EAA1C,cAA0C,EAA1C,IAA0C,EAAE,CAAC;gBAApE,IAAA,WAAmB,EAAlB,OAAO,QAAA,EAAE,QAAQ,QAAA;gBAC3B,IAAI,QAAQ,KAAK,YAAY,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;oBACvD,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBACtB,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,MAAM,CAAC;IAChB,CAAC;IACH,cAAC;AAAD,CAAC,AAtID,IAsIC;AAtIY,0BAAO"}

package/package.json

@@ -2,7 +2,7 @@
     "name": "@pgds/api-interface",
     "description": "Api interface for pgds services",
     "authors": "Florry",
-    "version": "1.3.2",
+    "version": "1.3.4",
     "main": "index.js",
     "types": "types/",
     "scripts": {
@@ -100,4 +100,4 @@
             "**/*.js.map"
         ]
     }
-}
+}