@squidcloud/client 1.0.387 → 1.0.389

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

@@ -0,0 +1,59 @@
+import { MmEntity, MmEntityMatch, MmFindMatchesOptions, MmListEntitiesOptions, MmMatchMaker } from '../public-types/ai-matchmaking.public-types';
+export interface MmCreateMatchMakerRequest {
+    matchMaker: MmMatchMaker;
+}
+export interface MmDeleteMatchMakerRequest {
+    matchMakerId: string;
+}
+export interface MmGetMatchMakerRequest {
+    matchMakerId: string;
+}
+export interface MmGetMatchMakerResponse {
+    matchMaker: MmMatchMaker | undefined;
+}
+export interface MmDeleteEntityRequest {
+    matchMakerId: string;
+    entityId: string;
+}
+export interface MmInsertEntityRequest {
+    matchMakerId: string;
+    entity: MmEntity;
+}
+export interface MmInsertEntitiesRequest {
+    matchMakerId: string;
+    entities: Array<MmEntity>;
+}
+export interface MmFindMatchesRequest {
+    matchMakerId: string;
+    entityId: string;
+    options: MmFindMatchesOptions;
+}
+export interface MmFindMatchesResponse {
+    matches: Array<MmEntityMatch>;
+}
+export interface MmFindMatchesForEntityRequest {
+    matchMakerId: string;
+    entity: Omit<MmEntity, 'metadata' | 'id'>;
+    options: MmFindMatchesOptions;
+}
+export interface MmFindMatchesForEntityResponse {
+    matches: Array<MmEntityMatch>;
+}
+export interface MmListMatchMakersResponse {
+    matchMakers: Array<MmMatchMaker>;
+}
+export interface MmListEntitiesRequest {
+    matchMakerId: string;
+    categoryId: string;
+    options: MmListEntitiesOptions;
+}
+export interface MmListEntitiesResponse {
+    entities: Array<MmEntity>;
+}
+export interface MmGetEntityRequest {
+    matchMakerId: string;
+    entityId: string;
+}
+export interface MmGetEntityResponse {
+    entity: MmEntity | undefined;
+}

package/dist/internal-common/src/types/backend-function.types.d.ts

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

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

@@ -0,0 +1 @@
+export type ChatId = string;

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

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

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

@@ -0,0 +1,6 @@
+export interface Base64File {
+    filename: string;
+    mimetype: string;
+    base64: string;
+    __isSquidBase64File__: true;
+}

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

@@ -0,0 +1,17 @@
+/** HTTP header names used by Squid for request metadata. */
+export declare const SquidHeaders: {
+    /** Correlates logs and spans across distributed calls. */
+    readonly TRACE_ID: "x-squid-traceid";
+    /** Shared secret header for internal authentication. */
+    readonly SECRET: "x-squid-secret";
+    /** API key provided by the calling application. */
+    readonly APP_API_KEY: "x-app-api-key";
+    /** Unique identifier of the client application. */
+    readonly APP_ID: "x-squid-appid";
+    /** Unique identifier of the end user or service client. */
+    readonly CLIENT_ID: "x-squid-clientid";
+    /** Version string of the Squid client library. */
+    readonly CLIENT_VERSION: "x-squid-client-version";
+    /** Originating IP address of the request. */
+    readonly SOURCE_IP: "x-squid-source-ip";
+};

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

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

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

@@ -0,0 +1,5 @@
+import { ClientId } from '../public-types/communication.public-types';
+export interface PublishNotificationRequest {
+    clientIds: Array<ClientId>;
+    payload: unknown;
+}

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

@@ -0,0 +1,72 @@
+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>;
+}
+/** 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";
+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";
+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,2 @@
+export declare const BACKEND_API_KEY = "_BACKEND_API_KEY";
+export declare const APP_API_KEY = "APP_API_KEY";

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,41 @@
+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;
+}
+/**
+ * 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;
+}
+/**
+ * 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/global.utils.d.ts

@@ -0,0 +1 @@
+export declare function isTimestampEnabled(): boolean;

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): 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,57 @@
+/** 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>;

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

@@ -0,0 +1,11 @@
+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, v2: 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/index.d.ts

@@ -30,6 +30,7 @@ export * from './integration-client';
 export * from './job-client';
 export * from './mutation/mutation-sender';
 export * from './native-query-manager';
+export * from './notification-client';
 export * from './observability-client';
 export * from './personal-storage-client';
 export * from './public-types';

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

@@ -0,0 +1,20 @@
+import { Observable } from 'rxjs';
+import { ClientId } from '../../internal-common/src/public-types/communication.public-types';
+/**
+ * NotificationClient is a client for handling user-defined notifications.
+ * Using this class you can receive messages that are sent from the server to this client or
+ * publish messages to other clients. In order to publish a message you have to initialize the squid sdk with a valid
+ * api key.
+ */
+export declare class NotificationClient {
+    private readonly socketManager;
+    private readonly rpcManager;
+    /**
+     * Observes user-defined notifications.
+     */
+    observeNotifications(): Observable<unknown>;
+    /**
+     * Publishes a notification to clients.
+     */
+    publishNotification(payload: unknown, clientIds: Array<ClientId>): Promise<void>;
+}

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

@@ -7,6 +7,7 @@ import { DistributedLock } from './distributed-lock.manager';
 import { ExecuteFunctionOptions } from './execute-function-options';
 import { ExtractionClient } from './extraction-client';
 import { JobClient } from './job-client';
+import { NotificationClient } from './notification-client';
 import { ObservabilityClient } from './observability-client';
 import { PersonalStorageClient } from './personal-storage-client';
 import { ApiKey, AppId, CollectionName, DocumentData, EnvironmentId, IntegrationId, SquidDeveloperId, SquidRegion } from './public-types';
@@ -65,16 +66,16 @@ export interface SquidOptions {
  * @category Authentication
  */
 export interface SquidAuthProvider {
-    /**
-     * Returns a valid AccessToken or undefined if there is no active authorized session.
-     * Called by Squid every time a Squid client makes requests to the Squid backend.
-     */
-    getToken(): Promise<string | undefined> | string | undefined;
     /**
      * Optional Auth integration id.
      * Sent as a part of all Squid requests to the backend.
      */
     integrationId: string;
+    /**
+     * Returns a valid AccessToken or undefined if there is no active authorized session.
+     * Called by Squid every time a Squid client makes requests to the Squid backend.
+     */
+    getToken(): Promise<string | undefined> | string | undefined;
 }
 /**
  * The main entry point to the Squid Client SDK.
@@ -89,6 +90,7 @@ export interface SquidAuthProvider {
  */
 export declare class Squid {
     readonly options: SquidOptions;
+    private static readonly squidInstancesMap;
     private readonly socketManager;
     private readonly dataManager;
     private readonly documentReferenceFactory;
@@ -107,7 +109,6 @@ export declare class Squid {
     private readonly clientIdService;
     private readonly _connectionDetails;
     private readonly querySender;
-    private static readonly squidInstancesMap;
     private readonly aiClient;
     private readonly jobClient;
     private readonly apiClient;
@@ -116,6 +117,7 @@ export declare class Squid {
     private readonly observabilityClient;
     private readonly queueManagerFactory;
     private readonly schedulerClient;
+    private readonly notificationClient;
     private readonly _appId;
     /**
      * Creates a new instance of Squid with the given options.
@@ -123,6 +125,18 @@ export declare class Squid {
      * @param options The options for initializing the Squid instance.
      */
     constructor(options: SquidOptions);
+    /**
+     * Returns the observability client for metrics.
+     */
+    get observability(): ObservabilityClient;
+    /**
+     * Returns the scheduler client for managing scheduled jobs and tasks.
+     */
+    get schedulers(): SchedulerClient;
+    /**
+     * Returns the application ID of the current Squid instance.
+     */
+    get appId(): AppId;
     /**
      * Returns the global Squid instance with the given options, creating a new instance if one with the same options
      * does not exist.
@@ -199,8 +213,10 @@ export declare class Squid {
      * See https://docs.getsquid.ai/docs/sdk/client-sdk/database/native-queries.
      *
      * @param integrationId The id of the integration that the query is associated with.
-     * @param query The raw SQL or database-specific query string to execute. Use named bind variables enclosed in ${}, e.g., ${firstName}.
-     * @param params (Optional) An object containing key-value pairs to bind to the query variables. Defaults to an empty object.
+     * @param query The raw SQL or database-specific query string to execute. Use named bind variables enclosed in ${},
+     *   e.g., ${firstName}.
+     * @param params (Optional) An object containing key-value pairs to bind to the query variables. Defaults to an empty
+     *   object.
      * @returns A promise that resolves with the result of the query.
      */
     executeNativeRelationalQuery<T = any>(integrationId: IntegrationId, query: string, params?: Record<string, any>): Promise<Array<T>>;
@@ -263,18 +279,6 @@ export declare class Squid {
      * Returns a client for working with structured data extraction tools.
      */
     extraction(): ExtractionClient;
-    /**
-     * Returns the observability client for metrics.
-     */
-    get observability(): ObservabilityClient;
-    /**
-     * Returns the scheduler client for managing scheduled jobs and tasks.
-     */
-    get schedulers(): SchedulerClient;
-    /**
-     * Returns the application ID of the current Squid instance.
-     */
-    get appId(): AppId;
     /**
      * Returns a distributed lock for the given mutex. The lock can be used to synchronize access to a shared resource.
      * The lock will be released when the release method on the returned object is invoked or whenever the connection
@@ -306,5 +310,7 @@ export declare class Squid {
     destruct(): Promise<void>;
     /** Provides information about the connection to the Squid Server. */
     connectionDetails(): ConnectionDetails;
+    /** Returns the notification client for handling (publishing and receiving) custom messages. */
+    getNotificationClient(): NotificationClient;
     private _validateNotDestructed;
 }

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

package/package.json

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