@hasna/connectors 1.3.44 → 1.3.46

package/connectors/zotero/src/utils/config.ts

@@ -0,0 +1,245 @@
+import { existsSync, readFileSync, writeFileSync, mkdirSync, readdirSync, rmSync } from 'fs';
+import { homedir } from 'os';
+import { join } from 'path';
+import type { CliConfig, LibraryType } from '../types';
+
+const CONNECTOR_NAME = 'connect-zotero';
+const DEFAULT_PROFILE = 'default';
+const CURRENT_PROFILE_FILE = 'current_profile';
+const PROFILES_DIR = 'profiles';
+
+let profileOverride: string | undefined;
+
+const BASE_CONFIG_DIR = join(homedir(), '.hasna', 'connectors', CONNECTOR_NAME);
+
+export function setProfileOverride(profile: string | undefined): void {
+  profileOverride = profile;
+}
+
+export function getProfileOverride(): string | undefined {
+  return profileOverride;
+}
+
+function ensureBaseConfigDir(): void {
+  if (!existsSync(BASE_CONFIG_DIR)) {
+    mkdirSync(BASE_CONFIG_DIR, { recursive: true });
+  }
+}
+
+function getProfilesDir(): string {
+  return join(BASE_CONFIG_DIR, PROFILES_DIR);
+}
+
+function getCurrentProfileFile(): string {
+  return join(BASE_CONFIG_DIR, CURRENT_PROFILE_FILE);
+}
+
+export function getCurrentProfile(): string {
+  if (profileOverride) {
+    return profileOverride;
+  }
+
+  ensureBaseConfigDir();
+
+  const profilesDir = getProfilesDir();
+  if (!existsSync(profilesDir)) {
+    mkdirSync(profilesDir, { recursive: true });
+  }
+
+  const currentProfileFile = getCurrentProfileFile();
+  if (existsSync(currentProfileFile)) {
+    try {
+      const profile = readFileSync(currentProfileFile, 'utf-8').trim();
+      if (profile && profileExists(profile)) {
+        return profile;
+      }
+    } catch {
+      // Fall through to default
+    }
+  }
+
+  return DEFAULT_PROFILE;
+}
+
+export function setCurrentProfile(profile: string): void {
+  ensureBaseConfigDir();
+
+  if (!profileExists(profile) && profile !== DEFAULT_PROFILE) {
+    throw new Error(`Profile "${profile}" does not exist. Create it first with "profile create ${profile}"`);
+  }
+
+  writeFileSync(getCurrentProfileFile(), profile);
+}
+
+export function profileExists(profile: string): boolean {
+  const profileDir = join(getProfilesDir(), profile);
+  return existsSync(profileDir);
+}
+
+export function listProfiles(): string[] {
+  ensureBaseConfigDir();
+
+  const profilesDir = getProfilesDir();
+  if (!existsSync(profilesDir)) {
+    return [];
+  }
+
+  return readdirSync(profilesDir, { withFileTypes: true })
+    .filter(dirent => dirent.isDirectory())
+    .map(dirent => dirent.name)
+    .sort();
+}
+
+export function createProfile(profile: string): void {
+  ensureBaseConfigDir();
+
+  if (profileExists(profile)) {
+    throw new Error(`Profile "${profile}" already exists`);
+  }
+
+  if (!/^[a-zA-Z0-9_-]+$/.test(profile)) {
+    throw new Error('Profile name can only contain letters, numbers, hyphens, and underscores');
+  }
+
+  const profileDir = join(getProfilesDir(), profile);
+  mkdirSync(profileDir, { recursive: true });
+}
+
+export function deleteProfile(profile: string): void {
+  if (profile === DEFAULT_PROFILE) {
+    throw new Error('Cannot delete the default profile');
+  }
+
+  if (!profileExists(profile)) {
+    throw new Error(`Profile "${profile}" does not exist`);
+  }
+
+  const currentProfile = getCurrentProfile();
+  if (currentProfile === profile) {
+    setCurrentProfile(DEFAULT_PROFILE);
+  }
+
+  const profileDir = join(getProfilesDir(), profile);
+  rmSync(profileDir, { recursive: true });
+}
+
+function getProfileDir(): string {
+  ensureBaseConfigDir();
+
+  const profilesDir = getProfilesDir();
+  if (!existsSync(profilesDir)) {
+    mkdirSync(profilesDir, { recursive: true });
+  }
+
+  const profile = getCurrentProfile();
+  const profileDir = join(profilesDir, profile);
+
+  if (!existsSync(profileDir)) {
+    mkdirSync(profileDir, { recursive: true });
+  }
+
+  return profileDir;
+}
+
+export function getConfigDir(): string {
+  return getProfileDir();
+}
+
+export function getBaseConfigDir(): string {
+  return BASE_CONFIG_DIR;
+}
+
+export function ensureConfigDir(): void {
+  getProfileDir();
+}
+
+export function loadConfig(): CliConfig {
+  ensureConfigDir();
+  const configFile = join(getProfileDir(), 'config.json');
+
+  if (!existsSync(configFile)) {
+    return {};
+  }
+
+  try {
+    const content = readFileSync(configFile, 'utf-8');
+    return JSON.parse(content) as CliConfig;
+  } catch {
+    return {};
+  }
+}
+
+export function saveConfig(config: CliConfig): void {
+  ensureConfigDir();
+  const configFile = join(getProfileDir(), 'config.json');
+  writeFileSync(configFile, JSON.stringify(config, null, 2));
+}
+
+export function getApiKey(): string | undefined {
+  return process.env.ZOTERO_API_KEY || loadConfig().apiKey;
+}
+
+export function setApiKey(apiKey: string): void {
+  const config = loadConfig();
+  config.apiKey = apiKey;
+  saveConfig(config);
+}
+
+export function getLibraryId(): string | undefined {
+  return process.env.ZOTERO_LIBRARY_ID || loadConfig().libraryId;
+}
+
+export function setLibraryId(libraryId: string): void {
+  const config = loadConfig();
+  config.libraryId = libraryId;
+  saveConfig(config);
+}
+
+export function getLibraryType(): LibraryType {
+  const raw = process.env.ZOTERO_LIBRARY_TYPE || loadConfig().libraryType || 'users';
+  return raw === 'groups' || raw === 'group' ? 'groups' : 'users';
+}
+
+export function setLibraryType(libraryType: LibraryType | 'group'): void {
+  const config = loadConfig();
+  config.libraryType = libraryType;
+  saveConfig(config);
+}
+
+export function getBaseUrl(): string | undefined {
+  return process.env.ZOTERO_BASE_URL || loadConfig().baseUrl;
+}
+
+export function setBaseUrl(baseUrl: string): void {
+  const config = loadConfig();
+  config.baseUrl = baseUrl;
+  saveConfig(config);
+}
+
+export function clearConfig(): void {
+  saveConfig({});
+}
+
+export function isAuthenticated(): boolean {
+  const apiKey = getApiKey();
+  const libraryId = getLibraryId();
+  return Boolean(apiKey && libraryId);
+}
+
+export function getActiveProfileName(): string {
+  return getCurrentProfile();
+}
+
+export function getZoteroConfigFromEnv(): {
+  apiKey?: string;
+  libraryId?: string;
+  libraryType: LibraryType;
+  baseUrl?: string;
+} {
+  return {
+    apiKey: getApiKey(),
+    libraryId: getLibraryId(),
+    libraryType: getLibraryType(),
+    baseUrl: getBaseUrl(),
+  };
+}

package/connectors/zotero/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('OK'), message);
+}
+
+export function error(message: string): void {
+  console.error(chalk.red('Error:'), message);
+}
+
+export function warn(message: string): void {
+  console.warn(chalk.yellow('Warning:'), message);
+}
+
+export function info(message: string): void {
+  console.log(chalk.blue('Info:'), 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/zotero/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/zymbly/.env.example

@@ -0,0 +1,2 @@
+ZYMBLY_API_KEY=REPLACE_ME
+ZYMBLY_BASE_URL=https://api.zymbly.com/v1

package/connectors/zymbly/AGENTS.md

@@ -0,0 +1,11 @@
+# Zymbly Connector
+
+Follow the repository root agent instructions. This connector uses the Zymbly REST API and must not add browser automation dependencies.
+
+## Checks
+
+```bash
+bun run typecheck
+bun test
+bun run ./src/cli/index.ts --help
+```

package/connectors/zymbly/CLAUDE.md

@@ -0,0 +1,5 @@
+# Zymbly Connector
+
+This package implements a first-class Zymbly aircraft maintenance REST API connector.
+
+Do not commit real Zymbly API keys. Use `ZYMBLY_API_KEY`.

package/connectors/zymbly/README.md

@@ -0,0 +1,35 @@
+# @hasna/connect-zymbly
+
+Zymbly REST API connector for aircraft maintenance work orders, parts search, maintenance notes, and scoped raw API calls.
+
+This package was rebuilt from the public Zymbly API contract and open-connectors patterns. It is not a copy of internal platform code.
+
+## Configure
+
+```bash
+export ZYMBLY_API_KEY=REPLACE_ME
+export ZYMBLY_BASE_URL=https://api.zymbly.com/v1
+```
+
+## CLI
+
+```bash
+bun run ./src/cli/index.ts work-orders list --query '{"status":"open","limit":25}'
+bun run ./src/cli/index.ts work-orders get WO-123
+bun run ./src/cli/index.ts parts search --query '{"q":"brake pad"}'
+bun run ./src/cli/index.ts notes create WO-123 --note "Completed 100-hour inspection"
+bun run ./src/cli/index.ts raw GET /aircraft/N12345/inspections
+```
+
+## Programmatic Usage
+
+```ts
+import { ZymblyClient } from "@hasna/connect-zymbly";
+
+const client = new ZymblyClient({ apiKey: process.env.ZYMBLY_API_KEY });
+await client.listWorkOrders({ status: "open" });
+```
+
+## Security
+
+Do not commit real Zymbly API keys. Use placeholder values in `.env.example` only.

package/connectors/zymbly/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@hasna/connect-zymbly",
+  "version": "0.0.1",
+  "description": "Zymbly aircraft maintenance API connector for work orders, parts search, maintenance notes, and raw API calls",
+  "type": "module",
+  "bin": {
+    "connect-zymbly": "./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",
+    "test": "bun test",
+    "prepublishOnly": "bun run build"
+  },
+  "keywords": [
+    "zymbly",
+    "aircraft",
+    "maintenance",
+    "cmms",
+    "work-orders",
+    "aviation",
+    "connector",
+    "cli",
+    "typescript",
+    "bun"
+  ],
+  "author": "Hasna",
+  "license": "Apache-2.0",
+  "devDependencies": {
+    "@types/bun": "latest",
+    "typescript": "^5"
+  },
+  "dependencies": {
+    "commander": "^12.1.0"
+  },
+  "engines": {
+    "bun": ">=1.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/hasna/open-connectors.git"
+  }
+}

package/connectors/zymbly/src/api/client.test.ts

@@ -0,0 +1,110 @@
+import { afterEach, beforeEach, describe, expect, mock, test } from "bun:test";
+import { ZymblyClient, ZymblyApiError } from "../index";
+
+const originalFetch = globalThis.fetch;
+let fetchMock: ReturnType<typeof mock>;
+
+function mockJsonResponse(body: unknown, init: ResponseInit = {}) {
+  return new Response(JSON.stringify(body), {
+    status: init.status ?? 200,
+    headers: { "content-type": "application/json", ...init.headers },
+  });
+}
+
+function client() {
+  return new ZymblyClient({
+    apiKey: "test-api-key",
+    baseUrl: "https://api.zymbly.com/v1",
+  });
+}
+
+beforeEach(() => {
+  fetchMock = mock(async () => mockJsonResponse({ ok: true }));
+  globalThis.fetch = fetchMock as unknown as typeof fetch;
+});
+
+afterEach(() => {
+  globalThis.fetch = originalFetch;
+});
+
+describe("ZymblyClient", () => {
+  test("lists work orders with bearer auth and query params", async () => {
+    const api = client();
+
+    await api.listWorkOrders({ status: "open", limit: 25 });
+
+    expect(fetchMock).toHaveBeenCalledTimes(1);
+    const [url, init] = fetchMock.mock.calls[0] as [string, RequestInit];
+    expect(url).toBe("https://api.zymbly.com/v1/work-orders?status=open&limit=25");
+    expect(init.method).toBe("GET");
+    expect((init.headers as Record<string, string>).Authorization).toBe("Bearer test-api-key");
+  });
+
+  test("gets a work order with URL-encoded id", async () => {
+    const api = client();
+
+    await api.getWorkOrder("WO/2026-01");
+
+    const [url] = fetchMock.mock.calls[0] as [string, RequestInit];
+    expect(url).toBe("https://api.zymbly.com/v1/work-orders/WO%2F2026-01");
+  });
+
+  test("searches parts with query passthrough", async () => {
+    const api = client();
+
+    await api.searchParts({ q: "brake pad", aircraft: "N12345" });
+
+    const [url] = fetchMock.mock.calls[0] as [string, RequestInit];
+    expect(url).toBe("https://api.zymbly.com/v1/parts?q=brake+pad&aircraft=N12345");
+  });
+
+  test("creates a maintenance note with note body field", async () => {
+    const api = client();
+
+    await api.createMaintenanceNote("wo-42", "Replaced left main tire");
+
+    const [url, init] = fetchMock.mock.calls[0] as [string, RequestInit];
+    expect(url).toBe("https://api.zymbly.com/v1/work-orders/wo-42/notes");
+    expect(init.method).toBe("POST");
+    expect(init.body).toBe(JSON.stringify({ note: "Replaced left main tire" }));
+  });
+
+  test("supports raw relative API paths", async () => {
+    const api = client();
+
+    await api.rawRequest("GET", "/aircraft/N12345/inspections");
+
+    const [url, init] = fetchMock.mock.calls[0] as [string, RequestInit];
+    expect(url).toBe("https://api.zymbly.com/v1/aircraft/N12345/inspections");
+    expect(init.method).toBe("GET");
+  });
+
+  test("rejects absolute URLs and path traversal in raw requests", async () => {
+    const api = client();
+
+    expect(() => api.rawRequest("GET", "https://evil.example/v1/work-orders")).toThrow(
+      "Zymbly API paths must be relative",
+    );
+    expect(() => api.rawRequest("GET", "/work-orders/../secrets")).toThrow(
+      "parent-directory segments",
+    );
+    expect(fetchMock).not.toHaveBeenCalled();
+  });
+
+  test("surfaces API error messages", async () => {
+    fetchMock = mock(async () =>
+      mockJsonResponse({ message: "invalid api key" }, { status: 401 }),
+    );
+    globalThis.fetch = fetchMock as unknown as typeof fetch;
+
+    await expect(client().listWorkOrders()).rejects.toThrow(ZymblyApiError);
+    await expect(client().listWorkOrders()).rejects.toThrow("invalid api key");
+  });
+
+  test("requires API key before sending requests", async () => {
+    const api = new ZymblyClient({ apiKey: "" });
+
+    await expect(api.listWorkOrders()).rejects.toThrow("Zymbly API key is required");
+    expect(fetchMock).not.toHaveBeenCalled();
+  });
+});