@hasna/connectors 0.3.16 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/bin/index.js +71 -1
- package/bin/mcp.js +71 -1
- package/bin/serve.js +70 -0
- package/connectors/connect-asana/.env.example +11 -0
- package/connectors/connect-asana/CLAUDE.md +128 -0
- package/connectors/connect-asana/README.md +193 -0
- package/connectors/connect-asana/package.json +52 -0
- package/connectors/connect-asana/src/api/client.ts +119 -0
- package/connectors/connect-asana/src/api/index.ts +319 -0
- package/connectors/connect-asana/src/cli/index.ts +731 -0
- package/connectors/connect-asana/src/index.ts +19 -0
- package/connectors/connect-asana/src/types/index.ts +270 -0
- package/connectors/connect-asana/src/utils/config.ts +171 -0
- package/connectors/connect-asana/src/utils/output.ts +119 -0
- package/connectors/connect-asana/tsconfig.json +16 -0
- package/connectors/connect-clickup/.env.example +11 -0
- package/connectors/connect-clickup/CLAUDE.md +128 -0
- package/connectors/connect-clickup/README.md +193 -0
- package/connectors/connect-clickup/package.json +52 -0
- package/connectors/connect-clickup/src/api/client.ts +116 -0
- package/connectors/connect-clickup/src/api/index.ts +400 -0
- package/connectors/connect-clickup/src/cli/index.ts +625 -0
- package/connectors/connect-clickup/src/index.ts +19 -0
- package/connectors/connect-clickup/src/types/index.ts +591 -0
- package/connectors/connect-clickup/src/utils/config.ts +157 -0
- package/connectors/connect-clickup/src/utils/output.ts +119 -0
- package/connectors/connect-clickup/tsconfig.json +16 -0
- package/connectors/connect-confluence/.env.example +11 -0
- package/connectors/connect-confluence/CLAUDE.md +272 -0
- package/connectors/connect-confluence/README.md +193 -0
- package/connectors/connect-confluence/package.json +53 -0
- package/connectors/connect-confluence/scripts/release.ts +179 -0
- package/connectors/connect-confluence/src/api/client.ts +213 -0
- package/connectors/connect-confluence/src/api/example.ts +48 -0
- package/connectors/connect-confluence/src/api/index.ts +51 -0
- package/connectors/connect-confluence/src/cli/index.ts +254 -0
- package/connectors/connect-confluence/src/index.ts +103 -0
- package/connectors/connect-confluence/src/types/index.ts +237 -0
- package/connectors/connect-confluence/src/utils/auth.ts +274 -0
- package/connectors/connect-confluence/src/utils/bulk.ts +212 -0
- package/connectors/connect-confluence/src/utils/config.ts +326 -0
- package/connectors/connect-confluence/src/utils/output.ts +175 -0
- package/connectors/connect-confluence/src/utils/settings.ts +114 -0
- package/connectors/connect-confluence/src/utils/storage.ts +198 -0
- package/connectors/connect-confluence/tsconfig.json +16 -0
- package/connectors/connect-jira/.env.example +11 -0
- package/connectors/connect-jira/CLAUDE.md +128 -0
- package/connectors/connect-jira/README.md +193 -0
- package/connectors/connect-jira/package.json +53 -0
- package/connectors/connect-jira/src/api/client.ts +131 -0
- package/connectors/connect-jira/src/api/index.ts +266 -0
- package/connectors/connect-jira/src/cli/index.ts +653 -0
- package/connectors/connect-jira/src/index.ts +23 -0
- package/connectors/connect-jira/src/types/index.ts +448 -0
- package/connectors/connect-jira/src/utils/config.ts +179 -0
- package/connectors/connect-jira/src/utils/output.ts +119 -0
- package/connectors/connect-jira/tsconfig.json +16 -0
- package/connectors/connect-linear/CLAUDE.md +88 -0
- package/connectors/connect-linear/README.md +201 -0
- package/connectors/connect-linear/package.json +45 -0
- package/connectors/connect-linear/src/api/client.ts +62 -0
- package/connectors/connect-linear/src/api/index.ts +46 -0
- package/connectors/connect-linear/src/api/issues.ts +247 -0
- package/connectors/connect-linear/src/api/projects.ts +179 -0
- package/connectors/connect-linear/src/api/teams.ts +125 -0
- package/connectors/connect-linear/src/api/users.ts +112 -0
- package/connectors/connect-linear/src/cli/index.ts +560 -0
- package/connectors/connect-linear/src/index.ts +27 -0
- package/connectors/connect-linear/src/types/index.ts +275 -0
- package/connectors/connect-linear/src/utils/config.ts +249 -0
- package/connectors/connect-linear/src/utils/output.ts +119 -0
- package/connectors/connect-linear/tsconfig.json +16 -0
- package/connectors/connect-slack/.env.example +7 -0
- package/connectors/connect-slack/CLAUDE.md +69 -0
- package/connectors/connect-slack/README.md +150 -0
- package/connectors/connect-slack/package.json +44 -0
- package/connectors/connect-slack/src/api/channels.ts +112 -0
- package/connectors/connect-slack/src/api/client.ts +97 -0
- package/connectors/connect-slack/src/api/index.ts +42 -0
- package/connectors/connect-slack/src/api/messages.ts +127 -0
- package/connectors/connect-slack/src/api/users.ts +110 -0
- package/connectors/connect-slack/src/cli/index.ts +494 -0
- package/connectors/connect-slack/src/index.ts +21 -0
- package/connectors/connect-slack/src/types/index.ts +263 -0
- package/connectors/connect-slack/src/utils/config.ts +297 -0
- package/connectors/connect-slack/src/utils/output.ts +119 -0
- package/connectors/connect-slack/tsconfig.json +16 -0
- package/connectors/connect-telegram/.env.example +2 -0
- package/connectors/connect-telegram/package.json +49 -0
- package/connectors/connect-todoist/.env.example +11 -0
- package/connectors/connect-todoist/CLAUDE.md +104 -0
- package/connectors/connect-todoist/README.md +193 -0
- package/connectors/connect-todoist/package.json +52 -0
- package/connectors/connect-todoist/src/api/client.ts +117 -0
- package/connectors/connect-todoist/src/api/index.ts +188 -0
- package/connectors/connect-todoist/src/cli/index.ts +990 -0
- package/connectors/connect-todoist/src/index.ts +21 -0
- package/connectors/connect-todoist/src/types/index.ts +240 -0
- package/connectors/connect-todoist/src/utils/config.ts +157 -0
- package/connectors/connect-todoist/src/utils/output.ts +119 -0
- package/connectors/connect-todoist/tsconfig.json +16 -0
- package/connectors/connect-trello/.env.example +11 -0
- package/connectors/connect-trello/CLAUDE.md +128 -0
- package/connectors/connect-trello/README.md +193 -0
- package/connectors/connect-trello/package.json +53 -0
- package/connectors/connect-trello/src/api/client.ts +128 -0
- package/connectors/connect-trello/src/api/index.ts +278 -0
- package/connectors/connect-trello/src/cli/index.ts +737 -0
- package/connectors/connect-trello/src/index.ts +21 -0
- package/connectors/connect-trello/src/types/index.ts +314 -0
- package/connectors/connect-trello/src/utils/config.ts +182 -0
- package/connectors/connect-trello/src/utils/output.ts +119 -0
- package/connectors/connect-trello/tsconfig.json +16 -0
- package/connectors/connect-whatsapp/.env.example +11 -0
- package/connectors/connect-whatsapp/CLAUDE.md +113 -0
- package/connectors/connect-whatsapp/README.md +193 -0
- package/connectors/connect-whatsapp/package.json +53 -0
- package/connectors/connect-whatsapp/src/api/client.ts +133 -0
- package/connectors/connect-whatsapp/src/api/index.ts +365 -0
- package/connectors/connect-whatsapp/src/cli/index.ts +686 -0
- package/connectors/connect-whatsapp/src/index.ts +25 -0
- package/connectors/connect-whatsapp/src/types/index.ts +502 -0
- package/connectors/connect-whatsapp/src/utils/config.ts +179 -0
- package/connectors/connect-whatsapp/src/utils/output.ts +119 -0
- package/connectors/connect-whatsapp/tsconfig.json +16 -0
- package/dist/index.js +70 -0
- package/package.json +1 -1
package/bin/index.js
CHANGED
|
@@ -2353,6 +2353,76 @@ var init_registry = __esm(() => {
|
|
|
2353
2353
|
description: "Twitter/X advertising",
|
|
2354
2354
|
category: "Advertising",
|
|
2355
2355
|
tags: ["ads", "twitter"]
|
|
2356
|
+
},
|
|
2357
|
+
{
|
|
2358
|
+
name: "linear",
|
|
2359
|
+
displayName: "Linear",
|
|
2360
|
+
description: "Issue tracking and project management",
|
|
2361
|
+
category: "Business Tools",
|
|
2362
|
+
tags: ["issues", "project-management"]
|
|
2363
|
+
},
|
|
2364
|
+
{
|
|
2365
|
+
name: "jira",
|
|
2366
|
+
displayName: "Jira",
|
|
2367
|
+
description: "Issue tracking, projects, and agile boards",
|
|
2368
|
+
category: "Business Tools",
|
|
2369
|
+
tags: ["issues", "project-management", "agile"]
|
|
2370
|
+
},
|
|
2371
|
+
{
|
|
2372
|
+
name: "confluence",
|
|
2373
|
+
displayName: "Confluence",
|
|
2374
|
+
description: "Pages, spaces, and content management",
|
|
2375
|
+
category: "Business Tools",
|
|
2376
|
+
tags: ["wiki", "documentation"]
|
|
2377
|
+
},
|
|
2378
|
+
{
|
|
2379
|
+
name: "asana",
|
|
2380
|
+
displayName: "Asana",
|
|
2381
|
+
description: "Projects, tasks, and team workflows",
|
|
2382
|
+
category: "Business Tools",
|
|
2383
|
+
tags: ["tasks", "project-management"]
|
|
2384
|
+
},
|
|
2385
|
+
{
|
|
2386
|
+
name: "trello",
|
|
2387
|
+
displayName: "Trello",
|
|
2388
|
+
description: "Boards, lists, and cards",
|
|
2389
|
+
category: "Business Tools",
|
|
2390
|
+
tags: ["kanban", "project-management"]
|
|
2391
|
+
},
|
|
2392
|
+
{
|
|
2393
|
+
name: "clickup",
|
|
2394
|
+
displayName: "ClickUp",
|
|
2395
|
+
description: "Tasks, docs, and project management",
|
|
2396
|
+
category: "Business Tools",
|
|
2397
|
+
tags: ["tasks", "project-management"]
|
|
2398
|
+
},
|
|
2399
|
+
{
|
|
2400
|
+
name: "todoist",
|
|
2401
|
+
displayName: "Todoist",
|
|
2402
|
+
description: "Task management and to-do lists",
|
|
2403
|
+
category: "Business Tools",
|
|
2404
|
+
tags: ["tasks", "todo"]
|
|
2405
|
+
},
|
|
2406
|
+
{
|
|
2407
|
+
name: "slack",
|
|
2408
|
+
displayName: "Slack",
|
|
2409
|
+
description: "Channels, messages, and workspace management",
|
|
2410
|
+
category: "Communication",
|
|
2411
|
+
tags: ["chat", "messaging", "workspace"]
|
|
2412
|
+
},
|
|
2413
|
+
{
|
|
2414
|
+
name: "telegram",
|
|
2415
|
+
displayName: "Telegram",
|
|
2416
|
+
description: "Bot API for messages, chats, and updates",
|
|
2417
|
+
category: "Communication",
|
|
2418
|
+
tags: ["chat", "bot", "messaging"]
|
|
2419
|
+
},
|
|
2420
|
+
{
|
|
2421
|
+
name: "whatsapp",
|
|
2422
|
+
displayName: "WhatsApp",
|
|
2423
|
+
description: "Business Cloud API for messages and templates",
|
|
2424
|
+
category: "Communication",
|
|
2425
|
+
tags: ["messaging", "business"]
|
|
2356
2426
|
}
|
|
2357
2427
|
];
|
|
2358
2428
|
});
|
|
@@ -6833,7 +6903,7 @@ var PRESETS = {
|
|
|
6833
6903
|
commerce: { description: "Commerce and finance", connectors: ["stripe", "shopify", "revolut", "mercury", "pandadoc"] }
|
|
6834
6904
|
};
|
|
6835
6905
|
var program2 = new Command;
|
|
6836
|
-
program2.name("connectors").description("Install API connectors for your project").version("0.
|
|
6906
|
+
program2.name("connectors").description("Install API connectors for your project").version("0.4.0").enablePositionalOptions();
|
|
6837
6907
|
program2.command("interactive", { isDefault: true }).alias("i").description("Interactive connector browser").action(() => {
|
|
6838
6908
|
if (!isTTY) {
|
|
6839
6909
|
console.log(`Non-interactive environment detected. Use a subcommand:
|
package/bin/mcp.js
CHANGED
|
@@ -19841,6 +19841,76 @@ var CONNECTORS = [
|
|
|
19841
19841
|
description: "Twitter/X advertising",
|
|
19842
19842
|
category: "Advertising",
|
|
19843
19843
|
tags: ["ads", "twitter"]
|
|
19844
|
+
},
|
|
19845
|
+
{
|
|
19846
|
+
name: "linear",
|
|
19847
|
+
displayName: "Linear",
|
|
19848
|
+
description: "Issue tracking and project management",
|
|
19849
|
+
category: "Business Tools",
|
|
19850
|
+
tags: ["issues", "project-management"]
|
|
19851
|
+
},
|
|
19852
|
+
{
|
|
19853
|
+
name: "jira",
|
|
19854
|
+
displayName: "Jira",
|
|
19855
|
+
description: "Issue tracking, projects, and agile boards",
|
|
19856
|
+
category: "Business Tools",
|
|
19857
|
+
tags: ["issues", "project-management", "agile"]
|
|
19858
|
+
},
|
|
19859
|
+
{
|
|
19860
|
+
name: "confluence",
|
|
19861
|
+
displayName: "Confluence",
|
|
19862
|
+
description: "Pages, spaces, and content management",
|
|
19863
|
+
category: "Business Tools",
|
|
19864
|
+
tags: ["wiki", "documentation"]
|
|
19865
|
+
},
|
|
19866
|
+
{
|
|
19867
|
+
name: "asana",
|
|
19868
|
+
displayName: "Asana",
|
|
19869
|
+
description: "Projects, tasks, and team workflows",
|
|
19870
|
+
category: "Business Tools",
|
|
19871
|
+
tags: ["tasks", "project-management"]
|
|
19872
|
+
},
|
|
19873
|
+
{
|
|
19874
|
+
name: "trello",
|
|
19875
|
+
displayName: "Trello",
|
|
19876
|
+
description: "Boards, lists, and cards",
|
|
19877
|
+
category: "Business Tools",
|
|
19878
|
+
tags: ["kanban", "project-management"]
|
|
19879
|
+
},
|
|
19880
|
+
{
|
|
19881
|
+
name: "clickup",
|
|
19882
|
+
displayName: "ClickUp",
|
|
19883
|
+
description: "Tasks, docs, and project management",
|
|
19884
|
+
category: "Business Tools",
|
|
19885
|
+
tags: ["tasks", "project-management"]
|
|
19886
|
+
},
|
|
19887
|
+
{
|
|
19888
|
+
name: "todoist",
|
|
19889
|
+
displayName: "Todoist",
|
|
19890
|
+
description: "Task management and to-do lists",
|
|
19891
|
+
category: "Business Tools",
|
|
19892
|
+
tags: ["tasks", "todo"]
|
|
19893
|
+
},
|
|
19894
|
+
{
|
|
19895
|
+
name: "slack",
|
|
19896
|
+
displayName: "Slack",
|
|
19897
|
+
description: "Channels, messages, and workspace management",
|
|
19898
|
+
category: "Communication",
|
|
19899
|
+
tags: ["chat", "messaging", "workspace"]
|
|
19900
|
+
},
|
|
19901
|
+
{
|
|
19902
|
+
name: "telegram",
|
|
19903
|
+
displayName: "Telegram",
|
|
19904
|
+
description: "Bot API for messages, chats, and updates",
|
|
19905
|
+
category: "Communication",
|
|
19906
|
+
tags: ["chat", "bot", "messaging"]
|
|
19907
|
+
},
|
|
19908
|
+
{
|
|
19909
|
+
name: "whatsapp",
|
|
19910
|
+
displayName: "WhatsApp",
|
|
19911
|
+
description: "Business Cloud API for messages and templates",
|
|
19912
|
+
category: "Communication",
|
|
19913
|
+
tags: ["messaging", "business"]
|
|
19844
19914
|
}
|
|
19845
19915
|
];
|
|
19846
19916
|
function getConnectorsByCategory(category) {
|
|
@@ -20315,7 +20385,7 @@ async function getConnectorCommandHelp(name, command) {
|
|
|
20315
20385
|
loadConnectorVersions();
|
|
20316
20386
|
var server = new McpServer({
|
|
20317
20387
|
name: "connectors",
|
|
20318
|
-
version: "0.
|
|
20388
|
+
version: "0.4.0"
|
|
20319
20389
|
});
|
|
20320
20390
|
server.registerTool("search_connectors", {
|
|
20321
20391
|
title: "Search Connectors",
|
package/bin/serve.js
CHANGED
|
@@ -446,6 +446,76 @@ var CONNECTORS = [
|
|
|
446
446
|
description: "Twitter/X advertising",
|
|
447
447
|
category: "Advertising",
|
|
448
448
|
tags: ["ads", "twitter"]
|
|
449
|
+
},
|
|
450
|
+
{
|
|
451
|
+
name: "linear",
|
|
452
|
+
displayName: "Linear",
|
|
453
|
+
description: "Issue tracking and project management",
|
|
454
|
+
category: "Business Tools",
|
|
455
|
+
tags: ["issues", "project-management"]
|
|
456
|
+
},
|
|
457
|
+
{
|
|
458
|
+
name: "jira",
|
|
459
|
+
displayName: "Jira",
|
|
460
|
+
description: "Issue tracking, projects, and agile boards",
|
|
461
|
+
category: "Business Tools",
|
|
462
|
+
tags: ["issues", "project-management", "agile"]
|
|
463
|
+
},
|
|
464
|
+
{
|
|
465
|
+
name: "confluence",
|
|
466
|
+
displayName: "Confluence",
|
|
467
|
+
description: "Pages, spaces, and content management",
|
|
468
|
+
category: "Business Tools",
|
|
469
|
+
tags: ["wiki", "documentation"]
|
|
470
|
+
},
|
|
471
|
+
{
|
|
472
|
+
name: "asana",
|
|
473
|
+
displayName: "Asana",
|
|
474
|
+
description: "Projects, tasks, and team workflows",
|
|
475
|
+
category: "Business Tools",
|
|
476
|
+
tags: ["tasks", "project-management"]
|
|
477
|
+
},
|
|
478
|
+
{
|
|
479
|
+
name: "trello",
|
|
480
|
+
displayName: "Trello",
|
|
481
|
+
description: "Boards, lists, and cards",
|
|
482
|
+
category: "Business Tools",
|
|
483
|
+
tags: ["kanban", "project-management"]
|
|
484
|
+
},
|
|
485
|
+
{
|
|
486
|
+
name: "clickup",
|
|
487
|
+
displayName: "ClickUp",
|
|
488
|
+
description: "Tasks, docs, and project management",
|
|
489
|
+
category: "Business Tools",
|
|
490
|
+
tags: ["tasks", "project-management"]
|
|
491
|
+
},
|
|
492
|
+
{
|
|
493
|
+
name: "todoist",
|
|
494
|
+
displayName: "Todoist",
|
|
495
|
+
description: "Task management and to-do lists",
|
|
496
|
+
category: "Business Tools",
|
|
497
|
+
tags: ["tasks", "todo"]
|
|
498
|
+
},
|
|
499
|
+
{
|
|
500
|
+
name: "slack",
|
|
501
|
+
displayName: "Slack",
|
|
502
|
+
description: "Channels, messages, and workspace management",
|
|
503
|
+
category: "Communication",
|
|
504
|
+
tags: ["chat", "messaging", "workspace"]
|
|
505
|
+
},
|
|
506
|
+
{
|
|
507
|
+
name: "telegram",
|
|
508
|
+
displayName: "Telegram",
|
|
509
|
+
description: "Bot API for messages, chats, and updates",
|
|
510
|
+
category: "Communication",
|
|
511
|
+
tags: ["chat", "bot", "messaging"]
|
|
512
|
+
},
|
|
513
|
+
{
|
|
514
|
+
name: "whatsapp",
|
|
515
|
+
displayName: "WhatsApp",
|
|
516
|
+
description: "Business Cloud API for messages and templates",
|
|
517
|
+
category: "Communication",
|
|
518
|
+
tags: ["messaging", "business"]
|
|
449
519
|
}
|
|
450
520
|
];
|
|
451
521
|
function getConnector(name) {
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# API Credentials
|
|
2
|
+
# TODO: Update variable names and instructions for your API
|
|
3
|
+
# Example: PERPLEXITY_API_KEY, OPENAI_API_KEY, etc.
|
|
4
|
+
|
|
5
|
+
CONNECTOR_API_KEY=your-api-key-here
|
|
6
|
+
|
|
7
|
+
# Optional: API secret (if your API requires it)
|
|
8
|
+
# CONNECTOR_API_SECRET=your-api-secret-here
|
|
9
|
+
|
|
10
|
+
# Optional: Custom base URL (if needed)
|
|
11
|
+
# CONNECTOR_BASE_URL=https://api.example.com
|
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
# CLAUDE.md
|
|
2
|
+
|
|
3
|
+
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
|
|
4
|
+
|
|
5
|
+
## Project Overview
|
|
6
|
+
|
|
7
|
+
scaffold-connector is a TypeScript template for building API connector CLIs. It provides multi-profile configuration, Bearer token authentication (customizable), and a clean CLI structure using Commander.js.
|
|
8
|
+
|
|
9
|
+
**This is a SCAFFOLD** - meant to be cloned and customized for specific APIs.
|
|
10
|
+
|
|
11
|
+
## Build & Run Commands
|
|
12
|
+
|
|
13
|
+
```bash
|
|
14
|
+
# Install dependencies
|
|
15
|
+
bun install
|
|
16
|
+
|
|
17
|
+
# Run CLI in development
|
|
18
|
+
bun run dev
|
|
19
|
+
|
|
20
|
+
# Build for distribution
|
|
21
|
+
bun run build
|
|
22
|
+
|
|
23
|
+
# Type check
|
|
24
|
+
bun run typecheck
|
|
25
|
+
|
|
26
|
+
# Run specific commands
|
|
27
|
+
bun run dev profile list
|
|
28
|
+
bun run dev config show
|
|
29
|
+
bun run dev example list
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
## Code Style
|
|
33
|
+
|
|
34
|
+
- TypeScript with strict mode
|
|
35
|
+
- ESM modules (type: module)
|
|
36
|
+
- Use async/await for all async operations
|
|
37
|
+
- Minimal dependencies: commander, chalk only
|
|
38
|
+
- Type annotations required everywhere
|
|
39
|
+
- Use interfaces for all API types
|
|
40
|
+
|
|
41
|
+
## Project Structure
|
|
42
|
+
|
|
43
|
+
```
|
|
44
|
+
src/
|
|
45
|
+
├── api/
|
|
46
|
+
│ ├── client.ts # HTTP client with authentication
|
|
47
|
+
│ ├── example.ts # Example API module (template)
|
|
48
|
+
│ └── index.ts # Main connector class
|
|
49
|
+
├── cli/
|
|
50
|
+
│ └── index.ts # CLI commands
|
|
51
|
+
├── types/
|
|
52
|
+
│ └── index.ts # Type definitions
|
|
53
|
+
├── utils/
|
|
54
|
+
│ ├── config.ts # Multi-profile configuration
|
|
55
|
+
│ └── output.ts # CLI output formatting
|
|
56
|
+
└── index.ts # Library exports
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
## Key Patterns
|
|
60
|
+
|
|
61
|
+
### Multi-Profile Configuration
|
|
62
|
+
|
|
63
|
+
Profiles stored in `~/.connect/{connector-name}/profiles/`:
|
|
64
|
+
- Each profile is a separate JSON file
|
|
65
|
+
- `current_profile` file tracks active profile
|
|
66
|
+
- `--profile` flag overrides for single command
|
|
67
|
+
- Environment variables override profile config
|
|
68
|
+
|
|
69
|
+
### Authentication
|
|
70
|
+
|
|
71
|
+
Default is Bearer token in `src/api/client.ts`:
|
|
72
|
+
```typescript
|
|
73
|
+
'Authorization': `Bearer ${this.apiKey}`,
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
Customize for different auth methods:
|
|
77
|
+
- API Key header: `'X-API-Key': this.apiKey`
|
|
78
|
+
- Basic auth: `'Authorization': 'Basic ' + base64(key:secret)`
|
|
79
|
+
- OAuth: Add token refresh logic
|
|
80
|
+
|
|
81
|
+
### Adding New API Modules
|
|
82
|
+
|
|
83
|
+
1. Create file in `src/api/` following `example.ts` pattern
|
|
84
|
+
2. Add to exports in `src/api/index.ts`
|
|
85
|
+
3. Add types in `src/types/index.ts`
|
|
86
|
+
4. Add CLI commands in `src/cli/index.ts`
|
|
87
|
+
|
|
88
|
+
## TODO Markers
|
|
89
|
+
|
|
90
|
+
When customizing this scaffold, search for `TODO` comments:
|
|
91
|
+
|
|
92
|
+
- `src/cli/index.ts:22-24` - CONNECTOR_NAME, VERSION, description
|
|
93
|
+
- `src/utils/config.ts:5-6` - CONNECTOR_NAME, env var prefix
|
|
94
|
+
- `src/api/client.ts:5` - DEFAULT_BASE_URL
|
|
95
|
+
- `src/api/client.ts:45-48` - Authentication method
|
|
96
|
+
- `src/api/index.ts:7` - Rename Connector class
|
|
97
|
+
- `src/types/index.ts` - Replace example types
|
|
98
|
+
|
|
99
|
+
## Environment Variables
|
|
100
|
+
|
|
101
|
+
| Variable | Description |
|
|
102
|
+
|----------|-------------|
|
|
103
|
+
| `CONNECTOR_API_KEY` | API key (overrides profile) |
|
|
104
|
+
| `CONNECTOR_API_SECRET` | API secret (optional) |
|
|
105
|
+
| `CONNECTOR_BASE_URL` | Override base URL |
|
|
106
|
+
|
|
107
|
+
## Data Storage
|
|
108
|
+
|
|
109
|
+
```
|
|
110
|
+
~/.connect/{connector-name}/
|
|
111
|
+
├── current_profile # Active profile name
|
|
112
|
+
└── profiles/
|
|
113
|
+
├── default.json # Default profile
|
|
114
|
+
└── {name}.json # Named profiles
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
Profile JSON structure:
|
|
118
|
+
```json
|
|
119
|
+
{
|
|
120
|
+
"apiKey": "sk-xxx",
|
|
121
|
+
"apiSecret": "optional"
|
|
122
|
+
}
|
|
123
|
+
```
|
|
124
|
+
|
|
125
|
+
## Dependencies
|
|
126
|
+
|
|
127
|
+
- commander: CLI framework
|
|
128
|
+
- chalk: Terminal styling
|
|
@@ -0,0 +1,193 @@
|
|
|
1
|
+
# scaffold-connector
|
|
2
|
+
|
|
3
|
+
A TypeScript scaffold for building API connector CLIs with multi-profile support.
|
|
4
|
+
|
|
5
|
+
## Features
|
|
6
|
+
|
|
7
|
+
- Multi-profile configuration (switch between different API keys/accounts)
|
|
8
|
+
- Bearer token authentication (easily customizable)
|
|
9
|
+
- Clean CLI structure with Commander.js
|
|
10
|
+
- Pretty and JSON output formats
|
|
11
|
+
- TypeScript with strict mode
|
|
12
|
+
|
|
13
|
+
## Quick Start
|
|
14
|
+
|
|
15
|
+
### 1. Clone and Rename
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
# Clone for your connector
|
|
19
|
+
git clone https://github.com/hasna/scaffold-connector.git connect-yourapi
|
|
20
|
+
cd connect-yourapi
|
|
21
|
+
|
|
22
|
+
# Update package.json name
|
|
23
|
+
# Change "@hasna/scaffold-connector" to "@hasna/connect-yourapi"
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
### 2. Update Configuration
|
|
27
|
+
|
|
28
|
+
Search for `TODO` comments throughout the codebase and update:
|
|
29
|
+
|
|
30
|
+
- `src/cli/index.ts` - Update `CONNECTOR_NAME` and description
|
|
31
|
+
- `src/utils/config.ts` - Update `CONNECTOR_NAME` and env var names
|
|
32
|
+
- `src/api/client.ts` - Update `DEFAULT_BASE_URL` and authentication method
|
|
33
|
+
- `src/api/index.ts` - Rename `Connector` class to your API name
|
|
34
|
+
- `src/types/index.ts` - Add your API's type definitions
|
|
35
|
+
- `package.json` - Update name, description, bin command
|
|
36
|
+
- `.env.example` - Update environment variable names
|
|
37
|
+
|
|
38
|
+
### 3. Install and Test
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
# Install dependencies
|
|
42
|
+
bun install
|
|
43
|
+
|
|
44
|
+
# Run CLI
|
|
45
|
+
bun run dev
|
|
46
|
+
|
|
47
|
+
# Or run specific commands
|
|
48
|
+
bun run dev profile list
|
|
49
|
+
bun run dev config show
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
## CLI Structure
|
|
53
|
+
|
|
54
|
+
```bash
|
|
55
|
+
connector [options] [command]
|
|
56
|
+
|
|
57
|
+
Options:
|
|
58
|
+
-k, --api-key <key> API key (overrides config)
|
|
59
|
+
-f, --format <format> Output format (json, pretty)
|
|
60
|
+
-p, --profile <profile> Use a specific profile
|
|
61
|
+
|
|
62
|
+
Commands:
|
|
63
|
+
profile list List all profiles
|
|
64
|
+
profile use <name> Switch to a profile
|
|
65
|
+
profile create <name> Create a new profile
|
|
66
|
+
profile delete <name> Delete a profile
|
|
67
|
+
profile show [name] Show profile configuration
|
|
68
|
+
|
|
69
|
+
config set-key <key> Set API key for active profile
|
|
70
|
+
config show Show current configuration
|
|
71
|
+
config clear Clear configuration
|
|
72
|
+
|
|
73
|
+
example list Example API command (replace)
|
|
74
|
+
example get <id> Example API command (replace)
|
|
75
|
+
example create Example API command (replace)
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
## Project Structure
|
|
79
|
+
|
|
80
|
+
```
|
|
81
|
+
src/
|
|
82
|
+
├── api/
|
|
83
|
+
│ ├── client.ts # HTTP client with authentication
|
|
84
|
+
│ ├── example.ts # Example API module (replace with your API)
|
|
85
|
+
│ └── index.ts # Main connector class
|
|
86
|
+
├── cli/
|
|
87
|
+
│ └── index.ts # CLI commands
|
|
88
|
+
├── types/
|
|
89
|
+
│ └── index.ts # Type definitions
|
|
90
|
+
├── utils/
|
|
91
|
+
│ ├── config.ts # Multi-profile configuration
|
|
92
|
+
│ └── output.ts # CLI output formatting
|
|
93
|
+
└── index.ts # Library exports
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
## Multi-Profile Configuration
|
|
97
|
+
|
|
98
|
+
Profiles are stored in `~/.connect/{connector-name}/profiles/`:
|
|
99
|
+
|
|
100
|
+
```
|
|
101
|
+
~/.connect/connector/
|
|
102
|
+
├── current_profile # Name of active profile
|
|
103
|
+
└── profiles/
|
|
104
|
+
├── default.json # Default profile
|
|
105
|
+
├── work.json # Named profile
|
|
106
|
+
└── personal.json # Named profile
|
|
107
|
+
```
|
|
108
|
+
|
|
109
|
+
### Profile Commands
|
|
110
|
+
|
|
111
|
+
```bash
|
|
112
|
+
# Create profiles
|
|
113
|
+
connector profile create work --api-key sk-xxx --use
|
|
114
|
+
connector profile create personal --api-key sk-yyy
|
|
115
|
+
|
|
116
|
+
# Switch profiles
|
|
117
|
+
connector profile use work
|
|
118
|
+
|
|
119
|
+
# Use profile for single command
|
|
120
|
+
connector -p personal example list
|
|
121
|
+
|
|
122
|
+
# List profiles
|
|
123
|
+
connector profile list
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
## Customizing Authentication
|
|
127
|
+
|
|
128
|
+
Edit `src/api/client.ts` to change authentication:
|
|
129
|
+
|
|
130
|
+
```typescript
|
|
131
|
+
// Bearer token (default)
|
|
132
|
+
'Authorization': `Bearer ${this.apiKey}`,
|
|
133
|
+
|
|
134
|
+
// API Key header
|
|
135
|
+
'X-API-Key': this.apiKey,
|
|
136
|
+
|
|
137
|
+
// Basic auth
|
|
138
|
+
'Authorization': `Basic ${Buffer.from(`${this.apiKey}:${this.apiSecret}`).toString('base64')}`,
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
## Adding API Endpoints
|
|
142
|
+
|
|
143
|
+
1. Create a new file in `src/api/` (e.g., `users.ts`)
|
|
144
|
+
2. Export it from `src/api/index.ts`
|
|
145
|
+
3. Add types in `src/types/index.ts`
|
|
146
|
+
4. Add CLI commands in `src/cli/index.ts`
|
|
147
|
+
|
|
148
|
+
Example API module:
|
|
149
|
+
|
|
150
|
+
```typescript
|
|
151
|
+
// src/api/users.ts
|
|
152
|
+
import type { ConnectorClient } from './client';
|
|
153
|
+
|
|
154
|
+
export class UsersApi {
|
|
155
|
+
constructor(private readonly client: ConnectorClient) {}
|
|
156
|
+
|
|
157
|
+
async list(options?: { limit?: number }) {
|
|
158
|
+
return this.client.get('/users', { limit: options?.limit });
|
|
159
|
+
}
|
|
160
|
+
|
|
161
|
+
async get(id: string) {
|
|
162
|
+
return this.client.get(`/users/${id}`);
|
|
163
|
+
}
|
|
164
|
+
}
|
|
165
|
+
```
|
|
166
|
+
|
|
167
|
+
## Environment Variables
|
|
168
|
+
|
|
169
|
+
| Variable | Description |
|
|
170
|
+
|----------|-------------|
|
|
171
|
+
| `CONNECTOR_API_KEY` | API key (overrides profile config) |
|
|
172
|
+
| `CONNECTOR_API_SECRET` | API secret (optional) |
|
|
173
|
+
| `CONNECTOR_BASE_URL` | Override base URL (optional) |
|
|
174
|
+
|
|
175
|
+
## Development
|
|
176
|
+
|
|
177
|
+
```bash
|
|
178
|
+
# Install dependencies
|
|
179
|
+
bun install
|
|
180
|
+
|
|
181
|
+
# Run CLI in development
|
|
182
|
+
bun run dev
|
|
183
|
+
|
|
184
|
+
# Build for distribution
|
|
185
|
+
bun run build
|
|
186
|
+
|
|
187
|
+
# Type check
|
|
188
|
+
bun run typecheck
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
## License
|
|
192
|
+
|
|
193
|
+
Apache-2.0
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@hasna/connect-asana",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"description": "Asana connector - Projects, tasks, workspaces, and teams management",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"bin": {
|
|
7
|
+
"connect-asana": "./bin/index.js"
|
|
8
|
+
},
|
|
9
|
+
"exports": {
|
|
10
|
+
".": {
|
|
11
|
+
"import": "./dist/index.js",
|
|
12
|
+
"types": "./dist/index.d.ts"
|
|
13
|
+
}
|
|
14
|
+
},
|
|
15
|
+
"main": "./dist/index.js",
|
|
16
|
+
"types": "./dist/index.d.ts",
|
|
17
|
+
"scripts": {
|
|
18
|
+
"build": "bun build ./src/index.ts --outdir ./dist --target bun && bun build ./src/cli/index.ts --outdir ./bin --target bun",
|
|
19
|
+
"dev": "bun run ./src/cli/index.ts",
|
|
20
|
+
"typecheck": "tsc --noEmit",
|
|
21
|
+
"prepublishOnly": "bun run build"
|
|
22
|
+
},
|
|
23
|
+
"keywords": [
|
|
24
|
+
"hasna",
|
|
25
|
+
"asana",
|
|
26
|
+
"project-management",
|
|
27
|
+
"tasks",
|
|
28
|
+
"projects",
|
|
29
|
+
"api",
|
|
30
|
+
"connector",
|
|
31
|
+
"cli",
|
|
32
|
+
"typescript",
|
|
33
|
+
"bun"
|
|
34
|
+
],
|
|
35
|
+
"author": "Hasna",
|
|
36
|
+
"license": "Apache-2.0",
|
|
37
|
+
"devDependencies": {
|
|
38
|
+
"@types/bun": "latest",
|
|
39
|
+
"typescript": "^5"
|
|
40
|
+
},
|
|
41
|
+
"dependencies": {
|
|
42
|
+
"commander": "^12.1.0",
|
|
43
|
+
"chalk": "^5.3.0"
|
|
44
|
+
},
|
|
45
|
+
"engines": {
|
|
46
|
+
"bun": ">=1.0.0"
|
|
47
|
+
},
|
|
48
|
+
"repository": {
|
|
49
|
+
"type": "git",
|
|
50
|
+
"url": "git+https://github.com/hasna/connectors.git"
|
|
51
|
+
}
|
|
52
|
+
}
|