[Issue #189] Add CanReadAll() and CanWriteAll()

Author: DrewImm

CHANGELOG.md

@@ -3,7 +3,7 @@
 ## [3.2.0] Aug-19-2019
 
 ### Additions
-
+- [Issue #189] Add CanReadAll() and CanWriteAll()
 
 ## [3.1.0] Aug-06-2019
 

src/bodyguard.ts

@@ -130,7 +130,7 @@
  */
 
 /**
- * Bodyguard Decorators
+ * # Bodyguard Decorators
  */
 import 'reflect-metadata';
 import { BodyguardOwner, UserRole } from './enums';
@@ -142,6 +142,60 @@ const CanSearchSymbol = Symbol('CanSearch');
 const CanSearchRelationSymbol = Symbol('CanSearchRelation');
 const CanReadRelationSymbol = Symbol('CanReadRelationSymbol');
 
+/**
+ * ## Class Decorators
+ */
+
+/**
+ * Get if all members are readable
+ * NOTE:	This function only checks if the CanReadAll() decorator is present.
+ * 			Individual fields may have fine-grain access rights, which this
+ * 			function will ignore. Use getCanRead() instead for authorization.
+ * @param target Object to test
+ */
+export function getCanReadAll(target: any) {
+	return target.canReadAll;
+}
+
+/**
+ * Get if all members are writable
+ * NOTE:	This function only checks if the CanWriteAll() decorator is present.
+ * 			Individual fields may have fine-grain access rights, which this
+ * 			function will ignore. Use getCanWrite() instead for authorization.
+ * @param target Object to test
+ */
+export function getCanWriteAll(target: any) {
+	return target.canWriteAll;
+}
+
+/**
+ * All class members are readable
+ * @param who Who can read the fields. Default is anyone
+ */
+export function CanReadAll(
+	who: BodyguardOwner | UserRole = BodyguardOwner.Anyone
+) {
+	return (constructor) => {
+		constructor.prototype.canReadAll = who;
+	};
+}
+
+/**
+ * All class members are readable
+ * @param who Who can read the fields. Default is anyone
+ */
+export function CanWriteAll(
+	who: BodyguardOwner | UserRole = BodyguardOwner.Anyone
+) {
+	return (constructor) => {
+		constructor.prototype.canWriteAll = who;
+	};
+}
+
+/**
+ * ## Member Decorators
+ */
+
 /**
  * Check if the key is a bodyguard key
  * @param target Object to test
@@ -157,7 +211,10 @@ export function isBodyguardKey(target: any, propertyKey: string): boolean {
  * @param propertyKey Key to check
  */
 export function getCanRead(target: any, propertyKey: string): string {
-	return Reflect.getMetadata(CanReadSymbol, target, propertyKey);
+	return (
+		Reflect.getMetadata(CanReadSymbol, target, propertyKey) ||
+		getCanReadAll(target)
+	);
 }
 
 /**
@@ -166,7 +223,10 @@ export function getCanRead(target: any, propertyKey: string): string {
  * @param propertyKey Key to check
  */
 export function getCanWrite(target: any, propertyKey: string): string {
-	return Reflect.getMetadata(CanWriteSymbol, target, propertyKey);
+	return (
+		Reflect.getMetadata(CanWriteSymbol, target, propertyKey) ||
+		getCanWriteAll(target)
+	);
 }
 
 /**

test/spec/api/bodyguard/bodyguard.spec.ts

@@ -14,10 +14,14 @@ import {
 	CanRead,
 	CanWrite,
 	CanSearch,
-	CanSearchRelation
+	CanSearchRelation,
+	CanReadAll,
+	CanWriteAll,
+	getCanReadAll,
+	getCanWriteAll
 } from '../../../../src/bodyguard';
 import { BaseModel } from '../../../../src/models';
-import { BodyguardOwner } from '../../../../src/enums';
+import { BodyguardOwner, UserRole } from '../../../../src/enums';
 
 class ExampleModel extends BaseModel {
 	@BodyguardKey() public bodyguardKey: number = undefined;
@@ -48,6 +52,76 @@ class ExampleModel extends BaseModel {
 }
 const example = new ExampleModel();
 
+@CanReadAll()
+class ExampleReadableModel extends BaseModel {
+	public testField1: string = undefined;
+}
+const exampleReadable = new ExampleReadableModel();
+
+@CanWriteAll()
+class ExampleWritableModel extends BaseModel {
+	public testField1: string = undefined;
+}
+const exampleWritable = new ExampleWritableModel();
+
+@CanReadAll(UserRole.Admin)
+class AdminReadableModel extends BaseModel {
+	public testField1: string = undefined;
+}
+const adminReadable = new AdminReadableModel();
+
+@CanWriteAll(UserRole.Admin)
+class AdminWritableModel extends BaseModel {
+	public testField1: string = undefined;
+}
+const adminWritable = new AdminWritableModel();
+
+@CanReadAll()
+class MixedReadableModel extends BaseModel {
+	public anyoneCanReadThisField: string = undefined;
+
+	@CanRead(UserRole.Admin)
+	public butOnlyAdminCanReadThisOne: string = undefined;
+}
+const mixedReadable = new MixedReadableModel();
+
+@CanWriteAll()
+class MixedWritableModel extends BaseModel {
+	public anyoneCanWriteThisField: string = undefined;
+
+	@CanWrite(UserRole.Admin)
+	public butOnlyAdminCanWriteThisOne: string = undefined;
+}
+const mixedWritable = new MixedWritableModel();
+
+/**
+ * getCanReadAll()
+ * pointyapi/bodyguard
+ */
+describe('getCanReadAll()', () => {
+	it('returns anyone if no parameter is set', () => {
+		expect(getCanReadAll(exampleReadable)).toEqual(BodyguardOwner.Anyone);
+	});
+
+	it('returns role if set as parameter', () => {
+		expect(getCanReadAll(adminReadable)).toEqual(UserRole.Admin);
+	});
+});
+
+/**
+ * getCanWriteAll()
+ * pointyapi/bodyguard
+ */
+describe('getCanWriteAll()', () => {
+	it('returns anyone if no parameter is set', () => {
+		expect(getCanWriteAll(exampleWritable)).toEqual(BodyguardOwner.Anyone);
+	});
+
+	it('returns role if set as parameter', () => {
+		expect(getCanWriteAll(adminWritable)).toEqual(UserRole.Admin);
+	});
+});
+
 /**
  * isBodyguardKey()
  * pointyapi/bodyguard
@@ -91,8 +165,16 @@ describe('getCanRead()', () => {
 		);
 	});
 
-	it('returns undefined if the member is not readable', () => {
-		expect(getCanRead(example, 'bodyguardKey')).toBe(undefined);
+	it('returns anyone if the class has CanReadAll()', () => {
+		expect(getCanRead(mixedReadable, 'anyoneCanReadThisField')).toEqual(
+			BodyguardOwner.Anyone
+		);
+	});
+
+	it('returns UserRole.Admin if CanReadAll() has been overridden', () => {
+		expect(getCanRead(mixedReadable, 'butOnlyAdminCanReadThisOne')).toEqual(
+			UserRole.Admin
+		);
 	});
 });
 
@@ -128,6 +210,18 @@ describe('getCanWrite()', () => {
 	it('returns undefined if the member is not writeable', () => {
 		expect(getCanWrite(example, 'bodyguardKey')).toBe(undefined);
 	});
+
+	it('returns anyone if the class has CanWriteAll()', () => {
+		expect(getCanWrite(mixedWritable, 'anyoneCanWriteThisField')).toEqual(
+			BodyguardOwner.Anyone
+		);
+	});
+
+	it('returns UserRole.Admin if CanWriteAll() has been overridden', () => {
+		expect(
+			getCanWrite(mixedWritable, 'butOnlyAdminCanWriteThisOne')
+		).toEqual(UserRole.Admin);
+	});
 });
 
 /**