@squidcloud/client 1.0.388 → 1.0.389

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

@@ -15,20 +15,25 @@ export type AiProviderType = (typeof AI_PROVIDER_TYPES)[number];
  * The supported OpenAI models.
  * @category AI
  */
-export declare const OPENAI_O1_CHAT_MODEL_NAMES: readonly ["o1", "o1-mini"];
+export declare const OPENAI_O1_CHAT_MODEL_NAMES: readonly ["o1"];
 /**
  * @category AI
  */
-export declare const OPENAI_REASONING_CHAT_MODEL_NAMES: readonly ["o1", "o1-mini", "o3", "o3-mini", "o4-mini"];
+export declare const OPENAI_REASONING_CHAT_MODEL_NAMES: readonly ["o1", "o3", "o3-mini", "o4-mini"];
 /**
  * @category AI
  */
-export declare const OPENAI_CHAT_MODEL_NAMES: readonly ["gpt-4o", "gpt-4o-mini", "gpt-4.1-nano", "gpt-4.1-mini", "gpt-4.1", "o1", "o1-mini", "o3", "o3-mini", "o4-mini"];
+export declare const OPENAI_CHAT_MODEL_NAMES: readonly ["gpt-4o", "gpt-4o-mini", "gpt-4.1-nano", "gpt-4.1-mini", "gpt-4.1", "o1", "o3", "o3-mini", "o4-mini"];
 /**
  * @category AI
  */
-export declare const GEMINI_CHAT_MODEL_NAMES: readonly ["gemini-2.5-pro", "gemini-2.5-flash"];
+export declare const GEMINI_CHAT_MODEL_NAMES: readonly ["gemini-2.5-pro", "gemini-2.5-flash", "gemini-2.5-flash-lite"];
 /**
+ * Notes:
+ * - 'grok-3-mini' model os ~10x less expensive than 'grok-3'.
+ * - '*-fast' models are ~2x more expensive than non-fast variants and only marginally faster.
+ * - 'grok-4' cost is comparable to 'grok-3-fast'.
+ *
  * @category AI
  */
 export declare const GROK_CHAT_MODEL_NAMES: readonly ["grok-3", "grok-3-fast", "grok-3-mini", "grok-3-mini-fast", "grok-4"];
@@ -40,7 +45,7 @@ export declare const ANTHROPIC_CHAT_MODEL_NAMES: readonly ["claude-3-7-sonnet-la
  * The supported AI model names.
  * @category AI
  */
-export declare const VENDOR_AI_CHAT_MODEL_NAMES: readonly ["gpt-4o", "gpt-4o-mini", "gpt-4.1-nano", "gpt-4.1-mini", "gpt-4.1", "o1", "o1-mini", "o3", "o3-mini", "o4-mini", "claude-3-7-sonnet-latest", "claude-opus-4-20250514", "claude-sonnet-4-20250514", "gemini-2.5-pro", "gemini-2.5-flash", "grok-3", "grok-3-fast", "grok-3-mini", "grok-3-mini-fast", "grok-4"];
+export declare const VENDOR_AI_CHAT_MODEL_NAMES: readonly ["gpt-4o", "gpt-4o-mini", "gpt-4.1-nano", "gpt-4.1-mini", "gpt-4.1", "o1", "o3", "o3-mini", "o4-mini", "claude-3-7-sonnet-latest", "claude-opus-4-20250514", "claude-sonnet-4-20250514", "gemini-2.5-pro", "gemini-2.5-flash", "gemini-2.5-flash-lite", "grok-3", "grok-3-fast", "grok-3-mini", "grok-3-mini-fast", "grok-4"];
 /**
  * Check if the given model name is a global AI chat model name.
  */

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

@@ -43,8 +43,8 @@ export type LlmModelMetadata = {
      * A friendly name for the model, to display in UIs.
      */
     displayName: string;
-    /**
-     * The max number of input tokens that the model can handle.
-     */
-    maxTokens: number;
+    /** Maximum tokens the model can generate in a single response. */
+    maxOutputTokens: number;
+    /** Total context window size: input (aka prompt) + output (aka completion) tokens combined. */
+    contextWindowTokens: number;
 };

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

package/package.json

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