@squidcloud/client 1.0.57 → 1.0.59

package/dist/common/src/logger.types.d.ts

@@ -1,21 +1,21 @@
-export type LoggerContext = Record<string, any>;
-export interface Logger {
-    trace(message: string, context?: LoggerContext): void;
-    debug(message: string, context?: LoggerContext): void;
-    info(message: string, context?: LoggerContext): void;
-    warn(message: string, context?: LoggerContext): void;
-    error(message: string, context?: LoggerContext): void;
-    log(record: LogRecord): void;
-}
-export declare enum LogLevel {
-    TRACE = "trace",
-    DEBUG = "debug",
-    INFO = "info",
-    WARN = "warn",
-    ERROR = "error"
-}
-export interface LogRecord {
-    level?: LogLevel;
-    message?: string;
-    [key: string]: any;
-}
+export type LoggerContext = Record<string, any>;
+export interface Logger {
+    trace(message: string, context?: LoggerContext): void;
+    debug(message: string, context?: LoggerContext): void;
+    info(message: string, context?: LoggerContext): void;
+    warn(message: string, context?: LoggerContext): void;
+    error(message: string, context?: LoggerContext): void;
+    log(record: LogRecord): void;
+}
+export declare enum LogLevel {
+    TRACE = "trace",
+    DEBUG = "debug",
+    INFO = "info",
+    WARN = "warn",
+    ERROR = "error"
+}
+export interface LogRecord {
+    level?: LogLevel;
+    message?: string;
+    [key: string]: any;
+}

package/dist/common/src/metrics.types.d.ts

@@ -1,58 +1,58 @@
-export type MetricType = 'count' | 'gauge';
-export type AggregationPeriod = '1m' | '5m' | '15m' | '1h' | '1d' | '1w';
-export declare const aggregationPeriodMap: Record<AggregationPeriod, number>;
-export interface CountMetricHistogramData {
-    stepInterval: number;
-    sumInStep: number;
-    cumulativeSum: number;
-    rate: number;
-}
-export interface CountMetricSummary {
-    cumulativeRate: number;
-    cumulativeSum: number;
-}
-export interface GaugeMetricHistogramData {
-    stepInterval: number;
-    sumInStep: number;
-    countInStep: number;
-    minInStep: number;
-    maxInStep: number;
-    avgInStep: number;
-    medianInStep: number;
-}
-export interface GaugeMetricSummary {
-    cumulativeSum: number;
-    cumulativeMin: number;
-    cumulativeMax: number;
-    cumulativeAvg: number;
-    cumulativeCount: number;
-}
-interface BaseMetricResponse {
-    type: MetricType;
-}
-export interface CountMetricResponse extends BaseMetricResponse {
-    type: 'count';
-    histogram: Array<CountMetricHistogramData>;
-    summary: CountMetricSummary;
-}
-export interface GaugeMetricResponse extends BaseMetricResponse {
-    type: 'gauge';
-    histogram: Array<GaugeMetricHistogramData>;
-    summary: GaugeMetricSummary;
-}
-export type MetricResponse = CountMetricResponse | GaugeMetricResponse;
-export interface GetSingleMetricRequest {
-    metricName: string;
-    tagFilters: Record<string, string | Array<string>>;
-    metricType: MetricType;
-}
-export interface GetMetricsRequest {
-    requests: Array<GetSingleMetricRequest>;
-    from: number;
-    to: number;
-    aggregationPeriod: AggregationPeriod;
-}
-export interface GetMetricsResponse {
-    responses: Array<MetricResponse>;
-}
-export {};
+export type MetricType = 'count' | 'gauge';
+export type AggregationPeriod = '1m' | '5m' | '15m' | '1h' | '1d' | '1w';
+export declare const aggregationPeriodMap: Record<AggregationPeriod, number>;
+export interface CountMetricHistogramData {
+    stepInterval: number;
+    sumInStep: number;
+    cumulativeSum: number;
+    rate: number;
+}
+export interface CountMetricSummary {
+    cumulativeRate: number;
+    cumulativeSum: number;
+}
+export interface GaugeMetricHistogramData {
+    stepInterval: number;
+    sumInStep: number;
+    countInStep: number;
+    minInStep: number;
+    maxInStep: number;
+    avgInStep: number;
+    medianInStep: number;
+}
+export interface GaugeMetricSummary {
+    cumulativeSum: number;
+    cumulativeMin: number;
+    cumulativeMax: number;
+    cumulativeAvg: number;
+    cumulativeCount: number;
+}
+interface BaseMetricResponse {
+    type: MetricType;
+}
+export interface CountMetricResponse extends BaseMetricResponse {
+    type: 'count';
+    histogram: Array<CountMetricHistogramData>;
+    summary: CountMetricSummary;
+}
+export interface GaugeMetricResponse extends BaseMetricResponse {
+    type: 'gauge';
+    histogram: Array<GaugeMetricHistogramData>;
+    summary: GaugeMetricSummary;
+}
+export type MetricResponse = CountMetricResponse | GaugeMetricResponse;
+export interface GetSingleMetricRequest {
+    metricName: string;
+    tagFilters: Record<string, string | Array<string>>;
+    metricType: MetricType;
+}
+export interface GetMetricsRequest {
+    requests: Array<GetSingleMetricRequest>;
+    from: number;
+    to: number;
+    aggregationPeriod: AggregationPeriod;
+}
+export interface GetMetricsResponse {
+    responses: Array<MetricResponse>;
+}
+export {};

package/dist/common/src/mutation.context.d.ts

@@ -1,10 +1,10 @@
-import { Mutation, MutationType } from './mutation.types';
-import { BeforeAndAfterDocs } from './document.types';
-import { Paths } from './types';
-export declare class MutationContext<T = any> {
-    readonly mutation: Mutation<T>;
-    readonly beforeAndAfterDocs: BeforeAndAfterDocs<T>;
-    readonly serverTimeStamp: Date;
-    getMutationType(): MutationType;
-    affectsPath(path: Paths<T>): boolean;
-}
+import { Mutation, MutationType } from './mutation.types';
+import { BeforeAndAfterDocs } from './document.types';
+import { Paths } from './types';
+export declare class MutationContext<T = any> {
+    readonly mutation: Mutation<T>;
+    readonly beforeAndAfterDocs: BeforeAndAfterDocs<T>;
+    readonly serverTimeStamp: Date;
+    getMutationType(): MutationType;
+    affectsPath(path: Paths<T>): boolean;
+}

package/dist/common/src/mutation.schemas.d.ts

@@ -1,5 +1,5 @@
-import { JSONSchemaType } from 'ajv';
-import { MutateRequest } from './mutation.types';
-type DocumentBase = Record<string, any>;
-export declare const MutationRequestSchema: JSONSchemaType<MutateRequest<DocumentBase>>;
-export {};
+import { JSONSchemaType } from 'ajv';
+import { MutateRequest } from './mutation.types';
+type DocumentBase = Record<string, any>;
+export declare const MutationRequestSchema: JSONSchemaType<MutateRequest<DocumentBase>>;
+export {};

package/dist/common/src/mutation.types.d.ts

@@ -1,72 +1,72 @@
-import { ClientId, IntegrationId } from './communication.types';
-import { DocTimestamp, FieldName, SquidDocId, SquidDocIdObj, SquidDocument } from './document.types';
-export interface MutateRequest<T = any> {
-    clientId: ClientId;
-    integrationId: IntegrationId;
-    mutations: Array<Mutation<T>>;
-}
-export interface ExecuteMutationsResponse {
-    timestamp: DocTimestamp;
-    idResolutionMap?: IdResolutionMap;
-    afterDocs: Record<SquidDocId, SquidDocument>;
-}
-export interface MutateResponse extends Omit<ExecuteMutationsResponse, 'afterDocs'> {
-    refreshList: Array<SquidDocId>;
-}
-export type IdResolutionMap = Record<SquidDocId, SquidDocId>;
-export type Mutation<T = any> = UpdateMutation<T> | InsertMutation<T> | DeleteMutation;
-export type MutationType = 'insert' | 'update' | 'delete';
-interface BaseMutation {
-    type: MutationType;
-    squidDocIdObj: SquidDocIdObj;
-}
-export interface DeleteMutation extends BaseMutation {
-    type: 'delete';
-}
-export interface UpdateMutation<T = any> extends BaseMutation {
-    type: 'update';
-    properties: {
-        [key in keyof T & string]?: Array<PropertyMutation<T[key]>>;
-    };
-}
-export interface InsertMutation<T = any> extends BaseMutation {
-    type: 'insert';
-    properties: T;
-}
-export type PropertyMutation<Value = any> = ApplyNumericFnPropertyMutation | ApplyStringFnPropertyMutation | ValueUpdatePropertyMutation<Value> | RemovePropertyMutation;
-export interface ValueUpdatePropertyMutation<Value = any> {
-    type: 'update';
-    value: Value;
-}
-export interface ApplyNumericFnPropertyMutation {
-    type: 'applyNumericFn';
-    fn: 'increment';
-    value: number;
-}
-export interface RemovePropertyMutation {
-    type: 'removeProperty';
-}
-interface ApplyExtendString {
-    type: 'applyStringFn';
-    fn: 'extendString';
-    value: string;
-}
-interface ApplyTrimString {
-    type: 'applyStringFn';
-    fn: 'trim';
-}
-export type ApplyStringFnPropertyMutation = ApplyExtendString | ApplyTrimString;
-/**
- * Sorts the update mutation properties in the order the properties should be applied. If the update mutation has
- * updates for both 'a' and 'a.b', the update should be applied first to 'a' and then to 'a.b'.
- */
-export declare function sortUpdateMutationProperties(updateMutation: UpdateMutation): Array<[FieldName, Array<PropertyMutation>]>;
-export declare function mergeMutations(mutationA: Mutation, mutationB: Mutation): Mutation;
-export declare function applyUpdateMutation<T extends SquidDocument>(doc: T, updateMutation: UpdateMutation<T>): T | undefined;
-export declare function convertInsertToUpdate(insertMutation: InsertMutation): UpdateMutation;
-/**
- * Reduces the list of mutations such that each document will have a single mutation. If for example there are multiple
- * updates to the same document, those will be merged and a single update will be returned.
- */
-export declare function reduceMutations(mutations: Array<Mutation<unknown>>): Array<Mutation<unknown>>;
-export {};
+import { ClientId, IntegrationId } from './communication.types';
+import { DocTimestamp, FieldName, SquidDocId, SquidDocIdObj, SquidDocument } from './document.types';
+export interface MutateRequest<T = any> {
+    clientId: ClientId;
+    integrationId: IntegrationId;
+    mutations: Array<Mutation<T>>;
+}
+export interface ExecuteMutationsResponse {
+    timestamp: DocTimestamp;
+    idResolutionMap?: IdResolutionMap;
+    afterDocs: Record<SquidDocId, SquidDocument>;
+}
+export interface MutateResponse extends Omit<ExecuteMutationsResponse, 'afterDocs'> {
+    refreshList: Array<SquidDocId>;
+}
+export type IdResolutionMap = Record<SquidDocId, SquidDocId>;
+export type Mutation<T = any> = UpdateMutation<T> | InsertMutation<T> | DeleteMutation;
+export type MutationType = 'insert' | 'update' | 'delete';
+interface BaseMutation {
+    type: MutationType;
+    squidDocIdObj: SquidDocIdObj;
+}
+export interface DeleteMutation extends BaseMutation {
+    type: 'delete';
+}
+export interface UpdateMutation<T = any> extends BaseMutation {
+    type: 'update';
+    properties: {
+        [key in keyof T & string]?: Array<PropertyMutation<T[key]>>;
+    };
+}
+export interface InsertMutation<T = any> extends BaseMutation {
+    type: 'insert';
+    properties: T;
+}
+export type PropertyMutation<Value = any> = ApplyNumericFnPropertyMutation | ApplyStringFnPropertyMutation | ValueUpdatePropertyMutation<Value> | RemovePropertyMutation;
+export interface ValueUpdatePropertyMutation<Value = any> {
+    type: 'update';
+    value: Value;
+}
+export interface ApplyNumericFnPropertyMutation {
+    type: 'applyNumericFn';
+    fn: 'increment';
+    value: number;
+}
+export interface RemovePropertyMutation {
+    type: 'removeProperty';
+}
+interface ApplyExtendString {
+    type: 'applyStringFn';
+    fn: 'extendString';
+    value: string;
+}
+interface ApplyTrimString {
+    type: 'applyStringFn';
+    fn: 'trim';
+}
+export type ApplyStringFnPropertyMutation = ApplyExtendString | ApplyTrimString;
+/**
+ * Sorts the update mutation properties in the order the properties should be applied. If the update mutation has
+ * updates for both 'a' and 'a.b', the update should be applied first to 'a' and then to 'a.b'.
+ */
+export declare function sortUpdateMutationProperties(updateMutation: UpdateMutation): Array<[FieldName, Array<PropertyMutation>]>;
+export declare function mergeMutations(mutationA: Mutation, mutationB: Mutation): Mutation;
+export declare function applyUpdateMutation<T extends SquidDocument>(doc: T, updateMutation: UpdateMutation<T>): T | undefined;
+export declare function convertInsertToUpdate(insertMutation: InsertMutation): UpdateMutation;
+/**
+ * Reduces the list of mutations such that each document will have a single mutation. If for example there are multiple
+ * updates to the same document, those will be merged and a single update will be returned.
+ */
+export declare function reduceMutations(mutations: Array<Mutation<unknown>>): Array<Mutation<unknown>>;
+export {};

package/dist/common/src/named-query.context.d.ts

@@ -1,4 +1,4 @@
-export declare class NamedQueryContext {
-    readonly params: Record<string, any>;
-    constructor(params: Record<string, any>);
-}
+export declare class NamedQueryContext {
+    readonly params: Record<string, any>;
+    constructor(params: Record<string, any>);
+}

package/dist/common/src/named-query.schemas.d.ts

@@ -1,3 +1,3 @@
-import { JSONSchemaType } from 'ajv';
-import { ExecuteNamedQueryRequest } from './named-query.types';
-export declare const ExecuteNamedQueryRequestSchema: JSONSchemaType<ExecuteNamedQueryRequest>;
+import { JSONSchemaType } from 'ajv';
+import { ExecuteNamedQueryRequest } from './named-query.types';
+export declare const ExecuteNamedQueryRequestSchema: JSONSchemaType<ExecuteNamedQueryRequest>;

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

@@ -1,9 +1,9 @@
-import { ClientId, ClientRequestId, IntegrationId } from './communication.types';
-import { QueryName } from './application.types';
-export interface ExecuteNamedQueryRequest {
-    integrationId: IntegrationId;
-    queryName: QueryName;
-    paramsRecordStr: string;
-    clientRequestId: ClientRequestId;
-    clientId: ClientId;
-}
+import { ClientId, ClientRequestId, IntegrationId } from './communication.types';
+import { QueryName } from './application.types';
+export interface ExecuteNamedQueryRequest {
+    integrationId: IntegrationId;
+    queryName: QueryName;
+    paramsRecordStr: string;
+    clientRequestId: ClientRequestId;
+    clientId: ClientId;
+}

package/dist/common/src/query/index.d.ts

@@ -1,2 +1,2 @@
-export * from './query-context';
-export * from './simple-query-builder';
+export * from './query-context';
+export * from './simple-query-builder';

package/dist/common/src/query/query-context.d.ts

@@ -1,37 +1,37 @@
-import { IntegrationId } from '../communication.types';
-import { CollectionName, FieldName } from '../document.types';
-import { AllOperators, ContextCondition, ContextConditions, FieldSort, GeneralCondition, GeneralConditions, GenericValue, Query } from '../query.types';
-import { PartialBy, Paths } from '../types';
-export declare class QueryContext<T = any> {
-    readonly query: Query<T>;
-    private readonly parsedConditions;
-    get integrationId(): IntegrationId;
-    get collectionName(): CollectionName;
-    get limit(): number;
-    sortedBy(sorts: Array<PartialBy<FieldSort<T>, 'asc'>>): boolean;
-    sortedByExact(sorts: Array<PartialBy<FieldSort<T>, 'asc'>>): boolean;
-    includes<F extends FieldName<T>, O extends AllOperators>(fieldName: F, operator: O, value: GenericValue<T, F, O>): boolean;
-    includesCondition(condition: ContextCondition<T>): boolean;
-    includesConditions(conditions: GeneralConditions<T>): boolean;
-    matchesConditions(conditions: GeneralConditions<T>): boolean;
-    matchesQuery(query: Query<T>): boolean;
-    isSubsetOf<F extends FieldName<T>, O extends AllOperators>(fieldName: F, operator: O, value: GenericValue<T, F, O> | null): boolean;
-    isSubsetOfCondition(condition: GeneralCondition<T>): boolean;
-    isSubsetOfConditions(conditions: GeneralConditions<T>): boolean;
-    isSubsetOfQuery(query: Query<T>): boolean;
-    getConditionsFor<K extends FieldName<T>>(...fieldNames: K[]): ContextConditions<T, K>;
-    getConditionsForField<K extends Paths<T>>(fieldName: K): ContextConditions<T>;
-    /**
-     * Compares a condition against a given operator and value to determine if the
-     * provided condition is a subset of the operator and value. A condition is
-     * considered a subset if all values that satisfy (return true for) the
-     * condition also satisfy the operator and value.
-     *
-     * This is done using the underlying CompareTable, which provides a comparison
-     * function for each operator pair, or undefined if the comparison would
-     * always be false, regardless of the values.
-     */
-    private evaluateSubset;
-    private evaluateIncludes;
-    private parseConditions;
-}
+import { IntegrationId } from '../communication.types';
+import { CollectionName, FieldName } from '../document.types';
+import { AllOperators, ContextCondition, ContextConditions, FieldSort, GeneralCondition, GeneralConditions, GenericValue, Query } from '../query.types';
+import { PartialBy, Paths } from '../types';
+export declare class QueryContext<T = any> {
+    readonly query: Query<T>;
+    private readonly parsedConditions;
+    get integrationId(): IntegrationId;
+    get collectionName(): CollectionName;
+    get limit(): number;
+    sortedBy(sorts: Array<PartialBy<FieldSort<T>, 'asc'>>): boolean;
+    sortedByExact(sorts: Array<PartialBy<FieldSort<T>, 'asc'>>): boolean;
+    includes<F extends FieldName<T>, O extends AllOperators>(fieldName: F, operator: O, value: GenericValue<T, F, O>): boolean;
+    includesCondition(condition: ContextCondition<T>): boolean;
+    includesConditions(conditions: GeneralConditions<T>): boolean;
+    matchesConditions(conditions: GeneralConditions<T>): boolean;
+    matchesQuery(query: Query<T>): boolean;
+    isSubsetOf<F extends FieldName<T>, O extends AllOperators>(fieldName: F, operator: O, value: GenericValue<T, F, O> | null): boolean;
+    isSubsetOfCondition(condition: GeneralCondition<T>): boolean;
+    isSubsetOfConditions(conditions: GeneralConditions<T>): boolean;
+    isSubsetOfQuery(query: Query<T>): boolean;
+    getConditionsFor<K extends FieldName<T>>(...fieldNames: K[]): ContextConditions<T, K>;
+    getConditionsForField<K extends Paths<T>>(fieldName: K): ContextConditions<T>;
+    /**
+     * Compares a condition against a given operator and value to determine if the
+     * provided condition is a subset of the operator and value. A condition is
+     * considered a subset if all values that satisfy (return true for) the
+     * condition also satisfy the operator and value.
+     *
+     * This is done using the underlying CompareTable, which provides a comparison
+     * function for each operator pair, or undefined if the comparison would
+     * always be false, regardless of the values.
+     */
+    private evaluateSubset;
+    private evaluateIncludes;
+    private parseConditions;
+}