@hasna/connectors 1.0.5 → 1.0.7

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

@@ -0,0 +1,333 @@
+// PatentsView Connector Types
+// Based on the PatentsView API v1 (May 2025+)
+
+// ============================================
+// Configuration
+// ============================================
+
+export interface PatentsViewConfig {
+  apiKey?: string; // API key for authentication (required)
+  baseUrl?: string; // Override default base URL (https://search.patentsview.org/api/v1)
+}
+
+// ============================================
+// Common Types
+// ============================================
+
+export type OutputFormat = 'json' | 'pretty';
+
+// Query operators for filtering
+export interface QueryFilter {
+  _eq?: string | number | boolean;
+  _neq?: string | number | boolean;
+  _gt?: number | string;
+  _gte?: number | string;
+  _lt?: number | string;
+  _lte?: number | string;
+  _begins?: string;
+  _contains?: string;
+  _text_any?: string;
+  _text_all?: string;
+  _text_phrase?: string;
+}
+
+// Generic query object structure
+export type QueryObject = {
+  _and?: QueryObject[];
+  _or?: QueryObject[];
+  _not?: QueryObject;
+} & {
+  [field: string]: QueryFilter | QueryObject | QueryObject[] | undefined;
+};
+
+// Pagination and sorting options
+export interface QueryOptions {
+  page?: number;
+  per_page?: number;
+  sort?: Array<{ [field: string]: 'asc' | 'desc' }>;
+}
+
+// Base search request format
+export interface SearchRequest {
+  q?: QueryObject;
+  f?: string[];
+  o?: QueryOptions;
+}
+
+// Base search response format
+export interface SearchResponse<T> {
+  patents?: T[];
+  assignees?: T[];
+  inventors?: T[];
+  cpc_subgroups?: T[];
+  locations?: T[];
+  count?: number;
+  total_hits?: number;
+}
+
+// ============================================
+// Patent Types
+// ============================================
+
+export interface Patent {
+  patent_id: string;
+  patent_number?: string;
+  patent_title?: string;
+  patent_abstract?: string;
+  patent_date?: string;
+  patent_type?: string;
+  patent_kind?: string;
+  patent_num_claims?: number;
+  patent_num_cited_by_us_patents?: number;
+  patent_num_combined_citations?: number;
+  patent_num_foreign_citations?: number;
+  patent_num_us_application_citations?: number;
+  patent_num_us_patent_citations?: number;
+  patent_firstnamed_assignee_id?: string;
+  patent_firstnamed_assignee_city?: string;
+  patent_firstnamed_assignee_state?: string;
+  patent_firstnamed_assignee_country?: string;
+  patent_firstnamed_inventor_id?: string;
+  patent_firstnamed_inventor_city?: string;
+  patent_firstnamed_inventor_state?: string;
+  patent_firstnamed_inventor_country?: string;
+  patent_year?: number;
+  // Nested objects
+  assignees?: Assignee[];
+  inventors?: Inventor[];
+  cpc_current?: CPCClassification[];
+  application?: Application;
+  claims?: Claim[];
+}
+
+export interface Application {
+  application_id?: string;
+  application_number?: string;
+  application_date?: string;
+  application_type?: string;
+}
+
+export interface Claim {
+  claim_number?: number;
+  claim_text?: string;
+  claim_dependent?: number;
+}
+
+// ============================================
+// Assignee Types
+// ============================================
+
+export interface Assignee {
+  assignee_id: string;
+  assignee_organization?: string;
+  assignee_type?: string;
+  assignee_individual_name_first?: string;
+  assignee_individual_name_last?: string;
+  assignee_city?: string;
+  assignee_state?: string;
+  assignee_country?: string;
+  assignee_latitude?: number;
+  assignee_longitude?: number;
+  assignee_num_patents?: number;
+  assignee_num_inventors?: number;
+  assignee_first_seen_date?: string;
+  assignee_last_seen_date?: string;
+  assignee_years_active?: number;
+}
+
+// ============================================
+// Inventor Types
+// ============================================
+
+export interface Inventor {
+  inventor_id: string;
+  inventor_name_first?: string;
+  inventor_name_last?: string;
+  inventor_city?: string;
+  inventor_state?: string;
+  inventor_country?: string;
+  inventor_latitude?: number;
+  inventor_longitude?: number;
+  inventor_num_patents?: number;
+  inventor_num_assignees?: number;
+  inventor_first_seen_date?: string;
+  inventor_last_seen_date?: string;
+  inventor_years_active?: number;
+}
+
+// ============================================
+// CPC (Cooperative Patent Classification) Types
+// ============================================
+
+export interface CPCClassification {
+  cpc_subgroup_id?: string;
+  cpc_subgroup_title?: string;
+  cpc_group_id?: string;
+  cpc_group_title?: string;
+  cpc_subclass_id?: string;
+  cpc_subclass_title?: string;
+  cpc_class_id?: string;
+  cpc_class_title?: string;
+  cpc_section_id?: string;
+  cpc_section_title?: string;
+  cpc_sequence?: number;
+  cpc_type?: string;
+}
+
+export interface CPCSubgroup {
+  cpc_subgroup_id: string;
+  cpc_subgroup_title?: string;
+  cpc_group_id?: string;
+  cpc_group_title?: string;
+  cpc_subclass_id?: string;
+  cpc_subclass_title?: string;
+  cpc_class_id?: string;
+  cpc_class_title?: string;
+  cpc_section_id?: string;
+  cpc_section_title?: string;
+  cpc_num_patents?: number;
+  cpc_num_inventors?: number;
+  cpc_num_assignees?: number;
+}
+
+// ============================================
+// Location Types
+// ============================================
+
+export interface Location {
+  location_id: string;
+  location_city?: string;
+  location_state?: string;
+  location_country?: string;
+  location_latitude?: number;
+  location_longitude?: number;
+  location_num_patents?: number;
+  location_num_inventors?: number;
+  location_num_assignees?: number;
+}
+
+// ============================================
+// API Response Types
+// ============================================
+
+export interface PatentSearchResponse {
+  patents: Patent[];
+  count: number;
+  total_hits: number;
+}
+
+export interface PatentGetResponse {
+  patents: Patent[];
+}
+
+export interface AssigneeSearchResponse {
+  assignees: Assignee[];
+  count: number;
+  total_hits: number;
+}
+
+export interface AssigneeGetResponse {
+  assignees: Assignee[];
+}
+
+export interface InventorSearchResponse {
+  inventors: Inventor[];
+  count: number;
+  total_hits: number;
+}
+
+export interface InventorGetResponse {
+  inventors: Inventor[];
+}
+
+export interface CPCSearchResponse {
+  cpc_subgroups: CPCSubgroup[];
+  count: number;
+  total_hits: number;
+}
+
+export interface CPCGetResponse {
+  cpc_subgroups: CPCSubgroup[];
+}
+
+export interface LocationSearchResponse {
+  locations: Location[];
+  count: number;
+  total_hits: number;
+}
+
+// ============================================
+// API Error Types
+// ============================================
+
+export interface ApiErrorDetail {
+  code: string;
+  message: string;
+  field?: string;
+}
+
+export class PatentsViewApiError extends Error {
+  public readonly statusCode: number;
+  public readonly errors?: ApiErrorDetail[];
+
+  constructor(message: string, statusCode: number, errors?: ApiErrorDetail[]) {
+    super(message);
+    this.name = 'PatentsViewApiError';
+    this.statusCode = statusCode;
+    this.errors = errors;
+  }
+}
+
+// ============================================
+// Default Fields (commonly used fields for each entity)
+// ============================================
+
+export const DEFAULT_PATENT_FIELDS = [
+  'patent_id',
+  'patent_number',
+  'patent_title',
+  'patent_abstract',
+  'patent_date',
+  'patent_type',
+  'patent_num_claims',
+  'patent_num_cited_by_us_patents',
+];
+
+export const DEFAULT_ASSIGNEE_FIELDS = [
+  'assignee_id',
+  'assignee_organization',
+  'assignee_individual_name_first',
+  'assignee_individual_name_last',
+  'assignee_city',
+  'assignee_state',
+  'assignee_country',
+  'assignee_num_patents',
+];
+
+export const DEFAULT_INVENTOR_FIELDS = [
+  'inventor_id',
+  'inventor_name_first',
+  'inventor_name_last',
+  'inventor_city',
+  'inventor_state',
+  'inventor_country',
+  'inventor_num_patents',
+];
+
+export const DEFAULT_CPC_FIELDS = [
+  'cpc_subgroup_id',
+  'cpc_subgroup_title',
+  'cpc_group_id',
+  'cpc_group_title',
+  'cpc_section_id',
+  'cpc_num_patents',
+];
+
+export const DEFAULT_LOCATION_FIELDS = [
+  'location_id',
+  'location_city',
+  'location_state',
+  'location_country',
+  'location_num_patents',
+  'location_num_inventors',
+];

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

@@ -0,0 +1,212 @@
+import { existsSync, readFileSync, writeFileSync, mkdirSync, readdirSync, rmSync } from 'fs';
+import { homedir } from 'os';
+import { join } from 'path';
+
+const CONNECTOR_NAME = 'connect-patentsview';
+const DEFAULT_PROFILE = 'default';
+
+export interface ProfileConfig {
+  apiKey?: string;
+  baseUrl?: 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));
+}
+
+// ============================================
+// API Key Management
+// ============================================
+
+export function getApiKey(): string | undefined {
+  return process.env.PATENTSVIEW_API_KEY || loadProfile().apiKey;
+}
+
+export function setApiKey(apiKey: string): void {
+  const config = loadProfile();
+  config.apiKey = apiKey;
+  saveProfile(config);
+}
+
+// ============================================
+// Base URL Management
+// ============================================
+
+export function getBaseUrl(): string | undefined {
+  return process.env.PATENTSVIEW_BASE_URL || loadProfile().baseUrl;
+}
+
+export function setBaseUrl(baseUrl: string): void {
+  const config = loadProfile();
+  config.baseUrl = baseUrl;
+  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-patentsview/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-patentsview/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"]
+}

package/connectors/connect-patreon/.env.example

@@ -0,0 +1,11 @@
+# API Credentials
+# TODO: Update variable names and instructions for your API
+# Example: PERPLEXITY_API_KEY, OPENAI_API_KEY, etc.
+
+CONNECTOR_API_KEY=your-api-key-here
+
+# Optional: API secret (if your API requires it)
+# CONNECTOR_API_SECRET=your-api-secret-here
+
+# Optional: Custom base URL (if needed)
+# CONNECTOR_BASE_URL=https://api.example.com