Skip to main content

Documentation Index

Fetch the complete documentation index at: https://veryfront.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

veryfront/oauth

OAuth 2.0 with 37 pre-configured providers.

Import

import {
  createOAuthInitHandler,
  createOAuthCallbackHandler,
  githubConfig,
  MemoryTokenStore,
  createOAuthDisconnectHandler,
  createOAuthStatusHandler,
} from "veryfront/oauth";

Examples

// Create OAuth routes with pre-configured providers
import { createOAuthInitHandler, createOAuthCallbackHandler, gmailConfig } from "veryfront/oauth";

// app/api/auth/gmail/route.ts
export const GET = createOAuthInitHandler(gmailConfig);

// app/api/auth/gmail/callback/route.ts
export const GET = createOAuthCallbackHandler(gmailConfig);

Exports

Functions

NameDescriptionSource
createOAuthCallbackHandlerHandler for create oauth callback.source
createOAuthDisconnectHandlerHandler for create oauth disconnect.source
createOAuthInitHandlerHandler for create oauth init.source
createOAuthStatusHandlerHandler for create oauth status.source

Classes

NameDescriptionSource
MemoryTokenStoreIn-memory TokenStore keyed by (serviceId, userId).source
OAuthProviderImplement oauth provider.source
OAuthServiceImplement oauth service.source

Types

NameDescriptionSource
AuthorizationUrlOptionsOptions accepted by authorization URL.source
OAuthCallbackHandlerOptionsOptions accepted by oauth callback handler.source
OAuthInitHandlerOptionsOptions accepted by oauth init handler.source
OAuthProviderConfigConfiguration used by oauth provider.source
OAuthServiceConfigConfiguration used by oauth service.source
OAuthStateState for oauth.source
OAuthTokensPublic API contract for oauth tokens.source
TokenExchangeOptionsOptions accepted by token exchange.source
TokenExchangeResultResult returned from token exchange.source
TokenStoreTokenStore is keyed by (serviceId, userId) - tokens are per-user.source

Constants

NameDescriptionSource
airtableConfigConfiguration used by airtable.source
asanaConfigConfiguration used by asana.source
bitbucketConfigConfiguration used by bitbucket.source
boxConfigConfiguration used by box.source
calendarConfigConfiguration used by calendar.source
clickupConfigConfiguration used by clickup.source
confluenceConfigConfiguration used by confluence.source
discordConfigConfiguration used by discord.source
driveConfigConfiguration used by drive.source
dropboxConfigConfiguration used by dropbox.source
figmaConfigConfiguration used by figma.source
freshdeskConfigConfiguration used by freshdesk.source
githubConfigConfiguration used by github.source
gitlabConfigConfiguration used by gitlab.source
gmailConfigConfiguration used by gmail.source
hubspotConfigConfiguration used by hubspot.source
intercomConfigConfiguration used by intercom.source
jiraConfigConfiguration used by jira.source
linearConfigConfiguration used by linear.source
mailchimpConfigConfiguration used by mailchimp.source
mondayConfigConfiguration used by monday.source
notionConfigConfiguration used by notion.source
oneDriveConfigConfiguration used by one drive.source
outlookConfigConfiguration used by outlook.source
pipedriveConfigConfiguration used by pipedrive.source
quickbooksConfigConfiguration used by quickbooks.source
salesforceConfigConfiguration used by salesforce.source
sharePointConfigConfiguration used by share point.source
sheetsConfigConfiguration used by sheets.source
shopifyConfigConfiguration used by shopify.source
slackConfigConfiguration used by slack.source
teamsConfigConfiguration used by teams.source
trelloConfigConfiguration used by trello.source
twitterConfigConfiguration used by twitter.source
webexConfigConfiguration used by webex.source
xeroConfigConfiguration used by xero.source
zoomConfigConfiguration used by zoom.source
Reference modules: User guides:
  • oauth: OAuth flows and provider setup
Architecture: