Merge pull request #19 from vectorize-io/devin/1751035441-update-env-var-names

Author: benfrank241

docs/API.md

@@ -15,6 +15,8 @@ This document provides a comprehensive reference for all functions and classes a
  - [createWhiteLabelGDriveConnector](#createwhitelabelgdriveconnector)
  - [createVectorizeDropboxConnector](#createvectorizedropboxconnector)
  - [createWhiteLabelDropboxConnector](#createwhitelabeldropboxconnector)
+ - [createVectorizeNotionConnector](#createvectorizenotionconnector)
+ - [createWhiteLabelNotionConnector](#createwhitelabelnotionconnector)
 - [Base API Functions](#base-api-functions)
  - [createSourceConnector](#createsourceconnector)
  - [manageUser](#manageuser)
@@ -24,6 +26,9 @@ This document provides a comprehensive reference for all functions and classes a
  - [refreshGDriveToken](#refreshgdrivetoken)
  - [exchangeDropboxCodeForTokens](#exchangedropboxcodefortokens)
  - [refreshDropboxToken](#refreshdropboxtoken)
+ - [exchangeNotionCodeForTokens](#exchangenotioncodefortokens)
+ - [refreshNotionToken](#refreshnotiontoken)
+ - [manageNotionUser](#managenotionuser)
 
 ## OAuth Classes
 
@@ -351,8 +356,8 @@ async function createVectorizeGDriveConnector(
 **Parameters:**
 
 - `config`: A `VectorizeAPIConfig` object containing:
- - `authorization`: Bearer token for authentication (use VECTORIZE_TOKEN env var)
- - `organizationId`: Your Vectorize organization ID (use VECTORIZE_ORG env var)
+ - `authorization`: Bearer token for authentication (use VECTORIZE_API_KEY env var)
+ - `organizationId`: Your Vectorize organization ID (use VECTORIZE_ORGANIZATION_ID env var)
 - `connectorName`: Name for the connector
 - `platformUrl` (optional): URL of the Vectorize API (defaults to "https://api.vectorize.io/v1")
 
@@ -364,8 +369,8 @@ async function createVectorizeGDriveConnector(
 
 ```typescript
 const config = {
- authorization: process.env.VECTORIZE_TOKEN!,
- organizationId: process.env.VECTORIZE_ORG!,
+ authorization: process.env.VECTORIZE_API_KEY!,
+ organizationId: process.env.VECTORIZE_ORGANIZATION_ID!,
 };
 
 const connectorId = await createVectorizeGDriveConnector(
@@ -404,8 +409,8 @@ async function createWhiteLabelGDriveConnector(
 
 ```typescript
 const config = {
- authorization: process.env.VECTORIZE_TOKEN!,
- organizationId: process.env.VECTORIZE_ORG!,
+ authorization: process.env.VECTORIZE_API_KEY!,
+ organizationId: process.env.VECTORIZE_ORGANIZATION_ID!,
 };
 
 const connectorId = await createWhiteLabelGDriveConnector(
@@ -442,8 +447,8 @@ async function createVectorizeDropboxConnector(
 
 ```typescript
 const config = {
- authorization: process.env.VECTORIZE_TOKEN!,
- organizationId: process.env.VECTORIZE_ORG!,
+ authorization: process.env.VECTORIZE_API_KEY!,
+ organizationId: process.env.VECTORIZE_ORGANIZATION_ID!,
 };
 
 const connectorId = await createVectorizeDropboxConnector(
@@ -482,8 +487,8 @@ async function createWhiteLabelDropboxConnector(
 
 ```typescript
 const config = {
- authorization: process.env.VECTORIZE_TOKEN!,
- organizationId: process.env.VECTORIZE_ORG!,
+ authorization: process.env.VECTORIZE_API_KEY!,
+ organizationId: process.env.VECTORIZE_ORGANIZATION_ID!,
 };
 
 const connectorId = await createWhiteLabelDropboxConnector(
@@ -494,6 +499,140 @@ const connectorId = await createWhiteLabelDropboxConnector(
 );
 ```
 
+### createVectorizeNotionConnector
+
+Creates a Notion connector using Vectorize's managed OAuth credentials.
+
+```typescript
+async function createVectorizeNotionConnector(
+ config: VectorizeAPIConfig,
+ connectorName: string,
+ platformUrl?: string
+): Promise<string>
+```
+
+**Parameters:**
+
+- `config`: A `VectorizeAPIConfig` object
+- `connectorName`: Name for the connector
+- `platformUrl` (optional): URL of the Vectorize API (defaults to "https://api.vectorize.io/v1")
+
+**Returns:**
+
+- `Promise<string>`: The ID of the created connector
+
+**Example:**
+
+```typescript
+const config = {
+ authorization: process.env.VECTORIZE_API_KEY!,
+ organizationId: process.env.VECTORIZE_ORGANIZATION_ID!,
+};
+
+const connectorId = await createVectorizeNotionConnector(
+ config,
+ "My Notion Connector"
+);
+```
+
+### createWhiteLabelNotionConnector
+
+Creates a Notion connector using your own OAuth credentials.
+
+```typescript
+async function createWhiteLabelNotionConnector(
+ config: VectorizeAPIConfig,
+ connectorName: string,
+ clientId: string,
+ clientSecret: string,
+ platformUrl?: string
+): Promise<string>
+```
+
+**Parameters:**
+
+- `config`: A `VectorizeAPIConfig` object
+- `connectorName`: Name for the connector
+- `clientId`: Your Notion OAuth client ID
+- `clientSecret`: Your Notion OAuth client secret
+- `platformUrl` (optional): URL of the Vectorize API (defaults to "https://api.vectorize.io/v1")
+
+**Returns:**
+
+- `Promise<string>`: The ID of the created connector
+
+**Example:**
+
+```typescript
+const config = {
+ authorization: process.env.VECTORIZE_API_KEY!,
+ organizationId: process.env.VECTORIZE_ORGANIZATION_ID!,
+};
+
+const connectorId = await createWhiteLabelNotionConnector(
+ config,
+ "My Custom Notion Connector",
+ process.env.NOTION_CLIENT_ID!,
+ process.env.NOTION_CLIENT_SECRET!
+);
+```
+
+### manageNotionUser
+
+Manages a Notion user for a connector, allowing you to add, edit, or remove users.
+
+```typescript
+async function manageNotionUser(
+ config: VectorizeAPIConfig,
+ connectorId: string,
+ selectedPages: Record<string, { title: string; pageId: string; parentType?: string }> | null,
+ accessToken: string,
+ userId: string,
+ action: UserAction,
+ platformUrl?: string
+): Promise<Response>
+```
+
+**Parameters:**
+
+- `config`: A `VectorizeAPIConfig` object
+- `connectorId`: ID of the connector
+- `selectedPages`: Record of selected pages with their metadata (required for add/edit actions)
+- `accessToken`: Notion OAuth access token (required for add/edit actions)
+- `userId`: User ID to manage
+- `action`: Action to perform ("add", "edit", or "remove")
+- `platformUrl` (optional): URL of the Vectorize API (defaults to "https://api.vectorize.io/v1")
+
+**Returns:**
+
+- `Promise<Response>`: The API response
+
+**Example:**
+
+```typescript
+const config = {
+ authorization: process.env.VECTORIZE_API_KEY!,
+ organizationId: process.env.VECTORIZE_ORGANIZATION_ID!,
+};
+
+const selectedPages = {
+ "page1": {
+ title: "My Page",
+ pageId: "page1",
+ parentType: "workspace"
+ }
+};
+
+const response = await manageNotionUser(
+ config,
+ "connector123",
+ selectedPages,
+ "notion_access_token",
+ "user123",
+ "add"
+);
+```
+
 ## Base API Functions
 
 ### createSourceConnector
@@ -653,6 +792,67 @@ console.log('New access token:', tokens.access_token);
 console.log('Expires in:', tokens.expires_in, 'seconds');
 ```
 
+### exchangeNotionCodeForTokens
+
+Exchanges an authorization code for Notion OAuth tokens.
+
+```typescript
+async function exchangeNotionCodeForTokens(
+ code: string,
+ clientId: string,
+ clientSecret: string,
+ redirectUri: string
+): Promise<any>
+```
+
+**Parameters:**
+
+- `code`: Authorization code from Notion OAuth flow
+- `clientId`: Notion OAuth client ID
+- `clientSecret`: Notion OAuth client secret
+- `redirectUri`: Redirect URI used in the OAuth flow
+
+**Returns:**
+
+- `Promise<any>`: Notion OAuth tokens
+
+**Example:**
+
+```typescript
+import { exchangeNotionCodeForTokens } from '@vectorize-io/vectorize-connect';
+
+const tokens = await exchangeNotionCodeForTokens(
+ authCode,
+ process.env.NOTION_CLIENT_ID!,
+ process.env.NOTION_CLIENT_SECRET!,
+ "https://yourapp.com/callback"
+);
+```
+
+### refreshNotionToken
+
+Validates an existing Notion access token by making an API request to Notion.
+
+```typescript
+async function refreshNotionToken(accessToken: string): Promise<any>
+```
+
+**Parameters:**
+
+- `accessToken`: Notion access token to validate
+
+**Returns:**
+
+- `Promise<any>`: Validated token information
+
+**Example:**
+
+```typescript
+import { refreshNotionToken } from '@vectorize-io/vectorize-connect';
+
+const validatedToken = await refreshNotionToken("notion_access_token");
+```
+
 ### exchangeDropboxCodeForTokens
 
 Exchanges an authorization code for access and refresh tokens.

docs/authentication/README.md

@@ -0,0 +1,68 @@
+# Authentication
+
+This section covers authentication flows for different connector approaches.
+
+## Approaches
+
+- **[Vectorize](./vectorize/)** - Authentication using Vectorize's managed OAuth flow
+- **[White-Label](./white-label/)** - Authentication using your own OAuth applications
+
+## Overview
+
+Authentication is the process of connecting users to their cloud storage accounts and obtaining the necessary permissions to access their files.
+
+### Vectorize Approach
+- Users are redirected to Vectorize's platform for authentication
+- Vectorize handles the OAuth flow and token management
+- Simplified implementation with consistent user experience
+
+### White-Label Approach
+- Users authenticate directly with your OAuth application
+- Full control over the authentication experience
+- Requires implementing OAuth callback handling
+
+## Platform-Specific Guides
+
+### Vectorize Approach
+- [Google Drive Authentication](./vectorize/google-drive.md)
+- [Dropbox Authentication](./vectorize/dropbox.md)
+- [Notion Authentication](./vectorize/notion.md)
+
+### White-Label Approach
+- [Google Drive Authentication](./white-label/google-drive.md)
+- [Dropbox Authentication](./white-label/dropbox.md)
+- [Notion Authentication](./white-label/notion.md)
+
+## Quick Reference
+
+### Vectorize Authentication Flow
+```typescript
+import { getOneTimeConnectorToken, GoogleDriveOAuth } from '@vectorize-io/vectorize-connect';
+
+// 1. Generate one-time token
+const tokenResponse = await getOneTimeConnectorToken(config, userId, connectorId);
+
+// 2. Redirect to Vectorize authentication (example with Google Drive)
+await GoogleDriveOAuth.redirectToVectorizeConnect(
+ tokenResponse.token,
+ organizationId
+);
+```
+
+### White-Label Authentication Flow
+```typescript
+import { GoogleDriveOAuth } from '@vectorize-io/vectorize-connect';
+
+// Start OAuth flow in popup (example with Google Drive)
+GoogleDriveOAuth.startOAuth({
+ clientId: process.env.GOOGLE_OAUTH_CLIENT_ID!,
+ clientSecret: process.env.GOOGLE_OAUTH_CLIENT_SECRET!,
+ redirectUri: `${window.location.origin}/api/oauth/callback`,
+ onSuccess: (response) => {
+ // Handle successful authentication
+ },
+ onError: (error) => {
+ // Handle authentication error
+ }
+});
+```