@squidcloud/client 1.0.483 → 1.0.484

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

@@ -0,0 +1,306 @@
+import { AiEmbeddingsModelWithOptionalFields, AiKnowledgeBase, AiKnowledgeBaseChatOptions, AiKnowledgeBaseContext, AiKnowledgeBaseContextRequest, AiKnowledgeBaseGraphContext, AiKnowledgeBaseGraphSearchOptions, AiKnowledgeBaseSearchResultChunk } from '../public-types/ai-knowledge-base.public-types';
+import { AiContextId, AiKnowledgeBaseId, AppId } from '../public-types/communication.public-types';
+import { DocumentExtractionMethod } from '../public-types/extraction.public-types';
+/**
+ * Internal (eval-harness-only) extension of the public graph search options. `graphOnly` returns just the
+ * graph channel's chunks (measures the graph's marginal recall) instead of the public `fused` behavior;
+ * it is not exposed in public-types because production callers always fuse. The graph channel accepts
+ * this shape at runtime, so eval specs cast their options to it. Themes-level "global" answering is NOT a
+ * search mode — it moved to the `globalSummary` op of `queryKnowledgeGraph`.
+ * @category AI
+ */
+export interface AiKnowledgeBaseGraphSearchOptionsInternal extends AiKnowledgeBaseGraphSearchOptions {
+    /** Internal/eval-only: `'graphOnly'` returns only the graph channel; `'fused'` (default) RRF-merges with hybrid. */
+    mode?: 'graphOnly' | 'fused';
+}
+/**
+ * Request structure for getting an AiKnowledgeBase
+ * @category AI
+ */
+export interface GetAiKnowledgeBaseRequest {
+    /** The id of the app */
+    appId: AppId;
+    /** The id of the AiKnowledgeBase */
+    knowledgeBaseId: AiKnowledgeBaseId;
+}
+/**
+ * Request structure for getting all AiKnowledgeBases
+ * @category AI
+ */
+export interface GetAiKnowledgeBasesRequest {
+    /** The id of the app */
+    appId: AppId;
+}
+/**
+ * Response structure for getting an AiKnowledgeBase
+ * @category AI
+ */
+export interface GetAiKnowledgeBaseResponse {
+    /** The resulting AiKnowledgeBase, if it is found */
+    knowledgeBase: AiKnowledgeBase | undefined;
+}
+/**
+ * Request structure for deleting an AiKnowledgeBase
+ * @category AI
+ */
+export interface DeleteAiKnowledgeBaseRequest {
+    /** The id of the AiKnowledgeBase */
+    id: string;
+}
+/**
+ * Request structure for upserting an AiKnowledgeBase
+ * @category AI
+ */
+export interface UpsertAiKnowledgeBaseRequest {
+    /** The AiKnowledgeBase to upsert */
+    knowledgeBase: Omit<AiEmbeddingsModelWithOptionalFields, 'appId' | 'updatedAt'>;
+}
+/**
+ * Response structure for listing AiKnowledgeBases
+ * @category AI
+ */
+export interface ListAiKnowledgeBasesResponse {
+    /** The list of AiKnowledgeBases */
+    knowledgeBases: Array<AiKnowledgeBase>;
+}
+/**
+ * Request structure for listing AiKnowledgeBaseContexts
+ * @category AI
+ * @deprecated Fetches every context in one call with no pagination — expensive for large knowledge
+ * bases. Use {@link ListAiKnowledgeBaseContextsPageRequest} instead.
+ */
+export interface ListAiKnowledgeBaseContextsRequest {
+    /** The id of the AiKnowledgeBase */
+    id: string;
+    /** The number of characters after which text is truncated. Optional */
+    truncateTextAfter?: number;
+}
+/**
+ * Response structure to list AiKnowledgeBaseContexts
+ * @category AI
+ * @deprecated See {@link ListAiKnowledgeBaseContextsRequest}.
+ */
+export interface ListAiKnowledgeBaseContextsResponse {
+    /** The list of AiKnowledgeBaseContexts */
+    contexts: Array<AiKnowledgeBaseContext>;
+}
+/**
+ * Response structure to list contextids for an AiKnowledgeBase
+ * @category AI
+ */
+export interface ListAiKnowledgeBaseContextIdsResponse {
+    /** The list of AiContextIds */
+    contextIds: Array<AiContextId>;
+}
+/**
+ * Request structure for deleting AiKnowledgeBaseContexts
+ * @category AI
+ */
+export interface DeleteAiKnowledgeBaseContextsRequest {
+    /** The id of the AiKnowledgeBase */
+    knowledgeBaseId: string;
+    /** An array of AiKnowledgeBaseContext ids */
+    contextIds: Array<string>;
+}
+/**
+ * Request structure for getting an AiKnowledgeBaseContext
+ * @category AI
+ */
+export interface GetAiKnowledgeBaseContextRequest {
+    /** The id of the AiKnowledgeBase */
+    knowledgeBaseId: string;
+    /** The id of the AiKnowledgeBaseContext */
+    contextId: string;
+}
+/**
+ * Request structure for getting a page of AiKnowledgeBaseContexts
+ * for a given knowledge base
+ * @category AI
+ */
+export interface GetAiKnowledgeBaseContextsRequest {
+    /** The id of the app */
+    appId: AppId;
+    /** The id of the AiKnowledgeBase */
+    knowledgeBaseId: AiKnowledgeBaseId;
+    /** The number of characters after which text is truncated. Optional */
+    truncateTextAfter?: number;
+    /** The number of contexts to skip, for pagination. Optional */
+    offset?: number;
+    /** The maximum number of contexts to return, for pagination. Optional */
+    limit?: number;
+    /** Case-insensitive substring search across id/title only. Optional */
+    search?: string;
+}
+/**
+ * Response structure for getting a page of AiKnowledgeBaseContexts for a given knowledge base
+ * @category AI
+ */
+export interface GetAiKnowledgeBaseContextsResponse {
+    /** The requested page of AiKnowledgeBaseContexts */
+    contexts: Array<AiKnowledgeBaseContext>;
+    /** The total number of contexts in the AiKnowledgeBase, ignoring offset/limit */
+    totalCount: number;
+}
+/**
+ * Response structure for getting an AiKnowledgeBaseContext
+ * @category AI
+ */
+export interface GetAiKnowledgeBaseContextResponse {
+    /** The resulting AiKnowledgeBaseContext, if it is found */
+    context: AiKnowledgeBaseContext | undefined;
+}
+/**
+ * Request structure for upserting context for an AiKnowledgeBase
+ * @category AI
+ */
+export interface UpsertAiKnowledgeBaseContextsRequest {
+    /** The id of the AiKnowledgeBase */
+    knowledgeBaseId: string;
+    /** The AiKnowledgeBaseContext data, which could be a file or text */
+    contextRequests: Array<AiKnowledgeBaseContextRequest>;
+    /** The job ID to use for the async upsert job */
+    jobId: string;
+}
+/**
+ * Response structure for searching an AiKnowledgeBase
+ * @category AI
+ */
+export interface AiKnowledgeBaseSearchResponse {
+    /** Array of result chunks from the search */
+    chunks: Array<AiKnowledgeBaseSearchResultChunk>;
+    /** Traversed subgraph for a `searchMode:'graph'` query with `includeGraphContext`; absent otherwise. */
+    graphContext?: AiKnowledgeBaseGraphContext;
+}
+export type { ExploreKnowledgeBaseGraphRequest, ExploreKnowledgeBaseGraphResponse, GetKnowledgeBaseGraphStatusRequest, GetKnowledgeBaseGraphStatusResponse, KnowledgeBaseGraphEdge, KnowledgeBaseGraphFacetStatus, KnowledgeBaseGraphModelUsage, KnowledgeBaseGraphNode, KnowledgeBaseGraphQueryConcepts, KnowledgeBaseGraphQueryDoc, KnowledgeBaseGraphQueryGlobalSummary, KnowledgeBaseGraphQueryMatch, KnowledgeBaseGraphQueryOp, KnowledgeBaseGraphQueryPath, KnowledgeBaseGraphQuerySubtreeNode, KnowledgeBaseGraphRebuildMode, KnowledgeBaseGraphTopic, KnowledgeBaseGraphTopicEdge, KnowledgeBaseGraphUsage, QueryKnowledgeBaseGraphRequest, QueryKnowledgeBaseGraphResponse, RebuildKnowledgeBaseGraphRequest, } from '../public-types/ai-knowledge-base.public-types';
+/**
+ * Request structure for getting the size of context
+ * for an AiKnowledgeBase
+ * @category AI
+ */
+export interface AiKnowledgeBaseContextSizeRequest {
+    /** The ID of the App */
+    appId: AppId;
+    /** The ID of the AIKnowledgeBase */
+    knowledgeBaseId: AiKnowledgeBaseId;
+}
+/**
+ * Request structure for the internal test-only route that arms the next `count` grep scans of a
+ * knowledge base to fail at their `maxTimeMS` deadline.
+ */
+export interface AiKnowledgeBaseFailNextGrepScansRequest {
+    /** The ID of the App */
+    appId: AppId;
+    /** The ID of the AIKnowledgeBase */
+    knowledgeBaseId: AiKnowledgeBaseId;
+    /** How many upcoming scans fail; a non-positive value disarms. */
+    count: number;
+}
+/**
+ * Request structure for identifying a knowledge base to reimport the context files (when possible).
+ */
+export interface AiKnowledgeBaseReimportAllFilesRequest {
+    /** The ID of the AIKnowledgeBase */
+    knowledgeBaseId: AiKnowledgeBaseId;
+}
+/**
+ * Request structure for identifying a knowledge base to reimport the context files (when possible).
+ */
+export interface AiKnowledgeBaseReimportFilesRequest {
+    /** The ID of the AIKnowledgeBase */
+    knowledgeBaseId: AiKnowledgeBaseId;
+    /** The ids of the AiKnowledgeBaseContexts to reimport */
+    contextIds: Array<string>;
+}
+/** Longest context batch one `backfillFulltext` call accepts; larger work-lists are split by the caller. */
+export declare const BACKFILL_FULLTEXT_MAX_CONTEXTS_PER_CALL = 20;
+/**
+ * Request structure for rebuilding the stored raw text (`kb_fulltext`) of existing contexts from their
+ * stored source files, without re-ingesting them — no chunk, embedding or graph writes. This is how
+ * contexts ingested before literal search existed become greppable.
+ */
+export interface AiKnowledgeBaseBackfillFulltextRequest {
+    /** The ID of the AIKnowledgeBase */
+    knowledgeBaseId: AiKnowledgeBaseId;
+    /**
+     * The ids of the contexts to backfill, at most {@link BACKFILL_FULLTEXT_MAX_CONTEXTS_PER_CALL} per
+     * call. Each context's stored text is fully replaced, so re-running a context is safe.
+     */
+    contextIds: Array<AiContextId>;
+    /**
+     * The extraction method for file contexts. Defaults to the server's regular document extraction
+     * default (OCR when configured), which reproduces the text the ingest pipeline indexed — including
+     * scanned pages. `legacy` extracts in-process without any external model call, but yields nothing for
+     * scanned pages, so a caller choosing it must compare the stored part counts against expectations.
+     */
+    extractionMethod?: DocumentExtractionMethod;
+    /**
+     * A context that already has stored text is SKIPPED unless this is true. The backfill rebuilds
+     * literal text only, while ingest also stores image/OCR-description parts — so replacing a context
+     * that ingest populated would silently delete its description text from the literal index. Set this
+     * only to deliberately re-extract contexts this backfill itself populated (e.g. retrying a thin
+     * `legacy` yield with OCR).
+     */
+    overwrite?: boolean;
+}
+/**
+ * Response structure for a `backfillFulltext` call: one status per requested context, in request order.
+ */
+export interface AiKnowledgeBaseBackfillFulltextResponse {
+    statuses: Array<AiKnowledgeBaseBackfillFulltextStatus>;
+}
+/**
+ * Outcome of backfilling the raw text of one context.
+ */
+export interface AiKnowledgeBaseBackfillFulltextStatus {
+    contextId: AiContextId;
+    /** `skipped` means the context already has stored text and `overwrite` was not set; nothing changed. */
+    status: 'success' | 'error' | 'skipped';
+    /**
+     * How many parts (pages/sheets) were stored, on success. Zero means extraction yielded no text at
+     * all — for a `legacy` run over a scanned document that is the expected signal to retry with OCR.
+     */
+    storedPartCount?: number;
+    errorMessage?: string;
+}
+/**
+ * Response structure for getting size of context
+ * @category AI
+ */
+export interface AiKnowledgeBaseContextSizeResponse {
+    /** Size of context bytes, as a number */
+    sizeBytes: number;
+}
+/**
+ * Request structure for getting the values vector of
+ * a specific context
+ *
+ * @category AI
+ */
+export interface AiKnowledgeBaseValueVectorRequest {
+    /** The ID of the App */
+    appId: AppId;
+    /** The ID of the AIKnowledgeBase */
+    knowledgeBaseId: AiKnowledgeBaseId;
+    /** The ID of the context */
+    contextId: AiContextId;
+}
+/**
+ * Response structure for getting values vector of a
+ * specific context
+ * @category AI
+ */
+export interface AiKnowledgeBaseValueVectorResponse {
+    /** The vector */
+    vector: number[];
+}
+export interface AiKnowledgeBaseChatRequest {
+    knowledgeBaseId: AiKnowledgeBaseId;
+    prompt?: string;
+    options?: AiKnowledgeBaseChatOptions;
+}
+/** Emitted to the console queue when a knowledge base or its contexts change. */
+export interface KbChangeEvent {
+    appId: AppId;
+    knowledgeBaseId: AiKnowledgeBaseId;
+    changeType: 'kb' | 'context';
+}

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

@@ -0,0 +1,19 @@
+import { MmEntity, MmMatchMaker } from '../public-types/ai-matchmaking.public-types';
+/**
+ * Internal-only matchmaking request shapes. Every other request/response of the matchmaking wire
+ * contract is declared in `ai-matchmaking.public-types` and imported directly from there.
+ */
+export interface MmCreateMatchMakerRequest {
+    matchMaker: MmMatchMaker;
+}
+export interface MmGetMatchMakerRequest {
+    matchMakerId: string;
+}
+export interface MmInsertEntityRequest {
+    matchMakerId: string;
+    entity: MmEntity;
+}
+export interface MmGetEntityRequest {
+    matchMakerId: string;
+    entityId: string;
+}

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,41 @@
+/** 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";
+    /**
+     * Response-only: IP of the tenant pod that served the request, i.e. the address to reach it at
+     * again. Core records it to route subsequent affinity-keyed calls to the same pod. Absent when the
+     * pod does not know its own IP.
+     */
+    readonly POD_IP: "x-squid-pod-ip";
+    /**
+     * Response-only: identity of the tenant process that served the request. Distinct from
+     * {@link POD_IP}, which is an address and is reused: Kubernetes hands the IP of a deleted pod to a
+     * new one, so only this value tells core whether it is still talking to the same instance.
+     */
+    readonly INSTANCE_ID: "x-squid-instance-id";
+    /**
+     * Request-only: the {@link INSTANCE_ID} core believes it is calling, sent when routing directly to a
+     * pinned pod instead of through the tenant service. The receiving instance refuses the request when
+     * the value is not its own — the pod at that address may have been replaced, possibly by a pod of a
+     * different application.
+     */
+    readonly EXPECTED_INSTANCE_ID: "x-squid-expected-instance-id";
+    /**
+     * Response-only: key of the tenant worker that served the request, reported separately from
+     * {@link POD_IP} so core alone decides whether to pin at pod or at worker granularity.
+     */
+    readonly WORKER_KEY: "x-squid-worker-key";
+};

package/dist/internal-common/src/types/management-api-key.types.d.ts

@@ -0,0 +1,92 @@
+/**
+ * Status lifecycle for management API keys.
+ * Keys must be suspended before they can be deleted.
+ * @category ManagementApiKey
+ */
+export type ManagementApiKeyStatus = 'active' | 'suspended' | 'deleted';
+/**
+ * Prefix for all management API keys.
+ * Used to identify and validate management keys.
+ * @category ManagementApiKey
+ */
+export declare const MANAGEMENT_API_KEY_PREFIX = "squid_mgmt_";
+/**
+ * Represents a user-level management API key.
+ * These keys provide programmatic access to manage organizations and applications
+ * where the user is an admin.
+ * @category ManagementApiKey
+ */
+export interface ManagementApiKey {
+    /** Unique identifier for the API key */
+    id: string;
+    /** The user ID who owns this key */
+    userId: string;
+    /** Optional description for the key */
+    description?: string;
+    /** Current status of the key */
+    status: ManagementApiKeyStatus;
+    /** Timestamp when the key was created */
+    createdAt: Date;
+    /** Timestamp when the key was last updated */
+    updatedAt: Date;
+    /** Timestamp when the key was last used, if ever */
+    lastUsedAt?: Date;
+}
+/**
+ * Request to create a new management API key.
+ * @category ManagementApiKey
+ */
+export interface CreateManagementApiKeyRequest {
+    /** Optional description for the key */
+    description?: string;
+}
+/**
+ * Response when creating a new management API key.
+ * The keyValue is only returned once during creation.
+ * @category ManagementApiKey
+ */
+export interface CreateManagementApiKeyResponse {
+    /** The created key metadata */
+    key: ManagementApiKey;
+    /** The raw key value (only returned once during creation) */
+    keyValue: string;
+}
+/**
+ * Request to update a management API key's status.
+ * @category ManagementApiKey
+ */
+export interface UpdateManagementApiKeyRequest {
+    /** The ID of the key to update */
+    keyId: string;
+    /** New status (can only toggle between active and suspended) */
+    status: 'active' | 'suspended';
+}
+/**
+ * Request to delete a management API key.
+ * The key must be suspended before deletion.
+ * @category ManagementApiKey
+ */
+export interface DeleteManagementApiKeyRequest {
+    /** The ID of the key to delete */
+    keyId: string;
+}
+/**
+ * Response containing a list of user's management API keys.
+ * @category ManagementApiKey
+ */
+export interface ListManagementApiKeysResponse {
+    /** List of management API keys (without key values) */
+    keys: ManagementApiKey[];
+}
+/**
+ * Response from validating a management API key.
+ * @category ManagementApiKey
+ */
+export interface ValidateManagementApiKeyResponse {
+    /** Whether the key is valid and active */
+    valid: boolean;
+    /** The user ID associated with the key (if valid) */
+    userId?: string;
+    /** The key ID (if valid) */
+    keyId?: string;
+}

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,168 @@
+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;
+    readonly acquireLock: ObservableNameMetrics;
+    readonly releaseLock: ObservableNameMetrics;
+    /**
+     * Timing and count for '/observability/metrics' endpoint calls used to report batch of metrics.
+     */
+    readonly metricReport: ObservableNameMetrics;
+    /**
+     * Timing and count for '/observability/metrics/query' endpoint calls used to query metrics.
+     */
+    readonly metricQuery: ObservableNameMetrics;
+    readonly storageUploadFile: ObservableNameMetrics;
+    readonly storageGetFileMetadata: ObservableNameMetrics;
+    readonly storageGetDownloadUrl: ObservableNameMetrics;
+    readonly storageDeleteFiles: ObservableNameMetrics;
+    readonly storageListDirectoryContents: ObservableNameMetrics;
+    readonly produceTopicMessage: ObservableNameMetrics;
+    readonly subscribeToTopic: ObservableNameMetrics;
+    readonly queueMessageHandler: ObservableNameMetrics;
+    readonly schedulerJob: ObservableNameMetrics;
+    readonly eventHandler: ObservableNameMetrics;
+    readonly webhook: ObservableNameMetrics;
+    readonly openapi: ObservableNameMetrics;
+    readonly executeBackendFunction: ObservableNameMetrics;
+    readonly apiControllerCall: 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>;
+}
+/** Agent audit log entry - one per agent invocation */
+export interface AgentAuditLogEvent {
+    appId: AppId;
+    /** Agent ID (nullable for query-with-AI operations without an agent) */
+    agentId?: string;
+    jobId: string;
+    prompt: string;
+    /** Fully assembled system instructions sent to the LLM; set only when the agent enables auditLogFullContext. */
+    systemInstructions?: string;
+    tags: Record<string, string>;
+    createdAt: Date;
+    /** Integration ID for query-with-AI operations (nullable, used when not invoked via agent) */
+    integrationId?: string;
+}
+export type AgentAuditLogUpdateType = 'statusUpdate' | 'response';
+/** Usage metric for AI model input/output — either token count or character count depending on provider. */
+export interface AiUsageMetric {
+    unit: 'tokens' | 'characters';
+    value: number;
+}
+/** Agent audit log update entry - status updates and responses for agent invocations */
+export interface AgentAuditLogUpdateEvent {
+    appId: AppId;
+    /** Agent ID (nullable for query-with-AI operations without an agent) */
+    agentId?: string;
+    jobId: string;
+    statusUpdateId: string;
+    title: string;
+    parentStatusUpdateId?: string;
+    tags: Record<string, string>;
+    body: string;
+    type: AgentAuditLogUpdateType;
+    createdAt: Date;
+    /** Integration ID for query-with-AI operations (nullable, used when not invoked via agent) */
+    integrationId?: string;
+    /** Input usage metric (tokens or characters depending on provider). */
+    inputUsage?: AiUsageMetric;
+    /** Output usage metric (tokens or characters depending on provider). */
+    outputUsage?: AiUsageMetric;
+    /** Reasoning tokens consumed (where the provider reports them separately from output tokens). */
+    reasoningTokens?: number;
+    /** Number of input tokens served from the provider's prompt cache (read hits). */
+    cacheReadInputTokens?: number;
+    /** Number of input tokens written into the provider's prompt cache (cache misses that created new entries). */
+    cacheWriteInputTokens?: number;
+}
+/** 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";
+/** Tag for AI KnowledgeBase events */
+export declare const O11Y_TAG_AI_KNOWLEDGE_BASE_MODEL = "aiKnowledgeBaseModel";
+export declare const O11Y_TAG_API_KEY_SOURCE = "apiKeySource";
+export declare const O11Y_TAG_AI_JOB_ID = "aiJobId";
+/** Tag prefix for client-provided metric annotations (see BaseAiChatOptions.metricAnnotations). */
+export declare const O11Y_TAG_METRIC_ANNOTATION_PREFIX = "annotation.";
+/** Maximum number of AI usage annotation entries kept per call; extra entries are dropped. */
+export declare const MAX_METRIC_ANNOTATIONS = 10;
+/** Maximum length of an AI usage annotation key; longer keys are dropped. */
+export declare const MAX_METRIC_ANNOTATION_KEY_LENGTH = 64;
+/** Maximum length of an AI usage annotation value; longer values are truncated. */
+export declare const MAX_METRIC_ANNOTATION_VALUE_LENGTH = 256;
+/**
+ * Sanitizes client-provided metric annotations: caps the number of entries, drops empty or
+ * oversized keys, and truncates oversized values. Returns undefined when nothing valid remains.
+ */
+export declare function sanitizeMetricAnnotations(annotations: Record<string, string> | undefined): Record<string, string> | undefined;
+/** 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";
+/** Tag for the trace ID. Used in logs. */
+export declare const O11Y_TAG_TRACE_ID = "trace_id";
+/** Tag for the span ID. Used in logs. */
+export declare const O11Y_TAG_SPAN_ID = "span_id";
+/**
+ * Tag carrying Squid's own correlation id (the `n_`/`c_`/`k_` short id minted by
+ * `generateTraceId`). Distinct from `trace_id`/`span_id`, which hold the W3C ids from OTel.
+ * Rides W3C baggage under the same key on internal hops; attached to spans and logs.
+ */
+export declare const O11Y_TAG_SQUID_TRACE_ID = "squid_tid";
+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,15 @@
+import { Condition, DocIdCondition, 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;
+/** Returns true if the condition is a 'DocIdCondition' or false otherwise. */
+export declare function isDocIdCondition(condition: Condition): condition is DocIdCondition;

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;
+}