@alpic-ai/api 0.0.0-dev.gef9a9d1 → 0.0.0-dev.gefacfca
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 +222 -88
- package/package.json +5 -5
package/dist/index.mjs
CHANGED
|
@@ -256,6 +256,16 @@ z.object({
|
|
|
256
256
|
clientSecret: z.string(),
|
|
257
257
|
clientScopes: z.array(z.string())
|
|
258
258
|
});
|
|
259
|
+
z.enum([
|
|
260
|
+
"opening_balance",
|
|
261
|
+
"free_seed",
|
|
262
|
+
"paid_conversion_floor",
|
|
263
|
+
"top_up",
|
|
264
|
+
"usage",
|
|
265
|
+
"refund",
|
|
266
|
+
"admin_adjustment"
|
|
267
|
+
]);
|
|
268
|
+
z.enum(["playground"]);
|
|
259
269
|
const deploymentStatusSchema$1 = z.enum([
|
|
260
270
|
"ongoing",
|
|
261
271
|
"deployed",
|
|
@@ -368,6 +378,7 @@ const playgroundModelSchema = z.enum([
|
|
|
368
378
|
]);
|
|
369
379
|
const environmentDomainSchema = z.object({
|
|
370
380
|
name: z.string(),
|
|
381
|
+
pathPrefix: z.string(),
|
|
371
382
|
status: z.enum([
|
|
372
383
|
"ongoing",
|
|
373
384
|
"deployed",
|
|
@@ -402,12 +413,13 @@ z.object({
|
|
|
402
413
|
collectUserData: z.boolean(),
|
|
403
414
|
identityTraitKey: z.string().min(1).max(200).nullable()
|
|
404
415
|
});
|
|
405
|
-
z.object({
|
|
416
|
+
const feedbackSchema = z.object({
|
|
406
417
|
id: z.string(),
|
|
407
418
|
createdAt: z.coerce.date(),
|
|
408
419
|
environmentId: z.string(),
|
|
409
420
|
content: z.string(),
|
|
410
|
-
source: z.enum(["model", "user"])
|
|
421
|
+
source: z.enum(["model", "user"]),
|
|
422
|
+
clientName: z.string().nullable()
|
|
411
423
|
});
|
|
412
424
|
z.object({
|
|
413
425
|
content: z.string(),
|
|
@@ -423,7 +435,7 @@ const intentCategoryColorSchema = z.enum([
|
|
|
423
435
|
"pink",
|
|
424
436
|
"gray"
|
|
425
437
|
]);
|
|
426
|
-
intentCategoryColorSchema.options;
|
|
438
|
+
const INTENT_CATEGORY_COLORS = intentCategoryColorSchema.options;
|
|
427
439
|
const intentCategorySchema = z.object({
|
|
428
440
|
id: z.string(),
|
|
429
441
|
createdAt: z.coerce.date(),
|
|
@@ -431,7 +443,7 @@ const intentCategorySchema = z.object({
|
|
|
431
443
|
name: z.string(),
|
|
432
444
|
color: intentCategoryColorSchema
|
|
433
445
|
});
|
|
434
|
-
z.object({
|
|
446
|
+
const intentCategorySummarySchema = z.object({
|
|
435
447
|
id: z.string(),
|
|
436
448
|
name: z.string(),
|
|
437
449
|
color: intentCategoryColorSchema,
|
|
@@ -443,6 +455,7 @@ z.object({
|
|
|
443
455
|
environmentId: z.string(),
|
|
444
456
|
toolName: z.string(),
|
|
445
457
|
message: z.string(),
|
|
458
|
+
clientName: z.string().nullable(),
|
|
446
459
|
categories: z.array(intentCategorySchema)
|
|
447
460
|
});
|
|
448
461
|
const signalCategorySchema = z.object({
|
|
@@ -1396,6 +1409,11 @@ const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
|
1396
1409
|
});
|
|
1397
1410
|
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1398
1411
|
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1412
|
+
z.literal([
|
|
1413
|
+
100,
|
|
1414
|
+
75,
|
|
1415
|
+
50
|
|
1416
|
+
]);
|
|
1399
1417
|
const subscriptionPlanSchema = z.enum([
|
|
1400
1418
|
"pro",
|
|
1401
1419
|
"business",
|
|
@@ -1413,6 +1431,7 @@ const customerUsageSchema = z.object({
|
|
|
1413
1431
|
periodEnd: z.number()
|
|
1414
1432
|
});
|
|
1415
1433
|
const partnerDiscountSchema = z.object({ endsAt: z.number() });
|
|
1434
|
+
z.object({ balanceInNanoUSD: z.number() });
|
|
1416
1435
|
z.object({
|
|
1417
1436
|
customerCredits: customerCreditsSchema.nullable(),
|
|
1418
1437
|
customerUsage: customerUsageSchema.nullable(),
|
|
@@ -1544,21 +1563,20 @@ const deploymentSchema = z.object({
|
|
|
1544
1563
|
isCurrent: z.boolean(),
|
|
1545
1564
|
deploymentPageUrl: z.url().nullable()
|
|
1546
1565
|
});
|
|
1547
|
-
const
|
|
1566
|
+
const isValidTimeInput = (value) => {
|
|
1548
1567
|
if (ms(value) !== void 0) return true;
|
|
1549
1568
|
return !Number.isNaN(new Date(value).getTime());
|
|
1550
1569
|
};
|
|
1551
|
-
const
|
|
1570
|
+
const timeInputSchema = z.string().refine(isValidTimeInput, { message: "Invalid time. Use relative (1h, 30m, 2d) or ISO 8601 format." });
|
|
1571
|
+
const base = oc.errors({ BAD_REQUEST: {} });
|
|
1572
|
+
const createEnvironmentContractV1 = base.route({
|
|
1552
1573
|
path: "/v1/environments",
|
|
1553
1574
|
method: "POST",
|
|
1554
1575
|
summary: "Create an environment",
|
|
1555
1576
|
description: "Create an environment for a project",
|
|
1556
1577
|
tags: ["environments"],
|
|
1557
1578
|
successDescription: "The environment has been created successfully"
|
|
1558
|
-
}).errors({
|
|
1559
|
-
NOT_FOUND: {},
|
|
1560
|
-
BAD_REQUEST: {}
|
|
1561
|
-
}).input(z.object({
|
|
1579
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1562
1580
|
projectId: z.string().describe("The ID of the project to create the environment for"),
|
|
1563
1581
|
name: z.string().min(1).describe("The name of the environment"),
|
|
1564
1582
|
sourceBranch: z.string().min(1).describe("The branch used to build the environment"),
|
|
@@ -1571,7 +1589,7 @@ const createEnvironmentContractV1 = oc.route({
|
|
|
1571
1589
|
createdAt: z.coerce.date(),
|
|
1572
1590
|
projectId: z.string().describe("The ID of the project the environment belongs to")
|
|
1573
1591
|
}));
|
|
1574
|
-
const getEnvironmentContractV1 =
|
|
1592
|
+
const getEnvironmentContractV1 = base.route({
|
|
1575
1593
|
path: "/v1/environments/{environmentId}",
|
|
1576
1594
|
method: "GET",
|
|
1577
1595
|
summary: "Get an environment",
|
|
@@ -1628,7 +1646,7 @@ const projectOutputSchema = z.object({
|
|
|
1628
1646
|
productionEnvironment: productionEnvironmentSchema.nullable(),
|
|
1629
1647
|
environments: z.array(environmentSchema)
|
|
1630
1648
|
});
|
|
1631
|
-
const getProjectContractV1 =
|
|
1649
|
+
const getProjectContractV1 = base.route({
|
|
1632
1650
|
path: "/v1/projects/{projectId}",
|
|
1633
1651
|
method: "GET",
|
|
1634
1652
|
summary: "Get a project",
|
|
@@ -1636,18 +1654,15 @@ const getProjectContractV1 = oc.route({
|
|
|
1636
1654
|
tags: ["projects"],
|
|
1637
1655
|
successDescription: "The project details"
|
|
1638
1656
|
}).errors({ NOT_FOUND: {} }).input(z.object({ projectId: z.string().describe("The ID of the project") })).output(projectOutputSchema);
|
|
1639
|
-
const listProjectsContractV1 =
|
|
1657
|
+
const listProjectsContractV1 = base.route({
|
|
1640
1658
|
path: "/v1/projects",
|
|
1641
1659
|
method: "GET",
|
|
1642
1660
|
summary: "List projects",
|
|
1643
1661
|
description: "List all projects for a team",
|
|
1644
1662
|
tags: ["projects"],
|
|
1645
1663
|
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({
|
|
1664
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.array(projectOutputSchema));
|
|
1665
|
+
const createProjectContractV1 = base.route({
|
|
1651
1666
|
path: "/v1/projects",
|
|
1652
1667
|
method: "POST",
|
|
1653
1668
|
summary: "Create a project",
|
|
@@ -1656,7 +1671,6 @@ const createProjectContractV1 = oc.route({
|
|
|
1656
1671
|
successDescription: "The project has been created successfully"
|
|
1657
1672
|
}).errors({
|
|
1658
1673
|
NOT_FOUND: {},
|
|
1659
|
-
BAD_REQUEST: {},
|
|
1660
1674
|
FORBIDDEN: {}
|
|
1661
1675
|
}).input(z.object({
|
|
1662
1676
|
teamId: z.string().optional(),
|
|
@@ -1697,7 +1711,7 @@ const environmentVariableOutputSchema = z.object({
|
|
|
1697
1711
|
isSecret: z.boolean(),
|
|
1698
1712
|
createdAt: z.coerce.date()
|
|
1699
1713
|
});
|
|
1700
|
-
const listEnvironmentVariablesContractV1 =
|
|
1714
|
+
const listEnvironmentVariablesContractV1 = base.route({
|
|
1701
1715
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1702
1716
|
method: "GET",
|
|
1703
1717
|
summary: "List environment variables",
|
|
@@ -1705,48 +1719,39 @@ const listEnvironmentVariablesContractV1 = oc.route({
|
|
|
1705
1719
|
tags: ["environments"],
|
|
1706
1720
|
successDescription: "The list of environment variables"
|
|
1707
1721
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(environmentVariableOutputSchema));
|
|
1708
|
-
const createEnvironmentVariablesContractV1 =
|
|
1722
|
+
const createEnvironmentVariablesContractV1 = base.route({
|
|
1709
1723
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1710
1724
|
method: "POST",
|
|
1711
1725
|
summary: "Add environment variables",
|
|
1712
1726
|
description: "Add one or more environment variables to an environment",
|
|
1713
1727
|
tags: ["environments"],
|
|
1714
1728
|
successDescription: "The environment variables have been added successfully"
|
|
1715
|
-
}).errors({
|
|
1716
|
-
NOT_FOUND: {},
|
|
1717
|
-
BAD_REQUEST: {}
|
|
1718
|
-
}).input(z.object({
|
|
1729
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1719
1730
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1720
1731
|
environmentVariables: environmentVariablesSchema
|
|
1721
1732
|
})).output(z.object({ success: z.literal(true) }));
|
|
1722
|
-
const updateEnvironmentVariableContractV1 =
|
|
1733
|
+
const updateEnvironmentVariableContractV1 = base.route({
|
|
1723
1734
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1724
1735
|
method: "PATCH",
|
|
1725
1736
|
summary: "Update an environment variable",
|
|
1726
1737
|
description: "Update an environment variable by ID",
|
|
1727
1738
|
tags: ["environments"],
|
|
1728
1739
|
successDescription: "The environment variable has been updated successfully"
|
|
1729
|
-
}).errors({
|
|
1730
|
-
NOT_FOUND: {},
|
|
1731
|
-
BAD_REQUEST: {}
|
|
1732
|
-
}).input(z.object({
|
|
1740
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1733
1741
|
environmentVariableId: z.string().describe("The ID of the environment variable"),
|
|
1734
1742
|
key: environmentVariableSchema.shape.key,
|
|
1735
1743
|
value: environmentVariableSchema.shape.value.optional(),
|
|
1736
1744
|
isSecret: environmentVariableSchema.shape.isSecret.optional()
|
|
1737
1745
|
})).output(z.object({ success: z.literal(true) }));
|
|
1738
|
-
const deleteEnvironmentVariableContractV1 =
|
|
1746
|
+
const deleteEnvironmentVariableContractV1 = base.route({
|
|
1739
1747
|
path: "/v1/environment-variables/{environmentVariableId}",
|
|
1740
1748
|
method: "DELETE",
|
|
1741
1749
|
summary: "Delete an environment variable",
|
|
1742
1750
|
description: "Delete an environment variable by ID",
|
|
1743
1751
|
tags: ["environments"],
|
|
1744
1752
|
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({
|
|
1753
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentVariableId: z.string().describe("The ID of the environment variable") })).output(z.object({ success: z.literal(true) }));
|
|
1754
|
+
const deleteProjectContractV1 = base.route({
|
|
1750
1755
|
path: "/v1/projects/{projectId}",
|
|
1751
1756
|
method: "DELETE",
|
|
1752
1757
|
summary: "Delete a project",
|
|
@@ -1754,7 +1759,7 @@ const deleteProjectContractV1 = oc.route({
|
|
|
1754
1759
|
tags: ["projects"],
|
|
1755
1760
|
successDescription: "The project has been deleted successfully"
|
|
1756
1761
|
}).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 =
|
|
1762
|
+
const updateProjectContractV1 = base.route({
|
|
1758
1763
|
path: "/v1/projects/{projectId}",
|
|
1759
1764
|
method: "PATCH",
|
|
1760
1765
|
summary: "Update a project",
|
|
@@ -1763,14 +1768,13 @@ const updateProjectContractV1 = oc.route({
|
|
|
1763
1768
|
successDescription: "The project has been updated successfully"
|
|
1764
1769
|
}).errors({
|
|
1765
1770
|
NOT_FOUND: {},
|
|
1766
|
-
BAD_REQUEST: {},
|
|
1767
1771
|
FORBIDDEN: {}
|
|
1768
1772
|
}).input(z.object({
|
|
1769
1773
|
projectId: z.string().describe("The ID of the project"),
|
|
1770
1774
|
name: z.string().min(1).max(100).optional().describe("The new name for the project"),
|
|
1771
1775
|
sourceRepository: z.string().nullable().optional().describe("The source repository to connect to the project")
|
|
1772
1776
|
})).output(projectOutputSchema);
|
|
1773
|
-
const deployEnvironmentContractV1 =
|
|
1777
|
+
const deployEnvironmentContractV1 = base.route({
|
|
1774
1778
|
path: "/v1/environments/{environmentId}/deploy",
|
|
1775
1779
|
method: "POST",
|
|
1776
1780
|
summary: "Deploy an environment",
|
|
@@ -1779,29 +1783,25 @@ const deployEnvironmentContractV1 = oc.route({
|
|
|
1779
1783
|
successDescription: "The environment has been deployed successfully"
|
|
1780
1784
|
}).errors({
|
|
1781
1785
|
NOT_FOUND: {},
|
|
1782
|
-
BAD_REQUEST: {},
|
|
1783
1786
|
CONFLICT: {}
|
|
1784
1787
|
}).input(z.object({
|
|
1785
1788
|
environmentId: z.string().describe("The ID of the environment to deploy"),
|
|
1786
1789
|
token: z.string().describe("The token to identify the source archive").optional(),
|
|
1787
1790
|
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
1791
|
})).output(deploymentSchema);
|
|
1789
|
-
const uploadDeploymentArtifactContractV1 =
|
|
1792
|
+
const uploadDeploymentArtifactContractV1 = base.route({
|
|
1790
1793
|
path: "/v1/deployments/upload",
|
|
1791
1794
|
method: "POST",
|
|
1792
1795
|
summary: "Upload deployment artifacts",
|
|
1793
1796
|
description: "Return a presigned S3 URL to upload a deployment artifact",
|
|
1794
1797
|
tags: ["deployments"],
|
|
1795
1798
|
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({
|
|
1799
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().optional() }).optional()).output(z.object({
|
|
1800
1800
|
uploadUrl: z.url().describe("Presigned S3 URL to upload the source archive with HTTP PUT"),
|
|
1801
1801
|
token: z.string().describe("Token to identify the source archive"),
|
|
1802
1802
|
expiresAt: z.coerce.date().describe("Expiration date of the presigned URL")
|
|
1803
1803
|
}));
|
|
1804
|
-
const listDeploymentsContractV1 =
|
|
1804
|
+
const listDeploymentsContractV1 = base.route({
|
|
1805
1805
|
path: "/v1/projects/{projectId}/deployments",
|
|
1806
1806
|
method: "GET",
|
|
1807
1807
|
summary: "List project deployments",
|
|
@@ -1813,7 +1813,7 @@ const listDeploymentsContractV1 = oc.route({
|
|
|
1813
1813
|
status: z.array(deploymentStatusSchema).optional().describe("Filter by one or more statuses"),
|
|
1814
1814
|
environmentId: z.string().optional().describe("Filter by environment ID")
|
|
1815
1815
|
})).output(z.array(deploymentSchema));
|
|
1816
|
-
const getDeploymentContractV1 =
|
|
1816
|
+
const getDeploymentContractV1 = base.route({
|
|
1817
1817
|
path: "/v1/deployments/{deploymentId}",
|
|
1818
1818
|
method: "GET",
|
|
1819
1819
|
summary: "Get a deployment",
|
|
@@ -1836,20 +1836,17 @@ const logEntrySchema = z.object({
|
|
|
1836
1836
|
method: z.string().optional(),
|
|
1837
1837
|
durationInMs: z.number().optional()
|
|
1838
1838
|
});
|
|
1839
|
-
const getLogsContractV1 =
|
|
1839
|
+
const getLogsContractV1 = base.route({
|
|
1840
1840
|
path: "/v1/environments/{environmentId}/logs",
|
|
1841
1841
|
method: "GET",
|
|
1842
1842
|
summary: "Get logs",
|
|
1843
1843
|
description: "Get logs for an environment",
|
|
1844
1844
|
tags: ["environments"],
|
|
1845
1845
|
successDescription: "The logs"
|
|
1846
|
-
}).errors({
|
|
1847
|
-
NOT_FOUND: {},
|
|
1848
|
-
BAD_REQUEST: {}
|
|
1849
|
-
}).input(z.object({
|
|
1846
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1850
1847
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1851
|
-
since:
|
|
1852
|
-
until:
|
|
1848
|
+
since: timeInputSchema.optional().describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
1849
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1853
1850
|
limit: z.coerce.number().int().min(1).max(1e3).default(1e3).describe("Maximum number of log entries to return."),
|
|
1854
1851
|
level: z.array(z.enum([
|
|
1855
1852
|
"INFO",
|
|
@@ -1863,17 +1860,14 @@ const getLogsContractV1 = oc.route({
|
|
|
1863
1860
|
logs: z.array(logEntrySchema),
|
|
1864
1861
|
nextToken: z.string().nullable()
|
|
1865
1862
|
}));
|
|
1866
|
-
const getLatestLogsContractV1 =
|
|
1863
|
+
const getLatestLogsContractV1 = base.route({
|
|
1867
1864
|
path: "/v1/environments/{environmentId}/latest-logs",
|
|
1868
1865
|
method: "GET",
|
|
1869
1866
|
summary: "Get latest logs",
|
|
1870
1867
|
description: "Get the N most recent logs for an environment",
|
|
1871
1868
|
tags: ["environments"],
|
|
1872
1869
|
successDescription: "The latest logs"
|
|
1873
|
-
}).errors({
|
|
1874
|
-
NOT_FOUND: {},
|
|
1875
|
-
BAD_REQUEST: {}
|
|
1876
|
-
}).input(z.object({
|
|
1870
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1877
1871
|
environmentId: z.string().describe("The ID of the environment"),
|
|
1878
1872
|
limit: z.coerce.number().int().min(1).max(1e3).default(100).describe("Number of most recent log entries to return"),
|
|
1879
1873
|
level: z.array(z.enum([
|
|
@@ -1884,7 +1878,7 @@ const getLatestLogsContractV1 = oc.route({
|
|
|
1884
1878
|
])).optional().describe("Filter by log level"),
|
|
1885
1879
|
search: z.string().optional().describe("Filter pattern to search for in log content")
|
|
1886
1880
|
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
1887
|
-
const getDeploymentLogsContractV1 =
|
|
1881
|
+
const getDeploymentLogsContractV1 = base.route({
|
|
1888
1882
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
1889
1883
|
method: "GET",
|
|
1890
1884
|
summary: "Get deployment logs",
|
|
@@ -1911,17 +1905,14 @@ const analyticsTimeSeriesSchema = z.object({
|
|
|
1911
1905
|
output_token_mean: z.array(analyticsDataPointSchema),
|
|
1912
1906
|
task_count: z.array(analyticsDataPointSchema)
|
|
1913
1907
|
});
|
|
1914
|
-
const getProjectAnalyticsContractV1 =
|
|
1908
|
+
const getProjectAnalyticsContractV1 = base.route({
|
|
1915
1909
|
path: "/v1/analytics/{projectId}",
|
|
1916
1910
|
method: "GET",
|
|
1917
1911
|
summary: "Get project analytics",
|
|
1918
1912
|
description: "Get analytics data for a project over a time range",
|
|
1919
1913
|
tags: ["analytics"],
|
|
1920
1914
|
successDescription: "The project analytics data"
|
|
1921
|
-
}).errors({
|
|
1922
|
-
NOT_FOUND: {},
|
|
1923
|
-
BAD_REQUEST: {}
|
|
1924
|
-
}).input(z.object({
|
|
1915
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1925
1916
|
projectId: z.string().describe("The ID of the project"),
|
|
1926
1917
|
startTimestamp: z.coerce.number().describe("Start timestamp in milliseconds"),
|
|
1927
1918
|
endTimestamp: z.coerce.number().describe("End timestamp in milliseconds"),
|
|
@@ -1936,7 +1927,132 @@ const getProjectAnalyticsContractV1 = oc.route({
|
|
|
1936
1927
|
}),
|
|
1937
1928
|
timeSeries: analyticsTimeSeriesSchema
|
|
1938
1929
|
}));
|
|
1939
|
-
const
|
|
1930
|
+
const paginatedInsightsInputShape = {
|
|
1931
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
1932
|
+
since: timeInputSchema.default("7d").describe("Start time — ISO 8601 (2024-01-01T00:00:00Z) or relative (1h, 30m, 2d)"),
|
|
1933
|
+
until: timeInputSchema.optional().describe("End time — ISO 8601 or relative"),
|
|
1934
|
+
limit: z.coerce.number().int().min(1).max(200).default(50),
|
|
1935
|
+
offset: z.coerce.number().int().min(0).default(0),
|
|
1936
|
+
search: z.string().trim().min(1).max(200).optional()
|
|
1937
|
+
};
|
|
1938
|
+
const listIntentsContractV1 = base.route({
|
|
1939
|
+
path: "/v1/environments/{environmentId}/intents",
|
|
1940
|
+
method: "GET",
|
|
1941
|
+
summary: "List intents",
|
|
1942
|
+
description: "List grouped user intents for an environment over a time range",
|
|
1943
|
+
tags: ["insights"],
|
|
1944
|
+
successDescription: "The grouped user intents"
|
|
1945
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1946
|
+
...paginatedInsightsInputShape,
|
|
1947
|
+
tools: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
1948
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional(),
|
|
1949
|
+
categoryIds: z.array(z.string().trim().min(1)).min(1).max(100).optional(),
|
|
1950
|
+
sortDir: z.enum(["asc", "desc"]).default("desc")
|
|
1951
|
+
})).output(z.object({
|
|
1952
|
+
intents: z.array(z.object({
|
|
1953
|
+
id: z.string(),
|
|
1954
|
+
intentIds: z.array(z.string()).min(1),
|
|
1955
|
+
environmentId: z.string(),
|
|
1956
|
+
message: z.string(),
|
|
1957
|
+
toolName: z.string(),
|
|
1958
|
+
createdAt: z.coerce.date(),
|
|
1959
|
+
occurrenceCount: z.number().int().positive(),
|
|
1960
|
+
clientName: z.string().nullable(),
|
|
1961
|
+
clientId: z.string().nullable(),
|
|
1962
|
+
categories: z.array(z.object({
|
|
1963
|
+
id: z.string(),
|
|
1964
|
+
name: z.string(),
|
|
1965
|
+
color: intentCategoryColorSchema
|
|
1966
|
+
}))
|
|
1967
|
+
})),
|
|
1968
|
+
totalCount: z.number().int().nonnegative()
|
|
1969
|
+
}));
|
|
1970
|
+
const listFeedbacksContractV1 = base.route({
|
|
1971
|
+
path: "/v1/environments/{environmentId}/feedbacks",
|
|
1972
|
+
method: "GET",
|
|
1973
|
+
summary: "List feedbacks",
|
|
1974
|
+
description: "List user feedback for an environment over a time range",
|
|
1975
|
+
tags: ["insights"],
|
|
1976
|
+
successDescription: "The user feedback"
|
|
1977
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1978
|
+
...paginatedInsightsInputShape,
|
|
1979
|
+
clientIds: z.array(z.string().min(1)).min(1).max(100).optional()
|
|
1980
|
+
})).output(z.object({
|
|
1981
|
+
feedbacks: z.array(feedbackSchema.extend({ clientId: z.string().nullable() })),
|
|
1982
|
+
totalCount: z.number().int().nonnegative()
|
|
1983
|
+
}));
|
|
1984
|
+
const intentCategoryNameSchema = z.string().trim().min(1).max(100).describe("The category name");
|
|
1985
|
+
const categorizableIntentIdsSchema = z.array(z.string().trim().min(1)).min(1).max(100).describe("IDs of the intents to categorize");
|
|
1986
|
+
const listIntentCategoriesContractV1 = base.route({
|
|
1987
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
1988
|
+
method: "GET",
|
|
1989
|
+
summary: "List intent categories",
|
|
1990
|
+
description: "List intent categories for an environment, including how many intents each category is linked to",
|
|
1991
|
+
tags: ["insights"],
|
|
1992
|
+
successDescription: "The intent categories"
|
|
1993
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(intentCategorySummarySchema));
|
|
1994
|
+
const createIntentCategoryContractV1 = base.route({
|
|
1995
|
+
path: "/v1/environments/{environmentId}/intent-categories",
|
|
1996
|
+
method: "POST",
|
|
1997
|
+
summary: "Create an intent category",
|
|
1998
|
+
description: "Create an intent category, optionally linking it to existing intents",
|
|
1999
|
+
tags: ["insights"],
|
|
2000
|
+
successDescription: "The created intent category"
|
|
2001
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2002
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2003
|
+
name: intentCategoryNameSchema,
|
|
2004
|
+
color: intentCategoryColorSchema.optional().describe("The category color; derived from the name when omitted"),
|
|
2005
|
+
intentIds: categorizableIntentIdsSchema.optional().describe("IDs of intents to link to the new category")
|
|
2006
|
+
})).output(intentCategorySchema);
|
|
2007
|
+
const updateIntentCategoryContractV1 = base.route({
|
|
2008
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2009
|
+
method: "PATCH",
|
|
2010
|
+
summary: "Update an intent category",
|
|
2011
|
+
description: "Rename or recolor an intent category",
|
|
2012
|
+
tags: ["insights"],
|
|
2013
|
+
successDescription: "The updated intent category"
|
|
2014
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2015
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2016
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2017
|
+
name: intentCategoryNameSchema.optional(),
|
|
2018
|
+
color: intentCategoryColorSchema.optional().describe("The category color")
|
|
2019
|
+
}).refine(({ name, color }) => name !== void 0 || color !== void 0, { message: "At least one of name or color must be provided" })).output(intentCategorySchema);
|
|
2020
|
+
const deleteIntentCategoryContractV1 = base.route({
|
|
2021
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}",
|
|
2022
|
+
method: "DELETE",
|
|
2023
|
+
summary: "Delete an intent category",
|
|
2024
|
+
description: "Delete an intent category; its intents are unlinked but not deleted",
|
|
2025
|
+
tags: ["insights"],
|
|
2026
|
+
successDescription: "The intent category has been deleted successfully"
|
|
2027
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2028
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2029
|
+
categoryId: z.string().describe("The ID of the category")
|
|
2030
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2031
|
+
const linkIntentCategoryContractV1 = base.route({
|
|
2032
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/link",
|
|
2033
|
+
method: "POST",
|
|
2034
|
+
summary: "Link an intent category",
|
|
2035
|
+
description: "Link an intent category to intents; already linked intents are ignored",
|
|
2036
|
+
tags: ["insights"],
|
|
2037
|
+
successDescription: "The intents have been linked successfully"
|
|
2038
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2039
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2040
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2041
|
+
intentIds: categorizableIntentIdsSchema
|
|
2042
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2043
|
+
const unlinkIntentCategoryContractV1 = base.route({
|
|
2044
|
+
path: "/v1/environments/{environmentId}/intent-categories/{categoryId}/unlink",
|
|
2045
|
+
method: "POST",
|
|
2046
|
+
summary: "Unlink an intent category",
|
|
2047
|
+
description: "Unlink an intent category from intents; intents without the category are ignored",
|
|
2048
|
+
tags: ["insights"],
|
|
2049
|
+
successDescription: "The intents have been unlinked successfully"
|
|
2050
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2051
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2052
|
+
categoryId: z.string().describe("The ID of the category"),
|
|
2053
|
+
intentIds: categorizableIntentIdsSchema
|
|
2054
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
2055
|
+
const listTeamsContractV1 = base.route({
|
|
1940
2056
|
path: "/v1/teams",
|
|
1941
2057
|
method: "GET",
|
|
1942
2058
|
summary: "List teams",
|
|
@@ -1949,7 +2065,22 @@ const listTeamsContractV1 = oc.route({
|
|
|
1949
2065
|
createdAt: z.coerce.date(),
|
|
1950
2066
|
hasStripeAccount: z.boolean()
|
|
1951
2067
|
})));
|
|
1952
|
-
const
|
|
2068
|
+
const getTeamUsageContractV1 = base.route({
|
|
2069
|
+
path: "/v1/teams/{teamId}/usage",
|
|
2070
|
+
method: "GET",
|
|
2071
|
+
summary: "Get team usage",
|
|
2072
|
+
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.",
|
|
2073
|
+
tags: ["teams"],
|
|
2074
|
+
successDescription: "The current billing window usage"
|
|
2075
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ teamId: z.string().describe("The ID of the team") })).output(z.object({
|
|
2076
|
+
teamId: z.string(),
|
|
2077
|
+
plan: subscriptionPlanSchema.nullable().describe("The plan in force for the window, null on the Free plan"),
|
|
2078
|
+
periodStart: z.coerce.date().describe("Start of the current billing window"),
|
|
2079
|
+
periodEnd: z.coerce.date().describe("End of the current billing window"),
|
|
2080
|
+
requestCount: z.number().int().describe("MCP requests settled during the current billing window"),
|
|
2081
|
+
includedRequests: z.number().int().nullable().describe("Requests included in the plan for one window, null when the allowance is contract-specific")
|
|
2082
|
+
}));
|
|
2083
|
+
const getTunnelTicketContractV1 = base.route({
|
|
1953
2084
|
path: "/v1/tunnels/ticket",
|
|
1954
2085
|
method: "GET",
|
|
1955
2086
|
summary: "Get a tunnel ticket",
|
|
@@ -1961,16 +2092,13 @@ const getTunnelTicketContractV1 = oc.route({
|
|
|
1961
2092
|
ticket: z.string().describe("The signed tunnel ticket"),
|
|
1962
2093
|
tunnelHost: z.string().describe("The tunnel host to connect to")
|
|
1963
2094
|
}));
|
|
1964
|
-
const publishServerContractV1 =
|
|
2095
|
+
const publishServerContractV1 = base.route({
|
|
1965
2096
|
path: "/v1/distribution/publish",
|
|
1966
2097
|
method: "POST",
|
|
1967
2098
|
summary: "Publish a server to the MCP registry",
|
|
1968
2099
|
tags: ["distribution"],
|
|
1969
2100
|
successDescription: "The server has been published successfully"
|
|
1970
|
-
}).errors({
|
|
1971
|
-
NOT_FOUND: {},
|
|
1972
|
-
BAD_REQUEST: {}
|
|
1973
|
-
}).input(z.object({
|
|
2101
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1974
2102
|
projectId: z.string(),
|
|
1975
2103
|
domain: z.string(),
|
|
1976
2104
|
title: z.string().min(1).max(100),
|
|
@@ -1979,17 +2107,14 @@ const publishServerContractV1 = oc.route({
|
|
|
1979
2107
|
iconSrc: z.url().max(255).optional(),
|
|
1980
2108
|
dryRun: z.boolean().optional()
|
|
1981
2109
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
1982
|
-
const getServerInfoContractV1 =
|
|
2110
|
+
const getServerInfoContractV1 = base.route({
|
|
1983
2111
|
path: "/v1/distribution/get",
|
|
1984
2112
|
method: "GET",
|
|
1985
2113
|
summary: "Get server info",
|
|
1986
2114
|
description: "Get info about a server",
|
|
1987
2115
|
tags: ["distribution"],
|
|
1988
2116
|
successDescription: "The server info"
|
|
1989
|
-
}).errors({
|
|
1990
|
-
NOT_FOUND: {},
|
|
1991
|
-
BAD_REQUEST: {}
|
|
1992
|
-
}).input(z.object({
|
|
2117
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
1993
2118
|
projectId: z.string(),
|
|
1994
2119
|
domain: z.string()
|
|
1995
2120
|
})).output(z.object({ serverFields: serverFieldsSchema }));
|
|
@@ -2008,7 +2133,7 @@ const playgroundOutputSchema = z.object({
|
|
|
2008
2133
|
isPlaygroundEnabled: z.boolean(),
|
|
2009
2134
|
serverMetadata: playgroundServerMetadataOutputSchema.nullable()
|
|
2010
2135
|
});
|
|
2011
|
-
const getPlaygroundContractV1 =
|
|
2136
|
+
const getPlaygroundContractV1 = base.route({
|
|
2012
2137
|
path: "/v1/environments/{environmentId}/playground",
|
|
2013
2138
|
method: "GET",
|
|
2014
2139
|
summary: "Get playground configuration",
|
|
@@ -2016,17 +2141,14 @@ const getPlaygroundContractV1 = oc.route({
|
|
|
2016
2141
|
tags: ["environments"],
|
|
2017
2142
|
successDescription: "The playground configuration"
|
|
2018
2143
|
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(playgroundOutputSchema);
|
|
2019
|
-
const upsertPlaygroundContractV1 =
|
|
2144
|
+
const upsertPlaygroundContractV1 = base.route({
|
|
2020
2145
|
path: "/v1/environments/{environmentId}/playground",
|
|
2021
2146
|
method: "PUT",
|
|
2022
2147
|
summary: "Update playground configuration",
|
|
2023
2148
|
description: "Update the playground configuration for an environment. All fields are optional — only provided fields are updated.",
|
|
2024
2149
|
tags: ["environments"],
|
|
2025
2150
|
successDescription: "The updated playground configuration"
|
|
2026
|
-
}).errors({
|
|
2027
|
-
NOT_FOUND: {},
|
|
2028
|
-
BAD_REQUEST: {}
|
|
2029
|
-
}).input(z.object({
|
|
2151
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2030
2152
|
environmentId: z.string().describe("The ID of the environment"),
|
|
2031
2153
|
isPlaygroundEnabled: z.boolean().optional(),
|
|
2032
2154
|
name: z.string().min(1).max(100).optional(),
|
|
@@ -2034,7 +2156,7 @@ const upsertPlaygroundContractV1 = oc.route({
|
|
|
2034
2156
|
headers: z.array(playgroundHeaderSchema).optional(),
|
|
2035
2157
|
examplePrompts: z.array(playgroundExamplePromptSchema).max(5).optional()
|
|
2036
2158
|
})).output(playgroundOutputSchema);
|
|
2037
|
-
const createBeaconContractV1 =
|
|
2159
|
+
const createBeaconContractV1 = base.route({
|
|
2038
2160
|
path: "/v1/beacon/audits",
|
|
2039
2161
|
method: "POST",
|
|
2040
2162
|
summary: "Create a beacon audit",
|
|
@@ -2043,7 +2165,6 @@ const createBeaconContractV1 = oc.route({
|
|
|
2043
2165
|
successDescription: "The audit has been created"
|
|
2044
2166
|
}).errors({
|
|
2045
2167
|
NOT_FOUND: {},
|
|
2046
|
-
BAD_REQUEST: {},
|
|
2047
2168
|
DNS_RESOLUTION_FAILED: { status: 400 }
|
|
2048
2169
|
}).input(z.object({
|
|
2049
2170
|
targetUrl: z.url().describe("The HTTPS URL of the MCP server to audit"),
|
|
@@ -2051,7 +2172,7 @@ const createBeaconContractV1 = oc.route({
|
|
|
2051
2172
|
projectId: z.string().optional().describe("The project ID to associate the audit with"),
|
|
2052
2173
|
excludeCategories: z.array(checkCategorySchema).optional().describe("Check categories to exclude from the audit")
|
|
2053
2174
|
})).output(z.object({ id: z.string() }));
|
|
2054
|
-
const getBeaconContractV1 =
|
|
2175
|
+
const getBeaconContractV1 = base.route({
|
|
2055
2176
|
path: "/v1/beacon/audits/{auditId}",
|
|
2056
2177
|
method: "GET",
|
|
2057
2178
|
summary: "Get a beacon audit",
|
|
@@ -2067,8 +2188,21 @@ const getBeaconContractV1 = oc.route({
|
|
|
2067
2188
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
2068
2189
|
}));
|
|
2069
2190
|
const contract = {
|
|
2070
|
-
teams: {
|
|
2191
|
+
teams: {
|
|
2192
|
+
list: { v1: listTeamsContractV1 },
|
|
2193
|
+
getUsage: { v1: getTeamUsageContractV1 }
|
|
2194
|
+
},
|
|
2071
2195
|
analytics: { get: { v1: getProjectAnalyticsContractV1 } },
|
|
2196
|
+
intents: { list: { v1: listIntentsContractV1 } },
|
|
2197
|
+
intentCategories: {
|
|
2198
|
+
list: { v1: listIntentCategoriesContractV1 },
|
|
2199
|
+
create: { v1: createIntentCategoryContractV1 },
|
|
2200
|
+
update: { v1: updateIntentCategoryContractV1 },
|
|
2201
|
+
delete: { v1: deleteIntentCategoryContractV1 },
|
|
2202
|
+
link: { v1: linkIntentCategoryContractV1 },
|
|
2203
|
+
unlink: { v1: unlinkIntentCategoryContractV1 }
|
|
2204
|
+
},
|
|
2205
|
+
feedbacks: { list: { v1: listFeedbacksContractV1 } },
|
|
2072
2206
|
deployments: {
|
|
2073
2207
|
list: { v1: listDeploymentsContractV1 },
|
|
2074
2208
|
get: { v1: getDeploymentContractV1 },
|
|
@@ -2115,4 +2249,4 @@ const contractForDocs = {
|
|
|
2115
2249
|
deployments: deploymentsForDocs
|
|
2116
2250
|
};
|
|
2117
2251
|
//#endregion
|
|
2118
|
-
export { AUTH_SCOPE_ANY, AUTH_SCOPE_USER, PLATFORM_LABELS, buildSettingsSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, transportSchema, updateEnvironmentVariableSchema };
|
|
2252
|
+
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.gefacfca",
|
|
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
|
}
|