summaryrefslogtreecommitdiff
path: root/web/source/settings/lib/types/interaction.ts
blob: caedd95445eb2de23922cd7db8939e688b891019 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
/*
	GoToSocial
	Copyright (C) GoToSocial Authors admin@gotosocial.org
	SPDX-License-Identifier: AGPL-3.0-or-later

	This program is free software: you can redistribute it and/or modify
	it under the terms of the GNU Affero General Public License as published by
	the Free Software Foundation, either version 3 of the License, or
	(at your option) any later version.

	This program is distributed in the hope that it will be useful,
	but WITHOUT ANY WARRANTY; without even the implied warranty of
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
	GNU Affero General Public License for more details.

	You should have received a copy of the GNU Affero General Public License
	along with this program.  If not, see <http://www.gnu.org/licenses/>.
*/

import { Links } from "parse-link-header";
import { Account } from "./account";
import { Status } from "./status";

export interface DefaultInteractionPolicies {
	direct: InteractionPolicy;
	private: InteractionPolicy;
	unlisted: InteractionPolicy;
	public: InteractionPolicy;
}

export interface UpdateDefaultInteractionPolicies {
	direct: InteractionPolicy | null;
	private: InteractionPolicy | null;
	unlisted: InteractionPolicy | null;
	public: InteractionPolicy | null;
}

export interface InteractionPolicy {
	can_favourite: InteractionPolicyEntry;
	can_reply: InteractionPolicyEntry;
	can_reblog: InteractionPolicyEntry;
}

export interface InteractionPolicyEntry {
	always: InteractionPolicyValue[];
	with_approval: InteractionPolicyValue[];
}

export type InteractionPolicyValue = string;

const PolicyValuePublic: InteractionPolicyValue = "public";
const PolicyValueFollowers: InteractionPolicyValue = "followers";
const PolicyValueFollowing: InteractionPolicyValue = "following";
const PolicyValueMutuals: InteractionPolicyValue = "mutuals";
const PolicyValueMentioned: InteractionPolicyValue = "mentioned";
const PolicyValueAuthor: InteractionPolicyValue = "author";
const PolicyValueMe: InteractionPolicyValue = "me";

export {
	PolicyValuePublic,
	PolicyValueFollowers,
	PolicyValueFollowing,
	PolicyValueMutuals,
	PolicyValueMentioned,
	PolicyValueAuthor,
	PolicyValueMe,
};


/**
 * Interaction request targeting a status by an account.
 */
export interface InteractionRequest {
    /**
	 * ID of the request.
	 */
	id: string;
	/**
	 * Type of interaction being requested.
	 */
	type: "favourite" | "reply" | "reblog";
	/**
	 * Time when the request was created.
	 */
	created_at: string;
	/**
	 * Account that created the request.
	 */
	account: Account;
	/**
	 * Status being interacted with.
	 */
	status: Status;
	/**
	 * Replying status, if type = "reply".
	 */
	reply?: Status;
}

/**
 * Parameters for GET to /api/v1/interaction_requests.
 */
export interface SearchInteractionRequestsParams {
	/**
	 * If set, show only requests targeting the given status_id.
	 */
	status_id?: string;
	/**
	 * If true or not set, include favourites in the results.
	 */
	favourites?: boolean;
	/**
	 * If true or not set, include replies in the results.
	 */
	replies?: boolean;
	/**
	 * If true or not set, include reblogs in the results.
	 */
	reblogs?: boolean;
	/**
	 * If set, show only requests older (ie., lower) than the given ID.
	 * Request with the given ID will not be included in response.
	 */
	max_id?: string;
	/**
	 * If set, show only requests newer (ie., higher) than the given ID.
	 * Request with the given ID will not be included in response.
	 */
	since_id?: string;
	/**
	 * If set, show only requests *immediately newer* than the given ID.
	 * Request with the given ID will not be included in response.
	 */
	min_id?: string;
	/**
	 * If set, limit returned requests to this number.
	 * Else, fall back to GtS API defaults.
	 */
	limit?: number;
}

export interface SearchInteractionRequestsResp {
	requests: InteractionRequest[];
	links: Links | null;
}