@squidcloud/client 1.0.350 → 1.0.352

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

@@ -13,7 +13,7 @@ export declare const OPENAI_REASONING_CHAT_MODEL_NAMES: readonly ["o1", "o1-mini
 /**
  * @category AI
  */
-export declare const OPENAI_CHAT_MODEL_NAMES: readonly ["gpt-4o", "gpt-4o-mini", "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", "o1-mini", "o3", "o3-mini", "o4-mini"];
 /**
  * @category AI
  */
@@ -26,7 +26,7 @@ export declare const ANTHROPIC_CHAT_MODEL_NAMES: readonly ["claude-3-5-haiku-lat
  * The supported AI model names.
  * @category AI
  */
-export declare const AI_CHAT_MODEL_NAMES: readonly ["gpt-4o", "gpt-4o-mini", "o1", "o1-mini", "o3", "o3-mini", "o4-mini", "claude-3-5-haiku-latest", "claude-3-5-sonnet-latest", "claude-3-7-sonnet-latest", "gemini-1.5-pro", "gemini-2.0-flash"];
+export declare const 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-5-haiku-latest", "claude-3-5-sonnet-latest", "claude-3-7-sonnet-latest", "gemini-1.5-pro", "gemini-2.0-flash"];
 /**
  * @category AI
  */

package/dist/typescript-client/src/execute-function-options.d.ts

@@ -0,0 +1,73 @@
+/** Advanced options for a Squid `executeFunction` call. */
+export interface ExecuteFunctionOptions<ResultType> {
+    /** The name of the `@executable` function to invoke. */
+    functionName: string;
+    /** Optional caching configuration. Reuses results based on argument values. */
+    caching?: ExecuteFunctionCachingOptions<ResultType>;
+    /**
+     * Deduplication config for sharing results of concurrent calls with the same args.
+     * When set to true a default mode with 'compareArgsByReference' is used.
+     */
+    deduplication?: ConcurrentCallDeduplicationOptions | boolean;
+}
+/** Defines caching behavior for `executeFunction`. */
+export interface ExecuteFunctionCachingOptions<T> {
+    /** The caching implementation to use. */
+    cache: ExecuteFunctionCache<T>;
+}
+/** Interface for a function result cache. */
+export interface ExecuteFunctionCache<ValueType> {
+    /** Retrieves a cached value for the given arguments. */
+    get(args: Array<unknown>): ExecuteFunctionCacheLookupResult<ValueType>;
+    /** Caches a result for the given arguments. */
+    set(args: Array<unknown>, value: ValueType): void;
+}
+/** Result object returned from a cache lookup. */
+export type ExecuteFunctionCacheLookupResult<ValueType> = {
+    /** The cached value. */
+    value: ValueType;
+    /** Indicates that the value was found in the cache. */
+    found: true;
+} | {
+    /** Indicates that the value was not found in the cache. */
+    found: false;
+};
+/** Comparator function type for evaluating argument equality. */
+export type ExecuteFunctionArgsComparator = (args1: Array<unknown>, args2: Array<unknown>) => boolean;
+/** Comparator that checks reference equality of arguments. */
+export declare const compareArgsByReference: ExecuteFunctionArgsComparator;
+/** Comparator that checks argument equality using serialization. */
+export declare const compareArgsBySerializedValue: ExecuteFunctionArgsComparator;
+/** A single cached result of a function call. */
+export interface ExecuteFunctionCachedResult<T> {
+    /** Arguments used for the function call. */
+    args: Array<unknown>;
+    /** The result value returned by the function. */
+    result: T;
+    /** Time (in ms) when the result was cached. */
+    cacheTimeMillis: number;
+}
+/** Options for `LastUsedValueExecuteFunctionCache`. */
+interface LastUsedValueExecuteFunctionCacheOptions {
+    /** Argument equality comparator. */
+    argsComparator: ExecuteFunctionArgsComparator;
+    /** Validity duration in milliseconds. */
+    valueExpirationMillis: number;
+}
+/** Lightweight cache storing only the last computed result. */
+export declare class LastUsedValueExecuteFunctionCache<T> implements ExecuteFunctionCache<T> {
+    private readonly options;
+    protected cachedEntry?: ExecuteFunctionCachedResult<T>;
+    /** Creates a new instance of `LastUsedValueExecuteFunctionCache`. */
+    constructor(options: Partial<LastUsedValueExecuteFunctionCacheOptions>);
+    /** @inheritdoc */
+    get(args: Array<unknown>): ExecuteFunctionCacheLookupResult<T>;
+    /** @inheritdoc */
+    set(args: Array<unknown>, value: T): void;
+}
+/** Configuration for deduplicating concurrent function calls. */
+export interface ConcurrentCallDeduplicationOptions {
+    /** Comparator to determine if concurrent calls are equivalent. */
+    argsComparator: ExecuteFunctionArgsComparator;
+}
+export {};

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

@@ -17,6 +17,7 @@ export * from './document-identity.service';
 export * from './document-reference.factory';
 export * from './document-reference';
 export * from './document-store';
+export * from './execute-function-options';
 export * from './mutation/mutation-sender';
 export * from './native-query-manager';
 export * from './public-types';

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

@@ -13,6 +13,7 @@ import { SchedulerClient } from './scheduler-client';
 import { AdminClient } from './admin-client';
 import { AiClient } from './ai-client';
 import { WebClient } from './web-client';
+import { ExecuteFunctionOptions } from './execute-function-options';
 /**
  * The different options that can be used to initialize a Squid instance.
  * @category Platform
@@ -185,12 +186,13 @@ export declare class Squid {
      * on the backend.
      * - Arrays of files can also be passed directly as parameters.
      *
-     * @param functionName - The name of the backend function to execute.
+     * @param functionNameOrOptions - The name of the backend function to execute or detailed options which include
+     *   additional advanced options along with the function name.
      * @param params - A list of parameters to pass to the backend function.
      * @returns A promise that resolves to the result of the backend function.
      * @typeParam T - The expected type of the result returned by the backend function.
      */
-    executeFunction<T = any>(functionName: string, ...params: Array<any | File>): Promise<T>;
+    executeFunction<T = any>(functionNameOrOptions: string | ExecuteFunctionOptions<T>, ...params: Array<any | File>): Promise<T>;
     /**
      * Executes a native relational query with the given parameters and returns a promise with the result.
      * See https://docs.getsquid.ai/docs/client-sdk/database/native-queries.

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squidcloud/client",
-  "version": "1.0.350",
+  "version": "1.0.352",
   "description": "A typescript implementation of the Squid client",
   "main": "dist/cjs/index.js",
   "types": "dist/typescript-client/src/index.d.ts",