@squidcloud/client 1.0.59 → 1.0.60

package/dist/common/src/ai-assistant.schemas.d.ts

@@ -0,0 +1,210 @@
+export declare const AiAssistantChatRequestSchema: {
+    type: string;
+    properties: {
+        profileId: {
+            type: string;
+        };
+        integrationId: {
+            type: string;
+        };
+        clientId: {
+            type: string;
+        };
+        clientRequestId: {
+            type: string;
+        };
+        prompt: {
+            type: string;
+        };
+    };
+    required: string[];
+};
+export declare const AiAssistantMutateRequestSchema: {
+    type: string;
+    properties: {
+        profileId: {
+            type: string;
+        };
+        integrationId: {
+            type: string;
+        };
+        action: {
+            type: string;
+            enum: string[];
+        };
+        type: {
+            type: string;
+            enum: string[];
+        };
+    };
+    required: string[];
+    oneOf: ({
+        properties: {
+            action: {
+                const: string;
+            };
+            type: {
+                const: string;
+            };
+            payload: {
+                type: string;
+                properties: {
+                    modelName: {
+                        type: string;
+                        enum: string[];
+                    };
+                    strictContext: {
+                        type: string;
+                    };
+                    id?: undefined;
+                    instruction?: undefined;
+                    title?: undefined;
+                    context?: undefined;
+                };
+                required: string[];
+            };
+        };
+    } | {
+        properties: {
+            action: {
+                const: string;
+            };
+            type: {
+                const: string;
+            };
+            payload: {
+                type: string;
+                properties: {
+                    id: {
+                        type: string;
+                    };
+                    instruction: {
+                        type: string;
+                    };
+                    modelName?: undefined;
+                    strictContext?: undefined;
+                    title?: undefined;
+                    context?: undefined;
+                };
+                required: string[];
+            };
+        };
+    } | {
+        properties: {
+            action: {
+                const: string;
+            };
+            type: {
+                const: string;
+            };
+            payload: {
+                type: string;
+                properties: {
+                    id: {
+                        type: string;
+                    };
+                    title: {
+                        type: string;
+                    };
+                    context: {
+                        type: string;
+                    };
+                    modelName?: undefined;
+                    strictContext?: undefined;
+                    instruction?: undefined;
+                };
+                required: string[];
+            };
+        };
+    } | {
+        properties: {
+            action: {
+                const: string;
+            };
+            type: {
+                const: string;
+            };
+            payload: {
+                type: string;
+                properties: {
+                    modelName: {
+                        type: string;
+                        enum: string[];
+                    };
+                    strictContext: {
+                        type: string;
+                    };
+                    id?: undefined;
+                    instruction?: undefined;
+                    title?: undefined;
+                    context?: undefined;
+                };
+                required?: undefined;
+            };
+        };
+    } | {
+        properties: {
+            action: {
+                const: string;
+            };
+            type: {
+                const: string;
+            };
+            payload: {
+                type: string;
+                properties: {
+                    id: {
+                        type: string;
+                    };
+                    title: {
+                        type: string;
+                    };
+                    context: {
+                        type: string;
+                    };
+                    modelName?: undefined;
+                    strictContext?: undefined;
+                    instruction?: undefined;
+                };
+                required?: undefined;
+            };
+        };
+    } | {
+        properties: {
+            action: {
+                const: string;
+            };
+            type: {
+                const: string;
+            };
+            payload: {
+                type: string;
+                properties: {
+                    id: {
+                        type: string;
+                    };
+                    modelName?: undefined;
+                    strictContext?: undefined;
+                    instruction?: undefined;
+                    title?: undefined;
+                    context?: undefined;
+                };
+                required: string[];
+            };
+        };
+    } | {
+        properties: {
+            action: {
+                const: string;
+            };
+            type: {
+                const: string;
+            };
+            payload: {
+                type: string;
+                properties?: undefined;
+                required?: undefined;
+            };
+        };
+    })[];
+};

package/dist/common/src/ai-assistant.types.d.ts

@@ -0,0 +1,76 @@
+import { ClientId, ClientRequestId, IntegrationId } from './communication.types';
+export type OpenAiModelName = 'gpt-3.5-turbo' | 'gpt-4';
+export interface BaseAiAssistantRequest {
+    profileId: string;
+    integrationId: IntegrationId;
+}
+export interface AiAssistantChatRequest extends BaseAiAssistantRequest {
+    clientId: ClientId;
+    clientRequestId: ClientRequestId;
+    prompt: string;
+}
+export interface BaseAiAssistantMutateRequest extends BaseAiAssistantRequest {
+    action: AiAssistantMutationType;
+    type: AiAssistantRequestType;
+}
+export interface AiAssistantInsertProfileRequest extends BaseAiAssistantMutateRequest {
+    action: 'insert';
+    type: 'profile';
+    payload: {
+        modelName: OpenAiModelName;
+        strictContext: boolean;
+    };
+}
+export interface AiAssistantInsertInstructionRequest extends BaseAiAssistantMutateRequest {
+    action: 'insert';
+    type: 'instruction';
+    payload: {
+        id: string;
+        instruction: string;
+    };
+}
+export interface AiAssistantInsertContextRequest extends BaseAiAssistantMutateRequest {
+    action: 'insert';
+    type: 'context';
+    payload: {
+        id: string;
+        title: string;
+        context: string;
+    };
+}
+export interface AiAssistantUpdateProfileRequest extends BaseAiAssistantMutateRequest {
+    action: 'update';
+    type: 'profile';
+    payload: {
+        modelName?: OpenAiModelName;
+        strictContext?: boolean;
+    };
+}
+export interface AiAssistantUpdateInstructionRequest extends BaseAiAssistantMutateRequest {
+    action: 'update';
+    type: 'instruction';
+    payload: {
+        id: string;
+        instruction: string;
+    };
+}
+export interface AiAssistantUpdateContextRequest extends BaseAiAssistantMutateRequest {
+    action: 'update';
+    type: 'context';
+    payload: {
+        id: string;
+        title?: string;
+        context?: string;
+    };
+}
+export interface AiAssistantDeleteRequest extends BaseAiAssistantMutateRequest {
+    action: 'delete';
+    payload: {
+        id?: string;
+    };
+}
+export type AiAssistantInsertRequest = AiAssistantInsertProfileRequest | AiAssistantInsertInstructionRequest | AiAssistantInsertContextRequest;
+export type AiAssistantUpdateRequest = AiAssistantUpdateProfileRequest | AiAssistantUpdateInstructionRequest | AiAssistantUpdateContextRequest;
+export type AiAssistantMutateRequest = AiAssistantInsertRequest | AiAssistantUpdateRequest | AiAssistantDeleteRequest;
+export type AiAssistantRequestType = 'instruction' | 'context' | 'profile';
+export type AiAssistantMutationType = 'insert' | 'update' | 'delete';

package/dist/common/src/api-call.context.d.ts

@@ -1,5 +1,5 @@
 import { ApiHeaders } from './api.types';
-import { ApiEndpointId, HttpMethod } from './integration.types';
+import { ApiEndpointId, HttpMethod } from './integrations';
 export declare class ApiCallContext {
     readonly endpointId: ApiEndpointId;
     readonly url: string;

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

@@ -1,5 +1,5 @@
 import { ClientId, ClientRequestId, IntegrationId } from './communication.types';
-import { ApiEndpointId, HttpMethod } from './integration.types';
+import { ApiEndpointId, HttpMethod } from './integrations';
 export type ApiHeaders = Record<string, string | number | boolean>;
 export type ApiQueryParams = Record<string, string | number | boolean>;
 export interface CallApiRequest {

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

@@ -1,6 +1,6 @@
 import { JSONSchemaType } from 'ajv';
 import { UpdateOpenIdProviderRequest } from './application.types';
-import { IntegrationType } from './integration.types';
+import { IntegrationType } from './integrations';
 export declare const UpdateOpenIdProviderRequestSchema: JSONSchemaType<UpdateOpenIdProviderRequest>;
 export declare const UpsertIntegrationRequestSchema: {
     type: string;
@@ -576,6 +576,37 @@ export declare const UpsertIntegrationRequestSchema: {
             };
             supportsExternalChanges?: undefined;
         };
+    } | {
+        type: string;
+        required: never[];
+        properties: {
+            type: {
+                const: IntegrationType;
+            };
+            configuration: {
+                type: string;
+                nullable: boolean;
+                required: never[];
+                properties: {
+                    apiKey: {
+                        type: string;
+                        nullable: boolean;
+                        isSecret?: undefined;
+                    };
+                    connectionOptions?: undefined;
+                    discoveryOptions?: undefined;
+                    appKey?: undefined;
+                    datadogRegion?: undefined;
+                    newRelicRegion?: undefined;
+                    clientId?: undefined;
+                    domain?: undefined;
+                    jwksUri?: undefined;
+                    validations?: undefined;
+                    verifyUri?: undefined;
+                };
+            };
+            supportsExternalChanges?: undefined;
+        };
     })[];
 };
 export declare const DeleteIntegrationRequestSchema: {

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

@@ -1,8 +1,8 @@
+import { RunPermissions } from './backend-run.types';
 import { ApplicationBundleData, ServiceFunctionName } from './bundle-data.types';
 import { AppId, IntegrationId } from './communication.types';
 import { CollectionName } from './document.types';
-import { GraphQLConnectionOptions, IntegrationConfig, IntegrationApiSchema, IntegrationDataSchema, IntegrationGraphQLSchema, IntegrationType, MongoConnectionOptions, MssqlConnectionOptions, MySqlConnectionOptions, OpenApiDiscoveryOptions, PostgresConnectionOptions, SnowflakeConnectionOptions } from './integration.types';
-import { RunPermissions } from './backend-run.types';
+import { AiAssistantConfiguration, GraphQLConnectionOptions, IntegrationAiAssistantSchema, IntegrationApiSchema, IntegrationConfig, IntegrationDataSchema, IntegrationGraphQLSchema, IntegrationType, MongoConnectionOptions, MssqlConnectionOptions, MySqlConnectionOptions, OpenApiDiscoveryOptions, OracleConnectionOptions, PostgresConnectionOptions, SnowflakeConnectionOptions } from './integrations';
 export type WebhookId = string;
 export type QueryName = string;
 export type TriggerId = string;
@@ -134,8 +134,8 @@ export interface UpdateOpenIdProviderRequest {
 export interface CreateApplicationResponse {
     appId: AppId;
 }
-export type UpsertIntegrationRequest = UpsertDataIntegrationRequest | UpsertGraphQLIntegrationRequest | UpsertApiIntegrationRequest;
-export type UpsertDataIntegrationRequest = UpsertInternalIntegrationRequest | UpsertMongoDbIntegrationRequest | UpsertMssqlIntegrationRequest | UpsertMySqlIntegrationRequest | UpsertPostgresIntegrationRequest | UpsertCockroachIntegrationRequest | UpsertSnowflakeIntegrationRequest;
+export type UpsertIntegrationRequest = UpsertDataIntegrationRequest | UpsertGraphQLIntegrationRequest | UpsertApiIntegrationRequest | UpsertAiAssistantIntegrationRequest;
+export type UpsertDataIntegrationRequest = UpsertInternalIntegrationRequest | UpsertMongoDbIntegrationRequest | UpsertMssqlIntegrationRequest | UpsertMySqlIntegrationRequest | UpsertOracleIntegrationRequest | UpsertPostgresIntegrationRequest | UpsertCockroachIntegrationRequest | UpsertSnowflakeIntegrationRequest;
 interface BaseUpsertIntegrationRequest {
     id: IntegrationId;
     type: IntegrationType;
@@ -161,6 +161,13 @@ export interface UpsertMySqlIntegrationRequest extends BaseUpsertDataIntegration
         connectionOptions: MySqlConnectionOptions;
     };
 }
+export interface UpsertOracleIntegrationRequest extends BaseUpsertDataIntegrationRequest {
+    type: IntegrationType.oracledb;
+    schema?: IntegrationDataSchema;
+    configuration: {
+        connectionOptions: OracleConnectionOptions;
+    };
+}
 export interface UpsertMssqlIntegrationRequest extends BaseUpsertDataIntegrationRequest {
     type: IntegrationType.mssql;
     schema?: IntegrationDataSchema;
@@ -203,6 +210,11 @@ export interface UpsertApiIntegrationRequest extends BaseUpsertIntegrationReques
         discoveryOptions: OpenApiDiscoveryOptions;
     };
 }
+export interface UpsertAiAssistantIntegrationRequest extends BaseUpsertIntegrationRequest {
+    type: IntegrationType.ai_assistant;
+    schema?: IntegrationAiAssistantSchema;
+    configuration: AiAssistantConfiguration;
+}
 export interface DeleteIntegrationRequest {
     integrationId: IntegrationId;
 }

package/dist/common/src/bundle-data.types.d.ts

@@ -1,7 +1,7 @@
 import { QueryName, SchedulerConfig, SchedulerId, TriggerConfig, TriggerId, WebhookConfig, WebhookId } from './application.types';
 import { IntegrationId } from './communication.types';
 import { CollectionName } from './document.types';
-import { ApiEndpointId } from './integration.types';
+import { ApiEndpointId } from './integrations';
 export type ActionType = 'read' | 'write' | 'update' | 'insert' | 'delete' | 'all';
 export type ServiceName = string;
 export type FunctionName = string;

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

@@ -1,3 +1,5 @@
+export * from './ai-assistant.schemas';
+export * from './ai-assistant.types';
 export * from './api-call.context';
 export * from './api.types';
 export * from './application.schemas';
@@ -15,7 +17,7 @@ export * from './document.types';
 export * from './graphql.context';
 export * from './graphql.types';
 export * from './http-status.enum';
-export * from './integration.types';
+export * from './integrations';
 export * from './logger.types';
 export * from './metrics.types';
 export * from './mutation.context';

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

@@ -0,0 +1,30 @@
+import { BaseIntegrationConfig, IntegrationType } from './index';
+import { IntegrationId } from '../communication.types';
+export interface AiAssistantIntegrationConfig extends BaseIntegrationConfig {
+    type: IntegrationType.ai_assistant;
+    configuration: AiAssistantConfiguration;
+    schema: IntegrationAiAssistantSchema;
+}
+export type AiAssistantConfiguration = {
+    apiKey?: string;
+};
+export type AiAssistantProfile = {
+    modelName: string;
+    strictContext: boolean;
+    instructions: Record<string, string>;
+    contexts: Record<string, AiAssistantContext>;
+};
+export type AiAssistantContext = {
+    title: string;
+    text: string;
+    preview: boolean;
+};
+export interface IntegrationAiAssistantSchema {
+    profiles: Record<string, AiAssistantProfile>;
+}
+export interface DiscoverAiAssistantSchemaRequest {
+    integrationId: IntegrationId;
+}
+export interface DiscoverAiAssistantSchemaResponse {
+    schema: IntegrationAiAssistantSchema;
+}

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

@@ -0,0 +1,80 @@
+import { FieldName } from '../document.types';
+import { IntrospectionQuery } from '../graphql.types';
+import { BaseIntegrationConfig, IntegrationType } from './index';
+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 type IntegrationApiEndpoints = Record<ApiEndpointId, ApiEndpoint>;
+export interface IntegrationGraphQLSchema {
+    introspection: IntrospectionQuery;
+}
+export interface IntegrationApiSchema {
+    baseUrl: string;
+    endpoints: IntegrationApiEndpoints;
+    injectionSchema?: ApiInjectionSchema;
+}
+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 GraphQLConnectionOptions {
+    baseUrl: string;
+    injectionSchema?: ApiInjectionSchema;
+}
+export type ApiInjectionSchema = Record<FieldName, ApiInjectionField>;
+export interface OpenApiDiscoveryOptions {
+    openApiSpecUrl: string;
+}
+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 DiscoverGraphQLConnectionSchemaRequest {
+    integrationType: IntegrationType.graphql;
+    connectionOptions: GraphQLConnectionOptions;
+}
+export interface DiscoverOpenApiSchemaRequest {
+    integrationType: IntegrationType.api;
+    discoveryOptions: OpenApiDiscoveryOptions;
+}
+export interface TestGraphQLDataConnectionRequest {
+    type: IntegrationType.graphql;
+    configuration: {
+        connectionOptions: GraphQLConnectionOptions;
+    };
+}
+export interface DiscoverGraphQLConnectionSchemaResponse {
+    schema: IntegrationGraphQLSchema;
+}
+export interface DiscoverOpenApiSchemaResponse {
+    schema: IntegrationApiSchema;
+}

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

@@ -0,0 +1,22 @@
+import { Validations } from '../auth.types';
+import { BaseIntegrationConfig, IntegrationType } from './index';
+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;
+    };
+}