Create Plugin Package Architecture & SDK

[coderabbitai]

Overview

Establish the structure for standalone plugin packages and create the plugin SDK for external plugin development.

Context

Related to PR #40 - Enable modular plugin development similar to n8n's node packages.

Implementation Steps

1. Create Plugin SDK Package

Create packages/plugin-sdk/:

• Export all core types from plugin-system
• Provide helper functions: createPlugin(), PluginAuth.OAuth2(), PluginAuth.ApiKey()
• Include utilities for common operations

2. Define Plugin Package Structure

Standard structure for all plugins:

@axebase/plugin-{name}/
├── package.json           # Plugin manifest
├── src/
│   ├── index.ts          # Plugin entry point
│   ├── trigger.ts        # Trigger implementation (if applicable)
│   ├── actions/          # Actions (if applicable)
│   ├── auth.ts           # Auth configuration
│   └── utils.ts          # Helpers
├── README.md
└── tsconfig.json

3. Package.json Convention

{
  "name": "@axebase/plugin-google-forms",
  "keywords": ["axebase-plugin"],
  "axebase": {
    "plugin": {
      "type": "integration",
      "triggers": ["./dist/trigger.js"],
      "actions": ["./dist/actions/*.js"]
    }
  },
  "peerDependencies": {
    "@axebase/plugin-sdk": "^1.0.0"
  }
}

4. Create Example Plugin

Create @axebase/plugin-google-forms as reference implementation:

• Full implementation following the architecture
• Documentation for developers
• Demonstrates webhook trigger pattern

5. Helper Functions

// Simplified plugin creation
export function createPlugin(config: PluginConfig): Plugin;
export function createTriggerPlugin(config: TriggerPluginConfig): TriggerPlugin;
export function createActionPlugin(config: ActionPluginConfig): ActionPlugin;

// Auth helpers
export const PluginAuth = {
  None: () => ({ type: 'none' }),
  ApiKey: (config) => ({ type: 'api-key', fields: [...] }),
  OAuth2: (config) => ({ type: 'oauth2', ... })
};

Acceptance Criteria

• Plugin SDK package created and published (or linked locally)
• Standard plugin package structure documented
• Helper functions implemented and tested
• Reference plugin (google-forms) created
• Plugin discovery via package.json axebase field works
• Documentation for creating plugins written

Dependencies

• Issue feat: tRPC Initalized #1 (Plugin System Foundation) must be completed first

Estimated Effort

• Large (8-12 hours)

---

Backlink: #40

[github-actions]

👋 Thanks for opening another issue, @coderabbitai[bot]! We appreciate your continued engagement with the project.

Quick checklist:

• Clear description of the issue
• Steps to reproduce (if applicable)
• Expected vs actual behavior

We'll take a look as soon as possible!

[coderabbitai]

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
# Fetch details of issue `#43` from the repository
gh issue view 43 --repo Pranjal6955/axebase --json number,title,body,author,labels,state,createdAt,url

Length of output: 3251

---

@github-actions Thank you for the welcome message! This issue has been created as a follow-up action from PR #40.

Checklist status:

• ✅ Clear description of the issue - Comprehensive overview and context provided
• ✅ Steps to reproduce - Implementation steps detailed with code examples
• ✅ Expected vs actual behavior - Acceptance criteria clearly defined

The issue documents the architecture for creating a plugin SDK and standardizing plugin packages for the axebase project. It includes detailed implementation steps, package structure, helper function signatures, and acceptance criteria. This issue is ready for review and implementation by the project maintainers.