@squidcloud/client 1.0.392 → 1.0.393

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 (43) hide show
  1. package/dist/cjs/index.js +1 -1
  2. package/dist/esm/index.js +1 -1
  3. package/dist/internal-common/src/metric-name.d.ts +9 -0
  4. package/dist/internal-common/src/public-types/ai-agent.public-types.d.ts +9 -3
  5. package/dist/internal-common/src/public-types/ai-common.public-types.d.ts +2 -2
  6. package/dist/internal-common/src/public-types/ai-knowledge-base.public-types.d.ts +21 -8
  7. package/dist/internal-common/src/public-types-backend/api-call.public-context.d.ts +30 -0
  8. package/dist/internal-common/src/public-types-backend/mutation.public-context.d.ts +148 -0
  9. package/dist/internal-common/src/public-types-backend/native-query.public-context.d.ts +60 -0
  10. package/dist/internal-common/src/public-types-backend/query.public-context.d.ts +166 -0
  11. package/dist/internal-common/src/types/ai-agent.types.d.ts +159 -0
  12. package/dist/internal-common/src/types/ai-assistant.types.d.ts +1 -0
  13. package/dist/internal-common/src/types/ai-knowledge-base.types.d.ts +130 -0
  14. package/dist/internal-common/src/types/ai-matchmaking.types.d.ts +59 -0
  15. package/dist/internal-common/src/types/backend-function.types.d.ts +1 -0
  16. package/dist/internal-common/src/types/communication.types.d.ts +1 -0
  17. package/dist/internal-common/src/types/document.types.d.ts +1 -0
  18. package/dist/internal-common/src/types/file.types.d.ts +6 -0
  19. package/dist/internal-common/src/types/headers.types.d.ts +17 -0
  20. package/dist/internal-common/src/types/mutation.types.d.ts +1 -0
  21. package/dist/internal-common/src/types/notification.types.d.ts +5 -0
  22. package/dist/internal-common/src/types/observability.types.d.ts +78 -0
  23. package/dist/internal-common/src/types/query.types.d.ts +13 -0
  24. package/dist/internal-common/src/types/secret.types.d.ts +2 -0
  25. package/dist/internal-common/src/types/socket.types.d.ts +1 -0
  26. package/dist/internal-common/src/types/stage.d.ts +9 -0
  27. package/dist/internal-common/src/types/time-units.d.ts +1 -0
  28. package/dist/internal-common/src/types/url-shortener.types.d.ts +41 -0
  29. package/dist/internal-common/src/utils/array.d.ts +7 -0
  30. package/dist/internal-common/src/utils/e2e-test-utils.d.ts +2 -0
  31. package/dist/internal-common/src/utils/global.utils.d.ts +1 -0
  32. package/dist/internal-common/src/utils/http.d.ts +5 -0
  33. package/dist/internal-common/src/utils/lock.manager.d.ts +14 -0
  34. package/dist/internal-common/src/utils/metric-utils.d.ts +4 -0
  35. package/dist/internal-common/src/utils/metrics.types.d.ts +7 -0
  36. package/dist/internal-common/src/utils/object.d.ts +58 -0
  37. package/dist/internal-common/src/utils/serialization.d.ts +11 -0
  38. package/dist/internal-common/src/utils/squid.constants.d.ts +1 -0
  39. package/dist/internal-common/src/utils/trace-id-generator.d.ts +1 -0
  40. package/dist/internal-common/src/utils/validation.d.ts +19 -0
  41. package/dist/internal-common/src/websocket.impl.d.ts +26 -0
  42. package/dist/typescript-client/src/version.d.ts +1 -1
  43. package/package.json +1 -1
@@ -0,0 +1,130 @@
1
+ import { AiKnowledgeBase, AiKnowledgeBaseContext, AiKnowledgeBaseContextRequest, AiKnowledgeBaseSearchResultChunk, AiKnowledgeBaseWithOptionalChatModel, AllAiKnowledgeBaseChatOptions } from '../public-types/ai-knowledge-base.public-types';
2
+ import { AiKnowledgeBaseId, AppId } from '../public-types/communication.public-types';
3
+ /**
4
+ * Request structure for getting an AiKnowledgeBase
5
+ * @category AI
6
+ */
7
+ export interface GetAiKnowledgeBaseRequest {
8
+ /** The id of the AiKnowledgeBase */
9
+ id: string;
10
+ }
11
+ /**
12
+ * Response structure for getting an AiKnowledgeBase
13
+ * @category AI
14
+ */
15
+ export interface GetAiKnowledgeBaseResponse {
16
+ /** The resulting AiKnowledgeBase, if it is found */
17
+ knowledgeBase: AiKnowledgeBase | undefined;
18
+ }
19
+ /**
20
+ * Request structure for deleting an AiKnowledgeBase
21
+ * @category AI
22
+ */
23
+ export interface DeleteAiKnowledgeBaseRequest {
24
+ /** The id of the AiKnowledgeBase */
25
+ id: string;
26
+ }
27
+ /**
28
+ * Request structure for upserting an AiKnowledgeBase
29
+ * @category AI
30
+ */
31
+ export interface UpsertAiKnowledgeBaseRequest {
32
+ /** The AiKnowledgeBase to upsert */
33
+ knowledgeBase: AiKnowledgeBaseWithOptionalChatModel;
34
+ }
35
+ /**
36
+ * Response structure for listing AiKnowledgeBases
37
+ * @category AI
38
+ */
39
+ export interface ListAiKnowledgeBasesResponse {
40
+ /** The list of AiKnowledgeBases */
41
+ knowledgeBases: Array<AiKnowledgeBase>;
42
+ }
43
+ /**
44
+ * Request structure for listing AiKnowledgeBaseContexts
45
+ * @category AI
46
+ */
47
+ export interface ListAiKnowledgeBaseContextsRequest {
48
+ /** The id of the AiKnowledgeBase */
49
+ id: string;
50
+ }
51
+ /**
52
+ * Response structure to list AiKnowledgeBaseContexts
53
+ * @category AI
54
+ */
55
+ export interface ListAiKnowledgeBaseContextsResponse {
56
+ /** The list AiKnowledgeBaseContexts */
57
+ contexts: Array<AiKnowledgeBaseContext>;
58
+ }
59
+ /**
60
+ * Request structure for deleting AiKnowledgeBaseContexts
61
+ * @category AI
62
+ */
63
+ export interface DeleteAiKnowledgeBaseContextsRequest {
64
+ /** The id of the AiKnowledgeBase */
65
+ knowledgeBaseId: string;
66
+ /** An array of AiKnowledgeBaseContext ids */
67
+ contextIds: Array<string>;
68
+ }
69
+ /**
70
+ * Request structure for getting an AiKnowledgeBaseContext
71
+ * @category AI
72
+ */
73
+ export interface GetAiKnowledgeBaseContextRequest {
74
+ /** The id of the AiKnowledgeBase */
75
+ knowledgeBaseId: string;
76
+ /** The id of the AiKnowledgeBaseContext */
77
+ contextId: string;
78
+ }
79
+ /**
80
+ * Response structure for getting an AiKnowledgeBaseContext
81
+ * @category AI
82
+ */
83
+ export interface GetAiKnowledgeBaseContextResponse {
84
+ /** The resulting AiKnowledgeBaseContext, if it is found */
85
+ context: AiKnowledgeBaseContext | undefined;
86
+ }
87
+ /**
88
+ * Request structure for upserting context for an AiKnowledgeBase
89
+ * @category AI
90
+ */
91
+ export interface UpsertAiKnowledgeBaseContextsRequest {
92
+ /** The id of the AiKnowledgeBase */
93
+ knowledgeBaseId: string;
94
+ /** The AiKnowledgeBaseContext data, which could be a file or text */
95
+ contextRequests: Array<AiKnowledgeBaseContextRequest>;
96
+ /** The job ID to use for the async upsert job */
97
+ jobId: string;
98
+ }
99
+ /**
100
+ * Response structure for searching an AiKnowledgeBase
101
+ * @category AI
102
+ */
103
+ export interface AiKnowledgeBaseSearchResponse {
104
+ /** Array of result chunks from the search */
105
+ chunks: Array<AiKnowledgeBaseSearchResultChunk>;
106
+ }
107
+ /**
108
+ * Request structure for getting the size of context
109
+ * for an AiKnowledgeBase
110
+ * @category AI
111
+ */
112
+ export interface AiKnowledgeBaseContextSizeRequest {
113
+ /** The ID of the App */
114
+ appId: AppId;
115
+ /** The ID of the AIKnowledgeBase */
116
+ knowledgeBaseId: AiKnowledgeBaseId;
117
+ }
118
+ /**
119
+ * Response structure for getting size of context
120
+ * @category AI
121
+ */
122
+ export interface AiKnowledgeBaseContextSizeResponse {
123
+ /** Size of context bytes, as a number */
124
+ sizeBytes: number;
125
+ }
126
+ export interface AiKnowledgeBaseChatRequest {
127
+ knowledgeBaseId: AiKnowledgeBaseId;
128
+ prompt?: string;
129
+ options?: AllAiKnowledgeBaseChatOptions;
130
+ }
@@ -0,0 +1,59 @@
1
+ import { MmEntity, MmEntityMatch, MmFindMatchesOptions, MmListEntitiesOptions, MmMatchMaker } from '../public-types/ai-matchmaking.public-types';
2
+ export interface MmCreateMatchMakerRequest {
3
+ matchMaker: MmMatchMaker;
4
+ }
5
+ export interface MmDeleteMatchMakerRequest {
6
+ matchMakerId: string;
7
+ }
8
+ export interface MmGetMatchMakerRequest {
9
+ matchMakerId: string;
10
+ }
11
+ export interface MmGetMatchMakerResponse {
12
+ matchMaker: MmMatchMaker | undefined;
13
+ }
14
+ export interface MmDeleteEntityRequest {
15
+ matchMakerId: string;
16
+ entityId: string;
17
+ }
18
+ export interface MmInsertEntityRequest {
19
+ matchMakerId: string;
20
+ entity: MmEntity;
21
+ }
22
+ export interface MmInsertEntitiesRequest {
23
+ matchMakerId: string;
24
+ entities: Array<MmEntity>;
25
+ }
26
+ export interface MmFindMatchesRequest {
27
+ matchMakerId: string;
28
+ entityId: string;
29
+ options: MmFindMatchesOptions;
30
+ }
31
+ export interface MmFindMatchesResponse {
32
+ matches: Array<MmEntityMatch>;
33
+ }
34
+ export interface MmFindMatchesForEntityRequest {
35
+ matchMakerId: string;
36
+ entity: Omit<MmEntity, 'metadata' | 'id'>;
37
+ options: MmFindMatchesOptions;
38
+ }
39
+ export interface MmFindMatchesForEntityResponse {
40
+ matches: Array<MmEntityMatch>;
41
+ }
42
+ export interface MmListMatchMakersResponse {
43
+ matchMakers: Array<MmMatchMaker>;
44
+ }
45
+ export interface MmListEntitiesRequest {
46
+ matchMakerId: string;
47
+ categoryId: string;
48
+ options: MmListEntitiesOptions;
49
+ }
50
+ export interface MmListEntitiesResponse {
51
+ entities: Array<MmEntity>;
52
+ }
53
+ export interface MmGetEntityRequest {
54
+ matchMakerId: string;
55
+ entityId: string;
56
+ }
57
+ export interface MmGetEntityResponse {
58
+ entity: MmEntity | undefined;
59
+ }
@@ -0,0 +1 @@
1
+ export type ChatId = string;
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,6 @@
1
+ export interface Base64File {
2
+ filename: string;
3
+ mimetype: string;
4
+ base64: string;
5
+ __isSquidBase64File__: true;
6
+ }
@@ -0,0 +1,17 @@
1
+ /** HTTP header names used by Squid for request metadata. */
2
+ export declare const SquidHeaders: {
3
+ /** Correlates logs and spans across distributed calls. */
4
+ readonly TRACE_ID: "x-squid-traceid";
5
+ /** Shared secret header for internal authentication. */
6
+ readonly SECRET: "x-squid-secret";
7
+ /** API key provided by the calling application. */
8
+ readonly APP_API_KEY: "x-app-api-key";
9
+ /** Unique identifier of the client application. */
10
+ readonly APP_ID: "x-squid-appid";
11
+ /** Unique identifier of the end user or service client. */
12
+ readonly CLIENT_ID: "x-squid-clientid";
13
+ /** Version string of the Squid client library. */
14
+ readonly CLIENT_VERSION: "x-squid-client-version";
15
+ /** Originating IP address of the request. */
16
+ readonly SOURCE_IP: "x-squid-source-ip";
17
+ };
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,5 @@
1
+ import { ClientId } from '../public-types/communication.public-types';
2
+ export interface PublishNotificationRequest {
3
+ clientIds: Array<ClientId>;
4
+ payload: unknown;
5
+ }
@@ -0,0 +1,78 @@
1
+ import { MetricName } from '../metric-name';
2
+ import { AppId } from '../public-types/communication.public-types';
3
+ export interface ObservableNameMetrics {
4
+ count: MetricName;
5
+ time: MetricName;
6
+ }
7
+ export declare const ObservableNames: {
8
+ readonly functionExecution: ObservableNameMetrics;
9
+ readonly codeInitialization: ObservableNameMetrics;
10
+ readonly getAiChatbotProfiles: ObservableNameMetrics;
11
+ readonly aiImageGeneration: ObservableNameMetrics;
12
+ readonly aiRemoveBackground: ObservableNameMetrics;
13
+ readonly aiAudioTranscribe: ObservableNameMetrics;
14
+ readonly aiAudioCreateSpeech: ObservableNameMetrics;
15
+ readonly discoverGraphQLConnectionSchema: ObservableNameMetrics;
16
+ readonly discoverOpenApiSchema: ObservableNameMetrics;
17
+ readonly discoverOpenApiSchemaFromFile: ObservableNameMetrics;
18
+ readonly graphqlQuery: ObservableNameMetrics;
19
+ readonly testGraphQLConnection: ObservableNameMetrics;
20
+ readonly testAgentProtocolConnection: ObservableNameMetrics;
21
+ readonly graphql: ObservableNameMetrics;
22
+ };
23
+ export type ObservableName = keyof typeof ObservableNames;
24
+ export interface MetricEvent {
25
+ appId: AppId;
26
+ name: MetricName;
27
+ tags: Record<string, string>;
28
+ timestamp: Date;
29
+ value: number;
30
+ isExposedToUser: boolean;
31
+ }
32
+ export interface LogEvent {
33
+ message: string;
34
+ level: string;
35
+ tags: Record<string, string>;
36
+ timestamp: Date;
37
+ isExposedToUser: boolean;
38
+ host: string;
39
+ source?: string;
40
+ service?: string;
41
+ }
42
+ export declare const AUDIT_LOG_EVENT_NAMES: readonly ["ai_agent"];
43
+ export type AuditLogEventName = (typeof AUDIT_LOG_EVENT_NAMES)[number];
44
+ export interface AuditLogEvent {
45
+ appId: AppId;
46
+ name: AuditLogEventName;
47
+ timestamp: Date;
48
+ context: {
49
+ clientId?: string;
50
+ userId: string;
51
+ };
52
+ tags: Record<string, string>;
53
+ }
54
+ /** Tag for metric events. Value: '0' - not an error, '1' - is an error. */
55
+ export declare const O11Y_TAG_IS_ERROR = "isError";
56
+ /** Tag for log events. Metrics have an explicit appId field. */
57
+ export declare const O11Y_TAG_APP_ID = "appId";
58
+ /** Tag for metric and log events. */
59
+ export declare const O11Y_TAG_INTEGRATION_ID = "integrationId";
60
+ /** Tag for AI events. */
61
+ export declare const O11Y_TAG_AI_MODEL = "aiModel";
62
+ export declare const O11Y_TAG_AI_PROFILE = "aiProfile";
63
+ /** Tag for AI KnowledgeBase events */
64
+ export declare const O11Y_TAG_AI_KNOWLEDGE_BASE_MODEL = "aiKnowledgeBaseModel";
65
+ export declare const O11Y_TAG_API_KEY_SOURCE = "apiKeySource";
66
+ /** Tag for metric and log events. Value: '0' - not a tenant originated, '1' - is a tenant originated. */
67
+ export declare const O11Y_TAG_IS_TENANT_ORIGINATED = "isTenantOriginated";
68
+ /** Contains a full (with a service name) function name for backend functions. */
69
+ export declare const O11Y_TAG_FUNCTION_NAME = "functionName";
70
+ /** Contains a type of the function name for backend functions (See ExecuteFunctionAnnotationType.). */
71
+ export declare const O11Y_TAG_FUNCTION_TYPE = "functionType";
72
+ /** Tag for the trace ID. Used in logs. */
73
+ export declare const O11Y_TAG_TRACE_ID = "trace_id";
74
+ /** Tag for the span ID. Used in logs. */
75
+ export declare const O11Y_TAG_SPAN_ID = "span_id";
76
+ export declare function getBooleanMetricTagValue(value: boolean): string;
77
+ export declare const COUNT_METRIC_SUFFIXES: string[];
78
+ export declare const GAUGE_METRIC_SUFFIXES: string[];
@@ -0,0 +1,13 @@
1
+ import { Condition, SimpleCondition } from '../public-types/query.public-types';
2
+ /**
3
+ * Generates the regex pattern, handling special characters as follows:
4
+ * - `_` is replaced with a `.`
5
+ * - `%` is replaced with `[\s\S]*`.
6
+ * - The above characters can be escaped with \, eg. `\_` is replaced with `_` and `\%` with `%`.
7
+ * - All special characters in regex (-, /, \, ^, $, *, +, ?, ., (, ), |, [, ], {, }) get escaped with \
8
+ *
9
+ * Exported for testing purposes.
10
+ * */
11
+ export declare function replaceSpecialCharacters(input: string): string;
12
+ /** Returns true if the condition is a 'SimpleCondition' or false otherwise. */
13
+ export declare function isSimpleCondition(condition: Condition): condition is SimpleCondition;
@@ -0,0 +1,2 @@
1
+ export declare const BACKEND_API_KEY = "_BACKEND_API_KEY";
2
+ export declare const APP_API_KEY = "APP_API_KEY";
@@ -0,0 +1 @@
1
+ export declare const SOCKET_RECONNECT_TIMEOUT: number;
@@ -0,0 +1,9 @@
1
+ /**
2
+ * Stage of the Squid deployment:
3
+ * - 'local' - Squid is run locally.
4
+ * - 'prod' - Production environment (https://console.getsquid.ai).
5
+ * - 'sandbox' - One of the sandbox environments (https://console.sandbox.squid.cloud).
6
+ * - 'staging' - One of the staging environments (https://console.staging.squid.cloud).
7
+ */
8
+ export declare const STAGES: readonly ["local", "prod", "sandbox", "staging"];
9
+ export type Stage = (typeof STAGES)[number];
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,41 @@
1
+ import { AppId } from '../public-types/communication.public-types';
2
+ /**
3
+ * Request to create a shortened URL.
4
+ */
5
+ export interface ShortUrlRequest {
6
+ /** The URL to shorten. It must be a valid URL and should include the protocol (start with http:// or https://). */
7
+ url: string;
8
+ /** The application ID that will own this shortened URL. */
9
+ appId: AppId;
10
+ /** Seconds to live for the shortened URL. If set to 0, the URL will never expire. Defaults to 1 day. */
11
+ secondsToLive?: number;
12
+ }
13
+ /**
14
+ * Request to create shortened URLs.
15
+ */
16
+ export interface ShortUrlBulkRequest {
17
+ /** The URLs to shorten. They must be valid URLs and should include the protocol (start with http:// or https://). */
18
+ urls: string[];
19
+ /** The application ID that will own these shortened URLs. */
20
+ appId: AppId;
21
+ /** Seconds to live for all shortened URLs. If set to 0, the URLs will never expire. Defaults to 1 day. */
22
+ secondsToLive?: number;
23
+ }
24
+ /**
25
+ * Request to delete a shortened URL.
26
+ */
27
+ export interface ShortUrlDeleteRequest {
28
+ /** The ID of the shortened URL to delete. */
29
+ id: string;
30
+ /** The application ID that owns the shortened URL. */
31
+ appId: AppId;
32
+ }
33
+ /**
34
+ * Request to delete a shortened URL.
35
+ */
36
+ export interface ShortUrlBulkDeleteRequest {
37
+ /** The IDs of the shortened URLs to delete. */
38
+ ids: string[];
39
+ /** The application ID that owns the shortened URLs. */
40
+ appId: AppId;
41
+ }
@@ -0,0 +1,7 @@
1
+ export declare function truncateOrPadArray(arr: number[], length: number): number[];
2
+ /**
3
+ * Computes a single “recommended” chunk size so that if you loop
4
+ * `for (let i = 0; i < length; i += chunkSize)`,
5
+ * no slice will exceed `maxChunkSize` and all chunk sizes are 'almost' equal.
6
+ */
7
+ export declare function computeRecommendedChunkSize(length: number, maxChunkSize: number): number;
@@ -0,0 +1,2 @@
1
+ /** Returns true if the application is run by a Playwright test. */
2
+ export declare function isPlaywrightTestMode(): boolean | undefined;
@@ -0,0 +1 @@
1
+ export {};
@@ -0,0 +1,5 @@
1
+ import { AppId } from '../public-types/communication.public-types';
2
+ import { Stage } from '../types/stage';
3
+ export declare const KOTLIN_CONTROLLERS: string[];
4
+ export declare function getEnvironmentPrefix(shard: string | undefined, region: string, cloudId: string, stage: Stage): string;
5
+ export declare function getApplicationUrl(environmentPrefix: string, appId: string, path: string, appIdPlaceholder?: AppId, environmentPrefixPlaceholder?: string): string;
@@ -0,0 +1,14 @@
1
+ type LockMutex = string;
2
+ /**
3
+ * A simple lock manager that locks a list of mutexes.
4
+ * When locking a list of mutexes, the lock will start only when all the mutexes are available - preventing partial lock
5
+ * and potential deadlocks.
6
+ */
7
+ export declare class LockManager {
8
+ private readonly locks;
9
+ lock(...mutexes: LockMutex[]): Promise<void>;
10
+ release(...mutexes: LockMutex[]): void;
11
+ canGetLock(...mutexes: LockMutex[]): boolean;
12
+ lockSync(...mutexes: LockMutex[]): void;
13
+ }
14
+ export {};
@@ -0,0 +1,4 @@
1
+ import { QueryMetricsRequestCommon, QueryMetricsResultGroup } from '../public-types/metric.public-types';
2
+ export type QueryMetricsRequestIntervals = Required<Pick<QueryMetricsRequestCommon, 'fillValue' | 'fn' | 'groupByTags' | 'periodEndSeconds' | 'periodStartSeconds' | 'pointIntervalAlignment' | 'pointIntervalSeconds' | 'tagDomains' | 'noDataBehavior'>>;
3
+ /** Adds missed known tag domain groups and fills all missed points with a request.fillValue. */
4
+ export declare function fillMissedPoints(request: QueryMetricsRequestIntervals, resultGroups: Array<QueryMetricsResultGroup>): void;
@@ -0,0 +1,7 @@
1
+ /**
2
+ * Type suffixes defines the type of the metric and can be used for
3
+ * metric value validation for incoming metrics.
4
+ */
5
+ export declare const SQUID_METRIC_TYPE_SUFFIXES: readonly ["_count", "_time", "_size", "_entries", "_value"];
6
+ /** Returns true if the given metric has a valid metric type. */
7
+ export declare function hasValidMetricTypeSuffix(metricName: string): boolean;
@@ -0,0 +1,58 @@
1
+ /** Returns a value by the `path`. Works with array indexes, like a.b[0]. */
2
+ export declare function getInPath(obj: unknown, path: string): any;
3
+ export declare function isDateObject(value: unknown): value is Date;
4
+ /** Sets a value by path . Does not support array indexes. */
5
+ export declare function setInPath(obj: object, path: string, value: unknown, delimiter?: string): void;
6
+ export declare function deleteInPath(obj: object, path: string, delimiter?: string): void;
7
+ export declare function replaceKeyInMap<K, T>(map: Map<K, T | undefined>, a: K, b: K): void;
8
+ export declare function replaceKeyInRecord<K extends keyof any, T>(record: Record<K, T>, a: K, b: K): void;
9
+ export declare function isNil(obj: unknown): obj is null | undefined;
10
+ export declare function isEqual(a: unknown, b: unknown): boolean;
11
+ export declare function isEmpty(a: unknown): boolean;
12
+ export declare function omit<T extends object, K extends PropertyKey[]>(object: T | null | undefined, ...fieldsToRemove: K): Pick<T, Exclude<keyof T, K[number]>>;
13
+ export type CloneCustomizer = (value: unknown) => unknown | undefined;
14
+ /**
15
+ * Creates a deep copy of the specified object, including all nested objects and specifically handling Date, Map, and
16
+ * Set fields.
17
+ *
18
+ * The customizer function can modify the cloning process for the object and its fields. If the customizer
19
+ * returns 'undefined' for any input, the function falls back to the standard cloning logic.
20
+ *
21
+ * The cloning process is recursive, ensuring deep cloning of all objects.
22
+ *
23
+ * Note: This function does not support cloning objects with circular dependencies and will throw a system stack
24
+ * overflow error if encountered.
25
+ */
26
+ export declare function cloneDeep<R = unknown>(value: R, customizer?: CloneCustomizer): R;
27
+ /** Creates a shallow clone of the object. */
28
+ export declare function cloneShallow<T>(value: T): T;
29
+ export declare function deepMerge<T extends object, U extends object>(target: T, source: U): T & U;
30
+ /** Returns true if the `value` is a defined object and is not an array. */
31
+ export declare function isPlainObject(value: unknown): value is object;
32
+ /** Compares 2 values. 'null' and 'undefined' values are considered equal and are less than any other values. */
33
+ export declare function compareValues(v1: unknown, v2: unknown): number;
34
+ /** Returns a new object with all top-level object fields re-mapped using `valueMapperFn`. */
35
+ export declare function mapValues<ResultType extends object = Record<string, unknown>, InputType extends Record<string, unknown> = Record<string, unknown>>(obj: InputType, valueMapperFn: (value: any, key: keyof InputType, obj: InputType) => unknown): ResultType;
36
+ /** Groups elements of the array by key. See _.groupBy for details. */
37
+ export declare function groupBy<T, K extends PropertyKey>(array: T[], getKey: (item: T) => K): Record<K, T[]>;
38
+ /**
39
+ * Picks selected fields from the object and returns a new object with the fields selected.
40
+ * The selected fields are assigned by reference (there is no cloning).
41
+ */
42
+ export declare function pick<T extends object, K extends keyof T>(obj: T, keys: ReadonlyArray<K>): Pick<T, K>;
43
+ /** Inverts the record: swaps keys and values. */
44
+ export declare function invert<K extends string | number, V extends string | number>(record: Record<K, V>): Record<V, K>;
45
+ /**
46
+ * Creates an array of numbers (positive and/or negative) progressing from start up to, but not including, end.
47
+ * If end is less than start a zero-length range is created unless a negative step is specified.
48
+ *
49
+ * Same as lodash range but with an additional parameter: `maximumNumberOfItems`.
50
+ */
51
+ export declare function range(start: number, end: number, step: number, maximumNumberOfItems?: number): number[];
52
+ /** Returns count of top level properties in object. */
53
+ export declare function countObjectKeys(obj: object | undefined): number;
54
+ /** Returns object entries sorted by name. */
55
+ export declare function getSortedEntries<T>(record: Record<string, T>): Array<[string, T]>;
56
+ /** Removes top level fields which are empty objects. May be used for value formatting. */
57
+ export declare function removeEmptyTopLevelRecords<T extends object>(record: T): Partial<T>;
58
+ export declare function removeUndefinedValues<V>(tags: Record<string, V | undefined>): Record<string, V>;
@@ -0,0 +1,11 @@
1
+ export declare function normalizeJsonAsString(json: unknown): string;
2
+ export declare function serializeObj(obj: unknown): string;
3
+ export declare function deserializeObj<T = any>(str: string): T;
4
+ export declare function encodeValueForMapping(value: unknown): string;
5
+ export declare function decodeValueForMapping(encodedString: string): any;
6
+ /**
7
+ * Compares 2 objects by their normalized JSON value.
8
+ * This function should not be used with objects with circular references.
9
+ * Returns true if the object are equal.
10
+ */
11
+ export declare function compareByNormalizedJsonValue<T>(v1: T, v2: T): boolean;
@@ -0,0 +1 @@
1
+ export declare const SQUID_SUPPORT_EMAIL = "support@getsquid.ai";
@@ -0,0 +1 @@
1
+ export declare function generateTraceId(prefix?: string): string;
@@ -0,0 +1,19 @@
1
+ import { HttpStatusCode } from '../public-types/http-status.public-types';
2
+ export declare class ValidationError extends Error {
3
+ readonly statusCode: HttpStatusCode;
4
+ readonly details?: any;
5
+ constructor(error: string, statusCode: HttpStatusCode, details?: Record<string, unknown>);
6
+ }
7
+ export declare function isValidId(id: unknown, maxLength?: number): boolean;
8
+ export declare function validateFieldSort(fieldSort: unknown): void;
9
+ export declare function validateQueryLimit(limit: unknown): void;
10
+ /**
11
+ * All type names returned by 'typeof' supported by JavaScript:
12
+ * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/typeof}.
13
+ * and a few other supported types.
14
+ */
15
+ export type JavascriptTypeName = 'undefined' | 'object' | 'boolean' | 'number' | 'bigint' | 'string' | 'symbol' | 'function';
16
+ /** Returns true if 'typeof' of the 'value' is 'type' or 'type[]'. */
17
+ export declare function isRightType(value: unknown, type: JavascriptTypeName): boolean;
18
+ /** Returns true if 'obj' has only keys listed in the 'keys'. Object can't be an array. */
19
+ export declare function hasOnlyKeys(obj: object, keys: string[]): boolean;
@@ -0,0 +1,26 @@
1
+ interface Options {
2
+ maxAttempts?: number;
3
+ protocols?: string[];
4
+ onmessage?: (event: any) => void;
5
+ onopen?: (event: any) => void;
6
+ onclose?: (event: any) => void;
7
+ onerror?: (event: any) => void;
8
+ onreconnect?: (event: any) => void;
9
+ onmaximum?: (event: any) => void;
10
+ timeoutMillis?: number;
11
+ }
12
+ export interface WebSocketWrapper {
13
+ open: () => void;
14
+ reconnect: (e: any) => void;
15
+ json: (x: any) => void;
16
+ send: (x: string) => void;
17
+ close: (x?: number, y?: string) => void;
18
+ connected: boolean;
19
+ /**
20
+ * Websocket is explicitly closed by calling socket.close().
21
+ * Used to ignore errors after socket.closed() is called.
22
+ */
23
+ closeCalled: boolean;
24
+ }
25
+ export declare function createWebSocketWrapper(url: string, opts?: Options): WebSocketWrapper;
26
+ export {};
@@ -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.392";
5
+ export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.393";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@squidcloud/client",
3
- "version": "1.0.392",
3
+ "version": "1.0.393",
4
4
  "description": "A typescript implementation of the Squid client",
5
5
  "main": "dist/cjs/index.js",
6
6
  "module": "dist/esm/index.js",