@squidcloud/client 1.0.442 → 1.0.444

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

@@ -324,7 +324,7 @@ export interface AiAgentExecutionPlanOptions {
     /** Whether to enable an execution plan for the agent. */
     enabled: boolean;
     /** The model to use for the execution plan - defaults to the model used by the agent. */
-    model?: AiChatModelName;
+    model?: AiChatModelSelection;
     /** In case the model supports reasoning, this will control the level of effort - defaults to `high`. */
     reasoningEffort?: AiReasoningEffort;
     /**
@@ -557,7 +557,7 @@ export interface AnthropicChatOptions extends BaseAiChatOptions {
  * the type is inferred from the provided overrideModel (or falls back to BaseAiAgentChatOptions).
  * @category AI
  */
-export type AiChatOptions<T extends AiChatModelName | undefined = undefined> = T extends undefined ? BaseAiChatOptions | GeminiChatOptions | OpenAiChatOptions | AnthropicChatOptions : T extends GeminiChatModelName ? GeminiChatOptions : T extends OpenAiChatModelName ? OpenAiChatOptions : T extends AnthropicChatModelName ? AnthropicChatOptions : T extends GrokChatModelName ? GrokChatOptions : never;
+export type AiChatOptions<T extends AiChatModelSelection | undefined = undefined> = T extends undefined ? BaseAiChatOptions | GeminiChatOptions | OpenAiChatOptions | AnthropicChatOptions : T extends GeminiChatModelName ? GeminiChatOptions : T extends OpenAiChatModelName ? OpenAiChatOptions : T extends AnthropicChatModelName ? AnthropicChatOptions : T extends GrokChatModelName ? GrokChatOptions : BaseAiChatOptions;
 /**
  * @category AI
  */
@@ -568,7 +568,7 @@ export type AllAiAgentChatOptions = {
  * A definition of an AI agent with its properties and default chat options.
  * @category AI
  */
-export interface AiAgent<T extends AiChatModelName | undefined = undefined> {
+export interface AiAgent<T extends AiChatModelSelection | undefined = undefined> {
     /** The unique identifier of the AI agent. */
     id: AiAgentId;
     /** The date and time the agent was created. */
@@ -773,7 +773,7 @@ export interface FileContextRequest extends BaseContextRequest {
     /** The minimum size for extracted images, if applicable. */
     imageMinSizePixels?: number;
     /** The AI model to use for extraction, if specified. */
-    extractionModel?: AiChatModelName;
+    extractionModel?: AiChatModelSelection;
     /** General options for how to process the file. */
     options?: AiContextFileOptions;
     /** The preferred method for extracting data from the document. */

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

@@ -8,7 +8,7 @@ export declare const RERANK_PROVIDERS: readonly ["cohere", "none"];
  */
 export type AiRerankProvider = (typeof RERANK_PROVIDERS)[number];
 /** List of available AI provider types. See AiProviderType. */
-export declare const AI_PROVIDER_TYPES: readonly ["anthropic", "bedrock", "claude-code", "flux", "gemini", "openai", "grok", "stability", "voyage", "mistral", "textract", "external"];
+export declare const AI_PROVIDER_TYPES: readonly ["anthropic", "bedrock", "claude-code", "cohere", "flux", "gemini", "openai", "grok", "stability", "voyage", "mistral", "textract", "external"];
 /**
  * Type of the AI provider.
  * References a single AI service, regardless of the model or other AI function it provides (like
@@ -181,6 +181,13 @@ export type StableDiffusionModelName = (typeof STABLE_DIFFUSION_MODEL_NAMES)[num
  * @category AI
  */
 export type FluxModelName = (typeof FLUX_MODEL_NAMES)[number];
+/** Represents an AI model. */
+export interface ModelIdSpec {
+    /** The model ID used for API calls. */
+    modelId: AiChatModelName;
+    /** The integration ID if this model comes from an integration (OpenAI-compatible, Bedrock). Is undefined for Squid-provided models. */
+    integrationId?: string;
+}
 /**
  * Type guard to check if a model selection is integration-based.
  * @category AI

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

@@ -1,5 +1,5 @@
-import { AgentContextRequest, UpsertContextStatusError } from './ai-agent.public-types';
-import { AiChatModelName, AiEmbeddingsModelName, AiRerankProvider } from './ai-common.public-types';
+import { AgentContextRequest, AiChatModelSelection, UpsertContextStatusError } from './ai-agent.public-types';
+import { AiEmbeddingsModelName, AiRerankProvider } from './ai-common.public-types';
 import { AiContextId, AiKnowledgeBaseId, AppId } from './communication.public-types';
 import { DocumentExtractionMethod } from './extraction.public-types';
 /**
@@ -18,7 +18,7 @@ export interface AiKnowledgeBase {
     /** The embedding model name that should be used for this knowledge base.*/
     embeddingModel: AiEmbeddingsModelName;
     /** The model name that should be used when asking questions of this knowledge base. */
-    chatModel: AiChatModelName;
+    chatModel: AiChatModelSelection;
     /** The timestamp the knowledge base was last updated */
     updatedAt: Date;
 }
@@ -125,7 +125,7 @@ export interface AiKnowledgeBaseChatOptions {
     /** How many chunks to look over. Defaults to 100 */
     chunkLimit?: number;
     /** Which chat model to use when asking the question */
-    chatModel?: AiChatModelName;
+    chatModel?: AiChatModelSelection;
 }
 /**
  * @category AI
@@ -216,7 +216,7 @@ export interface AiKnowledgeBaseFileContextRequest extends BaseAiKnowledgeBaseCo
     /** The minimum size for extracted images, if applicable. */
     imageMinSizePixels?: number;
     /** The AI model to use for extraction, if specified. */
-    imageExtractionModel?: AiChatModelName;
+    imageExtractionModel?: AiChatModelSelection;
     /** General options for how to process the file. */
     options?: AiKnowledgeBaseContextFileOptions;
     /** The preferred method for extracting data from the document. */
@@ -262,7 +262,7 @@ export interface AiKnowledgeBaseSearchOptions {
     /** How many chunks to look over. Defaults to 100 */
     chunkLimit?: number;
     /** Which chat model to use when asking the question */
-    chatModel?: string;
+    chatModel?: AiChatModelSelection;
 }
 /**
  * A single chunk of data returned from an AI search operation.
@@ -320,7 +320,7 @@ export interface BaseAiKnowledgeBaseSearchContextsRequest {
     /** Whether to rerank the results with AI and provide reasoning - defaults to true */
     rerank?: boolean;
     /** Which chat model to use when doing reranking */
-    chatModel?: string;
+    chatModel?: AiChatModelSelection;
 }
 /**
  * Request structure for searching AI contexts in the AiKnowledgeBase with prompt.

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

@@ -1,6 +1,5 @@
 import { Observable } from 'rxjs';
 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';
 import { AiAskOptions, AiAskOptionsWithVoice, AiChatOptionsWithoutVoice, AskResponse, AskWithVoiceResponse, TranscribeAndAskWithVoiceResponse, TranscribeAndChatResponse } from './ai-agent-client.types';
@@ -96,7 +95,7 @@ export declare class AiAgentReference {
      *   `squid.jobs().getJob(jobId)` to track progress. Make sure each job ID is both unique and kept private—anyone who
      *   knows it can look up the job’s status.
      */
-    chat<T extends AiChatModelName | undefined>(prompt: string, options?: AiChatOptionsWithoutVoice<T>, jobId?: JobId): Observable<string>;
+    chat<T extends AiChatModelSelection | undefined>(prompt: string, options?: AiChatOptionsWithoutVoice<T>, jobId?: JobId): Observable<string>;
     /**
      * Transcribes the given file and performs a chat interaction.
      * @param fileToTranscribe The audio file to transcribe and send to the agent.
@@ -114,7 +113,7 @@ export declare class AiAgentReference {
      *   `squid.jobs().getJob(jobId)` to track progress. Make sure each job ID is both unique and kept private—anyone who
      *   knows it can look up the job’s status.
      */
-    ask<T extends AiChatModelName | undefined = undefined>(prompt: string, options?: AiAskOptions<T>, jobId?: JobId): Promise<string>;
+    ask<T extends AiChatModelSelection | undefined = undefined>(prompt: string, options?: AiAskOptions<T>, jobId?: JobId): Promise<string>;
     /**
      * Sends a prompt and returns the string response and file annotations.
      * @param prompt The text prompt to send to the agent.
@@ -123,7 +122,7 @@ export declare class AiAgentReference {
      *   `squid.jobs().getJob(jobId)` to track progress. Make sure each job ID is both unique and kept private—anyone who
      *   knows it can look up the job’s status.
      */
-    askWithAnnotations<T extends AiChatModelName | undefined = undefined>(prompt: string, options?: AiAskOptions<T>, jobId?: JobId): Promise<AskResponse>;
+    askWithAnnotations<T extends AiChatModelSelection | undefined = undefined>(prompt: string, options?: AiAskOptions<T>, jobId?: JobId): Promise<AskResponse>;
     /**
      * Sends a prompt and not wait for the result - the result can be tracked using the job ID
      * (`squid.jobs().awaitJob(jobId)` or `squid.jobs().getJob(jobId)).
@@ -134,7 +133,7 @@ export declare class AiAgentReference {
      to track progress. Make sure each job ID is both unique and kept private—anyone who knows it can look up the job’s status.
      * @param options Optional parameters for the AI ask request.
      */
-    askAsync<T extends AiChatModelName | undefined = undefined>(prompt: string, jobId: JobId, options?: AiAskOptions<T>): Promise<void>;
+    askAsync<T extends AiChatModelSelection | 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.
@@ -153,7 +152,7 @@ export declare class AiAgentReference {
      *   `squid.jobs().getJob(jobId)` to track progress. Make sure each job ID is both unique and kept private—anyone who
      *   knows it can look up the job’s status.
      */
-    transcribeAndAsk<T extends AiChatModelName | undefined>(fileToTranscribe: File, options?: AiAskOptions<T>, jobId?: JobId): Promise<AiTranscribeAndAskResponse>;
+    transcribeAndAsk<T extends AiChatModelSelection | undefined>(fileToTranscribe: File, options?: AiAskOptions<T>, jobId?: JobId): Promise<AiTranscribeAndAskResponse>;
     /**
      * Transcribes audio and gets both text and voice response from the agent.
      * @param fileToTranscribe The audio file to transcribe and send to the agent.
@@ -162,7 +161,7 @@ export declare class AiAgentReference {
      *   `squid.jobs().getJob(jobId)` to track progress. Make sure each job ID is both unique and kept private—anyone who
      *   knows it can look up the job’s status.
      */
-    transcribeAndAskWithVoiceResponse<T extends AiChatModelName | undefined>(fileToTranscribe: File, options?: AiAskOptionsWithVoice<T>, jobId?: JobId): Promise<TranscribeAndAskWithVoiceResponse>;
+    transcribeAndAskWithVoiceResponse<T extends AiChatModelSelection | undefined>(fileToTranscribe: File, options?: AiAskOptionsWithVoice<T>, jobId?: JobId): Promise<TranscribeAndAskWithVoiceResponse>;
     /**
      * Sends a prompt and gets both text and voice response from the agent.
      * @param prompt The text prompt to send to the agent.
@@ -171,7 +170,7 @@ export declare class AiAgentReference {
      *   `squid.jobs().getJob(jobId)` to track progress. Make sure each job ID is both unique and kept private—anyone who
      *   knows it can look up the job’s status.
      */
-    askWithVoiceResponse<T extends AiChatModelName | undefined>(prompt: string, options?: AiAskOptionsWithVoice<T>, jobId?: JobId): Promise<AskWithVoiceResponse>;
+    askWithVoiceResponse<T extends AiChatModelSelection | undefined>(prompt: string, options?: AiAskOptionsWithVoice<T>, jobId?: JobId): Promise<AskWithVoiceResponse>;
     /**
      * Sets a value at a specific path within the agent's options.
      */

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

@@ -1,6 +1,5 @@
 import { Observable } from 'rxjs';
-import { AiAnnotation, AiChatOptions } from '../../../internal-common/src/public-types/ai-agent.public-types';
-import { AiChatModelName } from '../../../internal-common/src/public-types/ai-common.public-types';
+import { AiAnnotation, AiChatModelSelection, AiChatOptions } from '../../../internal-common/src/public-types/ai-agent.public-types';
 /**
  * Response format for transcribing audio and generating a chat response.
  * Contains the transcribed text and a stream of AI-generated responses.
@@ -50,20 +49,20 @@ export interface AskWithVoiceResponse {
  * Chat options that exclude voice-specific configurations.
  * @category AI
  */
-export type AiChatOptionsWithoutVoice<T extends AiChatModelName | undefined = undefined> = Omit<AiChatOptions<T>, 'voiceOptions'> & {
+export type AiChatOptionsWithoutVoice<T extends AiChatModelSelection | undefined = undefined> = Omit<AiChatOptions<T>, 'voiceOptions'> & {
     model?: T;
 };
 /**
  * Options for AI-generated responses that exclude voice-specific settings and smooth typing behavior.
  * @category AI
  */
-export type AiAskOptions<T extends AiChatModelName | undefined = undefined> = Omit<AiChatOptions<T>, 'voiceOptions' | 'smoothTyping'> & {
+export type AiAskOptions<T extends AiChatModelSelection | undefined = undefined> = Omit<AiChatOptions<T>, 'voiceOptions' | 'smoothTyping'> & {
     model?: T;
 };
 /**
  * Options for AI-generated responses that include voice-specific settings but excludes smooth typing.
  * @category AI
  */
-export type AiAskOptionsWithVoice<T extends AiChatModelName | undefined = undefined> = Omit<AiChatOptions<T>, 'smoothTyping'> & {
+export type AiAskOptionsWithVoice<T extends AiChatModelSelection | undefined = undefined> = Omit<AiChatOptions<T>, 'smoothTyping'> & {
     model?: T;
 };

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

@@ -8,7 +8,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, AiStatusMessage, ApplicationAiSettings, IntegrationId, JobId, SecretKey } from './public-types';
+import { AiAgent, AiAgentApiIntegrationOptions, AiAgentId, AiFileProviderType, AiKnowledgeBase, AiKnowledgeBaseId, AiProviderType, AiSessionContext, AiStatusMessage, ApplicationAiSettings, IntegrationId, JobId, ModelIdSpec, 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
@@ -44,6 +44,11 @@ export declare class AiClient {
      * @returns A promise that resolves to an array of AI function metadata.
      */
     listFunctions(): Promise<Array<AiFunctionMetadata>>;
+    /**
+     * Returns a list of all available AI chat models.
+     * Includes both Squid-provided vendor models and custom integration models.
+     */
+    listChatModels(): Promise<ModelIdSpec[]>;
     /**
      * Retrieves an AI image client.
      */

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

@@ -49,6 +49,26 @@ export interface ManagementCreateApplicationResponse {
     /** The API key for the prod environment */
     prodApiKey: string;
 }
+/**
+ * Request to rename an organization.
+ * @category ManagementClient
+ */
+export interface ManagementRenameOrganizationRequest {
+    /** The ID of the organization to rename */
+    organizationId: string;
+    /** New name for the organization (2-50 characters) */
+    name: string;
+}
+/**
+ * Request to rename an application.
+ * @category ManagementClient
+ */
+export interface ManagementRenameApplicationRequest {
+    /** The ID of the application to rename */
+    appId: string;
+    /** New name for the application */
+    name: string;
+}
 /**
  * Client for programmatic management of Squid organizations and applications.
  *
@@ -114,4 +134,20 @@ export declare class ManagementClient {
      * @throws Error if user is not admin or application not found
      */
     deleteApplication(appId: string): Promise<void>;
+    /**
+     * Renames an organization.
+     * Requires the user to be an admin in the organization.
+     *
+     * @param request - The rename request containing organizationId and new name
+     * @throws Error if user is not admin or organization not found
+     */
+    renameOrganization(request: ManagementRenameOrganizationRequest): Promise<void>;
+    /**
+     * Renames an application.
+     * Requires the user to be an admin in the application's organization.
+     *
+     * @param request - The rename request containing appId and new name
+     * @throws Error if user is not admin or application not found
+     */
+    renameApplication(request: ManagementRenameApplicationRequest): Promise<void>;
 }

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

@@ -149,6 +149,8 @@ export declare class Squid {
      * Returns the application ID of the current Squid instance.
      */
     get appId(): AppId;
+    /** Set to true if the client was destructured. */
+    get isDestructed(): boolean;
     /**
      * Returns the global Squid instance with the given options, creating a new instance if one with the same options
      * does not exist.
@@ -379,8 +381,6 @@ export declare class Squid {
      * @returns A promise that resolves when the destruct process is complete.
      */
     destruct(): Promise<void>;
-    /** Set to true if the client was destructured. */
-    get isDestructed(): boolean;
     /** Provides information about the connection to the Squid Server. */
     connectionDetails(): ConnectionDetails;
     /** Returns the notification client for handling (publishing and receiving) custom messages. */

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

package/package.json

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

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

@@ -1,9 +0,0 @@
-/**
- * Names of the Squid metrics.
- * Should be in sync with MetricName.kt.
- * See MetricName.kt for documentation on each value.
- */
-export declare const ALL_SQUID_METRIC_NAMES: readonly ["squid_functionExecution_count", "squid_functionExecution_time", "squid_aiChatbotContext_size", "squid_aiChatbotChatInputTokens_count", "squid_aiChatbotChatOutputTokens_count", "squid_aiChatbotChatOutcome_count", "squid_aiImageGeneration_count", "squid_aiImageGeneration_time", "squid_aiRemoveBackground_count", "squid_aiRemoveBackground_time", "squid_aiAudioTranscribe_count", "squid_aiAudioTranscribe_time", "squid_aiAudioCreateSpeech_count", "squid_aiAudioCreateSpeech_time", "squid_aiIntegrationData_count", "squid_aiIntegrationData_time", "squid_aiIntegrationApi_count", "squid_aiIntegrationApi_time", "squid_apiControllerCall_count", "squid_apiControllerCall_time", "squid_aiContextUpsert_count", "squid_aiContextDelete_count", "squid_codeInitialization_count", "squid_codeInitialization_time", "squid_deleteApiKey_count", "squid_deleteApiKey_time", "squid_deleteSecret_count", "squid_deleteSecret_time", "squid_discoverGraphQLConnectionSchema_count", "squid_discoverGraphQLConnectionSchema_time", "squid_discoverOpenApiSchema_count", "squid_discoverOpenApiSchema_time", "squid_discoverOpenApiSchemaFromFile_count", "squid_discoverOpenApiSchemaFromFile_time", "squid_executeBackendFunction_count", "squid_executeBackendFunction_time", "squid_getAiChatbotProfiles_count", "squid_getAiChatbotProfiles_time", "squid_getAllApiKeys_count", "squid_getAllApiKeys_time", "squid_getAllSecrets_count", "squid_getAllSecrets_time", "squid_getAppApiKey_count", "squid_getAppApiKey_time", "squid_getSecret_count", "squid_getSecret_time", "squid_graphql_count", "squid_graphql_time", "squid_graphqlQuery_count", "squid_graphqlQuery_time", "squid_integrationCount_value", "squid_acquireLock_count", "squid_releaseLock_count", "squid_mutate_count", "squid_mutate_time", "squid_metricQuery_count", "squid_metricQuery_time", "squid_metricReport_count", "squid_metricReport_time", "squid_nativeQuery_count", "squid_nativeQuery_time", "squid_openapi_count", "squid_openapi_time", "squid_produceTopicMessage_count", "squid_produceTopicMessage_time", "squid_query_count", "squid_query_time", "squid_registerQuery_count", "squid_registerQuery_time", "squid_rerankChunks_count", "squid_rerankChunks_time", "squid_schedulerJob_count", "squid_schedulerJob_time", "squid_schema_size", "squid_secrets_entries", "squid_storageDeleteFiles_count", "squid_storageDeleteFiles_time", "squid_storageGetDownloadUrl_count", "squid_storageGetDownloadUrl_time", "squid_storageGetFileMetadata_count", "squid_storageGetFileMetadata_time", "squid_storageListDirectoryContents_count", "squid_storageListDirectoryContents_time", "squid_storageUploadFile_count", "squid_storageUploadFile_time", "squid_subscribeToTopic_count", "squid_subscribeToTopic_time", "squid_testGraphQLConnection_count", "squid_testGraphQLConnection_time", "squid_testAgentProtocolConnection_count", "squid_testAgentProtocolConnection_time", "squid_trigger_count", "squid_trigger_time", "squid_upsertApiKey_count", "squid_upsertApiKey_time", "squid_upsertSecret_count", "squid_upsertSecret_time", "squid_vectorChunks_count", "squid_vectorChunks_time", "squid_webhook_count", "squid_webhook_time"];
-export type MetricName = (typeof ALL_SQUID_METRIC_NAMES)[number];
-/** Common prefix for all Squid metrics. */
-export declare const SQUID_METRIC_NAME_PREFIX = "squid_";

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

@@ -1,30 +0,0 @@
-import { ApiOptions } from '../public-types/api-client.public-types';
-import { ApiEndpointId, HttpMethod } from '../public-types/api.public-types';
-import { IntegrationId } from '../public-types/communication.public-types';
-/** The headers of an API call. */
-export type ApiHeaders = Record<string, string | number | boolean>;
-/** The context of an API call. */
-export declare class ApiCallContext {
-    readonly integrationId: IntegrationId;
-    readonly endpointId: ApiEndpointId;
-    readonly url: string;
-    readonly method: HttpMethod;
-    readonly body: unknown;
-    readonly options: ApiOptions;
-}
-/**
- * Represents a request to call an API through a specified integration and endpoint.
- * Includes optional method override and additional request options.
- */
-export interface CallApiRequest<BodyType = any> {
-    /** The identifier of the integration through which the API is called. */
-    integrationId: IntegrationId;
-    /** Target API endpoint to invoke. */
-    endpointId: ApiEndpointId;
-    /** Optional request payload. */
-    body?: BodyType;
-    /** Optional HTTP method override. Default is POST. */
-    overrideMethod?: HttpMethod;
-    /** Additional request options. */
-    options: ApiOptions;
-}

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

@@ -1,148 +0,0 @@
-import { SquidDocIdObj, SquidDocument } from '../public-types/document.public-types';
-import { Paths } from '../public-types/typescript.public-types';
-/**
- * The mutation type.
- * @category Database
- */
-export declare const MUTATION_TYPES: readonly ["insert", "update", "delete"];
-/**
- * @category Database
- */
-export type MutationType = (typeof MUTATION_TYPES)[number];
-interface BaseMutation {
-    type: MutationType;
-    squidDocIdObj: SquidDocIdObj;
-}
-/**
- * A mutation on a document.
- * @category Database
- */
-export type Mutation<T = any> = UpdateMutation<T> | InsertMutation<T> | DeleteMutation;
-/**
- * Represents a delete mutation on a document.
- * @category Database
- */
-export interface DeleteMutation extends BaseMutation {
-    /** Specifies that the mutation is a deletion. */
-    type: 'delete';
-}
-/**
- * Represents an update mutation on a document.
- * @category Database
- */
-export interface UpdateMutation<T = any> extends BaseMutation {
-    /** Specifies that the mutation is an update. */
-    type: 'update';
-    /** The updated properties */
-    properties: {
-        [key in keyof T & string]?: Array<PropertyMutation<T[key]>>;
-    };
-}
-/**
- * Represents an insert mutation on a document.
- * @category Database
- */
-export interface InsertMutation<T = any> extends BaseMutation {
-    /** Specifies that the mutation is an insertion. */
-    type: 'insert';
-    /** The inserted document */
-    properties: T;
-}
-/**
- * A representation of a single property update.
- * @category Database
- */
-export type PropertyMutation<Value = any> = ApplyNumericFnPropertyMutation | ApplyStringFnPropertyMutation | ValueUpdatePropertyMutation<Value> | RemovePropertyMutation;
-/**
- * A value update property mutation.
- * @category Database
- */
-export interface ValueUpdatePropertyMutation<Value = any> {
-    /** Specifies that the mutation updates a value. */
-    type: 'update';
-    /** New value to be set. */
-    value: Value;
-}
-/**
- * Applying a numeric function to a property.
- * @category Database
- */
-export interface ApplyNumericFnPropertyMutation {
-    /** Specifies that the mutation applies a numeric function. */
-    type: 'applyNumericFn';
-    /** Numeric function to apply. */
-    fn: 'increment';
-    /** Value to use in the numeric function. */
-    value: number;
-}
-/**
- * A property update that removes a property from a document.
- * @category Database
- */
-export interface RemovePropertyMutation {
-    /** Specifies that the mutation removes a property. */
-    type: 'removeProperty';
-}
-interface ApplyExtendString {
-    /** Specifies that the mutation applies a string function. */
-    type: 'applyStringFn';
-    /** String function to extend the existing string. */
-    fn: 'extendString';
-    /** String value to append. */
-    value: string;
-}
-interface ApplyTrimString {
-    /** Specifies that the mutation applies a string function. */
-    type: 'applyStringFn';
-    /** String function to trim the existing string. */
-    fn: 'trim';
-}
-/**
- * A property mutation that modifies a string.
- * @category Database
- */
-export type ApplyStringFnPropertyMutation = ApplyExtendString | ApplyTrimString;
-/**
- * The before and after documents of a document change.
- * @category Database
- */
-export interface BeforeAndAfterDocs<T = SquidDocument> {
-    /** Document state before the mutation. */
-    before: T | undefined;
-    /** Document state after the mutation. */
-    after: T | undefined;
-}
-/**
- * The mutation context that will be provided to the security function.
- * @category Database
- */
-export declare class MutationContext<T = any> {
-    readonly mutation: Mutation<T>;
-    readonly beforeAndAfterDocs: BeforeAndAfterDocs<T>;
-    readonly serverTimeStamp: Date;
-    /**
-     * Returns the state of the document before the mutation was applied.
-     */
-    get before(): T | undefined;
-    /**
-     * Returns the state of the document after the mutation was applied.
-     */
-    get after(): T | undefined;
-    /**
-     * Returns the type of the mutation (insert, update, or delete).
-     */
-    getMutationType(): MutationType;
-    /** Returns true if the mutation affects the provided path. */
-    affectsPath(path: Paths<T>): boolean;
-    /**
-     * Find all affected paths starting from a root path.
-     *
-     * @example
-     * doc before - { a: { b: 1, c: 2 }, d: 3 }
-     * doc after - { a: { b: 1, c: 3 }, d: 4 }
-     * doc.affectedPaths('a') // ['a.c']
-     */
-    affectedPaths(startingRoot?: Paths<T> | string): Array<Paths<T>>;
-    private checkPath;
-}
-export {};

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

@@ -1,72 +0,0 @@
-import { IntegrationId } from '../public-types/communication.public-types';
-/**
- * Represents the type of native query request, either relational, elastic or MongoDB.
- * @category Database
- */
-export type NativeQueryRequestType = 'relational' | 'mongo' | 'elasticsearch' | 'pure';
-interface BaseNativeQueryContext {
-    /** Type of the native query request. */
-    type: NativeQueryRequestType;
-    /** Identifier for the integration. */
-    integrationId: IntegrationId;
-}
-/**
- * Context for executing a relational database query.
- * @category Database
- */
-export interface RelationalNativeQueryContext extends BaseNativeQueryContext {
-    /** Specifies that the query is for a relational database. */
-    type: 'relational';
-    /** SQL query string to be executed. */
-    query: string;
-    /** Parameters to be used in the query. */
-    params: Record<string, any>;
-}
-/**
- * Context for executing a MongoDB query.
- * @category Database
- */
-export interface MongoNativeQueryContext extends BaseNativeQueryContext {
-    /** Specifies that the query is for a Mongo database. */
-    type: 'mongo';
-    /** Name of the MongoDB collection to query. */
-    collectionName: string;
-    /** Array of aggregation pipeline stages. */
-    aggregationPipeline: Array<any | undefined>;
-}
-/**
- * Context for executing an Elasticsearch query.
- * @category Database
- */
-export interface ElasticsearchNativeQueryContext {
-    /** Specifies that the query is for an Elasticsearch database. */
-    type: 'elasticsearch';
-    /** Elasticsearch index to query. */
-    index: string;
-    /** Elasticsearch query string. */
-    endpoint?: string;
-    /** HTTP method to use for the request. */
-    method?: 'GET' | 'POST';
-    /** Body of the request. */
-    body: Record<string, any>;
-    /** Headers to include in the request. */
-    integrationId: IntegrationId;
-}
-/**
- * Context for executing a pure database query.
- * @category Database
- */
-export interface PureNativeQueryContext extends BaseNativeQueryContext {
-    /** Specifies that the query is for a relational database. */
-    type: 'pure';
-    /** SQL query string to be executed. */
-    query: string;
-    /** Parameters to be used in the query. */
-    params: Record<string, any>;
-}
-/**
- * Union type representing either a relational or MongoDB native query context.
- * @category Database
- */
-export type NativeQueryContext = RelationalNativeQueryContext | MongoNativeQueryContext | ElasticsearchNativeQueryContext | PureNativeQueryContext;
-export {};