@openhands/extensions 0.5.0 → 0.7.0

package/integrations/catalog/zoom.json

@@ -0,0 +1,33 @@
+{
+  "id": "zoom",
+  "name": "Zoom",
+  "description": "Meetings, recordings, webinars, and scheduling operations.",
+  "categories": [
+    "Meetings",
+    "Calendar"
+  ],
+  "appUrl": "https://zoom.us",
+  "docsUrl": "https://developers.zoom.us/docs/integrations/oauth/",
+  "notes": "Frequently requested for scheduling and meeting summaries.",
+  "popularityRank": 31,
+  "connectionOptions": [
+    {
+      "id": "oauth",
+      "provider": "http",
+      "auth": {
+        "strategy": "oauth2",
+        "oauth": {
+          "authorizationUrl": "https://zoom.us/oauth/authorize",
+          "tokenUrl": "https://zoom.us/oauth/token",
+          "scopes": [
+            "meeting:read:user"
+          ]
+        }
+      },
+      "http": {
+        "apiBaseUrl": "https://api.zoom.us/v2",
+        "openApiUrl": "https://api.apis.guru/v2/specs/zoom.us/2.0.0/openapi.json"
+      }
+    }
+  ]
+}

package/integrations/catalog-index.js

@@ -0,0 +1,151 @@
+// This file is auto-generated by scripts/build-integration-catalog.mjs.
+// Do not edit it manually. To update it after changing integrations/catalog/*.json,
+// run: npm run build:integrations
+
+import entry0 from "./catalog/github.json" with { type: "json" };
+import entry1 from "./catalog/slack.json" with { type: "json" };
+import entry2 from "./catalog/tavily.json" with { type: "json" };
+import entry3 from "./catalog/linear.json" with { type: "json" };
+import entry4 from "./catalog/notion.json" with { type: "json" };
+import entry5 from "./catalog/ordinal.json" with { type: "json" };
+import entry6 from "./catalog/elevenlabs.json" with { type: "json" };
+import entry7 from "./catalog/bitbucket.json" with { type: "json" };
+import entry8 from "./catalog/xero.json" with { type: "json" };
+import entry9 from "./catalog/quickbooks.json" with { type: "json" };
+import entry10 from "./catalog/okta.json" with { type: "json" };
+import entry11 from "./catalog/netlify.json" with { type: "json" };
+import entry12 from "./catalog/vercel.json" with { type: "json" };
+import entry13 from "./catalog/supabase.json" with { type: "json" };
+import entry14 from "./catalog/posthog.json" with { type: "json" };
+import entry15 from "./catalog/sentry.json" with { type: "json" };
+import entry16 from "./catalog/datadog.json" with { type: "json" };
+import entry17 from "./catalog/canva.json" with { type: "json" };
+import entry18 from "./catalog/miro.json" with { type: "json" };
+import entry19 from "./catalog/webflow.json" with { type: "json" };
+import entry20 from "./catalog/zoom.json" with { type: "json" };
+import entry21 from "./catalog/discord.json" with { type: "json" };
+import entry22 from "./catalog/stripe.json" with { type: "json" };
+import entry23 from "./catalog/intercom.json" with { type: "json" };
+import entry24 from "./catalog/hubspot.json" with { type: "json" };
+import entry25 from "./catalog/salesforce.json" with { type: "json" };
+import entry26 from "./catalog/sharepoint.json" with { type: "json" };
+import entry27 from "./catalog/onedrive.json" with { type: "json" };
+import entry28 from "./catalog/microsoft-teams.json" with { type: "json" };
+import entry29 from "./catalog/microsoft-outlook.json" with { type: "json" };
+import entry30 from "./catalog/box.json" with { type: "json" };
+import entry31 from "./catalog/airtable.json" with { type: "json" };
+import entry32 from "./catalog/monday.json" with { type: "json" };
+import entry33 from "./catalog/trello.json" with { type: "json" };
+import entry34 from "./catalog/asana.json" with { type: "json" };
+import entry35 from "./catalog/confluence.json" with { type: "json" };
+import entry36 from "./catalog/jira.json" with { type: "json" };
+import entry37 from "./catalog/google-calendar.json" with { type: "json" };
+import entry38 from "./catalog/gmail.json" with { type: "json" };
+import entry39 from "./catalog/google-sheets.json" with { type: "json" };
+import entry40 from "./catalog/google-drive.json" with { type: "json" };
+import entry41 from "./catalog/figma.json" with { type: "json" };
+import entry42 from "./catalog/google-docs.json" with { type: "json" };
+import entry43 from "./catalog/apify.json" with { type: "json" };
+import entry44 from "./catalog/atlassian.json" with { type: "json" };
+import entry45 from "./catalog/brave-search.json" with { type: "json" };
+import entry46 from "./catalog/browser-mcp.json" with { type: "json" };
+import entry47 from "./catalog/clickhouse.json" with { type: "json" };
+import entry48 from "./catalog/cloudflare-bindings.json" with { type: "json" };
+import entry49 from "./catalog/cloudflare-browser-rendering.json" with { type: "json" };
+import entry50 from "./catalog/cloudflare-builds.json" with { type: "json" };
+import entry51 from "./catalog/cloudflare-docs.json" with { type: "json" };
+import entry52 from "./catalog/cloudflare-observability.json" with { type: "json" };
+import entry53 from "./catalog/deepwiki.json" with { type: "json" };
+import entry54 from "./catalog/everything.json" with { type: "json" };
+import entry55 from "./catalog/exa.json" with { type: "json" };
+import entry56 from "./catalog/fetch.json" with { type: "json" };
+import entry57 from "./catalog/filesystem.json" with { type: "json" };
+import entry58 from "./catalog/firecrawl.json" with { type: "json" };
+import entry59 from "./catalog/git.json" with { type: "json" };
+import entry60 from "./catalog/huggingface.json" with { type: "json" };
+import entry61 from "./catalog/kagi.json" with { type: "json" };
+import entry62 from "./catalog/memory.json" with { type: "json" };
+import entry63 from "./catalog/mongodb.json" with { type: "json" };
+import entry64 from "./catalog/neon.json" with { type: "json" };
+import entry65 from "./catalog/obsidian.json" with { type: "json" };
+import entry66 from "./catalog/paypal.json" with { type: "json" };
+import entry67 from "./catalog/playwright.json" with { type: "json" };
+import entry68 from "./catalog/redis.json" with { type: "json" };
+import entry69 from "./catalog/resend.json" with { type: "json" };
+import entry70 from "./catalog/sequential-thinking.json" with { type: "json" };
+import entry71 from "./catalog/time.json" with { type: "json" };
+
+export const INTEGRATION_CATALOG_ENTRIES = [
+  entry0,
+  entry1,
+  entry2,
+  entry3,
+  entry4,
+  entry5,
+  entry6,
+  entry7,
+  entry8,
+  entry9,
+  entry10,
+  entry11,
+  entry12,
+  entry13,
+  entry14,
+  entry15,
+  entry16,
+  entry17,
+  entry18,
+  entry19,
+  entry20,
+  entry21,
+  entry22,
+  entry23,
+  entry24,
+  entry25,
+  entry26,
+  entry27,
+  entry28,
+  entry29,
+  entry30,
+  entry31,
+  entry32,
+  entry33,
+  entry34,
+  entry35,
+  entry36,
+  entry37,
+  entry38,
+  entry39,
+  entry40,
+  entry41,
+  entry42,
+  entry43,
+  entry44,
+  entry45,
+  entry46,
+  entry47,
+  entry48,
+  entry49,
+  entry50,
+  entry51,
+  entry52,
+  entry53,
+  entry54,
+  entry55,
+  entry56,
+  entry57,
+  entry58,
+  entry59,
+  entry60,
+  entry61,
+  entry62,
+  entry63,
+  entry64,
+  entry65,
+  entry66,
+  entry67,
+  entry68,
+  entry69,
+  entry70,
+  entry71,
+];

package/integrations/catalog.schema.json

@@ -0,0 +1,255 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://github.com/OpenHands/extensions/integrations/catalog.schema.json",
+  "title": "IntegrationCatalogEntry",
+  "description": "Strict schema for integrations/catalog/*.json. Mirrors integrations/index.d.ts and encodes the cross-field connectability rules the catalog contract depends on.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["id", "name", "description", "connectionOptions"],
+  "properties": {
+    "id": { "type": "string", "minLength": 1 },
+    "name": { "type": "string", "minLength": 1 },
+    "description": { "type": "string", "minLength": 1 },
+    "categories": {
+      "type": "array",
+      "minItems": 1,
+      "items": { "type": "string", "minLength": 1 },
+      "uniqueItems": true
+    },
+    "appUrl": { "type": "string", "pattern": "^https://", "minLength": 8 },
+    "docsUrl": { "type": "string", "pattern": "^https://", "minLength": 8 },
+    "notes": { "type": "string", "minLength": 1 },
+    "iconBg": { "type": "string", "minLength": 1 },
+    "iconColor": { "type": "string", "minLength": 1 },
+    "logoUrl": { "type": "string", "pattern": "^https://", "minLength": 8 },
+    "keywords": {
+      "type": "array",
+      "items": { "type": "string", "minLength": 1 },
+      "uniqueItems": true
+    },
+    "popularityRank": { "type": "integer", "minimum": 0 },
+    "installHint": { "type": "string", "minLength": 1 },
+    "connectionOptions": {
+      "type": "array",
+      "minItems": 1,
+      "items": { "$ref": "#/$defs/connectionOption" }
+    }
+  },
+  "$defs": {
+    "marketplaceField": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["key", "label"],
+      "properties": {
+        "key": { "type": "string", "minLength": 1 },
+        "label": { "type": "string", "minLength": 1 },
+        "type": { "enum": ["text", "password"] },
+        "placeholder": { "type": "string" },
+        "helperText": { "type": "string" },
+        "helperLink": { "type": "string", "pattern": "^https://" },
+        "required": { "type": "boolean" }
+      },
+      "allOf": [
+        {
+          "if": { "properties": { "type": { "const": "password" } } },
+          "then": {
+            "required": ["helperText"],
+            "properties": { "helperText": { "minLength": 1 } }
+          }
+        }
+      ]
+    },
+    "oauthConfig": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "authorizationUrl": { "type": "string", "pattern": "^https://", "minLength": 8 },
+        "tokenUrl": { "type": "string", "pattern": "^https://", "minLength": 8 },
+        "scopes": {
+          "type": "array",
+          "items": { "type": "string", "minLength": 1 }
+        },
+        "optionalScopes": {
+          "type": "array",
+          "items": { "type": "string", "minLength": 1 }
+        },
+        "toolScopes": {
+          "type": "array",
+          "items": { "type": "string", "minLength": 1 }
+        },
+        "scopeSeparator": { "enum": ["space", "comma"] },
+        "pkce": { "type": "boolean" },
+        "clientAuthentication": { "enum": ["basic", "body", "none"] },
+        "registrationUrl": { "type": "string", "pattern": "^https://", "minLength": 8 },
+        "additionalAuthorizationParams": {
+          "type": "object",
+          "additionalProperties": { "type": "string" }
+        },
+        "additionalTokenParams": {
+          "type": "object",
+          "additionalProperties": { "type": "string" }
+        }
+      }
+    },
+    "authConfig": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["strategy"],
+      "properties": {
+        "strategy": { "enum": ["none", "api_key", "bearer", "basic", "oauth2"] },
+        "authModes": {
+          "type": "array",
+          "items": { "enum": ["none", "api_key", "bearer", "basic", "oauth2"] },
+          "minItems": 1
+        },
+        "credentialLabel": { "type": "string", "minLength": 1 },
+        "credentialPlaceholder": { "type": "string", "minLength": 1 },
+        "credentialHelp": { "type": "string", "minLength": 1 },
+        "credentialSecretName": { "type": "string", "minLength": 1 },
+        "saveCredentialAsSecretByDefault": { "type": "boolean" },
+        "apiKeyHeaderName": { "type": "string", "minLength": 1 },
+        "apiKeyOptional": { "type": "boolean" },
+        "oauth": { "$ref": "#/$defs/oauthConfig" }
+      }
+    },
+    "httpConfig": {
+      "type": "object",
+      "additionalProperties": false,
+      "properties": {
+        "apiBaseUrl": { "type": "string", "pattern": "^https://", "minLength": 8 },
+        "openApiUrl": { "type": "string", "pattern": "^https://", "minLength": 8 }
+      }
+    },
+    "transport": {
+      "oneOf": [
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["kind", "url"],
+          "properties": {
+            "kind": { "const": "shttp" },
+            "url": { "type": "string", "pattern": "^https://", "minLength": 8 },
+            "apiKeyOptional": { "type": "boolean" },
+            "headerFields": {
+              "type": "array",
+              "items": { "$ref": "#/$defs/marketplaceField" }
+            },
+            "urlEditable": { "type": "boolean" }
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["kind", "url"],
+          "properties": {
+            "kind": { "const": "sse" },
+            "url": { "type": "string", "pattern": "^https://", "minLength": 8 },
+            "apiKeyOptional": { "type": "boolean" },
+            "headerFields": {
+              "type": "array",
+              "items": { "$ref": "#/$defs/marketplaceField" }
+            },
+            "urlEditable": { "type": "boolean" }
+          }
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": ["kind", "serverName", "command", "args"],
+          "properties": {
+            "kind": { "const": "stdio" },
+            "serverName": { "type": "string", "minLength": 1 },
+            "command": { "type": "string", "minLength": 1 },
+            "args": {
+              "type": "array",
+              "items": { "type": "string" },
+              "minItems": 0
+            },
+            "envFields": {
+              "type": "array",
+              "items": { "$ref": "#/$defs/marketplaceField" }
+            },
+            "argFields": {
+              "type": "array",
+              "items": { "$ref": "#/$defs/marketplaceField" }
+            }
+          }
+        }
+      ]
+    },
+    "connectionOption": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": ["id", "provider", "auth"],
+      "properties": {
+        "id": { "type": "string", "minLength": 1 },
+        "provider": { "enum": ["mcp", "http"] },
+        "transport": { "$ref": "#/$defs/transport" },
+        "http": { "$ref": "#/$defs/httpConfig" },
+        "auth": { "$ref": "#/$defs/authConfig" }
+      },
+      "allOf": [
+        {
+          "if": { "properties": { "provider": { "const": "mcp" } } },
+          "then": {
+            "required": ["transport"],
+            "not": { "required": ["http"] }
+          }
+        },
+        {
+          "if": { "properties": { "provider": { "const": "http" } } },
+          "then": {
+            "required": ["http"],
+            "not": { "required": ["transport"] },
+            "properties": {
+              "http": {
+                "required": ["apiBaseUrl", "openApiUrl"],
+                "properties": {
+                  "apiBaseUrl": { "type": "string", "minLength": 8 },
+                  "openApiUrl": { "type": "string", "minLength": 8 }
+                }
+              }
+            }
+          }
+        },
+        {
+          "if": {
+            "properties": {
+              "provider": { "const": "http" },
+              "auth": { "properties": { "strategy": { "const": "api_key" } } }
+            }
+          },
+          "then": {
+            "properties": {
+              "auth": { "required": ["apiKeyHeaderName"] }
+            }
+          }
+        },
+        {
+          "if": {
+            "properties": {
+              "provider": { "const": "http" },
+              "auth": { "properties": { "strategy": { "const": "oauth2" } } }
+            }
+          },
+          "then": {
+            "properties": {
+              "auth": {
+                "required": ["oauth"],
+                "properties": {
+                  "oauth": {
+                    "required": ["authorizationUrl", "tokenUrl"],
+                    "properties": {
+                      "authorizationUrl": { "type": "string", "minLength": 8 },
+                      "tokenUrl": { "type": "string", "minLength": 8 }
+                    }
+                  }
+                }
+              }
+            }
+          }
+        }
+      ]
+    }
+  }
+}

package/integrations/index.d.ts

@@ -15,11 +15,35 @@ export type IntegrationTransport =
       kind: "shttp";
       url: string;
       apiKeyOptional?: boolean;
+      /**
+       * Named request headers the user must supply (e.g. Datadog's
+       * `DD-API-KEY` / `DD-APPLICATION-KEY`). Values are sent verbatim as
+       * headers on every MCP request. The direct analog of stdio's
+       * `envFields`: each entry renders one input in the install modal,
+       * `type: "password"` entries are secret-saved by default, and
+       * `required` entries are validated before submit. Composes with the
+       * `api_key`/`bearer`/`basic` auth strategies (whose Bearer token is
+       * folded into `Authorization` separately); a header field with
+       * `key: "Authorization"` is redundant and should be avoided.
+       */
+      headerFields?: MarketplaceField[];
+      /**
+       * When true, the install modal renders the URL as an editable input
+       * pre-filled with `url` instead of read-only. Use for servers whose
+       * host is region/account-specific (e.g. Datadog's
+       * `https://mcp.<site>.datadoghq.com/v1/mcp`); pair with the entry's
+       * `installHint` to tell users what to change.
+       */
+      urlEditable?: boolean;
     }
   | {
       kind: "sse";
       url: string;
       apiKeyOptional?: boolean;
+      /** See {@link IntegrationTransport} `shttp` `headerFields`. */
+      headerFields?: MarketplaceField[];
+      /** See {@link IntegrationTransport} `shttp` `urlEditable`. */
+      urlEditable?: boolean;
     }
   | {
       kind: "stdio";
@@ -66,18 +90,9 @@ export interface IntegrationAuthConfig {
   oauth?: IntegrationOAuthConfig;
 }
 
-export interface IntegrationHttpDefaultTool {
-  name: string;
-  description?: string;
-  method?: string;
-  path?: string;
-  scopes?: string[];
-}
-
 export interface IntegrationHttpConfig {
   apiBaseUrl?: string;
   openApiUrl?: string;
-  defaultTool?: IntegrationHttpDefaultTool;
 }
 
 export interface IntegrationConnectionOption {
@@ -88,52 +103,9 @@ export interface IntegrationConnectionOption {
   auth: IntegrationAuthConfig;
 }
 
-export interface OAuthProviderRegistrationDefaults {
-  provider?: IntegrationProvider;
-  authModes?: IntegrationAuthStrategy[];
-  authStrategy?: IntegrationAuthStrategy;
-  credentialLabel?: string;
-  credentialPlaceholder?: string;
-  credentialHelp?: string;
-  apiKeyHeaderName?: string;
-  apiBaseUrl?: string;
-  serverUrl?: string;
-  openApiUrl?: string;
-  authorizationUrl?: string;
-  tokenUrl?: string;
-  scopes?: string[];
-  optionalScopes?: string[];
-  toolScopes?: string[];
-  scopeSeparator?: "space" | "comma";
-  pkce?: boolean;
-  clientAuthentication?: "basic" | "body" | "none";
-  registrationUrl?: string;
-  additionalAuthorizationParams?: Record<string, string>;
-  additionalTokenParams?: Record<string, string>;
-  toolName?: string;
-  toolDescription?: string;
-  requestMethod?: string;
-  requestPath?: string;
-}
-
-export interface OAuthProviderCatalogOption {
-  slug: string;
-  name: string;
-  description: string;
-  categories: string[];
-  authStrategy: IntegrationAuthStrategy;
-  availability: "oauth_ready" | "manual_token" | "planned";
-  managedConnectorSlug?: string;
-  appUrl?: string;
-  docsUrl?: string;
-  notes: string;
-  popularityRank: number;
-  registrationDefaults?: OAuthProviderRegistrationDefaults;
-}
 
 export interface IntegrationCatalogEntry {
   id: string;
-  kind: IntegrationProvider;
   name: string;
   description: string;
   categories?: string[];
@@ -142,28 +114,36 @@ export interface IntegrationCatalogEntry {
   notes?: string;
   iconBg?: string;
   iconColor?: string;
+  logoUrl?: string;
   keywords?: string[];
   popularityRank?: number;
-  runtimeAvailability?: "all" | "local";
-  catalogStatus?: "oauth_ready" | "manual_token" | "planned";
-  managedConnectorSlug?: string;
-  authStrategy?: IntegrationAuthStrategy;
   installHint?: string;
-  defaultConnectionOptionId?: string;
   connectionOptions: IntegrationConnectionOption[];
-  registrationDefaults?: OAuthProviderRegistrationDefaults;
 }
 
-export const INTEGRATION_CATALOG: IntegrationCatalogEntry[];
-export function listOAuthProviderCatalog(): OAuthProviderCatalogOption[];
-export function getOAuthProviderRegistrationDefaults(
-  slug: string,
-): OAuthProviderRegistrationDefaults | undefined;
-
-export const hubspotMcpServerUrl: string;
-export const hubspotMcpAuthorizationUrl: string;
-export const hubspotMcpTokenUrl: string;
-export const hubspotRequiredScopes: readonly string[];
-export const hubspotOptionalScopes: readonly string[];
+/**
+ * Filter for {@link listIntegrationCatalog}. Each dimension is tri-state:
+ * `true` keeps only entries that support that connector type, `false` keeps
+ * only entries that do not, and `undefined` leaves that dimension unfiltered.
+ */
+export interface IntegrationCatalogFilter {
+  /** Filter on whether the entry exposes at least one `mcp` connector. */
+  mcp?: boolean;
+  /** Filter on whether the entry exposes at least one `oauth2` connector. */
+  oauth?: boolean;
+}
 
+export const INTEGRATION_CATALOG: IntegrationCatalogEntry[];
+/**
+ * Return the full integration catalog, optionally filtered by connector type.
+ * Reads the generated static import index over `integrations/catalog/<id>.json`.
+ * Returns an independent copy, matching the Python read API.
+ */
+export function listIntegrationCatalog(
+  filter?: IntegrationCatalogFilter,
+): IntegrationCatalogEntry[];
+/** Return one integration catalog entry by id as an independent copy. */
+export function getIntegrationCatalogEntry(
+  id: string,
+): IntegrationCatalogEntry | undefined;
 export default INTEGRATION_CATALOG;