Skip to main content

​
veryfront/integrations

Integration metadata and SVG icons for all connectors.

​
Import

import {
  executeRemoteIntegrationTool,
  getConnector,
  getConnectorNames,
  getIcon,
  getRemoteIntegrationToolDefinitions,
  isRemoteIntegrationTool,
} from "veryfront/integrations";

​
Examples

import { listConnectors, getIcon } from "veryfront/integrations";

const connectors = listConnectors();
const slackIcon = getIcon("slack"); // raw SVG string

​
Exports

​
Components

NameDescription
EnvVarSchemaValidates environment variable configuration metadata
IntegrationConfigSchemaValidates complete integration connector configuration spec
IntegrationNameSchemaValidates integration name against allowed enum values
IntegrationPromptSchemaValidates predefined prompt configuration for integrations
IntegrationToolSchemaValidates tool definition from connector specification
OAuthConfigSchemaValidates OAuth/API key authentication configuration
OAuthFieldSchemaValidates OAuth form field configuration and mapping

​
Functions

NameDescription
executeRemoteIntegrationToolExecute a remote integration tool via the API.
getConnectorLook up connector config by name from registry
getConnectorNamesReturn readonly array of all connector names
getIconReturn SVG icon string for integration by name
getRemoteIntegrationToolDefinitionsFetch integration tool definitions for the current request context.
isRemoteIntegrationToolCheck if a tool name looks like a remote integration tool.
listConnectorsReturn readonly array of all connectors
syncIntegrationConfigSync integration config from veryfront.config.ts to the API.

​
Types

NameDescription
EnvVarConfigEnvironment variable requirement with metadata
IntegrationConfigComplete connector spec: name, auth, tools, prompts
IntegrationConnectorRuntime connector with tools and endpoint definitions
IntegrationNameUnion type of valid integration name literals
IntegrationPromptPredefined prompt template for integration use
IntegrationRuntimeConfigPer-user settings and tool allowlist for integration
IntegrationScope
IntegrationToolIntegration tool with endpoint execution spec
IntegrationToolMetaTool metadata: name, description, write requirements
OAuthConfigOAuth/API key authentication type and parameters
OAuthFieldForm field for OAuth configuration with mapping