@salsita-ai/contracts 0.50.0-develop.c33986dc44 → 0.50.0-develop.c402728d10
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/README.md +2 -0
- package/dist/assistant/graphql-tools.d.ts +13 -0
- package/dist/assistant/graphql-tools.js +1 -1
- package/dist/assistant/image-reference.d.ts +10 -0
- package/dist/assistant/image-reference.js +1 -0
- package/dist/assistant/index.d.ts +1 -0
- package/dist/assistant/index.js +1 -1
- package/dist/assistant/message-metadata.d.ts +10 -1
- package/dist/assistant/message-metadata.js +1 -1
- package/dist/webhook/implementation/backend-data-response.d.ts +3 -0
- package/dist/webhook/implementation/backend-data-response.js +1 -0
- package/dist/webhook/implementation/webhook-routing.js +1 -1
- package/dist/webhook/implementation/webhook-tunnel-types.d.ts +9 -0
- package/dist/webhook/implementation/webhook-tunnel-types.js +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -22,6 +22,8 @@ There is no package-root export. Import from the path that owns the boundary; th
|
|
|
22
22
|
| `assistant` | Experimental assistant: shared client-tool definitions, user-message metadata, server-recorded tool errors and the deployment webhook setup shape. |
|
|
23
23
|
| `webhook` | Webhook clients and building blocks, finalization tasks and resources, spreadsheet adapters. |
|
|
24
24
|
|
|
25
|
+
The gzip and development-tunnel wire contracts are defined in [Webhook transports](../../../docs/architecture/background-jobs.md#webhook-transports).
|
|
26
|
+
|
|
25
27
|
Runtime schemas and TypeScript types are kept aligned, so a value that passes the schema has the declared type.
|
|
26
28
|
|
|
27
29
|
## Licence
|
|
@@ -11,6 +11,8 @@ export interface AssistantGraphQLOperation {
|
|
|
11
11
|
* against the configurator's GraphQL schema, each one seeing the changes of the ones before it.
|
|
12
12
|
*/
|
|
13
13
|
export interface AssistantGraphQLToolInput {
|
|
14
|
+
/** A short name of the call for the user, in their language; the panel shows it on the call's chip. */
|
|
15
|
+
readonly title?: string | null;
|
|
14
16
|
readonly operations: ReadonlyArray<AssistantGraphQLOperation>;
|
|
15
17
|
}
|
|
16
18
|
/**
|
|
@@ -19,6 +21,7 @@ export interface AssistantGraphQLToolInput {
|
|
|
19
21
|
* out; the tools are not sent as strict schemas, because `variables` is a free-form map.
|
|
20
22
|
*/
|
|
21
23
|
export declare const AssistantGraphQLToolInput: z.ZodObject<{
|
|
24
|
+
title: z.ZodCatch<z.ZodOptional<z.ZodNullable<z.ZodString>>>;
|
|
22
25
|
operations: z.ZodArray<z.ZodObject<{
|
|
23
26
|
query: z.ZodString;
|
|
24
27
|
variables: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodUnknown>>>;
|
|
@@ -33,12 +36,14 @@ export declare const AssistantGraphQLToolInput: z.ZodObject<{
|
|
|
33
36
|
operationName?: string | null | undefined;
|
|
34
37
|
}>, "many">;
|
|
35
38
|
}, "strip", z.ZodTypeAny, {
|
|
39
|
+
title?: string | null | undefined;
|
|
36
40
|
operations: {
|
|
37
41
|
query: string;
|
|
38
42
|
variables?: Record<string, unknown> | null | undefined;
|
|
39
43
|
operationName?: string | null | undefined;
|
|
40
44
|
}[];
|
|
41
45
|
}, {
|
|
46
|
+
title?: unknown;
|
|
42
47
|
operations: {
|
|
43
48
|
query: string;
|
|
44
49
|
variables?: Record<string, unknown> | null | undefined;
|
|
@@ -57,6 +62,10 @@ export declare const AssistantGraphQLToolInput: z.ZodObject<{
|
|
|
57
62
|
export declare const queryTool: import("@tanstack/ai").ToolDefinition<{
|
|
58
63
|
type: string;
|
|
59
64
|
properties: {
|
|
65
|
+
title: {
|
|
66
|
+
type: string;
|
|
67
|
+
description: string;
|
|
68
|
+
};
|
|
60
69
|
operations: {
|
|
61
70
|
type: string;
|
|
62
71
|
minItems: number;
|
|
@@ -92,6 +101,10 @@ export declare const queryTool: import("@tanstack/ai").ToolDefinition<{
|
|
|
92
101
|
export declare const applyTool: import("@tanstack/ai").ToolDefinition<{
|
|
93
102
|
type: string;
|
|
94
103
|
properties: {
|
|
104
|
+
title: {
|
|
105
|
+
type: string;
|
|
106
|
+
description: string;
|
|
107
|
+
};
|
|
95
108
|
operations: {
|
|
96
109
|
type: string;
|
|
97
110
|
minItems: number;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
import{toolDefinition as e}from"@tanstack/ai";import{z as t}from"zod";export const AssistantGraphQLToolInput=t.object({operations:t.array(t.object({query:t.string(),variables:t.record(t.unknown()).nullish(),operationName:t.string().nullish()})).min(1)});let o={type:"object",properties:{operations:{type:"array",minItems:1,description:"The operations to run, in order. Each one sees the changes of the ones before it.",items:{type:"object",properties:{query:{type:"string",description:"A GraphQL document with exactly one operation, a query or a mutation."},variables:{type:"object",description:"Values of the variables the document declares. Prefer literals written into the document."},operationName:{type:"string",description:"The name of the operation, when the document names it."}},required:["query"]}}},required:["operations"]};export const queryTool=e({name:"query",description:"Reads the open configuration: runs GraphQL operations and returns their results. Changes nothing; mutations run on a copy discarded after the call. Screenshots the operations take follow the results as images, each after its label.",inputSchema:o});export const applyTool=e({name:"apply",description:"Changes the open configuration: runs GraphQL operations and keeps their changes as one undo step. All or nothing: when any operation fails, nothing changes. `committed` says whether the changes were kept. Screenshots the operations take follow the results as images, each after its label.",inputSchema:o});
|
|
1
|
+
import{toolDefinition as e}from"@tanstack/ai";import{z as t}from"zod";export const AssistantGraphQLToolInput=t.object({title:t.string().nullish().catch(void 0),operations:t.array(t.object({query:t.string(),variables:t.record(t.unknown()).nullish(),operationName:t.string().nullish()})).min(1)});let o={type:"object",properties:{title:{type:"string",description:"A short name of this call for the user, two to five words in their language, saying what it does."},operations:{type:"array",minItems:1,description:"The operations to run, in order. Each one sees the changes of the ones before it.",items:{type:"object",properties:{query:{type:"string",description:"A GraphQL document with exactly one operation, a query or a mutation."},variables:{type:"object",description:"Values of the variables the document declares. Prefer literals written into the document."},operationName:{type:"string",description:"The name of the operation, when the document names it."}},required:["query"]}}},required:["operations"]};export const queryTool=e({name:"query",description:"Reads the open configuration: runs GraphQL operations and returns their results. Changes nothing; mutations run on a copy discarded after the call. `errors` say why an operation failed; `warnings` are what its changes would newly cause, and do not make it fail. Screenshots the operations take follow the results as images, each after its label.",inputSchema:o});export const applyTool=e({name:"apply",description:"Changes the open configuration: runs GraphQL operations and keeps their changes as one undo step. All or nothing: when any operation fails, nothing changes. `committed` says whether the changes were kept. `errors` say why an operation failed; `warnings` are what the changes newly cause, and do not stop them. Screenshots the operations take follow the results as images, each after its label.",inputSchema:o});
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* The URL an image part carries for an image the browser uploaded, a screenshot in an assistant tool
|
|
3
|
+
* result or an image the user attached to their message: `assistant-image:<imageId>`, the id the
|
|
4
|
+
* server's image upload answered with. The thread stores
|
|
5
|
+
* the reference; the server swaps it for the image only in the copy of the thread sent to the model,
|
|
6
|
+
* and the panel fetches the image by its id.
|
|
7
|
+
*/
|
|
8
|
+
export declare const assistantImageReference: (imageId: string) => string;
|
|
9
|
+
/** The image id of an `assistant-image:` reference; `null` for any other URL. */
|
|
10
|
+
export declare const readAssistantImageReference: (url: string) => string | null;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
let e="assistant-image:",t=/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i;export const assistantImageReference=t=>`${e}${t}`;export const readAssistantImageReference=a=>{if(!a.startsWith(e))return null;let s=a.slice(e.length);return t.test(s)?s:null};
|
|
@@ -3,6 +3,7 @@ export { ASSISTANT_AI_PROVIDERS, ASSISTANT_MODEL_TIERS, ASSISTANT_REASONING_LEVE
|
|
|
3
3
|
export { AssistantGraphQLToolInput, applyTool, queryTool } from './graphql-tools.js';
|
|
4
4
|
export type { AssistantGraphQLOperation } from './graphql-tools.js';
|
|
5
5
|
export type { AssistantAiProvider, AssistantModelTier, AssistantReasoningLevel } from './deployment-assistant.js';
|
|
6
|
+
export { assistantImageReference, readAssistantImageReference } from './image-reference.js';
|
|
6
7
|
export { AssistantMessageMetadata } from './message-metadata.js';
|
|
7
8
|
export { ASSISTANT_TOOL_ERROR_CODES, AssistantToolError } from './tool-error.js';
|
|
8
9
|
export type { AssistantToolErrorCode } from './tool-error.js';
|
package/dist/assistant/index.js
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
export{browserDetailsTool}from"./browser-details-tool.js";export{ASSISTANT_AI_PROVIDERS,ASSISTANT_MODEL_TIERS,ASSISTANT_REASONING_LEVELS,AssistantAiSettings,DeploymentAssistant}from"./deployment-assistant.js";export{AssistantGraphQLToolInput,applyTool,queryTool}from"./graphql-tools.js";export{AssistantMessageMetadata}from"./message-metadata.js";export{ASSISTANT_TOOL_ERROR_CODES,AssistantToolError}from"./tool-error.js";
|
|
1
|
+
export{browserDetailsTool}from"./browser-details-tool.js";export{ASSISTANT_AI_PROVIDERS,ASSISTANT_MODEL_TIERS,ASSISTANT_REASONING_LEVELS,AssistantAiSettings,DeploymentAssistant}from"./deployment-assistant.js";export{AssistantGraphQLToolInput,applyTool,queryTool}from"./graphql-tools.js";export{assistantImageReference,readAssistantImageReference}from"./image-reference.js";export{AssistantMessageMetadata}from"./message-metadata.js";export{ASSISTANT_TOOL_ERROR_CODES,AssistantToolError}from"./tool-error.js";
|
|
@@ -2,16 +2,25 @@ import { z } from 'zod';
|
|
|
2
2
|
/**
|
|
3
3
|
* Metadata the assistant chat client attaches to each user message (AG-UI message `metadata`). It is
|
|
4
4
|
* persisted with the message, and the server shows `changes` to the model in front of the message, so
|
|
5
|
-
* the model knows what the user did in the configurator since it last acted.
|
|
5
|
+
* the model knows what the user did in the configurator since it last acted. It also tells the model
|
|
6
|
+
* which language to reply in, on a thread's first user message and wherever `locale` changed.
|
|
6
7
|
*/
|
|
7
8
|
export interface AssistantMessageMetadata {
|
|
8
9
|
/** The change record since the agent's previous action: a marker or a diff, as the assistant prompt describes it. */
|
|
9
10
|
readonly changes: string;
|
|
11
|
+
/**
|
|
12
|
+
* The locale the configurator showed when the user sent the message, as its i18n code (e.g. `de` or
|
|
13
|
+
* `de-AT`). Absent on messages from clients and versions that do not send it.
|
|
14
|
+
*/
|
|
15
|
+
readonly locale?: string;
|
|
10
16
|
}
|
|
11
17
|
export declare const AssistantMessageMetadata: z.ZodObject<{
|
|
12
18
|
changes: z.ZodString;
|
|
19
|
+
locale: z.ZodOptional<z.ZodString>;
|
|
13
20
|
}, "strip", z.ZodTypeAny, {
|
|
14
21
|
changes: string;
|
|
22
|
+
locale?: string | undefined;
|
|
15
23
|
}, {
|
|
16
24
|
changes: string;
|
|
25
|
+
locale?: string | undefined;
|
|
17
26
|
}>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
import{z as t}from"zod";export const AssistantMessageMetadata=t.object({changes:t.string()});
|
|
1
|
+
import{z as t}from"zod";export const AssistantMessageMetadata=t.object({changes:t.string(),locale:t.string().optional()});
|
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
import type { APIGatewayProxyStructuredResultV2 } from 'aws-lambda';
|
|
2
|
+
import type { FetchBackendDataHandlerResponse } from './webhook-api-types.js';
|
|
3
|
+
export declare const createBackendDataResponse: (result: FetchBackendDataHandlerResponse, acceptEncoding: string | undefined) => Promise<APIGatewayProxyStructuredResultV2>;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export const createBackendDataResponse=async(e,t)=>{let n,r,i,s=JSON.stringify(e),o={"content-type":"application/json",vary:"Accept-Encoding"};if(32768>Buffer.byteLength(s,"utf8")||!((i=(r=(n=(t??"").split(",").map(e=>{let[t,...n]=e.trim().toLowerCase().split(";"),r=n.map(e=>e.trim()).find(e=>e.startsWith("q=")),i=void 0===r?"1":r.slice(2).trim();return{encoding:t?.trim(),quality:/^(?:0(?:\.\d{0,3})?|1(?:\.0{0,3})?)$/.test(i)?Number(i):0}})).filter(e=>"gzip"===e.encoding)).length>0?r:n.filter(e=>"*"===e.encoding)).length>0&&i.every(e=>e.quality>0)))return{statusCode:200,headers:o,body:s};let a=await new Response(new Blob([s]).stream().pipeThrough(new CompressionStream("gzip"))).arrayBuffer(),p=Buffer.from(a).toString("base64");return p.length>=Buffer.byteLength(s,"utf8")?{statusCode:200,headers:o,body:s}:{statusCode:200,headers:{...o,"content-encoding":"gzip"},body:p,isBase64Encoded:!0}};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
import{P as o,match as t}from"ts-pattern";import{ApplicationType as r}from"../../domain/index.js";import{validateTaskConfiguration as
|
|
1
|
+
import{P as o,match as t}from"ts-pattern";import{ApplicationType as r}from"../../domain/index.js";import{validateTaskConfiguration as e}from"../tasks/index.js";import{createBackendDataResponse as n}from"./backend-data-response.js";import{AssistantSetupPayload as a,AssistantSetupResponse as i,AuthPayload as s,CallbackPayload as f,FetchBackendDataPayload as c,FinalizeWebhookPayload as u}from"./webhook-api-types.js";let d="assistantSetup",h="auth",p="finalize",l="callback",g="fetchBackendData";export const getAssistantSetupRoute=()=>`?o=${d}`;export const getAuthRoute=()=>`?o=${h}`;export const getFinalizeRoute=o=>`?o=${p}&t=${o}`;export const getCallbackRoute=()=>`?o=${l}`;export const getFetchBackendDataRoute=()=>`?o=${g}`;export const handleWebhookSafely=(o,t)=>async r=>{try{return await o(r)}catch(e){let o=`Webhook failed: ${e instanceof Error?e.message:"Unknown error"}`,r="object"==typeof e&&e instanceof Error?e:Error(o);return t.error(o,{},r),{statusCode:500,body:JSON.stringify({message:o})}}};export const routeWebhookRequests=(w,b)=>handleWebhookSafely(async y=>{if(!y.body)throw Error("No body found in the webhook event!");let k=JSON.parse(y.isBase64Encoded?Buffer.from(y.body,"base64").toString():y.body);return t(y.queryStringParameters?.o).with(d,async()=>{if(!w.configurator?.onAssistantSetup)throw Error("Assistant setup operation is not configured for this webhook!");let o=await w.configurator.onAssistantSetup(a.parse(k),y);return{statusCode:200,body:JSON.stringify(i.parse(o))}}).with(h,async()=>{if(b.info("Handling auth operation."),!w.onAuth)throw Error("Auth operation is not configured for this webhook!");let o=s.parse(k);return{statusCode:200,body:JSON.stringify(await w.onAuth(o,y))}}).with(l,async()=>{if(b.info("Handling configurator callback operation."),!w.configurator?.onCallback)throw Error("Auth operation is not configured for this webhook!");let o=f.parse(k);return{statusCode:200,body:JSON.stringify(await w.configurator.onCallback(o,y))}}).with(o.union(void 0,p),()=>t(y.queryStringParameters?.t).with(r.Admin,async()=>{if(b.info("Handling admin finalize operation."),!w.admin?.onFinalize)throw Error("Admin finalize operation is not configured for this webhook!");let o=u.parse(k),t=await w.admin.onFinalize(o,y);return e(t),{statusCode:200,body:JSON.stringify(t)}}).with(o.union(void 0,r.Configurator),async()=>{if(b.info("Handling configurator finalize operation."),!w.configurator?.onFinalize)throw Error("Configurator finalize operation is not configured for this webhook!");let o=u.parse(k),t=await w.configurator.onFinalize(o,y);return e(t),{statusCode:200,body:JSON.stringify(t)}}).otherwise(o=>{throw Error(`Can not parse application type - unknown type: ${o}!`)})).with(g,async()=>{if(b.info("Handling fetch backend data operation."),!w.configurator?.onFetchBackendData)throw Error("Fetch backend data operation is not configured for this webhook!");let o=c.parse(k);return n(await w.configurator.onFetchBackendData(o,y),Object.entries(y.headers).find(([o])=>"accept-encoding"===o.toLowerCase())?.[1])}).otherwise(o=>{throw Error(`Can not parse webhook operation - unknown operation: ${o}!`)})},b);
|
|
@@ -28,23 +28,29 @@ export declare const TunneledWebhookResponse: z.ZodObject<{
|
|
|
28
28
|
status: z.ZodNumber;
|
|
29
29
|
headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
30
30
|
body: z.ZodString;
|
|
31
|
+
isBase64Encoded: z.ZodOptional<z.ZodBoolean>;
|
|
31
32
|
}, "strip", z.ZodTypeAny, {
|
|
32
33
|
status: number;
|
|
33
34
|
headers?: Record<string, string> | undefined;
|
|
34
35
|
body: string;
|
|
36
|
+
isBase64Encoded?: boolean | undefined;
|
|
35
37
|
}, {
|
|
36
38
|
status: number;
|
|
37
39
|
headers?: Record<string, string> | undefined;
|
|
38
40
|
body: string;
|
|
41
|
+
isBase64Encoded?: boolean | undefined;
|
|
39
42
|
}>;
|
|
40
43
|
export type TunneledWebhookResponse = z.infer<typeof TunneledWebhookResponse>;
|
|
41
44
|
/** Payload used to claim a development deployment and wait for its next webhook request. */
|
|
42
45
|
export declare const WebhookTunnelPollRequest: z.ZodObject<{
|
|
43
46
|
sessionId: z.ZodString;
|
|
47
|
+
acceptResponseEncoding: z.ZodOptional<z.ZodLiteral<"gzip">>;
|
|
44
48
|
}, "strip", z.ZodTypeAny, {
|
|
45
49
|
sessionId: string;
|
|
50
|
+
acceptResponseEncoding?: "gzip" | undefined;
|
|
46
51
|
}, {
|
|
47
52
|
sessionId: string;
|
|
53
|
+
acceptResponseEncoding?: "gzip" | undefined;
|
|
48
54
|
}>;
|
|
49
55
|
export type WebhookTunnelPollRequest = z.infer<typeof WebhookTunnelPollRequest>;
|
|
50
56
|
/** Result of waiting for the next tunneled webhook request. */
|
|
@@ -98,17 +104,20 @@ export declare const WebhookTunnelRespondRequest: z.ZodObject<{
|
|
|
98
104
|
status: z.ZodNumber;
|
|
99
105
|
headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
|
|
100
106
|
body: z.ZodString;
|
|
107
|
+
isBase64Encoded: z.ZodOptional<z.ZodBoolean>;
|
|
101
108
|
}, "strip", z.ZodTypeAny, {
|
|
102
109
|
sessionId: string;
|
|
103
110
|
requestId: string;
|
|
104
111
|
status: number;
|
|
105
112
|
headers?: Record<string, string> | undefined;
|
|
106
113
|
body: string;
|
|
114
|
+
isBase64Encoded?: boolean | undefined;
|
|
107
115
|
}, {
|
|
108
116
|
sessionId: string;
|
|
109
117
|
requestId: string;
|
|
110
118
|
status: number;
|
|
111
119
|
headers?: Record<string, string> | undefined;
|
|
112
120
|
body: string;
|
|
121
|
+
isBase64Encoded?: boolean | undefined;
|
|
113
122
|
}>;
|
|
114
123
|
export type WebhookTunnelRespondRequest = z.infer<typeof WebhookTunnelRespondRequest>;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
import{z as e}from"zod";export const TunneledWebhookRequest=e.object({requestId:e.string(),url:e.string(),method:e.string(),headers:e.record(e.string()),body:e.string().nullable(),deadline:e.number()});export const TunneledWebhookResponse=e.object({status:e.number().int(),headers:e.record(e.string()).optional(),body:e.string()});export const WebhookTunnelPollRequest=e.object({sessionId:e.string()});export const WebhookTunnelPollResponse=e.object({request:TunneledWebhookRequest.nullable()});export const WebhookTunnelRespondRequest=e.object({sessionId:e.string(),requestId:e.string(),status:e.number().int(),headers:e.record(e.string()).optional(),body:e.string()});
|
|
1
|
+
import{z as e}from"zod";export const TunneledWebhookRequest=e.object({requestId:e.string(),url:e.string(),method:e.string(),headers:e.record(e.string()),body:e.string().nullable(),deadline:e.number()});export const TunneledWebhookResponse=e.object({status:e.number().int(),headers:e.record(e.string()).optional(),body:e.string(),isBase64Encoded:e.boolean().optional()});export const WebhookTunnelPollRequest=e.object({sessionId:e.string(),acceptResponseEncoding:e.literal("gzip").optional()});export const WebhookTunnelPollResponse=e.object({request:TunneledWebhookRequest.nullable()});export const WebhookTunnelRespondRequest=e.object({sessionId:e.string(),requestId:e.string(),status:e.number().int(),headers:e.record(e.string()).optional(),body:e.string(),isBase64Encoded:e.boolean().optional()});
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@salsita-ai/contracts",
|
|
3
|
-
"version": "0.50.0-develop.
|
|
3
|
+
"version": "0.50.0-develop.c402728d10",
|
|
4
4
|
"description": "Shared API, authentication, domain, chat, and webhook contracts for Phoenix.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"salsita",
|
|
@@ -54,7 +54,7 @@
|
|
|
54
54
|
"uuid": "14.0.0",
|
|
55
55
|
"valid-url": "1.0.9",
|
|
56
56
|
"zod": "3.25.76",
|
|
57
|
-
"@salsita-ai/common": "0.50.0-develop.
|
|
57
|
+
"@salsita-ai/common": "0.50.0-develop.c402728d10"
|
|
58
58
|
},
|
|
59
59
|
"devDependencies": {
|
|
60
60
|
"@lingui/core": "5.9.5",
|