@squidcloud/client 1.0.278 → 1.0.280

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

@@ -159,6 +159,7 @@ export interface AiChatbotContextBase {
     type: AiChatbotContextType;
     data: string;
     metadata?: AiContextMetadata;
+    password?: string;
 }
 export interface AiSearchResponse {
     chunks: Array<AiSearchResultChunk>;

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

@@ -1,9 +1,13 @@
 export type DocumentFileDataType = 'image';
+export interface ExtractDataFromDocumentFileOptions {
+    password?: string;
+}
 export interface DocumentFileData {
     type: DocumentFileDataType;
     pathInBucket: string;
 }
 export interface DocumentPageData {
+    title?: string;
     text: string;
     fileDataList: DocumentFileData[];
 }
@@ -13,6 +17,7 @@ export interface ExtractDataFromDocumentResponse {
 }
 export interface TextOnlyPageData {
     text: string;
+    title?: string;
 }
 export interface DocumentTextDataResponse {
     pages: TextOnlyPageData[];

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

@@ -1,10 +1,124 @@
 /**
- * A timestamp + value pair. If there is no data for the point 'null' value is used.
+ * Name of metrics publicly provided by the system.
+ * - Metrics suffixed by '_time' are 'gauge' metrics.
+ * - Metrics suffixed by '_count' are 'count' metrics.
+ * All Squid metrics starts with `squid_` prefix.
+ */
+export declare const SQUID_METRIC_NAMES: readonly ["squid_functionExecution_count", "squid_functionExecution_time"];
+export type SquidMetricName = (typeof SQUID_METRIC_NAMES)[number];
+export declare const METRIC_FUNCTIONS: readonly ["sum", "max", "min", "average", "median", "p95", "p99", "count"];
+export type MetricFunction = (typeof METRIC_FUNCTIONS)[number];
+/** Defines source of the metric: reported by user or automatically collected by the system (Squid). */
+export declare const METRIC_DOMAIN: readonly ["user", "squid"];
+export type MetricDomain = (typeof METRIC_DOMAIN)[number];
+export declare const METRIC_INTERVAL_ALIGNMENT: readonly ["align-by-start-time", "align-by-end-time"];
+/** Indicates how to align per-point periods in metric queries. */
+export type MetricIntervalAlignment = (typeof METRIC_INTERVAL_ALIGNMENT)[number];
+export interface QueryMetricsRequestCommon {
+    /** Kind of the metrics (domain) to query. */
+    domain: MetricDomain;
+    /** Start of the queried interval. Must be an integer value. */
+    periodStartSeconds: number;
+    /** End of the queried interval. Must be an integer value. */
+    periodEndSeconds: number;
+    /**
+     * Time interval per point. Must be less than  periodEndSeconds - periodStartSeconds.
+     * Set to 0 or keep undefined to have only 1 value in the result.
+     */
+    pointIntervalSeconds?: number;
+    /**
+     * Specifies the alignment of the per-point interval.
+     * Default: 'align-by-start-time'
+     */
+    pointIntervalAlignment?: MetricIntervalAlignment;
+    /** Aggregation functions that maps multiple points per point region to a single point value. */
+    fn: MetricFunction | Array<MetricFunction>;
+    /**
+     * If there is no data in the specified region this value will be used to fill the gap.
+     * Default: null.
+     */
+    fillValue?: number | null;
+    /**
+     * Tag filters.
+     * TODO: add operations to exclude tags: !=, !contains...
+     */
+    tagFilter?: Record<string, string>;
+    /**
+     * A mapping of known tag values that must be present in the response groups.
+     *
+     * This ensures that the result will include groups for all specified tag values,
+     * even if there is no data for some values in the database.
+     *
+     * Example: Consider a tag 'isError' with two possible values: '0' and '1'.
+     * When 'tagDomains' contains {'isError': ['0', '1']}, the result will include
+     * groups for both 'isError: 0' and 'isError: 1'. If the database lacks data for
+     * 'isError: 1', the points in this group will be set to 'fillValue' (default is 'null').
+     *
+     * The tags in the new groups will be copied from the existing resultGroups,
+     * along with one of the tag domain values.
+     *
+     * @property {Record<string, string[]>} tagDomains - A record where each key is a tag name and
+     * each value is an array of possible values for that tag. Should only contain tags listed in 'groupByTags' field.
+     */
+    tagDomains?: Record<string, string[]>;
+    /** List of ordered tag names for a 'GROUP BY'. */
+    groupByTags?: string[];
+    /** The results will be ordered by the specified tags (ORDER BY). */
+    orderByTags?: string[];
+    /**
+     * Specifies what result will be returned if there were no records found in the database.
+     * In this case the 'resultGroups' array will be empty (default), or can be filled with a default
+     * values if 'return-result-group-with-default-values' is specified.
+     * The generated result group will have 'tagValues' set to empty strings.
+     *
+     * May be useful to get a ready-to-render array with no additional post-processing required.
+     *
+     * Note: 'tagDomains' can provide similar functionality when set of tag values is defined: multiple result groups
+     * will be filled with default values. There is no need to use this option if 'tagDomains' is used.
+     *
+     * Default: 'return-no-result-groups'
+     */
+    noDataBehavior?: 'return-no-result-groups' | 'return-result-group-with-default-values';
+}
+export interface QueryUserMetricsRequest<NameType extends string = string> extends QueryMetricsRequestCommon {
+    domain: 'user';
+    /** Squid metric name. */
+    name: NameType;
+}
+export interface QuerySquidMetricsRequest<NameType extends SquidMetricName = SquidMetricName> extends QueryMetricsRequestCommon {
+    domain: 'squid';
+    /** User metric name. */
+    name: NameType;
+}
+export type QueryMetricsRequest<NameType extends string = string> = QuerySquidMetricsRequest<NameType extends SquidMetricName ? NameType : SquidMetricName> | QueryUserMetricsRequest<NameType>;
+/**
+ * Every result point is a list of [timestamp, values...],
+ * where list of values are defined by the list of functions in the request.
+ * If there is no data for the point 'null' is used as a 'value'.
  * The timestamp is always equal to the point period start date and is measured in Unix epoch seconds.
  */
-export type QueryMetricResultPoint = [number, number | null];
-export interface QueryMetricResultGroup {
+export type QueryMetricsResultPoint = [number, ...(number | null)[]];
+export interface QueryMetricsResultGroup {
     /** Values of the tags in the group. The tags are ordered the same way as in request.groupByTags collection. */
     tagValues: string[];
-    points: Array<QueryMetricResultPoint>;
+    points: Array<QueryMetricsResultPoint>;
+}
+export interface QueryMetricsResponseCommon {
+    /**
+     * Result of the metrics query.
+     * Contains only 1 element if `groupByTags` are empty, otherwise contains multiple results grouped by tags.
+     */
+    resultGroups: Array<QueryMetricsResultGroup>;
+}
+export interface QueryUserMetricsResponse<NameType extends string = string> extends QueryMetricsResponseCommon {
+    domain: 'user';
+    metricName: NameType;
+}
+/**
+ * A single metric response for 'SquidMetricsRequest'.
+ */
+export interface QuerySquidMetricsResponse<NameType extends SquidMetricName> extends QueryMetricsResponseCommon {
+    domain: 'squid';
+    metricName: NameType;
 }
+export type QueryMetricsResponse<NameType extends string = string> = Required<QuerySquidMetricsResponse<NameType extends SquidMetricName ? NameType : SquidMetricName> | QueryUserMetricsResponse<NameType>>;

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

@@ -1,4 +1,4 @@
-import { QueryMetricRequestCommon, QueryMetricResultGroup } from '../public-types/metric.public-types';
-export type QueryMetricRequestIntervals = Required<Pick<QueryMetricRequestCommon, 'fillValue' | 'groupByTags' | 'periodEndSeconds' | 'periodStartSeconds' | 'pointIntervalAlignment' | 'pointIntervalSeconds' | 'tagDomains' | 'noDataBehavior'>>;
+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: QueryMetricRequestIntervals, resultGroups: Array<QueryMetricResultGroup>): void;
+export declare function fillMissedPoints(request: QueryMetricsRequestIntervals, resultGroups: Array<QueryMetricsResultGroup>): void;

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

@@ -1,20 +1,24 @@
-import { AiChatbotChatOptions, AiChatbotContext, AiChatModelName, AiSearchOptions, AiSearchResponse, AiTranscribeAndAskResponse } from './public-types';
+import { AiChatbotChatOptions, AiChatbotContext, AiChatModelName, AiSearchOptions, AiSearchResponse, AiTranscribeAndAskResponse, AiTranscribeAndChatResponse } from './public-types';
 import { Observable } from 'rxjs';
-interface TranscribeAndChatResponse {
+export interface TranscribeAndChatResponse {
     transcribedPrompt: string;
     responseStream: Observable<string>;
 }
-interface TranscribeAndAskWithVoiceResponse {
+export interface TranscribeAndAskWithVoiceResponse {
     transcribedPrompt: string;
     responseString: string;
     voiceResponseFile: File;
 }
-interface AskWithVoiceResponse {
+export interface AskWithVoiceResponse {
     responseString: string;
     voiceResponseFile: File;
 }
-type ChatOptionsWithoutVoice = Omit<AiChatbotChatOptions, 'voiceOptions'>;
-type AskOptionsWithoutVoice = Omit<AiChatbotChatOptions, 'voiceOptions' | 'smoothTyping'>;
+export interface ChatInternalResponse {
+    responseStream: Observable<string>;
+    serverResponse?: Promise<AiTranscribeAndChatResponse>;
+}
+export type ChatOptionsWithoutVoice = Omit<AiChatbotChatOptions, 'voiceOptions'>;
+export type AskOptionsWithoutVoice = Omit<AiChatbotChatOptions, 'voiceOptions' | 'smoothTyping'>;
 export declare class AiAgentClient {
     private readonly rpcManager;
     private readonly socketManager;
@@ -221,4 +225,3 @@ export declare class AiChatbotContextReference extends AiAgentContextReference {
 }
 export declare class AiChatbotInstructionReference extends AiAgentInstructionReference {
 }
-export {};

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

@@ -1,6 +1,6 @@
 import { BlobAndFilename } from './types';
-import { DocumentTextDataResponse } from '../../internal-common/src/public-types/extraction.public-types';
+import { DocumentTextDataResponse, ExtractDataFromDocumentFileOptions } from '../../internal-common/src/public-types/extraction.public-types';
 export declare class ExtractionClient {
     private readonly rpcManager;
-    extractDataFromDocumentFile(file: File | BlobAndFilename): Promise<DocumentTextDataResponse>;
+    extractDataFromDocumentFile(file: File | BlobAndFilename, options?: ExtractDataFromDocumentFileOptions): Promise<DocumentTextDataResponse>;
 }

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

@@ -1 +1 @@
-export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.278";
+export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.280";

package/package.json

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