@squidcloud/client 1.0.142 → 1.0.144-beta

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

@@ -1,42 +1,43 @@
-import { AiAssistantActionType, DatabaseActionType } from './bundle-data.types';
-import { DocumentData, SquidDocId } from './document.types';
-import { MutationContext } from './mutation.context';
-import { MutationType } from './mutation.types';
-import { QueryContext } from './query';
-import { ApiCallContext } from './api-call.context';
-import { NamedQueryContext } from './named-query.context';
-import { GraphqlContext } from './graphql.context';
-import { DistributedLockContext } from './distributed-lock.context';
-import { AiAssistantChatContext, AiAssistantMutationContext } from './ai-assistant.context';
-import { ClientId } from './communication.types';
-import { ClientConnectionState } from './socket.types';
-import { NativeQueryContext } from './native-query.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 SecureApiAction = ((context: ApiCallContext) => boolean | Promise<boolean>) | (() => boolean | Promise<boolean>);
-export type SecureNamedQueryAction = ((context: NamedQueryContext) => 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 SecureAiAssistantAction<T extends AiAssistantActionType> = T extends 'all' ? () => boolean | Promise<boolean> : T extends 'chat' ? ((context: AiAssistantChatContext) => boolean | Promise<boolean>) | (() => boolean | Promise<boolean>) : ((context: AiAssistantMutationContext) => boolean | Promise<boolean>) | (() => boolean | Promise<boolean>);
-export type ClientConnectionStateChangeAction = (clientId: ClientId, clientConnectionState: ClientConnectionState) => Promise<void> | void;
-export type ExecutableAction = (...args: any[]) => 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 {
-    body: any;
-    rawBody?: string;
-    queryParams: Record<string, string>;
-    headers: Record<string, string>;
-    httpMethod: 'post' | 'get' | 'put' | 'delete';
-    files?: Array<SquidFile>;
-}
-export type ActionMethodDecorator<U> = <T extends U>(target: Object, propertyName: string, descriptor: TypedPropertyDescriptor<T>) => TypedPropertyDescriptor<T>;
+import { AiChatbotActionType, DatabaseActionType } from './bundle-data.types';
+import { DocumentData, SquidDocId } from './document.types';
+import { MutationContext } from './mutation.context';
+import { MutationType } from './mutation.types';
+import { QueryContext } from './query';
+import { ApiCallContext } from './api-call.context';
+import { NamedQueryContext } from './named-query.context';
+import { GraphqlContext } from './graphql.context';
+import { DistributedLockContext } from './distributed-lock.context';
+import { ClientId } from './communication.types';
+import { ClientConnectionState } from './socket.types';
+import { NativeQueryContext } from './native-query.context';
+import { AiChatbotChatContext, AiChatbotMutationContext } from './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 SecureApiAction = ((context: ApiCallContext) => boolean | Promise<boolean>) | (() => boolean | Promise<boolean>);
+export type SecureNamedQueryAction = ((context: NamedQueryContext) => 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 {
+    body: any;
+    rawBody?: string;
+    queryParams: Record<string, string>;
+    headers: Record<string, string>;
+    httpMethod: 'post' | 'get' | 'put' | 'delete';
+    files?: Array<SquidFile>;
+}
+export type ActionMethodDecorator<U> = <T extends U>(target: Object, propertyName: string, descriptor: TypedPropertyDescriptor<T>) => TypedPropertyDescriptor<T>;

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

@@ -1,4 +1,5 @@
-/** 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 an AI assistant. */
-export type AiAssistantActionType = 'chat' | 'mutate' | 'all';
+/** 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 an AI chatbot. */
+export type AiChatbotActionType = 'chat' | 'mutate' | 'all';
+export type AiFunctionParamType = 'string' | 'number' | 'boolean' | 'date';

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

@@ -1,8 +1,8 @@
-/** A type alias for an application id. */
-export type AppId = string;
-export type EnvironmentId = 'prod' | 'dev';
-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;
+/** A type alias for an application id. */
+export type AppId = string;
+export type EnvironmentId = 'prod' | 'dev';
+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/common/src/context.types.d.ts

@@ -1,40 +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>;
-}
+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/common/src/distributed-lock.context.d.ts

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

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

@@ -1,22 +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>;
+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/common/src/graphql.context.d.ts

@@ -1,7 +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;
-}
+/** 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/common/src/graphql.types.d.ts

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

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

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

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

@@ -1,50 +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
-}
+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/common/src/index.d.ts

@@ -1,56 +1,57 @@
-export * from './ai-assistant.schemas';
-export * from './ai-assistant.types';
-export * from './api-call.context';
-export * from './api.types';
-export * from './application.schemas';
-export * from './application.types';
-export * from './backend-function.schemas';
-export * from './backend-function.types';
-export * from './backend-run.types';
-export * from './bundle-api.types';
-export * from './bundle-data.types';
-export * from './communication.types';
-export * from './context.types';
-export * from './distributed-lock.context';
-export * from './document.types';
-export * from './graphql.context';
-export * from './graphql.types';
-export * from './http-status.enum';
-export * from './integrations';
-export * from './logger.types';
-export * from './metrics.types';
-export * from './mutation.context';
-export * from './mutation.schemas';
-export * from './mutation.types';
-export * from './named-query.context';
-export * from './named-query.schemas';
-export * from './named-query.types';
-export * from './native-query.context';
-export * from './native-query.types';
-export * from './query';
-export * from './query.types';
-export * from './regions';
-export * from './schema/schema.types';
-export * from './secret.schemas';
-export * from './secret.types';
-export * from './security.types';
-export * from './socket.schemas';
-export * from './socket.types';
-export * from './time-units';
-export * from './trigger.types';
-export * from './types';
-export * from './utils/array';
-export * from './utils/assert';
-export * from './utils/error';
-export * from './utils/http';
-export * from './utils/id';
-export * from './utils/lock.manager';
-export * from './utils/object';
-export * from './utils/serialization';
-export * from './utils/transforms';
-export * from './utils/url';
-export * from './utils/validation';
-export * from './webhook-response';
-export * from './heartbeat.types';
-export * from './utils/global.utils';
-export * from './websocket.impl';
+export * from './ai-chatbot.schemas';
+export * from './ai-chatbot.types';
+export * from './ai-assistant.types';
+export * from './api-call.context';
+export * from './api.types';
+export * from './application.schemas';
+export * from './application.types';
+export * from './backend-function.schemas';
+export * from './backend-function.types';
+export * from './backend-run.types';
+export * from './bundle-api.types';
+export * from './bundle-data.types';
+export * from './communication.types';
+export * from './context.types';
+export * from './distributed-lock.context';
+export * from './document.types';
+export * from './graphql.context';
+export * from './graphql.types';
+export * from './http-status.enum';
+export * from './integrations';
+export * from './logger.types';
+export * from './metrics.types';
+export * from './mutation.context';
+export * from './mutation.schemas';
+export * from './mutation.types';
+export * from './named-query.context';
+export * from './named-query.schemas';
+export * from './named-query.types';
+export * from './native-query.context';
+export * from './native-query.types';
+export * from './query';
+export * from './query.types';
+export * from './regions';
+export * from './schema/schema.types';
+export * from './secret.schemas';
+export * from './secret.types';
+export * from './security.types';
+export * from './socket.schemas';
+export * from './socket.types';
+export * from './time-units';
+export * from './trigger.types';
+export * from './types';
+export * from './utils/array';
+export * from './utils/assert';
+export * from './utils/error';
+export * from './utils/http';
+export * from './utils/id';
+export * from './utils/lock.manager';
+export * from './utils/object';
+export * from './utils/serialization';
+export * from './utils/transforms';
+export * from './utils/url';
+export * from './utils/validation';
+export * from './webhook-response';
+export * from './heartbeat.types';
+export * from './utils/global.utils';
+export * from './websocket.impl';

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

@@ -0,0 +1,31 @@
+import { AiModelName } from '../ai-chatbot.types';
+import { IntegrationId } from '../communication.types';
+import { BaseIntegrationConfig, IntegrationType } from './index';
+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;
+}