@squidcloud/client 1.0.59 → 1.0.60

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

@@ -0,0 +1,236 @@
+import { CollectionName } from '../document.types';
+import { CollectionSchema } from '../schema/schema.types';
+import { BaseIntegrationConfig, DatabaseIntegrationType, IntegrationType } from './index';
+export interface MongoConnectionSecretOptions {
+    password?: string;
+}
+export interface MongoConnectionOptions {
+    secrets: MongoConnectionSecretOptions;
+    connectionString: string;
+    user?: string;
+    replicaSet?: string;
+    ssl?: {
+        certificateFile: string;
+        validate: boolean;
+    };
+    maxPoolSize?: number;
+    minPoolSize?: number;
+    socketTimeoutMS?: number;
+    serverSelectionTimeoutMS?: number;
+    keepAlive?: boolean;
+    directConnection?: boolean;
+}
+export interface MySqlConnectionSecretOptions {
+    password: string;
+}
+export interface OracleConnectionSecretOptions {
+    password: string;
+}
+export interface MssqlConnectionSecretOptions {
+    password: string;
+}
+export interface PostgresConnectionSecretOptions {
+    password: string;
+    sslCertificate?: string;
+}
+export interface MySqlConnectionOptions {
+    secrets: MySqlConnectionSecretOptions;
+    host: string;
+    user: string;
+    database: string;
+    connectionLimit?: number;
+    sslEnabled?: boolean;
+}
+export interface OracleConnectionOptions {
+    secrets: OracleConnectionSecretOptions;
+    host: string;
+    user: string;
+    database: string;
+    connectionLimit?: number;
+}
+export interface MssqlConnectionOptions {
+    secrets: MssqlConnectionSecretOptions;
+    host: string;
+    user: string;
+    schema: string;
+    database: string;
+    connectionLimit?: number;
+    sslEnabled?: boolean;
+}
+export interface PostgresConnectionOptions {
+    host: string;
+    user: string;
+    database: string;
+    schema?: string;
+    sslEnabled?: boolean;
+    secrets: PostgresConnectionSecretOptions;
+}
+export interface SnowflakeConnectionSecretOptions {
+    password: string;
+}
+export interface SnowflakeConnectionOptions {
+    secrets: SnowflakeConnectionSecretOptions;
+    account: string;
+    username: string;
+    database: string;
+    schema: string;
+    warehouse: string;
+    role: string;
+}
+type TableName = string;
+export interface IntegrationDataSchema {
+    collections: Record<TableName, CollectionSchema>;
+}
+export interface BaseDatabaseIntegrationConfig extends BaseIntegrationConfig {
+    type: DatabaseIntegrationType;
+    schema?: IntegrationDataSchema;
+    supportsExternalChanges: boolean;
+}
+export interface MySqlIntegrationConfiguration {
+    connectionOptions: MySqlConnectionOptions;
+}
+export interface OracleIntegrationConfiguration {
+    connectionOptions: OracleConnectionOptions;
+}
+export interface MssqlIntegrationConfiguration {
+    connectionOptions: MssqlConnectionOptions;
+}
+export interface PostgresIntegrationConfiguration {
+    connectionOptions: PostgresConnectionOptions;
+}
+export interface MongoIntegrationConfiguration {
+    connectionOptions: MongoConnectionOptions;
+}
+export interface SnowflakeIntegrationConfiguration {
+    connectionOptions: SnowflakeConnectionOptions;
+}
+export interface MySqlIntegrationConfig extends BaseDatabaseIntegrationConfig {
+    type: IntegrationType.mysql;
+    configuration: MySqlIntegrationConfiguration;
+    schema: IntegrationDataSchema;
+}
+export interface OracleIntegrationConfig extends BaseDatabaseIntegrationConfig {
+    type: IntegrationType.oracledb;
+    configuration: OracleIntegrationConfiguration;
+    schema: IntegrationDataSchema;
+}
+export interface MssqlIntegrationConfig extends BaseDatabaseIntegrationConfig {
+    type: IntegrationType.mssql;
+    configuration: MssqlIntegrationConfiguration;
+    schema: IntegrationDataSchema;
+}
+export interface BasePostgresIntegration extends BaseDatabaseIntegrationConfig {
+    type: IntegrationType.postgres | IntegrationType.cockroach;
+    configuration: PostgresIntegrationConfiguration;
+    schema: IntegrationDataSchema;
+}
+export interface PostgresIntegrationConfig extends BasePostgresIntegration {
+    type: IntegrationType.postgres;
+}
+export interface CockroachIntegrationConfig extends BasePostgresIntegration {
+    type: IntegrationType.cockroach;
+    supportsExternalChanges: false;
+}
+export interface InternalIntegrationConfig extends BaseDatabaseIntegrationConfig {
+    type: IntegrationType.built_in_db;
+}
+export interface MongoIntegrationConfig extends BaseDatabaseIntegrationConfig {
+    type: IntegrationType.mongo;
+    configuration: MongoIntegrationConfiguration;
+}
+export interface SnowflakeIntegrationConfig extends BaseDatabaseIntegrationConfig {
+    type: IntegrationType.snowflake;
+    configuration: SnowflakeIntegrationConfiguration;
+    schema: IntegrationDataSchema;
+    supportsExternalChanges: false;
+}
+interface TestMongoDataConnectionRequest {
+    type: IntegrationType.mongo;
+    configuration: {
+        connectionOptions: MongoConnectionOptions;
+    };
+}
+interface TestMysqlDataConnectionRequest {
+    type: IntegrationType.mysql;
+    configuration: {
+        connectionOptions: MySqlConnectionOptions;
+    };
+}
+interface TestOracleDataConnectionRequest {
+    type: IntegrationType.oracledb;
+    configuration: {
+        connectionOptions: OracleConnectionOptions;
+    };
+}
+interface TestMssqlDataConnectionRequest {
+    type: IntegrationType.mssql;
+    configuration: {
+        connectionOptions: MssqlConnectionOptions;
+    };
+}
+interface TestPostgresDataConnectionRequest {
+    type: IntegrationType.postgres;
+    configuration: {
+        connectionOptions: PostgresConnectionOptions;
+    };
+}
+interface TestSnowflakeDataConnectionRequest {
+    type: IntegrationType.snowflake;
+    configuration: {
+        connectionOptions: SnowflakeConnectionOptions;
+    };
+}
+interface TestCockroachDataConnectionRequest {
+    type: IntegrationType.cockroach;
+    configuration: {
+        connectionOptions: PostgresConnectionOptions;
+    };
+}
+export type TestDataConnectionRequest = TestMongoDataConnectionRequest | TestMysqlDataConnectionRequest | TestOracleDataConnectionRequest | TestMssqlDataConnectionRequest | TestCockroachDataConnectionRequest | TestPostgresDataConnectionRequest | TestSnowflakeDataConnectionRequest;
+export interface CollectionReadiness {
+    hasPermissions: boolean;
+    grantPermissionsCommands: string[];
+    replicationEnabled: boolean;
+    enableReplicationCommands: string[];
+}
+export interface DiscoverDataConnectionSchemaResponse {
+    schema: IntegrationDataSchema;
+    collectionReadiness: Record<CollectionName, CollectionReadiness>;
+}
+interface DiscoverMongoDataConnectionSchemaRequest {
+    integrationType: IntegrationType.mongo;
+    connectionOptions: MongoConnectionOptions;
+}
+interface DiscoverInternalDataConnectionSchemaRequest {
+    integrationType: IntegrationType.built_in_db;
+}
+interface DiscoverMysqlDataConnectionSchemaRequest {
+    integrationType: IntegrationType.mysql;
+    connectionOptions: MySqlConnectionOptions;
+}
+interface DiscoverOracleDataConnectionSchemaRequest {
+    integrationType: IntegrationType.oracledb;
+    connectionOptions: OracleConnectionOptions;
+}
+interface DiscoverMssqlDataConnectionSchemaRequest {
+    integrationType: IntegrationType.mssql;
+    connectionOptions: MssqlConnectionOptions;
+}
+interface DiscoverPostgresDataConnectionSchemaRequest {
+    integrationType: IntegrationType.postgres;
+    connectionOptions: PostgresConnectionOptions;
+}
+interface DiscoverSnowflakeDataConnectionSchemaRequest {
+    integrationType: IntegrationType.snowflake;
+    connectionOptions: SnowflakeConnectionOptions;
+}
+interface DiscoverCockroachDataConnectionSchemaRequest {
+    integrationType: IntegrationType.cockroach;
+    connectionOptions: PostgresConnectionOptions;
+}
+export interface TestDataConnectionResponse {
+    success: boolean;
+    errorMessage?: string;
+}
+export type DiscoverDataConnectionSchemaRequest = DiscoverMongoDataConnectionSchemaRequest | DiscoverInternalDataConnectionSchemaRequest | DiscoverMysqlDataConnectionSchemaRequest | DiscoverOracleDataConnectionSchemaRequest | DiscoverMssqlDataConnectionSchemaRequest | DiscoverCockroachDataConnectionSchemaRequest | DiscoverPostgresDataConnectionSchemaRequest | DiscoverSnowflakeDataConnectionSchemaRequest;
+export {};

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

@@ -0,0 +1,97 @@
+export * from './ai_assistant.types';
+export * from './api.types';
+export * from './auth.types';
+export * from './database.types';
+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 { BaseDatabaseIntegrationConfig, CockroachIntegrationConfig, InternalIntegrationConfig, MongoIntegrationConfig, MssqlIntegrationConfig, MySqlIntegrationConfig, OracleIntegrationConfig, PostgresIntegrationConfig, SnowflakeIntegrationConfig, TestDataConnectionRequest } from './database.types';
+import { DatadogIntegrationConfig, NewRelicIntegrationConfig } from './observability.types';
+export declare enum IntegrationCategory {
+    'database' = "database",
+    'api' = "api",
+    'observability' = "observability",
+    'crm' = "crm",
+    'auth' = "auth",
+    'ai' = "ai"
+}
+export declare enum IntegrationType {
+    'built_in_db' = "built_in_db",
+    'mongo' = "mongo",
+    'mysql' = "mysql",
+    'mssql' = "mssql",
+    'postgres' = "postgres",
+    'cockroach' = "cockroach",
+    'api' = "api",
+    'graphql' = "graphql",
+    'snowflake' = "snowflake",
+    'datadog' = "datadog",
+    'newrelic' = "newrelic",
+    'auth0' = "auth0",
+    'jwt_rsa' = "jwt_rsa",
+    'jwt_hmac' = "jwt_hmac",
+    'ai_assistant' = "ai_assistant",
+    'algolia' = "algolia",
+    'elastic_observability' = "elastic_observability",
+    'elastic_search' = "elastic_search",
+    'elastic_enterprise_search' = "elastic_enterprise_search",
+    'sentry' = "sentry",
+    'sap_hana' = "sap_hana",
+    'salesforce_crm' = "salesforce_crm",
+    'documentdb' = "documentdb",
+    'dynamodb' = "dynamodb",
+    'cassandra' = "cassandra",
+    'clickhouse' = "clickhouse",
+    'alloydb' = "alloydb",
+    'spanner' = "spanner",
+    'db2' = "db2",
+    'mariadb' = "mariadb",
+    'oracledb' = "oracledb",
+    'redis' = "redis",
+    'xata' = "xata",
+    'azure_sql' = "azure_sql"
+}
+export interface IntegrationConfigTypes {
+    [IntegrationType.built_in_db]: InternalIntegrationConfig;
+    [IntegrationType.mongo]: MongoIntegrationConfig;
+    [IntegrationType.mysql]: MySqlIntegrationConfig;
+    [IntegrationType.oracledb]: OracleIntegrationConfig;
+    [IntegrationType.mssql]: MssqlIntegrationConfig;
+    [IntegrationType.postgres]: PostgresIntegrationConfig;
+    [IntegrationType.cockroach]: CockroachIntegrationConfig;
+    [IntegrationType.snowflake]: SnowflakeIntegrationConfig;
+    [IntegrationType.api]: HttpApiIntegrationConfig;
+    [IntegrationType.graphql]: GraphQLIntegrationConfig;
+    [IntegrationType.datadog]: DatadogIntegrationConfig;
+    [IntegrationType.newrelic]: NewRelicIntegrationConfig;
+    [IntegrationType.auth0]: Auth0IntegrationConfig;
+    [IntegrationType.jwt_rsa]: JwtRsaIntegrationConfig;
+    [IntegrationType.jwt_hmac]: JwtHmacIntegrationConfig;
+    [IntegrationType.ai_assistant]: AiAssistantIntegrationConfig;
+}
+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 type ApiIntegrationType = (typeof ApiIntegrationTypes)[number];
+export type ApiIntegrationConfig = IntegrationConfigTypes[ApiIntegrationType];
+export type ObservabilityIntegrationType = (typeof ObservabilityIntegrationTypes)[number];
+export type ObservabilityIntegrationConfig = IntegrationConfigTypes[ObservabilityIntegrationType];
+export type AuthIntegrationType = (typeof AuthIntegrationTypes)[number];
+export type AuthIntegrationConfig = IntegrationConfigTypes[AuthIntegrationType];
+export declare function isDataIntegrationType(type: IntegrationType): type is DatabaseIntegrationType;
+export declare function isDataIntegration(integration: any): integration is BaseDatabaseIntegrationConfig;
+export declare function isAuthIntegrationType(type: IntegrationType): type is AuthIntegrationType;
+export declare function isAuthIntegration(integration: any): integration is AuthIntegrationConfig;
+export type IntegrationConfig = DatabaseIntegrationConfig | ApiIntegrationConfig | ObservabilityIntegrationConfig | AuthIntegrationConfig | AiAssistantIntegrationConfig;
+export interface BaseIntegrationConfig {
+    id: IntegrationId;
+    type: IntegrationType;
+    creationDate: Date;
+    updateDate: Date;
+}
+export type TestConnectionRequest = TestDataConnectionRequest | TestGraphQLDataConnectionRequest;

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

@@ -0,0 +1,22 @@
+import { BaseIntegrationConfig, IntegrationType } from './index';
+export interface DatadogIntegrationConfig extends BaseIntegrationConfig {
+    type: IntegrationType.datadog;
+    configuration: DatadogIntegrationConfiguration;
+}
+export interface NewRelicIntegrationConfig extends BaseIntegrationConfig {
+    type: IntegrationType.newrelic;
+    configuration: NewRelicIntegrationConfiguration;
+}
+export type DatadogRegion = 'us1' | 'us3' | 'us5' | 'eu1' | 'us1-fed';
+export declare const datadogRegionMap: Record<DatadogRegion, string>;
+export interface DatadogIntegrationConfiguration {
+    apiKey: string;
+    appKey: string;
+    datadogRegion: DatadogRegion;
+}
+export type NewRelicRegion = 'worldwide' | 'eu';
+export declare const newRelicRegionMap: Record<NewRelicRegion, string>;
+export interface NewRelicIntegrationConfiguration {
+    apiKey: string;
+    newRelicRegion: NewRelicRegion;
+}

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

@@ -23,9 +23,6 @@ export type SetCustomSecretRequest = Omit<SecretEntry, 'lastUpdated'>;
 export interface DeleteCustomSecretRequest {
     key: SecretKey;
 }
-export interface GetApiKeyRequest {
-    apiKeyName: ApiKeyName;
-}
 export interface GetApiKeyResponse {
     apiKey: string | undefined;
 }

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

@@ -1,7 +1,7 @@
 import { ClientId, ClientRequestId, IntegrationId } from './communication.types';
+import { AuthToken } from './context.types';
 import { CollectionName, DocTimestamp, SquidDocId, SquidDocument } from './document.types';
 import { MutationType } from './mutation.types';
-import { AuthToken } from './context.types';
 export type MessageId = string;
 export type MessageFromClientType = 'acknowledge' | 'catchup' | 'kill' | 'acquireLock' | 'releaseLock';
 interface BaseMessageFromClient {
@@ -35,7 +35,7 @@ export interface ReleaseLockMessage extends BaseMessageFromClient {
     };
 }
 export type MessageFromClient = AcknowledgeMessage | CatchupMessage | KillMessage | AcquireLockMessage | ReleaseLockMessage;
-export type MessageToClientType = 'mutations' | 'query' | 'backendFunction' | 'api' | 'namedQuery' | 'lockAcquired' | 'lockReleased';
+export type MessageToClientType = 'mutations' | 'query' | 'backendFunction' | 'api' | 'namedQuery' | 'lockAcquired' | 'lockReleased' | 'aiAssistant';
 interface BaseMessageToClient {
     type: MessageToClientType;
     messageId: MessageId;
@@ -73,7 +73,15 @@ export interface LockReleasedResponseMessageToClient extends BaseMessageToClient
         lockId: string;
     };
 }
-export type MessageToClient = MutationsMessageToClient | QueryResultMessageToClient | BackendFunctionMessageToClient | NamedQueryMessageToClient | ApiResponseMessageToClient | LockAcquiredResponseMessageToClient | LockReleasedResponseMessageToClient;
+export interface AiAssistantMessageToClient extends BaseMessageToClient {
+    type: 'aiAssistant';
+    clientRequestId: ClientRequestId;
+    payload: {
+        token: string;
+        complete: boolean;
+    };
+}
+export type MessageToClient = MutationsMessageToClient | QueryResultMessageToClient | BackendFunctionMessageToClient | NamedQueryMessageToClient | ApiResponseMessageToClient | LockAcquiredResponseMessageToClient | LockReleasedResponseMessageToClient | AiAssistantMessageToClient;
 export interface MutationsMessageToClient extends BaseMessageToClient {
     type: 'mutations';
     payload: Array<MutationResultData>;

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

@@ -5,7 +5,7 @@
  */
 import { OpenIdProvider } from '../application.types';
 import { HttpStatus } from '../http-status.enum';
-export type StatusCode = HttpStatus.BAD_REQUEST | HttpStatus.NOT_FOUND | HttpStatus.FORBIDDEN | HttpStatus.UNAUTHORIZED;
+export type StatusCode = HttpStatus.BAD_REQUEST | HttpStatus.NOT_FOUND | HttpStatus.FORBIDDEN | HttpStatus.UNAUTHORIZED | HttpStatus.CONFLICT;
 export declare class ValidationError extends Error {
     readonly statusCode: StatusCode;
     readonly details?: any;