@auvexis/fabric-sdk

TypeScript SDK for building external Fabric plugins. By Auvexis.

Install

npm install @auvexis/fabric-sdk

Minimal plugin

import { defineManifest, definePlugin } from "@auvexis/fabric-sdk";

const manifest = defineManifest({
  metadata: {
    id: "my-plugin",
    name: "My Plugin",
    description: "Small external plugin",
    icon: "plug",
    categories: ["Apps"],
    author: "Acme",
    version: "1.0.0",
    repository: "https://github.com/acme/my-plugin",
  },
  methods: {
    ping: {
      metadata: {
        label: "Ping",
        description: "Returns pong",
      },
      parameters: {
        type: "object",
        properties: {},
      },
      responseSchema: {
        type: "object",
      },
    },
  },
});

export default definePlugin({
  id: "my-plugin",
  manifest,
  auth: { type: "none" },
  methods: {
    async ping() {
      return { pong: true };
    },
  },
});

Validate a manifest

import { validateManifest } from "@auvexis/fabric-sdk";

const result = validateManifest(manifest);

if (!result.valid) {
  console.error(result.errors);
}

Exports

• defineManifest
• definePlugin
• validateManifest
• manifestSchema
• Fabric plugin, auth, method, trigger and JSON schema types

Migration from 1.x to 2.0

Version 2.0 removes the legacy singular metadata.category field.

Before:

{
  "metadata": {
    "category": "Utilities"
  }
}

After:

{
  "metadata": {
    "categories": ["Core"]
  }
}

Valid categories are:

• AI
• Core
• Flow
• Data transformation
• Apps
• Files
• Developer