X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=support%2Fdoc%2Fplugins%2Fguide.md;h=e567e6c1b352b689ee9ab6d1189067ebe6bc0c84;hb=9452d4fd3321148fb80b64a67bd9983fee6c208e;hp=85aaf9f02ffe3300a0d2bb42bb9b25abe0a8e3a2;hpb=dc3d902234bb73fbc8cf9787e3036f2012526e6c;p=github%2FChocobozzz%2FPeerTube.git diff --git a/support/doc/plugins/guide.md b/support/doc/plugins/guide.md index 85aaf9f02..e567e6c1b 100644 --- a/support/doc/plugins/guide.md +++ b/support/doc/plugins/guide.md @@ -3,7 +3,6 @@ - - [Concepts](#concepts) - [Hooks](#hooks) - [Static files](#static-files) @@ -17,19 +16,20 @@ - [Add new transcoding profiles](#add-new-transcoding-profiles) - [Server helpers](#server-helpers) - [Client API (themes & plugins)](#client-api-themes--plugins) - - [Plugin static route](#plugin-static-route) + - [Get plugin static and router routes](#get-plugin-static-and-router-routes) - [Notifier](#notifier) - [Markdown Renderer](#markdown-renderer) - [Auth header](#auth-header) - - [Plugin router route](#plugin-router-route) - [Custom Modal](#custom-modal) - [Translate](#translate) - [Get public settings](#get-public-settings) - [Get server config](#get-server-config) - [Add custom fields to video form](#add-custom-fields-to-video-form) - [Register settings script](#register-settings-script) + - [Plugin selector on HTML elements](#plugin-selector-on-html-elements) - [HTML placeholder elements](#html-placeholder-elements) - [Add/remove left menu links](#addremove-left-menu-links) + - [Create client page](#create-client-page) - [Publishing](#publishing) - [Write a plugin/theme](#write-a-plugintheme) - [Clone the quickstart repository](#clone-the-quickstart-repository) @@ -108,6 +108,20 @@ async function register ({ } ``` +Hooks prefixed by `action:api` also give access the original **express** [Request](http://expressjs.com/en/api.html#req) and [Response](http://expressjs.com/en/api.html#res): + +```js +async function register ({ + registerHook, + peertubeHelpers: { logger } +}) { + registerHook({ + target: 'action:api.video.updated', + handler: ({ req, res }) => logger.debug('original request parameters', { params: req.params }) + }) +} +``` + On client side, these hooks are registered by the `clientScripts` files defined in `package.json`. All client scripts have scopes so PeerTube client only loads scripts it needs: @@ -180,6 +194,15 @@ function register (...) { type: 'input', // type: 'input' | 'input-checkbox' | 'input-password' | 'input-textarea' | 'markdown-text' | 'markdown-enhanced' | 'select' | 'html' + // If type: 'select', give the select available options + options: [ + { label: 'Label 1', value: 'value1' }, + { label: 'Label 2', value: 'value2' } + ], + + // If type: 'html', set the HTML that will be injected in the page + html: 'Hello

' + // Optional descriptionHTML: 'The purpose of this field is...', @@ -196,7 +219,7 @@ function register (...) { result['admin-name] settingsManager.onSettingsChange(settings => { - settings['admin-name]) + settings['admin-name'] }) } ``` @@ -237,12 +260,12 @@ function register ({ You can add/delete video categories, licences or languages using the appropriate constant managers: ```js -function register ({ - videoLanguageManager, - videoCategoryManager, - videoLicenceManager, - videoPrivacyManager, - playlistPrivacyManager +function register ({ + videoLanguageManager, + videoCategoryManager, + videoLicenceManager, + videoPrivacyManager, + playlistPrivacyManager }) { videoLanguageManager.addConstant('al_bhed', 'Al Bhed') videoLanguageManager.deleteConstant('fr') @@ -508,7 +531,7 @@ See the [plugin API reference](https://docs.joinpeertube.org/api-plugins) to see ### Client API (themes & plugins) -#### Plugin static route +#### Get plugin static and router routes To get your plugin static route: @@ -519,6 +542,24 @@ function register (...) { } ``` +And to get your plugin router route, use `peertubeHelpers.getBaseRouterRoute()`: + +```js +function register (...) { + registerHook({ + target: 'action:video-watch.video.loaded', + handler: ({ video }) => { + fetch(peertubeHelpers.getBaseRouterRoute() + '/my/plugin/api', { + method: 'GET', + headers: peertubeHelpers.getAuthHeader() + }).then(res => res.json()) + .then(data => console.log('Hi %s.', data)) + } + }) +} +``` + + #### Notifier To notify the user with the PeerTube ToastModule: @@ -571,27 +612,6 @@ function register (...) { } ``` -#### Plugin router route - -**PeerTube >= 3.3** - -To get your plugin router route, you can use `peertubeHelpers.getBaseRouterRoute()`: - -```js -function register (...) { - registerHook({ - target: 'action:video-watch.video.loaded', - handler: ({ video }) => { - fetch(peertubeHelpers.getBaseRouterRoute() + '/my/plugin/api', { - method: 'GET', - headers: peertubeHelpers.getAuthHeader() - }).then(res => res.json()) - .then(data => console.log('Hi %s.', data)) - } - }) -} -``` - #### Custom Modal To show a custom modal: @@ -663,18 +683,37 @@ async function register ({ registerVideoField, peertubeHelpers }) { name: 'my-field-name, label: 'My added field', descriptionHTML: 'Optional description', + + // type: 'input' | 'input-checkbox' | 'input-password' | 'input-textarea' | 'markdown-text' | 'markdown-enhanced' | 'select' | 'html' + // /!\ 'input-checkbox' could send "false" and "true" strings instead of boolean type: 'input-textarea', + default: '', + // Optional, to hide a field depending on the current form state // liveVideo is in the options object when the user is creating/updating a live // videoToUpdate is in the options object when the user is updating a video hidden: ({ formValues, videoToUpdate, liveVideo }) => { return formValues.pluginData['other-field'] === 'toto' + }, + + // Optional, to display an error depending on the form state + error: ({ formValues, value }) => { + if (formValues['privacy'] !== 1 && formValues['privacy'] !== 2) return { error: false } + if (value === true) return { error: false } + + return { error: true, text: 'Should be enabled' } } } + const videoFormOptions = { + // Optional, to choose to put your setting in a specific tab in video form + // type: 'main' | 'plugin-settings' + tab: 'main' + } + for (const type of [ 'upload', 'import-url', 'import-torrent', 'update', 'go-live' ]) { - registerVideoField(commonOptions, { type }) + registerVideoField(commonOptions, { type, ...videoFormOptions }) } } ``` @@ -736,6 +775,13 @@ async function register ({ registerSettingsScript }) { }) } ``` +#### Plugin selector on HTML elements + +PeerTube provides some selectors (using `id` HTML attribute) on important blocks so plugins can easily change their style. + +For example `#plugin-selector-login-form` could be used to hide the login form. + +See the complete list on https://docs.joinpeertube.org/api-plugins #### HTML placeholder elements @@ -757,6 +803,21 @@ See the complete list on https://docs.joinpeertube.org/api-plugins Left menu links can be filtered (add/remove a section or add/remove links) using the `filter:left-menu.links.create.result` client hook. +#### Create client page + +To create a client page, register a new client route: + +```js +function register ({ registerClientRoute }) { + registerClientRoute({ + route: 'my-super/route', + onMount: ({ rootEl }) => { + rootEl.innerHTML = 'hello' + } + }) +} +``` + ### Publishing @@ -845,11 +906,62 @@ And if you don't need CSS or client script files, use an empty `array`: ### Write code Now you can register hooks or settings, write CSS and add static directories to your plugin or your theme :) +It's up to you to check the code you write will be compatible with the PeerTube NodeJS version, and will be supported by web browsers. + +**JavaScript** -**Caution:** It's up to you to check the code you write will be compatible with the PeerTube NodeJS version, -and will be supported by web browsers. If you want to write modern JavaScript, please use a transpiler like [Babel](https://babeljs.io/). +**Typescript** + +If you want to use __Typescript__, you can add __PeerTube__ types as dev dependencies: + +``` +npm install --save-dev @peertube/peertube-types +``` + +This package exposes *server* definition files by default: +```ts +import { RegisterServerOptions } from '@peertube/peertube-types' + +export async function register ({ registerHook }: RegisterServerOptions) { + registerHook({ + target: 'action:application.listening', + handler: () => displayHelloWorld() + }) +} +``` + +But it also exposes client types and various models used in __PeerTube__: +```ts +import { Video } from '@peertube/peertube-types'; +import { RegisterClientOptions } from '@peertube/peertube-types/client'; + +function register({ registerHook, peertubeHelpers }: RegisterClientOptions) { + registerHook({ + target: 'action:admin-plugin-settings.init', + handler: ({ npmName }: { npmName: string }) => { + if ('peertube-plugin-transcription' !== npmName) { + return; + } + }, + }); + + registerHook({ + target: 'action:video-watch.video.loaded', + handler: ({ video }: { video: Video }) => { + fetch(`${peertubeHelpers.getBaseRouterRoute()}/videos/${video.uuid}/captions`, { + method: 'PUT', + headers: peertubeHelpers.getAuthHeader(), + }).then((res) => res.json()) + .then((data) => console.log('Hi %s.', data)); + }, + }); +} + +export { register }; +``` + ### Add translations If you want to translate strings of your plugin (like labels of your registered settings), create a file and add it to `package.json`: @@ -903,13 +1015,16 @@ You built files are in the `dist/` directory. Check `package.json` to correctly ### Test your plugin/theme +PeerTube dev server (ran with `npm run dev` on `localhost:3000`) can't inject plugin CSS. +It's the reason why we don't use the dev mode but build PeerTube instead. + You'll need to have a local PeerTube instance: * Follow the [dev prerequisites](https://github.com/Chocobozzz/PeerTube/blob/develop/.github/CONTRIBUTING.md#prerequisites) (to clone the repository, install dependencies and prepare the database) - * Build PeerTube (`--light` to only build the english language): + * Build PeerTube: ``` -$ npm run build -- --light +$ npm run build ``` * Build the CLI: @@ -921,7 +1036,7 @@ $ npm run setup:cli * Run PeerTube (you can access to your instance on http://localhost:9000): ``` -$ NODE_ENV=test npm start +$ NODE_ENV=dev npm start ``` * Register the instance via the CLI: