plugins/client-hook.model.ts

   1 // Data from API hooks: {hookType}:api.{location}.{elementType}.{actionType}.{target}
   2
   3 export const clientFilterHookObject = {
   4   // Filter params/result of the function that fetch videos of the trending page
   5   'filter:api.trending-videos.videos.list.params': true,
   6   'filter:api.trending-videos.videos.list.result': true,
   7
   8   // Filter params/result of the function that fetch videos of the local page
   9   'filter:api.local-videos.videos.list.params': true,
  10   'filter:api.local-videos.videos.list.result': true,
  11
  12   // Filter params/result of the function that fetch videos of the recently-added page
  13   'filter:api.recently-added-videos.videos.list.params': true,
  14   'filter:api.recently-added-videos.videos.list.result': true,
  15
  16   // Filter params/result of the function that fetch videos of the user subscription page
  17   'filter:api.user-subscriptions-videos.videos.list.params': true,
  18   'filter:api.user-subscriptions-videos.videos.list.result': true,
  19
  20   // Filter params/result of the function that fetch the video of the video-watch page
  21   'filter:api.video-watch.video.get.params': true,
  22   'filter:api.video-watch.video.get.result': true,
  23
  24   // Filter params/result of the function that fetch the threads of the video-watch page
  25   'filter:api.video-watch.video-threads.list.params': true,
  26   'filter:api.video-watch.video-threads.list.result': true,
  27
  28   // Filter params/result of the function that fetch the replies of a thread in the video-watch page
  29   'filter:api.video-watch.video-thread-replies.list.params': true,
  30   'filter:api.video-watch.video-thread-replies.list.result': true,
  31
  32   // Filter params/result of the function that fetch videos according to the user search
  33   'filter:api.search.videos.list.params': true,
  34   'filter:api.search.videos.list.result': true,
  35   // Filter params/result of the function that fetch video-channels according to the user search
  36   'filter:api.search.video-channels.list.params': true,
  37   'filter:api.search.video-channels.list.result': true
  38 }
  39
  40 export type ClientFilterHookName = keyof typeof clientFilterHookObject
  41
  42 export const clientActionHookObject = {
  43   // Fired when the application is being initialized
  44   'action:application.init': true,
  45
  46   // Fired when the video watch page is being initialized
  47   'action:video-watch.init': true,
  48   // Fired when the video watch page loaded the video
  49   'action:video-watch.video.loaded': true,
  50
  51   // Fired when the search page is being initialized
  52   'action:search.init': true,
  53
  54   // Fired every time Angular URL changes
  55   'action:router.navigation-end': true
  56 }
  57
  58 export type ClientActionHookName = keyof typeof clientActionHookObject
  59
  60 export const clientHookObject = Object.assign({}, clientFilterHookObject, clientActionHookObject)
  61 export type ClientHookName = keyof typeof clientHookObject
  62
  63 export interface ClientHook {
  64   runHook <T> (hookName: ClientHookName, result?: T, params?: any): Promise<T>
  65 }