@squidcloud/client 1.0.469 → 1.0.470

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (44) hide show
  1. package/dist/cjs/index.js +1 -1
  2. package/dist/esm/index.js +1 -1
  3. package/dist/internal-common/src/public-types/ai-agent.public-types.d.ts +13 -0
  4. package/dist/internal-common/src/public-types/ai-common.public-types.d.ts +23 -0
  5. package/dist/typescript-client/src/ai-client.d.ts +4 -2
  6. package/dist/typescript-client/src/version.d.ts +1 -1
  7. package/package.json +1 -1
  8. package/dist/internal-common/src/metric-name.d.ts +0 -14
  9. package/dist/internal-common/src/public-types-backend/api-call.public-context.d.ts +0 -30
  10. package/dist/internal-common/src/public-types-backend/mutation.public-context.d.ts +0 -148
  11. package/dist/internal-common/src/public-types-backend/native-query.public-context.d.ts +0 -72
  12. package/dist/internal-common/src/public-types-backend/query.public-context.d.ts +0 -190
  13. package/dist/internal-common/src/types/ai-agent.types.d.ts +0 -240
  14. package/dist/internal-common/src/types/ai-knowledge-base.types.d.ts +0 -202
  15. package/dist/internal-common/src/types/ai-matchmaking.types.d.ts +0 -59
  16. package/dist/internal-common/src/types/backend-function.types.d.ts +0 -1
  17. package/dist/internal-common/src/types/communication.types.d.ts +0 -1
  18. package/dist/internal-common/src/types/document.types.d.ts +0 -1
  19. package/dist/internal-common/src/types/file.types.d.ts +0 -6
  20. package/dist/internal-common/src/types/headers.types.d.ts +0 -17
  21. package/dist/internal-common/src/types/management-api-key.types.d.ts +0 -92
  22. package/dist/internal-common/src/types/mutation.types.d.ts +0 -1
  23. package/dist/internal-common/src/types/notification.types.d.ts +0 -5
  24. package/dist/internal-common/src/types/observability.types.d.ts +0 -135
  25. package/dist/internal-common/src/types/query.types.d.ts +0 -15
  26. package/dist/internal-common/src/types/secret.types.d.ts +0 -7
  27. package/dist/internal-common/src/types/socket.types.d.ts +0 -1
  28. package/dist/internal-common/src/types/stage.d.ts +0 -9
  29. package/dist/internal-common/src/types/time-units.d.ts +0 -1
  30. package/dist/internal-common/src/types/url-shortener.types.d.ts +0 -45
  31. package/dist/internal-common/src/utils/array.d.ts +0 -7
  32. package/dist/internal-common/src/utils/e2e-test-utils.d.ts +0 -2
  33. package/dist/internal-common/src/utils/file-utils.d.ts +0 -2
  34. package/dist/internal-common/src/utils/global.utils.d.ts +0 -1
  35. package/dist/internal-common/src/utils/http.d.ts +0 -11
  36. package/dist/internal-common/src/utils/lock.manager.d.ts +0 -14
  37. package/dist/internal-common/src/utils/metric-utils.d.ts +0 -4
  38. package/dist/internal-common/src/utils/metrics.types.d.ts +0 -7
  39. package/dist/internal-common/src/utils/object.d.ts +0 -86
  40. package/dist/internal-common/src/utils/serialization.d.ts +0 -18
  41. package/dist/internal-common/src/utils/squid.constants.d.ts +0 -6
  42. package/dist/internal-common/src/utils/trace-id-generator.d.ts +0 -1
  43. package/dist/internal-common/src/utils/validation.d.ts +0 -19
  44. package/dist/internal-common/src/websocket.impl.d.ts +0 -26
@@ -1041,9 +1041,22 @@ export interface ListAgentsResponse {
1041
1041
  /** All AI agents defined for the application. */
1042
1042
  agents: Array<AiAgent>;
1043
1043
  }
1044
+ /**
1045
+ * Request options for listing the chat models available to an application.
1046
+ * @category AI
1047
+ */
1048
+ export interface ListChatModelsRequest {
1049
+ /**
1050
+ * When true, deprecated vendor models (those with `replacedBy`) are included.
1051
+ * Defaults to false (only active models are returned).
1052
+ */
1053
+ includeDeprecated?: boolean;
1054
+ }
1044
1055
  /**
1045
1056
  * Response containing the list of chat models available to an application.
1046
1057
  * Includes both Squid-provided vendor models and any custom integration models.
1058
+ * Vendor models carry a human-readable `description`. Deprecated vendor models are
1059
+ * included only when requested via `includeDeprecated` and are marked with `replacedBy`.
1047
1060
  * @category AI
1048
1061
  */
1049
1062
  export interface ListChatModelsResponse {
@@ -206,6 +206,15 @@ export type StableDiffusionModelName = (typeof STABLE_DIFFUSION_MODEL_NAMES)[num
206
206
  * @category AI
207
207
  */
208
208
  export type FluxModelName = (typeof FLUX_MODEL_NAMES)[number];
209
+ /**
210
+ * Where a chat model offered to an app comes from. See {@link ModelIdSpec.source}.
211
+ * @category AI
212
+ */
213
+ export declare const AI_MODEL_SOURCES: readonly ["vendor", "connector", "custom"];
214
+ /**
215
+ * @category AI
216
+ */
217
+ export type AiModelSource = (typeof AI_MODEL_SOURCES)[number];
209
218
  /** Represents an AI model. */
210
219
  export interface ModelIdSpec {
211
220
  /** The model ID used for API calls. */
@@ -214,6 +223,20 @@ export interface ModelIdSpec {
214
223
  integrationId?: string;
215
224
  /** Human-readable display name for the model (e.g. "GPT-4o"). */
216
225
  displayName?: string;
226
+ /** Short human-readable description of the model. Undefined for custom integration models. */
227
+ description?: string;
228
+ /**
229
+ * Set only for deprecated models: the active model that calls to this model are routed to.
230
+ * Undefined for active models.
231
+ */
232
+ replacedBy?: AiChatModelName;
233
+ /**
234
+ * Where the model comes from. Always set on `listChatModels()` results:
235
+ * - 'vendor': a Squid-provided model from the vendor model registry.
236
+ * - 'connector': provided by an integration configured on the app (OpenAI-compatible, Bedrock, Vertex).
237
+ * - 'custom': a user-added model from the app's bundle (e.g. CLI agent models like Claude Code or Codex).
238
+ */
239
+ source?: AiModelSource;
217
240
  }
218
241
  /**
219
242
  * Type guard to check if a model selection is integration-based.
@@ -8,7 +8,7 @@ import { AiFilesClient } from './ai-files-client';
8
8
  import { AiImageClient } from './ai-image-client';
9
9
  import { AiKnowledgeBaseReference } from './ai-knowledge-base/ai-knowledge-base-client-reference';
10
10
  import { AiMatchMakingClient } from './ai-matchmaking-client';
11
- import { AiAgent, AiAgentApiIntegrationOptions, AiAgentId, AiFileProviderType, AiKnowledgeBase, AiKnowledgeBaseId, AiProviderType, AiSessionContext, AiStatusMessage, ApplicationAiSettings, IntegrationId, JobId, ModelIdSpec, SecretKey } from './public-types';
11
+ import { AiAgent, AiAgentApiIntegrationOptions, AiAgentId, AiFileProviderType, AiKnowledgeBase, AiKnowledgeBaseId, AiProviderType, AiSessionContext, AiStatusMessage, ApplicationAiSettings, IntegrationId, JobId, ListChatModelsRequest, ModelIdSpec, SecretKey } from './public-types';
12
12
  /**
13
13
  * AiClient class serves as a facade for interacting with different AI services.
14
14
  * It provides simplified access to AI chatbot and assistant functionalities
@@ -47,8 +47,10 @@ export declare class AiClient {
47
47
  /**
48
48
  * Returns a list of all available AI chat models.
49
49
  * Includes both Squid-provided vendor models and custom integration models.
50
+ * Vendor models carry a human-readable `description`. Deprecated vendor models are
51
+ * included only when `options.includeDeprecated` is true and are marked with `replacedBy`.
50
52
  */
51
- listChatModels(): Promise<ModelIdSpec[]>;
53
+ listChatModels(options?: ListChatModelsRequest): Promise<ModelIdSpec[]>;
52
54
  /**
53
55
  * Retrieves an AI image client.
54
56
  */
@@ -2,4 +2,4 @@
2
2
  * The current version of the SquidCloud client package.
3
3
  * @category Platform
4
4
  */
5
- export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.469";
5
+ export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.470";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@squidcloud/client",
3
- "version": "1.0.469",
3
+ "version": "1.0.470",
4
4
  "description": "A typescript implementation of the Squid client",
5
5
  "main": "dist/cjs/index.js",
6
6
  "module": "dist/esm/index.js",
@@ -1,14 +0,0 @@
1
- /**
2
- * Names of the Squid metrics.
3
- *
4
- * This list and its Kotlin counterpart (MetricName.kt) may diverge:
5
- * each side declares only the metrics that its own backend emits.
6
- * However, metrics emitted by both backends MUST use identical names on both sides —
7
- * otherwise dashboards and metric queries that mix data from both sources will break.
8
- *
9
- * See MetricName.kt for documentation on each value.
10
- */
11
- 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_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", "squid_acquireLock_count", "squid_acquireLock_time", "squid_releaseLock_count", "squid_releaseLock_time"];
12
- export type MetricName = (typeof ALL_SQUID_METRIC_NAMES)[number];
13
- /** Common prefix for all Squid metrics. */
14
- export declare const SQUID_METRIC_NAME_PREFIX = "squid_";
@@ -1,30 +0,0 @@
1
- import { ApiOptions } from '../public-types/api-client.public-types';
2
- import { ApiEndpointId, HttpMethod } from '../public-types/api.public-types';
3
- import { IntegrationId } from '../public-types/communication.public-types';
4
- /** The headers of an API call. */
5
- export type ApiHeaders = Record<string, string | number | boolean>;
6
- /** The context of an API call. */
7
- export declare class ApiCallContext {
8
- readonly integrationId: IntegrationId;
9
- readonly endpointId: ApiEndpointId;
10
- readonly url: string;
11
- readonly method: HttpMethod;
12
- readonly body: unknown;
13
- readonly options: ApiOptions;
14
- }
15
- /**
16
- * Represents a request to call an API through a specified integration and endpoint.
17
- * Includes optional method override and additional request options.
18
- */
19
- export interface CallApiRequest<BodyType = any> {
20
- /** The identifier of the integration through which the API is called. */
21
- integrationId: IntegrationId;
22
- /** Target API endpoint to invoke. */
23
- endpointId: ApiEndpointId;
24
- /** Optional request payload. */
25
- body?: BodyType;
26
- /** Optional HTTP method override. Default is POST. */
27
- overrideMethod?: HttpMethod;
28
- /** Additional request options. */
29
- options: ApiOptions;
30
- }
@@ -1,148 +0,0 @@
1
- import { SquidDocIdObj, SquidDocument } from '../public-types/document.public-types';
2
- import { Paths } from '../public-types/typescript.public-types';
3
- /**
4
- * The mutation type.
5
- * @category Database
6
- */
7
- export declare const MUTATION_TYPES: readonly ["insert", "update", "delete"];
8
- /**
9
- * @category Database
10
- */
11
- export type MutationType = (typeof MUTATION_TYPES)[number];
12
- interface BaseMutation {
13
- type: MutationType;
14
- squidDocIdObj: SquidDocIdObj;
15
- }
16
- /**
17
- * A mutation on a document.
18
- * @category Database
19
- */
20
- export type Mutation<T = any> = UpdateMutation<T> | InsertMutation<T> | DeleteMutation;
21
- /**
22
- * Represents a delete mutation on a document.
23
- * @category Database
24
- */
25
- export interface DeleteMutation extends BaseMutation {
26
- /** Specifies that the mutation is a deletion. */
27
- type: 'delete';
28
- }
29
- /**
30
- * Represents an update mutation on a document.
31
- * @category Database
32
- */
33
- export interface UpdateMutation<T = any> extends BaseMutation {
34
- /** Specifies that the mutation is an update. */
35
- type: 'update';
36
- /** The updated properties */
37
- properties: {
38
- [key in keyof T & string]?: Array<PropertyMutation<T[key]>>;
39
- };
40
- }
41
- /**
42
- * Represents an insert mutation on a document.
43
- * @category Database
44
- */
45
- export interface InsertMutation<T = any> extends BaseMutation {
46
- /** Specifies that the mutation is an insertion. */
47
- type: 'insert';
48
- /** The inserted document */
49
- properties: T;
50
- }
51
- /**
52
- * A representation of a single property update.
53
- * @category Database
54
- */
55
- export type PropertyMutation<Value = any> = ApplyNumericFnPropertyMutation | ApplyStringFnPropertyMutation | ValueUpdatePropertyMutation<Value> | RemovePropertyMutation;
56
- /**
57
- * A value update property mutation.
58
- * @category Database
59
- */
60
- export interface ValueUpdatePropertyMutation<Value = any> {
61
- /** Specifies that the mutation updates a value. */
62
- type: 'update';
63
- /** New value to be set. */
64
- value: Value;
65
- }
66
- /**
67
- * Applying a numeric function to a property.
68
- * @category Database
69
- */
70
- export interface ApplyNumericFnPropertyMutation {
71
- /** Specifies that the mutation applies a numeric function. */
72
- type: 'applyNumericFn';
73
- /** Numeric function to apply. */
74
- fn: 'increment';
75
- /** Value to use in the numeric function. */
76
- value: number;
77
- }
78
- /**
79
- * A property update that removes a property from a document.
80
- * @category Database
81
- */
82
- export interface RemovePropertyMutation {
83
- /** Specifies that the mutation removes a property. */
84
- type: 'removeProperty';
85
- }
86
- interface ApplyExtendString {
87
- /** Specifies that the mutation applies a string function. */
88
- type: 'applyStringFn';
89
- /** String function to extend the existing string. */
90
- fn: 'extendString';
91
- /** String value to append. */
92
- value: string;
93
- }
94
- interface ApplyTrimString {
95
- /** Specifies that the mutation applies a string function. */
96
- type: 'applyStringFn';
97
- /** String function to trim the existing string. */
98
- fn: 'trim';
99
- }
100
- /**
101
- * A property mutation that modifies a string.
102
- * @category Database
103
- */
104
- export type ApplyStringFnPropertyMutation = ApplyExtendString | ApplyTrimString;
105
- /**
106
- * The before and after documents of a document change.
107
- * @category Database
108
- */
109
- export interface BeforeAndAfterDocs<T = SquidDocument> {
110
- /** Document state before the mutation. */
111
- before: T | undefined;
112
- /** Document state after the mutation. */
113
- after: T | undefined;
114
- }
115
- /**
116
- * The mutation context that will be provided to the security function.
117
- * @category Database
118
- */
119
- export declare class MutationContext<T = any> {
120
- readonly mutation: Mutation<T>;
121
- readonly beforeAndAfterDocs: BeforeAndAfterDocs<T>;
122
- readonly serverTimeStamp: Date;
123
- /**
124
- * Returns the state of the document before the mutation was applied.
125
- */
126
- get before(): T | undefined;
127
- /**
128
- * Returns the state of the document after the mutation was applied.
129
- */
130
- get after(): T | undefined;
131
- /**
132
- * Returns the type of the mutation (insert, update, or delete).
133
- */
134
- getMutationType(): MutationType;
135
- /** Returns true if the mutation affects the provided path. */
136
- affectsPath(path: Paths<T>): boolean;
137
- /**
138
- * Find all affected paths starting from a root path.
139
- *
140
- * @example
141
- * doc before - { a: { b: 1, c: 2 }, d: 3 }
142
- * doc after - { a: { b: 1, c: 3 }, d: 4 }
143
- * doc.affectedPaths('a') // ['a.c']
144
- */
145
- affectedPaths(startingRoot?: Paths<T> | string): Array<Paths<T>>;
146
- private checkPath;
147
- }
148
- export {};
@@ -1,72 +0,0 @@
1
- import { IntegrationId } from '../public-types/communication.public-types';
2
- /**
3
- * Represents the type of native query request, either relational, elastic or MongoDB.
4
- * @category Database
5
- */
6
- export type NativeQueryRequestType = 'relational' | 'mongo' | 'elasticsearch' | 'pure';
7
- interface BaseNativeQueryContext {
8
- /** Type of the native query request. */
9
- type: NativeQueryRequestType;
10
- /** Identifier for the integration. */
11
- integrationId: IntegrationId;
12
- }
13
- /**
14
- * Context for executing a relational database query.
15
- * @category Database
16
- */
17
- export interface RelationalNativeQueryContext extends BaseNativeQueryContext {
18
- /** Specifies that the query is for a relational database. */
19
- type: 'relational';
20
- /** SQL query string to be executed. */
21
- query: string;
22
- /** Parameters to be used in the query. */
23
- params: Record<string, any>;
24
- }
25
- /**
26
- * Context for executing a MongoDB query.
27
- * @category Database
28
- */
29
- export interface MongoNativeQueryContext extends BaseNativeQueryContext {
30
- /** Specifies that the query is for a Mongo database. */
31
- type: 'mongo';
32
- /** Name of the MongoDB collection to query. */
33
- collectionName: string;
34
- /** Array of aggregation pipeline stages. */
35
- aggregationPipeline: Array<any | undefined>;
36
- }
37
- /**
38
- * Context for executing an Elasticsearch query.
39
- * @category Database
40
- */
41
- export interface ElasticsearchNativeQueryContext {
42
- /** Specifies that the query is for an Elasticsearch database. */
43
- type: 'elasticsearch';
44
- /** Elasticsearch index to query. */
45
- index: string;
46
- /** Elasticsearch query string. */
47
- endpoint?: string;
48
- /** HTTP method to use for the request. */
49
- method?: 'GET' | 'POST';
50
- /** Body of the request. */
51
- body: Record<string, any>;
52
- /** Headers to include in the request. */
53
- integrationId: IntegrationId;
54
- }
55
- /**
56
- * Context for executing a pure database query.
57
- * @category Database
58
- */
59
- export interface PureNativeQueryContext extends BaseNativeQueryContext {
60
- /** Specifies that the query is for a relational database. */
61
- type: 'pure';
62
- /** SQL query string to be executed. */
63
- query: string;
64
- /** Parameters to be used in the query. */
65
- params: Record<string, any>;
66
- }
67
- /**
68
- * Union type representing either a relational or MongoDB native query context.
69
- * @category Database
70
- */
71
- export type NativeQueryContext = RelationalNativeQueryContext | MongoNativeQueryContext | ElasticsearchNativeQueryContext | PureNativeQueryContext;
72
- export {};
@@ -1,190 +0,0 @@
1
- import { AiQueryOptions } from '../public-types/ai-query.public-types';
2
- import { IntegrationId } from '../public-types/communication.public-types';
3
- import { CollectionName, DocumentData, FieldName } from '../public-types/document.public-types';
4
- import { FieldSort, Operator, Query, SimpleCondition } from '../public-types/query.public-types';
5
- import { DeepRecord, FieldOf, PartialBy, Paths } from '../public-types/typescript.public-types';
6
- /**
7
- * The information provided to the secureAiQuery function about the AI query being executed.
8
- * @category AI
9
- */
10
- export interface AiQueryContext {
11
- /** The prompt provided for the AI query. */
12
- prompt: string;
13
- /** The options used for executing the AI query. */
14
- options: AiQueryOptions;
15
- }
16
- /**
17
- * Represents the Squid query context.
18
- * Passed to methods that require query details, such as those annotated with the `@secureCollection` annotation.
19
- * @category Database
20
- */
21
- export declare class QueryContext<T extends DocumentData = any> {
22
- readonly query: Query<T>;
23
- /**
24
- * The ID of the integration being queried.
25
- */
26
- get integrationId(): IntegrationId;
27
- /**
28
- * The name of the collection being queried.
29
- */
30
- get collectionName(): CollectionName;
31
- /**
32
- * The query limit if one exists, -1 otherwise.
33
- */
34
- get limit(): number;
35
- /**
36
- * The fields to project (include) in query results, or undefined if all fields should be returned.
37
- */
38
- get projectFields(): Array<FieldName> | undefined;
39
- /**
40
- * Verifies that the query's sort order aligns with the provided field sorts. The fields specified in the `sorts`
41
- * parameter must appear in the exact order at the beginning of the query's sort sequence. The query can include
42
- * additional fields in its sort order, but only after the specified sorts.
43
- *
44
- * @param sorts An array of field sorts.
45
- * @returns Whether the query's sorts matches the provided field sorts.
46
- */
47
- sortedBy(sorts: Array<PartialBy<FieldSort<T>, 'asc'>>): boolean;
48
- /**
49
- * Verifies that the query's sort order exactly matches the provided field sorts. The fields specified in the
50
- * `sorts` parameter must appear in the exact order in the query's sort sequence. No additional sorts may be present
51
- * in the query.
52
- *
53
- * @param sorts An array of field sorts.
54
- * @returns Whether the query's sorts exactly match the provided field sorts.
55
- */
56
- sortedByExact(sorts: Array<PartialBy<FieldSort<T>, 'asc'>>): boolean;
57
- /**
58
- * Verifies that the query is a subquery of the specified condition. A subquery is defined as a query that evaluates
59
- * to a subset of the results that would be obtained by applying the parent condition. The subquery may also include
60
- * additional conditions, as these only narrow the result set.
61
- *
62
- * @param fieldName The name of the field for the condition.
63
- * @param operator The operator of the condition.
64
- * @param value The value of the condition.
65
- * @returns Whether the query is a subquery of the parent condition.
66
- */
67
- isSubqueryOf<F extends Paths<T>, O extends AllOperators>(fieldName: F, operator: O, value: GenericValue<T, F, O> | null): boolean;
68
- /**
69
- * Verifies that the query is a subquery of the specified condition. A subquery is defined as a query that evaluates
70
- * to a subset of the results that would be obtained by applying the parent condition. The subquery may also include
71
- * additional conditions, as these only narrow the result set.
72
- *
73
- * @param condition The condition to validate.
74
- * @returns Whether the query is a subquery of the parent condition.
75
- */
76
- isSubqueryOfCondition(condition: GeneralCondition<T>): boolean;
77
- /**
78
- * Verifies that the query is a subquery of the specified conditions. A subquery is defined as a query that evaluates
79
- * to a subset of the results that would be obtained by applying the parent conditions. The subquery may also include
80
- * additional conditions, as these only narrow the result set.
81
- *
82
- * @param conditions The conditions to validate.
83
- * @returns Whether the query includes subquery of the parent conditions.
84
- */
85
- isSubqueryOfConditions(conditions: GeneralConditions<T>): boolean;
86
- /**
87
- * Verifies that the query is a subquery of the specified query. A subquery is defined as a query that evaluates
88
- * to a subset of the results that obtained for the parent query, including sorts and limits.
89
- *
90
- * @param query The query to validate.
91
- * @returns Whether the query is a subquery of the parent query.
92
- */
93
- isSubqueryOfQuery(query: Query<T>): boolean;
94
- /**
95
- * Checks if this query's projectFields are a subset of the parent query's projectFields.
96
- * A query can only be a child of another if the parent provides all fields the child needs.
97
- *
98
- * @param childFields - The projectFields of this query (the potential child)
99
- * @param parentFields - The projectFields of the candidate parent query
100
- * @returns Whether the child's fields are available from the parent
101
- */
102
- private isProjectFieldsSubset;
103
- /**
104
- * Returns all conditions that apply to any of the specified field names. This method
105
- * provides a convenient way to retrieve all conditions that involve a specific set of fields.
106
- *
107
- * @param fieldNames The field names for which to retrieve conditions.
108
- * @returns An array of conditions that involve any of the specified field names.
109
- */
110
- getConditionsFor<K extends Paths<T>>(...fieldNames: Array<K>): ContextConditions<T, K>;
111
- /**
112
- * Returns all conditions that apply to the specified field name. This method provides
113
- * a convenient way to retrieve all conditions that involve a specific field.
114
- *
115
- * @param fieldName The field name for which to retrieve conditions.
116
- * @returns An array of conditions that involve the specified field name.
117
- */
118
- getConditionsForField<K extends Paths<T>>(fieldName: K): ContextConditions<T>;
119
- /**
120
- * Returns true if the given document can be a result of the query.
121
- * The method does not account for limit and sort order.
122
- */
123
- documentMatchesQuery(doc: DocumentData): boolean;
124
- }
125
- /**
126
- * A list of context conditions.
127
- * @category Database
128
- */
129
- export type ContextConditions<Doc extends DocumentData = any, F extends Paths<Doc> = Paths<Doc>> = Array<ContextCondition<Doc, F>>;
130
- /**
131
- * A Context condition - a condition that replaces multiple '==' or '!=' conditions with 'in' and 'not in'.
132
- * @category Database
133
- */
134
- export type ContextCondition<Doc extends DocumentData = any, F extends Paths<Doc> = Paths<Doc>> = InContextCondition<Doc, F> | NotInContextCondition<Doc, F> | OtherContextCondition<Doc, F>;
135
- /**
136
- * A condition using the 'in' operator to match values within a set.
137
- * @category Database
138
- */
139
- export interface InContextCondition<Doc extends DocumentData = any, F extends Paths<Doc> = Paths<Doc>> extends SimpleCondition<Doc, F, 'in'> {
140
- /** Specifies the 'in' operator to check if a value exists within an array. */
141
- operator: 'in';
142
- /** An array of values to match against the field. */
143
- value: Array<FieldOf<DeepRecord<Doc>, Paths<Doc>> | any>;
144
- }
145
- /**
146
- * A condition using the 'not in' operator to exclude values within a set.
147
- * @category Database
148
- */
149
- export interface NotInContextCondition<Doc extends DocumentData = any, F extends Paths<Doc> = Paths<Doc>> extends SimpleCondition<Doc, F, 'not in'> {
150
- /** Specifies the 'not in' operator to check if a value does not exist within an array. */
151
- operator: 'not in';
152
- /** An array of values to exclude from the field. */
153
- value: Array<FieldOf<DeepRecord<Doc>, Paths<Doc>> | any>;
154
- }
155
- /**
156
- * A condition using operators other than 'in' or 'not in' for field comparisons.
157
- * @category Database
158
- */
159
- export interface OtherContextCondition<Doc extends DocumentData = any, F extends Paths<Doc> = Paths<Doc>> extends SimpleCondition<Doc, F, Exclude<ContextOperator, 'in' | 'not in'>> {
160
- /** The operator to use for the comparison, excluding 'in' and 'not in'. */
161
- operator: Exclude<ContextOperator, 'in' | 'not in'>;
162
- /** The value to compare against the field. */
163
- value: FieldOf<DeepRecord<Doc>, Paths<Doc>> | any;
164
- }
165
- /**
166
- * A condition that includes all operators, including 'in' and 'not in', for general use.
167
- * @category Database
168
- */
169
- export interface GeneralCondition<Doc extends DocumentData = any, F extends Paths<Doc> = Paths<Doc>> extends SimpleCondition<Doc, F, AllOperators> {
170
- /** The operator to apply to the condition, including all possible operators. */
171
- operator: AllOperators;
172
- /** The value to use in the condition comparison. */
173
- value: any;
174
- }
175
- /**
176
- * A list of general conditions.
177
- * @category Database
178
- */
179
- export type GeneralConditions<Doc extends DocumentData = any, F extends Paths<Doc> = Paths<Doc>> = Array<GeneralCondition<Doc, F>>;
180
- /**
181
- * @category Database
182
- */
183
- export type ContextOperator = Exclude<Operator, '==' | '!='> | 'in' | 'not in';
184
- type AllOperators = Operator | 'in' | 'not in';
185
- /**
186
- * A generic value that can exist in a query.
187
- * @category Database
188
- */
189
- export type GenericValue<Doc = any, F extends Paths<Doc> = Paths<Doc>, O extends AllOperators = any> = O extends 'in' ? Array<DeepRecord<Doc>[F]> | null : O extends 'not in' ? Array<DeepRecord<Doc>[F]> | null : DeepRecord<Doc>[F] | null;
190
- export {};