@big-yahu/plugin-sdk

The plugin contract for Big Yahu — types, the hook names, and the plugin API version.

npm install --save-dev @big-yahu/plugin-sdk

A devDependency: everything here except PLUGIN_API_VERSION, HOOK_NAMES and definePlugin is a type, so nothing of it exists at runtime and a production install never fetches it.

import { definePlugin } from '@big-yahu/plugin-sdk';

export default definePlugin({
  id: 'my-plugin',
  name: 'My Plugin',
  description: 'What it does, in one line.',
  version: '1.0.0',

  onMessage({ message, storage }) {
    storage.set('lastSeen', message.id);
  },
});

Depending on this package is how you declare which contract you speak. Its major version is the contract version, so the range in your package.json says it and there is nothing else to keep in step — updating the SDK is the whole of updating your declaration.

{ "devDependencies": { "@big-yahu/plugin-sdk": "^2" } }

The bot reads that range out of your package.json rather than importing your plugin to ask, because it checks compatibility before running your entry file: a plugin written against a contract the host does not speak may do anything at import time, and running its top level to find out it should not have run is the wrong order.

If you do not use the SDK at all — plain JavaScript, no build step — say it directly instead:

{ "bigYahu": { "displayName": "My Plugin", "apiVersion": 2 } }

Do not do both. When the two disagree the plugin is refused rather than one being quietly preferred, since that is precisely the drift this exists to prevent. A git or tag dependency carries no version number and cannot be read, so pair it with the explicit field.

Full authoring guide: PLUGINS.md.

MIT.