aboutsummaryrefslogtreecommitdiffhomepage
path: root/shared/models/plugins/client/client-hook.model.ts
diff options
context:
space:
mode:
Diffstat (limited to 'shared/models/plugins/client/client-hook.model.ts')
-rw-r--r--shared/models/plugins/client/client-hook.model.ts125
1 files changed, 125 insertions, 0 deletions
diff --git a/shared/models/plugins/client/client-hook.model.ts b/shared/models/plugins/client/client-hook.model.ts
new file mode 100644
index 000000000..620651051
--- /dev/null
+++ b/shared/models/plugins/client/client-hook.model.ts
@@ -0,0 +1,125 @@
1// Data from API hooks: {hookType}:api.{location}.{elementType}.{actionType}.{target}
2// Data in internal functions: {hookType}:{location}.{elementType}.{actionType}.{target}
3
4export const clientFilterHookObject = {
5 // Filter params/result of the function that fetch videos of the trending page
6 'filter:api.trending-videos.videos.list.params': true,
7 'filter:api.trending-videos.videos.list.result': true,
8
9 // Filter params/result of the function that fetch videos of the trending page
10 'filter:api.most-liked-videos.videos.list.params': true,
11 'filter:api.most-liked-videos.videos.list.result': true,
12
13 // Filter params/result of the function that fetch videos of the local page
14 'filter:api.local-videos.videos.list.params': true,
15 'filter:api.local-videos.videos.list.result': true,
16
17 // Filter params/result of the function that fetch videos of the recently-added page
18 'filter:api.recently-added-videos.videos.list.params': true,
19 'filter:api.recently-added-videos.videos.list.result': true,
20
21 // Filter params/result of the function that fetch videos of the user subscription page
22 'filter:api.user-subscriptions-videos.videos.list.params': true,
23 'filter:api.user-subscriptions-videos.videos.list.result': true,
24
25 // Filter params/result of the function that fetch the video of the video-watch page
26 'filter:api.video-watch.video.get.params': true,
27 'filter:api.video-watch.video.get.result': true,
28
29 // Filter params/result of the function that fetch the threads of the video-watch page
30 'filter:api.video-watch.video-threads.list.params': true,
31 'filter:api.video-watch.video-threads.list.result': true,
32
33 // Filter params/result of the function that fetch the replies of a thread in the video-watch page
34 'filter:api.video-watch.video-thread-replies.list.params': true,
35 'filter:api.video-watch.video-thread-replies.list.result': true,
36
37 // Filter params/result of the function that fetch videos according to the user search
38 'filter:api.search.videos.list.params': true,
39 'filter:api.search.videos.list.result': true,
40 // Filter params/result of the function that fetch video-channels according to the user search
41 'filter:api.search.video-channels.list.params': true,
42 'filter:api.search.video-channels.list.result': true,
43
44 // Filter form
45 'filter:api.signup.registration.create.params': true,
46
47 // Filter the options to create our player
48 'filter:internal.video-watch.player.build-options.params': true,
49 'filter:internal.video-watch.player.build-options.result': true,
50
51 // Filter our SVG icons content
52 'filter:internal.common.svg-icons.get-content.params': true,
53 'filter:internal.common.svg-icons.get-content.result': true
54}
55
56export type ClientFilterHookName = keyof typeof clientFilterHookObject
57
58export const clientActionHookObject = {
59 // Fired when the application is being initialized
60 'action:application.init': true,
61
62 // Fired when the video watch page is being initialized
63 'action:video-watch.init': true,
64 // Fired when the video watch page loaded the video
65 'action:video-watch.video.loaded': true,
66 // Fired when the player finished loading
67 'action:video-watch.player.loaded': true,
68 // Fired when the video watch page comments(threads) are loaded and load more comments on scroll
69 'action:video-watch.video-threads.loaded': true,
70 // Fired when a user click on 'View x replies' and they're loaded
71 'action:video-watch.video-thread-replies.loaded': true,
72
73 // Fired when the video edit page (upload, URL/torrent import, update) is being initialized
74 'action:video-edit.init': true,
75
76 // Fired when the login page is being initialized
77 'action:login.init': true,
78
79 // Fired when the search page is being initialized
80 'action:search.init': true,
81
82 // Fired every time Angular URL changes
83 'action:router.navigation-end': true,
84
85 // Fired when the registration page is being initialized
86 'action:signup.register.init': true,
87
88 // PeerTube >= 3.2
89 // Fired when the admin plugin settings page is being initialized
90 'action:admin-plugin-settings.init': true,
91
92 // Fired when the video upload page is being initalized
93 'action:video-upload.init': true,
94 // Fired when the video import by URL page is being initalized
95 'action:video-url-import.init': true,
96 // Fired when the video import by torrent/magnet URI page is being initalized
97 'action:video-torrent-import.init': true,
98 // Fired when the "Go Live" page is being initalized
99 'action:go-live.init': true,
100
101 // Fired when the user explicitely logged in/logged out
102 'action:auth-user.logged-in': true,
103 'action:auth-user.logged-out': true,
104 // Fired when the application loaded user information (using tokens from the local storage or after a successful login)
105 'action:auth-user.information-loaded': true,
106
107 // Fired when the modal to download a video/caption is shown
108 'action:modal.video-download.shown': true,
109
110 // ####### Embed hooks #######
111 // /!\ In embed scope, peertube helpers are not available
112 // ###########################
113
114 // Fired when the embed loaded the player
115 'action:embed.player.loaded': true
116}
117
118export type ClientActionHookName = keyof typeof clientActionHookObject
119
120export const clientHookObject = Object.assign({}, clientFilterHookObject, clientActionHookObject)
121export type ClientHookName = keyof typeof clientHookObject
122
123export interface ClientHook {
124 runHook <T> (hookName: ClientHookName, result?: T, params?: any): Promise<T>
125}