-
-
Notifications
You must be signed in to change notification settings - Fork 605
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1778 from matrix-org/travis/notifications-2
Add minimal types for "notification settings" UI
- Loading branch information
Showing
4 changed files
with
224 additions
and
40 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,164 @@ | ||
| /* | ||
| Copyright 2021 The Matrix.org Foundation C.I.C. | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| // allow camelcase as these are things that go onto the wire | ||
| /* eslint-disable camelcase */ | ||
|
|
||
| export enum PushRuleActionName { | ||
| DontNotify = "dont_notify", | ||
| Notify = "notify", | ||
| Coalesce = "coalesce", | ||
| } | ||
|
|
||
| export enum TweakName { | ||
| Highlight = "highlight", | ||
| Sound = "sound", | ||
| } | ||
|
|
||
| export type Tweak<N extends TweakName, V> = { | ||
| set_tweak: N; | ||
| value: V; | ||
| }; | ||
|
|
||
| export type TweakHighlight = Tweak<TweakName.Highlight, boolean>; | ||
| export type TweakSound = Tweak<TweakName.Sound, string>; | ||
|
|
||
| export type Tweaks = TweakHighlight | TweakSound; | ||
|
|
||
| export enum ConditionOperator { | ||
| ExactEquals = "==", | ||
| LessThan = "<", | ||
| GreaterThan = ">", | ||
| GreaterThanOrEqual = ">=", | ||
| LessThanOrEqual = "<=", | ||
| } | ||
|
|
||
| export type PushRuleAction = Tweaks | PushRuleActionName; | ||
|
|
||
| export type MemberCountCondition | ||
| <N extends number, Op extends ConditionOperator = ConditionOperator.ExactEquals> | ||
| = `${Op}${N}` | (Op extends ConditionOperator.ExactEquals ? `${N}` : never); | ||
|
|
||
| export type AnyMemberCountCondition = MemberCountCondition<number, ConditionOperator>; | ||
|
|
||
| export const DMMemberCountCondition: MemberCountCondition<2> = "2"; | ||
|
|
||
| export function isDmMemberCountCondition(condition: AnyMemberCountCondition): boolean { | ||
| return condition === "==2" || condition === "2"; | ||
| } | ||
|
|
||
| export enum ConditionKind { | ||
| EventMatch = "event_match", | ||
| ContainsDisplayName = "contains_display_name", | ||
| RoomMemberCount = "room_member_count", | ||
| SenderNotificationPermission = "sender_notification_permission", | ||
| } | ||
|
|
||
| export interface IPushRuleCondition<N extends ConditionKind | string> { | ||
| [k: string]: any; // for custom conditions, there can be other fields here | ||
| kind: N; | ||
| } | ||
|
|
||
| export interface IEventMatchCondition extends IPushRuleCondition<ConditionKind.EventMatch> { | ||
| key: string; | ||
| pattern: string; | ||
| } | ||
|
|
||
| export interface IContainsDisplayNameCondition extends IPushRuleCondition<ConditionKind.ContainsDisplayName> { | ||
| // no additional fields | ||
| } | ||
|
|
||
| export interface IRoomMemberCountCondition extends IPushRuleCondition<ConditionKind.RoomMemberCount> { | ||
| is: AnyMemberCountCondition; | ||
| } | ||
|
|
||
| export interface ISenderNotificationPermissionCondition | ||
| extends IPushRuleCondition<ConditionKind.SenderNotificationPermission> { | ||
| key: string; | ||
| } | ||
|
|
||
| export type PushRuleCondition = IPushRuleCondition<string> | ||
| | IEventMatchCondition | ||
| | IContainsDisplayNameCondition | ||
| | IRoomMemberCountCondition | ||
| | ISenderNotificationPermissionCondition; | ||
|
|
||
| export enum PushRuleKind { | ||
| Override = "override", | ||
| ContentSpecific = "content", | ||
| RoomSpecific = "room", | ||
| SenderSpecific = "sender", | ||
| Underride = "underride", | ||
| } | ||
|
|
||
| export enum RuleId { | ||
| Master = ".m.rule.master", | ||
| ContainsDisplayName = ".m.rule.contains_display_name", | ||
| ContainsUserName = ".m.rule.contains_user_name", | ||
| AtRoomNotification = ".m.rule.roomnotif", | ||
| DM = ".m.rule.room_one_to_one", | ||
| EncryptedDM = ".m.rule.encrypted_room_one_to_one", | ||
| Message = ".m.rule.message", | ||
| EncryptedMessage = ".m.rule.encrypted", | ||
| InviteToSelf = ".m.rule.invite_for_me", | ||
| MemberEvent = ".m.rule.member_event", | ||
| IncomingCall = ".m.rule.call", | ||
| SuppressNotices = ".m.rule.suppress_notices", | ||
| Tombstone = ".m.rule.tombstone", | ||
| } | ||
|
|
||
| export type PushRuleSet = { | ||
| [k in PushRuleKind]?: IPushRule[]; | ||
| }; | ||
|
|
||
| export interface IPushRule { | ||
| actions: PushRuleAction[]; | ||
| conditions?: PushRuleCondition[]; | ||
| default: boolean; | ||
| enabled: boolean; | ||
| pattern?: string; | ||
| rule_id: RuleId | string; | ||
| } | ||
|
|
||
| export interface IAnnotatedPushRule extends IPushRule { | ||
| kind: PushRuleKind; | ||
| } | ||
|
|
||
| export interface IPushRules { | ||
| global: PushRuleSet; | ||
| device?: PushRuleSet; | ||
| } | ||
|
|
||
| export interface IPusher { | ||
| app_display_name: string; | ||
| app_id: string; | ||
| data: { | ||
| format?: string; // TODO: Types | ||
| url?: string; // TODO: Required if kind==http | ||
| brand?: string; // TODO: For email notifications only? | ||
| }; | ||
| device_display_name: string; | ||
| kind: string; // TODO: Types | ||
| lang: string; | ||
| profile_tag?: string; | ||
| pushkey: string; | ||
| } | ||
|
|
||
| export interface IPusherRequest extends IPusher { | ||
| append?: boolean; | ||
| } | ||
|
|
||
| /* eslint-enable camelcase */ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,28 @@ | ||
| /* | ||
| Copyright 2021 The Matrix.org Foundation C.I.C. | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| export enum ThreepidMedium { | ||
| Email = "email", | ||
| Phone = "msisdn", | ||
| } | ||
|
|
||
| // TODO: Are these types universal, or specific to just /account/3pid? | ||
| export interface IThreepid { | ||
| medium: ThreepidMedium; | ||
| address: string; | ||
| validated_at: number; // eslint-disable-line camelcase | ||
| added_at: number; // eslint-disable-line camelcase | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters