@squidcloud/client 1.0.423 → 1.0.425

package/dist/internal-common/src/types/observability.types.d.ts

@@ -0,0 +1,101 @@
+import { MetricName } from '../metric-name';
+import { AppId } from '../public-types/communication.public-types';
+export interface ObservableNameMetrics {
+    count: MetricName;
+    time: MetricName;
+}
+export declare const ObservableNames: {
+    readonly functionExecution: ObservableNameMetrics;
+    readonly codeInitialization: ObservableNameMetrics;
+    readonly getAiChatbotProfiles: ObservableNameMetrics;
+    readonly aiImageGeneration: ObservableNameMetrics;
+    readonly aiRemoveBackground: ObservableNameMetrics;
+    readonly aiAudioTranscribe: ObservableNameMetrics;
+    readonly aiAudioCreateSpeech: ObservableNameMetrics;
+    readonly discoverGraphQLConnectionSchema: ObservableNameMetrics;
+    readonly discoverOpenApiSchema: ObservableNameMetrics;
+    readonly discoverOpenApiSchemaFromFile: ObservableNameMetrics;
+    readonly graphqlQuery: ObservableNameMetrics;
+    readonly testGraphQLConnection: ObservableNameMetrics;
+    readonly testAgentProtocolConnection: ObservableNameMetrics;
+    readonly graphql: ObservableNameMetrics;
+};
+export type ObservableName = keyof typeof ObservableNames;
+export interface MetricEvent {
+    appId: AppId;
+    name: MetricName;
+    tags: Record<string, string>;
+    timestamp: Date;
+    value: number;
+    isExposedToUser: boolean;
+}
+export interface LogEvent {
+    message: string;
+    level: string;
+    tags: Record<string, string>;
+    timestamp: Date;
+    isExposedToUser: boolean;
+    host: string;
+    source?: string;
+    service?: string;
+}
+export declare const AUDIT_LOG_EVENT_NAMES: readonly ["ai_agent"];
+export type AuditLogEventName = (typeof AUDIT_LOG_EVENT_NAMES)[number];
+export interface AuditLogEvent {
+    appId: AppId;
+    name: AuditLogEventName;
+    timestamp: Date;
+    context: {
+        clientId?: string;
+        userId: string;
+    };
+    tags: Record<string, string>;
+}
+/** Agent audit log entry - one per agent invocation */
+export interface AgentAuditLogEvent {
+    appId: AppId;
+    agentId: string;
+    jobId: string;
+    prompt: string;
+    tags: Record<string, string>;
+    createdAt: Date;
+}
+export type AgentAuditLogUpdateType = 'statusUpdate' | 'response';
+/** Agent audit log update entry - status updates and responses for agent invocations */
+export interface AgentAuditLogUpdateEvent {
+    appId: AppId;
+    agentId: string;
+    jobId: string;
+    statusUpdateId: string;
+    title: string;
+    parentStatusUpdateId?: string;
+    tags: Record<string, string>;
+    body: string;
+    type: AgentAuditLogUpdateType;
+    createdAt: Date;
+}
+/** Tag for metric events. Value: '0' - not an error, '1' - is an error. */
+export declare const O11Y_TAG_IS_ERROR = "isError";
+/** Tag for log events. Metrics have an explicit appId field. */
+export declare const O11Y_TAG_APP_ID = "appId";
+/** Tag for metric and log events. */
+export declare const O11Y_TAG_INTEGRATION_ID = "integrationId";
+/** Tag for AI events. */
+export declare const O11Y_TAG_AI_MODEL = "aiModel";
+export declare const O11Y_TAG_AI_PROFILE = "aiProfile";
+/** Tag for AI KnowledgeBase events */
+export declare const O11Y_TAG_AI_KNOWLEDGE_BASE_MODEL = "aiKnowledgeBaseModel";
+export declare const O11Y_TAG_API_KEY_SOURCE = "apiKeySource";
+/** Tag for metric and log events. Value: '0' - not a tenant originated, '1' - is a tenant originated. */
+export declare const O11Y_TAG_IS_TENANT_ORIGINATED = "isTenantOriginated";
+/** Contains a full (with a service name) function name for backend functions. */
+export declare const O11Y_TAG_FUNCTION_NAME = "functionName";
+/** Contains a type of the function name for backend functions (See ExecuteFunctionAnnotationType.). */
+export declare const O11Y_TAG_FUNCTION_TYPE = "functionType";
+/** Tag for the trace ID. Used in logs. */
+export declare const O11Y_TAG_TRACE_ID = "trace_id";
+/** Tag for the span ID. Used in logs. */
+export declare const O11Y_TAG_SPAN_ID = "span_id";
+export declare function getBooleanMetricTagValue(value: boolean): string;
+export declare const COUNT_METRIC_SUFFIXES: string[];
+export declare const GAUGE_METRIC_SUFFIXES: string[];

package/dist/internal-common/src/types/query.types.d.ts

@@ -0,0 +1,13 @@
+import { Condition, SimpleCondition } from '../public-types/query.public-types';
+/**
+ * Generates the regex pattern, handling special characters as follows:
+ *  - `_` is replaced with a `.`
+ *  - `%` is replaced with `[\s\S]*`.
+ *  - The above characters can be escaped with \, eg. `\_` is replaced with `_` and `\%` with `%`.
+ *  - All special characters in regex (-, /, \, ^, $, *, +, ?, ., (, ), |, [, ], {, }) get escaped with \
+ *
+ *  Exported for testing purposes.
+ * */
+export declare function replaceSpecialCharacters(input: string): string;
+/** Returns true if the condition is a 'SimpleCondition' or false otherwise. */
+export declare function isSimpleCondition(condition: Condition): condition is SimpleCondition;

package/dist/internal-common/src/types/secret.types.d.ts

@@ -0,0 +1,7 @@
+import { ApiKeyEntry } from '../public-types/secret.public-types';
+export declare const BACKEND_API_KEY = "_BACKEND_API_KEY";
+export declare const APP_API_KEY = "APP_API_KEY";
+export declare const AGENT_API_HEADER = "x-squid-agent-api-key";
+export interface AgentSecrets {
+    apiKey: ApiKeyEntry | undefined;
+}

package/dist/internal-common/src/types/socket.types.d.ts

@@ -0,0 +1 @@
+export declare const SOCKET_RECONNECT_TIMEOUT: number;

package/dist/internal-common/src/types/stage.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Stage of the Squid deployment:
+ * - 'local' - Squid is run locally.
+ * - 'prod' - Production environment (https://console.getsquid.ai).
+ * - 'sandbox' - One of the sandbox environments  (https://console.sandbox.squid.cloud).
+ * - 'staging' - One of the staging environments  (https://console.staging.squid.cloud).
+ */
+export declare const STAGES: readonly ["local", "prod", "sandbox", "staging"];
+export type Stage = (typeof STAGES)[number];

package/dist/internal-common/src/types/time-units.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/internal-common/src/types/url-shortener.types.d.ts

@@ -0,0 +1,45 @@
+import { AppId } from '../public-types/communication.public-types';
+/**
+ * Request to create a shortened URL.
+ */
+export interface ShortUrlRequest {
+    /** The URL to shorten. It must be a valid URL and should include the protocol (start with http:// or https://). */
+    url: string;
+    /** The application ID that will own this shortened URL. */
+    appId: AppId;
+    /** Seconds to live for the shortened URL. If set to 0, the URL will never expire. Defaults to 1 day. */
+    secondsToLive?: number;
+    /** Optional file extension to include in the shortened URL ID (e.g., 'pdf', 'html'). The extension becomes part of the ID, so 'abc123.pdf' and 'abc123.jpg' are distinct URLs. */
+    fileExtension?: string;
+}
+/**
+ * Request to create shortened URLs.
+ */
+export interface ShortUrlBulkRequest {
+    /** The URLs to shorten. They must be valid URLs and should include the protocol (start with http:// or https://). */
+    urls: string[];
+    /** The application ID that will own these shortened URLs. */
+    appId: AppId;
+    /** Seconds to live for all shortened URLs. If set to 0, the URLs will never expire. Defaults to 1 day. */
+    secondsToLive?: number;
+    /** Optional file extension to include in all shortened URL IDs (e.g., 'pdf', 'html'). The extension becomes part of each ID, so 'abc123.pdf' and 'abc123.jpg' are distinct URLs. */
+    fileExtension?: string;
+}
+/**
+ * Request to delete a shortened URL.
+ */
+export interface ShortUrlDeleteRequest {
+    /** The ID of the shortened URL to delete. */
+    id: string;
+    /** The application ID that owns the shortened URL. */
+    appId: AppId;
+}
+/**
+ * Request to delete a shortened URL.
+ */
+export interface ShortUrlBulkDeleteRequest {
+    /** The IDs of the shortened URLs to delete. */
+    ids: string[];
+    /** The application ID that owns the shortened URLs. */
+    appId: AppId;
+}

package/dist/internal-common/src/utils/array.d.ts

@@ -0,0 +1,7 @@
+export declare function truncateOrPadArray(arr: number[], length: number): number[];
+/**
+ * Computes a single “recommended” chunk size so that if you loop
+ * `for (let i = 0; i < length; i += chunkSize)`,
+ * no slice will exceed `maxChunkSize` and all chunk sizes are 'almost' equal.
+ */
+export declare function computeRecommendedChunkSize(length: number, maxChunkSize: number): number;

package/dist/internal-common/src/utils/e2e-test-utils.d.ts

@@ -0,0 +1,2 @@
+/** Returns true if the application is run by a Playwright test. */
+export declare function isPlaywrightTestMode(): boolean | undefined;

package/dist/internal-common/src/utils/file-utils.d.ts

@@ -0,0 +1,2 @@
+/** Gets file extension from filename. */
+export declare function getFileExtension(filename: string): string | undefined;

package/dist/internal-common/src/utils/global.utils.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/internal-common/src/utils/http.d.ts

@@ -0,0 +1,5 @@
+import { AppId } from '../public-types/communication.public-types';
+import { Stage } from '../types/stage';
+export declare const KOTLIN_CONTROLLERS: string[];
+export declare function getEnvironmentPrefix(shard: string | undefined, region: string, cloudId: string, stage: Stage): string;
+export declare function getApplicationUrl(environmentPrefix: string, appId: string, path: string, appIdPlaceholder?: AppId, environmentPrefixPlaceholder?: string, forceKotlin?: boolean): string;

package/dist/internal-common/src/utils/lock.manager.d.ts

@@ -0,0 +1,14 @@
+type LockMutex = string;
+/**
+ * A simple lock manager that locks a list of mutexes.
+ * When locking a list of mutexes, the lock will start only when all the mutexes are available - preventing partial lock
+ * and potential deadlocks.
+ */
+export declare class LockManager {
+    private readonly locks;
+    lock(...mutexes: LockMutex[]): Promise<void>;
+    release(...mutexes: LockMutex[]): void;
+    canGetLock(...mutexes: LockMutex[]): boolean;
+    lockSync(...mutexes: LockMutex[]): void;
+}
+export {};

package/dist/internal-common/src/utils/metric-utils.d.ts

@@ -0,0 +1,4 @@
+import { QueryMetricsRequestCommon, QueryMetricsResultGroup } from '../public-types/metric.public-types';
+export type QueryMetricsRequestIntervals = Required<Pick<QueryMetricsRequestCommon, 'fillValue' | 'fn' | 'groupByTags' | 'periodEndSeconds' | 'periodStartSeconds' | 'pointIntervalAlignment' | 'pointIntervalSeconds' | 'tagDomains' | 'noDataBehavior'>>;
+/** Adds missed known tag domain groups and fills all missed points with a request.fillValue. */
+export declare function fillMissedPoints(request: QueryMetricsRequestIntervals, resultGroups: Array<QueryMetricsResultGroup>): void;

package/dist/internal-common/src/utils/metrics.types.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Type suffixes defines the type of the metric and can be used for
+ * metric value validation for incoming metrics.
+ */
+export declare const SQUID_METRIC_TYPE_SUFFIXES: readonly ["_count", "_time", "_size", "_entries", "_value"];
+/** Returns true if the given metric has a valid metric type. */
+export declare function hasValidMetricTypeSuffix(metricName: string): boolean;

package/dist/internal-common/src/utils/object.d.ts

@@ -0,0 +1,86 @@
+/** Returns a value by the `path`. Works with array indexes, like a.b[0]. */
+export declare function getInPath(obj: unknown, path: string): any;
+export declare function isDateObject(value: unknown): value is Date;
+/** Sets a value by path . Does not support array indexes. */
+export declare function setInPath(obj: object, path: string, value: unknown, delimiter?: string): void;
+export declare function deleteInPath(obj: object, path: string, delimiter?: string): void;
+export declare function replaceKeyInMap<K, T>(map: Map<K, T | undefined>, a: K, b: K): void;
+export declare function replaceKeyInRecord<K extends keyof any, T>(record: Record<K, T>, a: K, b: K): void;
+export declare function isNil(obj: unknown): obj is null | undefined;
+export declare function isEqual(a: unknown, b: unknown): boolean;
+export declare function isEmpty(a: unknown): boolean;
+export declare function omit<T extends object, K extends PropertyKey[]>(object: T | null | undefined, ...fieldsToRemove: K): Pick<T, Exclude<keyof T, K[number]>>;
+export type CloneCustomizer = (value: unknown) => unknown | undefined;
+/**
+ * Creates a deep copy of the specified object, including all nested objects and specifically handling Date, Map, and
+ * Set fields.
+ *
+ * The customizer function can modify the cloning process for the object and its fields. If the customizer
+ * returns 'undefined' for any input, the function falls back to the standard cloning logic.
+ *
+ * The cloning process is recursive, ensuring deep cloning of all objects.
+ *
+ * Note: This function does not support cloning objects with circular dependencies and will throw a system stack
+ * overflow error if encountered.
+ */
+export declare function cloneDeep<R = unknown>(value: R, customizer?: CloneCustomizer): R;
+/** Creates a shallow clone of the object. */
+export declare function cloneShallow<T>(value: T): T;
+export declare function deepMerge<T extends object, U extends object>(target: T, source: U): T & U;
+/** Returns true if the `value` is a defined object and is not an array. */
+export declare function isPlainObject(value: unknown): value is object;
+/** Compares 2 values. 'null' and 'undefined' values are considered equal and are less than any other values. */
+export declare function compareValues(v1: unknown, v2: unknown): number;
+/** Returns a new object with all top-level object fields re-mapped using `valueMapperFn`. */
+export declare function mapValues<ResultType extends object = Record<string, unknown>, InputType extends Record<string, unknown> = Record<string, unknown>>(obj: InputType, valueMapperFn: (value: any, key: keyof InputType, obj: InputType) => unknown): ResultType;
+/** Groups elements of the array by key. See _.groupBy for details. */
+export declare function groupBy<T, K extends PropertyKey>(array: T[], getKey: (item: T) => K): Record<K, T[]>;
+/**
+ * Picks selected fields from the object and returns a new object with the fields selected.
+ * The selected fields are assigned by reference (there is no cloning).
+ */
+export declare function pick<T extends object, K extends keyof T>(obj: T, keys: ReadonlyArray<K>): Pick<T, K>;
+/** Inverts the record: swaps keys and values. */
+export declare function invert<K extends string | number, V extends string | number>(record: Record<K, V>): Record<V, K>;
+/**
+ * Creates an array of numbers (positive and/or negative) progressing from start up to, but not including, end.
+ * If end is less than start a zero-length range is created unless a negative step is specified.
+ *
+ * Same as lodash range but with an additional parameter: `maximumNumberOfItems`.
+ */
+export declare function range(start: number, end: number, step: number, maximumNumberOfItems?: number): number[];
+/** Returns count of top level properties in object. */
+export declare function countObjectKeys(obj: object | undefined): number;
+/** Returns object entries sorted by name. */
+export declare function getSortedEntries<T>(record: Record<string, T>): Array<[string, T]>;
+/** Removes top level fields which are empty objects. May be used for value formatting. */
+export declare function removeEmptyTopLevelRecords<T extends object>(record: T): Partial<T>;
+export declare function removeUndefinedValues<V>(tags: Record<string, V | undefined>): Record<string, V>;
+export declare function extractKey(line: string | undefined): string | null;
+/** Represents a line in a diff output */
+export interface DiffLine {
+    lineNumber: number;
+    text: string;
+    type: 'unchanged' | 'added' | 'removed' | 'changed';
+}
+/** Result of computing a line-by-line diff between two objects */
+export interface DiffResult {
+    leftLines: Array<DiffLine>;
+    rightLines: Array<DiffLine>;
+    hasChanges: boolean;
+}
+/**
+ * Computes a line-by-line diff between two objects.
+ * Objects are serialized to JSON with sorted keys for consistent comparison.
+ * @param before The previous/left object (can be undefined for new objects)
+ * @param after The current/right object
+ * @returns DiffResult with left and right lines and whether there are changes
+ */
+export declare function computeObjectDiff(before: unknown, after: unknown): DiffResult;
+/**
+ * Formats an object as diff lines (all unchanged).
+ * Useful for displaying a single object without comparison.
+ * @param obj The object to format
+ * @returns Array of DiffLine with all lines marked as unchanged
+ */
+export declare function formatObjectAsLines(obj: unknown): Array<DiffLine>;

package/dist/internal-common/src/utils/serialization.d.ts

@@ -0,0 +1,18 @@
+export declare function sortKeys(json: unknown): any;
+export declare function normalizeJsonAsString(json: unknown): string;
+export declare function serializeObj(obj: unknown): string;
+export declare function deserializeObj<T = any>(str: string): T;
+export declare function encodeValueForMapping(value: unknown): string;
+export declare function decodeValueForMapping(encodedString: string): any;
+/**
+ * Compares 2 objects by their normalized JSON value.
+ * This function should not be used with objects with circular references.
+ * Returns true if the object are equal.
+ */
+export declare function compareByNormalizedJsonValue<T>(v1: T | undefined, v2: T | undefined): boolean;
+/**
+ * Compares 2 objects by their normalized JSON value for specific fields only.
+ * This function should not be used with objects with circular references.
+ * Returns true if the specified fields are equal.
+ */
+export declare function compareByNormalizedJsonValueForFields<T>(v1: T | undefined, v2: T | undefined, fields: Array<keyof T>): boolean;

package/dist/internal-common/src/utils/squid.constants.d.ts

@@ -0,0 +1 @@
+export declare const SQUID_SUPPORT_EMAIL = "support@getsquid.ai";

package/dist/internal-common/src/utils/trace-id-generator.d.ts

@@ -0,0 +1 @@
+export declare function generateTraceId(prefix?: string): string;

package/dist/internal-common/src/utils/validation.d.ts

@@ -0,0 +1,19 @@
+import { HttpStatusCode } from '../public-types/http-status.public-types';
+export declare class ValidationError extends Error {
+    readonly statusCode: HttpStatusCode;
+    readonly details?: any;
+    constructor(error: string, statusCode: HttpStatusCode, details?: Record<string, unknown>);
+}
+export declare function isValidId(id: unknown, maxLength?: number): boolean;
+export declare function validateFieldSort(fieldSort: unknown): void;
+export declare function validateQueryLimit(limit: unknown): void;
+/**
+ * All type names returned by 'typeof' supported by JavaScript:
+ * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/typeof}.
+ * and a few other supported types.
+ */
+export type JavascriptTypeName = 'undefined' | 'object' | 'boolean' | 'number' | 'bigint' | 'string' | 'symbol' | 'function';
+/** Returns true if 'typeof' of the 'value' is 'type' or 'type[]'. */
+export declare function isRightType(value: unknown, type: JavascriptTypeName): boolean;
+/** Returns true if 'obj' has only keys listed in the 'keys'. Object can't be an array. */
+export declare function hasOnlyKeys(obj: object, keys: string[]): boolean;

package/dist/internal-common/src/websocket.impl.d.ts

@@ -0,0 +1,26 @@
+interface Options {
+    maxAttempts?: number;
+    protocols?: string[];
+    onmessage?: (event: any) => void;
+    onopen?: (event: any) => void;
+    onclose?: (event: any) => void;
+    onerror?: (event: any) => void;
+    onreconnect?: (event: any) => void;
+    onmaximum?: (event: any) => void;
+    timeoutMillis?: number;
+}
+export interface WebSocketWrapper {
+    open: () => void;
+    reconnect: (e: any) => void;
+    json: (x: any) => void;
+    send: (x: string) => void;
+    close: (x?: number, y?: string) => void;
+    connected: boolean;
+    /**
+     * Websocket is explicitly closed by calling socket.close().
+     * Used to ignore errors after socket.closed() is called.
+     */
+    closeCalled: boolean;
+}
+export declare function createWebSocketWrapper(url: string, opts?: Options): WebSocketWrapper;
+export {};

package/dist/typescript-client/src/agent/ai-agent-client-reference.d.ts

@@ -1,5 +1,5 @@
 import { Observable } from 'rxjs';
-import { AiAgent, AiChatMessage, AiChatModelSelection, AiConnectedAgentMetadata, AiStatusMessage, AiTranscribeAndAskResponse, AllAiAgentChatOptions, GuardrailsOptions, UpsertAgentRequest } from '../../../internal-common/src/public-types/ai-agent.public-types';
+import { AiAgent, AiChatMessage, AiChatModelSelection, AiConnectedAgentMetadata, AiStatusMessage, AiTranscribeAndAskResponse, AllAiAgentChatOptions, GuardrailsOptions, ListAgentRevisionsResponse, UpsertAgentRequest } from '../../../internal-common/src/public-types/ai-agent.public-types';
 import { AiChatModelName } from '../../../internal-common/src/public-types/ai-common.public-types';
 import { JobId } from '../../../internal-common/src/public-types/job.public-types';
 import { Paths } from '../../../internal-common/src/public-types/typescript.public-types';
@@ -72,6 +72,22 @@ export declare class AiAgentReference {
      * @returns the api key if one exists
      */
     getApiKey(): Promise<string | undefined>;
+    /**
+     * Lists all revisions (history) of the agent.
+     * @returns the list of revisions sorted by newest first
+     */
+    listRevisions(): Promise<ListAgentRevisionsResponse>;
+    /**
+     * Restores the agent to a previous revision.
+     * This will create a new revision with the current state before restoring.
+     * @param revisionNumber The revision number to restore to
+     */
+    restoreRevision(revisionNumber: number): Promise<void>;
+    /**
+     * Deletes a specific revision.
+     * @param revisionNumber The revision number to delete
+     */
+    deleteRevision(revisionNumber: number): Promise<void>;
     /**
      * Sends a prompt to the agent and receives streamed text responses.
      * @param prompt The text prompt to send to the agent.

package/dist/typescript-client/src/ai-client.d.ts

@@ -1,7 +1,6 @@
 import { AiQueryOptions, AiQueryResponse, ExecuteAiApiResponse } from '../../internal-common/src/public-types/ai-query.public-types';
 import { AiAgentClientOptions } from './agent/ai-agent-client';
 import { AiAgentReference } from './agent/ai-agent-client-reference';
-import { AiAssistantClient } from './ai-assistant-client';
 import { AiAudioClient } from './ai-audio-client';
 import { AiFilesClient } from './ai-files-client';
 import { AiImageClient } from './ai-image-client';
@@ -19,7 +18,6 @@ export declare class AiClient {
     private readonly rpcManager;
     private readonly jobClient;
     private readonly backendFunctionManager;
-    private readonly aiAssistantClient;
     private aiAgentClient?;
     private aiKnowledgeBaseClient?;
     /**
@@ -39,11 +37,6 @@ export declare class AiClient {
      * Lists all available AI agents.
      */
     listKnowledgeBases(): Promise<Array<AiKnowledgeBase>>;
-    /**
-     * Retrieves the AI assistant client.
-     * @returns An instance of AiAssistantClient.
-     */
-    assistant(): AiAssistantClient;
     /**
      * Retrieves an AI image client.
      */

package/dist/typescript-client/src/index.d.ts

@@ -2,7 +2,6 @@ export * from './admin-client';
 export * from './agent/ai-agent-client';
 export * from './agent/ai-agent-client-reference';
 export * from './agent/ai-agent-client.types';
-export * from './ai-assistant-client';
 export * from './ai-audio-client';
 export * from './ai-client';
 export * from './ai-files-client';
@@ -30,7 +29,6 @@ export * from './execute-function-options';
 export * from './external-auth-client';
 export * from './extraction-client';
 export * from './file-args-transformer';
-export * from './file-utils';
 export * from './integration-client';
 export * from './job-client';
 export * from './mutation/mutation-sender';

package/dist/typescript-client/src/public-types.d.ts

@@ -1,6 +1,5 @@
 export * from '../../internal-common/src/public-types/ai-agent-integrations.public-types';
 export * from '../../internal-common/src/public-types/ai-agent.public-types';
-export * from '../../internal-common/src/public-types/ai-assistant.public-types';
 export * from '../../internal-common/src/public-types/ai-common.public-types';
 export * from '../../internal-common/src/public-types/ai-knowledge-base.public-types';
 export * from '../../internal-common/src/public-types/ai-matchmaking.public-types';

package/dist/typescript-client/src/version.d.ts

@@ -2,4 +2,4 @@
  * The current version of the SquidCloud client package.
  * @category Platform
  */
-export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.423";
+export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.425";

package/dist/typescript-client/src/web-client.d.ts

@@ -1,4 +1,4 @@
-import { WebAiSearchResponse, WebShortUrlBulkResponse, WebShortUrlResponse } from '../../internal-common/src/public-types/web.public-types';
+import { CreateShortUrlOptions, CreateShortUrlsOptions, WebAiSearchResponse, WebShortUrlBulkResponse, WebShortUrlResponse } from '../../internal-common/src/public-types/web.public-types';
 /**
  * WebClient provides methods to interact with web-related functionalities.
  * @category Platform
@@ -9,6 +9,8 @@ export declare class WebClient {
     private readonly appId;
     private readonly apiKey;
     private readonly consoleRegion;
+    /** Headers for short URL API requests. Only use after asserting apiKey is defined. */
+    private get shortUrlHeaders();
     /**
      * Search the web using AI. Returns a response containing Markdown text and cited URLs.
      * @param query The keywords or query string to search for.
@@ -22,28 +24,21 @@ export declare class WebClient {
     /**
      * Creates a shortened URL for the given URL.
      *
-     * Defaults to a 1 day expiration if no expiry is provided via the `secondsToLive` field.
+     * Defaults to a 1-day expiration if no expiry is provided via the `secondsToLive` field.
      * If `secondsToLive` is set to 0, the URL will never expire.
      *
-     * @param url The URL to shorten. It must be a valid URL and should include the protocol (start with http:// or
-     *   https://).
-     * @param secondsToLive Seconds to live for the shortened URL. If set to 0, the URL will never expire. Defaults to 30
-     *   days.
+     * @param urlOrOptions - Either a URL string or an options object with url and all available options.
      */
-    createShortUrl(url: string, secondsToLive?: number): Promise<WebShortUrlResponse>;
+    createShortUrl(urlOrOptions: string | CreateShortUrlOptions): Promise<WebShortUrlResponse>;
     /**
      * Creates shortened URLs for the given URLs.
      *
-     * Defaults to a 1 day expiration if no expiry is provided via the `secondsToLive` field.
+     * Defaults to a 1-day expiration if no expiry is provided via the `secondsToLive` field.
      * If `secondsToLive` is set to 0, the URL will never expire.
      *
-     * The parameter arrays should be of the same length and in the same order
-     *
-     * @param urls The URLs to shorten. It must be a valid URL and should include the protocol (start with http:// or
-     *   https://).
-     * @param secondsToLive Seconds to live for each shortened URL. If set to 0, the URL will never expire.
+     * @param urlsOrOptions - Either an array of URL strings or an options object and all available options.
      */
-    createShortUrls(urls: string[], secondsToLive?: number): Promise<WebShortUrlBulkResponse>;
+    createShortUrls(urlsOrOptions: string[] | CreateShortUrlsOptions): Promise<WebShortUrlBulkResponse>;
     /**
      * Deletes a shortened URL by its ID.
      *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squidcloud/client",
-  "version": "1.0.423",
+  "version": "1.0.425",
   "description": "A typescript implementation of the Squid client",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",

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

@@ -1,31 +0,0 @@
-import { AiReasoningEffort } from './ai-agent.public-types';
-import { OpenAiChatModelName } from './ai-common.public-types';
-import { AiFunctionId } from './backend.public-types';
-/**
- * Response format for AI assistant responses.
- * @category AI
- */
-export type AiAssistantResponseFormat = 'text' | 'json_object';
-/**
- * The type of assistant tool.
- * @category AI
- */
-export type AssistantToolType = 'code_interpreter' | 'file_search';
-/**
- * The options for configuring an AI assistant's behavior and response.
- * @category AI
- */
-export interface QueryAssistantOptions {
-    /** Additional context provided to all AI functions for processing. */
-    agentContext?: Record<string, unknown>;
-    /** Specific context provided per AI function, keyed by function ID. */
-    functionContexts?: Record<AiFunctionId, Record<string, unknown>>;
-    /** The desired format of the AI model's response; defaults to 'text'. */
-    responseFormat?: AiAssistantResponseFormat;
-    /** The OpenAI chat model to use for the assistant, if specified. */
-    model?: OpenAiChatModelName;
-    /** The level of reasoning effort to apply, as defined by OpenAI. */
-    reasoningEffort?: AiReasoningEffort;
-    /** Custom instructions to guide the assistant's behavior, if provided. */
-    instructions?: string;
-}