@hasna/connectors 1.1.0 → 1.1.1

package/connectors/connect-wipo/src/index.ts

@@ -0,0 +1,26 @@
+// WIPO Connector
+// A TypeScript wrapper for WIPO APIs with browser automation
+
+export { WIPO } from './api';
+export * from './types';
+
+// Re-export individual API classes for advanced usage
+export { WIPOClient, PatentscopeApi, MadridApi, PearlApi, BrowserApi } from './api';
+
+// Export config utilities
+export {
+  getApiKey,
+  setApiKey,
+  getHeadless,
+  setHeadless,
+  getBrowser,
+  setBrowser,
+  getCurrentProfile,
+  setCurrentProfile,
+  listProfiles,
+  createProfile,
+  deleteProfile,
+  loadProfile,
+  saveProfile,
+  clearConfig,
+} from './utils/config';

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

@@ -0,0 +1,315 @@
+// WIPO Connector Types
+
+// ============================================
+// Configuration
+// ============================================
+
+export interface WIPOConfig {
+  apiKey?: string; // Optional for some APIs
+  baseUrl?: string;
+  headless?: boolean; // For Playwright browser
+  browser?: 'chromium' | 'firefox' | 'webkit';
+}
+
+export type OutputFormat = 'json' | 'pretty';
+
+// ============================================
+// Patentscope Types (PCT Applications)
+// ============================================
+
+export interface PatentscopeSearchParams {
+  query: string;
+  start?: number;
+  rows?: number;
+  sort?: 'relevance' | 'date_asc' | 'date_desc';
+  language?: string;
+  facets?: boolean;
+  dateFrom?: string; // YYYY-MM-DD
+  dateTo?: string;
+  applicantCountry?: string;
+  ipc?: string; // IPC classification
+}
+
+export interface PCTApplication {
+  applicationNumber: string; // PCT/XX/YYYY/NNNNNN
+  publicationNumber?: string; // WO/YYYY/NNNNNN
+  internationalFilingDate: string;
+  publicationDate?: string;
+  title: string;
+  titleLanguage?: string;
+  abstract?: string;
+  abstractLanguage?: string;
+  applicants?: Applicant[];
+  inventors?: Inventor[];
+  designatedStates?: string[];
+  ipcClassifications?: IPCClassification[];
+  priorities?: PriorityDocument[];
+  pctStatus?: string;
+  nationalPhaseEntries?: NationalPhaseEntry[];
+}
+
+export interface Applicant {
+  name: string;
+  address?: string;
+  country?: string;
+  type?: 'individual' | 'organization';
+}
+
+export interface Inventor {
+  name: string;
+  address?: string;
+  country?: string;
+}
+
+export interface IPCClassification {
+  code: string;
+  description?: string;
+  version?: string;
+  section?: string;
+  class?: string;
+  subclass?: string;
+}
+
+export interface PriorityDocument {
+  applicationNumber: string;
+  filingDate: string;
+  country: string;
+}
+
+export interface NationalPhaseEntry {
+  country: string;
+  applicationNumber?: string;
+  entryDate?: string;
+  status?: string;
+}
+
+export interface PatentscopeSearchResponse {
+  total: number;
+  start: number;
+  rows: number;
+  applications: PCTApplication[];
+  facets?: Record<string, FacetValue[]>;
+}
+
+export interface FacetValue {
+  value: string;
+  count: number;
+}
+
+export interface PatentscopeDocument {
+  documentId: string;
+  documentType: 'application' | 'publication' | 'search-report' | 'other';
+  language?: string;
+  pageCount?: number;
+  downloadUrl?: string;
+}
+
+// ============================================
+// Madrid System Types (International Trademarks)
+// ============================================
+
+export interface MadridSearchParams {
+  query?: string;
+  markName?: string;
+  holderName?: string;
+  holderCountry?: string;
+  designatedCountry?: string;
+  niceClass?: number | number[];
+  status?: 'active' | 'inactive' | 'all';
+  dateFrom?: string;
+  dateTo?: string;
+  start?: number;
+  rows?: number;
+  sort?: 'relevance' | 'date_asc' | 'date_desc';
+}
+
+export interface MadridMark {
+  registrationNumber: string; // International Registration Number
+  applicationNumber?: string;
+  markName?: string;
+  markType?: 'word' | 'figurative' | 'combined' | 'three-dimensional' | 'sound' | 'other';
+  status: string;
+  statusDate?: string;
+  registrationDate: string;
+  expiryDate?: string;
+  holder: MarkHolder;
+  representative?: Representative;
+  designatedCountries: DesignatedCountry[];
+  niceClassifications: NiceClassification[];
+  viennaClassifications?: ViennaClassification[];
+  goodsServices: string;
+  colors?: string[];
+  imageUrl?: string;
+  priorities?: MarkPriority[];
+}
+
+export interface MarkHolder {
+  name: string;
+  address?: string;
+  city?: string;
+  country: string;
+  entityType?: string;
+}
+
+export interface Representative {
+  name: string;
+  address?: string;
+  country?: string;
+}
+
+export interface DesignatedCountry {
+  countryCode: string;
+  countryName?: string;
+  status: string;
+  statusDate?: string;
+  protectionStartDate?: string;
+  refusalDate?: string;
+  refusalReason?: string;
+}
+
+export interface NiceClassification {
+  classNumber: number;
+  description?: string;
+  goodsServices?: string;
+}
+
+export interface ViennaClassification {
+  code: string;
+  description?: string;
+}
+
+export interface MarkPriority {
+  country: string;
+  applicationNumber: string;
+  filingDate: string;
+}
+
+export interface MadridSearchResponse {
+  total: number;
+  start: number;
+  rows: number;
+  marks: MadridMark[];
+  facets?: Record<string, FacetValue[]>;
+}
+
+export interface MadridDocument {
+  documentId: string;
+  documentType: 'gazette' | 'notification' | 'certificate' | 'other';
+  publicationDate?: string;
+  downloadUrl?: string;
+}
+
+// ============================================
+// WIPO Pearl Types (Terminology)
+// ============================================
+
+export interface WIPOPearlSearchParams {
+  term: string;
+  sourceLanguage?: string;
+  targetLanguages?: string[];
+  domain?: string; // Technology domain
+  conceptId?: string;
+  exactMatch?: boolean;
+  start?: number;
+  rows?: number;
+}
+
+export interface WIPOPearlTerm {
+  termId: string;
+  term: string;
+  language: string;
+  conceptId: string;
+  conceptName?: string;
+  definition?: string;
+  domain?: string;
+  reliability?: 'high' | 'medium' | 'low';
+  source?: string;
+  translations?: Translation[];
+  relatedConcepts?: RelatedConcept[];
+  synonyms?: string[];
+}
+
+export interface Translation {
+  term: string;
+  language: string;
+  reliability?: 'high' | 'medium' | 'low';
+  source?: string;
+}
+
+export interface RelatedConcept {
+  conceptId: string;
+  conceptName: string;
+  relationshipType: 'broader' | 'narrower' | 'related';
+}
+
+export interface WIPOPearlSearchResponse {
+  total: number;
+  start: number;
+  rows: number;
+  terms: WIPOPearlTerm[];
+}
+
+export interface WIPOPearlConcept {
+  conceptId: string;
+  name: string;
+  definition?: string;
+  domain: string;
+  terms: WIPOPearlTerm[];
+  broaderConcepts?: RelatedConcept[];
+  narrowerConcepts?: RelatedConcept[];
+  relatedConcepts?: RelatedConcept[];
+}
+
+// ============================================
+// Browser Automation Types
+// ============================================
+
+export interface PatentscopeWebSearchParams {
+  query: string;
+  searchType?: 'simple' | 'advanced' | 'field';
+  language?: string;
+  collection?: 'pct' | 'national';
+}
+
+export interface MadridMonitorSearchParams {
+  markName?: string;
+  holderName?: string;
+  registrationNumber?: string;
+  country?: string;
+}
+
+export interface BrowserSearchOptions {
+  headless?: boolean;
+  timeout?: number;
+  screenshotPath?: string;
+}
+
+export interface BrowserSearchResult {
+  applicationNumber: string;
+  title?: string;
+  date?: string;
+  applicant?: string;
+  url?: string;
+}
+
+// ============================================
+// API Error Types
+// ============================================
+
+export interface ApiErrorDetail {
+  code: string;
+  message: string;
+  field?: string;
+}
+
+export class WIPOApiError extends Error {
+  public readonly statusCode: number;
+  public readonly errors?: ApiErrorDetail[];
+
+  constructor(message: string, statusCode: number, errors?: ApiErrorDetail[]) {
+    super(message);
+    this.name = 'WIPOApiError';
+    this.statusCode = statusCode;
+    this.errors = errors;
+  }
+}

package/connectors/connect-wipo/src/utils/config.ts

@@ -0,0 +1,235 @@
+import { existsSync, readFileSync, writeFileSync, mkdirSync, readdirSync, rmSync } from 'fs';
+import { homedir } from 'os';
+import { join } from 'path';
+
+const CONNECTOR_NAME = 'connect-wipo';
+const DEFAULT_PROFILE = 'default';
+
+export interface ProfileConfig {
+  apiKey?: string;
+  headless?: boolean;
+  browser?: 'chromium' | 'firefox' | 'webkit';
+  outputDir?: string;
+}
+
+// Store for --profile flag override (set by CLI before commands run)
+let profileOverride: string | undefined;
+
+// Config directory: ~/.connect/{connector-name}/
+const CONFIG_DIR = join(homedir(), '.connect', CONNECTOR_NAME);
+const PROFILES_DIR = join(CONFIG_DIR, 'profiles');
+const CURRENT_PROFILE_FILE = join(CONFIG_DIR, 'current_profile');
+
+// ============================================
+// Profile Management
+// ============================================
+
+export function setProfileOverride(profile: string | undefined): void {
+  profileOverride = profile;
+}
+
+export function ensureConfigDir(): void {
+  if (!existsSync(CONFIG_DIR)) {
+    mkdirSync(CONFIG_DIR, { recursive: true });
+  }
+  if (!existsSync(PROFILES_DIR)) {
+    mkdirSync(PROFILES_DIR, { recursive: true });
+  }
+}
+
+function getProfilePath(profile: string): string {
+  return join(PROFILES_DIR, `${profile}.json`);
+}
+
+/**
+ * Get the current active profile name
+ */
+export function getCurrentProfile(): string {
+  if (profileOverride) {
+    return profileOverride;
+  }
+
+  ensureConfigDir();
+
+  if (existsSync(CURRENT_PROFILE_FILE)) {
+    try {
+      const profile = readFileSync(CURRENT_PROFILE_FILE, 'utf-8').trim();
+      if (profile && profileExists(profile)) {
+        return profile;
+      }
+    } catch {
+      // Fall through to default
+    }
+  }
+
+  return DEFAULT_PROFILE;
+}
+
+/**
+ * Set the current active profile
+ */
+export function setCurrentProfile(profile: string): void {
+  ensureConfigDir();
+
+  if (!profileExists(profile) && profile !== DEFAULT_PROFILE) {
+    throw new Error(`Profile "${profile}" does not exist`);
+  }
+
+  writeFileSync(CURRENT_PROFILE_FILE, profile);
+}
+
+/**
+ * Check if a profile exists
+ */
+export function profileExists(profile: string): boolean {
+  return existsSync(getProfilePath(profile));
+}
+
+/**
+ * List all available profiles
+ */
+export function listProfiles(): string[] {
+  ensureConfigDir();
+
+  if (!existsSync(PROFILES_DIR)) {
+    return [];
+  }
+
+  return readdirSync(PROFILES_DIR)
+    .filter(f => f.endsWith('.json'))
+    .map(f => f.replace('.json', ''))
+    .sort();
+}
+
+/**
+ * Create a new profile
+ */
+export function createProfile(profile: string, config: ProfileConfig = {}): boolean {
+  ensureConfigDir();
+
+  if (profileExists(profile)) {
+    return false;
+  }
+
+  // Validate profile name
+  if (!/^[a-zA-Z0-9_-]+$/.test(profile)) {
+    throw new Error('Profile name can only contain letters, numbers, hyphens, and underscores');
+  }
+
+  writeFileSync(getProfilePath(profile), JSON.stringify(config, null, 2));
+  return true;
+}
+
+/**
+ * Delete a profile
+ */
+export function deleteProfile(profile: string): boolean {
+  if (profile === DEFAULT_PROFILE) {
+    return false;
+  }
+
+  if (!profileExists(profile)) {
+    return false;
+  }
+
+  // Switch to default if deleting current profile
+  if (getCurrentProfile() === profile) {
+    setCurrentProfile(DEFAULT_PROFILE);
+  }
+
+  rmSync(getProfilePath(profile));
+  return true;
+}
+
+/**
+ * Load profile config
+ */
+export function loadProfile(profile?: string): ProfileConfig {
+  ensureConfigDir();
+  const profileName = profile || getCurrentProfile();
+  const profilePath = getProfilePath(profileName);
+
+  if (!existsSync(profilePath)) {
+    return {};
+  }
+
+  try {
+    return JSON.parse(readFileSync(profilePath, 'utf-8'));
+  } catch {
+    return {};
+  }
+}
+
+/**
+ * Save profile config
+ */
+export function saveProfile(config: ProfileConfig, profile?: string): void {
+  ensureConfigDir();
+  const profileName = profile || getCurrentProfile();
+  writeFileSync(getProfilePath(profileName), JSON.stringify(config, null, 2));
+}
+
+// ============================================
+// Config Getters/Setters
+// ============================================
+
+export function getApiKey(): string | undefined {
+  return process.env.WIPO_API_KEY || process.env.WIPO_TOKEN || loadProfile().apiKey;
+}
+
+export function setApiKey(apiKey: string): void {
+  const config = loadProfile();
+  config.apiKey = apiKey;
+  saveProfile(config);
+}
+
+export function getHeadless(): boolean {
+  const envVal = process.env.WIPO_HEADLESS;
+  if (envVal !== undefined) {
+    return envVal !== 'false';
+  }
+  const config = loadProfile();
+  return config.headless !== false;
+}
+
+export function setHeadless(headless: boolean): void {
+  const config = loadProfile();
+  config.headless = headless;
+  saveProfile(config);
+}
+
+export function getBrowser(): ProfileConfig['browser'] | undefined {
+  return (process.env.WIPO_BROWSER as ProfileConfig['browser']) || loadProfile().browser;
+}
+
+export function setBrowser(browser: ProfileConfig['browser']): void {
+  const config = loadProfile();
+  config.browser = browser;
+  saveProfile(config);
+}
+
+export function getOutputDir(): string | undefined {
+  return process.env.WIPO_OUTPUT_DIR || loadProfile().outputDir;
+}
+
+export function setOutputDir(outputDir: string): void {
+  const config = loadProfile();
+  config.outputDir = outputDir;
+  saveProfile(config);
+}
+
+// ============================================
+// Utility Functions
+// ============================================
+
+export function clearConfig(): void {
+  saveProfile({});
+}
+
+export function getConfigDir(): string {
+  return CONFIG_DIR;
+}
+
+export function getActiveProfileName(): string {
+  return getCurrentProfile();
+}

package/connectors/connect-wipo/src/utils/output.ts

@@ -0,0 +1,119 @@
+import chalk from 'chalk';
+
+export type OutputFormat = 'json' | 'table' | 'pretty';
+
+export function formatOutput(data: unknown, format: OutputFormat = 'pretty'): string {
+  switch (format) {
+    case 'json':
+      return JSON.stringify(data, null, 2);
+    case 'table':
+      return formatAsTable(data);
+    case 'pretty':
+    default:
+      return formatPretty(data);
+  }
+}
+
+function formatAsTable(data: unknown): string {
+  if (!Array.isArray(data)) {
+    data = [data];
+  }
+
+  const items = data as Record<string, unknown>[];
+  if (items.length === 0) {
+    return 'No data';
+  }
+
+  const firstItem = items[0];
+  if (!firstItem || typeof firstItem !== 'object') {
+    return 'No data';
+  }
+
+  const keys = Object.keys(firstItem);
+  const colWidths = keys.map(key => {
+    const maxValue = Math.max(
+      key.length,
+      ...items.map(item => String(item[key] ?? '').length)
+    );
+    return Math.min(maxValue, 40);
+  });
+
+  const header = keys.map((key, i) => key.padEnd(colWidths[i] ?? 10)).join(' | ');
+  const separator = colWidths.map(w => '-'.repeat(w)).join('-+-');
+
+  const rows = items.map(item =>
+    keys.map((key, i) => {
+      const value = String(item[key] ?? '');
+      const width = colWidths[i] ?? 10;
+      return value.length > width
+        ? value.substring(0, width - 3) + '...'
+        : value.padEnd(width);
+    }).join(' | ')
+  );
+
+  return [header, separator, ...rows].join('\n');
+}
+
+function formatPretty(data: unknown): string {
+  if (Array.isArray(data)) {
+    return data.map((item, i) => `${chalk.cyan(`[${i + 1}]`)} ${formatPrettyItem(item)}`).join('\n\n');
+  }
+  return formatPrettyItem(data);
+}
+
+function formatPrettyItem(item: unknown, indent = 0): string {
+  if (item === null || item === undefined) {
+    return chalk.gray('null');
+  }
+
+  if (typeof item !== 'object') {
+    return String(item);
+  }
+
+  const spaces = '  '.repeat(indent);
+  const entries = Object.entries(item as Record<string, unknown>);
+
+  return entries
+    .map(([key, value]) => {
+      if (Array.isArray(value)) {
+        if (value.length === 0) {
+          return `${spaces}${chalk.blue(key)}: ${chalk.gray('[]')}`;
+        }
+        if (typeof value[0] === 'object') {
+          return `${spaces}${chalk.blue(key)}:\n${value.map(v => formatPrettyItem(v, indent + 1)).join('\n')}`;
+        }
+        return `${spaces}${chalk.blue(key)}: ${value.join(', ')}`;
+      }
+
+      if (typeof value === 'object' && value !== null) {
+        return `${spaces}${chalk.blue(key)}:\n${formatPrettyItem(value, indent + 1)}`;
+      }
+
+      return `${spaces}${chalk.blue(key)}: ${chalk.white(String(value))}`;
+    })
+    .join('\n');
+}
+
+export function success(message: string): void {
+  console.log(chalk.green('✓'), message);
+}
+
+export function error(message: string): void {
+  console.error(chalk.red('✗'), message);
+}
+
+export function warn(message: string): void {
+  console.warn(chalk.yellow('⚠'), message);
+}
+
+export function info(message: string): void {
+  console.log(chalk.blue('ℹ'), message);
+}
+
+export function heading(message: string): void {
+  console.log(chalk.bold.cyan(`\n${message}\n`));
+}
+
+export function print(data: unknown, format: OutputFormat = 'pretty'): void {
+  console.log(formatOutput(data, format));
+}

package/connectors/connect-wipo/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "target": "ESNext",
+    "module": "ESNext",
+    "moduleResolution": "bundler",
+    "esModuleInterop": true,
+    "strict": true,
+    "skipLibCheck": true,
+    "declaration": true,
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "types": ["bun-types"]
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist", "bin"]
+}