@alpic-ai/api 0.0.0-staging.gfab65e2 → 0.0.0-staging.gfabea7f
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 +230 -88
- package/package.json +5 -5
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,12 +422,13 @@ 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(),
|
|
409
429
|
content: z.string(),
|
|
410
|
-
source: z.enum(["model", "user"])
|
|
430
|
+
source: z.enum(["model", "user"]),
|
|
431
|
+
clientName: z.string().nullable()
|
|
411
432
|
});
|
|
412
433
|
z.object({
|
|
413
434
|
content: z.string(),
|
|
@@ -423,7 +444,7 @@ const intentCategoryColorSchema = z.enum([
|
|
|
423
444
|
"pink",
|
|
424
445
|
"gray"
|
|
425
446
|
]);
|
|
426
|
-
intentCategoryColorSchema.options;
|
|
447
|
+
const INTENT_CATEGORY_COLORS = intentCategoryColorSchema.options;
|
|
427
448
|
const intentCategorySchema = z.object({
|
|
428
449
|
id: z.string(),
|
|
429
450
|
createdAt: z.coerce.date(),
|
|
@@ -431,7 +452,7 @@ const intentCategorySchema = z.object({
|
|
|
431
452
|
name: z.string(),
|
|
432
453
|
color: intentCategoryColorSchema
|
|
433
454
|
});
|
|
434
|
-
z.object({
|
|
455
|
+
const intentCategorySummarySchema = z.object({
|
|
435
456
|
id: z.string(),
|
|
436
457
|
name: z.string(),
|
|
437
458
|
color: intentCategoryColorSchema,
|
|
@@ -443,6 +464,7 @@ z.object({
|
|
|
443
464
|
environmentId: z.string(),
|
|
444
465
|
toolName: z.string(),
|
|
445
466
|
message: z.string(),
|
|
467
|
+
clientName: z.string().nullable(),
|
|
446
468
|
categories: z.array(intentCategorySchema)
|
|
447
469
|
});
|
|
448
470
|
const signalCategorySchema = z.object({
|
|
@@ -1396,6 +1418,11 @@ const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
|
1396
1418
|
});
|
|
1397
1419
|
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1398
1420
|
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1421
|
+
z.literal([
|
|
1422
|
+
100,
|
|
1423
|
+
75,
|
|
1424
|
+
50
|
|
1425
|
+
]);
|
|
1399
1426
|
const subscriptionPlanSchema = z.enum([
|
|
1400
1427
|
"pro",
|
|
1401
1428
|
"business",
|
|
@@ -1544,21 +1571,20 @@ const deploymentSchema = z.object({
|
|
|
1544
1571
|
isCurrent: z.boolean(),
|
|
1545
1572
|
deploymentPageUrl: z.url().nullable()
|
|
1546
1573
|
});
|
|
1547
|
-
const
|
|
1574
|
+
const isValidTimeInput = (value) => {
|
|
1548
1575
|
if (ms(value) !== void 0) return true;
|
|
1549
1576
|
return !Number.isNaN(new Date(value).getTime());
|
|
1550
1577
|
};
|
|
1551
|
-
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({
|
|
1552
1581
|
path: "/v1/environments",
|
|
1553
1582
|
method: "POST",
|
|
1554
1583
|
summary: "Create an environment",
|
|
1555
1584
|
description: "Create an environment for a project",
|
|
1556
1585
|
tags: ["environments"],
|
|
1557
1586
|
successDescription: "The environment has been created successfully"
|
|
1558
|
-
}).errors({
|
|
1559
|
-
NOT_FOUND: {},
|
|
1560
|
-
BAD_REQUEST: {}
|
|
1561
|
-
}).input(z.object({
|
|
1587
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1562
1588
|
projectId: z.string().describe("The ID of the project to create the environment for"),
|
|
1563
1589
|
name: z.string().min(1).describe("The name of the environment"),
|
|
1564
1590
|
sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
|
|
@@ -1571,7 +1597,7 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
1571
1597
|
createdAt: z.coerce.date(),
|
|
1572
1598
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
1573
1599
|
}));
|
|
1574
|
-
const getEnvironmentContractV1 =
|
|
1600
|
+
const getEnvironmentContractV1 = base.route({
|
|
1575
1601
|
path: "/v1/environments/{environmentId}",
|
|
1576
1602
|
method: "GET",
|
|
1577
1603
|
summary: "Get an environment",
|
|
@@ -1628,7 +1654,7 @@ const projectOutputSchema = z.object({
|
|
|
1628
1654
|
productionEnvironment: productionEnvironmentSchema.nullable(),
|
|
1629
1655
|
environments: z.array(environmentSchema)
|
|
1630
1656
|
});
|
|
1631
|
-
const getProjectContractV1 =
|
|
1657
|
+
const getProjectContractV1 = base.route({
|
|
1632
1658
|
path: "/v1/projects/{projectId}",
|
|
1633
1659
|
method: "GET",
|
|
1634
1660
|
summary: "Get a project",
|
|
@@ -1636,18 +1662,15 @@ const getProjectContractV1 = oc.route({
|
|
|
1636
1662
|
tags: ["projects"],
|
|
1637
1663
|
successDescription: "The project details"
|
|
1638
1664
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
|
|
1639
|
-
const listProjectsContractV1 =
|
|
1665
|
+
const listProjectsContractV1 = base.route({
|
|
1640
1666
|
path: "/v1/projects",
|
|
1641
1667
|
method: "GET",
|
|
1642
1668
|
summary: "List projects",
|
|
1643
1669
|
description: "List all projects for a team",
|
|
1644
1670
|
tags: ["projects"],
|
|
1645
1671
|
successDescription: "The list of projects"
|
|
1646
|
-
}).errors({
|
|
1647
|
-
|
|
1648
|
-
BAD_REQUEST: {}
|
|
1649
|
-
}).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1650
|
-
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({
|
|
1651
1674
|
path: "/v1/projects",
|
|
1652
1675
|
method: "POST",
|
|
1653
1676
|
summary: "Create a project",
|
|
@@ -1656,7 +1679,6 @@ const createProjectContractV1 = oc.route({
|
|
|
1656
1679
|
successDescription: "The project has been created successfully"
|
|
1657
1680
|
}).errors({
|
|
1658
1681
|
NOT_FOUND: {},
|
|
1659
|
-
BAD_REQUEST: {},
|
|
1660
1682
|
FORBIDDEN: {}
|
|
1661
1683
|
}).input(z.object({
|
|
1662
1684
|
teamId: z.string().optional(),
|
|
@@ -1697,7 +1719,7 @@ const environmentVariableOutputSchema = z.object({
|
|
|
1697
1719
|
isSecret: z.boolean(),
|
|
1698
1720
|
createdAt: z.coerce.date()
|
|
1699
1721
|
});
|
|
1700
|
-
const listEnvironmentVariablesContractV1 =
|
|
1722
|
+
const listEnvironmentVariablesContractV1 = base.route({
|
|
1701
1723
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1702
1724
|
method: "GET",
|
|
1703
1725
|
summary: "List environment variables",
|
|
@@ -1705,48 +1727,39 @@ const listEnvironmentVariablesContractV1 = oc.route({
|
|
|
1705
1727
|
tags: ["environments"],
|
|
1706
1728
|
successDescription: "The list of environment variables"
|
|
1707
1729
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
|
|
1708
|
-
const createEnvironmentVariablesContractV1 =
|
|
1730
|
+
const createEnvironmentVariablesContractV1 = base.route({
|
|
1709
1731
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1710
1732
|
method: "POST",
|
|
1711
1733
|
summary: "Add environment variables",
|
|
1712
1734
|
description: "Add one or more environment variables to an environment",
|
|
1713
1735
|
tags: ["environments"],
|
|
1714
1736
|
successDescription: "The environment variables have been added successfully"
|
|
1715
|
-
}).errors({
|
|
1716
|
-
NOT_FOUND: {},
|
|
1717
|
-
BAD_REQUEST: {}
|
|
1718
|
-
}).input(z.object({
|
|
1737
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1719
1738
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1720
1739
|
environmentVariables: environmentVariablesSchema
|
|
1721
1740
|
})).output(z.object({ success: z.literal(true) }));
|
|
1722
|
-
const updateEnvironmentVariableContractV1 =
|
|
1741
|
+
const updateEnvironmentVariableContractV1 = base.route({
|
|
1723
1742
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1724
1743
|
method: "PATCH",
|
|
1725
1744
|
summary: "Update an environment variable",
|
|
1726
1745
|
description: "Update an environment variable by ID",
|
|
1727
1746
|
tags: ["environments"],
|
|
1728
1747
|
successDescription: "The environment variable has been updated successfully"
|
|
1729
|
-
}).errors({
|
|
1730
|
-
NOT_FOUND: {},
|
|
1731
|
-
BAD_REQUEST: {}
|
|
1732
|
-
}).input(z.object({
|
|
1748
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1733
1749
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
1734
1750
|
key: environmentVariableSchema.shape.key,
|
|
1735
1751
|
value: environmentVariableSchema.shape.value.optional(),
|
|
1736
1752
|
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
1737
1753
|
})).output(z.object({ success: z.literal(true) }));
|
|
1738
|
-
const deleteEnvironmentVariableContractV1 =
|
|
1754
|
+
const deleteEnvironmentVariableContractV1 = base.route({
|
|
1739
1755
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1740
1756
|
method: "DELETE",
|
|
1741
1757
|
summary: "Delete an environment variable",
|
|
1742
1758
|
description: "Delete an environment variable by ID",
|
|
1743
1759
|
tags: ["environments"],
|
|
1744
1760
|
successDescription: "The environment variable has been deleted successfully"
|
|
1745
|
-
}).errors({
|
|
1746
|
-
|
|
1747
|
-
BAD_REQUEST: {}
|
|
1748
|
-
}).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1749
|
-
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({
|
|
1750
1763
|
path: "/v1/projects/{projectId}",
|
|
1751
1764
|
method: "DELETE",
|
|
1752
1765
|
summary: "Delete a project",
|
|
@@ -1754,7 +1767,7 @@ const deleteProjectContractV1 = oc.route({
|
|
|
1754
1767
|
tags: ["projects"],
|
|
1755
1768
|
successDescription: "The project has been deleted successfully"
|
|
1756
1769
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(z.object({ success: z.literal(true) }));
|
|
1757
|
-
const updateProjectContractV1 =
|
|
1770
|
+
const updateProjectContractV1 = base.route({
|
|
1758
1771
|
path: "/v1/projects/{projectId}",
|
|
1759
1772
|
method: "PATCH",
|
|
1760
1773
|
summary: "Update a project",
|
|
@@ -1763,14 +1776,13 @@ const updateProjectContractV1 = oc.route({
|
|
|
1763
1776
|
successDescription: "The project has been updated successfully"
|
|
1764
1777
|
}).errors({
|
|
1765
1778
|
NOT_FOUND: {},
|
|
1766
|
-
BAD_REQUEST: {},
|
|
1767
1779
|
FORBIDDEN: {}
|
|
1768
1780
|
}).input(z.object({
|
|
1769
1781
|
projectId: z.string().describe("The ID of the project"),
|
|
1770
1782
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
1771
1783
|
sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
|
|
1772
1784
|
})).output(projectOutputSchema);
|
|
1773
|
-
const deployEnvironmentContractV1 =
|
|
1785
|
+
const deployEnvironmentContractV1 = base.route({
|
|
1774
1786
|
path: "/v1/environments/{environmentId}/deploy",
|
|
1775
1787
|
method: "POST",
|
|
1776
1788
|
summary: "Deploy an environment",
|
|
@@ -1779,29 +1791,25 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
1779
1791
|
successDescription: "The environment has been deployed successfully"
|
|
1780
1792
|
}).errors({
|
|
1781
1793
|
NOT_FOUND: {},
|
|
1782
|
-
BAD_REQUEST: {},
|
|
1783
1794
|
CONFLICT: {}
|
|
1784
1795
|
}).input(z.object({
|
|
1785
1796
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
1786
1797
|
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1787
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.")
|
|
1788
1799
|
})).output(deploymentSchema);
|
|
1789
|
-
const uploadDeploymentArtifactContractV1 =
|
|
1800
|
+
const uploadDeploymentArtifactContractV1 = base.route({
|
|
1790
1801
|
path: "/v1/deployments/upload",
|
|
1791
1802
|
method: "POST",
|
|
1792
1803
|
summary: "Upload deployment artifacts",
|
|
1793
1804
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
1794
1805
|
tags: ["deployments"],
|
|
1795
1806
|
successDescription: "The presigned upload URL has been generated successfully"
|
|
1796
|
-
}).errors({
|
|
1797
|
-
NOT_FOUND: {},
|
|
1798
|
-
BAD_REQUEST: {}
|
|
1799
|
-
}).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({
|
|
1800
1808
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
1801
1809
|
token: z.string().describe("Token to identify the source archive"),
|
|
1802
1810
|
expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
|
|
1803
1811
|
}));
|
|
1804
|
-
const listDeploymentsContractV1 =
|
|
1812
|
+
const listDeploymentsContractV1 = base.route({
|
|
1805
1813
|
path: "/v1/projects/{projectId}/deployments",
|
|
1806
1814
|
method: "GET",
|
|
1807
1815
|
summary: "List project deployments",
|
|
@@ -1813,7 +1821,7 @@ const listDeploymentsContractV1 = oc.route({
|
|
|
1813
1821
|
status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
|
|
1814
1822
|
environmentId: z.string().optional().describe("Filter by environment ID")
|
|
1815
1823
|
})).output(z.array(deploymentSchema));
|
|
1816
|
-
const getDeploymentContractV1 =
|
|
1824
|
+
const getDeploymentContractV1 = base.route({
|
|
1817
1825
|
path: "/v1/deployments/{deploymentId}",
|
|
1818
1826
|
method: "GET",
|
|
1819
1827
|
summary: "Get a deployment",
|
|
@@ -1836,20 +1844,17 @@ const logEntrySchema = z.object({
|
|
|
1836
1844
|
method: z.string().optional(),
|
|
1837
1845
|
durationInMs: z.number().optional()
|
|
1838
1846
|
});
|
|
1839
|
-
const getLogsContractV1 =
|
|
1847
|
+
const getLogsContractV1 = base.route({
|
|
1840
1848
|
path: "/v1/environments/{environmentId}/logs",
|
|
1841
1849
|
method: "GET",
|
|
1842
1850
|
summary: "Get logs",
|
|
1843
1851
|
description: "Get logs for an environment",
|
|
1844
1852
|
tags: ["environments"],
|
|
1845
1853
|
successDescription: "The logs"
|
|
1846
|
-
}).errors({
|
|
1847
|
-
NOT_FOUND: {},
|
|
1848
|
-
BAD_REQUEST: {}
|
|
1849
|
-
}).input(z.object({
|
|
1854
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1850
1855
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1851
|
-
since:
|
|
1852
|
-
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"),
|
|
1853
1858
|
limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
|
|
1854
1859
|
level: z.array(z.enum([
|
|
1855
1860
|
"INFO",
|
|
@@ -1863,17 +1868,14 @@ const getLogsContractV1 = oc.route({
|
|
|
1863
1868
|
logs: z.array(logEntrySchema),
|
|
1864
1869
|
nextToken: z.string().nullable()
|
|
1865
1870
|
}));
|
|
1866
|
-
const getLatestLogsContractV1 =
|
|
1871
|
+
const getLatestLogsContractV1 = base.route({
|
|
1867
1872
|
path: "/v1/environments/{environmentId}/latest-logs",
|
|
1868
1873
|
method: "GET",
|
|
1869
1874
|
summary: "Get latest logs",
|
|
1870
1875
|
description: "Get the N most recent logs for an environment",
|
|
1871
1876
|
tags: ["environments"],
|
|
1872
1877
|
successDescription: "The latest logs"
|
|
1873
|
-
}).errors({
|
|
1874
|
-
NOT_FOUND: {},
|
|
1875
|
-
BAD_REQUEST: {}
|
|
1876
|
-
}).input(z.object({
|
|
1878
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1877
1879
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1878
1880
|
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
1879
1881
|
level: z.array(z.enum([
|
|
@@ -1884,7 +1886,7 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
1884
1886
|
])).optional().describe("Filter by log level"),
|
|
1885
1887
|
search: z.string().optional().describe("Filter pattern to search for in log content")
|
|
1886
1888
|
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
1887
|
-
const getDeploymentLogsContractV1 =
|
|
1889
|
+
const getDeploymentLogsContractV1 = base.route({
|
|
1888
1890
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
1889
1891
|
method: "GET",
|
|
1890
1892
|
summary: "Get deployment logs",
|
|
@@ -1911,17 +1913,14 @@ const analyticsTimeSeriesSchema = z.object({
|
|
|
1911
1913
|
output_token_mean: z.array(analyticsDataPointSchema),
|
|
1912
1914
|
task_count: z.array(analyticsDataPointSchema)
|
|
1913
1915
|
});
|
|
1914
|
-
const getProjectAnalyticsContractV1 =
|
|
1916
|
+
const getProjectAnalyticsContractV1 = base.route({
|
|
1915
1917
|
path: "/v1/analytics/{projectId}",
|
|
1916
1918
|
method: "GET",
|
|
1917
1919
|
summary: "Get project analytics",
|
|
1918
1920
|
description: "Get analytics data for a project over a time range",
|
|
1919
1921
|
tags: ["analytics"],
|
|
1920
1922
|
successDescription: "The project analytics data"
|
|
1921
|
-
}).errors({
|
|
1922
|
-
NOT_FOUND: {},
|
|
1923
|
-
BAD_REQUEST: {}
|
|
1924
|
-
}).input(z.object({
|
|
1923
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1925
1924
|
projectId: z.string().describe("The ID of the project"),
|
|
1926
1925
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
1927
1926
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
@@ -1936,7 +1935,132 @@ const getProjectAnalyticsContractV1 = oc.route({
|
|
|
1936
1935
|
}),
|
|
1937
1936
|
timeSeries: analyticsTimeSeriesSchema
|
|
1938
1937
|
}));
|
|
1939
|
-
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({
|
|
1940
2064
|
path: "/v1/teams",
|
|
1941
2065
|
method: "GET",
|
|
1942
2066
|
summary: "List teams",
|
|
@@ -1949,7 +2073,22 @@ const listTeamsContractV1 = oc.route({
|
|
|
1949
2073
|
createdAt: z.coerce.date(),
|
|
1950
2074
|
hasStripeAccount: z.boolean()
|
|
1951
2075
|
})));
|
|
1952
|
-
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({
|
|
1953
2092
|
path: "/v1/tunnels/ticket",
|
|
1954
2093
|
method: "GET",
|
|
1955
2094
|
summary: "Get a tunnel ticket",
|
|
@@ -1961,16 +2100,13 @@ const getTunnelTicketContractV1 = oc.route({
|
|
|
1961
2100
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1962
2101
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
1963
2102
|
}));
|
|
1964
|
-
const publishServerContractV1 =
|
|
2103
|
+
const publishServerContractV1 = base.route({
|
|
1965
2104
|
path: "/v1/distribution/publish",
|
|
1966
2105
|
method: "POST",
|
|
1967
2106
|
summary: "Publish a server to the MCP registry",
|
|
1968
2107
|
tags: ["distribution"],
|
|
1969
2108
|
successDescription: "The server has been published successfully"
|
|
1970
|
-
}).errors({
|
|
1971
|
-
NOT_FOUND: {},
|
|
1972
|
-
BAD_REQUEST: {}
|
|
1973
|
-
}).input(z.object({
|
|
2109
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1974
2110
|
projectId: z.string(),
|
|
1975
2111
|
domain: z.string(),
|
|
1976
2112
|
title: z.string().min(1).max(100),
|
|
@@ -1979,17 +2115,14 @@ const publishServerContractV1 = oc.route({
|
|
|
1979
2115
|
iconSrc: z.url().max(255).optional(),
|
|
1980
2116
|
dryRun: z.boolean().optional()
|
|
1981
2117
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
1982
|
-
const getServerInfoContractV1 =
|
|
2118
|
+
const getServerInfoContractV1 = base.route({
|
|
1983
2119
|
path: "/v1/distribution/get",
|
|
1984
2120
|
method: "GET",
|
|
1985
2121
|
summary: "Get server info",
|
|
1986
2122
|
description: "Get info about a server",
|
|
1987
2123
|
tags: ["distribution"],
|
|
1988
2124
|
successDescription: "The server info"
|
|
1989
|
-
}).errors({
|
|
1990
|
-
NOT_FOUND: {},
|
|
1991
|
-
BAD_REQUEST: {}
|
|
1992
|
-
}).input(z.object({
|
|
2125
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1993
2126
|
projectId: z.string(),
|
|
1994
2127
|
domain: z.string()
|
|
1995
2128
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
@@ -2008,7 +2141,7 @@ const playgroundOutputSchema = z.object({
|
|
|
2008
2141
|
isPlaygroundEnabled: z.boolean(),
|
|
2009
2142
|
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
2010
2143
|
});
|
|
2011
|
-
const getPlaygroundContractV1 =
|
|
2144
|
+
const getPlaygroundContractV1 = base.route({
|
|
2012
2145
|
path: "/v1/environments/{environmentId}/playground",
|
|
2013
2146
|
method: "GET",
|
|
2014
2147
|
summary: "Get playground configuration",
|
|
@@ -2016,17 +2149,14 @@ const getPlaygroundContractV1 = oc.route({
|
|
|
2016
2149
|
tags: ["environments"],
|
|
2017
2150
|
successDescription: "The playground configuration"
|
|
2018
2151
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
2019
|
-
const upsertPlaygroundContractV1 =
|
|
2152
|
+
const upsertPlaygroundContractV1 = base.route({
|
|
2020
2153
|
path: "/v1/environments/{environmentId}/playground",
|
|
2021
2154
|
method: "PUT",
|
|
2022
2155
|
summary: "Update playground configuration",
|
|
2023
2156
|
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
2024
2157
|
tags: ["environments"],
|
|
2025
2158
|
successDescription: "The updated playground configuration"
|
|
2026
|
-
}).errors({
|
|
2027
|
-
NOT_FOUND: {},
|
|
2028
|
-
BAD_REQUEST: {}
|
|
2029
|
-
}).input(z.object({
|
|
2159
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2030
2160
|
environmentId: z.string().describe("The ID of the environment"),
|
|
2031
2161
|
isPlaygroundEnabled: z.boolean().optional(),
|
|
2032
2162
|
name: z.string().min(1).max(100).optional(),
|
|
@@ -2034,7 +2164,7 @@ const upsertPlaygroundContractV1 = oc.route({
|
|
|
2034
2164
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
2035
2165
|
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
2036
2166
|
})).output(playgroundOutputSchema);
|
|
2037
|
-
const createBeaconContractV1 =
|
|
2167
|
+
const createBeaconContractV1 = base.route({
|
|
2038
2168
|
path: "/v1/beacon/audits",
|
|
2039
2169
|
method: "POST",
|
|
2040
2170
|
summary: "Create a beacon audit",
|
|
@@ -2043,7 +2173,6 @@ const createBeaconContractV1 = oc.route({
|
|
|
2043
2173
|
successDescription: "The audit has been created"
|
|
2044
2174
|
}).errors({
|
|
2045
2175
|
NOT_FOUND: {},
|
|
2046
|
-
BAD_REQUEST: {},
|
|
2047
2176
|
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
2048
2177
|
}).input(z.object({
|
|
2049
2178
|
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
@@ -2051,7 +2180,7 @@ const createBeaconContractV1 = oc.route({
|
|
|
2051
2180
|
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
2052
2181
|
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
2053
2182
|
})).output(z.object({ id: z.string() }));
|
|
2054
|
-
const getBeaconContractV1 =
|
|
2183
|
+
const getBeaconContractV1 = base.route({
|
|
2055
2184
|
path: "/v1/beacon/audits/{auditId}",
|
|
2056
2185
|
method: "GET",
|
|
2057
2186
|
summary: "Get a beacon audit",
|
|
@@ -2067,8 +2196,21 @@ const getBeaconContractV1 = oc.route({
|
|
|
2067
2196
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
2068
2197
|
}));
|
|
2069
2198
|
const contract = {
|
|
2070
|
-
teams: {
|
|
2199
|
+
teams: {
|
|
2200
|
+
list: { v1: listTeamsContractV1 },
|
|
2201
|
+
getUsage: { v1: getTeamUsageContractV1 }
|
|
2202
|
+
},
|
|
2071
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 } },
|
|
2072
2214
|
deployments: {
|
|
2073
2215
|
list: { v1: listDeploymentsContractV1 },
|
|
2074
2216
|
get: { v1: getDeploymentContractV1 },
|
|
@@ -2115,4 +2257,4 @@ const contractForDocs = {
|
|
|
2115
2257
|
deployments: deploymentsForDocs
|
|
2116
2258
|
};
|
|
2117
2259
|
//#endregion
|
|
2118
|
-
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-staging.
|
|
3
|
+
"version": "0.0.0-staging.gfabea7f",
|
|
4
4
|
"description": "Contract for the Alpic API",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.mjs",
|
|
@@ -33,13 +33,13 @@
|
|
|
33
33
|
"author": "Alpic",
|
|
34
34
|
"license": "ISC",
|
|
35
35
|
"dependencies": {
|
|
36
|
-
"@orpc/contract": "^1.
|
|
36
|
+
"@orpc/contract": "^1.15.0",
|
|
37
37
|
"ms": "^2.1.3",
|
|
38
38
|
"zod": "^4.4.3"
|
|
39
39
|
},
|
|
40
40
|
"devDependencies": {
|
|
41
|
-
"@orpc/openapi": "^1.
|
|
42
|
-
"@orpc/zod": "^1.
|
|
41
|
+
"@orpc/openapi": "^1.15.0",
|
|
42
|
+
"@orpc/zod": "^1.15.0",
|
|
43
43
|
"@total-typescript/tsconfig": "^1.0.4",
|
|
44
44
|
"@types/ms": "^2.1.0",
|
|
45
45
|
"shx": "^0.4.0",
|
|
@@ -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
|
}
|