@squidcloud/client 1.0.435 → 1.0.436

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 | null): 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

@@ -137,8 +137,9 @@ export declare class AiAgentReference {
     askAsync<T extends AiChatModelName | undefined = undefined>(prompt: string, jobId: JobId, options?: AiAskOptions<T>): Promise<void>;
     /**
      * Observes live status messages from the agent.
+     * @param jobId The job ID to filter status updates for a specific job. If not provided, all status updates for the agent are observed.
      */
-    observeStatusUpdates(): Observable<AiStatusMessage>;
+    observeStatusUpdates(jobId: JobId): Observable<AiStatusMessage>;
     /**
      * Returns a list of all chat history messages with the given 'memoryId'.
      * Includes both user and & AI messages.

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

@@ -1,3 +1,4 @@
+import { Observable } from 'rxjs';
 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';
@@ -6,7 +7,7 @@ import { AiFilesClient } from './ai-files-client';
 import { AiImageClient } from './ai-image-client';
 import { AiKnowledgeBaseReference } from './ai-knowledge-base/ai-knowledge-base-client-reference';
 import { AiMatchMakingClient } from './ai-matchmaking-client';
-import { AiAgent, AiAgentApiIntegrationOptions, AiAgentId, AiFileProviderType, AiKnowledgeBase, AiKnowledgeBaseId, AiProviderType, AiSessionContext, ApplicationAiSettings, IntegrationId, SecretKey } from './public-types';
+import { AiAgent, AiAgentApiIntegrationOptions, AiAgentId, AiFileProviderType, AiKnowledgeBase, AiKnowledgeBaseId, AiProviderType, AiSessionContext, AiStatusMessage, ApplicationAiSettings, IntegrationId, JobId, SecretKey } from './public-types';
 /**
  * AiClient class serves as a facade for interacting with different AI services.
  * It provides simplified access to AI chatbot and assistant functionalities
@@ -117,6 +118,11 @@ export declare class AiClient {
      * Returns the updated state of the AI application settings.
      */
     setAiProviderApiKeySecret(providerType: AiProviderType, secretKey: SecretKey | undefined): Promise<ApplicationAiSettings>;
+    /**
+     * Observes live status messages for all AI updates.
+     * @param jobId (Optional) If provided, filters status updates to only those related to the given job ID.
+     */
+    observeStatusUpdates(jobId?: JobId): Observable<AiStatusMessage>;
     private getAiAgentClient;
     private getAiKnowledgeBaseClient;
 }

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

@@ -31,6 +31,7 @@ export * from './extraction-client';
 export * from './file-args-transformer';
 export * from './integration-client';
 export * from './job-client';
+export * from './management-client';
 export * from './mutation/mutation-sender';
 export * from './native-query-manager';
 export * from './notification-client';

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

@@ -0,0 +1,129 @@
+import { SquidRegion } from '../../internal-common/src/public-types/regions.public-types';
+/**
+ * Supported cloud providers for application creation.
+ * @category ManagementClient
+ */
+export type ManagementCloudId = 'aws' | 'gcp' | 'azure';
+/**
+ * Options for creating a ManagementClient.
+ * @category ManagementClient
+ */
+export interface ManagementClientOptions {
+    /** The management API key (starts with 'squid_mgmt_') */
+    apiKey: string;
+    /** The Squid region to connect to */
+    region: SquidRegion;
+}
+/**
+ * Request to create a new organization.
+ * @category ManagementClient
+ */
+export interface ManagementCreateOrganizationRequest {
+    /** Name of the organization (2-50 characters) */
+    name: string;
+}
+/**
+ * Response from creating a new organization.
+ * @category ManagementClient
+ */
+export interface ManagementCreateOrganizationResponse {
+    /** The ID of the created organization */
+    organizationId: string;
+}
+/**
+ * Request to create a new application.
+ * @category ManagementClient
+ */
+export interface ManagementCreateApplicationRequest {
+    /** The organization ID to create the application in */
+    organizationId: string;
+    /** Name of the application */
+    name: string;
+    /** Cloud provider for the application */
+    cloudId: ManagementCloudId;
+    /** Region within the cloud provider (e.g., 'us-east-1') */
+    region: string;
+}
+/**
+ * Response from creating a new application.
+ * @category ManagementClient
+ */
+export interface ManagementCreateApplicationResponse {
+    /** The ID of the created application */
+    appId: string;
+}
+/**
+ * Request to delete an application.
+ * @category ManagementClient
+ */
+export interface ManagementDeleteApplicationRequest {
+    /** The ID of the application to delete */
+    appId: string;
+}
+/**
+ * Client for programmatic management of Squid organizations and applications.
+ *
+ * Use this client to automate organization and application management
+ * using management API keys (created in the Squid Console Profile Settings).
+ *
+ * @example
+ * ```typescript
+ * const client = new ManagementClient({
+ *   apiKey: 'squid_mgmt_xxx...',
+ *   region: 'us-east-1.aws'
+ * });
+ *
+ * // Create an organization
+ * const { organizationId } = await client.createOrganization({ name: 'My Org' });
+ *
+ * // Create an application
+ * const { appId } = await client.createApplication({
+ *   organizationId,
+ *   name: 'My App',
+ *   cloudId: 'aws',
+ *   region: 'us-east-1'
+ * });
+ *
+ * // Delete an application
+ * await client.deleteApplication({ appId });
+ * ```
+ *
+ * @category ManagementClient
+ */
+export declare class ManagementClient {
+    private readonly apiKey;
+    private readonly region;
+    /**
+     * Creates a new ManagementClient.
+     *
+     * @param options - Configuration options including API key and region
+     * @throws Error if the API key does not start with 'squid_mgmt_'
+     */
+    constructor(options: ManagementClientOptions);
+    /**
+     * Creates a new organization.
+     * The user associated with the management API key becomes the admin of the new organization.
+     *
+     * @param request - The organization creation request
+     * @returns The created organization's ID
+     * @throws Error if organization name is invalid or key is unauthorized
+     */
+    createOrganization(request: ManagementCreateOrganizationRequest): Promise<ManagementCreateOrganizationResponse>;
+    /**
+     * Creates a new application in an organization.
+     * Requires the user to be an admin in the target organization.
+     *
+     * @param request - The application creation request
+     * @returns The created application's ID
+     * @throws Error if user is not admin or organization quota reached
+     */
+    createApplication(request: ManagementCreateApplicationRequest): Promise<ManagementCreateApplicationResponse>;
+    /**
+     * Deletes an application.
+     * Requires the user to be an admin in the application's organization.
+     *
+     * @param request - The application deletion request
+     * @throws Error if user is not admin or application not found
+     */
+    deleteApplication(request: ManagementDeleteApplicationRequest): Promise<void>;
+}

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.435";
+export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.436";

package/package.json

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