shared/models/plugins/client/client-hook.model.ts

   1 // Data from API hooks: {hookType}:api.{location}.{elementType}.{actionType}.{target}
   2 // Data in internal functions: {hookType}:{location}.{elementType}.{actionType}.{target}
   3
   4 export 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   // Filter params/result of the function that fetch video playlists according to the user search
  44   'filter:api.search.video-playlists.list.params': true,
  45   'filter:api.search.video-playlists.list.result': true,
  46
  47   // Filter form
  48   'filter:api.signup.registration.create.params': true,
  49
  50   // Filter the options to create our player
  51   'filter:internal.video-watch.player.build-options.params': true,
  52   'filter:internal.video-watch.player.build-options.result': true,
  53
  54   // Filter our SVG icons content
  55   'filter:internal.common.svg-icons.get-content.params': true,
  56   'filter:internal.common.svg-icons.get-content.result': true,
  57
  58   // Filter left menu links
  59   'filter:left-menu.links.create.result': true,
  60
  61   // Filter videojs options built for PeerTube player
  62   'filter:internal.player.videojs.options.result': true
  63 }
  64
  65 export type ClientFilterHookName = keyof typeof clientFilterHookObject
  66
  67 export const clientActionHookObject = {
  68   // Fired when the application is being initialized
  69   'action:application.init': true,
  70
  71   // Fired when the video watch page is being initialized
  72   'action:video-watch.init': true,
  73   // Fired when the video watch page loaded the video
  74   'action:video-watch.video.loaded': true,
  75   // Fired when the player finished loading
  76   'action:video-watch.player.loaded': true,
  77   // Fired when the video watch page comments(threads) are loaded and load more comments on scroll
  78   'action:video-watch.video-threads.loaded': true,
  79   // Fired when a user click on 'View x replies' and they're loaded
  80   'action:video-watch.video-thread-replies.loaded': true,
  81
  82   // Fired when the video edit page (upload, URL/torrent import, update) is being initialized
  83   'action:video-edit.init': true,
  84
  85   // Fired when the login page is being initialized
  86   'action:login.init': true,
  87
  88   // Fired when the search page is being initialized
  89   'action:search.init': true,
  90
  91   // Fired every time Angular URL changes
  92   'action:router.navigation-end': true,
  93
  94   // Fired when the registration page is being initialized
  95   'action:signup.register.init': true,
  96
  97   // PeerTube >= 3.2
  98   // Fired when the admin plugin settings page is being initialized
  99   'action:admin-plugin-settings.init': true,
 100
 101   // Fired when the video upload page is being initalized
 102   'action:video-upload.init': true,
 103   // Fired when the video import by URL page is being initalized
 104   'action:video-url-import.init': true,
 105   // Fired when the video import by torrent/magnet URI page is being initalized
 106   'action:video-torrent-import.init': true,
 107   // Fired when the "Go Live" page is being initalized
 108   'action:go-live.init': true,
 109
 110   // Fired when the user explicitely logged in/logged out
 111   'action:auth-user.logged-in': true,
 112   'action:auth-user.logged-out': true,
 113   // Fired when the application loaded user information (using tokens from the local storage or after a successful login)
 114   'action:auth-user.information-loaded': true,
 115
 116   // Fired when the modal to download a video/caption is shown
 117   'action:modal.video-download.shown': true,
 118
 119   // ####### Embed hooks #######
 120   // /!\ In embed scope, peertube helpers are not available
 121   // ###########################
 122
 123   // Fired when the embed loaded the player
 124   'action:embed.player.loaded': true
 125 }
 126
 127 export type ClientActionHookName = keyof typeof clientActionHookObject
 128
 129 export const clientHookObject = Object.assign({}, clientFilterHookObject, clientActionHookObject)
 130 export type ClientHookName = keyof typeof clientHookObject
 131
 132 export interface ClientHook {
 133   runHook <T> (hookName: ClientHookName, result?: T, params?: any): Promise<T>
 134 }