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