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

   1 // {hookType}:{api?}.{location}.{subLocation?}.{actionType}.{target}
   2
   3 export const serverFilterHookObject = {
   4   // Filter params/result used to list videos for the REST API
   5   // (used by the trending page, recently-added page, local page etc)
   6   'filter:api.videos.list.params': true,
   7   'filter:api.videos.list.result': true,
   8
   9   // Filter params/result used to list a video playlists videos
  10   // for the REST API
  11   'filter:api.video-playlist.videos.list.params': true,
  12   'filter:api.video-playlist.videos.list.result': true,
  13
  14   // Filter params/result used to list account videos for the REST API
  15   'filter:api.accounts.videos.list.params': true,
  16   'filter:api.accounts.videos.list.result': true,
  17
  18   // Filter params/result used to list channel videos for the REST API
  19   'filter:api.video-channels.videos.list.params': true,
  20   'filter:api.video-channels.videos.list.result': true,
  21
  22   // Filter params/result used to list my user videos for the REST API
  23   'filter:api.user.me.videos.list.params': true,
  24   'filter:api.user.me.videos.list.result': true,
  25
  26   // Filter params/result used to list overview videos for the REST API
  27   'filter:api.overviews.videos.list.params': true,
  28   'filter:api.overviews.videos.list.result': true,
  29
  30   // Filter params/result used to list subscription videos for the REST API
  31   'filter:api.user.me.subscription-videos.list.params': true,
  32   'filter:api.user.me.subscription-videos.list.result': true,
  33
  34   // Filter params/results to search videos/channels in the DB or on the remote index
  35   'filter:api.search.videos.local.list.params': true,
  36   'filter:api.search.videos.local.list.result': true,
  37   'filter:api.search.videos.index.list.params': true,
  38   'filter:api.search.videos.index.list.result': true,
  39   'filter:api.search.video-channels.local.list.params': true,
  40   'filter:api.search.video-channels.local.list.result': true,
  41   'filter:api.search.video-channels.index.list.params': true,
  42   'filter:api.search.video-channels.index.list.result': true,
  43   'filter:api.search.video-playlists.local.list.params': true,
  44   'filter:api.search.video-playlists.local.list.result': true,
  45   'filter:api.search.video-playlists.index.list.params': true,
  46   'filter:api.search.video-playlists.index.list.result': true,
  47
  48   // Filter the result of the get function
  49   // Used to get detailed video information (video watch page for example)
  50   'filter:api.video.get.result': true,
  51
  52   // Filter params/results when listing video channels
  53   'filter:api.video-channels.list.params': true,
  54   'filter:api.video-channels.list.result': true,
  55
  56   // Filter the result when getting a video channel
  57   'filter:api.video-channel.get.result': true,
  58
  59   // Filter the result of the accept upload/live, import via torrent/url functions
  60   // If this function returns false then the upload is aborted with an error
  61   'filter:api.video.upload.accept.result': true,
  62   'filter:api.live-video.create.accept.result': true,
  63   'filter:api.video.pre-import-url.accept.result': true,
  64   'filter:api.video.pre-import-torrent.accept.result': true,
  65   'filter:api.video.post-import-url.accept.result': true,
  66   'filter:api.video.post-import-torrent.accept.result': true,
  67   // Filter the result of the accept comment (thread or reply) functions
  68   // If the functions return false then the user cannot post its comment
  69   'filter:api.video-thread.create.accept.result': true,
  70   'filter:api.video-comment-reply.create.accept.result': true,
  71
  72   // Filter attributes when creating video object
  73   'filter:api.video.upload.video-attribute.result': true,
  74   'filter:api.video.import-url.video-attribute.result': true,
  75   'filter:api.video.import-torrent.video-attribute.result': true,
  76   'filter:api.video.live.video-attribute.result': true,
  77
  78   // Filter params/result used to list threads of a specific video
  79   // (used by the video watch page)
  80   'filter:api.video-threads.list.params': true,
  81   'filter:api.video-threads.list.result': true,
  82
  83   // Filter params/result used to list replies of a specific thread
  84   // (used by the video watch page when we click on the "View replies" button)
  85   'filter:api.video-thread-comments.list.params': true,
  86   'filter:api.video-thread-comments.list.result': true,
  87
  88   // Filter get stats result
  89   'filter:api.server.stats.get.result': true,
  90
  91   // Filter result used to check if we need to auto blacklist a video
  92   // (fired when a local or remote video is created or updated)
  93   'filter:video.auto-blacklist.result': true,
  94
  95   // Filter result used to check if a user can register on the instance
  96   'filter:api.user.signup.allowed.result': true,
  97
  98   // Filter result used to check if a user can send a registration request on the instance
  99   // PeerTube >= 5.1
 100   'filter:api.user.request-signup.allowed.result': true,
 101
 102   // Filter result used to check if video/torrent download is allowed
 103   'filter:api.download.video.allowed.result': true,
 104   'filter:api.download.torrent.allowed.result': true,
 105
 106   // Filter result to check if the embed is allowed for a particular request
 107   'filter:html.embed.video.allowed.result': true,
 108   'filter:html.embed.video-playlist.allowed.result': true,
 109
 110   'filter:job-queue.process.params': true,
 111   'filter:job-queue.process.result': true,
 112
 113   'filter:transcoding.manual.resolutions-to-transcode.result': true,
 114   'filter:transcoding.auto.resolutions-to-transcode.result': true,
 115
 116   'filter:activity-pub.remote-video-comment.create.accept.result': true,
 117
 118   'filter:activity-pub.activity.context.build.result': true,
 119
 120   // Filter the result of video JSON LD builder
 121   // You may also need to use filter:activity-pub.activity.context.build.result to also update JSON LD context
 122   'filter:activity-pub.video.json-ld.build.result': true
 123 }
 124
 125 export type ServerFilterHookName = keyof typeof serverFilterHookObject
 126
 127 export const serverActionHookObject = {
 128   // Fired when the application has been loaded and is listening HTTP requests
 129   'action:application.listening': true,
 130
 131   // Fired when a new notification is created
 132   'action:notifier.notification.created': true,
 133
 134   // API actions hooks give access to the original express `req` and `res` parameters
 135
 136   // Fired when a local video is updated
 137   'action:api.video.updated': true,
 138   // Fired when a local video is deleted
 139   'action:api.video.deleted': true,
 140   // Fired when a local video is uploaded
 141   'action:api.video.uploaded': true,
 142   // Fired when a local video is viewed
 143   'action:api.video.viewed': true,
 144
 145   // Fired when a video channel is created
 146   'action:api.video-channel.created': true,
 147   // Fired when a video channel is updated
 148   'action:api.video-channel.updated': true,
 149   // Fired when a video channel is deleted
 150   'action:api.video-channel.deleted': true,
 151
 152   // Fired when a live video is created
 153   'action:api.live-video.created': true,
 154
 155   // Fired when a thread is created
 156   'action:api.video-thread.created': true,
 157   // Fired when a reply to a thread is created
 158   'action:api.video-comment-reply.created': true,
 159   // Fired when a comment (thread or reply) is deleted
 160   'action:api.video-comment.deleted': true,
 161
 162   // Fired when a caption is created
 163   'action:api.video-caption.created': true,
 164   // Fired when a caption is deleted
 165   'action:api.video-caption.deleted': true,
 166
 167   // Fired when a user is blocked (banned)
 168   'action:api.user.blocked': true,
 169   // Fired when a user is unblocked (unbanned)
 170   'action:api.user.unblocked': true,
 171   // Fired when a user registered on the instance
 172   'action:api.user.registered': true,
 173   // Fired when a user requested registration on the instance
 174   // PeerTube >= 5.1
 175   'action:api.user.requested-registration': true,
 176   // Fired when an admin/moderator created a user
 177   'action:api.user.created': true,
 178   // Fired when a user is removed by an admin/moderator
 179   'action:api.user.deleted': true,
 180   // Fired when a user is updated by an admin/moderator
 181   'action:api.user.updated': true,
 182
 183   // Fired when a user got a new oauth2 token
 184   'action:api.user.oauth2-got-token': true,
 185
 186   // Fired when a video is added to a playlist
 187   'action:api.video-playlist-element.created': true
 188 }
 189
 190 export type ServerActionHookName = keyof typeof serverActionHookObject
 191
 192 export const serverHookObject = Object.assign({}, serverFilterHookObject, serverActionHookObject)
 193 export type ServerHookName = keyof typeof serverHookObject
 194
 195 export interface ServerHook {
 196   runHook <T> (hookName: ServerHookName, result?: T, params?: any): Promise<T>
 197 }