@squidcloud/client 1.0.159 → 1.0.160

package/dist/internal-common/src/public-types/bundle-api.types.d.ts

@@ -0,0 +1,49 @@
+import { MutationContext } from './mutation.context';
+import { ApiCallContext } from './api-call.context';
+import { GraphqlContext } from './graphql.context';
+import { DistributedLockContext } from './distributed-lock.context';
+import { NativeQueryContext } from './native-query.context';
+import { QueryContext } from './query-context';
+import { AiChatbotActionType, DatabaseActionType, TopicActionType } from './bundle-data.types';
+import { ClientId } from './communication.types';
+import { DocumentData, SquidDocId } from './document.types';
+import { MutationType } from './mutation.types';
+import { ClientConnectionState } from './socket.types';
+import { TopicReadContext, TopicWriteContext } from './topic.context';
+import { AiChatbotChatContext, AiChatbotMutationContext } from '../types/ai-chatbot.context';
+export type SecureDatabaseAction<T extends DatabaseActionType> = T extends 'all' ? () => boolean | Promise<boolean> : T extends 'read' ? ((context: QueryContext) => boolean | Promise<boolean>) | (() => boolean | Promise<boolean>) : ((context: MutationContext) => boolean | Promise<boolean>) | (() => boolean | Promise<boolean>);
+export type SecureTopicAction<T extends TopicActionType> = T extends 'all' ? () => boolean | Promise<boolean> : T extends 'read' ? ((context: TopicReadContext) => boolean | Promise<boolean>) | (() => boolean | Promise<boolean>) : ((context: TopicWriteContext<T>) => boolean | Promise<boolean>) | (() => boolean | Promise<boolean>);
+export type SecureApiAction = ((context: ApiCallContext) => boolean | Promise<boolean>) | (() => boolean | Promise<boolean>);
+export type SecureNativeQueryAction = ((context: NativeQueryContext) => boolean | Promise<boolean>) | (() => boolean | Promise<boolean>);
+export type SecureDistributedLockAction = ((context: DistributedLockContext) => boolean | Promise<boolean>) | (() => boolean | Promise<boolean>);
+export type SecureGraphQLAction = ((context: GraphqlContext) => boolean | Promise<boolean>) | (() => boolean | Promise<boolean>);
+export type SecureAiChatbotAction<T extends AiChatbotActionType> = T extends 'all' ? () => boolean | Promise<boolean> : T extends 'chat' ? ((context: AiChatbotChatContext) => boolean | Promise<boolean>) | (() => boolean | Promise<boolean>) : ((context: AiChatbotMutationContext) => boolean | Promise<boolean>) | (() => boolean | Promise<boolean>);
+export type ClientConnectionStateChangeAction = (clientId: ClientId, clientConnectionState: ClientConnectionState) => Promise<void> | void;
+export type ExecutableAction = (...args: any[]) => any;
+export type AiFunctionAction<T extends Record<string, any> = any> = (params: T) => any;
+export type TriggerAction = ((request: TriggerRequest) => void | Promise<void>) | (() => void | Promise<void>);
+/** The context provided to a trigger function. */
+export interface TriggerRequest<T extends DocumentData = any> {
+    squidDocId: SquidDocId;
+    mutationType: MutationType;
+    docBefore?: T;
+    docAfter?: T;
+}
+export type SchedulerAction = () => void | Promise<void>;
+export type WebhookAction = ((request: WebhookRequest) => any) | (() => any);
+/** The context provided to a webhook function. */
+export interface WebhookRequest<T = any> {
+    body: T;
+    rawBody?: string;
+    queryParams: Record<string, string>;
+    headers: Record<string, string>;
+    httpMethod: 'post' | 'get' | 'put' | 'delete';
+    files?: Array<SquidFile>;
+}
+export interface WebhookResponse {
+    headers: Record<string, any>;
+    body: any;
+    statusCode: number;
+    __isWebhookResponse__: true;
+}
+export type ActionMethodDecorator<U> = <T extends U>(target: Object, propertyName: string, descriptor: TypedPropertyDescriptor<T>) => TypedPropertyDescriptor<T>;

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

@@ -0,0 +1,11 @@
+/** The different types of actions that can be performed on a database. */
+export type DatabaseActionType = 'read' | 'write' | 'update' | 'insert' | 'delete' | 'all';
+/** The different types of actions that can be performed on a topic. */
+export type TopicActionType = 'read' | 'write' | 'all';
+/** The different types of actions that can be performed on an AI chatbot. */
+export type AiChatbotActionType = 'chat' | 'mutate' | 'all';
+export interface LocalBackendData {
+    applicationBundleData: ApplicationBundleData;
+    openApiSpecStr?: string;
+}
+export type AiFunctionParamType = 'string' | 'number' | 'boolean' | 'date';

package/dist/internal-common/src/public-types/communication.types.d.ts

@@ -0,0 +1,10 @@
+/** A type alias for an application id. */
+export type AppId = string;
+export declare const ENVIRONMENT_IDS: readonly ["dev", "prod"];
+export type EnvironmentId = (typeof ENVIRONMENT_IDS)[number];
+/** @deprecated. Use ENVIRONMENT_IDS. */
+export declare const allEnvironmentIds: Array<EnvironmentId>;
+/** A type alias for an integration id. */
+export type IntegrationId = string;
+export type ChatId = string;
+export type SquidDeveloperId = string;

package/dist/internal-common/src/public-types/context.types.d.ts

@@ -0,0 +1,40 @@
+import { AppId, ClientId } from './communication.types';
+export type AuthType = 'Bearer' | 'ApiKey';
+/**
+ * The payload of a JWT token in case an auth token was used.
+ */
+export interface AuthWithBearer {
+    type: 'Bearer';
+    userId: string;
+    expiration: number;
+    attributes: Record<string, any>;
+}
+/**
+ * The authentication object for the current request in case an API key is used.
+ */
+export interface AuthWithApiKey {
+    type: 'ApiKey';
+    apiKey: string;
+}
+/** The authentication object for the current request. */
+export type Auth = AuthWithBearer | AuthWithApiKey;
+export interface AuthToken {
+    type: AuthType;
+    token: string;
+    integrationId?: string;
+}
+/** The context of a request to a service. */
+export interface RunContext {
+    /** Your applicationId. */
+    appId: AppId;
+    /**
+     * The id of the client that initiated this request. This is only relevant in cases that the request was initiated by
+     * a client such as when securing an api call or a DB operation. This id will not be available for triggers,
+     * schedulers, webhooks and other functions that are not directly initiated by a user action.
+     */
+    clientId?: ClientId;
+    /** The IP address of the client that initiated this request. */
+    sourceIp?: string;
+    /** The headers of the request. */
+    headers?: Record<string, any>;
+}

package/dist/internal-common/src/public-types/distributed-lock.context.d.ts

@@ -0,0 +1,4 @@
+/** The context provided to a secure distributed lock function. */
+export declare class DistributedLockContext {
+    readonly mutex: string;
+}

package/dist/internal-common/src/public-types/document.types.d.ts

@@ -0,0 +1,22 @@
+import { IntegrationId } from './communication.types';
+/** A type alias for a field name. */
+export type FieldName<T = any> = string & keyof T;
+/** A type alias for a document id as string. */
+export type DocId = string;
+/** A type alias for a document id object when the ID is a composite of primary keys. */
+export type DocIdObj = Record<FieldName, any>;
+/** A type alias for a collection name. */
+export type CollectionName = string;
+/** The full document id, including the collection name and the integration id. */
+export interface SquidDocIdObj {
+    collectionName: CollectionName;
+    docId: DocId;
+    integrationId: IntegrationId;
+}
+/** The before and after documents of a document change. */
+export interface BeforeAndAfterDocs<T = SquidDocument> {
+    before: T | undefined;
+    after: T | undefined;
+}
+/** A generic document data type. */
+export type DocumentData = Record<FieldName, any | undefined>;

package/dist/internal-common/src/public-types/graphql.context.d.ts

@@ -0,0 +1,7 @@
+/** The context provided to a secure GraphQL function. */
+export declare class GraphqlContext {
+    readonly isGraphiQL: boolean;
+    readonly query: string | undefined;
+    readonly variables: string | Record<string, any> | undefined;
+    readonly operationName: string | undefined;
+}

package/dist/internal-common/src/public-types/graphql.types.d.ts

@@ -0,0 +1,9 @@
+export { type ExecutionResult, type IntrospectionQuery } from 'graphql';
+export interface GraphQLRequest {
+    operationName?: string;
+    query?: string;
+    variables?: string | Record<string, any>;
+}
+export interface SecureGraphQLRequest extends GraphQLRequest {
+    isGraphiQL: boolean;
+}

package/dist/internal-common/src/public-types/heartbeat.types.d.ts

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

package/dist/internal-common/src/public-types/http-status.enum.d.ts

@@ -0,0 +1,50 @@
+export declare enum HttpStatus {
+    CONTINUE = 100,
+    SWITCHING_PROTOCOLS = 101,
+    PROCESSING = 102,
+    EARLYHINTS = 103,
+    OK = 200,
+    CREATED = 201,
+    ACCEPTED = 202,
+    NON_AUTHORITATIVE_INFORMATION = 203,
+    NO_CONTENT = 204,
+    RESET_CONTENT = 205,
+    PARTIAL_CONTENT = 206,
+    AMBIGUOUS = 300,
+    MOVED_PERMANENTLY = 301,
+    FOUND = 302,
+    SEE_OTHER = 303,
+    NOT_MODIFIED = 304,
+    TEMPORARY_REDIRECT = 307,
+    PERMANENT_REDIRECT = 308,
+    BAD_REQUEST = 400,
+    UNAUTHORIZED = 401,
+    PAYMENT_REQUIRED = 402,
+    FORBIDDEN = 403,
+    NOT_FOUND = 404,
+    METHOD_NOT_ALLOWED = 405,
+    NOT_ACCEPTABLE = 406,
+    PROXY_AUTHENTICATION_REQUIRED = 407,
+    REQUEST_TIMEOUT = 408,
+    CONFLICT = 409,
+    GONE = 410,
+    LENGTH_REQUIRED = 411,
+    PRECONDITION_FAILED = 412,
+    PAYLOAD_TOO_LARGE = 413,
+    URI_TOO_LONG = 414,
+    UNSUPPORTED_MEDIA_TYPE = 415,
+    REQUESTED_RANGE_NOT_SATISFIABLE = 416,
+    EXPECTATION_FAILED = 417,
+    I_AM_A_TEAPOT = 418,
+    MISDIRECTED = 421,
+    UNPROCESSABLE_ENTITY = 422,
+    FAILED_DEPENDENCY = 424,
+    PRECONDITION_REQUIRED = 428,
+    TOO_MANY_REQUESTS = 429,
+    INTERNAL_SERVER_ERROR = 500,
+    NOT_IMPLEMENTED = 501,
+    BAD_GATEWAY = 502,
+    SERVICE_UNAVAILABLE = 503,
+    GATEWAY_TIMEOUT = 504,
+    HTTP_VERSION_NOT_SUPPORTED = 505
+}

package/dist/internal-common/src/public-types/integration-types.d.ts

@@ -0,0 +1,62 @@
+export declare enum IntegrationCategory {
+    'database' = "database",
+    'queue' = "queue",
+    '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_chatbot' = "ai_chatbot",
+    'cognito' = "cognito",
+    'okta' = "okta",
+    'descope' = "descope",
+    'kafka' = "kafka",
+    'confluent' = "confluent",
+    'built_in_queue' = "built_in_queue",
+    '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",
+    'pinot' = "pinot",
+    'redis' = "redis",
+    'xata' = "xata",
+    'azure_sql' = "azure_sql",
+    'azure_postgresql' = "azure_postgresql",
+    'azure_cosmosdb' = "azure_cosmosdb",
+    'firestore' = "firestore",
+    'bigquery' = "bigquery",
+    'cloudsql' = "cloudsql"
+}
+export declare enum IntegrationSchemaType {
+    'data' = "data",
+    'api' = "api",
+    'graphql' = "graphql"
+}

package/dist/internal-common/src/public-types/integrations/ai_chatbot.types.d.ts

@@ -0,0 +1,32 @@
+import { BaseIntegrationConfig } from './schemas';
+import { AiModelName } from '../ai-chatbot.public-types';
+import { IntegrationId } from '../communication.types';
+import { IntegrationType } from '../integration-types';
+export interface AiChatbotIntegrationConfig extends BaseIntegrationConfig {
+    type: IntegrationType.ai_chatbot;
+    configuration: AiChatbotConfiguration;
+}
+export type AiChatbotConfiguration = {
+    apiKey?: string;
+};
+export type AiChatbotProfileMetadata = {
+    modelName: AiModelName;
+    isPublic: boolean;
+    strictContext: boolean;
+    instructions: Record<string, string>;
+};
+export type AiChatbotContextMetadata = {
+    title: string;
+    text: string;
+    preview: boolean;
+    sizeBytes?: number;
+};
+export interface AiChatbotProfile extends AiChatbotProfileMetadata {
+    contexts: Record<string, AiChatbotContextMetadata>;
+}
+export interface AiChatbotProfiles {
+    profiles: Record<string, AiChatbotProfile>;
+}
+export interface GetAiChatbotProfilesRequest {
+    integrationId: IntegrationId;
+}

package/dist/internal-common/src/public-types/integrations/api.types.d.ts

@@ -0,0 +1,81 @@
+import { FieldName } from '../document.types';
+import { IntrospectionQuery } from '../graphql.types';
+import { BaseIntegrationConfig, BaseIntegrationSchema } from './schemas';
+import { IntegrationSchemaType, IntegrationType } from '../integration-types';
+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 extends BaseIntegrationSchema {
+    type: IntegrationSchemaType.graphql;
+    introspection: IntrospectionQuery;
+}
+export interface IntegrationApiSchema extends BaseIntegrationSchema {
+    type: IntegrationSchemaType.api;
+    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;
+    };
+}
+export interface GraphQLIntegrationConfig extends BaseIntegrationConfig {
+    type: IntegrationType.graphql;
+    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/internal-common/src/public-types/integrations/auth.types.d.ts

@@ -0,0 +1,54 @@
+import { BaseIntegrationConfig } from './schemas';
+import { IntegrationType } from '../integration-types';
+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;
+    };
+}
+export interface DescopeIntegrationConfig extends BaseIntegrationConfig {
+    type: IntegrationType.descope;
+    configuration: {
+        projectId: string;
+    };
+}