@squidcloud/client 1.0.492 → 1.0.493

package/dist/internal-common/src/public-types/ai-voice.public-types.d.ts

@@ -0,0 +1,200 @@
+import type { AllAiAgentChatOptions } from './ai-agent.public-types';
+import type { AiAgentId, IntegrationId } from './communication.public-types';
+/**
+ * Providers that put a Squid agent on a phone call. `twilio` relays the call to Squid over a WebSocket
+ * Squid serves; `openai` is an OpenAI Realtime call Squid answers itself, see
+ * {@link AnswerOpenAiVoiceCallRequest}.
+ * @category AI
+ */
+export declare const AI_VOICE_RELAY_PROVIDERS: readonly ["twilio", "openai"];
+/**
+ * A provider of {@link AI_VOICE_RELAY_PROVIDERS}.
+ * @category AI
+ */
+export type AiVoiceRelayProvider = (typeof AI_VOICE_RELAY_PROVIDERS)[number];
+/**
+ * How a call opens. `phrase` speaks the greeting as soon as the call is answered; `agent` has the agent
+ * compose its opening line on a first turn before the caller speaks, so it can look the caller up and greet a
+ * known caller by name, with the greeting as what it says when there is nothing to personalize.
+ * @category AI
+ */
+export declare const AI_VOICE_GREETING_MODES: readonly ["phrase", "agent"];
+/**
+ * A mode of {@link AI_VOICE_GREETING_MODES}.
+ * @category AI
+ */
+export type AiVoiceGreetingMode = (typeof AI_VOICE_GREETING_MODES)[number];
+/**
+ * Request to open a voice session: a phone call the provider relays to a Squid agent in real time.
+ * The response carries the relay URL the provider must connect to.
+ * @category AI
+ */
+export interface CreateAiVoiceSessionRequest {
+    /** The agent that answers the call. */
+    agentId: AiAgentId;
+    /** The telephony provider that relays the call. */
+    provider: AiVoiceRelayProvider;
+    /** The provider's id of the call (a Twilio CallSid), when known before the provider connects. */
+    externalCallId?: string;
+    /** Chat options applied to every turn of the call: instructions, connected integrations, agent context. */
+    chatOptions?: AllAiAgentChatOptions;
+    /** Free-form data echoed on every session event, for the caller's own bookkeeping. */
+    metadata?: Record<string, unknown>;
+    /** `agent` has the agent open the call once the provider connects; otherwise the provider speaks its own greeting. */
+    greetingMode?: AiVoiceGreetingMode;
+    /** What the agent says in `agent` mode when there is nothing to personalize. */
+    greeting?: string;
+    /** How long the relay token stays valid before the provider connects, in seconds. Defaults to 5 minutes. */
+    connectTimeoutSeconds?: number;
+    /** Public base URL of the application when it differs from the default, such as a tunnel in local development. */
+    relayBaseUrl?: string;
+}
+/**
+ * The opened voice session.
+ * @category AI
+ */
+export interface CreateAiVoiceSessionResponse {
+    /** Unique id of the session. */
+    sessionId: string;
+    /** One-time relay token; already embedded in `relayUrl`. */
+    token: string;
+    /** Absolute `wss://` URL the telephony provider connects to for this call. */
+    relayUrl: string;
+}
+/**
+ * Request to answer a phone call that reached an OpenAI project's SIP endpoint. Squid accepts the call with
+ * the given instructions, and for the call's life runs the agent whenever the realtime model asks it
+ * something and hangs up when the model ends the call. Requires the application API key.
+ * @category AI
+ */
+export interface AnswerOpenAiVoiceCallRequest {
+    /** The agent the realtime model asks for knowledge and actions. */
+    agentId: AiAgentId;
+    /** The call id from OpenAI's `realtime.call.incoming` webhook. */
+    callId: string;
+    /** The `openai_voice` integration whose API key answers the call. */
+    integrationId: IntegrationId;
+    /** Realtime model that talks on the call; defaults to the integration's default model. */
+    model?: string;
+    /** Voice of the realtime model; defaults to the integration's default voice. */
+    voice?: string;
+    /** Instructions of the realtime model. */
+    instructions: string;
+    /** Spoken as soon as the call is answered; without it the model waits for the caller to speak first. */
+    greeting?: string;
+    /** `agent` has the agent compose the opening line, with `greeting` as its fallback; `phrase` (the default) speaks `greeting` as is. */
+    greetingMode?: AiVoiceGreetingMode;
+    /** The telephony provider's id of the call (a Twilio CallSid), echoed on every session event. */
+    externalCallId?: string;
+    /** Chat options applied to every turn the agent runs for the call: instructions, agent context. */
+    chatOptions?: AllAiAgentChatOptions;
+    /** Free-form data echoed on every session event, for the caller's own bookkeeping. */
+    metadata?: Record<string, unknown>;
+}
+/**
+ * The answered OpenAI call.
+ * @category AI
+ */
+export interface AnswerOpenAiVoiceCallResponse {
+    /** Unique id of the voice session that runs the call. */
+    sessionId: string;
+}
+/**
+ * How a voice call handles languages: `single` keeps the whole call in its language, `selected` lets the
+ * caller switch between it and the chosen ones, `any` follows the caller into any language.
+ * @category AI
+ */
+export type AiVoiceLanguageMode = 'single' | 'selected' | 'any';
+/**
+ * Request to start a voice call with an agent from a browser. The browser produces a WebRTC offer, Squid
+ * creates the call on the OpenAI Realtime API and returns the answer; from then on the browser talks to
+ * OpenAI directly while Squid runs the agent behind the call. Every setting defaults to what the agent's
+ * phone line uses (its Twilio ability with the OpenAI engine), then to the application's OpenAI Voice
+ * integration. Open to application users under the agent's security rules, and to the API key.
+ * @category AI
+ */
+export interface StartOpenAiWebVoiceCallRequest {
+    /** The agent the realtime model asks for knowledge and actions. */
+    agentId: AiAgentId;
+    /** The browser's WebRTC offer, as SDP. */
+    sdp: string;
+    /** The `openai_voice` integration to use; needed only when the agent has no phone line and the app has several. */
+    integrationId?: IntegrationId;
+    /** Realtime model that talks on the call. */
+    model?: string;
+    /** Voice of the realtime model. */
+    voice?: string;
+    /** Language the call starts in, as an ISO code or BCP-47 tag. */
+    language?: string;
+    /** Whether the caller may switch language mid-call. */
+    languageMode?: AiVoiceLanguageMode;
+    /** The languages the caller may switch to in `selected` mode. */
+    additionalLanguages?: Array<string>;
+    /** Spoken as soon as the call starts; without any greeting the model waits for the caller. */
+    greeting?: string;
+    /** `agent` has the agent compose the opening line, with `greeting` as its fallback; defaults to the phone line's mode. */
+    greetingMode?: AiVoiceGreetingMode;
+    /** What this call is for, added to the realtime model's instructions. */
+    instructions?: string;
+    /** Chat options applied to every turn the agent runs for the call: instructions, agent context. */
+    chatOptions?: AllAiAgentChatOptions;
+    /** Free-form data echoed on every session event, for the caller's own bookkeeping. */
+    metadata?: Record<string, unknown>;
+}
+/**
+ * The started browser call.
+ * @category AI
+ */
+export interface StartOpenAiWebVoiceCallResponse {
+    /** Unique id of the voice session that runs the call. */
+    sessionId: string;
+    /** Id of the call at OpenAI. */
+    callId: string;
+    /** OpenAI's WebRTC answer, as SDP, for the browser's remote description. */
+    sdp: string;
+}
+/**
+ * Event type emitted on the application event bus for every voice session milestone. Subscribe with
+ * `@eventHandler(AI_VOICE_SESSION_EVENT_TYPE)`; the payload is an {@link AiVoiceSessionEvent}.
+ * @category AI
+ */
+export declare const AI_VOICE_SESSION_EVENT_TYPE = "ai-voice-session-event";
+/**
+ * Milestones of a voice session.
+ * @category AI
+ */
+export type AiVoiceSessionEventKind = 'started' | 'turn' | 'ended';
+/**
+ * One spoken turn of a voice session.
+ * @category AI
+ */
+export interface AiVoiceSessionTurn {
+    /** Who spoke. */
+    role: 'user' | 'agent';
+    /** What was said, as transcribed (user) or generated (agent). */
+    text: string;
+    /** When the turn completed, as an ISO timestamp. */
+    at: string;
+}
+/**
+ * Payload of an {@link AI_VOICE_SESSION_EVENT_TYPE} event.
+ * @category AI
+ */
+export interface AiVoiceSessionEvent {
+    /** Which milestone this event reports. */
+    kind: AiVoiceSessionEventKind;
+    /** The session the event belongs to. */
+    sessionId: string;
+    /** The provider of the call. */
+    provider: AiVoiceRelayProvider;
+    /** The agent answering the call. */
+    agentId: AiAgentId;
+    /** The provider's id of the call, when known. */
+    externalCallId?: string;
+    /** The metadata given when the session was created. */
+    metadata?: Record<string, unknown>;
+    /** The completed turn; set only for `turn` events. */
+    turn?: AiVoiceSessionTurn;
+    /** Why the session ended; set only for `ended` events. */
+    endReason?: string;
+}

package/dist/internal-common/src/public-types/connector.public-types.d.ts

@@ -4,7 +4,7 @@
  * 'CONNECTOR_PACKAGES_TO_EXCLUDE_FROM_AUTO_SYNC' in ConnectorsService (console-backend).
  * @category Platform
  */
-export declare const CONNECTOR_IDS: readonly ["bitbucket", "confluence", "cotomi", "essentials", "freshdesk", "generic_site_ingester", "github", "google_calendar", "google_drive", "hubspot", "sharepoint", "jira", "jira_jsm", "linear", "mail", "onedrive", "outlook", "salesforce", "servicenow_csm", "slack", "teams", "ticketmind_companion", "zendesk"];
+export declare const CONNECTOR_IDS: readonly ["bitbucket", "confluence", "connect_companion", "cotomi", "elevenlabs", "openai_voice", "essentials", "freshdesk", "generic_site_ingester", "github", "google_calendar", "google_drive", "hubspot", "sharepoint", "jira", "jira_jsm", "linear", "mail", "onedrive", "outlook", "salesforce", "servicenow_csm", "slack", "teams", "ticketmind_companion", "twilio", "zendesk"];
 /**
  * Unique connector package name.
  * @category Platform

package/dist/internal-common/src/public-types/integration.public-types.d.ts

@@ -1,6 +1,6 @@
 import { IntegrationId } from './communication.public-types';
 /** List of all integration types supported by Squid. */
-export declare const INTEGRATION_TYPES: readonly ["active_directory", "ai_agents", "ai_chatbot", "algolia", "alloydb", "api", "auth0", "bedrock", "azure_blob", "azure_cosmosdb", "azure_postgresql", "azure_sql", "bigquery", "bitbucket", "built_in_azure_blob", "built_in_db", "built_in_gcs", "built_in_queue", "built_in_s3", "cassandra", "clickhouse", "cloudsql", "cockroach", "cognito", "connected_knowledgebases", "confluence", "confluent", "datadog", "db2", "descope", "documentdb", "azure-entra-external-id", "azure-entra-id", "dynamodb", "elasticsearch", "firebase_auth", "firestore", "gcs", "generic_site_ingester", "github", "google_calendar", "google_docs", "google_drive", "graphql", "hubspot", "jira", "jira_jsm", "jwt_hmac", "jwt_rsa", "kafka", "keycloak", "linear", "mariadb", "monday", "mongo", "mssql", "databricks", "mysql", "newrelic", "okta", "onedrive", "outlook", "oracledb", "pinecone", "postgres", "redis", "s3", "salesforce", "sap_hana", "sentry", "snowflake", "spanner", "xata", "zendesk", "servicenow_csm", "freshdesk", "mail", "slack", "mcp", "a2a", "legend", "teams", "openai_compatible", "openai_compatible_embedding", "sharepoint", "vertex"];
+export declare const INTEGRATION_TYPES: readonly ["active_directory", "ai_agents", "ai_chatbot", "algolia", "alloydb", "api", "auth0", "bedrock", "azure_blob", "azure_cosmosdb", "azure_postgresql", "azure_sql", "bigquery", "bitbucket", "built_in_azure_blob", "built_in_db", "built_in_gcs", "built_in_queue", "built_in_s3", "cassandra", "clickhouse", "cloudsql", "cockroach", "cognito", "connected_knowledgebases", "confluence", "confluent", "datadog", "db2", "descope", "documentdb", "azure-entra-external-id", "azure-entra-id", "dynamodb", "elasticsearch", "firebase_auth", "firestore", "gcs", "generic_site_ingester", "github", "google_calendar", "google_docs", "google_drive", "graphql", "hubspot", "jira", "jira_jsm", "jwt_hmac", "jwt_rsa", "kafka", "keycloak", "linear", "mariadb", "monday", "mongo", "mssql", "databricks", "mysql", "newrelic", "okta", "onedrive", "outlook", "oracledb", "pinecone", "postgres", "redis", "s3", "salesforce", "sap_hana", "sentry", "snowflake", "spanner", "xata", "zendesk", "servicenow_csm", "freshdesk", "mail", "slack", "twilio", "elevenlabs", "openai_voice", "mcp", "a2a", "legend", "teams", "openai_compatible", "openai_compatible_embedding", "sharepoint", "vertex"];
 /**
  * @category Database
  */

package/dist/internal-common/src/public-types-backend/api-call.public-context.d.ts

@@ -0,0 +1,30 @@
+import { ApiOptions } from '../public-types/api-client.public-types';
+import { ApiEndpointId, HttpMethod } from '../public-types/api.public-types';
+import { IntegrationId } from '../public-types/communication.public-types';
+/** The headers of an API call. */
+export type ApiHeaders = Record<string, string | number | boolean>;
+/** The context of an API call. */
+export declare class ApiCallContext {
+    readonly integrationId: IntegrationId;
+    readonly endpointId: ApiEndpointId;
+    readonly url: string;
+    readonly method: HttpMethod;
+    readonly body: unknown;
+    readonly options: ApiOptions;
+}
+/**
+ * Represents a request to call an API through a specified integration and endpoint.
+ * Includes optional method override and additional request options.
+ */
+export interface CallApiRequest<BodyType = any> {
+    /** The identifier of the integration through which the API is called. */
+    integrationId: IntegrationId;
+    /** Target API endpoint to invoke. */
+    endpointId: ApiEndpointId;
+    /** Optional request payload. */
+    body?: BodyType;
+    /** Optional HTTP method override. Default is POST. */
+    overrideMethod?: HttpMethod;
+    /** Additional request options. */
+    options: ApiOptions;
+}

package/dist/internal-common/src/public-types-backend/mutation.public-context.d.ts

@@ -0,0 +1,161 @@
+import { SquidDocIdObj, SquidDocument } from '../public-types/document.public-types';
+import { Paths } from '../public-types/typescript.public-types';
+/**
+ * The mutation type.
+ * @category Database
+ */
+export declare const MUTATION_TYPES: readonly ["insert", "update", "delete"];
+/**
+ * @category Database
+ */
+export type MutationType = (typeof MUTATION_TYPES)[number];
+/**
+ * Base fields shared by all document mutations.
+ * @category Database
+ */
+export interface BaseMutation {
+    /** The type of the mutation. */
+    type: MutationType;
+    /** The identity of the mutated document. */
+    squidDocIdObj: SquidDocIdObj;
+}
+/**
+ * A mutation on a document.
+ * @category Database
+ */
+export type Mutation<T = any> = UpdateMutation<T> | InsertMutation<T> | DeleteMutation;
+/**
+ * Represents a delete mutation on a document.
+ * @category Database
+ */
+export interface DeleteMutation extends BaseMutation {
+    /** Specifies that the mutation is a deletion. */
+    type: 'delete';
+}
+/**
+ * Represents an update mutation on a document.
+ * @category Database
+ */
+export interface UpdateMutation<T = any> extends BaseMutation {
+    /** Specifies that the mutation is an update. */
+    type: 'update';
+    /** The updated properties */
+    properties: {
+        [key in keyof T & string]?: Array<PropertyMutation<T[key]>>;
+    };
+}
+/**
+ * Represents an insert mutation on a document.
+ * @category Database
+ */
+export interface InsertMutation<T = any> extends BaseMutation {
+    /** Specifies that the mutation is an insertion. */
+    type: 'insert';
+    /** The inserted document */
+    properties: T;
+}
+/**
+ * A representation of a single property update.
+ * @category Database
+ */
+export type PropertyMutation<Value = any> = ApplyNumericFnPropertyMutation | ApplyStringFnPropertyMutation | ValueUpdatePropertyMutation<Value> | RemovePropertyMutation;
+/**
+ * A value update property mutation.
+ * @category Database
+ */
+export interface ValueUpdatePropertyMutation<Value = any> {
+    /** Specifies that the mutation updates a value. */
+    type: 'update';
+    /** New value to be set. */
+    value: Value;
+}
+/**
+ * Applying a numeric function to a property.
+ * @category Database
+ */
+export interface ApplyNumericFnPropertyMutation {
+    /** Specifies that the mutation applies a numeric function. */
+    type: 'applyNumericFn';
+    /** Numeric function to apply. */
+    fn: 'increment';
+    /** Value to use in the numeric function. */
+    value: number;
+}
+/**
+ * A property update that removes a property from a document.
+ * @category Database
+ */
+export interface RemovePropertyMutation {
+    /** Specifies that the mutation removes a property. */
+    type: 'removeProperty';
+}
+/**
+ * A property mutation that appends a value to the existing string.
+ * @category Database
+ */
+export interface ApplyExtendString {
+    /** Specifies that the mutation applies a string function. */
+    type: 'applyStringFn';
+    /** String function to extend the existing string. */
+    fn: 'extendString';
+    /** String value to append. */
+    value: string;
+}
+/**
+ * A property mutation that trims the existing string.
+ * @category Database
+ */
+export interface ApplyTrimString {
+    /** Specifies that the mutation applies a string function. */
+    type: 'applyStringFn';
+    /** String function to trim the existing string. */
+    fn: 'trim';
+}
+/**
+ * A property mutation that modifies a string.
+ * @category Database
+ */
+export type ApplyStringFnPropertyMutation = ApplyExtendString | ApplyTrimString;
+/**
+ * The before and after documents of a document change.
+ * @category Database
+ */
+export interface BeforeAndAfterDocs<T = SquidDocument> {
+    /** Document state before the mutation. */
+    before: T | undefined;
+    /** Document state after the mutation. */
+    after: T | undefined;
+}
+/**
+ * The mutation context that will be provided to the security function.
+ * @category Database
+ */
+export declare class MutationContext<T = any> {
+    readonly mutation: Mutation<T>;
+    readonly beforeAndAfterDocs: BeforeAndAfterDocs<T>;
+    readonly serverTimeStamp: Date;
+    /**
+     * Returns the state of the document before the mutation was applied.
+     */
+    get before(): T | undefined;
+    /**
+     * Returns the state of the document after the mutation was applied.
+     */
+    get after(): T | undefined;
+    /**
+     * Returns the type of the mutation (insert, update, or delete).
+     */
+    getMutationType(): MutationType;
+    /** Returns true if the mutation affects the provided path. */
+    affectsPath(path: Paths<T>): boolean;
+    /**
+     * Find all affected paths starting from a root path.
+     *
+     * @example
+     * doc before - { a: { b: 1, c: 2 }, d: 3 }
+     * doc after - { a: { b: 1, c: 3 }, d: 4 }
+     * doc.affectedPaths('a') // ['a.c']
+     */
+    affectedPaths(startingRoot?: Paths<T> | string): Array<Paths<T>>;
+    private checkPath;
+}

package/dist/internal-common/src/public-types-backend/native-query.public-context.d.ts

@@ -0,0 +1,75 @@
+import { IntegrationId } from '../public-types/communication.public-types';
+/**
+ * Represents the type of native query request, either relational, elastic or MongoDB.
+ * @category Database
+ */
+export type NativeQueryRequestType = 'relational' | 'mongo' | 'elasticsearch' | 'pure';
+/**
+ * Base fields shared by all native query contexts.
+ * @category Database
+ */
+export interface BaseNativeQueryContext {
+    /** Type of the native query request. */
+    type: NativeQueryRequestType;
+    /** Identifier for the integration. */
+    integrationId: IntegrationId;
+}
+/**
+ * Context for executing a relational database query.
+ * @category Database
+ */
+export interface RelationalNativeQueryContext extends BaseNativeQueryContext {
+    /** Specifies that the query is for a relational database. */
+    type: 'relational';
+    /** SQL query string to be executed. */
+    query: string;
+    /** Parameters to be used in the query. */
+    params: Record<string, any>;
+}
+/**
+ * Context for executing a MongoDB query.
+ * @category Database
+ */
+export interface MongoNativeQueryContext extends BaseNativeQueryContext {
+    /** Specifies that the query is for a Mongo database. */
+    type: 'mongo';
+    /** Name of the MongoDB collection to query. */
+    collectionName: string;
+    /** Array of aggregation pipeline stages. */
+    aggregationPipeline: Array<any | undefined>;
+}
+/**
+ * Context for executing an Elasticsearch query.
+ * @category Database
+ */
+export interface ElasticsearchNativeQueryContext {
+    /** Specifies that the query is for an Elasticsearch database. */
+    type: 'elasticsearch';
+    /** Elasticsearch index to query. */
+    index: string;
+    /** Elasticsearch query string. */
+    endpoint?: string;
+    /** HTTP method to use for the request. */
+    method?: 'GET' | 'POST';
+    /** Body of the request. */
+    body: Record<string, any>;
+    /** Headers to include in the request. */
+    integrationId: IntegrationId;
+}
+/**
+ * Context for executing a pure database query.
+ * @category Database
+ */
+export interface PureNativeQueryContext extends BaseNativeQueryContext {
+    /** Specifies that the query is for a relational database. */
+    type: 'pure';
+    /** SQL query string to be executed. */
+    query: string;
+    /** Parameters to be used in the query. */
+    params: Record<string, any>;
+}
+/**
+ * Union type representing either a relational or MongoDB native query context.
+ * @category Database
+ */
+export type NativeQueryContext = RelationalNativeQueryContext | MongoNativeQueryContext | ElasticsearchNativeQueryContext | PureNativeQueryContext;