veryfront/integrations

Import

import {
  createIntegrationClient,
  createLocalIntegrationToolSource,
  createSalesforceServiceAccountToolSource,
  executeRemoteIntegrationTool,
  getConnector,
  getConnectorNames,
} from "veryfront/integrations";

Examples

import {
  createSalesforceServiceAccountToolSource,
  getConnector,
  getIcon,
  getRemoteIntegrationToolDefinitions,
  getRemoteIntegrationToolDiscovery,
  listConnectors,
} from "veryfront/integrations";

const connectors = listConnectors();
const slack = getConnector("slack");
const slackIcon = getIcon("slack"); // raw SVG string
const discovery = await getRemoteIntegrationToolDiscovery();
const runtimeTools = await getRemoteIntegrationToolDefinitions();

Exports

Components

Name	Description	Source
`EnvVarSchema`	Zod schema for env var.	source
`IntegrationConfigSchema`	Zod schema for integration config.	source
`IntegrationEndpointHistoricalSummarySchema`		source
`IntegrationNameSchema`	Zod schema for integration name.	source
`IntegrationPromptSchema`	Zod schema for integration prompt.	source
`IntegrationToolSchema`	Zod schema for integration tool.	source
`OAuthConfigSchema`	Zod schema for oauth config.	source
`OAuthFieldSchema`	Zod schema for oauth field.	source
`SALESFORCE_SERVICE_ACCOUNT_ENV_VARS`	Project environment variables required by the local Salesforce service-account source.	source

Functions

Name	Description	Source
`createIntegrationClient`	Bind explicit API credentials and an authorized project for catalog, status and tool calls. Requires the API expected-project precondition and effective-project response header contract. This client does not infer consent completion or executable readiness from connected status.	source
`createLocalIntegrationToolSource`	Create an explicitly granted, catalog-backed local integration tool source.	source
`createSalesforceServiceAccountToolSource`	Create a local Salesforce service-account tool source.	source
`executeRemoteIntegrationTool`	Execute a remote integration tool via the API. Called by the agent runtime when a tool isn’t found in the local registry. The request, response, and caller-supplied cancellation signal remain bounded for the complete network and response-body lifecycle.	source
`getConnector`	Return connector.	source
`getConnectorNames`	Return connector names.	source
`getIcon`	Return icon.	source
`getRemoteIntegrationToolDefinitions`	Fetch integration tool definitions for the current request context.	source
`getRemoteIntegrationToolDiscovery`	Discover integration tools for the current request context.	source
`isRemoteIntegrationTool`	Check if a tool name looks like a remote integration tool. Integration tools use “integration__tool_id” format (double underscore separator).	source
`listConnectors`	List connectors.	source

Classes

Name	Description	Source
`IntegrationApiError`	A bounded API failure. Call failures never authorize automatic replay.	source

Types

Name	Description	Source
`EnvVarConfig`	Configuration used by env var.	source
`IntegrationCallOptions`	Selection metadata for a tool call, separate from native provider arguments. The API must advertise generation-precondition support. Unsupported deployments throw `IntegrationApiError` with kind `unsupported_precondition` and `outcomeUnknown: false` before dispatch. Missing confirmation after a successful call response reports the same kind with `outcomeUnknown: true`. Calls never authorize automatic replay. Omitting the generation retains existing call behavior.	source
`IntegrationCallOutcome`	The native envelope is retained for both successful execution and tool failure.	source
`IntegrationCatalogEntry`	Integration catalog summary; additional native metadata is retained.	source
`IntegrationClient`	Project-bound primitives. Iterators use a bounded deadline and fail rather than silently truncate.	source
`IntegrationClientConnection`	A visible connection row, not an assertion of provider permission or tool readiness.	source
`IntegrationClientContext`	Explicit caller-owned context. Credentials are never inferred from runtime globals.	source
`IntegrationClientTool`	Authored tool schema and native discovery metadata.	source
`IntegrationConfig`	Configuration used by integration.	source
`IntegrationConnectionStatus`	The OAuth status response, with the requested scope recorded by the client.	source
`IntegrationConnectionWaitOptions`	Bounded wait for consent completion. Read `status()` before starting consent and pass it as `before`, so the unchanged prior connection is never mistaken for the new one. The baseline must include the same scope, as recorded by `status()`.	source
`IntegrationConnectionWaitOutcome`	`connection_observed` requires a connected status whose connection id and generation differ from `before` and match a connected row of the requested scope. It confirms the stored connection, not provider permission or tool readiness.	source
`IntegrationConnectOptions`	Connect options. Scope defaults to personal user ownership, never silently project scope.	source
`IntegrationConnector`	Public API contract for integration connector.	source
`IntegrationConnectOutcome`	Catalog setup facts do not establish effective project credentials or tool readiness.	source
`IntegrationDetails`	Connector setup requirements and native catalog details.	source
`IntegrationEndpointHistoricalSummary`	Provider-declared summary contract for old tool outputs kept actionable across turns.	source
`IntegrationFailureCondition`	Safe condition metadata supplied by the integration API.	source
`IntegrationHttpProblem`	Validated HTTP Problem identity without an assertion about server retryability.	source
`IntegrationJsonObject`	Data-only JSON retained without renaming provider fields. Response byte limits follow the endpoint transport budget; authored arguments retain stricter generic limits.	source
`IntegrationName`	Public API contract for integration name.	source
`IntegrationOAuthHandoff`	One-time browser handoff. connect_url is accessible but excluded from default serialization.	source
`IntegrationPrompt`	Public API contract for integration prompt.	source
`IntegrationSelectedReadiness`	Metadata-only selected-tool evidence. Provider authorization is never implied.	source
`IntegrationSelectionOptions`	Select a saved connection and optionally pin its observed generation.	source
`IntegrationTool`	Public API contract for integration tool.	source
`IntegrationToolMeta`	Public API contract for integration tool meta.	source
`IntegrationToolResult`	Native tool envelope, including multimedia, resources and extension metadata.	source
`LocalIntegrationCredentialProvider`	Resolve one local integration credential by its canonical environment-variable name.	source
`LocalIntegrationToolSourceOptions`	Options for a catalog-backed local integration tool source.	source
`OAuthConfig`	Configuration used by oauth.	source
`OAuthField`	Public API contract for oauth field.	source
`RemoteIntegrationToolDiscoveryResult`	Result of listing the integration tools available to the current run.	source
`SalesforceServiceAccountToolSourceOptions`	Options for the local Salesforce service-account source.	source

Getting Started

Concepts

Guides

API Reference

veryfront/integrations

Import

Examples

Exports

Components

Functions

Classes

Types

​Import

​Examples

​Exports

​Components

​Functions

​Classes

​Types

Import

Examples

Exports

Components

Functions

Classes

Types