X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=shared%2Fmodels%2Fplugins%2Fserver%2Fserver-hook.model.ts;h=4c9d86079d06ab9a096e57a55ba25ded229ef26a;hb=3f0ceab06e5320f62f593c49daa30d963dbc36f9;hp=562c6eb126deefa00c07d4c9ea9accfa39ea1ccc;hpb=ac27887774e63d99f4e227fbe18846f143cc4b3c;p=github%2FChocobozzz%2FPeerTube.git diff --git a/shared/models/plugins/server/server-hook.model.ts b/shared/models/plugins/server/server-hook.model.ts index 562c6eb12..4c9d86079 100644 --- a/shared/models/plugins/server/server-hook.model.ts +++ b/shared/models/plugins/server/server-hook.model.ts @@ -1,4 +1,4 @@ -// {hookType}:{api?}.{location}.{subLocation?}.{actionType}.{target} +// {hookType}:{root}.{location}.{subLocation?}.{actionType}.{target} export const serverFilterHookObject = { // Filter params/result used to list videos for the REST API @@ -6,6 +6,11 @@ export const serverFilterHookObject = { 'filter:api.videos.list.params': true, 'filter:api.videos.list.result': true, + // Filter params/result used to list a video playlists videos + // for the REST API + 'filter:api.video-playlist.videos.list.params': true, + 'filter:api.video-playlist.videos.list.result': true, + // Filter params/result used to list account videos for the REST API 'filter:api.accounts.videos.list.params': true, 'filter:api.accounts.videos.list.result': true, @@ -22,6 +27,10 @@ export const serverFilterHookObject = { 'filter:api.overviews.videos.list.params': true, 'filter:api.overviews.videos.list.result': true, + // Filter params/result used to list subscription videos for the REST API + 'filter:api.user.me.subscription-videos.list.params': true, + 'filter:api.user.me.subscription-videos.list.result': true, + // Filter params/results to search videos/channels in the DB or on the remote index 'filter:api.search.videos.local.list.params': true, 'filter:api.search.videos.local.list.result': true, @@ -40,6 +49,13 @@ export const serverFilterHookObject = { // Used to get detailed video information (video watch page for example) 'filter:api.video.get.result': true, + // Filter params/results when listing video channels + 'filter:api.video-channels.list.params': true, + 'filter:api.video-channels.list.result': true, + + // Filter the result when getting a video channel + 'filter:api.video-channel.get.result': true, + // Filter the result of the accept upload/live, import via torrent/url functions // If this function returns false then the upload is aborted with an error 'filter:api.video.upload.accept.result': true, @@ -53,6 +69,12 @@ export const serverFilterHookObject = { 'filter:api.video-thread.create.accept.result': true, 'filter:api.video-comment-reply.create.accept.result': true, + // Filter attributes when creating video object + 'filter:api.video.upload.video-attribute.result': true, + 'filter:api.video.import-url.video-attribute.result': true, + 'filter:api.video.import-torrent.video-attribute.result': true, + 'filter:api.video.live.video-attribute.result': true, + // Filter params/result used to list threads of a specific video // (used by the video watch page) 'filter:api.video-threads.list.params': true, @@ -63,6 +85,9 @@ export const serverFilterHookObject = { 'filter:api.video-thread-comments.list.params': true, 'filter:api.video-thread-comments.list.result': true, + // Filter get stats result + 'filter:api.server.stats.get.result': true, + // Filter result used to check if we need to auto blacklist a video // (fired when a local or remote video is created or updated) 'filter:video.auto-blacklist.result': true, @@ -70,13 +95,34 @@ export const serverFilterHookObject = { // Filter result used to check if a user can register on the instance 'filter:api.user.signup.allowed.result': true, + // Filter result used to check if a user can send a registration request on the instance + // PeerTube >= 5.1 + 'filter:api.user.request-signup.allowed.result': true, + // Filter result used to check if video/torrent download is allowed 'filter:api.download.video.allowed.result': true, 'filter:api.download.torrent.allowed.result': true, // Filter result to check if the embed is allowed for a particular request 'filter:html.embed.video.allowed.result': true, - 'filter:html.embed.video-playlist.allowed.result': true + 'filter:html.embed.video-playlist.allowed.result': true, + + // Peertube >= 5.2 + 'filter:html.client.json-ld.result': true, + + 'filter:job-queue.process.params': true, + 'filter:job-queue.process.result': true, + + 'filter:transcoding.manual.resolutions-to-transcode.result': true, + 'filter:transcoding.auto.resolutions-to-transcode.result': true, + + 'filter:activity-pub.remote-video-comment.create.accept.result': true, + + 'filter:activity-pub.activity.context.build.result': true, + + // Filter the result of video JSON LD builder + // You may also need to use filter:activity-pub.activity.context.build.result to also update JSON LD context + 'filter:activity-pub.video.json-ld.build.result': true } export type ServerFilterHookName = keyof typeof serverFilterHookObject @@ -85,6 +131,11 @@ export const serverActionHookObject = { // Fired when the application has been loaded and is listening HTTP requests 'action:application.listening': true, + // Fired when a new notification is created + 'action:notifier.notification.created': true, + + // API actions hooks give access to the original express `req` and `res` parameters + // Fired when a local video is updated 'action:api.video.updated': true, // Fired when a local video is deleted @@ -94,6 +145,13 @@ export const serverActionHookObject = { // Fired when a local video is viewed 'action:api.video.viewed': true, + // Fired when a video channel is created + 'action:api.video-channel.created': true, + // Fired when a video channel is updated + 'action:api.video-channel.updated': true, + // Fired when a video channel is deleted + 'action:api.video-channel.deleted': true, + // Fired when a live video is created 'action:api.live-video.created': true, @@ -104,12 +162,20 @@ export const serverActionHookObject = { // Fired when a comment (thread or reply) is deleted 'action:api.video-comment.deleted': true, + // Fired when a caption is created + 'action:api.video-caption.created': true, + // Fired when a caption is deleted + 'action:api.video-caption.deleted': true, + // Fired when a user is blocked (banned) 'action:api.user.blocked': true, // Fired when a user is unblocked (unbanned) 'action:api.user.unblocked': true, // Fired when a user registered on the instance 'action:api.user.registered': true, + // Fired when a user requested registration on the instance + // PeerTube >= 5.1 + 'action:api.user.requested-registration': true, // Fired when an admin/moderator created a user 'action:api.user.created': true, // Fired when a user is removed by an admin/moderator @@ -121,7 +187,11 @@ export const serverActionHookObject = { 'action:api.user.oauth2-got-token': true, // Fired when a video is added to a playlist - 'action:api.video-playlist-element.created': true + 'action:api.video-playlist-element.created': true, + + // Fired when a remote video has been created/updated + 'action:activity-pub.remote-video.created': true, + 'action:activity-pub.remote-video.updated': true } export type ServerActionHookName = keyof typeof serverActionHookObject