@ever-works/composio-plugin 1.0.0 → 1.0.5

package/dist/index.d.cts

@@ -0,0 +1,186 @@
+import { IPlugin, IPipelinePlugin, IFormSchemaProvider, ISkillsProviderPlugin, PluginCategory, JsonSchema, PluginContext, PluginHealthCheck, ValidationResult, ConnectionValidationResult, PluginManifest, FormFieldDefinition, FormFieldGroup, SkillCatalogListOptions, SkillCatalogListResult, PluginSettings, SkillCatalogEntry, SkillCatalogUpdate, PipelineStepDefinition, WorkReference, GenerationRequest, ExistingItems, PipelineExecutionOptions, PipelineProgressCallback, PipelineResult, PipelineState } from '@ever-works/plugin';
+
+/** Step IDs for the Composio pipeline. */
+type ComposioStepId = 'validate-composio' | 'prepare-payload' | 'execute-tool' | 'collect-results' | 'capture-screenshots' | 'cleanup';
+/**
+ * Identifies a single Composio tool the plugin will invoke.
+ *
+ * Composio v3 references a tool by its **slug** (e.g. `GMAIL_SEND_EMAIL`,
+ * `GITHUB_CREATE_ISSUE`, `SLACK_SEND_MESSAGE`). The slug is unique across
+ * toolkits, so `toolkit` is informational only — used for connected-account
+ * validation and surfaced in metrics.
+ */
+interface ComposioToolRef {
+    toolkit: string;
+    toolSlug: string;
+    /**
+     * The Composio `user_id` whose connected account the tool runs against.
+     * The plugin defaults this to the Ever Works user ID; the user can pin a
+     * different value (e.g. an email) in plugin settings.
+     */
+    userId: string;
+}
+/**
+ * How the plugin should interpret the tool's response payload.
+ *  - `structured`: the tool returns `{ items: [...] }` (cleanest for custom tools).
+ *  - `native`: raw records projected onto work items via a field mapping.
+ *  - `side-effect`: fire-and-forget (e.g. send email, post message) — no items.
+ */
+type ComposioResultShape = 'structured' | 'native' | 'side-effect';
+/** Field mapping used when the tool returns native records instead of { items: [...] }. */
+interface ComposioFieldMapping {
+    nameField: string;
+    urlField?: string;
+    descriptionField?: string;
+    categoryField?: string;
+    tagsField?: string;
+    imageField?: string;
+    brandField?: string;
+    contentField?: string;
+}
+/** Data source types for passing data to the Composio tool. */
+type DataSourceType = 'inline' | 'github-repo';
+/** Input payload sent as `arguments` to the Composio tool. */
+interface ComposioToolInput {
+    metadata: {
+        workId: string;
+        workName: string;
+        workSlug: string;
+        workDescription?: string;
+        prompt?: string;
+        generationMethod?: string;
+        targetItems: number;
+    };
+    existingSummary?: {
+        totalItems: number;
+        categories: string[];
+        tags: string[];
+        sampleItems: Array<{
+            name: string;
+            url?: string;
+        }>;
+    };
+    dataSource?: {
+        type: DataSourceType;
+        repoUrl?: string;
+        accessToken?: string;
+        branch?: string;
+        path?: string;
+    };
+    toolParams?: Record<string, unknown>;
+}
+/** Structured work payload returned by a custom Composio tool (mirrors sim-ai / zapier). */
+interface ComposioToolOutput {
+    items: ComposioOutputItem[];
+    categories?: Array<{
+        name: string;
+        description?: string;
+    }>;
+    tags?: Array<{
+        name: string;
+    }>;
+    brands?: Array<{
+        name: string;
+        url?: string;
+    }>;
+}
+interface ComposioOutputItem {
+    name: string;
+    description?: string;
+    url?: string;
+    source_url?: string;
+    content?: string;
+    category?: string;
+    tags?: string[];
+    brand?: string;
+    images?: string[];
+    metadata?: Record<string, unknown>;
+}
+/** Resolved settings for the Composio plugin. */
+interface ComposioSettings {
+    apiKey?: string;
+    baseUrl?: string;
+    defaultUserId?: string;
+    defaultToolkit?: string;
+    defaultToolSlug?: string;
+    timeoutMs: number;
+    resultShape: ComposioResultShape;
+    fieldMapping: ComposioFieldMapping;
+}
+/** Metrics specific to Composio execution. */
+interface ComposioPipelineMetrics {
+    toolkit: string;
+    toolSlug: string;
+    userId: string;
+    resultShape: ComposioResultShape;
+    composioDuration?: number;
+    itemsReturned?: number;
+}
+/** Shape of a Composio connected account (subset of the v3 response). */
+interface ComposioConnectedAccount {
+    id: string;
+    status: 'INITIATED' | 'ACTIVE' | 'EXPIRED' | 'REVOKED' | 'FAILED' | string;
+    toolkit?: {
+        slug: string;
+    } | undefined;
+    user_id?: string;
+}
+/** Shape of a Composio toolkit catalog entry (subset of the v3 response). */
+interface ComposioToolkitEntry {
+    slug: string;
+    name: string;
+    description?: string;
+    categories?: string[];
+    auth_schemes?: string[];
+}
+
+/**
+ * Composio Integrations Plugin
+ *
+ * Pipeline plugin that executes a Composio tool during work generation.
+ * Composio brokers OAuth across 500+ third-party apps; each user connects
+ * their accounts once via Composio's hosted flow, and the platform runs
+ * tools against `composio.user_id` (defaulted to the Ever Works user id).
+ */
+declare class ComposioPlugin implements IPlugin, IPipelinePlugin, IFormSchemaProvider, ISkillsProviderPlugin {
+    readonly id = "composio";
+    readonly name = "Composio Integrations";
+    readonly version = "1.0.0";
+    readonly category: PluginCategory;
+    readonly capabilities: readonly ["pipeline", "form-schema-provider", "skills-provider"];
+    readonly configurationMode: "user-required";
+    readonly handledConfigFields: readonly ["*"];
+    readonly providerName = "Composio Integrations";
+    readonly settingsSchema: JsonSchema;
+    private context;
+    onLoad(context: PluginContext): Promise<void>;
+    onUnload(): Promise<void>;
+    healthCheck(): Promise<PluginHealthCheck>;
+    isAvailable(settings?: Record<string, unknown>): boolean;
+    validateSettings(settings: Record<string, unknown>): Promise<ValidationResult>;
+    validateConnection(rawSettings: Record<string, unknown>): Promise<ConnectionValidationResult>;
+    getManifest(): PluginManifest;
+    getFormFields(): FormFieldDefinition[];
+    getFormGroups(): FormFieldGroup[];
+    validateFormInput(values: Record<string, unknown>): ValidationResult;
+    getDefaultValues(): Record<string, unknown>;
+    listEntries(options: SkillCatalogListOptions): Promise<SkillCatalogListResult>;
+    getEntry(slug: string, settings?: PluginSettings): Promise<SkillCatalogEntry | null>;
+    checkForUpdates(installedVersions: Record<string, string>, settings?: PluginSettings): Promise<{
+        updated: SkillCatalogUpdate[];
+    }>;
+    private loadEntries;
+    getStepDefinitions(): readonly PipelineStepDefinition[];
+    private _lastState;
+    private _lastAbortController;
+    execute(work: WorkReference, request: GenerationRequest, existing: ExistingItems, options?: PipelineExecutionOptions, onProgress?: PipelineProgressCallback): Promise<PipelineResult>;
+    cancel(): Promise<void>;
+    getState(): PipelineState<ComposioStepId> | null;
+    private resolveComposioSettings;
+    private resolveToolRef;
+    private collectMissingToolFields;
+    private captureScreenshots;
+    private flattenSettings;
+}
+
+export { type ComposioConnectedAccount, type ComposioFieldMapping, type ComposioOutputItem, type ComposioPipelineMetrics, ComposioPlugin, type ComposioResultShape, type ComposioSettings, type ComposioStepId, type ComposioToolInput, type ComposioToolOutput, type ComposioToolRef, type ComposioToolkitEntry, ComposioPlugin as default };

package/dist/index.d.ts

@@ -0,0 +1,186 @@
+import { IPlugin, IPipelinePlugin, IFormSchemaProvider, ISkillsProviderPlugin, PluginCategory, JsonSchema, PluginContext, PluginHealthCheck, ValidationResult, ConnectionValidationResult, PluginManifest, FormFieldDefinition, FormFieldGroup, SkillCatalogListOptions, SkillCatalogListResult, PluginSettings, SkillCatalogEntry, SkillCatalogUpdate, PipelineStepDefinition, WorkReference, GenerationRequest, ExistingItems, PipelineExecutionOptions, PipelineProgressCallback, PipelineResult, PipelineState } from '@ever-works/plugin';
+
+/** Step IDs for the Composio pipeline. */
+type ComposioStepId = 'validate-composio' | 'prepare-payload' | 'execute-tool' | 'collect-results' | 'capture-screenshots' | 'cleanup';
+/**
+ * Identifies a single Composio tool the plugin will invoke.
+ *
+ * Composio v3 references a tool by its **slug** (e.g. `GMAIL_SEND_EMAIL`,
+ * `GITHUB_CREATE_ISSUE`, `SLACK_SEND_MESSAGE`). The slug is unique across
+ * toolkits, so `toolkit` is informational only — used for connected-account
+ * validation and surfaced in metrics.
+ */
+interface ComposioToolRef {
+    toolkit: string;
+    toolSlug: string;
+    /**
+     * The Composio `user_id` whose connected account the tool runs against.
+     * The plugin defaults this to the Ever Works user ID; the user can pin a
+     * different value (e.g. an email) in plugin settings.
+     */
+    userId: string;
+}
+/**
+ * How the plugin should interpret the tool's response payload.
+ *  - `structured`: the tool returns `{ items: [...] }` (cleanest for custom tools).
+ *  - `native`: raw records projected onto work items via a field mapping.
+ *  - `side-effect`: fire-and-forget (e.g. send email, post message) — no items.
+ */
+type ComposioResultShape = 'structured' | 'native' | 'side-effect';
+/** Field mapping used when the tool returns native records instead of { items: [...] }. */
+interface ComposioFieldMapping {
+    nameField: string;
+    urlField?: string;
+    descriptionField?: string;
+    categoryField?: string;
+    tagsField?: string;
+    imageField?: string;
+    brandField?: string;
+    contentField?: string;
+}
+/** Data source types for passing data to the Composio tool. */
+type DataSourceType = 'inline' | 'github-repo';
+/** Input payload sent as `arguments` to the Composio tool. */
+interface ComposioToolInput {
+    metadata: {
+        workId: string;
+        workName: string;
+        workSlug: string;
+        workDescription?: string;
+        prompt?: string;
+        generationMethod?: string;
+        targetItems: number;
+    };
+    existingSummary?: {
+        totalItems: number;
+        categories: string[];
+        tags: string[];
+        sampleItems: Array<{
+            name: string;
+            url?: string;
+        }>;
+    };
+    dataSource?: {
+        type: DataSourceType;
+        repoUrl?: string;
+        accessToken?: string;
+        branch?: string;
+        path?: string;
+    };
+    toolParams?: Record<string, unknown>;
+}
+/** Structured work payload returned by a custom Composio tool (mirrors sim-ai / zapier). */
+interface ComposioToolOutput {
+    items: ComposioOutputItem[];
+    categories?: Array<{
+        name: string;
+        description?: string;
+    }>;
+    tags?: Array<{
+        name: string;
+    }>;
+    brands?: Array<{
+        name: string;
+        url?: string;
+    }>;
+}
+interface ComposioOutputItem {
+    name: string;
+    description?: string;
+    url?: string;
+    source_url?: string;
+    content?: string;
+    category?: string;
+    tags?: string[];
+    brand?: string;
+    images?: string[];
+    metadata?: Record<string, unknown>;
+}
+/** Resolved settings for the Composio plugin. */
+interface ComposioSettings {
+    apiKey?: string;
+    baseUrl?: string;
+    defaultUserId?: string;
+    defaultToolkit?: string;
+    defaultToolSlug?: string;
+    timeoutMs: number;
+    resultShape: ComposioResultShape;
+    fieldMapping: ComposioFieldMapping;
+}
+/** Metrics specific to Composio execution. */
+interface ComposioPipelineMetrics {
+    toolkit: string;
+    toolSlug: string;
+    userId: string;
+    resultShape: ComposioResultShape;
+    composioDuration?: number;
+    itemsReturned?: number;
+}
+/** Shape of a Composio connected account (subset of the v3 response). */
+interface ComposioConnectedAccount {
+    id: string;
+    status: 'INITIATED' | 'ACTIVE' | 'EXPIRED' | 'REVOKED' | 'FAILED' | string;
+    toolkit?: {
+        slug: string;
+    } | undefined;
+    user_id?: string;
+}
+/** Shape of a Composio toolkit catalog entry (subset of the v3 response). */
+interface ComposioToolkitEntry {
+    slug: string;
+    name: string;
+    description?: string;
+    categories?: string[];
+    auth_schemes?: string[];
+}
+
+/**
+ * Composio Integrations Plugin
+ *
+ * Pipeline plugin that executes a Composio tool during work generation.
+ * Composio brokers OAuth across 500+ third-party apps; each user connects
+ * their accounts once via Composio's hosted flow, and the platform runs
+ * tools against `composio.user_id` (defaulted to the Ever Works user id).
+ */
+declare class ComposioPlugin implements IPlugin, IPipelinePlugin, IFormSchemaProvider, ISkillsProviderPlugin {
+    readonly id = "composio";
+    readonly name = "Composio Integrations";
+    readonly version = "1.0.0";
+    readonly category: PluginCategory;
+    readonly capabilities: readonly ["pipeline", "form-schema-provider", "skills-provider"];
+    readonly configurationMode: "user-required";
+    readonly handledConfigFields: readonly ["*"];
+    readonly providerName = "Composio Integrations";
+    readonly settingsSchema: JsonSchema;
+    private context;
+    onLoad(context: PluginContext): Promise<void>;
+    onUnload(): Promise<void>;
+    healthCheck(): Promise<PluginHealthCheck>;
+    isAvailable(settings?: Record<string, unknown>): boolean;
+    validateSettings(settings: Record<string, unknown>): Promise<ValidationResult>;
+    validateConnection(rawSettings: Record<string, unknown>): Promise<ConnectionValidationResult>;
+    getManifest(): PluginManifest;
+    getFormFields(): FormFieldDefinition[];
+    getFormGroups(): FormFieldGroup[];
+    validateFormInput(values: Record<string, unknown>): ValidationResult;
+    getDefaultValues(): Record<string, unknown>;
+    listEntries(options: SkillCatalogListOptions): Promise<SkillCatalogListResult>;
+    getEntry(slug: string, settings?: PluginSettings): Promise<SkillCatalogEntry | null>;
+    checkForUpdates(installedVersions: Record<string, string>, settings?: PluginSettings): Promise<{
+        updated: SkillCatalogUpdate[];
+    }>;
+    private loadEntries;
+    getStepDefinitions(): readonly PipelineStepDefinition[];
+    private _lastState;
+    private _lastAbortController;
+    execute(work: WorkReference, request: GenerationRequest, existing: ExistingItems, options?: PipelineExecutionOptions, onProgress?: PipelineProgressCallback): Promise<PipelineResult>;
+    cancel(): Promise<void>;
+    getState(): PipelineState<ComposioStepId> | null;
+    private resolveComposioSettings;
+    private resolveToolRef;
+    private collectMissingToolFields;
+    private captureScreenshots;
+    private flattenSettings;
+}
+
+export { type ComposioConnectedAccount, type ComposioFieldMapping, type ComposioOutputItem, type ComposioPipelineMetrics, ComposioPlugin, type ComposioResultShape, type ComposioSettings, type ComposioStepId, type ComposioToolInput, type ComposioToolOutput, type ComposioToolRef, type ComposioToolkitEntry, ComposioPlugin as default };