-
Notifications
You must be signed in to change notification settings - Fork 1
/
configInterface.ts
198 lines (183 loc) · 5.1 KB
/
configInterface.ts
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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
/**
* @author DiZed Team
* @copyright Copyright (c) DiZed Team (https://github.com/di-zed/)
*/
/**
* Config Interface.
*
* @interface
*/
export interface ConfigInterface {
/**
* The path to the view file for the "AuthController.login" action.
*
* @see AuthController.login
* @example
* yandexSmartHome(app, {
* viewAuthLogin: 'auth/login',
* });
*/
viewAuthLogin?: string;
/**
* The custom function to get the Client by ID.
*
* @see ClientRepository.getClientById
* @example
* yandexSmartHome(app, {
* functionGetClientById: async function (appId: number): Promise<ClientInterface> {
* return new Promise<ClientInterface>((resolve, reject) => { ... });
* },
* });
*/
functionGetClientById?: Function;
/**
* The custom function to get the Client by Client ID.
*
* @see ClientRepository.getClientByClientId
* @example
* yandexSmartHome(app, {
* functionGetClientByClientId: async function (clientId: string): Promise<ClientInterface> {
* return new Promise<ClientInterface>((resolve, reject) => { ... });
* },
* });
*/
functionGetClientByClientId?: Function;
/**
* The custom function to get the User by ID.
*
* @see UserRepository.getUserById
* @example
* yandexSmartHome(app, {
* functionGetUserById: async function (userId: number): Promise<UserInterface> {
* return new Promise<UserInterface>((resolve, reject) => { ... });
* },
* });
*/
functionGetUserById?: Function;
/**
* The custom function to get the User by Email and Password.
*
* @see UserRepository.getUserByEmailAndPassword
* @example
* yandexSmartHome(app, {
* functionGetUserByEmailAndPassword: async function (email: string, password: string): Promise<UserInterface> {
* return new Promise<UserInterface>((resolve, reject) => { ... });
* },
* });
*/
functionGetUserByEmailAndPassword?: Function;
/**
* The custom function to get the User by Name or Email.
*
* @see UserRepository.getUserByNameOrEmail
* @example
* yandexSmartHome(app, {
* functionGetUserByNameOrEmail: async function (nameOrEmail: string): Promise<UserInterface> {
* return new Promise<UserInterface>((resolve, reject) => { ... });
* },
* });
*/
functionGetUserByNameOrEmail?: Function;
/**
* Additional actions during the notification of unlinked accounts.
*
* @see RestUserController.unlink
* @example
* yandexSmartHome(app, {
* functionRestUserUnlinkAction: async function (req: Request, res: Response): Promise<any> {
* return new Promise<any>((resolve, reject) => { ... });
* },
* });
*/
functionRestUserUnlinkAction?: Function;
/**
* The custom function to get the User Devices.
*
* @see DeviceRepository.getUserDevices
* @example
* yandexSmartHome(app, {
* functionGetUserDevices: async function (user: UserInterface, configDevices: Device[]): Promise<Device[]> {
* return new Promise<Device[]>((resolve, reject) => { ... });
* },
* });
*/
functionGetUserDevices?: Function;
/**
* The custom function for listening to the topics and handling them if needed.
*
* @see MqttProvider.listenTopic
* @example
* yandexSmartHome(app, {
* functionListenTopic: async function (
* topic: string,
* message: string,
* ): Promise<boolean> {
* return true;
* },
* });
*/
functionListenTopic?: Function;
/**
* Adjust the MQTT Message if needed.
*
* @see MqttRepository.convertAliceValueToMqttMessage
* @example
* yandexSmartHome(app, {
* functionConvertAliceValueToMqttMessage: async function (
* aliceValue: any,
* mqttMessage: string,
* topicData?: CommandTopicData,
* ): Promise<string> {
* return '';
* },
* });
*/
functionConvertAliceValueToMqttMessage?: Function;
/**
* Adjust the Alice Value if needed.
*
* @see MqttRepository.convertMqttMessageToAliceValue
* @example
* yandexSmartHome(app, {
* functionConvertMqttMessageToAliceValue: async function (
* mqttMessage: string,
* aliceValue: any,
* topicData?: CommandTopicData,
* ): Promise<any> {
* return ...;
* },
* });
*/
functionConvertMqttMessageToAliceValue?: Function;
/**
* The config file with the user list. Each user should have "id", "email", and "password" fields.
*
* @see UserRepository.getConfigUsers
* @example
* yandexSmartHome(app, {
* configFileUsers: `${__dirname}/../config/users.json`,
* });
*/
configFileUsers?: string;
/**
* The config file with the device list.
*
* @see DeviceRepository.getConfigDevices
* @example
* yandexSmartHome(app, {
* configFileDevices: `${__dirname}/../config/devices.json`,
* });
*/
configFileDevices?: string;
/**
* The config file with the MQTT information (topics, etc.).
*
* @see MqttRepository.getConfig
* @example
* yandexSmartHome(app, {
* configFileMqtt: `${__dirname}/../config/mqtt.json`,
* });
*/
configFileMqtt?: string;
[key: string]: any;
}