@squidcloud/client 1.0.133 → 1.0.136

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

@@ -1,39 +1,47 @@
-import { BaseIntegrationConfig, IntegrationType } from './index';
-export interface Auth0IntegrationConfig extends BaseIntegrationConfig {
-    type: IntegrationType.auth0;
-    configuration: {
-        clientId: string;
-        domain: string;
-    };
-}
-export interface CognitoIntegrationConfig extends BaseIntegrationConfig {
-    type: IntegrationType.cognito;
-    configuration: {
-        region: string;
-        userPoolId: string;
-        appClientId: string;
-    };
-}
-export interface OktaIntegrationConfig extends BaseIntegrationConfig {
-    type: IntegrationType.okta;
-    configuration: {
-        domain: string;
-        clientId: string;
-    };
-}
-export interface JwtRsaIntegrationConfig extends BaseIntegrationConfig {
-    type: IntegrationType.jwt_rsa;
-    configuration: {
-        jwksUri: string;
-        validations?: {
-            aud?: string;
-            iss?: string;
-        };
-    };
-}
-export interface JwtHmacIntegrationConfig extends BaseIntegrationConfig {
-    type: IntegrationType.jwt_hmac;
-    configuration: {
-        verifyUri?: string;
-    };
-}
+import { BaseIntegrationConfig, IntegrationType } from './index';
+export interface Auth0IntegrationConfig extends BaseIntegrationConfig {
+    type: IntegrationType.auth0;
+    configuration: {
+        /** Auth0 domain. Used to build JWKS URL (https://$domain/.well-known/jwks.json) to check the JWT token signature.*/
+        domain: string;
+        /**
+         * The Auth0 audience is a parameter that ensures the JWT token is intended for the specific backend being accessed.
+         *
+         * Note: the audience for the web-app auth token is equal to the Auth0 web client id: it means that the web app
+         * client is a target audience for the JWT token. Such JWT tokens (ID tokens) should not be sent to the backend:
+         * backend calls should use another kind of JWT tokens (access tokens) issued by Auth0 for the backends.
+         */
+        clientId: string;
+    };
+}
+export interface CognitoIntegrationConfig extends BaseIntegrationConfig {
+    type: IntegrationType.cognito;
+    configuration: {
+        region: string;
+        userPoolId: string;
+        appClientId: string;
+    };
+}
+export interface OktaIntegrationConfig extends BaseIntegrationConfig {
+    type: IntegrationType.okta;
+    configuration: {
+        domain: string;
+        clientId: string;
+    };
+}
+export interface JwtRsaIntegrationConfig extends BaseIntegrationConfig {
+    type: IntegrationType.jwt_rsa;
+    configuration: {
+        jwksUri: string;
+        validations?: {
+            aud?: string;
+            iss?: string;
+        };
+    };
+}
+export interface JwtHmacIntegrationConfig extends BaseIntegrationConfig {
+    type: IntegrationType.jwt_hmac;
+    configuration: {
+        verifyUri?: string;
+    };
+}

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

@@ -1,274 +1,274 @@
-import { CollectionName } from '../document.types';
-import { CollectionSchema } from '../schema/schema.types';
-import { BaseIntegrationConfig, BaseIntegrationSchema, DatabaseIntegrationType, IntegrationSchemaType, 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 BigQueryConnectionSecretOptions {
-    privateKey: string;
-}
-export interface OracleConnectionSecretOptions {
-    password: string;
-}
-export interface PinotConnectionSecretOptions {
-    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 BigQueryConnectionOptions {
-    secrets: BigQueryConnectionSecretOptions;
-    projectId: string;
-    datasetId: string;
-    email: string;
-}
-export interface OracleConnectionOptions {
-    secrets: OracleConnectionSecretOptions;
-    host: string;
-    user: string;
-    database: string;
-    connectionLimit?: number;
-}
-export interface PinotConnectionOptions {
-    secrets: PinotConnectionSecretOptions;
-    brokerUrl: string;
-    controllerUrl: string;
-    user?: 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 extends BaseIntegrationSchema {
-    type: IntegrationSchemaType.data;
-    collections: Record<TableName, CollectionSchema>;
-}
-export interface BaseDatabaseIntegrationConfig extends BaseIntegrationConfig {
-    type: DatabaseIntegrationType;
-    supportsExternalChanges: boolean;
-}
-export interface MySqlIntegrationConfiguration {
-    connectionOptions: MySqlConnectionOptions;
-}
-export interface BigQueryIntegrationConfiguration {
-    connectionOptions: BigQueryConnectionOptions;
-}
-export interface OracleIntegrationConfiguration {
-    connectionOptions: OracleConnectionOptions;
-}
-export interface PinotIntegrationConfiguration {
-    connectionOptions: PinotConnectionOptions;
-}
-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;
-}
-export interface BigQueryIntegrationConfig extends BaseDatabaseIntegrationConfig {
-    type: IntegrationType.bigquery;
-    configuration: BigQueryIntegrationConfiguration;
-}
-export interface OracleIntegrationConfig extends BaseDatabaseIntegrationConfig {
-    type: IntegrationType.oracledb;
-    configuration: OracleIntegrationConfiguration;
-}
-export interface PinotIntegrationConfig extends BaseDatabaseIntegrationConfig {
-    type: IntegrationType.pinot;
-    configuration: PinotIntegrationConfiguration;
-}
-export interface MssqlIntegrationConfig extends BaseDatabaseIntegrationConfig {
-    type: IntegrationType.mssql;
-    configuration: MssqlIntegrationConfiguration;
-}
-export interface BasePostgresIntegration extends BaseDatabaseIntegrationConfig {
-    type: IntegrationType.postgres | IntegrationType.cockroach;
-    configuration: PostgresIntegrationConfiguration;
-}
-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;
-    supportsExternalChanges: false;
-}
-interface TestMongoDataConnectionRequest {
-    type: IntegrationType.mongo;
-    configuration: {
-        connectionOptions: MongoConnectionOptions;
-    };
-}
-interface TestMysqlDataConnectionRequest {
-    type: IntegrationType.mysql;
-    configuration: {
-        connectionOptions: MySqlConnectionOptions;
-    };
-}
-interface TestBigQueryDataConnectionRequest {
-    type: IntegrationType.bigquery;
-    configuration: {
-        connectionOptions: BigQueryConnectionOptions;
-    };
-}
-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 | TestBigQueryDataConnectionRequest | 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 DiscoverBigQueryDataConnectionSchemaRequest {
-    integrationType: IntegrationType.bigquery;
-    connectionOptions: BigQueryConnectionOptions;
-}
-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 | DiscoverBigQueryDataConnectionSchemaRequest | DiscoverOracleDataConnectionSchemaRequest | DiscoverMssqlDataConnectionSchemaRequest | DiscoverCockroachDataConnectionSchemaRequest | DiscoverPostgresDataConnectionSchemaRequest | DiscoverSnowflakeDataConnectionSchemaRequest;
-export {};
+import { CollectionName } from '../document.types';
+import { CollectionSchema } from '../schema/schema.types';
+import { BaseIntegrationConfig, BaseIntegrationSchema, DatabaseIntegrationType, IntegrationSchemaType, 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 BigQueryConnectionSecretOptions {
+    privateKey: string;
+}
+export interface OracleConnectionSecretOptions {
+    password: string;
+}
+export interface PinotConnectionSecretOptions {
+    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 BigQueryConnectionOptions {
+    secrets: BigQueryConnectionSecretOptions;
+    projectId: string;
+    datasetId: string;
+    email: string;
+}
+export interface OracleConnectionOptions {
+    secrets: OracleConnectionSecretOptions;
+    host: string;
+    user: string;
+    database: string;
+    connectionLimit?: number;
+}
+export interface PinotConnectionOptions {
+    secrets: PinotConnectionSecretOptions;
+    brokerUrl: string;
+    controllerUrl: string;
+    user?: string;
+    connectionLimit?: number;
+}
+export interface MssqlConnectionOptions {
+    secrets: MssqlConnectionSecretOptions;
+    host: string;
+    user: string;
+    schemas: 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 extends BaseIntegrationSchema {
+    type: IntegrationSchemaType.data;
+    collections: Record<TableName, CollectionSchema>;
+}
+export interface BaseDatabaseIntegrationConfig extends BaseIntegrationConfig {
+    type: DatabaseIntegrationType;
+    supportsExternalChanges: boolean;
+}
+export interface MySqlIntegrationConfiguration {
+    connectionOptions: MySqlConnectionOptions;
+}
+export interface BigQueryIntegrationConfiguration {
+    connectionOptions: BigQueryConnectionOptions;
+}
+export interface OracleIntegrationConfiguration {
+    connectionOptions: OracleConnectionOptions;
+}
+export interface PinotIntegrationConfiguration {
+    connectionOptions: PinotConnectionOptions;
+}
+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;
+}
+export interface BigQueryIntegrationConfig extends BaseDatabaseIntegrationConfig {
+    type: IntegrationType.bigquery;
+    configuration: BigQueryIntegrationConfiguration;
+}
+export interface OracleIntegrationConfig extends BaseDatabaseIntegrationConfig {
+    type: IntegrationType.oracledb;
+    configuration: OracleIntegrationConfiguration;
+}
+export interface PinotIntegrationConfig extends BaseDatabaseIntegrationConfig {
+    type: IntegrationType.pinot;
+    configuration: PinotIntegrationConfiguration;
+}
+export interface MssqlIntegrationConfig extends BaseDatabaseIntegrationConfig {
+    type: IntegrationType.mssql;
+    configuration: MssqlIntegrationConfiguration;
+}
+export interface BasePostgresIntegration extends BaseDatabaseIntegrationConfig {
+    type: IntegrationType.postgres | IntegrationType.cockroach;
+    configuration: PostgresIntegrationConfiguration;
+}
+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;
+    supportsExternalChanges: false;
+}
+interface TestMongoDataConnectionRequest {
+    type: IntegrationType.mongo;
+    configuration: {
+        connectionOptions: MongoConnectionOptions;
+    };
+}
+interface TestMysqlDataConnectionRequest {
+    type: IntegrationType.mysql;
+    configuration: {
+        connectionOptions: MySqlConnectionOptions;
+    };
+}
+interface TestBigQueryDataConnectionRequest {
+    type: IntegrationType.bigquery;
+    configuration: {
+        connectionOptions: BigQueryConnectionOptions;
+    };
+}
+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 | TestBigQueryDataConnectionRequest | 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 DiscoverBigQueryDataConnectionSchemaRequest {
+    integrationType: IntegrationType.bigquery;
+    connectionOptions: BigQueryConnectionOptions;
+}
+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 | DiscoverBigQueryDataConnectionSchemaRequest | DiscoverOracleDataConnectionSchemaRequest | DiscoverMssqlDataConnectionSchemaRequest | DiscoverCockroachDataConnectionSchemaRequest | DiscoverPostgresDataConnectionSchemaRequest | DiscoverSnowflakeDataConnectionSchemaRequest;
+export {};