@squidcloud/client 1.0.59 → 1.0.60

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

@@ -1,404 +0,0 @@
-import { Validations } from './auth.types';
-import { IntegrationId } from './communication.types';
-import { FieldName } from './document.types';
-import { IntrospectionQuery } from './graphql.types';
-import { CollectionSchema } from './schema/schema.types';
-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 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 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 GraphQLConnectionOptions {
-    baseUrl: string;
-    injectionSchema?: ApiInjectionSchema;
-}
-export type ApiInjectionSchema = Record<FieldName, ApiInjectionField>;
-export interface OpenApiDiscoveryOptions {
-    openApiSpecUrl: string;
-}
-export interface SnowflakeConnectionSecretOptions {
-    password: string;
-}
-export interface SnowflakeConnectionOptions {
-    secrets: SnowflakeConnectionSecretOptions;
-    account: string;
-    username: string;
-    database: string;
-    schema: string;
-    warehouse: string;
-    role: string;
-}
-export declare enum IntegrationCategory {
-    'database' = "database",
-    'api' = "api",
-    'observability' = "observability",
-    'crm' = "crm",
-    'auth' = "auth"
-}
-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",
-    '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.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;
-}
-export declare const DatabaseIntegrationTypes: readonly [IntegrationType.built_in_db, IntegrationType.mongo, IntegrationType.mysql, IntegrationType.mssql, IntegrationType.postgres, IntegrationType.cockroach, IntegrationType.snowflake];
-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 DatabaseIntegrationType = (typeof DatabaseIntegrationTypes)[number];
-export type DatabaseIntegrationConfig = IntegrationConfigTypes[DatabaseIntegrationType];
-export declare function isDataIntegrationType(type: IntegrationType): type is DatabaseIntegrationType;
-export declare function isDataIntegration(integration: any): integration is BaseDatabaseIntegrationConfig;
-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 isAuthIntegrationType(type: IntegrationType): type is AuthIntegrationType;
-export declare function isAuthIntegration(integration: any): integration is AuthIntegrationConfig;
-export type IntegrationConfig = DatabaseIntegrationConfig | ApiIntegrationConfig | ObservabilityIntegrationConfig | AuthIntegrationConfig;
-type TableName = string;
-export interface IntegrationDataSchema {
-    collections: Record<TableName, CollectionSchema>;
-}
-export interface IntegrationGraphQLSchema {
-    introspection: IntrospectionQuery;
-}
-export interface IntegrationApiSchema {
-    baseUrl: string;
-    endpoints: IntegrationApiEndpoints;
-    injectionSchema?: ApiInjectionSchema;
-}
-export type IntegrationApiEndpoints = Record<ApiEndpointId, ApiEndpoint>;
-export type IntegrationSchema = IntegrationDataSchema | IntegrationGraphQLSchema;
-interface BaseIntegrationConfig {
-    id: IntegrationId;
-    type: IntegrationType;
-    creationDate: Date;
-    updateDate: Date;
-}
-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;
-}
-export interface BaseDatabaseIntegrationConfig extends BaseIntegrationConfig {
-    type: DatabaseIntegrationType;
-    schema?: IntegrationDataSchema;
-    supportsExternalChanges: boolean;
-}
-export type HttpMethod = 'post' | 'get' | 'delete' | 'patch' | 'put';
-export type ApiEndpointId = string;
-export type ApiParameterLocation = 'query' | 'body' | 'header' | 'path';
-export type ApiResponseParameterLocation = 'header' | 'body';
-export type ApiInjectionParameterLocation = 'header' | 'query';
-export type FieldPath = string;
-export interface ApiRequestField {
-    location: ApiParameterLocation;
-}
-export interface ApiResponseField {
-    location: ApiResponseParameterLocation;
-    path?: FieldPath;
-}
-export type ApiInjectionFieldType = 'secret' | 'regular';
-export interface ApiInjectionField {
-    value: string;
-    type: ApiInjectionFieldType;
-    location: ApiInjectionParameterLocation;
-}
-export interface ApiEndpoint {
-    relativePath: string;
-    method: HttpMethod;
-    requestSchema?: Record<FieldName, ApiRequestField>;
-    responseSchema?: Record<FieldPath, ApiResponseField>;
-    injectionSchema?: ApiInjectionSchema;
-}
-export interface HttpApiIntegrationConfig extends BaseIntegrationConfig {
-    type: IntegrationType.api;
-    configuration?: {
-        discoveryOptions: OpenApiDiscoveryOptions;
-    };
-    schema: IntegrationApiSchema;
-}
-export interface GraphQLIntegrationConfig extends BaseIntegrationConfig {
-    type: IntegrationType.graphql;
-    schema?: IntegrationGraphQLSchema;
-    configuration: {
-        connectionOptions: GraphQLConnectionOptions;
-    };
-}
-export interface MySqlIntegrationConfiguration {
-    connectionOptions: MySqlConnectionOptions;
-}
-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 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;
-}
-export interface Auth0IntegrationConfig extends BaseIntegrationConfig {
-    type: IntegrationType.auth0;
-    configuration: {
-        clientId: string;
-        domain: string;
-    };
-}
-export interface JwtRsaIntegrationConfig extends BaseIntegrationConfig {
-    type: IntegrationType.jwt_rsa;
-    configuration: {
-        jwksUri: string;
-        validations?: Validations;
-    };
-}
-export interface JwtHmacIntegrationConfig extends BaseIntegrationConfig {
-    type: IntegrationType.jwt_hmac;
-    configuration: {
-        verifyUri?: string;
-    };
-}
-export interface TestDataConnectionResponse {
-    success: boolean;
-    errorMessage?: string;
-}
-interface TestMongoDataConnectionRequest {
-    type: IntegrationType.mongo;
-    configuration: {
-        connectionOptions: MongoConnectionOptions;
-    };
-}
-interface TestMysqlDataConnectionRequest {
-    type: IntegrationType.mysql;
-    configuration: {
-        connectionOptions: MySqlConnectionOptions;
-    };
-}
-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 interface TestGraphQLDataConnectionRequest {
-    type: IntegrationType.graphql;
-    configuration: {
-        connectionOptions: GraphQLConnectionOptions;
-    };
-}
-export type TestDataConnectionRequest = TestMongoDataConnectionRequest | TestMysqlDataConnectionRequest | TestMssqlDataConnectionRequest | TestCockroachDataConnectionRequest | TestPostgresDataConnectionRequest | TestSnowflakeDataConnectionRequest;
-export type TestConnectionRequest = TestDataConnectionRequest | TestGraphQLDataConnectionRequest;
-export interface DiscoverDataConnectionSchemaResponse {
-    schema: IntegrationDataSchema;
-}
-export interface DiscoverGraphQLConnectionSchemaResponse {
-    schema: IntegrationGraphQLSchema;
-}
-export interface DiscoverOpenApiSchemaResponse {
-    schema: IntegrationApiSchema;
-}
-interface DiscoverMongoDataConnectionSchemaRequest {
-    integrationType: IntegrationType.mongo;
-    connectionOptions: MongoConnectionOptions;
-}
-interface DiscoverInternalDataConnectionSchemaRequest {
-    integrationType: IntegrationType.built_in_db;
-}
-interface DiscoverMysqlDataConnectionSchemaRequest {
-    integrationType: IntegrationType.mysql;
-    connectionOptions: MySqlConnectionOptions;
-}
-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 type DiscoverDataConnectionSchemaRequest = DiscoverMongoDataConnectionSchemaRequest | DiscoverInternalDataConnectionSchemaRequest | DiscoverMysqlDataConnectionSchemaRequest | DiscoverMssqlDataConnectionSchemaRequest | DiscoverCockroachDataConnectionSchemaRequest | DiscoverPostgresDataConnectionSchemaRequest | DiscoverSnowflakeDataConnectionSchemaRequest;
-export interface DiscoverGraphQLConnectionSchemaRequest {
-    integrationType: IntegrationType.graphql;
-    connectionOptions: GraphQLConnectionOptions;
-}
-export interface DiscoverOpenApiSchemaRequest {
-    integrationType: IntegrationType.api;
-    discoveryOptions: OpenApiDiscoveryOptions;
-}
-export {};