@alpic-ai/api 0.0.0-staging.ga3d0078 → 0.0.0-staging.ga405ddd
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 +5149 -32
- package/dist/index.mjs +237 -32
- package/package.json +6 -6
package/dist/index.mjs
CHANGED
|
@@ -2,7 +2,7 @@ import { z } from "zod";
|
|
|
2
2
|
import * as z$1 from "zod/v4";
|
|
3
3
|
import { oc } from "@orpc/contract";
|
|
4
4
|
import ms from "ms";
|
|
5
|
-
//#region ../../node_modules/.pnpm/@modelcontextprotocol+sdk@1.
|
|
5
|
+
//#region ../../node_modules/.pnpm/@modelcontextprotocol+sdk@1.32.1_supports-color@8.1.1_zod@4.5.4/node_modules/@modelcontextprotocol/sdk/dist/esm/shared/auth.js
|
|
6
6
|
/**
|
|
7
7
|
* Reusable URL validation that disallows javascript: scheme
|
|
8
8
|
*/
|
|
@@ -119,7 +119,12 @@ z$1.object({
|
|
|
119
119
|
token_type: z$1.string(),
|
|
120
120
|
expires_in: z$1.coerce.number().optional(),
|
|
121
121
|
scope: z$1.string().optional(),
|
|
122
|
-
refresh_token: z$1.string().optional()
|
|
122
|
+
refresh_token: z$1.string().optional(),
|
|
123
|
+
/**
|
|
124
|
+
* Not part of the wire format: the authorization server this value was obtained from, added by
|
|
125
|
+
* the client's `auth()` before it is stored and compared when it is read back.
|
|
126
|
+
*/
|
|
127
|
+
issuer: z$1.string().optional().catch(void 0)
|
|
123
128
|
}).strip();
|
|
124
129
|
z$1.object({
|
|
125
130
|
error: z$1.string(),
|
|
@@ -158,7 +163,12 @@ const OAuthClientInformationSchema = z$1.object({
|
|
|
158
163
|
client_id: z$1.string(),
|
|
159
164
|
client_secret: z$1.string().optional(),
|
|
160
165
|
client_id_issued_at: z$1.number().optional(),
|
|
161
|
-
client_secret_expires_at: z$1.number().optional()
|
|
166
|
+
client_secret_expires_at: z$1.number().optional(),
|
|
167
|
+
/**
|
|
168
|
+
* Not part of the wire format: the authorization server this value was obtained from, added by
|
|
169
|
+
* the client's `auth()` before it is stored and compared when it is read back.
|
|
170
|
+
*/
|
|
171
|
+
issuer: z$1.string().optional().catch(void 0)
|
|
162
172
|
}).strip();
|
|
163
173
|
OAuthClientMetadataSchema.merge(OAuthClientInformationSchema);
|
|
164
174
|
z$1.object({
|
|
@@ -336,7 +346,8 @@ const standaloneEnvironmentSchema = z.object({
|
|
|
336
346
|
const protectedWithoutDiscoveryEnvironmentSchema = z.object({
|
|
337
347
|
allowsAnonymous: z.literal(false),
|
|
338
348
|
oAuthMetadata: z.strictObject({}),
|
|
339
|
-
scope: z.string().optional()
|
|
349
|
+
scope: z.string().optional(),
|
|
350
|
+
wwwAuthenticate: z.string().optional()
|
|
340
351
|
});
|
|
341
352
|
const legacyPublicEnvironmentSchema = z.object({
|
|
342
353
|
isPublic: z.literal(true),
|
|
@@ -381,10 +392,13 @@ z.union([
|
|
|
381
392
|
legacyProtectedWithoutDiscoveryEnvironmentSchema
|
|
382
393
|
]);
|
|
383
394
|
const playgroundModelSchema = z.enum([
|
|
395
|
+
"global.anthropic.claude-haiku-5-5",
|
|
384
396
|
"global.anthropic.claude-haiku-4-5-20251001-v1:0",
|
|
385
|
-
"global.anthropic.claude-sonnet-
|
|
397
|
+
"global.anthropic.claude-sonnet-5-5",
|
|
386
398
|
"openai.gpt-5.4",
|
|
387
|
-
"openai.gpt-5.5"
|
|
399
|
+
"openai.gpt-5.5",
|
|
400
|
+
"openai.gpt-6-luna",
|
|
401
|
+
"openai.gpt-6.1-sol"
|
|
388
402
|
]);
|
|
389
403
|
const environmentDomainSchema = z.object({
|
|
390
404
|
name: z.string(),
|
|
@@ -420,7 +434,8 @@ z.object({
|
|
|
420
434
|
collectResponsePayload: z.boolean(),
|
|
421
435
|
collectErrorMessage: z.boolean(),
|
|
422
436
|
collectUserData: z.boolean(),
|
|
423
|
-
identityTraitKey: z.string().min(1).max(200).nullable()
|
|
437
|
+
identityTraitKey: z.string().min(1).max(200).nullable(),
|
|
438
|
+
leadEventName: z.string().min(1).max(200).nullable()
|
|
424
439
|
});
|
|
425
440
|
const feedbackSchema = z.object({
|
|
426
441
|
id: z.string(),
|
|
@@ -539,6 +554,14 @@ z.enum([
|
|
|
539
554
|
"DEBUG",
|
|
540
555
|
"ERROR"
|
|
541
556
|
]);
|
|
557
|
+
const LOG_SEARCH_MAX_ESCAPED_LENGTH = 960;
|
|
558
|
+
function escapeLogSearchTerm(search) {
|
|
559
|
+
return [...search].flatMap((character) => [...new TextEncoder().encode(character)]).map((byte) => {
|
|
560
|
+
const character = String.fromCharCode(byte);
|
|
561
|
+
return /^[a-zA-Z0-9]$/.test(character) ? character : `\\x${byte.toString(16).toUpperCase().padStart(2, "0")}`;
|
|
562
|
+
}).join("");
|
|
563
|
+
}
|
|
564
|
+
const logSearchSchema = z.string().max(240, `Search must be 240 characters or fewer`).refine((search) => escapeLogSearchTerm(search).length <= LOG_SEARCH_MAX_ESCAPED_LENGTH, "Search is too complex; shorten it or use fewer special characters");
|
|
542
565
|
/** Only names a vendor actually ships belong here: lookalikes like `claude-code-test` are customers' own scripts. */
|
|
543
566
|
const MCP_CLIENT_GROUPS = [
|
|
544
567
|
{
|
|
@@ -606,7 +629,7 @@ const MCP_CLIENT_GROUPS = [
|
|
|
606
629
|
id: "chatgpt",
|
|
607
630
|
label: "ChatGPT",
|
|
608
631
|
vendor: "openai",
|
|
609
|
-
rawNames: ["openai-mcp (ChatGPT)"]
|
|
632
|
+
rawNames: ["openai-mcp", "openai-mcp (ChatGPT)"]
|
|
610
633
|
},
|
|
611
634
|
{
|
|
612
635
|
id: "openai_responses_api",
|
|
@@ -620,12 +643,6 @@ const MCP_CLIENT_GROUPS = [
|
|
|
620
643
|
vendor: "openai",
|
|
621
644
|
rawNames: ["openai-mcp (Agent Builder)"]
|
|
622
645
|
},
|
|
623
|
-
{
|
|
624
|
-
id: "openai_other",
|
|
625
|
-
label: "OpenAI Other",
|
|
626
|
-
vendor: "openai",
|
|
627
|
-
rawNames: ["openai-mcp"]
|
|
628
|
-
},
|
|
629
646
|
{
|
|
630
647
|
id: "cursor",
|
|
631
648
|
label: "Cursor",
|
|
@@ -1210,7 +1227,7 @@ const chatgptTranslationLocaleSchema = z.enum([
|
|
|
1210
1227
|
const negativeTestCaseSchema = z.object({
|
|
1211
1228
|
scenario: z.string().min(1),
|
|
1212
1229
|
userPrompt: z.string().min(1)
|
|
1213
|
-
}).describe("Each case: Scenario + User prompt (the
|
|
1230
|
+
}).describe("Each case: Scenario + User prompt (the plugin should NOT trigger).");
|
|
1214
1231
|
const negativeTestCaseDraftSchema = negativeTestCaseSchema.partial().extend({
|
|
1215
1232
|
scenario: z.string().optional(),
|
|
1216
1233
|
userPrompt: z.string().optional()
|
|
@@ -1239,28 +1256,28 @@ chatgptTranslationSchema.extend({ tagline: clampStringField(chatgptTaglineSchema
|
|
|
1239
1256
|
const chatgptSubmissionFormDataSchema = z.object({
|
|
1240
1257
|
logoLight: z.string().describe("Logo icon for light mode. Square PNG, no borders or rounded corners (clients apply circular cropping)."),
|
|
1241
1258
|
logoDark: z.string().optional().describe("Optional dark-mode logo icon. Square PNG, same specs as the light icon. Leave empty if the light icon also works on dark backgrounds."),
|
|
1242
|
-
appName: z.string().describe("The name users will see in ChatGPT and in the
|
|
1259
|
+
appName: z.string().describe("The name users will see in ChatGPT and in the Plugin Directory."),
|
|
1243
1260
|
tagline: chatgptTaglineSchema.describe("Plain-language phrase focused on function and user value, 30 chars max. Avoid generic superlatives like \"the best …\"."),
|
|
1244
|
-
description: chatgptDescriptionSchema.describe("Clear, engaging description highlighting what the
|
|
1261
|
+
description: chatgptDescriptionSchema.describe("Clear, engaging description highlighting what the plugin does and why people will love it. Appears publicly on the directory page. End it by naming the product categories or intents the plugin does NOT cover, so ChatGPT learns when not to route to it (define exclusions by absent categories or wrong intents, never by naming other brands)."),
|
|
1245
1262
|
category: chatgptCategorySchema.describe("Category from the OpenAI taxonomy."),
|
|
1246
|
-
developerName: z.string().describe("Developer name shown publicly on the
|
|
1263
|
+
developerName: z.string().describe("Developer name shown publicly on the plugin's directory page."),
|
|
1247
1264
|
companyUrl: urlField.describe("Your company's main website URL."),
|
|
1248
1265
|
supportChannel: supportChannelSchema.describe("Customer support URL or email address."),
|
|
1249
1266
|
privacyPolicyUrl: urlField.describe("URL to your privacy policy."),
|
|
1250
|
-
termsOfServiceUrl: urlField.describe("URL to the
|
|
1251
|
-
demoRecordingUrl: urlField.describe("URL to a video demonstrating the
|
|
1252
|
-
appCommerceAndPurchasing: z.boolean().describe("Checkbox: 'My
|
|
1267
|
+
termsOfServiceUrl: urlField.describe("URL to the plugin's terms of service."),
|
|
1268
|
+
demoRecordingUrl: urlField.describe("URL to a video demonstrating the plugin, recorded via OpenAI Developer Mode. Cover all main use cases on web, iOS, and Android."),
|
|
1269
|
+
appCommerceAndPurchasing: z.boolean().describe("Checkbox: 'My plugin links or directs users out of ChatGPT to make purchases.' Defaults to false. Verify the plugin does not offer digital goods."),
|
|
1253
1270
|
serverUrl: urlField.describe("URL of the MCP server."),
|
|
1254
1271
|
authentication: chatgptAuthenticationSchema.describe("OAuth 2.0 or No auth. OAuth configuration is auto-discovered from the MCP server's metadata."),
|
|
1255
1272
|
tools: z.array(toolDefinitionSchema).describe("List of tools exposed by the MCP server (auto-populated from the production server's manifest)."),
|
|
1256
1273
|
toolJustifications: z.array(chatgptToolJustificationSchema).describe("Per-tool justification of `readOnlyHint`, `openWorldHint`, and `destructiveHint` annotation values. One short, specific sentence per hint describing what the tool actually does."),
|
|
1257
1274
|
skills: z.array(chatgptSkillSchema).optional().describe("Skills the server exposes over MCP (auto-populated from the production server's manifest). Left unset when the server does not advertise the skills extension, which is a different state from advertising it and exposing none."),
|
|
1258
1275
|
testCases: z.array(positiveTestCaseSchema).length(5).describe("Exactly 5 positive test cases. Each: Scenario, User prompt, Tool triggered, Expected output. Collectively cover the full capability across different flow stages (initial search or browse, market or locale handling, post-interaction detail, an action ChatGPT performs on the user's behalf, and a conversion or secondary tool) rather than five variations of the same first step."),
|
|
1259
|
-
negativeTestCases: z.array(negativeTestCaseSchema).length(3).describe("Exactly 3 negative test cases: prompts where the
|
|
1260
|
-
screenshots: z.array(screenshotEntrySchema.extend({ prompt: z.string().max(75, { error: "Screenshot prompts are limited to 75 characters." }) })).max(3).describe("In-
|
|
1276
|
+
negativeTestCases: z.array(negativeTestCaseSchema).length(3).describe("Exactly 3 negative test cases: prompts where the plugin should NOT trigger but the model might think it is relevant. These become production routing metadata that teaches ChatGPT when to stay silent, so pick tight near-misses: a product category the plugin does not carry, the right brand or domain but an intent the plugin does not serve, or a boundary with a sibling plugin."),
|
|
1277
|
+
screenshots: z.array(screenshotEntrySchema.extend({ prompt: z.string().max(75, { error: "Screenshot prompts are limited to 75 characters." }) })).max(3).describe("In-plugin screenshots paired with the user prompt that produced them (each prompt is 75 characters max). Widget plugins must show the widget UI; non-widget plugins show the model response. Min 1, max 3 entries, all public. Images: 706px wide, 400–860px tall, PNG."),
|
|
1261
1278
|
translations: z.array(chatgptTranslationSchema).describe("Per-locale translation of tagline + description. English (US) is the default."),
|
|
1262
1279
|
allowedCountries: chatgptAllowedCountriesSchema.describe("Availability: all supported countries, or an allow-list / block-list of specific ones (ISO alpha-2)."),
|
|
1263
|
-
releaseNotes: z.string().describe("Publicly displayed on the
|
|
1280
|
+
releaseNotes: z.string().describe("Publicly displayed on the plugin details page.")
|
|
1264
1281
|
});
|
|
1265
1282
|
const chatgptSubmissionDraftSchema = chatgptSubmissionFormDataSchema.partial().extend({
|
|
1266
1283
|
tagline: z.string().optional(),
|
|
@@ -1516,8 +1533,10 @@ const chatgptSubmissionSchemaInternal = submissionMetaFieldsSchema.extend({
|
|
|
1516
1533
|
formData: chatgptSubmissionDraftSchema,
|
|
1517
1534
|
prefillSnapshot: chatgptSubmissionDraftSchema.nullable().default(null)
|
|
1518
1535
|
});
|
|
1519
|
-
z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1536
|
+
const submissionSchemaInternal = z.discriminatedUnion("platform", [claudeSubmissionSchemaInternal, chatgptSubmissionSchemaInternal]);
|
|
1520
1537
|
z.union([claudeSubmissionDraftSchema, chatgptSubmissionDraftSchema]);
|
|
1538
|
+
/** Discriminated on `platform`, which pins the shape of `formData`: a Claude submission cannot carry chatgpt-only fields, and vice-versa. */
|
|
1539
|
+
const submissionSchema = submissionSchemaInternal;
|
|
1521
1540
|
z.literal([
|
|
1522
1541
|
100,
|
|
1523
1542
|
75,
|
|
@@ -1545,6 +1564,7 @@ const metricsQueueEventSchema = z.object({
|
|
|
1545
1564
|
tool: z.string().nullable(),
|
|
1546
1565
|
client: z.string(),
|
|
1547
1566
|
sessionId: z.string().nullable(),
|
|
1567
|
+
conversationId: z.string().nullable().optional(),
|
|
1548
1568
|
durationMs: z.number().int(),
|
|
1549
1569
|
outputTokens: z.number().int().nullable(),
|
|
1550
1570
|
errorType: z.enum([
|
|
@@ -1560,12 +1580,14 @@ z.object({
|
|
|
1560
1580
|
events: z.array(metricsQueueEventSchema)
|
|
1561
1581
|
});
|
|
1562
1582
|
z.object({ v: z.number() });
|
|
1563
|
-
const
|
|
1583
|
+
const TELEMETRY_SIGNALS = [
|
|
1564
1584
|
"logs",
|
|
1565
1585
|
"metrics",
|
|
1566
1586
|
"traces"
|
|
1567
|
-
]
|
|
1568
|
-
const
|
|
1587
|
+
];
|
|
1588
|
+
const telemetrySignalSchema = z.enum(TELEMETRY_SIGNALS);
|
|
1589
|
+
const OTLP_PROTOCOLS = ["http/protobuf", "http/json"];
|
|
1590
|
+
const otlpProtocolSchema = z.enum(OTLP_PROTOCOLS);
|
|
1569
1591
|
const otlpEndpointSchema = z.string().trim().min(1).max(2048);
|
|
1570
1592
|
const OTLP_HEADER_VALUE_MAX_LENGTH = 2048;
|
|
1571
1593
|
const otlpHeaderNameSchema = z.string().trim().min(1, "Enter a header name").max(128).regex(/^[A-Za-z0-9!#$%&'*+\-.^_`|~]+$/, "Use letters, digits and !#$%&'*+-.^_`|~ only");
|
|
@@ -1596,8 +1618,13 @@ z.object({
|
|
|
1596
1618
|
protocol: otlpProtocolSchema,
|
|
1597
1619
|
headers: z.array(telemetryDestinationHeaderSchema),
|
|
1598
1620
|
status: telemetryDestinationStatusSchema,
|
|
1599
|
-
lastFailureReason: otlpPushFailureReasonSchema.nullable()
|
|
1621
|
+
lastFailureReason: otlpPushFailureReasonSchema.nullable(),
|
|
1622
|
+
isScopedToIntentionalRequestsOnly: z.boolean()
|
|
1600
1623
|
});
|
|
1624
|
+
const hasDuplicateHeaderNames = (headers) => {
|
|
1625
|
+
const names = headers.map(({ name }) => name.trim().toLowerCase());
|
|
1626
|
+
return new Set(names).size !== names.length;
|
|
1627
|
+
};
|
|
1601
1628
|
//#endregion
|
|
1602
1629
|
//#region src/auth-scope.ts
|
|
1603
1630
|
/** Accepts an API key or OAuth access token (default for most routes). */
|
|
@@ -1888,6 +1915,100 @@ const environmentVariableOutputSchema = z.object({
|
|
|
1888
1915
|
isSecret: z.boolean(),
|
|
1889
1916
|
createdAt: z.coerce.date()
|
|
1890
1917
|
});
|
|
1918
|
+
const telemetryDestinationHeaderOutputSchema = z.discriminatedUnion("isSecret", [z.object({
|
|
1919
|
+
id: z.string(),
|
|
1920
|
+
name: otlpHeaderNameSchema,
|
|
1921
|
+
value: z.null(),
|
|
1922
|
+
isSecret: z.literal(true)
|
|
1923
|
+
}), z.object({
|
|
1924
|
+
id: z.string(),
|
|
1925
|
+
name: otlpHeaderNameSchema,
|
|
1926
|
+
value: otlpHeaderValueSchema,
|
|
1927
|
+
isSecret: z.literal(false)
|
|
1928
|
+
})]);
|
|
1929
|
+
const telemetryDestinationOutputSchema = z.object({
|
|
1930
|
+
id: z.string(),
|
|
1931
|
+
signal: telemetrySignalSchema,
|
|
1932
|
+
endpoint: otlpEndpointSchema,
|
|
1933
|
+
protocol: otlpProtocolSchema,
|
|
1934
|
+
headers: z.array(telemetryDestinationHeaderOutputSchema),
|
|
1935
|
+
status: telemetryDestinationStatusSchema,
|
|
1936
|
+
lastFailureReason: otlpPushFailureReasonSchema.nullable(),
|
|
1937
|
+
isScopedToIntentionalRequestsOnly: z.boolean()
|
|
1938
|
+
});
|
|
1939
|
+
const createTelemetryDestinationHeaderInputSchema = z.object({
|
|
1940
|
+
name: otlpHeaderNameSchema,
|
|
1941
|
+
value: otlpHeaderValueSchema.min(1, "Enter a header value"),
|
|
1942
|
+
isSecret: z.boolean()
|
|
1943
|
+
});
|
|
1944
|
+
const updateTelemetryDestinationHeaderInputSchema = z.object({
|
|
1945
|
+
id: z.string().optional(),
|
|
1946
|
+
name: otlpHeaderNameSchema,
|
|
1947
|
+
value: otlpHeaderValueSchema.optional(),
|
|
1948
|
+
isSecret: z.boolean()
|
|
1949
|
+
});
|
|
1950
|
+
const uniqueTelemetryHeaders = (headers) => !hasDuplicateHeaderNames(headers);
|
|
1951
|
+
const listTelemetryDestinationsContractV1 = base.route({
|
|
1952
|
+
path: "/v1/environments/{environmentId}/telemetry-destinations",
|
|
1953
|
+
method: "GET",
|
|
1954
|
+
summary: "List telemetry destinations",
|
|
1955
|
+
description: "List the OTLP destinations configured for an environment. Secret header values are never returned.",
|
|
1956
|
+
tags: ["telemetry"],
|
|
1957
|
+
successDescription: "The list of telemetry destinations"
|
|
1958
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ environmentId: z.string().describe("The ID of the environment") })).output(z.array(telemetryDestinationOutputSchema));
|
|
1959
|
+
const createTelemetryDestinationContractV1 = base.route({
|
|
1960
|
+
path: "/v1/environments/{environmentId}/telemetry-destinations",
|
|
1961
|
+
method: "POST",
|
|
1962
|
+
summary: "Create a telemetry destination",
|
|
1963
|
+
description: "Verify and save an OTLP destination for logs, metrics, or traces.",
|
|
1964
|
+
tags: ["telemetry"],
|
|
1965
|
+
successDescription: "The telemetry destination has been created"
|
|
1966
|
+
}).errors({
|
|
1967
|
+
NOT_FOUND: {},
|
|
1968
|
+
FORBIDDEN: {},
|
|
1969
|
+
OTLP_DESTINATION_UNVERIFIED: { status: 400 },
|
|
1970
|
+
INTERNAL_SERVER_ERROR: {}
|
|
1971
|
+
}).input(z.object({
|
|
1972
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
1973
|
+
signal: telemetrySignalSchema,
|
|
1974
|
+
endpoint: otlpEndpointSchema,
|
|
1975
|
+
protocol: otlpProtocolSchema.default("http/protobuf"),
|
|
1976
|
+
isScopedToIntentionalRequestsOnly: z.boolean().default(false),
|
|
1977
|
+
headers: z.array(createTelemetryDestinationHeaderInputSchema).default([]).refine(uniqueTelemetryHeaders, "Header names must be unique")
|
|
1978
|
+
})).output(telemetryDestinationOutputSchema);
|
|
1979
|
+
const updateTelemetryDestinationContractV1 = base.route({
|
|
1980
|
+
path: "/v1/environments/{environmentId}/telemetry-destinations/{destinationId}",
|
|
1981
|
+
method: "PATCH",
|
|
1982
|
+
summary: "Update a telemetry destination",
|
|
1983
|
+
description: "Verify and save changes to an OTLP destination. Omit headers to keep them unchanged; omit the value of an existing header to preserve it. A secret header value must be re-entered when the endpoint changes.",
|
|
1984
|
+
tags: ["telemetry"],
|
|
1985
|
+
successDescription: "The telemetry destination has been updated"
|
|
1986
|
+
}).errors({
|
|
1987
|
+
NOT_FOUND: {},
|
|
1988
|
+
FORBIDDEN: {},
|
|
1989
|
+
OTLP_DESTINATION_UNVERIFIED: { status: 400 }
|
|
1990
|
+
}).input(z.object({
|
|
1991
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
1992
|
+
destinationId: z.string().describe("The ID of the telemetry destination"),
|
|
1993
|
+
endpoint: otlpEndpointSchema.optional(),
|
|
1994
|
+
protocol: otlpProtocolSchema.optional(),
|
|
1995
|
+
isScopedToIntentionalRequestsOnly: z.boolean().optional(),
|
|
1996
|
+
headers: z.array(updateTelemetryDestinationHeaderInputSchema).refine(uniqueTelemetryHeaders, "Header names must be unique").optional()
|
|
1997
|
+
})).output(telemetryDestinationOutputSchema);
|
|
1998
|
+
const deleteTelemetryDestinationContractV1 = base.route({
|
|
1999
|
+
path: "/v1/environments/{environmentId}/telemetry-destinations/{destinationId}",
|
|
2000
|
+
method: "DELETE",
|
|
2001
|
+
summary: "Delete a telemetry destination",
|
|
2002
|
+
description: "Delete an OTLP destination from an environment.",
|
|
2003
|
+
tags: ["telemetry"],
|
|
2004
|
+
successDescription: "The telemetry destination has been deleted"
|
|
2005
|
+
}).errors({
|
|
2006
|
+
NOT_FOUND: {},
|
|
2007
|
+
INTERNAL_SERVER_ERROR: {}
|
|
2008
|
+
}).input(z.object({
|
|
2009
|
+
environmentId: z.string().describe("The ID of the environment"),
|
|
2010
|
+
destinationId: z.string().describe("The ID of the telemetry destination")
|
|
2011
|
+
})).output(z.object({ success: z.literal(true) }));
|
|
1891
2012
|
const listEnvironmentVariablesContractV1 = base.route({
|
|
1892
2013
|
path: "/v1/environments/{environmentId}/environment-variables",
|
|
1893
2014
|
method: "GET",
|
|
@@ -2031,7 +2152,7 @@ const getLogsContractV1 = base.route({
|
|
|
2031
2152
|
"WARNING",
|
|
2032
2153
|
"DEBUG"
|
|
2033
2154
|
])).optional().describe("Filter by log level"),
|
|
2034
|
-
search:
|
|
2155
|
+
search: logSearchSchema.optional().describe("Term to search for in log content"),
|
|
2035
2156
|
nextToken: z.string().optional().describe("Pagination token from a previous response")
|
|
2036
2157
|
})).output(z.object({
|
|
2037
2158
|
logs: z.array(logEntrySchema),
|
|
@@ -2053,7 +2174,7 @@ const getLatestLogsContractV1 = base.route({
|
|
|
2053
2174
|
"WARNING",
|
|
2054
2175
|
"DEBUG"
|
|
2055
2176
|
])).optional().describe("Filter by log level"),
|
|
2056
|
-
search:
|
|
2177
|
+
search: logSearchSchema.optional().describe("Term to search for in log content")
|
|
2057
2178
|
})).output(z.object({ logs: z.array(logEntrySchema) }));
|
|
2058
2179
|
const getDeploymentLogsContractV1 = base.route({
|
|
2059
2180
|
path: "/v1/deployments/{deploymentId}/logs",
|
|
@@ -2364,6 +2485,57 @@ const getBeaconContractV1 = base.route({
|
|
|
2364
2485
|
createdAt: z.coerce.date(),
|
|
2365
2486
|
report: auditReportWithScreenshotsSchema.nullable()
|
|
2366
2487
|
}));
|
|
2488
|
+
const PLATFORM_DESCRIPTION = "The directory the package targets: `chatgpt` for the OpenAI App Directory, `claudeai` for the Anthropic MCP Directory";
|
|
2489
|
+
const submissionIdSchema = z.string().describe("The ID of the submission package");
|
|
2490
|
+
const claudeSubmissionUpdateSchema = claudeSubmissionDraftSchema.strict();
|
|
2491
|
+
const chatgptSubmissionUpdateSchema = chatgptSubmissionDraftSchema.strict();
|
|
2492
|
+
const createSubmissionContractV1 = base.route({
|
|
2493
|
+
path: "/v1/submissions",
|
|
2494
|
+
method: "POST",
|
|
2495
|
+
summary: "Create a submission package",
|
|
2496
|
+
description: "Create a submission package for an environment. Alpic reads the environment's live MCP server and prefills every field it can infer, so the response already carries the populated package. The environment must have a successful deployment and must not require authentication.",
|
|
2497
|
+
tags: ["submissions"],
|
|
2498
|
+
successDescription: "The created submission package, with its prefilled fields"
|
|
2499
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2500
|
+
environmentId: z.string().describe("The ID of the environment to build the package from"),
|
|
2501
|
+
platform: platformSchema.describe(PLATFORM_DESCRIPTION)
|
|
2502
|
+
})).output(submissionSchema);
|
|
2503
|
+
const listSubmissionsContractV1 = base.route({
|
|
2504
|
+
path: "/v1/projects/{projectId}/submissions",
|
|
2505
|
+
method: "GET",
|
|
2506
|
+
summary: "List submission packages",
|
|
2507
|
+
description: "List the submission packages of a project, grouped by directory and most recently updated first, optionally narrowed to one environment or one directory",
|
|
2508
|
+
tags: ["submissions"],
|
|
2509
|
+
successDescription: "The list of submission packages"
|
|
2510
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({
|
|
2511
|
+
projectId: z.string().describe("The ID of the project"),
|
|
2512
|
+
environmentId: z.string().optional().describe("Filter by environment ID"),
|
|
2513
|
+
platform: platformSchema.optional().describe(PLATFORM_DESCRIPTION)
|
|
2514
|
+
})).output(z.array(submissionSchema));
|
|
2515
|
+
const getSubmissionContractV1 = base.route({
|
|
2516
|
+
path: "/v1/submissions/{submissionId}",
|
|
2517
|
+
method: "GET",
|
|
2518
|
+
summary: "Get a submission package",
|
|
2519
|
+
description: "Get a submission package by ID, including its form data and the prefill it started from",
|
|
2520
|
+
tags: ["submissions"],
|
|
2521
|
+
successDescription: "The submission package"
|
|
2522
|
+
}).errors({ NOT_FOUND: {} }).input(z.object({ submissionId: submissionIdSchema })).output(submissionSchema);
|
|
2523
|
+
const updateSubmissionContractV1 = base.route({
|
|
2524
|
+
path: "/v1/submissions/{submissionId}",
|
|
2525
|
+
method: "PUT",
|
|
2526
|
+
summary: "Update a submission package",
|
|
2527
|
+
description: "Update the form data of a submission package. Only the fields you send are changed; the rest are left as they are. Unknown field names are rejected rather than ignored, so a typo fails the call. `platform` must match the package's own platform.",
|
|
2528
|
+
tags: ["submissions"],
|
|
2529
|
+
successDescription: "The updated submission package"
|
|
2530
|
+
}).errors({ NOT_FOUND: {} }).input(z.discriminatedUnion("platform", [z.object({
|
|
2531
|
+
submissionId: submissionIdSchema,
|
|
2532
|
+
platform: z.literal("claudeai").describe(PLATFORM_DESCRIPTION),
|
|
2533
|
+
formData: claudeSubmissionUpdateSchema
|
|
2534
|
+
}), z.object({
|
|
2535
|
+
submissionId: submissionIdSchema,
|
|
2536
|
+
platform: z.literal("chatgpt").describe(PLATFORM_DESCRIPTION),
|
|
2537
|
+
formData: chatgptSubmissionUpdateSchema
|
|
2538
|
+
})])).output(submissionSchema);
|
|
2367
2539
|
const contract = {
|
|
2368
2540
|
teams: {
|
|
2369
2541
|
list: { v1: listTeamsContractV1 },
|
|
@@ -2400,6 +2572,12 @@ const contract = {
|
|
|
2400
2572
|
update: { v1: updateEnvironmentVariableContractV1 },
|
|
2401
2573
|
delete: { v1: deleteEnvironmentVariableContractV1 }
|
|
2402
2574
|
},
|
|
2575
|
+
telemetryDestinations: {
|
|
2576
|
+
list: { v1: listTelemetryDestinationsContractV1 },
|
|
2577
|
+
create: { v1: createTelemetryDestinationContractV1 },
|
|
2578
|
+
update: { v1: updateTelemetryDestinationContractV1 },
|
|
2579
|
+
delete: { v1: deleteTelemetryDestinationContractV1 }
|
|
2580
|
+
},
|
|
2403
2581
|
projects: {
|
|
2404
2582
|
update: { v1: updateProjectContractV1 },
|
|
2405
2583
|
get: { v1: getProjectContractV1 },
|
|
@@ -2419,6 +2597,12 @@ const contract = {
|
|
|
2419
2597
|
beacon: {
|
|
2420
2598
|
create: { v1: createBeaconContractV1 },
|
|
2421
2599
|
get: { v1: getBeaconContractV1 }
|
|
2600
|
+
},
|
|
2601
|
+
submissions: {
|
|
2602
|
+
create: { v1: createSubmissionContractV1 },
|
|
2603
|
+
list: { v1: listSubmissionsContractV1 },
|
|
2604
|
+
get: { v1: getSubmissionContractV1 },
|
|
2605
|
+
update: { v1: updateSubmissionContractV1 }
|
|
2422
2606
|
}
|
|
2423
2607
|
};
|
|
2424
2608
|
const { uploadArtifact: _discard, ...deploymentsForDocs } = contract.deployments;
|
|
@@ -2426,5 +2610,26 @@ const contractForDocs = {
|
|
|
2426
2610
|
...contract,
|
|
2427
2611
|
deployments: deploymentsForDocs
|
|
2428
2612
|
};
|
|
2613
|
+
/** Shared by the served `openapi.json` and the snapshot test that guards it, so the two cannot drift. */
|
|
2614
|
+
const OPENAPI_DOC_OPTIONS = {
|
|
2615
|
+
info: {
|
|
2616
|
+
title: "Alpic API",
|
|
2617
|
+
version: "1.0.0"
|
|
2618
|
+
},
|
|
2619
|
+
servers: [{ url: "https://api.alpic.ai" }],
|
|
2620
|
+
security: [{ bearerAuth: [] }],
|
|
2621
|
+
components: { securitySchemes: { bearerAuth: {
|
|
2622
|
+
type: "http",
|
|
2623
|
+
description: "Bearer token for authentication. Use an API key from the API Keys page in team settings, or an OAuth access token.",
|
|
2624
|
+
scheme: "bearer"
|
|
2625
|
+
} } },
|
|
2626
|
+
commonSchemas: {
|
|
2627
|
+
Submission: { schema: submissionSchema },
|
|
2628
|
+
ClaudeSubmissionFormData: { schema: claudeSubmissionDraftSchema },
|
|
2629
|
+
ChatgptSubmissionFormData: { schema: chatgptSubmissionDraftSchema },
|
|
2630
|
+
ClaudeSubmissionFormDataUpdate: { schema: claudeSubmissionUpdateSchema },
|
|
2631
|
+
ChatgptSubmissionFormDataUpdate: { schema: chatgptSubmissionUpdateSchema }
|
|
2632
|
+
}
|
|
2633
|
+
};
|
|
2429
2634
|
//#endregion
|
|
2430
|
-
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 };
|
|
2635
|
+
export { AI_PLATFORMS, AUTH_SCOPE_ANY, AUTH_SCOPE_USER, INTENT_CATEGORY_COLORS, OPENAPI_DOC_OPTIONS, OTLP_PROTOCOLS, PLATFORM_LABELS, TELEMETRY_SIGNALS, buildSettingsSchema, chatgptSubmissionUpdateSchema, claudeSubmissionUpdateSchema, contract, contractForDocs, createEnvironmentContractV1, deploymentStatusSchema, environmentVariableSchema, environmentVariablesSchema, intentCategoryColorSchema, otlpProtocolSchema, playgroundExamplePromptSchema, playgroundHeaderSchema, runtimeSchema, serverFieldsSchema, telemetrySignalSchema, 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.ga405ddd",
|
|
4
4
|
"description": "Contract for the Alpic API",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.mjs",
|
|
@@ -33,20 +33,20 @@
|
|
|
33
33
|
"author": "Alpic",
|
|
34
34
|
"license": "ISC",
|
|
35
35
|
"dependencies": {
|
|
36
|
-
"@orpc/contract": "^1.15.
|
|
36
|
+
"@orpc/contract": "^1.15.7",
|
|
37
37
|
"ms": "^2.1.3",
|
|
38
38
|
"zod": "^4.5.4"
|
|
39
39
|
},
|
|
40
40
|
"devDependencies": {
|
|
41
41
|
"@alpic-ai/domains": "0.0.0",
|
|
42
|
-
"@orpc/openapi": "^1.15.
|
|
43
|
-
"@orpc/zod": "^1.15.
|
|
42
|
+
"@orpc/openapi": "^1.15.7",
|
|
43
|
+
"@orpc/zod": "^1.15.7",
|
|
44
44
|
"@total-typescript/tsconfig": "^1.0.4",
|
|
45
45
|
"@types/ms": "^2.1.0",
|
|
46
46
|
"shx": "^0.4.0",
|
|
47
|
-
"tsdown": "^0.23.
|
|
47
|
+
"tsdown": "^0.23.1",
|
|
48
48
|
"typescript": "^6.0.3",
|
|
49
|
-
"vitest": "^5.0.
|
|
49
|
+
"vitest": "^5.0.5"
|
|
50
50
|
},
|
|
51
51
|
"scripts": {
|
|
52
52
|
"build": "shx rm -rf dist && tsdown",
|