forked from jtgi/automod
-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathicebreaker.ts
483 lines (415 loc) · 12.4 KB
/
icebreaker.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
import { CheckFunctionArgs, RuleDefinition, CheckFunction } from "~/rules/rules.type";
import { http } from "~/lib/http.server";
type IcebreakerChannel = {
type: string;
isVerified?: boolean;
isLocked?: boolean;
value?: string;
url?: string;
};
type IcebreakerCredential = {
name: string;
chain: string;
source?: string;
reference?: string;
};
type IcebreakerHighlight = {
title?: string;
url?: string;
};
type IcebreakerWorkExperience = {
jobTitle?: string;
orgWebsite?: string;
employmentType?: string;
startDate?: string;
endDate?: string;
location?: string;
isVerified?: boolean;
};
type IcebreakerEvent = {
id: string;
source: string;
name: string;
description?: string;
eventUrl?: string;
imageUrl?: string;
};
type IcebreakerGuildMembership = {
guildId: number;
roleIds: number[];
isAdmin: boolean;
isOwner: boolean;
joinedAt: Date;
};
type IcebreakerProfile = {
profileID?: string;
walletAddress: string;
avatarUrl?: string;
displayName?: string;
jobTitle?: string;
bio?: string;
location?: string;
primarySkill?: string;
networkingStatus?: string;
channels?: IcebreakerChannel[];
credentials?: IcebreakerCredential[];
highlights?: IcebreakerHighlight[];
workExperience?: IcebreakerWorkExperience[];
events?: IcebreakerEvent[];
guilds?: IcebreakerGuildMembership[];
};
const API_URL = "https://app.icebreaker.xyz/api/v1";
async function request<T>(path: string, options?: RequestInit) {
try {
const response = await http.get<T>(`${API_URL}${path}`);
return response.data;
} catch (err) {
console.error(err);
return;
}
}
type ProfileResponse = {
profiles: IcebreakerProfile[];
};
async function getIcebreakerbyFid(fid?: number) {
if (!fid) {
return;
}
const response = await request<ProfileResponse>(`/fid/${fid}`);
return response?.profiles[0];
}
function hasCredential(credentialName?: string, credentials?: IcebreakerCredential[], exact = false) {
if (!credentials || !credentialName) {
return false;
}
return credentials.some(({ name }) => (exact ? name === credentialName : name.startsWith(credentialName)));
}
async function hasIcebreakerCredential({ user: member, rule }: CheckFunctionArgs) {
const { credential, exactMatch } = rule.args as { credential: string; exactMatch: boolean };
const user = await getIcebreakerbyFid(member.fid);
if (!user) {
return {
result: false,
message: `@${member.username} not found in Icebreaker`,
};
}
const userHasCredential = hasCredential(credential, user.credentials, exactMatch);
return {
result: userHasCredential,
message: userHasCredential
? `@${member.username} has the ${credential} credential`
: `@${member.username} does not have the ${credential} credential`,
};
}
async function hasIcebreakerHuman({ user: member }: CheckFunctionArgs) {
const credential = "Human";
const user = await getIcebreakerbyFid(member.fid);
if (!user) {
return {
result: false,
message: `@${member.username} not found in Icebreaker`,
};
}
const userHasCredential = hasCredential(credential, user.credentials, true);
return {
result: userHasCredential,
message: userHasCredential
? `@${member.username} has the ${credential} credential`
: `@${member.username} does not have the ${credential} credential`,
};
}
async function hasIcebreakerBot({ user: member }: CheckFunctionArgs) {
const credential = "Feather Ice";
const user = await getIcebreakerbyFid(member.fid);
if (!user) {
return {
result: false,
message: `@${member.username} not found in Icebreaker`,
};
}
const userHasCredential = hasCredential(credential, user.credentials, true);
return {
result: userHasCredential,
message: userHasCredential
? `@${member.username} has the Bot (${credential}) credential`
: `@${member.username} does not have the Bot (${credential}) credential`,
};
}
async function hasIcebreakerVerified({ user: member }: CheckFunctionArgs) {
const credential = "Verified:";
const user = await getIcebreakerbyFid(member.fid);
if (!user) {
return {
result: false,
message: `@${member.username} not found in Icebreaker`,
};
}
const userHasCredential = hasCredential(credential, user.credentials);
return {
result: userHasCredential,
message: userHasCredential
? `@${member.username} has the ${credential} credential`
: `@${member.username} does not have the ${credential} credential`,
};
}
async function hasIcebreakerQBuilder({ user: member }: CheckFunctionArgs) {
const credential = "qBuilder";
const user = await getIcebreakerbyFid(member.fid);
if (!user) {
return {
result: false,
message: `@${member.username} not found in Icebreaker`,
};
}
const userHasCredential = hasCredential(credential, user.credentials, true);
return {
result: userHasCredential,
message: userHasCredential
? `@${member.username} has the ${credential} credential`
: `@${member.username} does not have the ${credential} credential`,
};
}
async function hasIcebreakerLinkedAccount({ user: member, rule }: CheckFunctionArgs) {
const { account, verified } = rule.args as { account: string; verified: boolean };
const user = await getIcebreakerbyFid(member.fid);
if (!user) {
return {
result: false,
message: `@${member.username} not found in Icebreaker`,
};
}
const userHasLinkedAccount =
user.channels?.some((channel) => channel.type === account && (!verified || channel.isVerified)) ?? false;
return {
result: userHasLinkedAccount,
message: userHasLinkedAccount
? `@${member.username} has linked ${verified ? "and verified " : " "}${account}`
: `@${member.username} does not have linked ${verified ? "and verified " : " "}${account}`,
};
}
async function hasPOAP({ user: member, rule }: CheckFunctionArgs) {
const { eventId } = rule.args as { eventId: string };
const user = await getIcebreakerbyFid(member.fid);
if (!user) {
return {
result: false,
message: `@${member.username} not found in Icebreaker`,
};
}
const userHasPOAP = user.events?.some((event) => event.source === "poap" && event.id === eventId) ?? false;
return {
result: userHasPOAP,
message: userHasPOAP
? `@${member.username} has the POAP ${eventId}`
: `@${member.username} does not have the POAP ${eventId}`,
};
}
async function hasGuildRole({ user: member, rule }: CheckFunctionArgs) {
const { guildId, roleId } = rule.args as { guildId: string; roleId: string | undefined };
const user = await getIcebreakerbyFid(member.fid);
if (!user) {
return {
result: false,
message: `@${member.username} not found in Icebreaker`,
};
}
const guild = user.guilds?.find((guild) => guild.guildId === +guildId);
const userHasGuildRole = (guild && (roleId ? guild.roleIds?.includes(+roleId) ?? false : true)) ?? false;
return {
result: userHasGuildRole,
message: userHasGuildRole
? `@${member.username} has the Guild ${guildId}${roleId ? ` with role ${roleId}` : ""}`
: `@${member.username} does not have the Guild ${guildId}${roleId ? ` with role ${roleId}` : ""}`,
};
}
type RuleName =
| "hasIcebreakerCredential"
| "hasIcebreakerHuman"
| "hasIcebreakerBot"
| "hasIcebreakerQBuilder"
| "hasIcebreakerVerified"
| "hasIcebreakerLinkedAccount"
| "hasPOAP"
| "hasGuildRole";
const author = "Icebreaker";
const authorUrl = "https://icebreaker.xyz";
const authorIcon = "/icons/icebreaker.png";
export const iceBreakerRulesDefinitions: Record<RuleName, RuleDefinition> = {
hasIcebreakerCredential: {
name: "hasIcebreakerCredential",
allowMultiple: true,
author,
authorUrl,
authorIcon,
category: "all",
friendlyName: "Icebreaker: Has Credential",
checkType: "user",
description: "Check if the user has a specific Icebreaker credential",
hidden: false,
invertable: true,
args: {
credential: {
type: "string",
friendlyName: "Credential",
description: "The name of the credential",
placeholder: "Enter a credential...",
required: true,
},
exactMatch: {
type: "boolean",
defaultValue: false,
friendlyName: "Exact credential match",
description: "Exactly matches the full name of the credential",
required: false,
},
},
},
hasIcebreakerHuman: {
name: "hasIcebreakerHuman",
allowMultiple: false,
author,
authorUrl,
authorIcon,
category: "all",
friendlyName: "Icebreaker: Has Human",
checkType: "user",
description: "Check if the user has the Icebreaker Human credential",
hidden: false,
invertable: true,
args: {},
},
hasIcebreakerBot: {
name: "hasIcebreakerBot",
allowMultiple: false,
author,
authorUrl,
authorIcon,
category: "all",
friendlyName: "Icebreaker: Has Bot",
checkType: "user",
description: "Check if the user has the Icebreaker Bot (Feather Ice) credential",
hidden: false,
invertable: true,
args: {},
},
hasIcebreakerQBuilder: {
name: "hasIcebreakerQBuilder",
allowMultiple: false,
author,
authorUrl,
authorIcon,
category: "all",
friendlyName: "Icebreaker: Has QBuilder",
checkType: "user",
description: "Check if the user has the Icebreaker QBuilder credential",
hidden: false,
invertable: true,
args: {},
},
hasIcebreakerVerified: {
name: "hasIcebreakerVerified",
allowMultiple: false,
author,
authorUrl,
authorIcon,
category: "all",
friendlyName: "Icebreaker: Has Verified Work Domain",
checkType: "user",
description: "Check if the user has the Icebreaker Verified credential for a work domain",
hidden: false,
invertable: true,
args: {},
},
hasIcebreakerLinkedAccount: {
name: "hasIcebreakerLinkedAccount",
allowMultiple: true,
author,
authorUrl,
authorIcon,
category: "all",
friendlyName: "Icebreaker: Has Linked Account",
checkType: "user",
description: "Check if the user has a specific type of linked account",
hidden: false,
invertable: true,
args: {
account: {
type: "string",
friendlyName: "Account",
description: "The type of account required. Consult Icebreaker Alloy for all types supported",
placeholder: "Choose one of linkedin, twitter, github, etc.",
required: true,
},
verified: {
type: "boolean",
defaultValue: false,
friendlyName: "Require verified account",
description: "If enabled, only passes if the account has been verified",
required: false,
},
},
},
hasPOAP: {
name: "hasPOAP",
allowMultiple: true,
author,
authorUrl,
authorIcon,
category: "all",
friendlyName: "Icebreaker: Has POAP",
checkType: "user",
description: "Check via Icebreaker if the user has a specific POAP",
hidden: false,
invertable: true,
args: {
eventId: {
type: "string",
friendlyName: "POAP Event ID",
description: "The POAP event ID to check for",
placeholder: "Enter a POAP event ID...",
required: true,
},
},
},
hasGuildRole: {
name: "hasGuildRole",
allowMultiple: true,
author,
authorUrl,
authorIcon,
category: "all",
friendlyName: "Icebreaker: Has Guild Role",
checkType: "user",
description: "Check via Icebreaker if the user is a member of a Guild",
hidden: false,
invertable: true,
args: {
guildId: {
type: "string",
friendlyName: "Guild ID",
description: "The Guild ID to check for",
placeholder: "Enter a Guild ID...",
pattern: "^[0-9]+$",
required: true,
},
roleId: {
type: "string",
friendlyName: "Role ID",
description: "Optional role ID to check for",
placeholder: "Enter a Role ID...",
pattern: "^[0-9]*$",
required: false,
},
},
},
} as const;
export const iceBreakerRulesFunction: Record<RuleName, CheckFunction> = {
hasIcebreakerHuman: hasIcebreakerHuman,
hasIcebreakerBot: hasIcebreakerBot,
hasIcebreakerQBuilder: hasIcebreakerQBuilder,
hasIcebreakerVerified: hasIcebreakerVerified,
hasIcebreakerCredential: hasIcebreakerCredential,
hasIcebreakerLinkedAccount: hasIcebreakerLinkedAccount,
hasPOAP: hasPOAP,
hasGuildRole: hasGuildRole,
} as const;