2019-07-22 09:31:47 -05:00
|
|
|
// Data from API hooks: {hookType}:api.{location}.{elementType}.{actionType}.{target}
|
2019-12-05 10:06:18 -06:00
|
|
|
// Data in internal functions: {hookType}:{location}.{elementType}.{actionType}.{target}
|
2019-07-22 08:40:13 -05:00
|
|
|
|
2019-07-22 09:31:47 -05:00
|
|
|
export const clientFilterHookObject = {
|
2019-07-24 03:21:22 -05:00
|
|
|
// Filter params/result of the function that fetch videos of the trending page
|
2019-07-22 09:31:47 -05:00
|
|
|
'filter:api.trending-videos.videos.list.params': true,
|
|
|
|
'filter:api.trending-videos.videos.list.result': true,
|
2019-07-22 08:40:13 -05:00
|
|
|
|
2019-10-01 16:11:53 -05:00
|
|
|
// Filter params/result of the function that fetch videos of the trending page
|
|
|
|
'filter:api.most-liked-videos.videos.list.params': true,
|
|
|
|
'filter:api.most-liked-videos.videos.list.result': true,
|
|
|
|
|
2019-07-24 03:21:22 -05:00
|
|
|
// Filter params/result of the function that fetch videos of the local page
|
2019-07-22 09:31:47 -05:00
|
|
|
'filter:api.local-videos.videos.list.params': true,
|
|
|
|
'filter:api.local-videos.videos.list.result': true,
|
2019-07-22 08:40:13 -05:00
|
|
|
|
2019-07-24 03:21:22 -05:00
|
|
|
// Filter params/result of the function that fetch videos of the recently-added page
|
2019-07-22 09:31:47 -05:00
|
|
|
'filter:api.recently-added-videos.videos.list.params': true,
|
|
|
|
'filter:api.recently-added-videos.videos.list.result': true,
|
2019-07-22 08:40:13 -05:00
|
|
|
|
2019-07-24 03:21:22 -05:00
|
|
|
// Filter params/result of the function that fetch videos of the user subscription page
|
2019-07-22 09:31:47 -05:00
|
|
|
'filter:api.user-subscriptions-videos.videos.list.params': true,
|
|
|
|
'filter:api.user-subscriptions-videos.videos.list.result': true,
|
2019-07-22 08:40:13 -05:00
|
|
|
|
2019-07-24 03:21:22 -05:00
|
|
|
// Filter params/result of the function that fetch the video of the video-watch page
|
2019-07-22 09:31:47 -05:00
|
|
|
'filter:api.video-watch.video.get.params': true,
|
|
|
|
'filter:api.video-watch.video.get.result': true,
|
2019-07-22 08:40:13 -05:00
|
|
|
|
2021-10-12 06:45:55 -05:00
|
|
|
// Filter params/result of the function that fetch video playlist elements of the video-watch page
|
|
|
|
'filter:api.video-watch.video-playlist-elements.get.params': true,
|
|
|
|
'filter:api.video-watch.video-playlist-elements.get.result': true,
|
|
|
|
|
2019-07-24 03:21:22 -05:00
|
|
|
// Filter params/result of the function that fetch the threads of the video-watch page
|
2019-07-22 09:31:47 -05:00
|
|
|
'filter:api.video-watch.video-threads.list.params': true,
|
|
|
|
'filter:api.video-watch.video-threads.list.result': true,
|
2019-07-22 08:40:13 -05:00
|
|
|
|
2019-07-24 03:21:22 -05:00
|
|
|
// Filter params/result of the function that fetch the replies of a thread in the video-watch page
|
2019-07-22 09:31:47 -05:00
|
|
|
'filter:api.video-watch.video-thread-replies.list.params': true,
|
|
|
|
'filter:api.video-watch.video-thread-replies.list.result': true,
|
2019-07-22 08:40:13 -05:00
|
|
|
|
2019-07-24 03:21:22 -05:00
|
|
|
// Filter params/result of the function that fetch videos according to the user search
|
2019-07-22 09:31:47 -05:00
|
|
|
'filter:api.search.videos.list.params': true,
|
|
|
|
'filter:api.search.videos.list.result': true,
|
2021-06-17 09:02:38 -05:00
|
|
|
// Filter params/result of the function that fetch video channels according to the user search
|
2019-07-22 09:31:47 -05:00
|
|
|
'filter:api.search.video-channels.list.params': true,
|
2019-11-25 04:16:12 -06:00
|
|
|
'filter:api.search.video-channels.list.result': true,
|
2021-06-17 09:02:38 -05:00
|
|
|
// Filter params/result of the function that fetch video playlists according to the user search
|
|
|
|
'filter:api.search.video-playlists.list.params': true,
|
|
|
|
'filter:api.search.video-playlists.list.result': true,
|
2019-11-25 04:16:12 -06:00
|
|
|
|
|
|
|
// Filter form
|
2019-12-05 10:06:18 -06:00
|
|
|
'filter:api.signup.registration.create.params': true,
|
|
|
|
|
2022-07-08 03:50:10 -05:00
|
|
|
// Filter params/result of the function that fetch video playlist elements of the my-library page
|
|
|
|
'filter:api.my-library.video-playlist-elements.list.params': true,
|
|
|
|
'filter:api.my-library.video-playlist-elements.list.result': true,
|
|
|
|
|
2019-12-05 10:06:18 -06:00
|
|
|
// Filter the options to create our player
|
2019-12-05 10:26:58 -06:00
|
|
|
'filter:internal.video-watch.player.build-options.params': true,
|
|
|
|
'filter:internal.video-watch.player.build-options.result': true,
|
|
|
|
|
|
|
|
// Filter our SVG icons content
|
|
|
|
'filter:internal.common.svg-icons.get-content.params': true,
|
2021-06-07 06:16:50 -05:00
|
|
|
'filter:internal.common.svg-icons.get-content.result': true,
|
|
|
|
|
|
|
|
// Filter left menu links
|
2021-05-14 23:30:24 -05:00
|
|
|
'filter:left-menu.links.create.result': true,
|
|
|
|
|
2021-08-25 04:38:10 -05:00
|
|
|
// Filter upload page alert messages
|
2021-08-25 04:41:10 -05:00
|
|
|
'filter:upload.messages.create.result': true,
|
2021-08-25 04:38:10 -05:00
|
|
|
|
2022-01-20 02:35:06 -06:00
|
|
|
'filter:login.instance-about-plugin-panels.create.result': true,
|
|
|
|
'filter:signup.instance-about-plugin-panels.create.result': true,
|
|
|
|
|
2021-05-14 23:30:24 -05:00
|
|
|
// Filter videojs options built for PeerTube player
|
|
|
|
'filter:internal.player.videojs.options.result': true
|
2019-07-22 09:31:47 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
export type ClientFilterHookName = keyof typeof clientFilterHookObject
|
|
|
|
|
|
|
|
export const clientActionHookObject = {
|
2019-07-24 03:21:22 -05:00
|
|
|
// Fired when the application is being initialized
|
2019-07-22 09:31:47 -05:00
|
|
|
'action:application.init': true,
|
2019-07-22 08:40:13 -05:00
|
|
|
|
2019-07-24 03:21:22 -05:00
|
|
|
// Fired when the video watch page is being initialized
|
2019-07-22 09:31:47 -05:00
|
|
|
'action:video-watch.init': true,
|
2019-07-24 03:21:22 -05:00
|
|
|
// Fired when the video watch page loaded the video
|
2019-07-22 09:31:47 -05:00
|
|
|
'action:video-watch.video.loaded': true,
|
2019-11-18 02:55:23 -06:00
|
|
|
// Fired when the player finished loading
|
|
|
|
'action:video-watch.player.loaded': true,
|
2020-03-05 06:14:26 -06:00
|
|
|
// Fired when the video watch page comments(threads) are loaded and load more comments on scroll
|
|
|
|
'action:video-watch.video-threads.loaded': true,
|
2020-03-11 03:59:41 -05:00
|
|
|
// Fired when a user click on 'View x replies' and they're loaded
|
|
|
|
'action:video-watch.video-thread-replies.loaded': true,
|
2019-07-22 09:31:47 -05:00
|
|
|
|
2020-08-20 09:18:16 -05:00
|
|
|
// Fired when the video edit page (upload, URL/torrent import, update) is being initialized
|
|
|
|
'action:video-edit.init': true,
|
|
|
|
|
2020-05-06 07:01:30 -05:00
|
|
|
// Fired when the login page is being initialized
|
|
|
|
'action:login.init': true,
|
|
|
|
|
2019-07-24 03:21:22 -05:00
|
|
|
// Fired when the search page is being initialized
|
2019-07-25 12:02:54 -05:00
|
|
|
'action:search.init': true,
|
|
|
|
|
|
|
|
// Fired every time Angular URL changes
|
2019-11-25 04:16:12 -06:00
|
|
|
'action:router.navigation-end': true,
|
|
|
|
|
|
|
|
// Fired when the registration page is being initialized
|
2020-08-20 04:46:25 -05:00
|
|
|
'action:signup.register.init': true,
|
|
|
|
|
2021-04-22 04:18:13 -05:00
|
|
|
// PeerTube >= 3.2
|
|
|
|
// Fired when the admin plugin settings page is being initialized
|
|
|
|
'action:admin-plugin-settings.init': true,
|
|
|
|
|
Fix various typos
Found via `codespell -q 3 -S ./CREDITS.md,./CHANGELOG.md,./client/src/locale,./yarn.lock,./client/yarn.lock -L doubleclick,followings,nd,ot,ro,serie,splitted,tread,truthy`
2022-06-07 08:45:06 -05:00
|
|
|
// Fired when the video upload page is being initialized
|
2021-03-24 04:58:36 -05:00
|
|
|
'action:video-upload.init': true,
|
Fix various typos
Found via `codespell -q 3 -S ./CREDITS.md,./CHANGELOG.md,./client/src/locale,./yarn.lock,./client/yarn.lock -L doubleclick,followings,nd,ot,ro,serie,splitted,tread,truthy`
2022-06-07 08:45:06 -05:00
|
|
|
// Fired when the video import by URL page is being initialized
|
2021-03-24 04:58:36 -05:00
|
|
|
'action:video-url-import.init': true,
|
Fix various typos
Found via `codespell -q 3 -S ./CREDITS.md,./CHANGELOG.md,./client/src/locale,./yarn.lock,./client/yarn.lock -L doubleclick,followings,nd,ot,ro,serie,splitted,tread,truthy`
2022-06-07 08:45:06 -05:00
|
|
|
// Fired when the video import by torrent/magnet URI page is being initialized
|
2021-03-24 04:58:36 -05:00
|
|
|
'action:video-torrent-import.init': true,
|
Fix various typos
Found via `codespell -q 3 -S ./CREDITS.md,./CHANGELOG.md,./client/src/locale,./yarn.lock,./client/yarn.lock -L doubleclick,followings,nd,ot,ro,serie,splitted,tread,truthy`
2022-06-07 08:45:06 -05:00
|
|
|
// Fired when the "Go Live" page is being initialized
|
2021-03-24 04:58:36 -05:00
|
|
|
'action:go-live.init': true,
|
|
|
|
|
Fix various typos
Found via `codespell -q 3 -S ./CREDITS.md,./CHANGELOG.md,./client/src/locale,./yarn.lock,./client/yarn.lock -L doubleclick,followings,nd,ot,ro,serie,splitted,tread,truthy`
2022-06-07 08:45:06 -05:00
|
|
|
// Fired when the user explicitly logged in/logged out
|
2021-03-24 05:34:31 -05:00
|
|
|
'action:auth-user.logged-in': true,
|
|
|
|
'action:auth-user.logged-out': true,
|
|
|
|
// Fired when the application loaded user information (using tokens from the local storage or after a successful login)
|
|
|
|
'action:auth-user.information-loaded': true,
|
|
|
|
|
2021-03-23 05:54:08 -05:00
|
|
|
// Fired when the modal to download a video/caption is shown
|
|
|
|
'action:modal.video-download.shown': true,
|
|
|
|
|
2020-08-20 04:46:25 -05:00
|
|
|
// ####### Embed hooks #######
|
2021-03-23 05:54:08 -05:00
|
|
|
// /!\ In embed scope, peertube helpers are not available
|
|
|
|
// ###########################
|
2020-08-20 04:46:25 -05:00
|
|
|
|
|
|
|
// Fired when the embed loaded the player
|
|
|
|
'action:embed.player.loaded': true
|
2019-07-22 09:31:47 -05:00
|
|
|
}
|
2019-07-22 08:40:13 -05:00
|
|
|
|
2019-07-22 09:31:47 -05:00
|
|
|
export type ClientActionHookName = keyof typeof clientActionHookObject
|
2019-07-22 08:40:13 -05:00
|
|
|
|
2019-07-22 09:31:47 -05:00
|
|
|
export const clientHookObject = Object.assign({}, clientFilterHookObject, clientActionHookObject)
|
|
|
|
export type ClientHookName = keyof typeof clientHookObject
|
2019-07-22 08:40:13 -05:00
|
|
|
|
|
|
|
export interface ClientHook {
|
|
|
|
runHook <T> (hookName: ClientHookName, result?: T, params?: any): Promise<T>
|
|
|
|
}
|