Skip to content

Commit 5bb0b9c

Browse files
stanleyphustanleyphu
committed
Rename UserRequestOptions to WarrantRequestOptions
1 parent 5a6aca2 commit 5bb0b9c

File tree

12 files changed

+116
-116
lines changed

12 files changed

+116
-116
lines changed

‎src/HttpClient.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
import ApiError from "./types/ApiError";
2-
import { UserRequestOptions } from "./types/Params";
2+
import { WarrantRequestOptions } from "./types/WarrantRequestOptions";
33

44
const { version } = require("../package.json");
55

@@ -21,7 +21,7 @@ export interface HttpClientRequestOptions {
2121
data?: any;
2222
params?: any;
2323
url: string;
24-
options?: UserRequestOptions;
24+
options?: WarrantRequestOptions;
2525
}
2626

2727
interface RequestHeaders {

‎src/modules/Authorization.ts‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
import Feature from "./Feature";
22
import Permission from "./Permission";
33
import Check, { AccessCheckRequest, CheckMany, CheckWarrant, FeatureCheck, PermissionCheck } from "../types/Check";
4-
import { UserRequestOptions } from "../types/Params";
4+
import { WarrantRequestOptions } from "../types/WarrantRequestOptions";
55
import Warrant, { isSubject, isWarrantObject } from "../types/Warrant";
66
import WarrantClient from "../WarrantClient";
77

88
export default class Authorization {
9-
public static async check(check: Check, options: UserRequestOptions = {}): Promise<boolean> {
9+
public static async check(check: Check, options: WarrantRequestOptions = {}): Promise<boolean> {
1010
const accessCheckRequest: AccessCheckRequest = {
1111
warrants: [{
1212
object: check.object,
@@ -23,7 +23,7 @@ export default class Authorization {
2323
return this.authorize(accessCheckRequest, options);
2424
}
2525

26-
public static async checkMany(check: CheckMany, options: UserRequestOptions = {}): Promise<boolean> {
26+
public static async checkMany(check: CheckMany, options: WarrantRequestOptions = {}): Promise<boolean> {
2727
let warrants: CheckWarrant[] = check.warrants.map((warrant) => {
2828
return {
2929
object: warrant.object,
@@ -45,7 +45,7 @@ export default class Authorization {
4545
return this.authorize(accessCheckRequest, options);
4646
}
4747

48-
public static async hasFeature(featureCheck: FeatureCheck, options: UserRequestOptions = {}): Promise<boolean> {
48+
public static async hasFeature(featureCheck: FeatureCheck, options: WarrantRequestOptions = {}): Promise<boolean> {
4949
return this.check({
5050
object: new Feature(featureCheck.featureId),
5151
relation: "member",
@@ -55,7 +55,7 @@ export default class Authorization {
5555
}, options)
5656
}
5757

58-
public static async hasPermission(permissionCheck: PermissionCheck, options: UserRequestOptions = {}): Promise<boolean> {
58+
public static async hasPermission(permissionCheck: PermissionCheck, options: WarrantRequestOptions = {}): Promise<boolean> {
5959
return this.check({
6060
object: new Permission(permissionCheck.permissionId),
6161
relation: "member",
@@ -66,7 +66,7 @@ export default class Authorization {
6666
}
6767

6868
// Private methods
69-
private static async authorize(accessCheckRequest: AccessCheckRequest, options: UserRequestOptions = {}): Promise<boolean> {
69+
private static async authorize(accessCheckRequest: AccessCheckRequest, options: WarrantRequestOptions = {}): Promise<boolean> {
7070
try {
7171

7272
const response = await WarrantClient.httpClient.post({
@@ -84,7 +84,7 @@ export default class Authorization {
8484
}
8585
}
8686

87-
private static async edgeAuthorize(accessCheckRequest: AccessCheckRequest, options: UserRequestOptions = {}): Promise<boolean> {
87+
private static async edgeAuthorize(accessCheckRequest: AccessCheckRequest, options: WarrantRequestOptions = {}): Promise<boolean> {
8888
try {
8989
const response = await WarrantClient.httpClient.post({
9090
baseUrl: WarrantClient.config.authorizeEndpoint,

‎src/modules/Feature.ts‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import WarrantModule from "./WarrantModule";
22
import WarrantClient from "../WarrantClient";
33
import { CreateFeatureParams, ListFeatureOptions } from "../types/Feature";
4-
import { UserRequestOptions } from "../types/Params";
4+
import { WarrantRequestOptions } from "../types/WarrantRequestOptions";
55
import Warrant, { WarrantObject } from "../types/Warrant";
66
import { ObjectType } from "../types/ObjectType";
77

@@ -15,7 +15,7 @@ export default class Feature implements WarrantObject {
1515
//
1616
// Static methods
1717
//
18-
public static async create(feature: CreateFeatureParams, options: UserRequestOptions = {}): Promise<Feature> {
18+
public static async create(feature: CreateFeatureParams, options: WarrantRequestOptions = {}): Promise<Feature> {
1919
try {
2020
const response = await WarrantClient.httpClient.post({
2121
url: "/v1/features",
@@ -29,7 +29,7 @@ export default class Feature implements WarrantObject {
2929
}
3030
}
3131

32-
public static async get(featureId: string, options: UserRequestOptions = {}): Promise<Feature> {
32+
public static async get(featureId: string, options: WarrantRequestOptions = {}): Promise<Feature> {
3333
try {
3434
const response = await WarrantClient.httpClient.get({
3535
url: `/v1/features/${featureId}`,
@@ -42,7 +42,7 @@ export default class Feature implements WarrantObject {
4242
}
4343
}
4444

45-
public static async delete(featureId: string, options: UserRequestOptions = {}): Promise<void> {
45+
public static async delete(featureId: string, options: WarrantRequestOptions = {}): Promise<void> {
4646
try {
4747
return await WarrantClient.httpClient.delete({
4848
url: `/v1/features/${featureId}`,
@@ -53,7 +53,7 @@ export default class Feature implements WarrantObject {
5353
}
5454
}
5555

56-
public static async listFeatures(listOptions: ListFeatureOptions = {}, options: UserRequestOptions = {}): Promise<Feature[]> {
56+
public static async listFeatures(listOptions: ListFeatureOptions = {}, options: WarrantRequestOptions = {}): Promise<Feature[]> {
5757
try {
5858
const response = await WarrantClient.httpClient.get({
5959
url: "/v1/features",
@@ -67,7 +67,7 @@ export default class Feature implements WarrantObject {
6767
}
6868
}
6969

70-
public static async listFeaturesForPricingTier(pricingTierId: string, listOptions: ListFeatureOptions = {}, options: UserRequestOptions = {}): Promise<Feature[]> {
70+
public static async listFeaturesForPricingTier(pricingTierId: string, listOptions: ListFeatureOptions = {}, options: WarrantRequestOptions = {}): Promise<Feature[]> {
7171
try {
7272
const response = await WarrantClient.httpClient.get({
7373
url: `/v1/pricing-tiers/${pricingTierId}/features`,
@@ -81,7 +81,7 @@ export default class Feature implements WarrantObject {
8181
}
8282
}
8383

84-
public static async assignFeatureToPricingTier(pricingTierId: string, featureId: string, options: UserRequestOptions = {}): Promise<Warrant> {
84+
public static async assignFeatureToPricingTier(pricingTierId: string, featureId: string, options: WarrantRequestOptions = {}): Promise<Warrant> {
8585
return WarrantModule.create({
8686
object: {
8787
objectType: ObjectType.Feature,
@@ -95,7 +95,7 @@ export default class Feature implements WarrantObject {
9595
}, options);
9696
}
9797

98-
public static async removeFeatureFromPricingTier(pricingTierId: string, featureId: string, options: UserRequestOptions = {}): Promise<void> {
98+
public static async removeFeatureFromPricingTier(pricingTierId: string, featureId: string, options: WarrantRequestOptions = {}): Promise<void> {
9999
return WarrantModule.delete({
100100
object: {
101101
objectType: ObjectType.Feature,
@@ -109,7 +109,7 @@ export default class Feature implements WarrantObject {
109109
}, options);
110110
}
111111

112-
public static async listFeaturesForTenant(tenantId: string, listOptions: ListFeatureOptions = {}, options: UserRequestOptions = {}): Promise<Feature[]> {
112+
public static async listFeaturesForTenant(tenantId: string, listOptions: ListFeatureOptions = {}, options: WarrantRequestOptions = {}): Promise<Feature[]> {
113113
try {
114114
const response = await WarrantClient.httpClient.get({
115115
url: `/v1/tenants/${tenantId}/features`,
@@ -123,7 +123,7 @@ export default class Feature implements WarrantObject {
123123
}
124124
}
125125

126-
public static async assignFeatureToTenant(tenantId: string, featureId: string, options: UserRequestOptions = {}): Promise<Warrant> {
126+
public static async assignFeatureToTenant(tenantId: string, featureId: string, options: WarrantRequestOptions = {}): Promise<Warrant> {
127127
return WarrantModule.create({
128128
object: {
129129
objectType: ObjectType.Feature,
@@ -137,7 +137,7 @@ export default class Feature implements WarrantObject {
137137
}, options);
138138
}
139139

140-
public static async removeFeatureFromTenant(tenantId: string, featureId: string, options: UserRequestOptions = {}): Promise<void> {
140+
public static async removeFeatureFromTenant(tenantId: string, featureId: string, options: WarrantRequestOptions = {}): Promise<void> {
141141
return WarrantModule.delete({
142142
object: {
143143
objectType: ObjectType.Feature,
@@ -151,7 +151,7 @@ export default class Feature implements WarrantObject {
151151
}, options);
152152
}
153153

154-
public static async listFeaturesForUser(userId: string, listOptions: ListFeatureOptions = {}, options: UserRequestOptions = {}): Promise<Feature[]> {
154+
public static async listFeaturesForUser(userId: string, listOptions: ListFeatureOptions = {}, options: WarrantRequestOptions = {}): Promise<Feature[]> {
155155
try {
156156
const response = await WarrantClient.httpClient.get({
157157
url: `/v1/users/${userId}/features`,
@@ -165,7 +165,7 @@ export default class Feature implements WarrantObject {
165165
}
166166
}
167167

168-
public static async assignFeatureToUser(userId: string, featureId: string, options: UserRequestOptions = {}): Promise<Warrant> {
168+
public static async assignFeatureToUser(userId: string, featureId: string, options: WarrantRequestOptions = {}): Promise<Warrant> {
169169
return WarrantModule.create({
170170
object: {
171171
objectType: ObjectType.Feature,
@@ -179,7 +179,7 @@ export default class Feature implements WarrantObject {
179179
}, options);
180180
}
181181

182-
public static async removeFeatureFromUser(userId: string, featureId: string, options: UserRequestOptions = {}): Promise<void> {
182+
public static async removeFeatureFromUser(userId: string, featureId: string, options: WarrantRequestOptions = {}): Promise<void> {
183183
return WarrantModule.delete({
184184
object: {
185185
objectType: ObjectType.Feature,

‎src/modules/Permission.ts‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import WarrantModule from "./WarrantModule";
22
import WarrantClient from "../WarrantClient";
33
import { CreatePermissionParams, ListPermissionOptions, UpdatePermissionParams } from "../types/Permission";
44
import { ObjectType } from "../types/ObjectType";
5-
import { UserRequestOptions } from "../types/Params";
5+
import { WarrantRequestOptions } from "../types/WarrantRequestOptions";
66
import Warrant, { WarrantObject } from "../types/Warrant";
77

88
export default class Permission implements WarrantObject {
@@ -19,7 +19,7 @@ export default class Permission implements WarrantObject {
1919
//
2020
// Static methods
2121
//
22-
public static async create(permission: CreatePermissionParams, options: UserRequestOptions = {}): Promise<Permission> {
22+
public static async create(permission: CreatePermissionParams, options: WarrantRequestOptions = {}): Promise<Permission> {
2323
try {
2424
const response = await WarrantClient.httpClient.post({
2525
url: "/v1/permissions",
@@ -33,7 +33,7 @@ export default class Permission implements WarrantObject {
3333
}
3434
}
3535

36-
public static async get(permissionId: string, options: UserRequestOptions = {}): Promise<Permission> {
36+
public static async get(permissionId: string, options: WarrantRequestOptions = {}): Promise<Permission> {
3737
try {
3838
const response = await WarrantClient.httpClient.get({
3939
url: `/v1/permissions/${permissionId}`,
@@ -46,7 +46,7 @@ export default class Permission implements WarrantObject {
4646
}
4747
}
4848

49-
public static async update(permissionId: string, permission: UpdatePermissionParams, options: UserRequestOptions = {}): Promise<Permission> {
49+
public static async update(permissionId: string, permission: UpdatePermissionParams, options: WarrantRequestOptions = {}): Promise<Permission> {
5050
try {
5151
const response = await WarrantClient.httpClient.put({
5252
url: `/v1/permissions/${permissionId}`,
@@ -60,7 +60,7 @@ export default class Permission implements WarrantObject {
6060
}
6161
}
6262

63-
public static async delete(permissionId: string, options: UserRequestOptions = {}): Promise<void> {
63+
public static async delete(permissionId: string, options: WarrantRequestOptions = {}): Promise<void> {
6464
try {
6565
return await WarrantClient.httpClient.delete({
6666
url: `/v1/permissions/${permissionId}`,
@@ -71,7 +71,7 @@ export default class Permission implements WarrantObject {
7171
}
7272
}
7373

74-
public static async listPermissions(listOptions: ListPermissionOptions = {}, options: UserRequestOptions = {}): Promise<Permission[]> {
74+
public static async listPermissions(listOptions: ListPermissionOptions = {}, options: WarrantRequestOptions = {}): Promise<Permission[]> {
7575
try {
7676
const response = await WarrantClient.httpClient.get({
7777
url: "/v1/permissions",
@@ -85,7 +85,7 @@ export default class Permission implements WarrantObject {
8585
}
8686
}
8787

88-
public static async listPermissionsForUser(userId: string, listOptions: ListPermissionOptions = {}, options: UserRequestOptions = {}): Promise<Permission[]> {
88+
public static async listPermissionsForUser(userId: string, listOptions: ListPermissionOptions = {}, options: WarrantRequestOptions = {}): Promise<Permission[]> {
8989
try {
9090
const response = await WarrantClient.httpClient.get({
9191
url: `/v1/users/${userId}/permissions`,
@@ -99,7 +99,7 @@ export default class Permission implements WarrantObject {
9999
}
100100
}
101101

102-
public static async assignPermissionToUser(userId: string, permissionId: string, options: UserRequestOptions = {}): Promise<Warrant> {
102+
public static async assignPermissionToUser(userId: string, permissionId: string, options: WarrantRequestOptions = {}): Promise<Warrant> {
103103
return WarrantModule.create({
104104
object: {
105105
objectType: ObjectType.Permission,
@@ -113,7 +113,7 @@ export default class Permission implements WarrantObject {
113113
}, options);
114114
}
115115

116-
public static async removePermissionFromUser(userId: string, permissionId: string, options: UserRequestOptions = {}): Promise<void> {
116+
public static async removePermissionFromUser(userId: string, permissionId: string, options: WarrantRequestOptions = {}): Promise<void> {
117117
return WarrantModule.delete({
118118
object: {
119119
objectType: ObjectType.Permission,
@@ -127,7 +127,7 @@ export default class Permission implements WarrantObject {
127127
}, options);
128128
}
129129

130-
public static async listPermissionsForRole(roleId: string, listOptions: ListPermissionOptions = {}, options: UserRequestOptions = {}): Promise<Permission[]> {
130+
public static async listPermissionsForRole(roleId: string, listOptions: ListPermissionOptions = {}, options: WarrantRequestOptions = {}): Promise<Permission[]> {
131131
try {
132132
const response = await WarrantClient.httpClient.get({
133133
url: `/v1/roles/${roleId}/permissions`,
@@ -141,7 +141,7 @@ export default class Permission implements WarrantObject {
141141
}
142142
}
143143

144-
public static async assignPermissionToRole(roleId: string, permissionId: string, options: UserRequestOptions = {}): Promise<Warrant> {
144+
public static async assignPermissionToRole(roleId: string, permissionId: string, options: WarrantRequestOptions = {}): Promise<Warrant> {
145145
return WarrantModule.create({
146146
object: {
147147
objectType: ObjectType.Permission,
@@ -155,7 +155,7 @@ export default class Permission implements WarrantObject {
155155
}, options);
156156
}
157157

158-
public static async removePermissionFromRole(roleId: string, permissionId: string, options: UserRequestOptions = {}): Promise<void> {
158+
public static async removePermissionFromRole(roleId: string, permissionId: string, options: WarrantRequestOptions = {}): Promise<void> {
159159
return WarrantModule.delete({
160160
object: {
161161
objectType: ObjectType.Permission,

0 commit comments

Comments
 (0)