shared/models/plugins/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 account videos for the REST API
  10   'filter:api.accounts.videos.list.params': true,
  11   'filter:api.accounts.videos.list.result': true,
  12
  13   // Filter params/result used to list channel videos for the REST API
  14   'filter:api.video-channels.videos.list.params': true,
  15   'filter:api.video-channels.videos.list.result': true,
  16
  17   // Filter params/result used to list my user videos for the REST API
  18   'filter:api.user.me.videos.list.params': true,
  19   'filter:api.user.me.videos.list.result': true,
  20
  21   // Filter the result of the get function
  22   // Used to get detailed video information (video watch page for example)
  23   'filter:api.video.get.result': true,
  24
  25   // Filter the result of the accept upload/live, import via torrent/url functions
  26   // If this function returns false then the upload is aborted with an error
  27   'filter:api.video.upload.accept.result': true,
  28   'filter:api.live-video.create.accept.result': true,
  29   'filter:api.video.pre-import-url.accept.result': true,
  30   'filter:api.video.pre-import-torrent.accept.result': true,
  31   'filter:api.video.post-import-url.accept.result': true,
  32   'filter:api.video.post-import-torrent.accept.result': true,
  33   // Filter the result of the accept comment (thread or reply) functions
  34   // If the functions return false then the user cannot post its comment
  35   'filter:api.video-thread.create.accept.result': true,
  36   'filter:api.video-comment-reply.create.accept.result': true,
  37
  38   // Filter params/result used to list threads of a specific video
  39   // (used by the video watch page)
  40   'filter:api.video-threads.list.params': true,
  41   'filter:api.video-threads.list.result': true,
  42
  43   // Filter params/result used to list replies of a specific thread
  44   // (used by the video watch page when we click on the "View replies" button)
  45   'filter:api.video-thread-comments.list.params': true,
  46   'filter:api.video-thread-comments.list.result': true,
  47
  48   // Filter result used to check if we need to auto blacklist a video
  49   // (fired when a local or remote video is created or updated)
  50   'filter:video.auto-blacklist.result': true,
  51
  52   // Filter result used to check if a user can register on the instance
  53   'filter:api.user.signup.allowed.result': true
  54 }
  55
  56 export type ServerFilterHookName = keyof typeof serverFilterHookObject
  57
  58 export const serverActionHookObject = {
  59   // Fired when the application has been loaded and is listening HTTP requests
  60   'action:application.listening': true,
  61
  62   // Fired when a local video is updated
  63   'action:api.video.updated': true,
  64   // Fired when a local video is deleted
  65   'action:api.video.deleted': true,
  66   // Fired when a local video is uploaded
  67   'action:api.video.uploaded': true,
  68   // Fired when a local video is viewed
  69   'action:api.video.viewed': true,
  70
  71   // Fired when a live video is created
  72   'action:api.live-video.created': true,
  73
  74   // Fired when a thread is created
  75   'action:api.video-thread.created': true,
  76   // Fired when a reply to a thread is created
  77   'action:api.video-comment-reply.created': true,
  78   // Fired when a comment (thread or reply) is deleted
  79   'action:api.video-comment.deleted': true,
  80
  81   // Fired when a user is blocked (banned)
  82   'action:api.user.blocked': true,
  83   // Fired when a user is unblocked (unbanned)
  84   'action:api.user.unblocked': true,
  85   // Fired when a user registered on the instance
  86   'action:api.user.registered': true,
  87   // Fired when an admin/moderator created a user
  88   'action:api.user.created': true,
  89   // Fired when a user is removed by an admin/moderator
  90   'action:api.user.deleted': true,
  91   // Fired when a user is updated by an admin/moderator
  92   'action:api.user.updated': true,
  93
  94   // Fired when a user got a new oauth2 token
  95   'action:api.user.oauth2-got-token': true
  96 }
  97
  98 export type ServerActionHookName = keyof typeof serverActionHookObject
  99
 100 export const serverHookObject = Object.assign({}, serverFilterHookObject, serverActionHookObject)
 101 export type ServerHookName = keyof typeof serverHookObject
 102
 103 export interface ServerHook {
 104   runHook <T> (hookName: ServerHookName, result?: T, params?: any): Promise<T>
 105 }