Skip to main content

Init Plugin Develop Env

Before developing a plugin, we need to create a plugin development environment. This environment can directly reuse the plugin environment of Tailchat official source code (https://github.com/msgbyte/tailchat/tree/master/client/web/plugins), It can also be an independent project

Here we mainly teach you how to create an independent plugin development environment

frontend plugin development environment​

It is very simple to create a plugin. Before that, if we did not initialize the plugin environment, we need to initialize the development environment first

Let's just find a place to build a project folder:

mkdir tailchat-plugin-test && cd tailchat-plugin-test

Execute in the root directory:

npm init -y
npm install mini-star

Create the configuration file of the mini-star in the root directory which named .ministarrc.js, the content is as follows:

// .ministarrc.js
const path = require('path');

module.exports = {
  externalDeps: [
    'react',
    'react-router',
    'axios',
    'styled-components',
    'zustand',
    'zustand/middleware/immer',
  ],
};

Write a compilation script in package.json

{
  //...
  "scripts": {
    // ...
    "plugins:all": "ministar buildPlugin all",
    "plugins:watch": "ministar watchPlugin all",
    // ...
  }
  //...
}

backend plugin development environment​

TODO

HTTP authentication for service actions​

Actions registered with TcService.registerAction require authentication over HTTP by default, unless the route is in the auth whitelist. For an action that allows anonymous reads but also needs the caller's identity when logged in, declare optionalAuth: true:

this.registerAction('getPublicInfo', this.getPublicInfo, {
  optionalAuth: true,
  params: { id: 'string' },
});

With this option, a request without x-token is anonymous. A valid token populates ctx.meta.userId; an invalid token returns HTTP 401. The policy follows the action, including its HTTP aliases, and takes precedence over the auth whitelist. No whitelist registration is needed. Services must still filter private fields based on the authenticated identity. Socket authentication and action visibility remain unchanged.