@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
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
// Todoist Connector
|
|
2
|
+
// Projects, tasks, sections, labels, and comments management
|
|
3
|
+
|
|
4
|
+
export { Todoist, TodoistClient } from './api';
|
|
5
|
+
export * from './types';
|
|
6
|
+
|
|
7
|
+
// Export config utilities
|
|
8
|
+
export {
|
|
9
|
+
getApiKey,
|
|
10
|
+
setApiKey,
|
|
11
|
+
getCurrentProfile,
|
|
12
|
+
setCurrentProfile,
|
|
13
|
+
listProfiles,
|
|
14
|
+
createProfile,
|
|
15
|
+
deleteProfile,
|
|
16
|
+
loadProfile,
|
|
17
|
+
saveProfile,
|
|
18
|
+
clearConfig,
|
|
19
|
+
getConfigDir,
|
|
20
|
+
getActiveProfileName,
|
|
21
|
+
} from './utils/config';
|
|
@@ -0,0 +1,240 @@
|
|
|
1
|
+
// Todoist Connector Types
|
|
2
|
+
// Projects, tasks, sections, labels, and comments management
|
|
3
|
+
|
|
4
|
+
// ============================================
|
|
5
|
+
// Configuration
|
|
6
|
+
// ============================================
|
|
7
|
+
|
|
8
|
+
export interface TodoistConfig {
|
|
9
|
+
apiKey: string;
|
|
10
|
+
baseUrl?: string;
|
|
11
|
+
}
|
|
12
|
+
|
|
13
|
+
// ============================================
|
|
14
|
+
// Common Types
|
|
15
|
+
// ============================================
|
|
16
|
+
|
|
17
|
+
export type OutputFormat = 'json' | 'pretty';
|
|
18
|
+
|
|
19
|
+
// ============================================
|
|
20
|
+
// Project Types
|
|
21
|
+
// ============================================
|
|
22
|
+
|
|
23
|
+
export interface Project {
|
|
24
|
+
id: string;
|
|
25
|
+
name: string;
|
|
26
|
+
comment_count: number;
|
|
27
|
+
order: number;
|
|
28
|
+
color: string;
|
|
29
|
+
is_shared: boolean;
|
|
30
|
+
is_favorite: boolean;
|
|
31
|
+
is_inbox_project: boolean;
|
|
32
|
+
is_team_inbox: boolean;
|
|
33
|
+
view_style: 'list' | 'board';
|
|
34
|
+
url: string;
|
|
35
|
+
parent_id?: string | null;
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
export interface CreateProjectInput {
|
|
39
|
+
name: string;
|
|
40
|
+
parent_id?: string;
|
|
41
|
+
color?: string;
|
|
42
|
+
is_favorite?: boolean;
|
|
43
|
+
view_style?: 'list' | 'board';
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
export interface UpdateProjectInput {
|
|
47
|
+
name?: string;
|
|
48
|
+
color?: string;
|
|
49
|
+
is_favorite?: boolean;
|
|
50
|
+
view_style?: 'list' | 'board';
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
// ============================================
|
|
54
|
+
// Section Types
|
|
55
|
+
// ============================================
|
|
56
|
+
|
|
57
|
+
export interface Section {
|
|
58
|
+
id: string;
|
|
59
|
+
project_id: string;
|
|
60
|
+
order: number;
|
|
61
|
+
name: string;
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
export interface CreateSectionInput {
|
|
65
|
+
name: string;
|
|
66
|
+
project_id: string;
|
|
67
|
+
order?: number;
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
export interface UpdateSectionInput {
|
|
71
|
+
name: string;
|
|
72
|
+
}
|
|
73
|
+
|
|
74
|
+
// ============================================
|
|
75
|
+
// Task Types
|
|
76
|
+
// ============================================
|
|
77
|
+
|
|
78
|
+
export interface Task {
|
|
79
|
+
id: string;
|
|
80
|
+
project_id: string;
|
|
81
|
+
section_id?: string | null;
|
|
82
|
+
content: string;
|
|
83
|
+
description: string;
|
|
84
|
+
is_completed: boolean;
|
|
85
|
+
labels: string[];
|
|
86
|
+
parent_id?: string | null;
|
|
87
|
+
order: number;
|
|
88
|
+
priority: number;
|
|
89
|
+
due?: Due | null;
|
|
90
|
+
url: string;
|
|
91
|
+
comment_count: number;
|
|
92
|
+
created_at: string;
|
|
93
|
+
creator_id: string;
|
|
94
|
+
assignee_id?: string | null;
|
|
95
|
+
assigner_id?: string | null;
|
|
96
|
+
duration?: Duration | null;
|
|
97
|
+
}
|
|
98
|
+
|
|
99
|
+
export interface Due {
|
|
100
|
+
date: string;
|
|
101
|
+
string: string;
|
|
102
|
+
lang: string;
|
|
103
|
+
is_recurring: boolean;
|
|
104
|
+
datetime?: string;
|
|
105
|
+
timezone?: string;
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
export interface Duration {
|
|
109
|
+
amount: number;
|
|
110
|
+
unit: 'minute' | 'day';
|
|
111
|
+
}
|
|
112
|
+
|
|
113
|
+
export interface CreateTaskInput {
|
|
114
|
+
content: string;
|
|
115
|
+
description?: string;
|
|
116
|
+
project_id?: string;
|
|
117
|
+
section_id?: string;
|
|
118
|
+
parent_id?: string;
|
|
119
|
+
order?: number;
|
|
120
|
+
labels?: string[];
|
|
121
|
+
priority?: number;
|
|
122
|
+
due_string?: string;
|
|
123
|
+
due_date?: string;
|
|
124
|
+
due_datetime?: string;
|
|
125
|
+
due_lang?: string;
|
|
126
|
+
assignee_id?: string;
|
|
127
|
+
duration?: number;
|
|
128
|
+
duration_unit?: 'minute' | 'day';
|
|
129
|
+
}
|
|
130
|
+
|
|
131
|
+
export interface UpdateTaskInput {
|
|
132
|
+
content?: string;
|
|
133
|
+
description?: string;
|
|
134
|
+
labels?: string[];
|
|
135
|
+
priority?: number;
|
|
136
|
+
due_string?: string;
|
|
137
|
+
due_date?: string;
|
|
138
|
+
due_datetime?: string;
|
|
139
|
+
due_lang?: string;
|
|
140
|
+
assignee_id?: string | null;
|
|
141
|
+
duration?: number;
|
|
142
|
+
duration_unit?: 'minute' | 'day';
|
|
143
|
+
}
|
|
144
|
+
|
|
145
|
+
// ============================================
|
|
146
|
+
// Label Types
|
|
147
|
+
// ============================================
|
|
148
|
+
|
|
149
|
+
export interface Label {
|
|
150
|
+
id: string;
|
|
151
|
+
name: string;
|
|
152
|
+
color: string;
|
|
153
|
+
order: number;
|
|
154
|
+
is_favorite: boolean;
|
|
155
|
+
}
|
|
156
|
+
|
|
157
|
+
export interface CreateLabelInput {
|
|
158
|
+
name: string;
|
|
159
|
+
color?: string;
|
|
160
|
+
order?: number;
|
|
161
|
+
is_favorite?: boolean;
|
|
162
|
+
}
|
|
163
|
+
|
|
164
|
+
export interface UpdateLabelInput {
|
|
165
|
+
name?: string;
|
|
166
|
+
color?: string;
|
|
167
|
+
order?: number;
|
|
168
|
+
is_favorite?: boolean;
|
|
169
|
+
}
|
|
170
|
+
|
|
171
|
+
// ============================================
|
|
172
|
+
// Comment Types
|
|
173
|
+
// ============================================
|
|
174
|
+
|
|
175
|
+
export interface Comment {
|
|
176
|
+
id: string;
|
|
177
|
+
task_id?: string;
|
|
178
|
+
project_id?: string;
|
|
179
|
+
posted_at: string;
|
|
180
|
+
content: string;
|
|
181
|
+
attachment?: Attachment;
|
|
182
|
+
}
|
|
183
|
+
|
|
184
|
+
export interface Attachment {
|
|
185
|
+
file_name: string;
|
|
186
|
+
file_type: string;
|
|
187
|
+
file_url: string;
|
|
188
|
+
resource_type: string;
|
|
189
|
+
}
|
|
190
|
+
|
|
191
|
+
export interface CreateCommentInput {
|
|
192
|
+
content: string;
|
|
193
|
+
task_id?: string;
|
|
194
|
+
project_id?: string;
|
|
195
|
+
attachment?: {
|
|
196
|
+
file_url: string;
|
|
197
|
+
file_type?: string;
|
|
198
|
+
resource_type?: string;
|
|
199
|
+
};
|
|
200
|
+
}
|
|
201
|
+
|
|
202
|
+
export interface UpdateCommentInput {
|
|
203
|
+
content: string;
|
|
204
|
+
}
|
|
205
|
+
|
|
206
|
+
// ============================================
|
|
207
|
+
// Collaborator Types
|
|
208
|
+
// ============================================
|
|
209
|
+
|
|
210
|
+
export interface Collaborator {
|
|
211
|
+
id: string;
|
|
212
|
+
name: string;
|
|
213
|
+
email: string;
|
|
214
|
+
}
|
|
215
|
+
|
|
216
|
+
// ============================================
|
|
217
|
+
// API Error Types
|
|
218
|
+
// ============================================
|
|
219
|
+
|
|
220
|
+
export interface TodoistError {
|
|
221
|
+
error: string;
|
|
222
|
+
error_code?: number;
|
|
223
|
+
error_extra?: Record<string, unknown>;
|
|
224
|
+
error_tag?: string;
|
|
225
|
+
http_code?: number;
|
|
226
|
+
}
|
|
227
|
+
|
|
228
|
+
export class TodoistApiError extends Error {
|
|
229
|
+
public readonly statusCode: number;
|
|
230
|
+
public readonly errorCode?: number;
|
|
231
|
+
public readonly errorTag?: string;
|
|
232
|
+
|
|
233
|
+
constructor(message: string, statusCode: number, errorCode?: number, errorTag?: string) {
|
|
234
|
+
super(message);
|
|
235
|
+
this.name = 'TodoistApiError';
|
|
236
|
+
this.statusCode = statusCode;
|
|
237
|
+
this.errorCode = errorCode;
|
|
238
|
+
this.errorTag = errorTag;
|
|
239
|
+
}
|
|
240
|
+
}
|
|
@@ -0,0 +1,157 @@
|
|
|
1
|
+
import { existsSync, readFileSync, writeFileSync, mkdirSync, readdirSync, rmSync } from 'fs';
|
|
2
|
+
import { homedir } from 'os';
|
|
3
|
+
import { join } from 'path';
|
|
4
|
+
|
|
5
|
+
const CONNECTOR_NAME = 'connect-todoist';
|
|
6
|
+
const DEFAULT_PROFILE = 'default';
|
|
7
|
+
|
|
8
|
+
export interface ProfileConfig {
|
|
9
|
+
apiKey?: string;
|
|
10
|
+
}
|
|
11
|
+
|
|
12
|
+
let profileOverride: string | undefined;
|
|
13
|
+
|
|
14
|
+
const CONFIG_DIR = join(homedir(), '.connect', CONNECTOR_NAME);
|
|
15
|
+
const PROFILES_DIR = join(CONFIG_DIR, 'profiles');
|
|
16
|
+
const CURRENT_PROFILE_FILE = join(CONFIG_DIR, 'current_profile');
|
|
17
|
+
|
|
18
|
+
export function setProfileOverride(profile: string | undefined): void {
|
|
19
|
+
profileOverride = profile;
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
export function ensureConfigDir(): void {
|
|
23
|
+
if (!existsSync(CONFIG_DIR)) {
|
|
24
|
+
mkdirSync(CONFIG_DIR, { recursive: true });
|
|
25
|
+
}
|
|
26
|
+
if (!existsSync(PROFILES_DIR)) {
|
|
27
|
+
mkdirSync(PROFILES_DIR, { recursive: true });
|
|
28
|
+
}
|
|
29
|
+
}
|
|
30
|
+
|
|
31
|
+
function getProfilePath(profile: string): string {
|
|
32
|
+
return join(PROFILES_DIR, `${profile}.json`);
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
export function getCurrentProfile(): string {
|
|
36
|
+
if (profileOverride) {
|
|
37
|
+
return profileOverride;
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
ensureConfigDir();
|
|
41
|
+
|
|
42
|
+
if (existsSync(CURRENT_PROFILE_FILE)) {
|
|
43
|
+
try {
|
|
44
|
+
const profile = readFileSync(CURRENT_PROFILE_FILE, 'utf-8').trim();
|
|
45
|
+
if (profile && profileExists(profile)) {
|
|
46
|
+
return profile;
|
|
47
|
+
}
|
|
48
|
+
} catch {
|
|
49
|
+
// Fall through to default
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
return DEFAULT_PROFILE;
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
export function setCurrentProfile(profile: string): void {
|
|
57
|
+
ensureConfigDir();
|
|
58
|
+
|
|
59
|
+
if (!profileExists(profile) && profile !== DEFAULT_PROFILE) {
|
|
60
|
+
throw new Error(`Profile "${profile}" does not exist`);
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
writeFileSync(CURRENT_PROFILE_FILE, profile);
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
export function profileExists(profile: string): boolean {
|
|
67
|
+
return existsSync(getProfilePath(profile));
|
|
68
|
+
}
|
|
69
|
+
|
|
70
|
+
export function listProfiles(): string[] {
|
|
71
|
+
ensureConfigDir();
|
|
72
|
+
|
|
73
|
+
if (!existsSync(PROFILES_DIR)) {
|
|
74
|
+
return [];
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
return readdirSync(PROFILES_DIR)
|
|
78
|
+
.filter(f => f.endsWith('.json'))
|
|
79
|
+
.map(f => f.replace('.json', ''))
|
|
80
|
+
.sort();
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
export function createProfile(profile: string, config: ProfileConfig = {}): boolean {
|
|
84
|
+
ensureConfigDir();
|
|
85
|
+
|
|
86
|
+
if (profileExists(profile)) {
|
|
87
|
+
return false;
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
if (!/^[a-zA-Z0-9_-]+$/.test(profile)) {
|
|
91
|
+
throw new Error('Profile name can only contain letters, numbers, hyphens, and underscores');
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
writeFileSync(getProfilePath(profile), JSON.stringify(config, null, 2));
|
|
95
|
+
return true;
|
|
96
|
+
}
|
|
97
|
+
|
|
98
|
+
export function deleteProfile(profile: string): boolean {
|
|
99
|
+
if (profile === DEFAULT_PROFILE) {
|
|
100
|
+
return false;
|
|
101
|
+
}
|
|
102
|
+
|
|
103
|
+
if (!profileExists(profile)) {
|
|
104
|
+
return false;
|
|
105
|
+
}
|
|
106
|
+
|
|
107
|
+
if (getCurrentProfile() === profile) {
|
|
108
|
+
setCurrentProfile(DEFAULT_PROFILE);
|
|
109
|
+
}
|
|
110
|
+
|
|
111
|
+
rmSync(getProfilePath(profile));
|
|
112
|
+
return true;
|
|
113
|
+
}
|
|
114
|
+
|
|
115
|
+
export function loadProfile(profile?: string): ProfileConfig {
|
|
116
|
+
ensureConfigDir();
|
|
117
|
+
const profileName = profile || getCurrentProfile();
|
|
118
|
+
const profilePath = getProfilePath(profileName);
|
|
119
|
+
|
|
120
|
+
if (!existsSync(profilePath)) {
|
|
121
|
+
return {};
|
|
122
|
+
}
|
|
123
|
+
|
|
124
|
+
try {
|
|
125
|
+
return JSON.parse(readFileSync(profilePath, 'utf-8'));
|
|
126
|
+
} catch {
|
|
127
|
+
return {};
|
|
128
|
+
}
|
|
129
|
+
}
|
|
130
|
+
|
|
131
|
+
export function saveProfile(config: ProfileConfig, profile?: string): void {
|
|
132
|
+
ensureConfigDir();
|
|
133
|
+
const profileName = profile || getCurrentProfile();
|
|
134
|
+
writeFileSync(getProfilePath(profileName), JSON.stringify(config, null, 2));
|
|
135
|
+
}
|
|
136
|
+
|
|
137
|
+
export function getApiKey(): string | undefined {
|
|
138
|
+
return process.env.TODOIST_API_KEY || loadProfile().apiKey;
|
|
139
|
+
}
|
|
140
|
+
|
|
141
|
+
export function setApiKey(apiKey: string): void {
|
|
142
|
+
const config = loadProfile();
|
|
143
|
+
config.apiKey = apiKey;
|
|
144
|
+
saveProfile(config);
|
|
145
|
+
}
|
|
146
|
+
|
|
147
|
+
export function clearConfig(): void {
|
|
148
|
+
saveProfile({});
|
|
149
|
+
}
|
|
150
|
+
|
|
151
|
+
export function getConfigDir(): string {
|
|
152
|
+
return CONFIG_DIR;
|
|
153
|
+
}
|
|
154
|
+
|
|
155
|
+
export function getActiveProfileName(): string {
|
|
156
|
+
return getCurrentProfile();
|
|
157
|
+
}
|
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
import chalk from 'chalk';
|
|
2
|
+
|
|
3
|
+
export type OutputFormat = 'json' | 'table' | 'pretty';
|
|
4
|
+
|
|
5
|
+
export function formatOutput(data: unknown, format: OutputFormat = 'pretty'): string {
|
|
6
|
+
switch (format) {
|
|
7
|
+
case 'json':
|
|
8
|
+
return JSON.stringify(data, null, 2);
|
|
9
|
+
case 'table':
|
|
10
|
+
return formatAsTable(data);
|
|
11
|
+
case 'pretty':
|
|
12
|
+
default:
|
|
13
|
+
return formatPretty(data);
|
|
14
|
+
}
|
|
15
|
+
}
|
|
16
|
+
|
|
17
|
+
function formatAsTable(data: unknown): string {
|
|
18
|
+
if (!Array.isArray(data)) {
|
|
19
|
+
data = [data];
|
|
20
|
+
}
|
|
21
|
+
|
|
22
|
+
const items = data as Record<string, unknown>[];
|
|
23
|
+
if (items.length === 0) {
|
|
24
|
+
return 'No data';
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
const firstItem = items[0];
|
|
28
|
+
if (!firstItem || typeof firstItem !== 'object') {
|
|
29
|
+
return 'No data';
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
const keys = Object.keys(firstItem);
|
|
33
|
+
const colWidths = keys.map(key => {
|
|
34
|
+
const maxValue = Math.max(
|
|
35
|
+
key.length,
|
|
36
|
+
...items.map(item => String(item[key] ?? '').length)
|
|
37
|
+
);
|
|
38
|
+
return Math.min(maxValue, 40);
|
|
39
|
+
});
|
|
40
|
+
|
|
41
|
+
const header = keys.map((key, i) => key.padEnd(colWidths[i] ?? 10)).join(' | ');
|
|
42
|
+
const separator = colWidths.map(w => '-'.repeat(w)).join('-+-');
|
|
43
|
+
|
|
44
|
+
const rows = items.map(item =>
|
|
45
|
+
keys.map((key, i) => {
|
|
46
|
+
const value = String(item[key] ?? '');
|
|
47
|
+
const width = colWidths[i] ?? 10;
|
|
48
|
+
return value.length > width
|
|
49
|
+
? value.substring(0, width - 3) + '...'
|
|
50
|
+
: value.padEnd(width);
|
|
51
|
+
}).join(' | ')
|
|
52
|
+
);
|
|
53
|
+
|
|
54
|
+
return [header, separator, ...rows].join('\n');
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
function formatPretty(data: unknown): string {
|
|
58
|
+
if (Array.isArray(data)) {
|
|
59
|
+
return data.map((item, i) => `${chalk.cyan(`[${i + 1}]`)} ${formatPrettyItem(item)}`).join('\n\n');
|
|
60
|
+
}
|
|
61
|
+
return formatPrettyItem(data);
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
function formatPrettyItem(item: unknown, indent = 0): string {
|
|
65
|
+
if (item === null || item === undefined) {
|
|
66
|
+
return chalk.gray('null');
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
if (typeof item !== 'object') {
|
|
70
|
+
return String(item);
|
|
71
|
+
}
|
|
72
|
+
|
|
73
|
+
const spaces = ' '.repeat(indent);
|
|
74
|
+
const entries = Object.entries(item as Record<string, unknown>);
|
|
75
|
+
|
|
76
|
+
return entries
|
|
77
|
+
.map(([key, value]) => {
|
|
78
|
+
if (Array.isArray(value)) {
|
|
79
|
+
if (value.length === 0) {
|
|
80
|
+
return `${spaces}${chalk.blue(key)}: ${chalk.gray('[]')}`;
|
|
81
|
+
}
|
|
82
|
+
if (typeof value[0] === 'object') {
|
|
83
|
+
return `${spaces}${chalk.blue(key)}:\n${value.map(v => formatPrettyItem(v, indent + 1)).join('\n')}`;
|
|
84
|
+
}
|
|
85
|
+
return `${spaces}${chalk.blue(key)}: ${value.join(', ')}`;
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
if (typeof value === 'object' && value !== null) {
|
|
89
|
+
return `${spaces}${chalk.blue(key)}:\n${formatPrettyItem(value, indent + 1)}`;
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
return `${spaces}${chalk.blue(key)}: ${chalk.white(String(value))}`;
|
|
93
|
+
})
|
|
94
|
+
.join('\n');
|
|
95
|
+
}
|
|
96
|
+
|
|
97
|
+
export function success(message: string): void {
|
|
98
|
+
console.log(chalk.green('✓'), message);
|
|
99
|
+
}
|
|
100
|
+
|
|
101
|
+
export function error(message: string): void {
|
|
102
|
+
console.error(chalk.red('✗'), message);
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
export function warn(message: string): void {
|
|
106
|
+
console.warn(chalk.yellow('⚠'), message);
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
export function info(message: string): void {
|
|
110
|
+
console.log(chalk.blue('ℹ'), message);
|
|
111
|
+
}
|
|
112
|
+
|
|
113
|
+
export function heading(message: string): void {
|
|
114
|
+
console.log(chalk.bold.cyan(`\n${message}\n`));
|
|
115
|
+
}
|
|
116
|
+
|
|
117
|
+
export function print(data: unknown, format: OutputFormat = 'pretty'): void {
|
|
118
|
+
console.log(formatOutput(data, format));
|
|
119
|
+
}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
{
|
|
2
|
+
"compilerOptions": {
|
|
3
|
+
"target": "ESNext",
|
|
4
|
+
"module": "ESNext",
|
|
5
|
+
"moduleResolution": "bundler",
|
|
6
|
+
"esModuleInterop": true,
|
|
7
|
+
"strict": true,
|
|
8
|
+
"skipLibCheck": true,
|
|
9
|
+
"declaration": true,
|
|
10
|
+
"outDir": "./dist",
|
|
11
|
+
"rootDir": "./src",
|
|
12
|
+
"types": ["bun-types"]
|
|
13
|
+
},
|
|
14
|
+
"include": ["src/**/*"],
|
|
15
|
+
"exclude": ["node_modules", "dist", "bin"]
|
|
16
|
+
}
|
|
@@ -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
|