mirror of
https://github.com/Chocobozzz/PeerTube.git
synced 2025-10-05 02:39:33 +02:00
Reorganize plugin models
This commit is contained in:
Chocobozzz
parent
2b02c520e6
commit
428ccb8b7a
48 changed files with 113 additions and 112 deletions
125
shared/models/plugins/client/client-hook.model.ts
Normal file
125
shared/models/plugins/client/client-hook.model.ts
Normal file
|
|
@ -0,0 +1,125 @@
|
|||
// Data from API hooks: {hookType}:api.{location}.{elementType}.{actionType}.{target}
|
||||
// Data in internal functions: {hookType}:{location}.{elementType}.{actionType}.{target}
|
||||
|
||||
export const clientFilterHookObject = {
|
||||
// Filter params/result of the function that fetch videos of the trending page
|
||||
'filter:api.trending-videos.videos.list.params': true,
|
||||
'filter:api.trending-videos.videos.list.result': true,
|
||||
|
||||
// Filter params/result of the function that fetch videos of the trending page
|
||||
'filter:api.most-liked-videos.videos.list.params': true,
|
||||
'filter:api.most-liked-videos.videos.list.result': true,
|
||||
|
||||
// Filter params/result of the function that fetch videos of the local page
|
||||
'filter:api.local-videos.videos.list.params': true,
|
||||
'filter:api.local-videos.videos.list.result': true,
|
||||
|
||||
// Filter params/result of the function that fetch videos of the recently-added page
|
||||
'filter:api.recently-added-videos.videos.list.params': true,
|
||||
'filter:api.recently-added-videos.videos.list.result': true,
|
||||
|
||||
// Filter params/result of the function that fetch videos of the user subscription page
|
||||
'filter:api.user-subscriptions-videos.videos.list.params': true,
|
||||
'filter:api.user-subscriptions-videos.videos.list.result': true,
|
||||
|
||||
// Filter params/result of the function that fetch the video of the video-watch page
|
||||
'filter:api.video-watch.video.get.params': true,
|
||||
'filter:api.video-watch.video.get.result': true,
|
||||
|
||||
// Filter params/result of the function that fetch the threads of the video-watch page
|
||||
'filter:api.video-watch.video-threads.list.params': true,
|
||||
'filter:api.video-watch.video-threads.list.result': true,
|
||||
|
||||
// Filter params/result of the function that fetch the replies of a thread in the video-watch page
|
||||
'filter:api.video-watch.video-thread-replies.list.params': true,
|
||||
'filter:api.video-watch.video-thread-replies.list.result': true,
|
||||
|
||||
// Filter params/result of the function that fetch videos according to the user search
|
||||
'filter:api.search.videos.list.params': true,
|
||||
'filter:api.search.videos.list.result': true,
|
||||
// Filter params/result of the function that fetch video-channels according to the user search
|
||||
'filter:api.search.video-channels.list.params': true,
|
||||
'filter:api.search.video-channels.list.result': true,
|
||||
|
||||
// Filter form
|
||||
'filter:api.signup.registration.create.params': true,
|
||||
|
||||
// Filter the options to create our player
|
||||
'filter:internal.video-watch.player.build-options.params': true,
|
||||
'filter:internal.video-watch.player.build-options.result': true,
|
||||
|
||||
// Filter our SVG icons content
|
||||
'filter:internal.common.svg-icons.get-content.params': true,
|
||||
'filter:internal.common.svg-icons.get-content.result': true
|
||||
}
|
||||
|
||||
export type ClientFilterHookName = keyof typeof clientFilterHookObject
|
||||
|
||||
export const clientActionHookObject = {
|
||||
// Fired when the application is being initialized
|
||||
'action:application.init': true,
|
||||
|
||||
// Fired when the video watch page is being initialized
|
||||
'action:video-watch.init': true,
|
||||
// Fired when the video watch page loaded the video
|
||||
'action:video-watch.video.loaded': true,
|
||||
// Fired when the player finished loading
|
||||
'action:video-watch.player.loaded': true,
|
||||
// Fired when the video watch page comments(threads) are loaded and load more comments on scroll
|
||||
'action:video-watch.video-threads.loaded': true,
|
||||
// Fired when a user click on 'View x replies' and they're loaded
|
||||
'action:video-watch.video-thread-replies.loaded': true,
|
||||
|
||||
// Fired when the video edit page (upload, URL/torrent import, update) is being initialized
|
||||
'action:video-edit.init': true,
|
||||
|
||||
// Fired when the login page is being initialized
|
||||
'action:login.init': true,
|
||||
|
||||
// Fired when the search page is being initialized
|
||||
'action:search.init': true,
|
||||
|
||||
// Fired every time Angular URL changes
|
||||
'action:router.navigation-end': true,
|
||||
|
||||
// Fired when the registration page is being initialized
|
||||
'action:signup.register.init': true,
|
||||
|
||||
// PeerTube >= 3.2
|
||||
// Fired when the admin plugin settings page is being initialized
|
||||
'action:admin-plugin-settings.init': true,
|
||||
|
||||
// Fired when the video upload page is being initalized
|
||||
'action:video-upload.init': true,
|
||||
// Fired when the video import by URL page is being initalized
|
||||
'action:video-url-import.init': true,
|
||||
// Fired when the video import by torrent/magnet URI page is being initalized
|
||||
'action:video-torrent-import.init': true,
|
||||
// Fired when the "Go Live" page is being initalized
|
||||
'action:go-live.init': true,
|
||||
|
||||
// Fired when the user explicitely logged in/logged out
|
||||
'action:auth-user.logged-in': true,
|
||||
'action:auth-user.logged-out': true,
|
||||
// Fired when the application loaded user information (using tokens from the local storage or after a successful login)
|
||||
'action:auth-user.information-loaded': true,
|
||||
|
||||
// Fired when the modal to download a video/caption is shown
|
||||
'action:modal.video-download.shown': true,
|
||||
|
||||
// ####### Embed hooks #######
|
||||
// /!\ In embed scope, peertube helpers are not available
|
||||
// ###########################
|
||||
|
||||
// Fired when the embed loaded the player
|
||||
'action:embed.player.loaded': true
|
||||
}
|
||||
|
||||
export type ClientActionHookName = keyof typeof clientActionHookObject
|
||||
|
||||
export const clientHookObject = Object.assign({}, clientFilterHookObject, clientActionHookObject)
|
||||
export type ClientHookName = keyof typeof clientHookObject
|
||||
|
||||
export interface ClientHook {
|
||||
runHook <T> (hookName: ClientHookName, result?: T, params?: any): Promise<T>
|
||||
}
|
||||
6
shared/models/plugins/client/index.ts
Normal file
6
shared/models/plugins/client/index.ts
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
export * from './client-hook.model'
|
||||
export * from './plugin-client-scope.type'
|
||||
export * from './plugin-element-placeholder.type'
|
||||
export * from './register-client-form-field.model'
|
||||
export * from './register-client-hook.model'
|
||||
export * from './register-client-settings-script.model'
|
||||
9
shared/models/plugins/client/plugin-client-scope.type.ts
Normal file
9
shared/models/plugins/client/plugin-client-scope.type.ts
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
export type PluginClientScope =
|
||||
'common' |
|
||||
'video-watch' |
|
||||
'search' |
|
||||
'signup' |
|
||||
'login' |
|
||||
'embed' |
|
||||
'video-edit' |
|
||||
'admin-plugin'
|
||||
|
|
@ -0,0 +1 @@
|
|||
export type PluginElementPlaceholder = 'player-next'
|
||||
|
|
@ -0,0 +1,23 @@
|
|||
export type RegisterClientFormFieldOptions = {
|
||||
name?: string
|
||||
label?: string
|
||||
type: 'input' | 'input-checkbox' | 'input-password' | 'input-textarea' | 'markdown-text' | 'markdown-enhanced' | 'select' | 'html'
|
||||
|
||||
// For select type
|
||||
options?: { value: string, label: string }[]
|
||||
|
||||
// For html type
|
||||
html?: string
|
||||
|
||||
descriptionHTML?: string
|
||||
|
||||
// Default setting value
|
||||
default?: string | boolean
|
||||
|
||||
// Not supported by plugin setting registration, use registerSettingsScript instead
|
||||
hidden?: (options: any) => boolean
|
||||
}
|
||||
|
||||
export interface RegisterClientVideoFieldOptions {
|
||||
type: 'update' | 'upload' | 'import-url' | 'import-torrent' | 'go-live'
|
||||
}
|
||||
|
|
@ -0,0 +1,7 @@
|
|||
import { ClientHookName } from './client-hook.model'
|
||||
|
||||
export interface RegisterClientHookOptions {
|
||||
target: ClientHookName
|
||||
handler: Function
|
||||
priority?: number
|
||||
}
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
import { RegisterServerSettingOptions } from '../server'
|
||||
|
||||
export interface RegisterClientSettingsScript {
|
||||
isSettingHidden (options: {
|
||||
setting: RegisterServerSettingOptions
|
||||
formValues: { [name: string]: any }
|
||||
}): boolean
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue