Matrix-Mirrors/mjolnir
1
0
Fork 0
mirror of https://github.com/matrix-org/mjolnir.git synced 2024-07-01 00:51:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

remove IProtectionSetting, just use AbstractProtectionSetting

Browse Source
This commit is contained in:
jesopo 2022-01-25 14:09:29 +00:00
parent 6e7763ae84
commit 04b88b9161
2 changed files with 19 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/protections/IProtection.ts
View File

@ -15,7 +15,7 @@ limitations under the License.
*/ */
import { Mjolnir } from "../Mjolnir"; import { Mjolnir } from "../Mjolnir";
import { IProtectionSetting } from "./ProtectionSettings"; import { AbstractProtectionSetting } from "./ProtectionSettings";
/** /**
* Represents a protection mechanism of sorts. Protections are intended to be * Represents a protection mechanism of sorts. Protections are intended to be
@ -25,6 +25,6 @@ import { IProtectionSetting } from "./ProtectionSettings";
*/ */
export interface IProtection { export interface IProtection {
readonly name: string; readonly name: string;
settings: { [setting: string]: IProtectionSetting<any, any> }; settings: { [setting: string]: AbstractProtectionSetting<any, any> };
handleEvent(mjolnir: Mjolnir, roomId: string, event: any): Promise<any>; handleEvent(mjolnir: Mjolnir, roomId: string, event: any): Promise<any>;
} }

44
src/protections/ProtectionSettings.ts
View File

@ -16,7 +16,7 @@ limitations under the License.
export class ProtectionSettingValidationError extends Error {}; export class ProtectionSettingValidationError extends Error {};
export interface IProtectionSetting<TChange, TValue> { export class AbstractProtectionSetting<TChange, TValue> {
// the current value of this setting // the current value of this setting
value: TValue value: TValue
@ -26,7 +26,9 @@ export interface IProtectionSetting<TChange, TValue> {
* @param data Serialised value * @param data Serialised value
* @returns Deserialised value or undefined if deserialisation failed * @returns Deserialised value or undefined if deserialisation failed
*/ */
fromString(data: string): TChange | undefined; fromString(data: string): TChange | undefined {
throw new Error("not Implemented");
}
/* /*
* Check whether a given value is valid for this setting * Check whether a given value is valid for this setting
@ -34,53 +36,41 @@ export interface IProtectionSetting<TChange, TValue> {
* @param data Setting value * @param data Setting value
* @returns Validity of provided value * @returns Validity of provided value
*/ */
validate(data: TChange): boolean; validate(data: TChange): boolean {
throw new Error("not Implemented");
}
/* /*
* Store a value in this setting, only to be used after `validate()` * Store a value in this setting, only to be used after `validate()`
* @param data Validated setting value * @param data Validated setting value
*/ */
setValue(data: TValue): void; setValue(data: TValue) {
this.value = data;
}
} }
export interface IProtectionListSetting<TChange, TValue> extends IProtectionSetting<TChange, TValue> { export class AbstractProtectionListSetting<TChange, TValue> extends AbstractProtectionSetting<TChange, TValue> {
/* /*
* Add `data` to the current setting value, and return that new object * Add `data` to the current setting value, and return that new object
* *
* @param data Value to add to the current setting value * @param data Value to add to the current setting value
* @returns The potential new value of this setting object * @returns The potential new value of this setting object
*/ */
addValue(data: TChange): TValue; addValue(data: TChange): TValue {
throw new Error("not Implemented");
}
/* /*
* Remove `data` from the current setting value, and return that new object * Remove `data` from the current setting value, and return that new object
* *
* @param data Value to remove from the current setting value * @param data Value to remove from the current setting value
* @returns The potential new value of this setting object * @returns The potential new value of this setting object
*/ */
removeValue(data: TChange): TValue;
}
class AbstractProtectionSetting<TChange, TValue> implements IProtectionSetting<TChange, TValue> {
value: TValue
fromString(data: string): TChange | undefined {
throw new Error("not Implemented");
}
validate(data: TChange): boolean {
throw new Error("not Implemented");
}
setValue(data: TValue) {
this.value = data;
}
}
class AbstractProtectionListSetting<TChange, TValue> extends AbstractProtectionSetting<TChange, TValue> implements IProtectionListSetting<TChange, TValue> {
addValue(data: TChange): TValue {
throw new Error("not Implemented");
}
removeValue(data: TChange): TValue { removeValue(data: TChange): TValue {
throw new Error("not Implemented"); throw new Error("not Implemented");
} }
} }
export function isListSetting(object: any): object is IProtectionListSetting<any, any> { export function isListSetting(object: any): object is AbstractProtectionListSetting<any, any> {
return ("addValue" in object && "removeValue" in object); return object instanceof AbstractProtectionListSetting;
} }