Add support for creating / deleting warrants with a policy

Author: stanleyphu

src/modules/Authorization.ts

@@ -1,6 +1,6 @@
 import Feature from "./Feature";
 import Permission from "./Permission";
-import Check, { AccessCheckRequest, CheckMany, FeatureCheck, PermissionCheck } from "../types/Check";
+import Check, { AccessCheckRequest, CheckMany, CheckWarrantRequest, FeatureCheck, PermissionCheck } from "../types/Check";
 import Warrant, { isSubject, isWarrantObject } from "../types/Warrant";
 import WarrantClient from "../WarrantClient";
 
@@ -24,7 +24,7 @@ export default class Authorization {
     }
 
     public static async checkMany(check: CheckMany): Promise<boolean> {
-        let warrants: Warrant[] = check.warrants.map((warrant) => {
+        let warrants: CheckWarrantRequest[] = check.warrants.map((warrant) => {
             return {
                 objectType: isWarrantObject(warrant.object) ? warrant.object.getObjectType() : warrant.object.objectType,
                 objectId: isWarrantObject(warrant.object) ? warrant.object.getObjectId() : warrant.object.objectId,

src/modules/PricingTier.ts

@@ -5,7 +5,7 @@ import WarrantClient from "../WarrantClient";
 import { ListFeatureOptions } from "../types/Feature";
 import { ObjectType } from "../types/ObjectType";
 import { CreatePricingTierParams, ListPricingTierOptions } from "../types/PricingTier";
-import Warrant, { Context, WarrantObject } from "../types/Warrant";
+import Warrant, { PolicyContext, WarrantObject } from "../types/Warrant";
 
 export default class PricingTier implements WarrantObject {
     pricingTierId: string;
@@ -160,7 +160,7 @@ export default class PricingTier implements WarrantObject {
         return Feature.removeFeatureFromPricingTier(this.pricingTierId, featureId);
     }
 
-    public async hasFeature(featureId: string, context: Context = {}): Promise<boolean> {
+    public async hasFeature(featureId: string, context: PolicyContext = {}): Promise<boolean> {
         return Authorization.hasFeature({ featureId: featureId, subject: { objectType: ObjectType.PricingTier, objectId: this.pricingTierId }, context: context });
     }
 

src/modules/Role.ts

@@ -5,7 +5,7 @@ import WarrantClient from "../WarrantClient";
 import { ObjectType } from "../types/ObjectType";
 import { ListPermissionOptions } from "../types/Permission";
 import { CreateRoleParams, ListRoleOptions, UpdateRoleParams } from "../types/Role";
-import Warrant, { Context, WarrantObject } from "../types/Warrant";
+import Warrant, { PolicyContext, WarrantObject } from "../types/Warrant";
 
 export default class Role implements WarrantObject {
     roleId: string;
@@ -136,7 +136,7 @@ export default class Role implements WarrantObject {
         return Permission.removePermissionFromRole(this.roleId, permissionId);
     }
 
-    public async hasPermission(permissionId: string, context: Context = {}): Promise<boolean> {
+    public async hasPermission(permissionId: string, context: PolicyContext = {}): Promise<boolean> {
         return Authorization.hasPermission({ permissionId: permissionId, subject: { objectType: ObjectType.Role, objectId: this.roleId }, context: context });
     }
 

src/modules/Tenant.ts

@@ -9,7 +9,7 @@ import { ObjectType } from "../types/ObjectType";
 import { ListPricingTierOptions } from "../types/PricingTier";
 import { CreateTenantParams, ListTenantOptions, UpdateTenantParams } from "../types/Tenant";
 import { ListUserOptions } from "../types/User";
-import { Context, WarrantObject } from "../types/Warrant";
+import { PolicyContext, WarrantObject } from "../types/Warrant";
 
 export default class Tenant implements WarrantObject {
     // Tenant properties
@@ -150,7 +150,7 @@ export default class Tenant implements WarrantObject {
         return Feature.removeFeatureFromTenant(this.tenantId, featureId);
     }
 
-    public async hasFeature(featureId: string, context: Context = {}): Promise<boolean> {
+    public async hasFeature(featureId: string, context: PolicyContext = {}): Promise<boolean> {
         return Authorization.hasFeature({ featureId: featureId, subject: { objectType: ObjectType.Tenant, objectId: this.tenantId }, context: context });
     }
 

src/modules/User.ts

@@ -13,7 +13,7 @@ import { ListPricingTierOptions } from "../types/PricingTier";
 import { ListRoleOptions } from "../types/Role";
 import { CreateUserParams, ListUserOptions, UpdateUserParams } from "../types/User";
 import { ListTenantOptions } from "../types/Tenant";
-import { Context, WarrantObject } from "../types/Warrant";
+import { PolicyContext, WarrantObject } from "../types/Warrant";
 import WarrantModule from "./WarrantModule";
 
 export default class User implements WarrantObject {
@@ -174,7 +174,7 @@ export default class User implements WarrantObject {
         return Permission.removePermissionFromUser(this.userId, permissionId);
     }
 
-    public async hasPermission(permissionId: string, context: Context = {}): Promise<boolean> {
+    public async hasPermission(permissionId: string, context: PolicyContext = {}): Promise<boolean> {
         return Authorization.hasPermission({ permissionId: permissionId, subject: { objectType: ObjectType.User, objectId: this.userId }, context: context });
     }
 
@@ -202,7 +202,7 @@ export default class User implements WarrantObject {
         return Feature.removeFeatureFromUser(this.userId, featureId);
     }
 
-    public async hasFeature(featureId: string, context: Context = {}): Promise<boolean> {
+    public async hasFeature(featureId: string, context: PolicyContext = {}): Promise<boolean> {
         return Authorization.hasFeature({ featureId: featureId, subject: { objectType: ObjectType.User, objectId: this.userId }, context: context });
     }
 

src/modules/WarrantModule.ts

@@ -12,7 +12,7 @@ export default class WarrantModule {
                     objectId: isWarrantObject(warrant.object) ? warrant.object.getObjectId() : warrant.object.objectId,
                     relation: warrant.relation,
                     subject: isSubject(warrant.subject) ? warrant.subject : { objectType: warrant.subject.getObjectType(), objectId: warrant.subject.getObjectId() },
-                    context: warrant.context
+                    policy: warrant.policy
                 },
             });
         } catch (e) {
@@ -29,7 +29,7 @@ export default class WarrantModule {
                     objectId: isWarrantObject(warrant.object) ? warrant.object.getObjectId() : warrant.object.objectId,
                     relation: warrant.relation,
                     subject: isSubject(warrant.subject) ? warrant.subject : { objectType: warrant.subject.getObjectType(), objectId: warrant.subject.getObjectId() },
-                    context: warrant.context
+                    policy: warrant.policy
                 },
             });
         } catch (e) {

src/types/Check.ts

@@ -1,4 +1,4 @@
-import Warrant, { Context, Subject, WarrantObject, WarrantObjectLiteral } from "./Warrant";
+import Warrant, { PolicyContext, Subject, WarrantObject, WarrantObjectLiteral } from "./Warrant";
 
 export enum CheckOp {
     AllOf = "allOf",
@@ -9,7 +9,7 @@ export interface CheckWarrant {
     object: WarrantObject | WarrantObjectLiteral;
     relation: string;
     subject: WarrantObject | Subject;
-    context?: Context;
+    context?: PolicyContext;
 }
 
 export default interface Check extends CheckWarrant {
@@ -25,19 +25,27 @@ export interface CheckMany {
 export interface FeatureCheck {
     featureId: string;
     subject: WarrantObject | Subject;
-    context?: Context;
+    context?: PolicyContext;
     debug?: boolean;
 }
 
 export interface PermissionCheck {
     permissionId: string;
     subject: WarrantObject | Subject;
-    context?: Context;
+    context?: PolicyContext;
     debug?: boolean;
 }
 
+export interface CheckWarrantRequest {
+    objectType: string;
+    objectId: string;
+    relation: string;
+    subject: WarrantObject | Subject;
+    context?: PolicyContext;
+}
+
 export interface AccessCheckRequest {
     op?: CheckOp;
-    warrants: Warrant[];
+    warrants: CheckWarrantRequest[];
     debug?: boolean;
 }

src/types/Query.ts

@@ -1,17 +1,17 @@
-import { Context, isSubject, isWarrantObject, Subject, WarrantObject, WarrantObjectLiteral } from "./Warrant";
+import { isSubject, isWarrantObject, PolicyContext, Subject, WarrantObject, WarrantObjectLiteral } from "./Warrant";
 
 export interface ForClause {
     object?: WarrantObject | WarrantObjectLiteral;
     relation?: string;
     subject?: Subject | WarrantObject;
-    context?: Context;
+    context?: PolicyContext;
 }
 
 export interface WhereClause {
     object?: WarrantObject | WarrantObjectLiteral;
     relation?: string;
     subject?: Subject | WarrantObject;
-    context?: Context;
+    context?: PolicyContext;
 }
 
 export default class Query {

src/types/Session.ts

@@ -1,9 +1,9 @@
-import { Context } from "./Warrant";
+import { PolicyContext } from "./Warrant";
 
 export interface SessionParams {
     userId: string;
     ttl?: number;
-    context?: Context;
+    context?: PolicyContext;
 }
 
 export interface SelfServiceSessionParams extends SessionParams {

src/types/Warrant.ts

@@ -7,8 +7,8 @@ export interface ListWarrantOptions extends ListOptions {
     userId?: string;
 }
 
-export interface Context {
-    [key: string]: string;
+export interface PolicyContext {
+    [key: string]: any;
 }
 
 export interface Subject {
@@ -27,7 +27,7 @@ export default interface Warrant {
     objectId: string;
     relation: string;
     subject: Subject;
-    context?: Context;
+    policy?: string;
 }
 
 export interface WarrantObject {
@@ -48,5 +48,5 @@ export interface WarrantParams {
     object: WarrantObject | WarrantObjectLiteral;
     relation: string;
     subject: WarrantObject | Subject;
-    context?: Context;
+    policy?: string;
 }