Skip to content

Commit ad17502

Browse files
abram0v1chabram0v1ch
committed
feat(tools): add Short.io tools and registry
Add 6 Short.io tool implementations (create link, list domains, list links, delete link, get QR code, get analytics) with shared types and barrel export. Register all tools in the tools registry.
1 parent 67f8a68 commit ad17502

9 files changed

Lines changed: 508 additions & 0 deletions

File tree

‎apps/sim/tools/registry.ts‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1609,6 +1609,14 @@ import {
16091609
shopifyUpdateOrderTool,
16101610
shopifyUpdateProductTool,
16111611
} from '@/tools/shopify'
1612+
import {
1613+
shortIoCreateLinkTool,
1614+
shortIoListDomainsTool,
1615+
shortIoListLinksTool,
1616+
shortIoDeleteLinkTool,
1617+
shortIoGetQrCodeTool,
1618+
shortIoGetAnalyticsTool,
1619+
} from '@/tools/short_io'
16121620
import {
16131621
similarwebBounceRateTool,
16141622
similarwebPagesPerVisitTool,
@@ -2353,6 +2361,12 @@ export const tools: Record<string, ToolConfig> = {
23532361
tavily_extract: tavilyExtractTool,
23542362
tavily_crawl: tavilyCrawlTool,
23552363
tavily_map: tavilyMapTool,
2364+
short_io_create_link: shortIoCreateLinkTool,
2365+
short_io_list_domains: shortIoListDomainsTool,
2366+
short_io_list_links: shortIoListLinksTool,
2367+
short_io_delete_link: shortIoDeleteLinkTool,
2368+
short_io_get_qr_code: shortIoGetQrCodeTool,
2369+
short_io_get_analytics: shortIoGetAnalyticsTool,
23562370
supabase_query: supabaseQueryTool,
23572371
supabase_insert: supabaseInsertTool,
23582372
supabase_get_row: supabaseGetRowTool,

‎apps/sim/tools/short_io/create_link.ts‎

Lines changed: 81 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,81 @@
1+
import type { ShortIoCreateLinkParams } from '@/tools/short_io/types'
2+
import type { ToolConfig, ToolResponse } from '@/tools/types'
3+
4+
export const shortIoCreateLinkTool: ToolConfig<ShortIoCreateLinkParams, ToolResponse> = {
5+
id: 'short_io_create_link',
6+
name: 'Short.io Create Link',
7+
description: 'Create a short link using your Short.io custom domain.',
8+
version: '1.0',
9+
params: {
10+
apiKey: {
11+
type: 'string',
12+
required: true,
13+
visibility: 'hidden',
14+
description: 'Short.io Secret API Key',
15+
},
16+
domain: {
17+
type: 'string',
18+
required: true,
19+
visibility: 'user-or-llm',
20+
description: 'Your registered Short.io custom domain',
21+
},
22+
originalURL: {
23+
type: 'string',
24+
required: true,
25+
visibility: 'user-or-llm',
26+
description: 'The long URL to shorten',
27+
},
28+
path: {
29+
type: 'string',
30+
required: false,
31+
visibility: 'user-or-llm',
32+
description: 'Optional custom path for the short link',
33+
},
34+
},
35+
request: {
36+
url: 'https://api.short.io/links',
37+
method: 'POST',
38+
headers: (params) => ({
39+
Authorization: params.apiKey,
40+
'Content-Type': 'application/json',
41+
}),
42+
body: (params) => {
43+
const bodyData: Record<string, string> = {
44+
domain: params.domain,
45+
originalURL: params.originalURL,
46+
}
47+
if (params.path) {
48+
bodyData.path = params.path
49+
}
50+
return bodyData
51+
},
52+
},
53+
transformResponse: async (response: Response) => {
54+
if (!response.ok) {
55+
const errorText = await response.text().catch(() => response.statusText)
56+
return {
57+
success: false,
58+
output: {
59+
success: false,
60+
error: `Failed to create short link: ${errorText}`,
61+
},
62+
}
63+
}
64+
65+
const data = await response.json().catch(() => ({}))
66+
return {
67+
success: true,
68+
output: {
69+
success: true,
70+
shortURL: data.shortURL,
71+
idString: data.idString,
72+
},
73+
}
74+
},
75+
outputs: {
76+
success: { type: 'boolean', description: 'Whether the link was created successfully' },
77+
shortURL: { type: 'string', description: 'The generated short link URL' },
78+
idString: { type: 'string', description: 'The unique Short.io link ID string' },
79+
error: { type: 'string', description: 'Error message if failed' },
80+
},
81+
}

‎apps/sim/tools/short_io/delete_link.ts‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
import type { ShortIoDeleteLinkParams } from '@/tools/short_io/types'
2+
import type { ToolConfig, ToolResponse } from '@/tools/types'
3+
4+
export const shortIoDeleteLinkTool: ToolConfig<ShortIoDeleteLinkParams, ToolResponse> = {
5+
id: 'short_io_delete_link',
6+
name: 'Short.io Delete Link',
7+
description: 'Delete a short link by ID (e.g. lnk_abc123_abcdef). Rate limit 20/s.',
8+
version: '1.0',
9+
params: {
10+
apiKey: { type: 'string', required: true, visibility: 'hidden', description: 'Short.io Secret API Key' },
11+
linkId: { type: 'string', required: true, visibility: 'user-or-llm', description: 'Link ID to delete' },
12+
},
13+
request: {
14+
url: (params) => `https://api.short.io/links/${encodeURIComponent(params.linkId)}`,
15+
method: 'DELETE',
16+
headers: (params) => ({
17+
Authorization: params.apiKey,
18+
}),
19+
},
20+
transformResponse: async (response: Response) => {
21+
if (!response.ok) {
22+
const err = await response.text().catch(() => response.statusText)
23+
return { success: false, output: { success: false, error: err } }
24+
}
25+
const data = await response.json().catch(() => ({}))
26+
return {
27+
success: true,
28+
output: {
29+
success: true,
30+
deleted: data.success === true,
31+
idString: data.idString ?? undefined,
32+
},
33+
}
34+
},
35+
outputs: {
36+
success: { type: 'boolean', description: 'Success status' },
37+
deleted: { type: 'boolean', description: 'Whether the link was deleted' },
38+
idString: { type: 'string', description: 'Deleted link ID' },
39+
error: { type: 'string', description: 'Error message' },
40+
},
41+
}

‎apps/sim/tools/short_io/get_analytics.ts‎

Lines changed: 110 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,110 @@
1+
import type { ShortIoGetAnalyticsParams } from '@/tools/short_io/types'
2+
import type { ToolConfig, ToolResponse } from '@/tools/types'
3+
4+
const STATS_PERIOD_MAP: Record<string, string> = {
5+
today: 'today',
6+
yesterday: 'yesterday',
7+
last_7_days: 'last7',
8+
last_30_days: 'last30',
9+
all_time: 'total',
10+
week: 'week',
11+
month: 'month',
12+
lastmonth: 'lastmonth',
13+
}
14+
15+
export const shortIoGetAnalyticsTool: ToolConfig<ShortIoGetAnalyticsParams, ToolResponse> = {
16+
id: 'short_io_get_analytics',
17+
name: 'Short.io Get Link Statistics',
18+
description:
19+
'Fetch click statistics for a Short.io link (Statistics API: totalClicks, humanClicks, referer, country, etc.).',
20+
version: '1.0',
21+
params: {
22+
apiKey: {
23+
type: 'string',
24+
required: true,
25+
visibility: 'hidden',
26+
description: 'Short.io Secret API Key',
27+
},
28+
linkId: { type: 'string', required: true, visibility: 'user-or-llm', description: 'Link ID' },
29+
period: {
30+
type: 'string',
31+
required: true,
32+
visibility: 'user-or-llm',
33+
description: 'Period: today, yesterday, last7, last30, total, week, month, lastmonth',
34+
},
35+
tz: { type: 'string', required: false, visibility: 'hidden', description: 'Timezone (default UTC)' },
36+
},
37+
request: {
38+
url: (params) => {
39+
const base = 'https://statistics.short.io/statistics/link/' + encodeURIComponent(params.linkId)
40+
const period = STATS_PERIOD_MAP[params.period] ?? params.period ?? 'last30'
41+
const q = new URLSearchParams({ period })
42+
if (params.tz) q.set('tz', params.tz)
43+
return `${base}?${q.toString()}`
44+
},
45+
method: 'GET',
46+
headers: (params) => ({
47+
Authorization: params.apiKey,
48+
Accept: 'application/json',
49+
}),
50+
},
51+
transformResponse: async (response: Response) => {
52+
if (!response.ok) {
53+
const err = await response.text().catch(() => response.statusText)
54+
return { success: false, output: { success: false, error: err } }
55+
}
56+
const data = await response.json().catch(() => ({}))
57+
const totalClicks = data.totalClicks ?? data.clicks ?? 0
58+
const humanClicks = data.humanClicks ?? totalClicks
59+
return {
60+
success: true,
61+
output: {
62+
success: true,
63+
clicks: totalClicks,
64+
totalClicks,
65+
humanClicks,
66+
totalClicksChange: data.totalClicksChange,
67+
humanClicksChange: data.humanClicksChange,
68+
referer: data.referer ?? [],
69+
country: data.country ?? [],
70+
browser: data.browser ?? [],
71+
os: data.os ?? [],
72+
city: data.city ?? [],
73+
device: data.device ?? [],
74+
social: data.social ?? [],
75+
utmMedium: data.utm_medium ?? [],
76+
utmSource: data.utm_source ?? [],
77+
utmCampaign: data.utm_campaign ?? [],
78+
clickStatistics: data.clickStatistics,
79+
interval: data.interval,
80+
},
81+
}
82+
},
83+
outputs: {
84+
success: { type: 'boolean', description: 'Success status' },
85+
clicks: { type: 'number', description: 'Total clicks in period' },
86+
totalClicks: { type: 'number', description: 'Total clicks' },
87+
humanClicks: { type: 'number', description: 'Human clicks' },
88+
totalClicksChange: { type: 'string', description: 'Change vs previous period' },
89+
humanClicksChange: { type: 'string', description: 'Human clicks change' },
90+
referer: { type: 'array', description: 'Referrer breakdown (referer, score)' },
91+
country: { type: 'array', description: 'Country breakdown (countryName, country, score)' },
92+
browser: { type: 'array', description: 'Browser breakdown (browser, score)' },
93+
os: { type: 'array', description: 'OS breakdown (os, score)' },
94+
city: { type: 'array', description: 'City breakdown (city, name, countryCode, score)' },
95+
device: { type: 'array', description: 'Device breakdown' },
96+
social: { type: 'array', description: 'Social source breakdown (social, score)' },
97+
utmMedium: { type: 'array', description: 'UTM medium breakdown' },
98+
utmSource: { type: 'array', description: 'UTM source breakdown' },
99+
utmCampaign: { type: 'array', description: 'UTM campaign breakdown' },
100+
clickStatistics: {
101+
type: 'object',
102+
description: 'Time-series click data (datasets with x/y points per interval)',
103+
},
104+
interval: {
105+
type: 'object',
106+
description: 'Date range (startDate, endDate, prevStartDate, prevEndDate, tz)',
107+
},
108+
error: { type: 'string', description: 'Error message' },
109+
},
110+
}

‎apps/sim/tools/short_io/get_qr_code.ts‎

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
import type { ShortIoGetQrParams } from '@/tools/short_io/types'
2+
import type { ToolConfig, ToolResponse } from '@/tools/types'
3+
4+
export const shortIoGetQrCodeTool: ToolConfig<ShortIoGetQrParams, ToolResponse> = {
5+
id: 'short_io_get_qr_code',
6+
name: 'Short.io Generate QR Code',
7+
description: 'Generate a QR code for a Short.io link (POST /links/qr/{linkIdString}).',
8+
version: '1.0',
9+
params: {
10+
apiKey: {
11+
type: 'string',
12+
required: true,
13+
visibility: 'hidden',
14+
description: 'Short.io Secret API Key',
15+
},
16+
linkId: {
17+
type: 'string',
18+
required: true,
19+
visibility: 'user-or-llm',
20+
description: 'Link ID (e.g. lnk_abc123_abcdef)',
21+
},
22+
color: {
23+
type: 'string',
24+
required: false,
25+
visibility: 'user-or-llm',
26+
description: 'QR color hex (e.g. 000000)',
27+
},
28+
backgroundColor: {
29+
type: 'string',
30+
required: false,
31+
visibility: 'user-or-llm',
32+
description: 'Background color hex (e.g. FFFFFF)',
33+
},
34+
size: { type: 'number', required: false, visibility: 'user-or-llm', description: 'QR size 1–99' },
35+
type: {
36+
type: 'string',
37+
required: false,
38+
visibility: 'user-or-llm',
39+
description: 'Output format: png or svg',
40+
},
41+
useDomainSettings: {
42+
type: 'boolean',
43+
required: false,
44+
visibility: 'hidden',
45+
description: 'Use domain settings (default true)',
46+
},
47+
},
48+
request: {
49+
url: (params) => `https://api.short.io/links/qr/${params.linkId}`,
50+
method: 'POST',
51+
headers: (params) => ({
52+
Authorization: params.apiKey,
53+
'Content-Type': 'application/json',
54+
}),
55+
body: (params) => {
56+
const body: Record<string, unknown> = {
57+
useDomainSettings: params.useDomainSettings ?? true,
58+
}
59+
if (params.color != null && params.color !== '') body.color = params.color
60+
if (params.backgroundColor != null && params.backgroundColor !== '') body.backgroundColor = params.backgroundColor
61+
if (params.size != null && params.size >= 1 && params.size <= 99) body.size = params.size
62+
if (params.type === 'svg' || params.type === 'png') body.type = params.type
63+
return body
64+
},
65+
},
66+
transformResponse: async (response: Response) => {
67+
if (!response.ok) {
68+
const err = await response.text().catch(() => response.statusText)
69+
return { success: false, output: { success: false, error: err } }
70+
}
71+
72+
const contentType = response.headers.get('Content-Type') ?? ''
73+
const blob = await response.blob()
74+
const arrayBuffer = await blob.arrayBuffer()
75+
const bytes = new Uint8Array(arrayBuffer)
76+
let binary = ''
77+
for (let i = 0; i < bytes.length; i++) binary += String.fromCharCode(bytes[i]!)
78+
const base64 = typeof btoa !== 'undefined' ? btoa(binary) : ''
79+
const mediaType = contentType.split(';')[0]?.trim() || 'image/png'
80+
const dataUrl = base64 ? `data:${mediaType};base64,${base64}` : ''
81+
return {
82+
success: true,
83+
output: { success: true, qrCodeURL: dataUrl },
84+
}
85+
},
86+
outputs: {
87+
success: { type: 'boolean', description: 'Success status' },
88+
qrCodeURL: {
89+
type: 'string',
90+
description: 'Base64 data URL of the QR code image (e.g. data:image/png;base64,...)',
91+
},
92+
error: { type: 'string', description: 'Error message' },
93+
},
94+
}

‎apps/sim/tools/short_io/index.ts‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
export { shortIoCreateLinkTool } from '@/tools/short_io/create_link'
2+
export { shortIoDeleteLinkTool } from '@/tools/short_io/delete_link'
3+
export { shortIoGetAnalyticsTool } from '@/tools/short_io/get_analytics'
4+
export { shortIoGetQrCodeTool } from '@/tools/short_io/get_qr_code'
5+
export { shortIoListDomainsTool } from '@/tools/short_io/list_domains'
6+
export { shortIoListLinksTool } from '@/tools/short_io/list_links'

0 commit comments

Comments
 (0)