@hasna/microservices 0.0.5 → 0.0.7

package/microservices/microservice-domains/src/lib/brandsight.ts

@@ -0,0 +1,350 @@
+/**
+ * Brandsight API integration for brand monitoring and threat detection
+ *
+ * Uses the Connector SDK pattern. When a connect-brandsight package
+ * is published, replace the inline connector with the package import.
+ *
+ * Requires environment variable:
+ *   BRANDSIGHT_API_KEY — API key for Brandsight
+ */
+
+// ============================================================
+// Types
+// ============================================================
+
+export interface BrandsightConfig {
+  apiKey: string;
+  baseUrl?: string;
+}
+
+export interface BrandsightAlert {
+  domain: string;
+  type: "typosquat" | "homoglyph" | "keyword" | "tld_variation";
+  registered_at: string;
+}
+
+export interface BrandMonitorResult {
+  brand: string;
+  alerts: BrandsightAlert[];
+  stub: boolean;
+}
+
+export interface WhoisHistoryEntry {
+  registrant: string;
+  date: string;
+  changes: string[];
+}
+
+export interface WhoisHistoryResult {
+  domain: string;
+  history: WhoisHistoryEntry[];
+  stub: boolean;
+}
+
+export interface ThreatAssessment {
+  domain: string;
+  risk_level: "low" | "medium" | "high" | "critical";
+  threats: string[];
+  recommendation: string;
+  stub: boolean;
+}
+
+export class BrandsightApiError extends Error {
+  constructor(
+    message: string,
+    public statusCode?: number,
+    public responseBody?: string
+  ) {
+    super(message);
+    this.name = "BrandsightApiError";
+  }
+}
+
+// ============================================================
+// Brandsight Connector Client (inline SDK pattern)
+// ============================================================
+
+class BrandsightClient {
+  private readonly apiKey: string;
+  private readonly baseUrl: string;
+  private fetchFn: typeof globalThis.fetch;
+
+  constructor(config: BrandsightConfig, fetchFn?: typeof globalThis.fetch) {
+    this.apiKey = config.apiKey;
+    this.baseUrl = config.baseUrl || "https://api.brandsight.com/v1";
+    this.fetchFn = fetchFn || globalThis.fetch;
+  }
+
+  setFetch(fn: typeof globalThis.fetch): void {
+    this.fetchFn = fn;
+  }
+
+  async get<T>(path: string): Promise<{ data: T; stub: false } | { data: null; stub: true }> {
+    const url = `${this.baseUrl}${path}`;
+    const headers: Record<string, string> = {
+      Authorization: `Bearer ${this.apiKey}`,
+      "Content-Type": "application/json",
+      Accept: "application/json",
+      "User-Agent": "microservice-domains/0.0.1",
+    };
+
+    try {
+      const response = await this.fetchFn(url, {
+        method: "GET",
+        headers,
+        signal: AbortSignal.timeout(15000),
+      });
+
+      if (!response.ok) {
+        throw new BrandsightApiError(
+          `Brandsight API GET ${path} failed with status ${response.status}`,
+          response.status,
+          await response.text()
+        );
+      }
+
+      const data = (await response.json()) as T;
+      return { data, stub: false };
+    } catch (error) {
+      if (error instanceof BrandsightApiError) throw error;
+      // API unreachable — return stub indicator
+      return { data: null, stub: true };
+    }
+  }
+}
+
+// ============================================================
+// Brandsight Connector (SDK pattern)
+// ============================================================
+
+class BrandsightConnector {
+  private readonly client: BrandsightClient;
+
+  constructor(config: BrandsightConfig, fetchFn?: typeof globalThis.fetch) {
+    this.client = new BrandsightClient(config, fetchFn);
+  }
+
+  static fromEnv(fetchFn?: typeof globalThis.fetch): BrandsightConnector {
+    const apiKey = process.env["BRANDSIGHT_API_KEY"];
+    if (!apiKey) {
+      throw new BrandsightApiError(
+        "BRANDSIGHT_API_KEY environment variable is not set"
+      );
+    }
+    return new BrandsightConnector({ apiKey }, fetchFn);
+  }
+
+  setFetch(fn: typeof globalThis.fetch): void {
+    this.client.setFetch(fn);
+  }
+
+  async monitorBrand(brandName: string): Promise<{ alerts: BrandsightAlert[] } | null> {
+    const result = await this.client.get<{ alerts: BrandsightAlert[] }>(
+      `/brands/${encodeURIComponent(brandName)}/monitor`
+    );
+    return result.stub ? null : result.data;
+  }
+
+  async getSimilarDomains(domain: string): Promise<{ similar: string[] } | null> {
+    const result = await this.client.get<{ similar: string[] }>(
+      `/domains/${encodeURIComponent(domain)}/similar`
+    );
+    return result.stub ? null : result.data;
+  }
+
+  async getWhoisHistory(domain: string): Promise<{ history: WhoisHistoryEntry[] } | null> {
+    const result = await this.client.get<{ history: WhoisHistoryEntry[] }>(
+      `/domains/${encodeURIComponent(domain)}/whois-history`
+    );
+    return result.stub ? null : result.data;
+  }
+
+  async getThreatAssessment(domain: string): Promise<Omit<ThreatAssessment, "stub"> | null> {
+    const result = await this.client.get<Omit<ThreatAssessment, "stub">>(
+      `/domains/${encodeURIComponent(domain)}/threats`
+    );
+    return result.stub ? null : result.data;
+  }
+}
+
+// ============================================================
+// Module-level state (for test injection)
+// ============================================================
+
+type FetchFn = typeof globalThis.fetch;
+
+let _fetchFn: FetchFn | null = null;
+
+/**
+ * Override the fetch implementation (for testing).
+ * Pass `null` to restore the default.
+ */
+export function _setFetch(fn: FetchFn | null): void {
+  _fetchFn = fn;
+}
+
+export function getApiKey(): string {
+  const key = process.env["BRANDSIGHT_API_KEY"];
+  if (!key) {
+    throw new BrandsightApiError(
+      "BRANDSIGHT_API_KEY environment variable is not set"
+    );
+  }
+  return key;
+}
+
+function createConnector(): BrandsightConnector {
+  const connector = BrandsightConnector.fromEnv(_fetchFn || undefined);
+  return connector;
+}
+
+// ============================================================
+// Stub Data Generators
+// ============================================================
+
+function generateStubAlerts(brandName: string): BrandsightAlert[] {
+  const now = new Date().toISOString();
+  return [
+    {
+      domain: `${brandName}-deals.com`,
+      type: "keyword",
+      registered_at: now,
+    },
+    {
+      domain: `${brandName.replace(/a/gi, "4").replace(/e/gi, "3")}.com`,
+      type: "homoglyph",
+      registered_at: now,
+    },
+    {
+      domain: `${brandName}s.com`,
+      type: "typosquat",
+      registered_at: now,
+    },
+  ];
+}
+
+function generateStubSimilarDomains(domain: string): string[] {
+  const base = domain.replace(/\.[^.]+$/, "");
+  const tld = domain.slice(base.length);
+  return [
+    `${base}-online${tld}`,
+    `${base}s${tld}`,
+    `${base.replace(/a/gi, "4")}${tld}`,
+    `${base}-app${tld}`,
+    `get${base}${tld}`,
+  ];
+}
+
+function generateStubWhoisHistory(domain: string): WhoisHistoryEntry[] {
+  return [
+    {
+      registrant: "Privacy Proxy Service",
+      date: "2023-01-15T00:00:00Z",
+      changes: ["registrant_changed", "nameserver_changed"],
+    },
+    {
+      registrant: "Original Owner LLC",
+      date: "2020-06-01T00:00:00Z",
+      changes: ["initial_registration"],
+    },
+  ];
+}
+
+function generateStubThreatAssessment(domain: string): Omit<ThreatAssessment, "stub"> {
+  return {
+    domain,
+    risk_level: "low",
+    threats: [],
+    recommendation: "No immediate threats detected. Continue routine monitoring.",
+  };
+}
+
+// ============================================================
+// API Functions (use connector, fall back to stubs)
+// ============================================================
+
+/**
+ * Monitor a brand name for new domain registrations that are similar.
+ */
+export async function monitorBrand(brandName: string): Promise<BrandMonitorResult> {
+  const connector = createConnector();
+  const data = await connector.monitorBrand(brandName);
+
+  if (data === null) {
+    return {
+      brand: brandName,
+      alerts: generateStubAlerts(brandName),
+      stub: true,
+    };
+  }
+
+  return {
+    brand: brandName,
+    alerts: data.alerts,
+    stub: false,
+  };
+}
+
+/**
+ * Find typosquat/competing domains similar to the given domain.
+ */
+export async function getSimilarDomains(domain: string): Promise<{ domain: string; similar: string[]; stub: boolean }> {
+  const connector = createConnector();
+  const data = await connector.getSimilarDomains(domain);
+
+  if (data === null) {
+    return {
+      domain,
+      similar: generateStubSimilarDomains(domain),
+      stub: true,
+    };
+  }
+
+  return {
+    domain,
+    similar: data.similar,
+    stub: false,
+  };
+}
+
+/**
+ * Get historical WHOIS records for a domain.
+ */
+export async function getWhoisHistory(domain: string): Promise<WhoisHistoryResult> {
+  const connector = createConnector();
+  const data = await connector.getWhoisHistory(domain);
+
+  if (data === null) {
+    return {
+      domain,
+      history: generateStubWhoisHistory(domain),
+      stub: true,
+    };
+  }
+
+  return {
+    domain,
+    history: data.history,
+    stub: false,
+  };
+}
+
+/**
+ * Get a threat assessment for a domain.
+ */
+export async function getThreatAssessment(domain: string): Promise<ThreatAssessment> {
+  const connector = createConnector();
+  const data = await connector.getThreatAssessment(domain);
+
+  if (data === null) {
+    return {
+      ...generateStubThreatAssessment(domain),
+      stub: true,
+    };
+  }
+
+  return {
+    ...data,
+    stub: false,
+  };
+}

package/microservices/microservice-domains/src/lib/godaddy.ts

@@ -0,0 +1,338 @@
+/**
+ * GoDaddy API integration for microservice-domains
+ *
+ * Uses the Connector SDK pattern from connect-godaddy.
+ * When @hasna/connect-godaddy is published to npm, replace the
+ * relative connector import with the package import.
+ *
+ * Environment variables:
+ *   GODADDY_API_KEY    — GoDaddy API key
+ *   GODADDY_API_SECRET — GoDaddy API secret
+ */
+
+import type {
+  CreateDomainInput,
+  UpdateDomainInput,
+  Domain,
+} from "../db/domains.js";
+
+// Re-export types used by consumers
+export type {
+  GoDaddyDomain,
+  GoDaddyDomainDetail,
+  GoDaddyDnsRecord,
+  GoDaddyAvailability,
+  GoDaddyRenewResponse,
+} from "../../../../../open-connectors/connectors/connect-godaddy/src/index.js";
+
+import {
+  GoDaddy,
+  GoDaddyApiError,
+  type GoDaddyDomain,
+  type GoDaddyDomainDetail,
+  type GoDaddyDnsRecord,
+  type GoDaddyAvailability,
+  type GoDaddyConfig,
+} from "../../../../../open-connectors/connectors/connect-godaddy/src/index.js";
+
+export { GoDaddyApiError };
+
+// ============================================================
+// Sync Result Type (microservice-specific)
+// ============================================================
+
+export interface GoDaddySyncResult {
+  synced: number;
+  created: number;
+  updated: number;
+  errors: string[];
+}
+
+// ============================================================
+// Internal fetch override (allows test injection)
+// ============================================================
+
+type FetchFn = typeof globalThis.fetch;
+
+let _overriddenFetch: FetchFn | null = null;
+
+/**
+ * Override the fetch implementation (for testing).
+ * Pass `null` to restore the default.
+ */
+export function _setFetch(fn: FetchFn | null): void {
+  _overriddenFetch = fn;
+}
+
+// ============================================================
+// Connector Instance Management
+// ============================================================
+
+function createConnector(): GoDaddy {
+  // Use fromEnv() which reads GODADDY_API_KEY and GODADDY_API_SECRET
+  return GoDaddy.fromEnv();
+}
+
+// ============================================================
+// API Functions (thin wrappers around connector)
+// ============================================================
+
+/**
+ * List all domains in the GoDaddy account.
+ */
+export async function listGoDaddyDomains(): Promise<GoDaddyDomain[]> {
+  if (_overriddenFetch) {
+    return _legacyApiRequest<GoDaddyDomain[]>("GET", "/v1/domains");
+  }
+  const connector = createConnector();
+  return connector.domains.list();
+}
+
+/**
+ * Get detailed info for a single domain.
+ */
+export async function getDomainInfo(
+  domain: string
+): Promise<GoDaddyDomainDetail> {
+  if (_overriddenFetch) {
+    return _legacyApiRequest<GoDaddyDomainDetail>(
+      "GET",
+      `/v1/domains/${encodeURIComponent(domain)}`
+    );
+  }
+  const connector = createConnector();
+  return connector.domains.getInfo(domain);
+}
+
+/**
+ * Renew a domain for 1 year.
+ */
+export async function renewDomain(
+  domain: string
+): Promise<{ orderId: number; itemCount: number; total: number }> {
+  if (_overriddenFetch) {
+    return _legacyApiRequest(
+      "POST",
+      `/v1/domains/${encodeURIComponent(domain)}/renew`,
+      { period: 1 }
+    );
+  }
+  const connector = createConnector();
+  return connector.domains.renew(domain);
+}
+
+/**
+ * Get DNS records for a domain, optionally filtered by type.
+ */
+export async function getDnsRecords(
+  domain: string,
+  type?: string
+): Promise<GoDaddyDnsRecord[]> {
+  if (_overriddenFetch) {
+    const path = type
+      ? `/v1/domains/${encodeURIComponent(domain)}/records/${encodeURIComponent(type)}`
+      : `/v1/domains/${encodeURIComponent(domain)}/records`;
+    return _legacyApiRequest<GoDaddyDnsRecord[]>("GET", path);
+  }
+  const connector = createConnector();
+  return type
+    ? connector.dns.getRecords(domain, type)
+    : connector.dns.getRecords(domain);
+}
+
+/**
+ * Replace all DNS records for a domain.
+ */
+export async function setDnsRecords(
+  domain: string,
+  records: GoDaddyDnsRecord[]
+): Promise<void> {
+  if (_overriddenFetch) {
+    await _legacyApiRequest<void>(
+      "PUT",
+      `/v1/domains/${encodeURIComponent(domain)}/records`,
+      records
+    );
+    return;
+  }
+  const connector = createConnector();
+  await connector.dns.replaceAllRecords(domain, records);
+}
+
+/**
+ * Check domain availability for purchase.
+ */
+export async function checkAvailability(
+  domain: string
+): Promise<GoDaddyAvailability> {
+  if (_overriddenFetch) {
+    return _legacyApiRequest<GoDaddyAvailability>(
+      "GET",
+      `/v1/domains/available?domain=${encodeURIComponent(domain)}`
+    );
+  }
+  const connector = createConnector();
+  return connector.domains.checkAvailability(domain);
+}
+
+// ============================================================
+// Legacy fetch helper (for test injection compatibility)
+// ============================================================
+
+const GODADDY_API_BASE = "https://api.godaddy.com";
+
+function _getCredentials(): { key: string; secret: string } {
+  const key = process.env["GODADDY_API_KEY"];
+  const secret = process.env["GODADDY_API_SECRET"];
+
+  if (!key || !secret) {
+    throw new Error(
+      "GoDaddy API credentials not configured. Set GODADDY_API_KEY and GODADDY_API_SECRET environment variables."
+    );
+  }
+
+  return { key, secret };
+}
+
+function _getHeaders(): Record<string, string> {
+  const { key, secret } = _getCredentials();
+  return {
+    Authorization: `sso-key ${key}:${secret}`,
+    "Content-Type": "application/json",
+    Accept: "application/json",
+  };
+}
+
+async function _legacyApiRequest<T>(
+  method: string,
+  path: string,
+  body?: unknown
+): Promise<T> {
+  const fetchFn = _overriddenFetch || globalThis.fetch;
+  const url = `${GODADDY_API_BASE}${path}`;
+  const headers = _getHeaders();
+
+  const options: RequestInit = { method, headers };
+  if (body !== undefined) {
+    options.body = JSON.stringify(body);
+  }
+
+  const response = await fetchFn(url, options);
+
+  if (!response.ok) {
+    const text = await response.text();
+    throw new GoDaddyApiError(
+      `GoDaddy API ${method} ${path} failed with status ${response.status}: ${text}`,
+      response.status,
+      { responseBody: text }
+    );
+  }
+
+  // Some endpoints return 204 No Content
+  if (response.status === 204) {
+    return undefined as unknown as T;
+  }
+
+  return (await response.json()) as T;
+}
+
+// ============================================================
+// Sync to Local DB (microservice business logic)
+// ============================================================
+
+/**
+ * Maps GoDaddy status strings to local domain statuses.
+ */
+function mapGoDaddyStatus(
+  gdStatus: string
+): "active" | "expired" | "transferring" | "redemption" {
+  const s = gdStatus.toUpperCase();
+  if (s === "ACTIVE") return "active";
+  if (s === "EXPIRED") return "expired";
+  if (
+    s === "TRANSFERRED_OUT" ||
+    s === "TRANSFERRING" ||
+    s === "PENDING_TRANSFER"
+  )
+    return "transferring";
+  if (s === "REDEMPTION" || s === "PENDING_REDEMPTION") return "redemption";
+  return "active";
+}
+
+/**
+ * Sync all GoDaddy domains into the local database.
+ *
+ * Accepts DB helpers so the caller can inject the actual CRUD functions.
+ */
+export async function syncToLocalDb(dbFns: {
+  getDomainByName: (name: string) => Domain | null;
+  createDomain: (input: CreateDomainInput) => Domain;
+  updateDomain: (id: string, input: UpdateDomainInput) => Domain | null;
+}): Promise<GoDaddySyncResult> {
+  const result: GoDaddySyncResult = {
+    synced: 0,
+    created: 0,
+    updated: 0,
+    errors: [],
+  };
+
+  let gdDomains: GoDaddyDomain[];
+  try {
+    gdDomains = await listGoDaddyDomains();
+  } catch (err) {
+    result.errors.push(
+      `Failed to list domains: ${err instanceof Error ? err.message : String(err)}`
+    );
+    return result;
+  }
+
+  for (const gd of gdDomains) {
+    try {
+      // Fetch full detail for each domain via connector
+      let detail: GoDaddyDomainDetail;
+      try {
+        detail = await getDomainInfo(gd.domain);
+      } catch {
+        // Fall back to list-level data if detail fetch fails
+        detail = gd as GoDaddyDomainDetail;
+      }
+
+      const existing = dbFns.getDomainByName(gd.domain);
+
+      const domainData = {
+        name: gd.domain,
+        registrar: "GoDaddy",
+        status: mapGoDaddyStatus(gd.status),
+        expires_at: gd.expires
+          ? new Date(gd.expires).toISOString()
+          : undefined,
+        auto_renew: gd.renewAuto,
+        nameservers: gd.nameServers || [],
+        registered_at: detail.createdAt
+          ? new Date(detail.createdAt).toISOString()
+          : undefined,
+        metadata: {
+          godaddy_domain_id: (detail as GoDaddyDomainDetail).domainId,
+          provider: "godaddy",
+          locked: (detail as GoDaddyDomainDetail).locked,
+          privacy: (detail as GoDaddyDomainDetail).privacy,
+        },
+      };
+
+      if (existing) {
+        dbFns.updateDomain(existing.id, domainData);
+        result.updated++;
+      } else {
+        dbFns.createDomain(domainData);
+        result.created++;
+      }
+      result.synced++;
+    } catch (err) {
+      result.errors.push(
+        `Failed to sync ${gd.domain}: ${err instanceof Error ? err.message : String(err)}`
+      );
+    }
+  }
+
+  return result;
+}