@hasna/connectors 1.0.4 → 1.0.6

package/connectors/connect-phrase/package.json

@@ -0,0 +1,51 @@
+{
+  "name": "@hasna/connect-phrase",
+  "version": "0.0.1",
+  "description": "Connector: connect-phrase",
+  "type": "module",
+  "bin": {
+    "connector": "./bin/index.js"
+  },
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "build": "bun build ./src/index.ts --outdir ./dist --target bun && bun build ./src/cli/index.ts --outdir ./bin --target bun",
+    "dev": "bun run ./src/cli/index.ts",
+    "typecheck": "tsc --noEmit",
+    "prepublishOnly": "bun run build",
+    "release": "bun run scripts/release.ts",
+    "release:dry": "bun run scripts/release.ts --dry-run"
+  },
+  "keywords": [
+    "api",
+    "connector",
+    "scaffold",
+    "cli",
+    "typescript",
+    "bun",
+    "template"
+  ],
+  "author": "Hasna",
+  "license": "Apache-2.0",
+  "devDependencies": {
+    "@types/bun": "latest",
+    "typescript": "^5"
+  },
+  "dependencies": {
+    "commander": "^12.1.0",
+    "chalk": "^5.3.0"
+  },
+  "engines": {
+    "bun": ">=1.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/hasnaxyz/scaffold-connector.git"
+  }
+}

package/connectors/connect-phrase/scripts/release.ts

@@ -0,0 +1,179 @@
+#!/usr/bin/env bun
+/**
+ * Release script for publishing to npm
+ *
+ * Usage:
+ *   bun run release        # Build, bump version, and publish
+ *   bun run release:dry    # Dry run (preview only)
+ *
+ * Features:
+ *   - Auto-fetches current npm version
+ *   - Bumps patch version if needed
+ *   - Creates git tag
+ *   - Publishes to npm
+ */
+
+import { readFileSync, writeFileSync } from 'fs';
+import { execSync } from 'child_process';
+
+const isDryRun = process.argv.includes('--dry-run');
+
+interface PackageJson {
+  name: string;
+  version: string;
+  [key: string]: unknown;
+}
+
+function exec(command: string, silent = false): string {
+  try {
+    const result = execSync(command, {
+      encoding: 'utf-8',
+      stdio: silent ? 'pipe' : 'inherit',
+    });
+    return result?.trim() || '';
+  } catch (err) {
+    if (silent) {
+      return '';
+    }
+    throw err;
+  }
+}
+
+function log(message: string): void {
+  console.log(`\x1b[36m▸\x1b[0m ${message}`);
+}
+
+function success(message: string): void {
+  console.log(`\x1b[32m✓\x1b[0m ${message}`);
+}
+
+function warn(message: string): void {
+  console.log(`\x1b[33m⚠\x1b[0m ${message}`);
+}
+
+function error(message: string): void {
+  console.error(`\x1b[31m✗\x1b[0m ${message}`);
+}
+
+function parseVersion(version: string): { major: number; minor: number; patch: number } {
+  const [major, minor, patch] = version.split('.').map(Number);
+  return { major, minor, patch };
+}
+
+function bumpPatch(version: string): string {
+  const { major, minor, patch } = parseVersion(version);
+  return `${major}.${minor}.${patch + 1}`;
+}
+
+async function main(): Promise<void> {
+  // Read package.json
+  const packageJsonPath = 'package.json';
+  const packageJson: PackageJson = JSON.parse(readFileSync(packageJsonPath, 'utf-8'));
+  const { name, version: localVersion } = packageJson;
+
+  log(`Package: ${name}`);
+  log(`Local version: ${localVersion}`);
+
+  // Get current npm version
+  let npmVersion = '';
+  try {
+    npmVersion = exec(`npm view ${name} version 2>/dev/null`, true);
+    log(`npm version: ${npmVersion || 'not published'}`);
+  } catch {
+    log('npm version: not published yet');
+  }
+
+  // Determine new version
+  let newVersion = localVersion;
+  if (npmVersion) {
+    const localParsed = parseVersion(localVersion);
+    const npmParsed = parseVersion(npmVersion);
+
+    // If local version <= npm version, bump from npm version
+    if (
+      localParsed.major < npmParsed.major ||
+      (localParsed.major === npmParsed.major && localParsed.minor < npmParsed.minor) ||
+      (localParsed.major === npmParsed.major &&
+        localParsed.minor === npmParsed.minor &&
+        localParsed.patch <= npmParsed.patch)
+    ) {
+      newVersion = bumpPatch(npmVersion);
+    }
+  }
+
+  if (newVersion !== localVersion) {
+    log(`Bumping version: ${localVersion} → ${newVersion}`);
+
+    if (!isDryRun) {
+      packageJson.version = newVersion;
+      writeFileSync(packageJsonPath, JSON.stringify(packageJson, null, 2) + '\n');
+    }
+  } else {
+    log(`Version unchanged: ${newVersion}`);
+  }
+
+  // Run typecheck
+  log('Running typecheck...');
+  if (!isDryRun) {
+    exec('bun run typecheck');
+    success('Typecheck passed');
+  }
+
+  // Build
+  log('Building...');
+  if (!isDryRun) {
+    exec('bun run build');
+    success('Build completed');
+  }
+
+  // Git operations
+  const gitStatus = exec('git status --porcelain', true);
+  if (gitStatus) {
+    log('Staging changes...');
+    if (!isDryRun) {
+      exec('git add package.json');
+      exec(`git commit -m "chore: release v${newVersion}"`);
+    }
+  }
+
+  // Create git tag
+  const tagName = `v${newVersion}`;
+  log(`Creating tag: ${tagName}`);
+  if (!isDryRun) {
+    try {
+      exec(`git tag ${tagName}`);
+      success(`Tag ${tagName} created`);
+    } catch {
+      warn(`Tag ${tagName} already exists`);
+    }
+  }
+
+  // Publish
+  log('Publishing to npm...');
+  if (isDryRun) {
+    warn('Dry run - skipping publish');
+    exec('npm publish --dry-run');
+  } else {
+    exec('npm publish');
+    success(`Published ${name}@${newVersion}`);
+  }
+
+  // Push tags
+  if (!isDryRun) {
+    log('Pushing tags...');
+    try {
+      exec('git push --tags');
+      success('Tags pushed');
+    } catch {
+      warn('Failed to push tags (you may need to push manually)');
+    }
+  }
+
+  console.log('');
+  success(`Release ${isDryRun ? '(dry run) ' : ''}complete: ${name}@${newVersion}`);
+}
+
+main().catch((err) => {
+  error(String(err));
+  process.exit(1);
+});

package/connectors/connect-phrase/src/api/client.ts

@@ -0,0 +1,213 @@
+import type { ConnectorConfig, OutputFormat } from '../types';
+import { ConnectorApiError, parseApiError } from '../types';
+
+// TODO: Replace with your API's base URL
+const DEFAULT_BASE_URL = 'https://api.example.com';
+
+export interface RequestOptions {
+  method?: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
+  params?: Record<string, string | number | boolean | undefined>;
+  body?: Record<string, unknown> | unknown[] | string;
+  headers?: Record<string, string>;
+  format?: OutputFormat;
+  /** Number of retries for failed requests (default: 3) */
+  retries?: number;
+  /** Timeout in milliseconds (default: 30000) */
+  timeout?: number;
+}
+
+export class ConnectorClient {
+  private readonly apiKey: string;
+  private readonly apiSecret?: string;
+  private readonly baseUrl: string;
+
+  constructor(config: ConnectorConfig) {
+    // Support both 'apiKey' and 'token' for flexibility
+    // Also support 'accessToken' for OAuth2
+    const key = config.apiKey || config.token || config.accessToken;
+    if (!key) {
+      throw new Error('API key, token, or accessToken is required');
+    }
+    this.apiKey = key;
+    this.apiSecret = config.apiSecret;
+    this.baseUrl = config.baseUrl || DEFAULT_BASE_URL;
+  }
+
+  private buildUrl(path: string, params?: Record<string, string | number | boolean | undefined>): string {
+    const url = new URL(`${this.baseUrl}${path}`);
+
+    if (params) {
+      Object.entries(params).forEach(([key, value]) => {
+        if (value !== undefined && value !== null && value !== '') {
+          url.searchParams.append(key, String(value));
+        }
+      });
+    }
+
+    return url.toString();
+  }
+
+  /**
+   * Sleep for a given number of milliseconds
+   */
+  private sleep(ms: number): Promise<void> {
+    return new Promise(resolve => setTimeout(resolve, ms));
+  }
+
+  /**
+   * Calculate delay for exponential backoff
+   */
+  private getRetryDelay(attempt: number, baseDelay: number = 1000): number {
+    // Exponential backoff with jitter: base * 2^attempt + random(0-1000)ms
+    return baseDelay * Math.pow(2, attempt) + Math.random() * 1000;
+  }
+
+  /**
+   * Check if error is retryable
+   */
+  private isRetryableStatus(status: number): boolean {
+    // Retry on rate limit (429) and server errors (5xx)
+    return status === 429 || (status >= 500 && status < 600);
+  }
+
+  /**
+   * Make an authenticated request to the API
+   * TODO: Adjust authentication method for your API:
+   * - Bearer token: Authorization: Bearer <token>
+   * - API Key header: X-API-Key: <key>
+   * - Basic auth: Authorization: Basic <base64(key:secret)>
+   */
+  async request<T>(path: string, options: RequestOptions = {}): Promise<T> {
+    const { method = 'GET', params, body, headers = {}, retries = 3, timeout = 30000 } = options;
+
+    const url = this.buildUrl(path, params);
+
+    // TODO: Adjust authentication header for your API
+    const requestHeaders: Record<string, string> = {
+      'Authorization': `Bearer ${this.apiKey}`,
+      'Accept': 'application/json',
+      ...headers,
+    };
+
+    if (body && ['POST', 'PUT', 'PATCH'].includes(method)) {
+      requestHeaders['Content-Type'] = 'application/json';
+    }
+
+    const fetchOptions: RequestInit = {
+      method,
+      headers: requestHeaders,
+    };
+
+    if (body && ['POST', 'PUT', 'PATCH'].includes(method)) {
+      fetchOptions.body = typeof body === 'string' ? body : JSON.stringify(body);
+    }
+
+    let lastError: Error | null = null;
+    let lastStatus: number = 0;
+
+    for (let attempt = 0; attempt <= retries; attempt++) {
+      try {
+        // Create abort controller for timeout
+        const controller = new AbortController();
+        const timeoutId = setTimeout(() => controller.abort(), timeout);
+
+        const response = await fetch(url, {
+          ...fetchOptions,
+          signal: controller.signal,
+        });
+
+        clearTimeout(timeoutId);
+        lastStatus = response.status;
+
+        // Handle 204 No Content
+        if (response.status === 204) {
+          return {} as T;
+        }
+
+        // Parse response
+        let data: unknown;
+        const contentType = response.headers.get('content-type') || '';
+
+        if (contentType.includes('application/json')) {
+          const text = await response.text();
+          if (text) {
+            try {
+              data = JSON.parse(text);
+            } catch {
+              data = text;
+            }
+          }
+        } else {
+          data = await response.text();
+        }
+
+        // Handle errors
+        if (!response.ok) {
+          // Check if we should retry
+          if (this.isRetryableStatus(response.status) && attempt < retries) {
+            // Check for Retry-After header
+            const retryAfter = response.headers.get('retry-after');
+            const delay = retryAfter
+              ? parseInt(retryAfter, 10) * 1000
+              : this.getRetryDelay(attempt);
+
+            await this.sleep(delay);
+            continue;
+          }
+
+          throw parseApiError(data, response.status);
+        }
+
+        return data as T;
+      } catch (err) {
+        lastError = err instanceof Error ? err : new Error(String(err));
+
+        // Handle timeout errors
+        if (lastError.name === 'AbortError') {
+          lastError = new Error(`Request timeout after ${timeout}ms`);
+        }
+
+        // Retry on network errors
+        if (attempt < retries && !(err instanceof ConnectorApiError)) {
+          await this.sleep(this.getRetryDelay(attempt));
+          continue;
+        }
+
+        throw err;
+      }
+    }
+
+    // Should not reach here, but just in case
+    throw lastError || new ConnectorApiError('Request failed', lastStatus);
+  }
+
+  async get<T>(path: string, params?: Record<string, string | number | boolean | undefined>): Promise<T> {
+    return this.request<T>(path, { method: 'GET', params });
+  }
+
+  async post<T>(path: string, body?: Record<string, unknown> | unknown[] | string | object, params?: Record<string, string | number | boolean | undefined>): Promise<T> {
+    return this.request<T>(path, { method: 'POST', body: body as Record<string, unknown>, params });
+  }
+
+  async put<T>(path: string, body?: Record<string, unknown> | object, params?: Record<string, string | number | boolean | undefined>): Promise<T> {
+    return this.request<T>(path, { method: 'PUT', body: body as Record<string, unknown>, params });
+  }
+
+  async patch<T>(path: string, body?: Record<string, unknown> | object, params?: Record<string, string | number | boolean | undefined>): Promise<T> {
+    return this.request<T>(path, { method: 'PATCH', body: body as Record<string, unknown>, params });
+  }
+
+  async delete<T>(path: string, params?: Record<string, string | number | boolean | undefined>): Promise<T> {
+    return this.request<T>(path, { method: 'DELETE', params });
+  }
+
+  /**
+   * Get a preview of the API key (for display/debugging)
+   */
+  getApiKeyPreview(): string {
+    if (this.apiKey.length > 10) {
+      return `${this.apiKey.substring(0, 6)}...${this.apiKey.substring(this.apiKey.length - 4)}`;
+    }
+    return '***';
+  }
+}

package/connectors/connect-phrase/src/api/example.ts

@@ -0,0 +1,48 @@
+import type { ConnectorClient } from './client';
+import type { ExampleResource, ExampleListResponse, ExampleCreateParams } from '../types';
+
+/**
+ * Example API module - demonstrates the pattern for API modules
+ * TODO: Replace with your actual API endpoints
+ */
+export class ExampleApi {
+  constructor(private readonly client: ConnectorClient) {}
+
+  /**
+   * List resources with optional pagination
+   */
+  async list(options?: { maxResults?: number; pageToken?: string }): Promise<ExampleListResponse> {
+    return this.client.get<ExampleListResponse>('/resources', {
+      max_results: options?.maxResults,
+      page_token: options?.pageToken,
+    });
+  }
+
+  /**
+   * Get a single resource by ID
+   */
+  async get(id: string): Promise<ExampleResource> {
+    return this.client.get<ExampleResource>(`/resources/${id}`);
+  }
+
+  /**
+   * Create a new resource
+   */
+  async create(params: ExampleCreateParams): Promise<ExampleResource> {
+    return this.client.post<ExampleResource>('/resources', params);
+  }
+
+  /**
+   * Update an existing resource
+   */
+  async update(id: string, params: Partial<ExampleCreateParams>): Promise<ExampleResource> {
+    return this.client.patch<ExampleResource>(`/resources/${id}`, params);
+  }
+
+  /**
+   * Delete a resource
+   */
+  async delete(id: string): Promise<void> {
+    await this.client.delete(`/resources/${id}`);
+  }
+}

package/connectors/connect-phrase/src/api/index.ts

@@ -0,0 +1,51 @@
+import type { ConnectorConfig } from '../types';
+import { ConnectorClient } from './client';
+import { ExampleApi } from './example';
+
+/**
+ * Main Connector class
+ * TODO: Rename to your API name (e.g., Perplexity, Twitter, etc.)
+ */
+export class Connector {
+  private readonly client: ConnectorClient;
+
+  // API modules - add more as needed
+  public readonly example: ExampleApi;
+
+  constructor(config: ConnectorConfig) {
+    this.client = new ConnectorClient(config);
+    this.example = new ExampleApi(this.client);
+  }
+
+  /**
+   * Create a client from environment variables
+   * TODO: Update env var names for your API
+   * Looks for CONNECTOR_API_KEY and optionally CONNECTOR_API_SECRET
+   */
+  static fromEnv(): Connector {
+    const apiKey = process.env.CONNECTOR_API_KEY;
+    const apiSecret = process.env.CONNECTOR_API_SECRET;
+
+    if (!apiKey) {
+      throw new Error('CONNECTOR_API_KEY environment variable is required');
+    }
+    return new Connector({ apiKey, apiSecret });
+  }
+
+  /**
+   * Get a preview of the API key (for debugging)
+   */
+  getApiKeyPreview(): string {
+    return this.client.getApiKeyPreview();
+  }
+
+  /**
+   * Get the underlying client for direct API access
+   */
+  getClient(): ConnectorClient {
+    return this.client;
+  }
+}
+
+export { ConnectorClient } from './client';
+export { ExampleApi } from './example';