Add context support to query method (#56)

Author: kkajla12

src/modules/WarrantModule.ts

@@ -3,6 +3,7 @@ import { API_VERSION } from "../constants";
 import {
     ListResponse,
     ListWarrantParams,
+    QueryParams,
     QueryListParams,
     QueryResult,
     Warrant,
@@ -49,13 +50,24 @@ export default class WarrantModule {
         });
     }
 
-    public static async query(query: string, listParams: QueryListParams = {}, options: WarrantRequestOptions = {}): Promise<ListResponse<QueryResult>> {
+    public static async query(query: string | QueryParams, listParams: QueryListParams = {}, options: WarrantRequestOptions = {}): Promise<ListResponse<QueryResult>> {
+        const params: any = {
+            ...listParams,
+        };
+
+        // preserve backwards compatibility
+        if (typeof query === "string") {
+            params.q = query;
+        } else {
+            params.q = query.query;
+            if (query.context) {
+                params.context = JSON.stringify(query.context);
+            }
+        }
+
         return await WarrantClient.httpClient.get({
             url: `/${API_VERSION}/query`,
-            params: {
-                q: query,
-                ...listParams,
-            },
+            params: params,
             options,
         });
     }

src/types/Query.ts

@@ -1,6 +1,11 @@
-import { Warrant } from "./Warrant";
+import { Warrant, PolicyContext } from "./Warrant";
 import { ListParams } from "./List";
 
+export interface QueryParams {
+    query: string;
+    context?: PolicyContext;
+}
+
 export interface QueryResult {
     objectType: string;
     objectId: string;

src/types/index.ts

@@ -58,6 +58,7 @@ export {
     Subject,
 } from "./Warrant";
 export {
+    QueryParams,
     QueryResult,
     QueryListParams,
 } from "./Query";

test/LiveTest.spec.ts

@@ -933,6 +933,12 @@ describe.skip('Live Test', function () {
             relation: "member",
             subject: role1,
         });
+        await this.warrant.Warrant.create({
+            object: permission1,
+            relation: "member",
+            subject: role2,
+            policy: "tenantId == 123",
+        });
         await this.warrant.Role.assignRoleToUser(userA.userId, role1.roleId);
         await this.warrant.Role.assignRoleToUser(userB.userId, role2.roleId);
 
@@ -958,6 +964,20 @@ describe.skip('Live Test', function () {
         assert.strictEqual("role", resultSet.results[0].warrant.subject.objectType);
         assert.strictEqual("role1", resultSet.results[0].warrant.subject.objectId);
 
+        resultSet = await this.warrant.Warrant.query({
+            query: "select permission where user:userB is member",
+            context: {
+                tenantId: 123,
+            },
+        });
+        assert.strictEqual(3, resultSet.results.length);
+        assert.strictEqual("permission", resultSet.results[0].objectType);
+        assert.strictEqual("perm1", resultSet.results[0].objectId);
+        assert.strictEqual("permission", resultSet.results[1].objectType);
+        assert.strictEqual("perm2", resultSet.results[1].objectId);
+        assert.strictEqual("permission", resultSet.results[2].objectType);
+        assert.strictEqual("perm3", resultSet.results[2].objectId);
+
         let warrantToken = await this.warrant.Role.delete(role1.roleId);
         assert(warrantToken);
         warrantToken = await this.warrant.Role.delete(role2.roleId);
@@ -972,5 +992,5 @@ describe.skip('Live Test', function () {
         assert(warrantToken);
         warrantToken = await this.warrant.User.delete(userB.userId);
         assert(warrantToken);
-    })
+    });
 });