@squidcloud/client 1.0.281 → 1.0.283

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

@@ -14,7 +14,8 @@ export declare const OPENAI_AUDIO_TRANSCRIPTION_MODEL_NAMES: readonly ["whisper-
 export declare const OPENAI_AUDIO_CREATE_SPEECH_MODEL_NAMES: readonly ["tts-1", "tts-1-hd"];
 export declare const OPENAI_AUDIO_MODEL_NAMES: readonly ["whisper-1", "tts-1", "tts-1-hd"];
 export declare const STABLE_DIFFUSION_MODEL_NAMES: readonly ["stable-diffusion-core"];
-export declare const AI_IMAGE_MODEL_NAMES: readonly ["dall-e-3", "stable-diffusion-core"];
+export declare const FLUX_MODEL_NAMES: readonly ["flux-pro-1.1"];
+export declare const AI_IMAGE_MODEL_NAMES: readonly ["dall-e-3", "stable-diffusion-core", "flux-pro-1.1"];
 export declare const AI_AUDIO_TRANSCRIPTION_MODEL_NAMES: readonly ["whisper-1"];
 export declare const AI_AUDIO_CREATE_SPEECH_MODEL_NAMES: readonly ["tts-1", "tts-1-hd"];
 export declare const OPEN_AI_CREATE_SPEECH_FORMATS: readonly ["mp3", "opus", "aac", "flac", "wav", "pcm"];
@@ -32,7 +33,8 @@ export type OpenAiAudioTranscriptionModelName = (typeof OPENAI_AUDIO_TRANSCRIPTI
 export type OpenAiAudioCreateSpeechModelName = (typeof OPENAI_AUDIO_CREATE_SPEECH_MODEL_NAMES)[number];
 export type OpenAiCreateSpeechFormat = (typeof OPEN_AI_CREATE_SPEECH_FORMATS)[number];
 export type StableDiffusionModelName = (typeof STABLE_DIFFUSION_MODEL_NAMES)[number];
-export type AiGenerateImageOptions = DallEOptions | StableDiffusionCoreOptions;
+export type FluxModelName = (typeof FLUX_MODEL_NAMES)[number];
+export type AiGenerateImageOptions = DallEOptions | StableDiffusionCoreOptions | FluxOptions;
 export type AiAudioTranscribeOptions = WhisperOptions;
 export type AiAudioCreateSpeechOptions = OpenAiCreateSpeechOptions;
 export type VectorDbType = 'pinecone' | 'postgres';
@@ -72,6 +74,14 @@ export interface OpenAiCreateSpeechOptions extends BaseAiAudioCreateSpeechOption
     responseFormat?: OpenAiCreateSpeechFormat;
     speed?: number;
 }
+export interface FluxOptions extends BaseAiGenerateImageOptions {
+    modelName: 'flux-pro-1.1';
+    width?: number;
+    height?: number;
+    prompt_upsampling?: boolean;
+    seed?: number;
+    safety_tolerance?: number;
+}
 export interface StableDiffusionCoreOptions extends BaseAiGenerateImageOptions {
     modelName: 'stable-diffusion-core';
     aspectRatio?: '16:9' | '1:1' | '21:9' | '2:3' | '3:2' | '4:5' | '5:4' | '9:16' | '9:21';

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

@@ -35,6 +35,6 @@ export interface RunContext {
     clientId?: ClientId;
     /** The IP address of the client that initiated this request. */
     sourceIp?: string;
-    /** The headers of the request. */
+    /** The headers of the request. Headers are in lower-case. */
     headers?: Record<string, any>;
 }

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

@@ -0,0 +1,21 @@
+import { ApiEndpointId, HttpMethod } from '../public-types/integrations/api.public-types';
+import { IntegrationId } from '../public-types/communication.public-types';
+import { ApiOptions } from '../public-types/api-client.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;
+}
+export interface CallApiRequest<BodyType = any> {
+    integrationId: IntegrationId;
+    endpointId: ApiEndpointId;
+    body?: BodyType;
+    overrideMethod?: HttpMethod;
+    options: ApiOptions;
+}

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

@@ -0,0 +1,18 @@
+import { IntegrationId } from '../public-types/communication.public-types';
+export type NativeQueryRequestType = 'relational' | 'mongo';
+interface BaseNativeQueryContext {
+    type: NativeQueryRequestType;
+    integrationId: IntegrationId;
+}
+export interface RelationalNativeQueryContext extends BaseNativeQueryContext {
+    type: 'relational';
+    query: string;
+    params: Record<string, any>;
+}
+export interface MongoNativeQueryContext extends BaseNativeQueryContext {
+    type: 'mongo';
+    collectionName: string;
+    aggregationPipeline: Array<any | undefined>;
+}
+export type NativeQueryContext = RelationalNativeQueryContext | MongoNativeQueryContext;
+export {};

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

@@ -0,0 +1,123 @@
+import { FieldSort, Operator, Query, SimpleCondition } from '../public-types/query.public-types';
+import { DeepRecord, FieldOf, PartialBy, Paths } from '../public-types/typescript.public-types';
+import { CollectionName, DocumentData } from '../public-types/document.public-types';
+import { IntegrationId } from '../public-types/communication.public-types';
+export declare class QueryContext<T extends DocumentData = any> {
+    readonly query: Query<T>;
+    /**
+     * The ID of the integration being queried.
+     */
+    get integrationId(): IntegrationId;
+    /**
+     * The name of the collection being queried.
+     */
+    get collectionName(): CollectionName;
+    /**
+     * The query limit if one exists, -1 otherwise.
+     */
+    get limit(): number;
+    /**
+     * Verifies that the query's sort order aligns with the provided field sorts. The fields specified in the `sorts`
+     * parameter must appear in the exact order at the beginning of the query's sort sequence. The query can include
+     * additional fields in its sort order, but only after the specified sorts.
+     *
+     * @param sorts An array of field sorts.
+     * @returns Whether the query's sorts matches the provided field sorts.
+     */
+    sortedBy(sorts: Array<PartialBy<FieldSort<T>, 'asc'>>): boolean;
+    /**
+     * Verifies that the query's sort order exactly matches the provided field sorts. The fields specified in the
+     * `sorts` parameter must appear in the exact order in the query's sort sequence. No additional sorts may be present
+     * in the query.
+     *
+     * @param sorts An array of field sorts.
+     * @returns Whether the query's sorts exactly match the provided field sorts.
+     */
+    sortedByExact(sorts: Array<PartialBy<FieldSort<T>, 'asc'>>): boolean;
+    /**
+     * Verifies that the query is a subquery of the specified condition. A subquery is defined as a query that evaluates
+     * to a subset of the results that would be obtained by applying the parent condition. The subquery may also include
+     * additional conditions, as these only narrow the result set.
+     *
+     * @param fieldName The name of the field for the condition.
+     * @param operator The operator of the condition.
+     * @param value The value of the condition.
+     * @returns Whether the query is a subquery of the parent condition.
+     */
+    isSubqueryOf<F extends Paths<T>, O extends AllOperators>(fieldName: F, operator: O, value: GenericValue<T, F, O> | null): boolean;
+    /**
+     * Verifies that the query is a subquery of the specified condition. A subquery is defined as a query that evaluates
+     * to a subset of the results that would be obtained by applying the parent condition. The subquery may also include
+     * additional conditions, as these only narrow the result set.
+     *
+     * @param condition The condition to validate.
+     * @returns Whether the query is a subquery of the parent condition.
+     */
+    isSubqueryOfCondition(condition: GeneralCondition<T>): boolean;
+    /**
+     * Verifies that the query is a subquery of the specified conditions. A subquery is defined as a query that evaluates
+     * to a subset of the results that would be obtained by applying the parent conditions. The subquery may also include
+     * additional conditions, as these only narrow the result set.
+     *
+     * @param conditions The conditions to validate.
+     * @returns Whether the query includes subquery of the parent conditions.
+     */
+    isSubqueryOfConditions(conditions: GeneralConditions<T>): boolean;
+    /**
+     * Verifies that the query is a subquery of the specified query. A subquery is defined as a query that evaluates
+     * to a subset of the results that obtained for the parent query, including sorts and limits.
+     *
+     * @param query The query to validate.
+     * @returns Whether the query is a subquery of the parent query.
+     */
+    isSubqueryOfQuery(query: Query<T>): boolean;
+    /**
+     * Returns all conditions that apply to any of the specified field names. This method
+     * provides a convenient way to retrieve all conditions that involve a specific set of fields.
+     *
+     * @param fieldNames The field names for which to retrieve conditions.
+     * @returns An array of conditions that involve any of the specified field names.
+     */
+    getConditionsFor<K extends Paths<T>>(...fieldNames: Array<K>): ContextConditions<T, K>;
+    /**
+     * Returns all conditions that apply to the specified field name. This method provides
+     * a convenient way to retrieve all conditions that involve a specific field.
+     *
+     * @param fieldName The field name for which to retrieve conditions.
+     * @returns An array of conditions that involve the specified field name.
+     */
+    getConditionsForField<K extends Paths<T>>(fieldName: K): ContextConditions<T>;
+    /**
+     * Returns true if the given document can be a result of the query.
+     * The method does not account for limit and sort order.
+     */
+    documentMatchesQuery(doc: DocumentData): boolean;
+}
+/** A list of context conditions */
+export type ContextConditions<Doc extends DocumentData = any, F extends Paths<Doc> = Paths<Doc>> = Array<ContextCondition<Doc, F>>;
+/** A Context condition - a condition that replaces multiple '==' or '!=' conditions with 'in' and 'not in'. */
+export type ContextCondition<Doc extends DocumentData = any, F extends Paths<Doc> = Paths<Doc>> = InContextCondition<Doc, F> | NotInContextCondition<Doc, F> | OtherContextCondition<Doc, F>;
+export interface InContextCondition<Doc extends DocumentData = any, F extends Paths<Doc> = Paths<Doc>> extends SimpleCondition<Doc, F, 'in'> {
+    operator: 'in';
+    value: Array<FieldOf<DeepRecord<Doc>, Paths<Doc>> | any>;
+}
+export interface NotInContextCondition<Doc extends DocumentData = any, F extends Paths<Doc> = Paths<Doc>> extends SimpleCondition<Doc, F, 'not in'> {
+    operator: 'not in';
+    value: Array<FieldOf<DeepRecord<Doc>, Paths<Doc>> | any>;
+}
+export interface OtherContextCondition<Doc extends DocumentData = any, F extends Paths<Doc> = Paths<Doc>> extends SimpleCondition<Doc, F, Exclude<ContextOperator, 'in' | 'not in'>> {
+    operator: Exclude<ContextOperator, 'in' | 'not in'>;
+    value: FieldOf<DeepRecord<Doc>, Paths<Doc>> | any;
+}
+/** A condition that includes the 'in' and 'not in' operators. */
+export interface GeneralCondition<Doc extends DocumentData = any, F extends Paths<Doc> = Paths<Doc>> extends SimpleCondition<Doc, F, AllOperators> {
+    operator: AllOperators;
+    value: any;
+}
+/** A list of general conditions. */
+export type GeneralConditions<Doc extends DocumentData = any, F extends Paths<Doc> = Paths<Doc>> = Array<GeneralCondition<Doc, F>>;
+export type ContextOperator = Exclude<Operator, '==' | '!='> | 'in' | 'not in';
+type AllOperators = Operator | 'in' | 'not in';
+/** A generic value that can exist in a query. */
+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;
+export {};

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

@@ -0,0 +1 @@
+export {};

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

@@ -0,0 +1,13 @@
+import { AiFileUrl } from '../public-types/ai-chatbot.public-types';
+import { FunctionName } from '../public-types/bundle-data.public-types';
+export type AiChatResponseFormat = 'text' | 'json_object';
+export interface AiChatOptions {
+    maxTokens: number;
+    responseFormat: AiChatResponseFormat;
+    temperature: number;
+    topP: number;
+    instructions: Array<string>;
+    clientId: string;
+    fileUrls: Array<AiFileUrl>;
+    functions?: Array<FunctionName>;
+}

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/mutation.types.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/internal-common/src/types/query.types.d.ts

@@ -0,0 +1,10 @@
+/**
+ * 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;

package/dist/internal-common/src/types/secret.types.d.ts

@@ -0,0 +1,2 @@
+export declare const BACKEND_API_KEY = "_BACKEND_API_KEY";
+export declare const APP_API_KEY = "APP_API_KEY";

package/dist/internal-common/src/types/socket.types.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/internal-common/src/types/time-units.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/internal-common/src/utils/array.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/internal-common/src/utils/e2e-test-utils.d.ts

@@ -0,0 +1,2 @@
+/** Returns true if the application is run by a Playwright test. */
+export declare function isPlaywrightTestMode(): boolean | undefined;

package/dist/internal-common/src/utils/global.utils.d.ts

@@ -0,0 +1 @@
+export declare function isTimestampEnabled(): boolean;

package/dist/internal-common/src/utils/http.d.ts

@@ -0,0 +1,2 @@
+export declare function getApplicationUrl(regionPrefix: string, appId: string, path: string): string;
+export declare function getApplicationHttpHeaders(regionPrefix: string, appId: string): Record<string, string>;

package/dist/internal-common/src/utils/lock.manager.d.ts

@@ -0,0 +1,14 @@
+type LockMutex = string;
+/**
+ * A simple lock manager that locks a list of mutexes.
+ * When locking a list of mutexes, the lock will start only when all the mutexes are available - preventing partial lock
+ * and potential deadlocks.
+ */
+export declare class LockManager {
+    private readonly locks;
+    lock(...mutexes: LockMutex[]): Promise<void>;
+    release(...mutexes: LockMutex[]): void;
+    canGetLock(...mutexes: LockMutex[]): boolean;
+    lockSync(...mutexes: LockMutex[]): void;
+}
+export {};

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

@@ -0,0 +1,4 @@
+import { QueryMetricsRequestCommon, QueryMetricsResultGroup } from '../public-types/metric.public-types';
+export type QueryMetricsRequestIntervals = Required<Pick<QueryMetricsRequestCommon, 'fillValue' | 'fn' | 'groupByTags' | 'periodEndSeconds' | 'periodStartSeconds' | 'pointIntervalAlignment' | 'pointIntervalSeconds' | 'tagDomains' | 'noDataBehavior'>>;
+/** Adds missed known tag domain groups and fills all missed points with a request.fillValue. */
+export declare function fillMissedPoints(request: QueryMetricsRequestIntervals, resultGroups: Array<QueryMetricsResultGroup>): void;

package/dist/internal-common/src/utils/object.d.ts

@@ -0,0 +1,49 @@
+/** Returns a value by the `path`. Works with array indexes, like a.b[0]. */
+export declare function getInPath(obj: unknown, path: string): any;
+export declare function isDateObject(value: unknown): value is Date;
+/** Sets a value by path . Does not support array indexes. */
+export declare function setInPath(obj: object, path: string, value: unknown, delimiter?: string): void;
+export declare function deleteInPath(obj: object, path: string, delimiter?: string): void;
+export declare function replaceKeyInMap<K, T>(map: Map<K, T | undefined>, a: K, b: K): void;
+export declare function replaceKeyInRecord<K extends keyof any, T>(record: Record<K, T>, a: K, b: K): void;
+export declare function isNil(obj: unknown): obj is null | undefined;
+export declare function isEqual(a: unknown, b: unknown): boolean;
+export declare function isEmpty(a: unknown): boolean;
+export declare function omit<T extends object, K extends PropertyKey[]>(object: T | null | undefined, ...fieldsToRemove: K): Pick<T, Exclude<keyof T, K[number]>>;
+export type CloneCustomizer = (value: unknown) => unknown | undefined;
+/**
+ * Creates a deep copy of the specified object, including all nested objects and specifically handling Date, Map, and
+ * Set fields.
+ *
+ * The customizer function can modify the cloning process for the object and its fields. If the customizer
+ * returns 'undefined' for any input, the function falls back to the standard cloning logic.
+ *
+ * The cloning process is recursive, ensuring deep cloning of all objects.
+ *
+ * Note: This function does not support cloning objects with circular dependencies and will throw a system stack
+ * overflow error if encountered.
+ */
+export declare function cloneDeep<R = unknown>(value: R, customizer?: CloneCustomizer): R;
+/** Creates a shallow clone of the object. */
+export declare function cloneShallow<T>(value: T): T;
+export declare function deepMerge<T extends object, U extends object>(target: T, source: U): T & U;
+/** Compares 2 values. 'null' and 'undefined' values are considered equal and are less than any other values. */
+export declare function compareValues(v1: unknown, v2: unknown): number;
+/** Returns a new object with all top-level object fields re-mapped using `valueMapperFn`. */
+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;
+/** Groups elements of the array by key. See _.groupBy for details. */
+export declare function groupBy<T, K extends PropertyKey>(array: T[], getKey: (item: T) => K): Record<K, T[]>;
+/**
+ * Picks selected fields from the object and returns a new object with the fields selected.
+ * The selected fields are assigned by reference (there is no cloning).
+ */
+export declare function pick<T extends object, K extends keyof T>(obj: T, keys: ReadonlyArray<K>): Pick<T, K>;
+/** Inverts the record: swaps keys and values. */
+export declare function invert<K extends string | number, V extends string | number>(record: Record<K, V>): Record<V, K>;
+/**
+ * Creates an array of numbers (positive and/or negative) progressing from start up to, but not including, end.
+ * If end is less than start a zero-length range is created unless a negative step is specified.
+ *
+ * Same as lodash range but with an additional parameter: `maximumNumberOfItems`.
+ */
+export declare function range(start: number, end: number, step: number, maximumNumberOfItems?: number): number[];

package/dist/internal-common/src/utils/serialization.d.ts

@@ -0,0 +1,5 @@
+export declare function normalizeJsonAsString(json: unknown): string;
+export declare function serializeObj(obj: unknown): string;
+export declare function deserializeObj<T = any>(str: string): T;
+export declare function encodeValueForMapping(value: unknown): string;
+export declare function decodeValueForMapping(encodedString: string): any;

package/dist/internal-common/src/utils/validation.d.ts

@@ -0,0 +1,20 @@
+import { HttpStatus } from '../public-types/http-status.enum';
+export type StatusCode = HttpStatus.BAD_REQUEST | HttpStatus.NOT_FOUND | HttpStatus.FORBIDDEN | HttpStatus.UNAUTHORIZED | HttpStatus.CONFLICT | HttpStatus.INTERNAL_SERVER_ERROR;
+export declare class ValidationError extends Error {
+    readonly statusCode: StatusCode;
+    readonly details?: any;
+    constructor(error: string, statusCode: StatusCode, details?: Record<string, any>);
+}
+export declare function isValidId(id: unknown, maxLength?: number): boolean;
+export declare function validateFieldSort(fieldSort: unknown): void;
+export declare function validateQueryLimit(limit: unknown): void;
+/**
+ * All type names returned by 'typeof' supported by JavaScript:
+ * {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/typeof}.
+ * and a few other supported types.
+ */
+export type JavascriptTypeName = 'undefined' | 'object' | 'boolean' | 'number' | 'bigint' | 'string' | 'symbol' | 'function';
+/** Returns true if 'typeof' of the 'value' is 'type' or 'type[]'. */
+export declare function isRightType(value: unknown, type: JavascriptTypeName): boolean;
+/** Returns true if 'obj' has only keys listed in the 'keys'. Object can't be an array. */
+export declare function hasOnlyKeys(obj: object, keys: string[]): boolean;

package/dist/internal-common/src/websocket.impl.d.ts

@@ -0,0 +1,26 @@
+interface Options {
+    maxAttempts?: number;
+    protocols?: string[];
+    onmessage?: (event: any) => void;
+    onopen?: (event: any) => void;
+    onclose?: (event: any) => void;
+    onerror?: (event: any) => void;
+    onreconnect?: (event: any) => void;
+    onmaximum?: (event: any) => void;
+    timeoutMillis?: number;
+}
+export interface WebSocketWrapper {
+    open: () => void;
+    reconnect: (e: any) => void;
+    json: (x: any) => void;
+    send: (x: string) => void;
+    close: (x?: number, y?: string) => void;
+    connected: boolean;
+    /**
+     * Websocket is explicitly closed by calling socket.close().
+     * Used to ignore errors after socket.closed() is called.
+     */
+    closeCalled: boolean;
+}
+export declare function createWebSocketWrapper(url: string, opts?: Options): WebSocketWrapper;
+export {};

package/dist/typescript-client/src/collection-reference.d.ts

@@ -34,7 +34,7 @@ export declare class CollectionReference<T extends DocumentData> {
     refId: string;
     /**
      * Returns a document reference for the given document id.
-     * The document id is an object that maps the primary keys of the collection (as defined in the Squid Cloud Console)
+     * The document id is an object that maps the primary keys of the collection (as defined in the Squid Console)
      * to their values. There are a few exceptions:
      * 1 - String document id is only supported for the `built_in_db` when a schema was not defined.
      * 2 - Not all the fields in the document id are required. If a field is not provided, it will be generated on the

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

@@ -1 +1,39 @@
-export {};
+import { QueryMetricsRequest, QueryMetricsResponse } from '../../internal-common/src/public-types/metric.public-types';
+/** A client for reporting user metrics and querying both application-related Squid and user metrics. */
+export declare class ObservabilityClient {
+    private readonly rpcManager;
+    private pendingPromises;
+    private isReporting;
+    /**
+     * Reports metrics to the metric submission queue.
+     * The metric can be sent immediately or with some (several seconds) delay
+     * due to optimizations applied by Squid client.
+     * If no tags are provided tags are set to an empty record ({}).
+     * If no timestamp is provided the timestamp is set to now().
+     */
+    reportMetric<MetricNameType = string>(metric: MetricReport<MetricNameType>): void;
+    /**
+     * Flushes all pending (unsent) metrics.
+     * Note: Even after flushing, it may take some time for these metrics to become visible via 'queryMetrics' due to the
+     * eventual consistency of the metrics storage.
+     */
+    flush(): Promise<void>;
+    /** Queries a batch of metric values. */
+    queryMetrics<MetricName extends string = string>(metricRequest: QueryMetricsRequest<MetricName>): Promise<QueryMetricsResponse<MetricName>>;
+}
+/** A single metric event. */
+export interface Metric<MetricNameType = string> {
+    /** Name of the metric. */
+    name: MetricNameType;
+    /** Value of the metric. */
+    value: number;
+    /** Time associated with the metric. Milliseconds since UNIX epoch. */
+    timestamp: number;
+    /** Set of tags for the metric. */
+    tags: Record<string, string>;
+}
+/**
+ * MetricReport represents a single metric event with some optional fields.
+ * These optional fields are automatically populated by Squid with default values.
+ */
+export type MetricReport<MetricNameType = string> = Omit<Metric<MetricNameType>, 'tags' | 'timestamp'> & Partial<Pick<Metric, 'tags' | 'timestamp'>>;

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

@@ -8,6 +8,7 @@ import { QueueManager } from './queue.manager';
 import { SecretClient } from './secret.client';
 import { StorageClient } from './storage-client';
 import { TransactionId } from './types';
+import { ObservabilityClient } from './observability-client';
 import { ExtractionClient } from './extraction-client';
 import { PersonalStorageClient } from './personal-storage-client';
 import { SchedulerClient } from './scheduler-client';
@@ -26,7 +27,7 @@ export interface SquidOptions {
     appId: AppId;
     /**
      * The application API key, using the API key can be used to bypass security rules and other restrictions.
-     * The API key can be found in the Squid Cloud Console.
+     * The API key can be found in the Squid Console.
      */
     apiKey?: ApiKey;
     /**
@@ -41,7 +42,7 @@ export interface SquidOptions {
      */
     authProvider?: SquidAuthProvider;
     /**
-     * The region that the application is running in. This is used to determine the URL of the Squid Cloud API.
+     * The region that the application is running in. This is used to determine the URL of the Squid API.
      */
     region: SquidRegion;
     /**
@@ -207,6 +208,7 @@ export declare class Squid {
     personalStorage(integrationId: IntegrationId): PersonalStorageClient;
     extraction(): ExtractionClient;
     get secrets(): SecretClient;
+    get observability(): ObservabilityClient;
     get schedulers(): SchedulerClient;
     /**
      * Returns a distributed lock for the given mutex. The lock can be used to synchronize access to a shared resource.

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

@@ -1 +1 @@
-export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.281";
+export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.283";

package/package.json

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