@hasna/connectors 0.7.2 → 0.8.0

package/connectors/connect-accuranker/src/types/index.ts

@@ -0,0 +1,342 @@
+// AccuRanker API Types
+
+// ============================================
+// Configuration
+// ============================================
+
+export interface ConnectorConfig {
+  apiKey?: string;
+  token?: string;
+  apiSecret?: string;
+  accessToken?: string;
+  baseUrl?: string;
+}
+
+// ============================================
+// OAuth2 Types
+// ============================================
+
+export interface OAuth2Config {
+  clientId: string;
+  clientSecret: string;
+  redirectUri?: string;
+}
+
+export interface OAuth2Tokens {
+  accessToken: string;
+  refreshToken?: string;
+  expiresAt: number;
+  tokenType?: string;
+  scope?: string;
+}
+
+// ============================================
+// Common Types
+// ============================================
+
+export type OutputFormat = 'json' | 'pretty';
+
+export interface ListParams {
+  limit?: number;
+  offset?: number;
+  fields?: string;
+}
+
+// ============================================
+// Account Types
+// ============================================
+
+export interface Account {
+  id: number;
+  name: string;
+  [key: string]: unknown;
+}
+
+// ============================================
+// Domain Types
+// ============================================
+
+export interface Domain {
+  id: number;
+  domain: string;
+  display_name?: string;
+  include_subdomains?: boolean;
+  exact_match?: boolean;
+  share_of_voice_percentage?: boolean;
+  [key: string]: unknown;
+}
+
+export interface DomainCreateParams {
+  domain: string;
+  group_id: number;
+  display_name?: string;
+  include_subdomains?: boolean;
+  exact_match?: boolean;
+  share_of_voice_percentage?: boolean;
+  default_searchsettings_names?: SearchSettings[];
+}
+
+export interface DomainUpdateParams {
+  display_name?: string;
+  include_subdomains?: boolean;
+  exact_match?: boolean;
+  share_of_voice_percentage?: boolean;
+}
+
+export interface SearchSettings {
+  countrylocale: string;
+  search_engine_names: string[];
+  search_type_names: string[];
+  locations?: string[];
+  ignore_local_results?: boolean;
+  ignore_featured_snippet?: boolean;
+  enable_autocorrect?: boolean;
+  primary?: boolean;
+}
+
+// ============================================
+// Keyword Types
+// ============================================
+
+export interface Keyword {
+  id: number;
+  keyword: string;
+  search_type?: string;
+  starred?: boolean;
+  description?: string;
+  tags?: string[];
+  ranks?: KeywordRank;
+  [key: string]: unknown;
+}
+
+export interface KeywordRank {
+  rank?: number;
+  rank_change?: number;
+  search_volume?: number;
+  cpc?: number;
+  url?: string;
+  share_of_voice?: number;
+  ctr?: number;
+  serp_features?: string[];
+  search_intent?: string;
+  [key: string]: unknown;
+}
+
+export interface KeywordCreateParams {
+  domain_id: number;
+  keywords: string[];
+  tags?: string[];
+  starred?: boolean;
+  ignore_local_results?: boolean;
+  ignore_featured_snippet?: boolean;
+  ignore_in_share_of_voice?: boolean;
+  enable_autocorrect?: boolean;
+  description?: string;
+}
+
+export interface KeywordUpdateParams {
+  keyword_ids: number[];
+  starred?: boolean;
+  tags?: string[];
+  description?: string;
+}
+
+export interface KeywordDeleteParams {
+  keyword_ids: number[];
+}
+
+// ============================================
+// Landing Page Types
+// ============================================
+
+export interface LandingPage {
+  id: number;
+  path: string;
+  [key: string]: unknown;
+}
+
+// ============================================
+// Tag Types
+// ============================================
+
+export interface Tag {
+  id: number;
+  tag: string;
+  [key: string]: unknown;
+}
+
+// ============================================
+// Group Types
+// ============================================
+
+export interface Group {
+  id: number;
+  name: string;
+  [key: string]: unknown;
+}
+
+export interface GroupCreateParams {
+  account_id: number;
+  name: string;
+}
+
+// ============================================
+// Brand Types
+// ============================================
+
+export interface Brand {
+  id: number;
+  [key: string]: unknown;
+}
+
+export interface BrandPrompt {
+  id: number;
+  [key: string]: unknown;
+}
+
+// ============================================
+// Job Types
+// ============================================
+
+export interface KeywordJob {
+  status: string;
+  [key: string]: unknown;
+}
+
+// ============================================
+// API Error Types
+// ============================================
+
+export interface ApiErrorDetail {
+  code: string;
+  message: string;
+  field?: string;
+  resource?: string;
+}
+
+export class ConnectorApiError extends Error {
+  public readonly statusCode: number;
+  public readonly errors?: ApiErrorDetail[];
+  public readonly documentationUrl?: string;
+  public readonly requestId?: string;
+
+  constructor(
+    message: string,
+    statusCode: number,
+    options?: {
+      errors?: ApiErrorDetail[];
+      documentationUrl?: string;
+      requestId?: string;
+    }
+  ) {
+    super(message);
+    this.name = 'ConnectorApiError';
+    this.statusCode = statusCode;
+    this.errors = options?.errors;
+    this.documentationUrl = options?.documentationUrl;
+    this.requestId = options?.requestId;
+  }
+
+  isRateLimited(): boolean {
+    return this.statusCode === 429;
+  }
+
+  isServerError(): boolean {
+    return this.statusCode >= 500 && this.statusCode < 600;
+  }
+
+  isClientError(): boolean {
+    return this.statusCode >= 400 && this.statusCode < 500;
+  }
+
+  isAuthError(): boolean {
+    return this.statusCode === 401 || this.statusCode === 403;
+  }
+
+  isNotFound(): boolean {
+    return this.statusCode === 404;
+  }
+
+  getUserMessage(): string {
+    switch (this.statusCode) {
+      case 400:
+        return 'Bad request. Please check your input.';
+      case 401:
+        return 'Authentication failed. Please check your API token.';
+      case 403:
+        return 'Access denied. You do not have permission to perform this action.';
+      case 404:
+        return 'Resource not found.';
+      case 429:
+        return 'Rate limit exceeded. Please wait and try again.';
+      case 500:
+        return 'Server error. Please try again later.';
+      case 502:
+      case 503:
+      case 504:
+        return 'Service temporarily unavailable. Please try again later.';
+      default:
+        return this.message;
+    }
+  }
+
+  toJSON(): Record<string, unknown> {
+    return {
+      name: this.name,
+      message: this.message,
+      statusCode: this.statusCode,
+      errors: this.errors,
+      documentationUrl: this.documentationUrl,
+      requestId: this.requestId,
+    };
+  }
+}
+
+export function parseApiError(
+  response: unknown,
+  statusCode: number
+): ConnectorApiError {
+  if (typeof response === 'string') {
+    return new ConnectorApiError(response, statusCode);
+  }
+
+  if (!response || typeof response !== 'object') {
+    return new ConnectorApiError(`HTTP ${statusCode} Error`, statusCode);
+  }
+
+  const data = response as Record<string, unknown>;
+
+  const message =
+    (data.message as string) ||
+    (data.error as string) ||
+    ((data.error as Record<string, unknown>)?.message as string) ||
+    (data.error_description as string) ||
+    (data.detail as string) ||
+    `HTTP ${statusCode} Error`;
+
+  let errors: ApiErrorDetail[] | undefined;
+  if (Array.isArray(data.errors)) {
+    errors = data.errors.map((e: Record<string, unknown>) => ({
+      code: String(e.code || e.error || 'unknown'),
+      message: String(e.message || e.description || 'Unknown error'),
+      field: e.field as string,
+      resource: e.resource as string,
+    }));
+  }
+
+  const documentationUrl =
+    (data.documentation_url as string) ||
+    (data.docs_url as string) ||
+    (data.help_url as string);
+
+  const requestId =
+    (data.request_id as string) ||
+    (data.requestId as string) ||
+    (data.trace_id as string);
+
+  return new ConnectorApiError(message, statusCode, {
+    errors,
+    documentationUrl,
+    requestId,
+  });
+}

package/connectors/connect-accuranker/src/utils/auth.ts

@@ -0,0 +1,274 @@
+import { createServer } from 'http';
+import type { OAuth2Tokens, OAuth2Config } from '../types';
+import { saveOAuthTokens, loadOAuthTokens, getOAuthConfig } from './config';
+
+// ============================================
+// OAuth2 Authentication Utility
+// ============================================
+
+// TODO: Replace with your OAuth provider's endpoints
+const DEFAULT_AUTH_URL = 'https://accounts.example.com/oauth2/authorize';
+const DEFAULT_TOKEN_URL = 'https://accounts.example.com/oauth2/token';
+
+// TODO: Define your OAuth scopes
+const DEFAULT_SCOPES = ['read', 'write'].join(' ');
+
+const REDIRECT_PORT = 8089;
+const REDIRECT_URI = `http://localhost:${REDIRECT_PORT}/callback`;
+
+export interface AuthResult {
+  success: boolean;
+  tokens?: OAuth2Tokens;
+  error?: string;
+}
+
+export interface AuthUrlOptions {
+  authUrl?: string;
+  scopes?: string;
+  state?: string;
+  extraParams?: Record<string, string>;
+}
+
+/**
+ * Generate the OAuth2 authorization URL
+ */
+export function getAuthUrl(options: AuthUrlOptions = {}): string {
+  const config = getOAuthConfig();
+  if (!config?.clientId) {
+    throw new Error('OAuth client ID not configured. Run "config set-credentials" first.');
+  }
+
+  const authUrl = options.authUrl || DEFAULT_AUTH_URL;
+  const scopes = options.scopes || DEFAULT_SCOPES;
+
+  const params = new URLSearchParams({
+    client_id: config.clientId,
+    redirect_uri: REDIRECT_URI,
+    response_type: 'code',
+    scope: scopes,
+    access_type: 'offline',
+    prompt: 'consent', // Force consent to get refresh token
+    ...(options.state && { state: options.state }),
+    ...options.extraParams,
+  });
+
+  return `${authUrl}?${params.toString()}`;
+}
+
+/**
+ * Exchange authorization code for tokens
+ */
+export async function exchangeCodeForTokens(
+  code: string,
+  tokenUrl: string = DEFAULT_TOKEN_URL
+): Promise<OAuth2Tokens> {
+  const config = getOAuthConfig();
+
+  if (!config?.clientId || !config?.clientSecret) {
+    throw new Error('OAuth credentials not configured');
+  }
+
+  const response = await fetch(tokenUrl, {
+    method: 'POST',
+    headers: {
+      'Content-Type': 'application/x-www-form-urlencoded',
+    },
+    body: new URLSearchParams({
+      code,
+      client_id: config.clientId,
+      client_secret: config.clientSecret,
+      redirect_uri: REDIRECT_URI,
+      grant_type: 'authorization_code',
+    }),
+  });
+
+  if (!response.ok) {
+    const error = await response.json().catch(() => ({ error: response.statusText }));
+    throw new Error(`Token exchange failed: ${error.error_description || error.error}`);
+  }
+
+  const data = await response.json();
+
+  const tokens: OAuth2Tokens = {
+    accessToken: data.access_token,
+    refreshToken: data.refresh_token,
+    expiresAt: Date.now() + data.expires_in * 1000,
+    tokenType: data.token_type,
+    scope: data.scope,
+  };
+
+  return tokens;
+}
+
+/**
+ * Refresh the access token using the refresh token
+ */
+export async function refreshAccessToken(
+  tokenUrl: string = DEFAULT_TOKEN_URL
+): Promise<OAuth2Tokens> {
+  const config = getOAuthConfig();
+  const currentTokens = loadOAuthTokens();
+
+  if (!config?.clientId || !config?.clientSecret) {
+    throw new Error('OAuth credentials not configured');
+  }
+
+  if (!currentTokens?.refreshToken) {
+    throw new Error('No refresh token available. Please login again.');
+  }
+
+  const response = await fetch(tokenUrl, {
+    method: 'POST',
+    headers: {
+      'Content-Type': 'application/x-www-form-urlencoded',
+    },
+    body: new URLSearchParams({
+      client_id: config.clientId,
+      client_secret: config.clientSecret,
+      refresh_token: currentTokens.refreshToken,
+      grant_type: 'refresh_token',
+    }),
+  });
+
+  if (!response.ok) {
+    const error = await response.json().catch(() => ({ error: response.statusText }));
+    throw new Error(`Token refresh failed: ${error.error_description || error.error}`);
+  }
+
+  const data = await response.json();
+
+  const tokens: OAuth2Tokens = {
+    accessToken: data.access_token,
+    refreshToken: data.refresh_token || currentTokens.refreshToken, // Keep original if not returned
+    expiresAt: Date.now() + data.expires_in * 1000,
+    tokenType: data.token_type,
+    scope: data.scope || currentTokens.scope,
+  };
+
+  saveOAuthTokens(tokens);
+  return tokens;
+}
+
+/**
+ * Start a local HTTP server to receive the OAuth callback
+ */
+export function startCallbackServer(): Promise<AuthResult> {
+  return new Promise((resolve) => {
+    const server = createServer(async (req, res) => {
+      const url = new URL(req.url || '', `http://localhost:${REDIRECT_PORT}`);
+
+      if (url.pathname === '/callback') {
+        const code = url.searchParams.get('code');
+        const error = url.searchParams.get('error');
+
+        if (error) {
+          res.writeHead(200, { 'Content-Type': 'text/html' });
+          res.end(`
+            <html>
+              <body style="font-family: sans-serif; display: flex; justify-content: center; align-items: center; height: 100vh; margin: 0;">
+                <div style="text-align: center;">
+                  <h1 style="color: #dc3545;">Authentication Failed</h1>
+                  <p>Error: ${error}</p>
+                  <p>You can close this window.</p>
+                </div>
+              </body>
+            </html>
+          `);
+          server.close();
+          resolve({ success: false, error });
+          return;
+        }
+
+        if (code) {
+          try {
+            const tokens = await exchangeCodeForTokens(code);
+            res.writeHead(200, { 'Content-Type': 'text/html' });
+            res.end(`
+              <html>
+                <body style="font-family: sans-serif; display: flex; justify-content: center; align-items: center; height: 100vh; margin: 0;">
+                  <div style="text-align: center;">
+                    <h1 style="color: #28a745;">Authentication Successful!</h1>
+                    <p>You can close this window and return to the terminal.</p>
+                  </div>
+                </body>
+              </html>
+            `);
+            server.close();
+            resolve({ success: true, tokens });
+          } catch (err) {
+            res.writeHead(200, { 'Content-Type': 'text/html' });
+            res.end(`
+              <html>
+                <body style="font-family: sans-serif; display: flex; justify-content: center; align-items: center; height: 100vh; margin: 0;">
+                  <div style="text-align: center;">
+                    <h1 style="color: #dc3545;">Authentication Failed</h1>
+                    <p>Error: ${String(err)}</p>
+                    <p>You can close this window.</p>
+                  </div>
+                </body>
+              </html>
+            `);
+            server.close();
+            resolve({ success: false, error: String(err) });
+          }
+        }
+      }
+    });
+
+    server.listen(REDIRECT_PORT, () => {
+      // Server is ready
+    });
+
+    // Timeout after 5 minutes
+    setTimeout(() => {
+      server.close();
+      resolve({ success: false, error: 'Authentication timed out' });
+    }, 5 * 60 * 1000);
+  });
+}
+
+/**
+ * Get a valid access token, refreshing if necessary
+ * @param tokenUrl - Token endpoint URL for refresh
+ * @param bufferMs - Refresh buffer in ms (default: 5 minutes)
+ */
+export async function getValidAccessToken(
+  tokenUrl: string = DEFAULT_TOKEN_URL,
+  bufferMs: number = 5 * 60 * 1000
+): Promise<string> {
+  const tokens = loadOAuthTokens();
+
+  if (!tokens) {
+    throw new Error('Not authenticated. Run "auth login" first.');
+  }
+
+  // Check if token is expired or will expire within buffer time
+  if (Date.now() >= tokens.expiresAt - bufferMs) {
+    const newTokens = await refreshAccessToken(tokenUrl);
+    return newTokens.accessToken;
+  }
+
+  return tokens.accessToken;
+}
+
+/**
+ * Check if the user is authenticated
+ */
+export function isAuthenticated(): boolean {
+  const tokens = loadOAuthTokens();
+  return !!tokens?.accessToken;
+}
+
+/**
+ * Get the redirect URI for OAuth configuration
+ */
+export function getRedirectUri(): string {
+  return REDIRECT_URI;
+}
+
+/**
+ * Get the redirect port for OAuth callback
+ */
+export function getRedirectPort(): number {
+  return REDIRECT_PORT;
+}