@hasna/connectors 1.0.0 → 1.0.1

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

@@ -0,0 +1,272 @@
+// HelloSign (Dropbox Sign) Connector Types
+
+// ============================================
+// Configuration
+// ============================================
+
+export interface HelloSignConfig {
+  apiKey: string;
+  baseUrl?: string;
+}
+
+// ============================================
+// Common Types
+// ============================================
+
+export type OutputFormat = 'json' | 'pretty';
+
+// ============================================
+// Signature Request Types
+// ============================================
+
+export interface SignatureRequest {
+  signature_request_id: string;
+  title: string;
+  original_title: string;
+  subject: string;
+  message: string;
+  is_complete: boolean;
+  is_declined: boolean;
+  has_error: boolean;
+  custom_fields?: CustomField[];
+  response_data?: ResponseData[];
+  signing_url?: string;
+  signing_redirect_url?: string;
+  final_copy_uri?: string;
+  files_url?: string;
+  details_url?: string;
+  requester_email_address: string;
+  signatures: Signature[];
+  cc_email_addresses?: string[];
+  created_at: number;
+  expires_at?: number;
+}
+
+export interface Signature {
+  signature_id: string;
+  signer_email_address: string;
+  signer_name: string;
+  signer_role?: string;
+  order?: number;
+  status_code: string;
+  signed_at?: number;
+  last_viewed_at?: number;
+  last_reminded_at?: number;
+  has_pin: boolean;
+  has_sms_auth: boolean;
+  has_sms_delivery: boolean;
+  sms_phone_number?: string;
+  error?: string;
+}
+
+export interface CustomField {
+  name: string;
+  type: string;
+  value?: string;
+  required?: boolean;
+  editor?: string;
+}
+
+export interface ResponseData {
+  api_id: string;
+  signature_id: string;
+  name: string;
+  value: string;
+  required: boolean;
+  type: string;
+}
+
+export interface SignatureRequestListResponse {
+  signature_requests: SignatureRequest[];
+  list_info: ListInfo;
+}
+
+export interface ListInfo {
+  num_pages: number;
+  num_results: number;
+  page: number;
+  page_size: number;
+}
+
+// ============================================
+// Signer Types
+// ============================================
+
+export interface Signer {
+  email_address: string;
+  name: string;
+  role?: string;
+  order?: number;
+  pin?: string;
+  sms_phone_number?: string;
+  sms_phone_number_type?: 'authentication' | 'delivery';
+}
+
+// ============================================
+// Template Types
+// ============================================
+
+export interface Template {
+  template_id: string;
+  title: string;
+  message?: string;
+  signer_roles: SignerRole[];
+  cc_roles?: CcRole[];
+  documents?: TemplateDocument[];
+  custom_fields?: CustomField[];
+  named_form_fields?: NamedFormField[];
+  accounts?: Account[];
+  is_creator: boolean;
+  is_embedded: boolean;
+  can_edit: boolean;
+  is_locked: boolean;
+  metadata?: Record<string, string>;
+  created_at: number;
+  updated_at: number;
+}
+
+export interface SignerRole {
+  name: string;
+  order?: number;
+}
+
+export interface CcRole {
+  name: string;
+}
+
+export interface TemplateDocument {
+  name: string;
+  index: number;
+  field_groups?: FieldGroup[];
+  form_fields?: FormField[];
+  custom_fields?: CustomField[];
+}
+
+export interface FieldGroup {
+  name: string;
+  rule: string;
+}
+
+export interface FormField {
+  api_id: string;
+  name: string;
+  type: string;
+  x: number;
+  y: number;
+  width: number;
+  height: number;
+  required: boolean;
+  signer?: number;
+  page?: number;
+}
+
+export interface NamedFormField {
+  name: string;
+  type: string;
+  signer: string;
+  required: boolean;
+}
+
+export interface TemplateListResponse {
+  templates: Template[];
+  list_info: ListInfo;
+}
+
+// ============================================
+// Account Types
+// ============================================
+
+export interface Account {
+  account_id: string;
+  email_address: string;
+  is_locked: boolean;
+  is_paid_hs: boolean;
+  is_paid_hf: boolean;
+  quotas: AccountQuotas;
+  callback_url?: string;
+  role_code?: string;
+  locale?: string;
+}
+
+export interface AccountQuotas {
+  templates_total: number;
+  templates_left: number;
+  api_signature_requests_left: number;
+  documents_left: number;
+  sms_verifications_left: number;
+}
+
+// ============================================
+// Team Types
+// ============================================
+
+export interface Team {
+  name: string;
+  accounts: TeamAccount[];
+  invited_accounts?: TeamAccount[];
+}
+
+export interface TeamAccount {
+  account_id: string;
+  email_address: string;
+  role_code: string;
+}
+
+// ============================================
+// Create Signature Request Options
+// ============================================
+
+export interface CreateSignatureRequestOptions {
+  signers: Signer[];
+  title?: string;
+  subject?: string;
+  message?: string;
+  cc_email_addresses?: string[];
+  file_urls?: string[];
+  use_text_tags?: boolean;
+  hide_text_tags?: boolean;
+  metadata?: Record<string, string>;
+  signing_redirect_url?: string;
+  test_mode?: boolean;
+}
+
+export interface CreateFromTemplateOptions {
+  template_id: string;
+  signers: Array<{
+    email_address: string;
+    name: string;
+    role: string;
+  }>;
+  ccs?: Array<{
+    email_address: string;
+    role: string;
+  }>;
+  title?: string;
+  subject?: string;
+  message?: string;
+  signing_redirect_url?: string;
+  metadata?: Record<string, string>;
+  test_mode?: boolean;
+}
+
+// ============================================
+// API Error Types
+// ============================================
+
+export interface ApiErrorDetail {
+  code: string;
+  message: string;
+  field?: string;
+}
+
+export class HelloSignApiError extends Error {
+  public readonly statusCode: number;
+  public readonly errors?: ApiErrorDetail[];
+
+  constructor(message: string, statusCode: number, errors?: ApiErrorDetail[]) {
+    super(message);
+    this.name = 'HelloSignApiError';
+    this.statusCode = statusCode;
+    this.errors = errors;
+  }
+}

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

@@ -0,0 +1,103 @@
+import { existsSync, readFileSync, writeFileSync, mkdirSync, readdirSync, rmSync } from 'fs';
+import { homedir } from 'os';
+import { join } from 'path';
+
+const CONNECTOR_NAME = 'connect-hellosign';
+const DEFAULT_PROFILE = 'default';
+
+export interface ProfileConfig {
+  apiKey?: string;
+}
+
+let profileOverride: string | undefined;
+
+const CONFIG_DIR = join(homedir(), '.connect', CONNECTOR_NAME);
+const PROFILES_DIR = join(CONFIG_DIR, 'profiles');
+const CURRENT_PROFILE_FILE = join(CONFIG_DIR, 'current_profile');
+
+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`);
+}
+
+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 */ }
+  }
+  return DEFAULT_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);
+}
+
+export function profileExists(profile: string): boolean {
+  return existsSync(getProfilePath(profile));
+}
+
+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();
+}
+
+export function createProfile(profile: string, config: ProfileConfig = {}): boolean {
+  ensureConfigDir();
+  if (profileExists(profile)) return false;
+  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;
+}
+
+export function deleteProfile(profile: string): boolean {
+  if (profile === DEFAULT_PROFILE) return false;
+  if (!profileExists(profile)) return false;
+  if (getCurrentProfile() === profile) setCurrentProfile(DEFAULT_PROFILE);
+  rmSync(getProfilePath(profile));
+  return true;
+}
+
+export function loadProfile(profile?: string): ProfileConfig {
+  ensureConfigDir();
+  const profilePath = getProfilePath(profile || getCurrentProfile());
+  if (!existsSync(profilePath)) return {};
+  try { return JSON.parse(readFileSync(profilePath, 'utf-8')); } catch { return {}; }
+}
+
+export function saveProfile(config: ProfileConfig, profile?: string): void {
+  ensureConfigDir();
+  writeFileSync(getProfilePath(profile || getCurrentProfile()), JSON.stringify(config, null, 2));
+}
+
+export function getApiKey(): string | undefined {
+  return process.env.HELLOSIGN_API_KEY || loadProfile().apiKey;
+}
+
+export function setApiKey(apiKey: string): void {
+  const config = loadProfile();
+  config.apiKey = apiKey;
+  saveProfile(config);
+}
+
+export function clearConfig(): void { saveProfile({}); }
+export function getConfigDir(): string { return CONFIG_DIR; }
+export function getActiveProfileName(): string { return getCurrentProfile(); }

package/connectors/connect-hellosign/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-hellosign/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-helpscout/.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