@squidcloud/client 1.0.71 → 1.0.73

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

@@ -10,13 +10,3 @@ export declare const allEnvironmentIds: Array<EnvironmentId>;
 /** A type alias for an integration id. */
 export type IntegrationId = string;
 export type SquidDeveloperId = string;
-export interface ParsedAppId {
-    appId: AppId;
-    environmentId: EnvironmentId;
-    squidDeveloperId?: SquidDeveloperId;
-}
-export declare function parseAppId(appId: AppId): ParsedAppId;
-export declare function appIdWithEnvironmentId(appId: AppId, environmentId: EnvironmentId | undefined): AppId;
-export declare function validateEnvironment(appId: AppId): ParsedAppId;
-export declare function verifyWithSquidDevId(appId: AppId): void;
-export declare function omitSquidDevId(appId: AppId): AppId;

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

@@ -0,0 +1 @@
+export declare function checkAllHeartbeatProviders(heartbeatProviders: Record<string, HeartbeatProvider>): Promise<void>;

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

@@ -4,7 +4,6 @@ export * from './api-call.context';
 export * from './api.types';
 export * from './application.schemas';
 export * from './application.types';
-export * from './auth.types';
 export * from './backend-function.schemas';
 export * from './backend-function.types';
 export * from './backend-run.types';
@@ -52,3 +51,4 @@ export * from './utils/transforms';
 export * from './utils/url';
 export * from './utils/validation';
 export * from './webhook-response';
+export * from './heartbeat.types';

package/dist/common/src/integrations/auth.types.d.ts

@@ -1,4 +1,3 @@
-import { Validations } from '../auth.types';
 import { BaseIntegrationConfig, IntegrationType } from './index';
 export interface Auth0IntegrationConfig extends BaseIntegrationConfig {
     type: IntegrationType.auth0;
@@ -7,11 +6,22 @@ export interface Auth0IntegrationConfig extends BaseIntegrationConfig {
         domain: string;
     };
 }
+export interface CognitoIntegrationConfig extends BaseIntegrationConfig {
+    type: IntegrationType.cognito;
+    configuration: {
+        region: string;
+        userPoolId: string;
+        appClientId: string;
+    };
+}
 export interface JwtRsaIntegrationConfig extends BaseIntegrationConfig {
     type: IntegrationType.jwt_rsa;
     configuration: {
         jwksUri: string;
-        validations?: Validations;
+        validations?: {
+            aud?: string;
+            iss?: string;
+        };
     };
 }
 export interface JwtHmacIntegrationConfig extends BaseIntegrationConfig {

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

@@ -6,7 +6,7 @@ export * from './observability.types';
 import { IntegrationId } from '../communication.types';
 import { AiAssistantIntegrationConfig } from './ai_assistant.types';
 import { GraphQLIntegrationConfig, HttpApiIntegrationConfig, TestGraphQLDataConnectionRequest } from './api.types';
-import { Auth0IntegrationConfig, JwtHmacIntegrationConfig, JwtRsaIntegrationConfig } from './auth.types';
+import { Auth0IntegrationConfig, CognitoIntegrationConfig, JwtHmacIntegrationConfig, JwtRsaIntegrationConfig } from './auth.types';
 import { BaseDatabaseIntegrationConfig, CockroachIntegrationConfig, InternalIntegrationConfig, MongoIntegrationConfig, MssqlIntegrationConfig, MySqlIntegrationConfig, OracleIntegrationConfig, PostgresIntegrationConfig, SnowflakeIntegrationConfig, TestDataConnectionRequest } from './database.types';
 import { DatadogIntegrationConfig, NewRelicIntegrationConfig } from './observability.types';
 export declare enum IntegrationCategory {
@@ -33,6 +33,7 @@ export declare enum IntegrationType {
     'jwt_rsa' = "jwt_rsa",
     'jwt_hmac' = "jwt_hmac",
     'ai_assistant' = "ai_assistant",
+    'cognito' = "cognito",
     'algolia' = "algolia",
     'elastic_observability' = "elastic_observability",
     'elastic_search' = "elastic_search",
@@ -70,13 +71,14 @@ export interface IntegrationConfigTypes {
     [IntegrationType.jwt_rsa]: JwtRsaIntegrationConfig;
     [IntegrationType.jwt_hmac]: JwtHmacIntegrationConfig;
     [IntegrationType.ai_assistant]: AiAssistantIntegrationConfig;
+    [IntegrationType.cognito]: CognitoIntegrationConfig;
 }
 export declare const DatabaseIntegrationTypes: readonly [IntegrationType.built_in_db, IntegrationType.mongo, IntegrationType.mysql, IntegrationType.mssql, IntegrationType.postgres, IntegrationType.cockroach, IntegrationType.snowflake, IntegrationType.oracledb];
 export type DatabaseIntegrationType = (typeof DatabaseIntegrationTypes)[number];
 export type DatabaseIntegrationConfig = IntegrationConfigTypes[DatabaseIntegrationType];
 export declare const ApiIntegrationTypes: readonly [IntegrationType.api, IntegrationType.graphql];
 export declare const ObservabilityIntegrationTypes: readonly [IntegrationType.datadog, IntegrationType.newrelic];
-export declare const AuthIntegrationTypes: readonly [IntegrationType.auth0, IntegrationType.jwt_rsa, IntegrationType.jwt_hmac];
+export declare const AuthIntegrationTypes: readonly [IntegrationType.auth0, IntegrationType.jwt_rsa, IntegrationType.jwt_hmac, IntegrationType.cognito];
 export type ApiIntegrationType = (typeof ApiIntegrationTypes)[number];
 export type ApiIntegrationConfig = IntegrationConfigTypes[ApiIntegrationType];
 export type ObservabilityIntegrationType = (typeof ObservabilityIntegrationTypes)[number];

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

@@ -1,5 +1,5 @@
 import { IntegrationId } from '../communication.types';
-import { CollectionName, FieldName } from '../document.types';
+import { CollectionName, DocumentData, 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> {
@@ -21,6 +21,11 @@ export declare class QueryContext<T = any> {
     isSubsetOfQuery(query: Query<T>): boolean;
     getConditionsFor<K extends FieldName<T>>(...fieldNames: K[]): ContextConditions<T, K>;
     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;
     /**
      * 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

package/dist/common/src/query/simple-query-builder.d.ts

@@ -2,7 +2,7 @@ import { IntegrationId } from '../communication.types';
 import { CollectionName, DocumentData, FieldName, PrimitiveFieldType } from '../document.types';
 import { Operator, Query } from '../query.types';
 /** Base interface for a query builder. */
-export interface BaseQueryBuilderInterface<MyDocType extends DocumentData> {
+export declare abstract class BaseQueryBuilderInterface<MyDocType extends DocumentData> {
     /**
      * Adds a condition to the query.
      * @param fieldName The name of the field to query.
@@ -10,7 +10,7 @@ export interface BaseQueryBuilderInterface<MyDocType extends DocumentData> {
      * @param value The value to compare against.
      * @returns The query builder.
      */
-    where(fieldName: (keyof MyDocType & FieldName) | string, operator: Operator | 'in' | 'not in', value: PrimitiveFieldType | Array<PrimitiveFieldType>): this;
+    abstract where(fieldName: (keyof MyDocType & FieldName) | string, operator: Operator | 'in' | 'not in', value: PrimitiveFieldType | Array<PrimitiveFieldType>): this;
     /**
      * A shortcut for where(fieldName, '==', value)
      *
@@ -92,7 +92,7 @@ export interface BaseQueryBuilderInterface<MyDocType extends DocumentData> {
      * @param limit The limit to set.
      * @returns The query builder.
      */
-    limit(limit: number): this;
+    abstract limit(limit: number): this;
     /**
      * Adds a sort order to the query. You can add multiple sort orders to the query. The order in which you add them
      * determines the order in which they are applied.
@@ -100,36 +100,16 @@ export interface BaseQueryBuilderInterface<MyDocType extends DocumentData> {
      * @param asc Whether to sort in ascending order. Defaults to true.
      * @returns The query builder.
      */
-    sortBy(fieldName: keyof MyDocType & FieldName, asc?: boolean): this;
+    abstract sortBy(fieldName: keyof MyDocType & FieldName, asc?: boolean): this;
 }
 /** A query builder that can be used to build a query that returns a list of documents. */
-export declare class SimpleQueryBuilder<MyDocType extends DocumentData> implements BaseQueryBuilderInterface<MyDocType> {
+export declare class SimpleQueryBuilder<MyDocType extends DocumentData> extends BaseQueryBuilderInterface<MyDocType> {
     protected readonly collectionName: CollectionName;
     protected readonly integrationId: IntegrationId;
     protected readonly query: Query<MyDocType>;
     /** @inheritDoc */
     where(fieldName: (keyof MyDocType & FieldName) | string, operator: Operator | 'in' | 'not in', value: PrimitiveFieldType | Array<PrimitiveFieldType>): this;
     /** @inheritDoc */
-    eq(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
-    /** @inheritDoc */
-    neq(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
-    /** @inheritDoc */
-    in(fieldName: (keyof MyDocType & FieldName) | string, value: Array<PrimitiveFieldType>): this;
-    /** @inheritDoc */
-    nin(fieldName: (keyof MyDocType & FieldName) | string, value: Array<PrimitiveFieldType>): this;
-    /** @inheritDoc */
-    gt(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
-    /** @inheritDoc */
-    gte(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
-    /** @inheritDoc */
-    lt(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
-    /** @inheritDoc */
-    lte(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
-    /** @inheritDoc */
-    like(fieldName: (keyof MyDocType & FieldName) | string, pattern: string, caseSensitive?: boolean): this;
-    /** @inheritDoc */
-    notLike(fieldName: (keyof MyDocType & FieldName) | string, pattern: string, caseSensitive?: boolean): this;
-    /** @inheritDoc */
     limit(limit: number): this;
     /** @inheritDoc */
     sortBy(fieldName: keyof MyDocType & FieldName, asc?: boolean): this;

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

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

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

@@ -1,3 +1,4 @@
+import { ClientId, ClientRequestId } from './communication.types';
 import { CollectionName, FieldName } from './document.types';
 /** A list of query conditions. */
 export type Conditions<Doc = any, F extends FieldName<Doc> = any> = Array<Condition<Doc, F>>;
@@ -23,7 +24,7 @@ interface NotInContextCondition<Doc = any, F extends FieldName<Doc> = any> exten
     operator: 'not in';
     value: Array<Doc[F]>;
 }
-interface OtherContextCondition<Doc = any, F extends FieldName<Doc> = any> extends Omit<Condition<Doc, F>, 'operator'> {
+export interface OtherContextCondition<Doc = any, F extends FieldName<Doc> = any> extends Omit<Condition<Doc, F>, 'operator'> {
     operator: Exclude<ContextOperator, 'in' | 'not in'>;
 }
 /** A condition that includes the 'in' and 'not in' operators. */
@@ -48,4 +49,10 @@ export interface Query<Doc = any> {
     sortOrder: Array<FieldSort<Doc>>;
     limit: number;
 }
+export interface QueryRegisterRequest {
+    clientId: ClientId;
+    clientRequestId: ClientRequestId;
+    query: Query;
+    parentClientRequestId: ClientRequestId;
+}
 export {};