@alpic-ai/api 0.0.0-dev.gf302e2f → 0.0.0-dev.gf378a72
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/dist/index.d.mts +647 -85
- package/dist/index.mjs +227 -87
- package/package.json +2 -2
package/dist/index.mjs
CHANGED
|
@@ -179,6 +179,7 @@ const PLATFORM_LABELS = {
|
|
|
179
179
|
};
|
|
180
180
|
const WAF_PLATFORMS = [
|
|
181
181
|
"akamai",
|
|
182
|
+
"cato",
|
|
182
183
|
"cloudflare",
|
|
183
184
|
"fastly"
|
|
184
185
|
];
|
|
@@ -256,6 +257,25 @@ z.object({
|
|
|
256
257
|
clientSecret: z.string(),
|
|
257
258
|
clientScopes: z.array(z.string())
|
|
258
259
|
});
|
|
260
|
+
const creditEntryReasonSchema = z.enum([
|
|
261
|
+
"free_seed",
|
|
262
|
+
"paid_conversion_floor",
|
|
263
|
+
"top_up",
|
|
264
|
+
"usage",
|
|
265
|
+
"admin_adjustment"
|
|
266
|
+
]);
|
|
267
|
+
z.enum(["playground"]);
|
|
268
|
+
z.number().int().min(500);
|
|
269
|
+
const creditActivityEntrySchema = z.object({
|
|
270
|
+
reason: creditEntryReasonSchema,
|
|
271
|
+
day: z.number(),
|
|
272
|
+
amountInNanoUSD: z.number(),
|
|
273
|
+
messageCount: z.number().nullable()
|
|
274
|
+
});
|
|
275
|
+
z.object({
|
|
276
|
+
balanceInNanoUSD: z.number(),
|
|
277
|
+
recentActivity: z.array(creditActivityEntrySchema)
|
|
278
|
+
});
|
|
259
279
|
const deploymentStatusSchema$1 = z.enum([
|
|
260
280
|
"ongoing",
|
|
261
281
|
"deployed",
|
|
@@ -402,7 +422,7 @@ z.object({
|
|
|
402
422
|
collectUserData: z.boolean(),
|
|
403
423
|
identityTraitKey: z.string().min(1).max(200).nullable()
|
|
404
424
|
});
|
|
405
|
-
z.object({
|
|
425
|
+
const feedbackSchema = z.object({
|
|
406
426
|
id: z.string(),
|
|
407
427
|
createdAt: z.coerce.date(),
|
|
408
428
|
environmentId: z.string(),
|
|
@@ -424,7 +444,7 @@ const intentCategoryColorSchema = z.enum([
|
|
|
424
444
|
"pink",
|
|
425
445
|
"gray"
|
|
426
446
|
]);
|
|
427
|
-
intentCategoryColorSchema.options;
|
|
447
|
+
const INTENT_CATEGORY_COLORS = intentCategoryColorSchema.options;
|
|
428
448
|
const intentCategorySchema = z.object({
|
|
429
449
|
id: z.string(),
|
|
430
450
|
createdAt: z.coerce.date(),
|
|
@@ -432,7 +452,7 @@ const intentCategorySchema = z.object({
|
|
|
432
452
|
name: z.string(),
|
|
433
453
|
color: intentCategoryColorSchema
|
|
434
454
|
});
|
|
435
|
-
z.object({
|
|
455
|
+
const intentCategorySummarySchema = z.object({
|
|
436
456
|
id: z.string(),
|
|
437
457
|
name: z.string(),
|
|
438
458
|
color: intentCategoryColorSchema,
|
|
@@ -1398,6 +1418,11 @@ const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
|
1398
1418
|
});
|
|
1399
1419
|
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1400
1420
|
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1421
|
+
z.literal([
|
|
1422
|
+
100,
|
|
1423
|
+
75,
|
|
1424
|
+
50
|
|
1425
|
+
]);
|
|
1401
1426
|
const subscriptionPlanSchema = z.enum([
|
|
1402
1427
|
"pro",
|
|
1403
1428
|
"business",
|
|
@@ -1546,21 +1571,20 @@ const deploymentSchema = z.object({
|
|
|
1546
1571
|
isCurrent: z.boolean(),
|
|
1547
1572
|
deploymentPageUrl: z.url().nullable()
|
|
1548
1573
|
});
|
|
1549
|
-
const
|
|
1574
|
+
const isValidTimeInput = (value) => {
|
|
1550
1575
|
if (ms(value) !== void 0) return true;
|
|
1551
1576
|
return !Number.isNaN(new Date(value).getTime());
|
|
1552
1577
|
};
|
|
1553
|
-
const
|
|
1578
|
+
const timeInputSchema = z.string().refine(isValidTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." });
|
|
1579
|
+
const base = oc.errors({ BAD_REQUEST: {} });
|
|
1580
|
+
const createEnvironmentContractV1 = base.route({
|
|
1554
1581
|
path: "/v1/environments",
|
|
1555
1582
|
method: "POST",
|
|
1556
1583
|
summary: "Create an environment",
|
|
1557
1584
|
description: "Create an environment for a project",
|
|
1558
1585
|
tags: ["environments"],
|
|
1559
1586
|
successDescription: "The environment has been created successfully"
|
|
1560
|
-
}).errors({
|
|
1561
|
-
NOT_FOUND: {},
|
|
1562
|
-
BAD_REQUEST: {}
|
|
1563
|
-
}).input(z.object({
|
|
1587
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1564
1588
|
projectId: z.string().describe("The ID of the project to create the environment for"),
|
|
1565
1589
|
name: z.string().min(1).describe("The name of the environment"),
|
|
1566
1590
|
sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
|
|
@@ -1573,7 +1597,7 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
1573
1597
|
createdAt: z.coerce.date(),
|
|
1574
1598
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
1575
1599
|
}));
|
|
1576
|
-
const getEnvironmentContractV1 =
|
|
1600
|
+
const getEnvironmentContractV1 = base.route({
|
|
1577
1601
|
path: "/v1/environments/{environmentId}",
|
|
1578
1602
|
method: "GET",
|
|
1579
1603
|
summary: "Get an environment",
|
|
@@ -1630,7 +1654,7 @@ const projectOutputSchema = z.object({
|
|
|
1630
1654
|
productionEnvironment: productionEnvironmentSchema.nullable(),
|
|
1631
1655
|
environments: z.array(environmentSchema)
|
|
1632
1656
|
});
|
|
1633
|
-
const getProjectContractV1 =
|
|
1657
|
+
const getProjectContractV1 = base.route({
|
|
1634
1658
|
path: "/v1/projects/{projectId}",
|
|
1635
1659
|
method: "GET",
|
|
1636
1660
|
summary: "Get a project",
|
|
@@ -1638,18 +1662,15 @@ const getProjectContractV1 = oc.route({
|
|
|
1638
1662
|
tags: ["projects"],
|
|
1639
1663
|
successDescription: "The project details"
|
|
1640
1664
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
|
|
1641
|
-
const listProjectsContractV1 =
|
|
1665
|
+
const listProjectsContractV1 = base.route({
|
|
1642
1666
|
path: "/v1/projects",
|
|
1643
1667
|
method: "GET",
|
|
1644
1668
|
summary: "List projects",
|
|
1645
1669
|
description: "List all projects for a team",
|
|
1646
1670
|
tags: ["projects"],
|
|
1647
1671
|
successDescription: "The list of projects"
|
|
1648
|
-
}).errors({
|
|
1649
|
-
|
|
1650
|
-
BAD_REQUEST: {}
|
|
1651
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1652
|
-
const createProjectContractV1 = oc.route({
|
|
1672
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1673
|
+
const createProjectContractV1 = base.route({
|
|
1653
1674
|
path: "/v1/projects",
|
|
1654
1675
|
method: "POST",
|
|
1655
1676
|
summary: "Create a project",
|
|
@@ -1658,7 +1679,6 @@ const createProjectContractV1 = oc.route({
|
|
|
1658
1679
|
successDescription: "The project has been created successfully"
|
|
1659
1680
|
}).errors({
|
|
1660
1681
|
NOT_FOUND: {},
|
|
1661
|
-
BAD_REQUEST: {},
|
|
1662
1682
|
FORBIDDEN: {}
|
|
1663
1683
|
}).input(z.object({
|
|
1664
1684
|
teamId: z.string().optional(),
|
|
@@ -1699,7 +1719,7 @@ const environmentVariableOutputSchema = z.object({
|
|
|
1699
1719
|
isSecret: z.boolean(),
|
|
1700
1720
|
createdAt: z.coerce.date()
|
|
1701
1721
|
});
|
|
1702
|
-
const listEnvironmentVariablesContractV1 =
|
|
1722
|
+
const listEnvironmentVariablesContractV1 = base.route({
|
|
1703
1723
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1704
1724
|
method: "GET",
|
|
1705
1725
|
summary: "List environment variables",
|
|
@@ -1707,48 +1727,39 @@ const listEnvironmentVariablesContractV1 = oc.route({
|
|
|
1707
1727
|
tags: ["environments"],
|
|
1708
1728
|
successDescription: "The list of environment variables"
|
|
1709
1729
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
|
|
1710
|
-
const createEnvironmentVariablesContractV1 =
|
|
1730
|
+
const createEnvironmentVariablesContractV1 = base.route({
|
|
1711
1731
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1712
1732
|
method: "POST",
|
|
1713
1733
|
summary: "Add environment variables",
|
|
1714
1734
|
description: "Add one or more environment variables to an environment",
|
|
1715
1735
|
tags: ["environments"],
|
|
1716
1736
|
successDescription: "The environment variables have been added successfully"
|
|
1717
|
-
}).errors({
|
|
1718
|
-
NOT_FOUND: {},
|
|
1719
|
-
BAD_REQUEST: {}
|
|
1720
|
-
}).input(z.object({
|
|
1737
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1721
1738
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1722
1739
|
environmentVariables: environmentVariablesSchema
|
|
1723
1740
|
})).output(z.object({ success: z.literal(true) }));
|
|
1724
|
-
const updateEnvironmentVariableContractV1 =
|
|
1741
|
+
const updateEnvironmentVariableContractV1 = base.route({
|
|
1725
1742
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1726
1743
|
method: "PATCH",
|
|
1727
1744
|
summary: "Update an environment variable",
|
|
1728
1745
|
description: "Update an environment variable by ID",
|
|
1729
1746
|
tags: ["environments"],
|
|
1730
1747
|
successDescription: "The environment variable has been updated successfully"
|
|
1731
|
-
}).errors({
|
|
1732
|
-
NOT_FOUND: {},
|
|
1733
|
-
BAD_REQUEST: {}
|
|
1734
|
-
}).input(z.object({
|
|
1748
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1735
1749
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
1736
1750
|
key: environmentVariableSchema.shape.key,
|
|
1737
1751
|
value: environmentVariableSchema.shape.value.optional(),
|
|
1738
1752
|
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
1739
1753
|
})).output(z.object({ success: z.literal(true) }));
|
|
1740
|
-
const deleteEnvironmentVariableContractV1 =
|
|
1754
|
+
const deleteEnvironmentVariableContractV1 = base.route({
|
|
1741
1755
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1742
1756
|
method: "DELETE",
|
|
1743
1757
|
summary: "Delete an environment variable",
|
|
1744
1758
|
description: "Delete an environment variable by ID",
|
|
1745
1759
|
tags: ["environments"],
|
|
1746
1760
|
successDescription: "The environment variable has been deleted successfully"
|
|
1747
|
-
}).errors({
|
|
1748
|
-
|
|
1749
|
-
BAD_REQUEST: {}
|
|
1750
|
-
}).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1751
|
-
const deleteProjectContractV1 = oc.route({
|
|
1761
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1762
|
+
const deleteProjectContractV1 = base.route({
|
|
1752
1763
|
path: "/v1/projects/{projectId}",
|
|
1753
1764
|
method: "DELETE",
|
|
1754
1765
|
summary: "Delete a project",
|
|
@@ -1756,7 +1767,7 @@ const deleteProjectContractV1 = oc.route({
|
|
|
1756
1767
|
tags: ["projects"],
|
|
1757
1768
|
successDescription: "The project has been deleted successfully"
|
|
1758
1769
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(z.object({ success: z.literal(true) }));
|
|
1759
|
-
const updateProjectContractV1 =
|
|
1770
|
+
const updateProjectContractV1 = base.route({
|
|
1760
1771
|
path: "/v1/projects/{projectId}",
|
|
1761
1772
|
method: "PATCH",
|
|
1762
1773
|
summary: "Update a project",
|
|
@@ -1765,14 +1776,13 @@ const updateProjectContractV1 = oc.route({
|
|
|
1765
1776
|
successDescription: "The project has been updated successfully"
|
|
1766
1777
|
}).errors({
|
|
1767
1778
|
NOT_FOUND: {},
|
|
1768
|
-
BAD_REQUEST: {},
|
|
1769
1779
|
FORBIDDEN: {}
|
|
1770
1780
|
}).input(z.object({
|
|
1771
1781
|
projectId: z.string().describe("The ID of the project"),
|
|
1772
1782
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
1773
1783
|
sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
|
|
1774
1784
|
})).output(projectOutputSchema);
|
|
1775
|
-
const deployEnvironmentContractV1 =
|
|
1785
|
+
const deployEnvironmentContractV1 = base.route({
|
|
1776
1786
|
path: "/v1/environments/{environmentId}/deploy",
|
|
1777
1787
|
method: "POST",
|
|
1778
1788
|
summary: "Deploy an environment",
|
|
@@ -1781,29 +1791,25 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
1781
1791
|
successDescription: "The environment has been deployed successfully"
|
|
1782
1792
|
}).errors({
|
|
1783
1793
|
NOT_FOUND: {},
|
|
1784
|
-
BAD_REQUEST: {},
|
|
1785
1794
|
CONFLICT: {}
|
|
1786
1795
|
}).input(z.object({
|
|
1787
1796
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
1788
1797
|
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1789
1798
|
settings: buildSettingsSchema.extend({ transport: transportSchema }).optional().describe("Project settings detected by the client from the source. When provided, the server skips downloading and extracting the source archive to detect them.")
|
|
1790
1799
|
})).output(deploymentSchema);
|
|
1791
|
-
const uploadDeploymentArtifactContractV1 =
|
|
1800
|
+
const uploadDeploymentArtifactContractV1 = base.route({
|
|
1792
1801
|
path: "/v1/deployments/upload",
|
|
1793
1802
|
method: "POST",
|
|
1794
1803
|
summary: "Upload deployment artifacts",
|
|
1795
1804
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
1796
1805
|
tags: ["deployments"],
|
|
1797
1806
|
successDescription: "The presigned upload URL has been generated successfully"
|
|
1798
|
-
}).errors({
|
|
1799
|
-
NOT_FOUND: {},
|
|
1800
|
-
BAD_REQUEST: {}
|
|
1801
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1807
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1802
1808
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
1803
1809
|
token: z.string().describe("Token to identify the source archive"),
|
|
1804
1810
|
expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
|
|
1805
1811
|
}));
|
|
1806
|
-
const listDeploymentsContractV1 =
|
|
1812
|
+
const listDeploymentsContractV1 = base.route({
|
|
1807
1813
|
path: "/v1/projects/{projectId}/deployments",
|
|
1808
1814
|
method: "GET",
|
|
1809
1815
|
summary: "List project deployments",
|
|
@@ -1815,7 +1821,7 @@ const listDeploymentsContractV1 = oc.route({
|
|
|
1815
1821
|
status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
|
|
1816
1822
|
environmentId: z.string().optional().describe("Filter by environment ID")
|
|
1817
1823
|
})).output(z.array(deploymentSchema));
|
|
1818
|
-
const getDeploymentContractV1 =
|
|
1824
|
+
const getDeploymentContractV1 = base.route({
|
|
1819
1825
|
path: "/v1/deployments/{deploymentId}",
|
|
1820
1826
|
method: "GET",
|
|
1821
1827
|
summary: "Get a deployment",
|
|
@@ -1838,20 +1844,17 @@ const logEntrySchema = z.object({
|
|
|
1838
1844
|
method: z.string().optional(),
|
|
1839
1845
|
durationInMs: z.number().optional()
|
|
1840
1846
|
});
|
|
1841
|
-
const getLogsContractV1 =
|
|
1847
|
+
const getLogsContractV1 = base.route({
|
|
1842
1848
|
path: "/v1/environments/{environmentId}/logs",
|
|
1843
1849
|
method: "GET",
|
|
1844
1850
|
summary: "Get logs",
|
|
1845
1851
|
description: "Get logs for an environment",
|
|
1846
1852
|
tags: ["environments"],
|
|
1847
1853
|
successDescription: "The logs"
|
|
1848
|
-
}).errors({
|
|
1849
|
-
NOT_FOUND: {},
|
|
1850
|
-
BAD_REQUEST: {}
|
|
1851
|
-
}).input(z.object({
|
|
1854
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1852
1855
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1853
|
-
since:
|
|
1854
|
-
until:
|
|
1856
|
+
since: timeInputSchema.optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
1857
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1855
1858
|
limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
|
|
1856
1859
|
level: z.array(z.enum([
|
|
1857
1860
|
"INFO",
|
|
@@ -1865,17 +1868,14 @@ const getLogsContractV1 = oc.route({
|
|
|
1865
1868
|
logs: z.array(logEntrySchema),
|
|
1866
1869
|
nextToken: z.string().nullable()
|
|
1867
1870
|
}));
|
|
1868
|
-
const getLatestLogsContractV1 =
|
|
1871
|
+
const getLatestLogsContractV1 = base.route({
|
|
1869
1872
|
path: "/v1/environments/{environmentId}/latest-logs",
|
|
1870
1873
|
method: "GET",
|
|
1871
1874
|
summary: "Get latest logs",
|
|
1872
1875
|
description: "Get the N most recent logs for an environment",
|
|
1873
1876
|
tags: ["environments"],
|
|
1874
1877
|
successDescription: "The latest logs"
|
|
1875
|
-
}).errors({
|
|
1876
|
-
NOT_FOUND: {},
|
|
1877
|
-
BAD_REQUEST: {}
|
|
1878
|
-
}).input(z.object({
|
|
1878
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1879
1879
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1880
1880
|
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
1881
1881
|
level: z.array(z.enum([
|
|
@@ -1886,7 +1886,7 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
1886
1886
|
])).optional().describe("Filter by log level"),
|
|
1887
1887
|
search: z.string().optional().describe("Filter pattern to search for in log content")
|
|
1888
1888
|
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
1889
|
-
const getDeploymentLogsContractV1 =
|
|
1889
|
+
const getDeploymentLogsContractV1 = base.route({
|
|
1890
1890
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
1891
1891
|
method: "GET",
|
|
1892
1892
|
summary: "Get deployment logs",
|
|
@@ -1913,17 +1913,14 @@ const analyticsTimeSeriesSchema = z.object({
|
|
|
1913
1913
|
output_token_mean: z.array(analyticsDataPointSchema),
|
|
1914
1914
|
task_count: z.array(analyticsDataPointSchema)
|
|
1915
1915
|
});
|
|
1916
|
-
const getProjectAnalyticsContractV1 =
|
|
1916
|
+
const getProjectAnalyticsContractV1 = base.route({
|
|
1917
1917
|
path: "/v1/analytics/{projectId}",
|
|
1918
1918
|
method: "GET",
|
|
1919
1919
|
summary: "Get project analytics",
|
|
1920
1920
|
description: "Get analytics data for a project over a time range",
|
|
1921
1921
|
tags: ["analytics"],
|
|
1922
1922
|
successDescription: "The project analytics data"
|
|
1923
|
-
}).errors({
|
|
1924
|
-
NOT_FOUND: {},
|
|
1925
|
-
BAD_REQUEST: {}
|
|
1926
|
-
}).input(z.object({
|
|
1923
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1927
1924
|
projectId: z.string().describe("The ID of the project"),
|
|
1928
1925
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
1929
1926
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
@@ -1938,7 +1935,132 @@ const getProjectAnalyticsContractV1 = oc.route({
|
|
|
1938
1935
|
}),
|
|
1939
1936
|
timeSeries: analyticsTimeSeriesSchema
|
|
1940
1937
|
}));
|
|
1941
|
-
const
|
|
1938
|
+
const paginatedInsightsInputShape = {
|
|
1939
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
1940
|
+
since: timeInputSchema.default("7d").describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
1941
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1942
|
+
limit: z.coerce.number().int().min(1).max(200).default(50),
|
|
1943
|
+
offset: z.coerce.number().int().min(0).default(0),
|
|
1944
|
+
search: z.string().trim().min(1).max(200).optional()
|
|
1945
|
+
};
|
|
1946
|
+
const listIntentsContractV1 = base.route({
|
|
1947
|
+
path: "/v1/environments/{environmentId}/intents",
|
|
1948
|
+
method: "GET",
|
|
1949
|
+
summary: "List intents",
|
|
1950
|
+
description: "List grouped user intents for an environment over a time range",
|
|
1951
|
+
tags: ["insights"],
|
|
1952
|
+
successDescription: "The grouped user intents"
|
|
1953
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1954
|
+
...paginatedInsightsInputShape,
|
|
1955
|
+
tools: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
1956
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional(),
|
|
1957
|
+
categoryIds: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
1958
|
+
sortDir: z.enum(["asc", "desc"]).default("desc")
|
|
1959
|
+
})).output(z.object({
|
|
1960
|
+
intents: z.array(z.object({
|
|
1961
|
+
id: z.string(),
|
|
1962
|
+
intentIds: z.array(z.string()).min(1),
|
|
1963
|
+
environmentId: z.string(),
|
|
1964
|
+
message: z.string(),
|
|
1965
|
+
toolName: z.string(),
|
|
1966
|
+
createdAt: z.coerce.date(),
|
|
1967
|
+
occurrenceCount: z.number().int().positive(),
|
|
1968
|
+
clientName: z.string().nullable(),
|
|
1969
|
+
clientId: z.string().nullable(),
|
|
1970
|
+
categories: z.array(z.object({
|
|
1971
|
+
id: z.string(),
|
|
1972
|
+
name: z.string(),
|
|
1973
|
+
color: intentCategoryColorSchema
|
|
1974
|
+
}))
|
|
1975
|
+
})),
|
|
1976
|
+
totalCount: z.number().int().nonnegative()
|
|
1977
|
+
}));
|
|
1978
|
+
const listFeedbacksContractV1 = base.route({
|
|
1979
|
+
path: "/v1/environments/{environmentId}/feedbacks",
|
|
1980
|
+
method: "GET",
|
|
1981
|
+
summary: "List feedbacks",
|
|
1982
|
+
description: "List user feedback for an environment over a time range",
|
|
1983
|
+
tags: ["insights"],
|
|
1984
|
+
successDescription: "The user feedback"
|
|
1985
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1986
|
+
...paginatedInsightsInputShape,
|
|
1987
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional()
|
|
1988
|
+
})).output(z.object({
|
|
1989
|
+
feedbacks: z.array(feedbackSchema.extend({ clientId: z.string().nullable() })),
|
|
1990
|
+
totalCount: z.number().int().nonnegative()
|
|
1991
|
+
}));
|
|
1992
|
+
const intentCategoryNameSchema = z.string().trim().min(1).max(100).describe("The category name");
|
|
1993
|
+
const categorizableIntentIdsSchema = z.array(z.string().trim().min(1)).min(1).max(100).describe("IDs of the intents to categorize");
|
|
1994
|
+
const listIntentCategoriesContractV1 = base.route({
|
|
1995
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
1996
|
+
method: "GET",
|
|
1997
|
+
summary: "List intent categories",
|
|
1998
|
+
description: "List intent categories for an environment, including how many intents each category is linked to",
|
|
1999
|
+
tags: ["insights"],
|
|
2000
|
+
successDescription: "The intent categories"
|
|
2001
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(intentCategorySummarySchema));
|
|
2002
|
+
const createIntentCategoryContractV1 = base.route({
|
|
2003
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
2004
|
+
method: "POST",
|
|
2005
|
+
summary: "Create an intent category",
|
|
2006
|
+
description: "Create an intent category, optionally linking it to existing intents",
|
|
2007
|
+
tags: ["insights"],
|
|
2008
|
+
successDescription: "The created intent category"
|
|
2009
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2010
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2011
|
+
name: intentCategoryNameSchema,
|
|
2012
|
+
color: intentCategoryColorSchema.optional().describe("The category color; derived from the name when omitted"),
|
|
2013
|
+
intentIds: categorizableIntentIdsSchema.optional().describe("IDs of intents to link to the new category")
|
|
2014
|
+
})).output(intentCategorySchema);
|
|
2015
|
+
const updateIntentCategoryContractV1 = base.route({
|
|
2016
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2017
|
+
method: "PATCH",
|
|
2018
|
+
summary: "Update an intent category",
|
|
2019
|
+
description: "Rename or recolor an intent category",
|
|
2020
|
+
tags: ["insights"],
|
|
2021
|
+
successDescription: "The updated intent category"
|
|
2022
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2023
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2024
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2025
|
+
name: intentCategoryNameSchema.optional(),
|
|
2026
|
+
color: intentCategoryColorSchema.optional().describe("The category color")
|
|
2027
|
+
}).refine(({ name, color }) => name !== void 0 || color !== void 0, { message: "At least one of name or color must be provided" })).output(intentCategorySchema);
|
|
2028
|
+
const deleteIntentCategoryContractV1 = base.route({
|
|
2029
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2030
|
+
method: "DELETE",
|
|
2031
|
+
summary: "Delete an intent category",
|
|
2032
|
+
description: "Delete an intent category; its intents are unlinked but not deleted",
|
|
2033
|
+
tags: ["insights"],
|
|
2034
|
+
successDescription: "The intent category has been deleted successfully"
|
|
2035
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2036
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2037
|
+
categoryId: z.string().describe("The ID of the category")
|
|
2038
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2039
|
+
const linkIntentCategoryContractV1 = base.route({
|
|
2040
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/link",
|
|
2041
|
+
method: "POST",
|
|
2042
|
+
summary: "Link an intent category",
|
|
2043
|
+
description: "Link an intent category to intents; already linked intents are ignored",
|
|
2044
|
+
tags: ["insights"],
|
|
2045
|
+
successDescription: "The intents have been linked successfully"
|
|
2046
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2047
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2048
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2049
|
+
intentIds: categorizableIntentIdsSchema
|
|
2050
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2051
|
+
const unlinkIntentCategoryContractV1 = base.route({
|
|
2052
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/unlink",
|
|
2053
|
+
method: "POST",
|
|
2054
|
+
summary: "Unlink an intent category",
|
|
2055
|
+
description: "Unlink an intent category from intents; intents without the category are ignored",
|
|
2056
|
+
tags: ["insights"],
|
|
2057
|
+
successDescription: "The intents have been unlinked successfully"
|
|
2058
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2059
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2060
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2061
|
+
intentIds: categorizableIntentIdsSchema
|
|
2062
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2063
|
+
const listTeamsContractV1 = base.route({
|
|
1942
2064
|
path: "/v1/teams",
|
|
1943
2065
|
method: "GET",
|
|
1944
2066
|
summary: "List teams",
|
|
@@ -1951,7 +2073,22 @@ const listTeamsContractV1 = oc.route({
|
|
|
1951
2073
|
createdAt: z.coerce.date(),
|
|
1952
2074
|
hasStripeAccount: z.boolean()
|
|
1953
2075
|
})));
|
|
1954
|
-
const
|
|
2076
|
+
const getTeamUsageContractV1 = base.route({
|
|
2077
|
+
path: "/v1/teams/{teamId}/usage",
|
|
2078
|
+
method: "GET",
|
|
2079
|
+
summary: "Get team usage",
|
|
2080
|
+
description: "Get the MCP request usage of a team for its current billing window. A team that has made no request in the window reports zero.",
|
|
2081
|
+
tags: ["teams"],
|
|
2082
|
+
successDescription: "The current billing window usage"
|
|
2083
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().describe("The ID of the team") })).output(z.object({
|
|
2084
|
+
teamId: z.string(),
|
|
2085
|
+
plan: subscriptionPlanSchema.nullable().describe("The plan in force for the window, null on the Free plan"),
|
|
2086
|
+
periodStart: z.coerce.date().describe("Start of the current billing window"),
|
|
2087
|
+
periodEnd: z.coerce.date().describe("End of the current billing window"),
|
|
2088
|
+
requestCount: z.number().int().describe("MCP requests settled during the current billing window"),
|
|
2089
|
+
includedRequests: z.number().int().nullable().describe("Requests included in the plan for one window, null when the allowance is contract-specific")
|
|
2090
|
+
}));
|
|
2091
|
+
const getTunnelTicketContractV1 = base.route({
|
|
1955
2092
|
path: "/v1/tunnels/ticket",
|
|
1956
2093
|
method: "GET",
|
|
1957
2094
|
summary: "Get a tunnel ticket",
|
|
@@ -1963,16 +2100,13 @@ const getTunnelTicketContractV1 = oc.route({
|
|
|
1963
2100
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1964
2101
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
1965
2102
|
}));
|
|
1966
|
-
const publishServerContractV1 =
|
|
2103
|
+
const publishServerContractV1 = base.route({
|
|
1967
2104
|
path: "/v1/distribution/publish",
|
|
1968
2105
|
method: "POST",
|
|
1969
2106
|
summary: "Publish a server to the MCP registry",
|
|
1970
2107
|
tags: ["distribution"],
|
|
1971
2108
|
successDescription: "The server has been published successfully"
|
|
1972
|
-
}).errors({
|
|
1973
|
-
NOT_FOUND: {},
|
|
1974
|
-
BAD_REQUEST: {}
|
|
1975
|
-
}).input(z.object({
|
|
2109
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1976
2110
|
projectId: z.string(),
|
|
1977
2111
|
domain: z.string(),
|
|
1978
2112
|
title: z.string().min(1).max(100),
|
|
@@ -1981,17 +2115,14 @@ const publishServerContractV1 = oc.route({
|
|
|
1981
2115
|
iconSrc: z.url().max(255).optional(),
|
|
1982
2116
|
dryRun: z.boolean().optional()
|
|
1983
2117
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
1984
|
-
const getServerInfoContractV1 =
|
|
2118
|
+
const getServerInfoContractV1 = base.route({
|
|
1985
2119
|
path: "/v1/distribution/get",
|
|
1986
2120
|
method: "GET",
|
|
1987
2121
|
summary: "Get server info",
|
|
1988
2122
|
description: "Get info about a server",
|
|
1989
2123
|
tags: ["distribution"],
|
|
1990
2124
|
successDescription: "The server info"
|
|
1991
|
-
}).errors({
|
|
1992
|
-
NOT_FOUND: {},
|
|
1993
|
-
BAD_REQUEST: {}
|
|
1994
|
-
}).input(z.object({
|
|
2125
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1995
2126
|
projectId: z.string(),
|
|
1996
2127
|
domain: z.string()
|
|
1997
2128
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
@@ -2010,7 +2141,7 @@ const playgroundOutputSchema = z.object({
|
|
|
2010
2141
|
isPlaygroundEnabled: z.boolean(),
|
|
2011
2142
|
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
2012
2143
|
});
|
|
2013
|
-
const getPlaygroundContractV1 =
|
|
2144
|
+
const getPlaygroundContractV1 = base.route({
|
|
2014
2145
|
path: "/v1/environments/{environmentId}/playground",
|
|
2015
2146
|
method: "GET",
|
|
2016
2147
|
summary: "Get playground configuration",
|
|
@@ -2018,17 +2149,14 @@ const getPlaygroundContractV1 = oc.route({
|
|
|
2018
2149
|
tags: ["environments"],
|
|
2019
2150
|
successDescription: "The playground configuration"
|
|
2020
2151
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
2021
|
-
const upsertPlaygroundContractV1 =
|
|
2152
|
+
const upsertPlaygroundContractV1 = base.route({
|
|
2022
2153
|
path: "/v1/environments/{environmentId}/playground",
|
|
2023
2154
|
method: "PUT",
|
|
2024
2155
|
summary: "Update playground configuration",
|
|
2025
2156
|
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
2026
2157
|
tags: ["environments"],
|
|
2027
2158
|
successDescription: "The updated playground configuration"
|
|
2028
|
-
}).errors({
|
|
2029
|
-
NOT_FOUND: {},
|
|
2030
|
-
BAD_REQUEST: {}
|
|
2031
|
-
}).input(z.object({
|
|
2159
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2032
2160
|
environmentId: z.string().describe("The ID of the environment"),
|
|
2033
2161
|
isPlaygroundEnabled: z.boolean().optional(),
|
|
2034
2162
|
name: z.string().min(1).max(100).optional(),
|
|
@@ -2036,7 +2164,7 @@ const upsertPlaygroundContractV1 = oc.route({
|
|
|
2036
2164
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
2037
2165
|
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
2038
2166
|
})).output(playgroundOutputSchema);
|
|
2039
|
-
const createBeaconContractV1 =
|
|
2167
|
+
const createBeaconContractV1 = base.route({
|
|
2040
2168
|
path: "/v1/beacon/audits",
|
|
2041
2169
|
method: "POST",
|
|
2042
2170
|
summary: "Create a beacon audit",
|
|
@@ -2045,7 +2173,6 @@ const createBeaconContractV1 = oc.route({
|
|
|
2045
2173
|
successDescription: "The audit has been created"
|
|
2046
2174
|
}).errors({
|
|
2047
2175
|
NOT_FOUND: {},
|
|
2048
|
-
BAD_REQUEST: {},
|
|
2049
2176
|
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
2050
2177
|
}).input(z.object({
|
|
2051
2178
|
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
@@ -2053,7 +2180,7 @@ const createBeaconContractV1 = oc.route({
|
|
|
2053
2180
|
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
2054
2181
|
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
2055
2182
|
})).output(z.object({ id: z.string() }));
|
|
2056
|
-
const getBeaconContractV1 =
|
|
2183
|
+
const getBeaconContractV1 = base.route({
|
|
2057
2184
|
path: "/v1/beacon/audits/{auditId}",
|
|
2058
2185
|
method: "GET",
|
|
2059
2186
|
summary: "Get a beacon audit",
|
|
@@ -2069,8 +2196,21 @@ const getBeaconContractV1 = oc.route({
|
|
|
2069
2196
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
2070
2197
|
}));
|
|
2071
2198
|
const contract = {
|
|
2072
|
-
teams: {
|
|
2199
|
+
teams: {
|
|
2200
|
+
list: { v1: listTeamsContractV1 },
|
|
2201
|
+
getUsage: { v1: getTeamUsageContractV1 }
|
|
2202
|
+
},
|
|
2073
2203
|
analytics: { get: { v1: getProjectAnalyticsContractV1 } },
|
|
2204
|
+
intents: { list: { v1: listIntentsContractV1 } },
|
|
2205
|
+
intentCategories: {
|
|
2206
|
+
list: { v1: listIntentCategoriesContractV1 },
|
|
2207
|
+
create: { v1: createIntentCategoryContractV1 },
|
|
2208
|
+
update: { v1: updateIntentCategoryContractV1 },
|
|
2209
|
+
delete: { v1: deleteIntentCategoryContractV1 },
|
|
2210
|
+
link: { v1: linkIntentCategoryContractV1 },
|
|
2211
|
+
unlink: { v1: unlinkIntentCategoryContractV1 }
|
|
2212
|
+
},
|
|
2213
|
+
feedbacks: { list: { v1: listFeedbacksContractV1 } },
|
|
2074
2214
|
deployments: {
|
|
2075
2215
|
list: { v1: listDeploymentsContractV1 },
|
|
2076
2216
|
get: { v1: getDeploymentContractV1 },
|
|
@@ -2117,4 +2257,4 @@ const contractForDocs = {
|
|
|
2117
2257
|
deployments: deploymentsForDocs
|
|
2118
2258
|
};
|
|
2119
2259
|
//#endregion
|
|
2120
|
-
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
2260
|
+
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, INTENT_CATEGORY_COLORS, PLATFORM_LABELS, buildSettingsSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, intentCategoryColorSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@alpic-ai/api",
|
|
3
|
-
"version": "0.0.0-dev.
|
|
3
|
+
"version": "0.0.0-dev.gf378a72",
|
|
4
4
|
"description": "Contract for the Alpic API",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.mjs",
|
|
@@ -55,6 +55,6 @@
|
|
|
55
55
|
"test:unit": "vitest run",
|
|
56
56
|
"test:format": "biome check --error-on-warnings .",
|
|
57
57
|
"test:type": "tsgo --noEmit",
|
|
58
|
-
"publish:npm": "
|
|
58
|
+
"publish:npm": "../../scripts/publish-if-new.sh"
|
|
59
59
|
}
|
|
60
60
|
}
|