@squidcloud/backend 1.0.145 → 1.0.146-beta

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

@@ -0,0 +1,71 @@
+import { AiConnectedIntegrationMetadata, AiSessionContext, AllAiAgentChatOptions } from '@squidcloud/client';
+import { AiFunctionId } from '@squidcloud/client';
+import { AiAgentId, IntegrationId } from '@squidcloud/client';
+import { IntegrationType } from '@squidcloud/client';
+/**
+ * Context object passed as a second parameter to every AI function call,
+ * providing both agent-specific and function-specific context.
+ * @category AI
+ */
+export interface AiFunctionCallContext<FunctionContextType = unknown, AgentContextType = unknown> {
+    /** Unique identifier for the AI agent making the call. */
+    agentId: AiAgentId;
+    /**
+     * Persistent context of the AI agent that calls the function.
+     * Same for all AI functions used by this agent.
+     */
+    agentContext: AgentContextType;
+    /**
+     * Context specific to each individual AI function call.
+     * Can contain parameters or data unique to the current function invocation
+     * or current function connection to the AI agent.
+     */
+    functionContext: FunctionContextType;
+    /** The session associated with this AI function call. */
+    sessionContext: AiSessionContext;
+}
+/** AiFunctionContext for the connected integration function. Contains predefined integration data. */
+export interface AiFunctionCallContextWithIntegration<AiConnectedIntegrationOptionsType = unknown, FunctionContextType = unknown, AgentContextType = unknown> extends AiFunctionCallContext<FunctionContextType, AgentContextType>, AiConnectedIntegrationMetadata<AiConnectedIntegrationOptionsType> {
+}
+/**
+ * Provides context to the security rules of an AI Agent for each new user prompt.
+ * Refer to the `@secureAiAgent` annotation for more details.
+ * @category AI
+ */
+export declare class SecureAiAgentContext {
+    readonly prompt?: string;
+    readonly agentId: AiAgentId;
+    readonly options?: AllAiAgentChatOptions;
+}
+/**
+ * A type defining an AI functions configurator request.
+ * @category AI
+ */
+export interface AiFunctionsConfiguratorRequest {
+    /** ID of the connected integration to configure. */
+    integrationId: IntegrationId;
+    /** Type of the integration to configure. */
+    integrationType: IntegrationType;
+    /** Current connected integration metadata with custom options. */
+    metadata: AiConnectedIntegrationMetadata;
+}
+/**
+ * Result of the configurator function call:
+ * details how to override the set of AI functions available in the bundle.
+ */
+export interface AiFunctionsConfiguratorResponse {
+    /**
+     * Map of overridden functions.
+     * If a function is not mentioned in the map - there is no override.
+     */
+    functionOverrides: Record<AiFunctionId, AiFunctionOverrideDetails>;
+}
+/** An override for a single AI function. */
+export interface AiFunctionOverrideDetails {
+    /** Overridden AI function ID. */
+    id: AiFunctionId;
+    /** If set to true, the function won't be available for the connector agent. */
+    isExcluded?: boolean;
+    /** Set of parameters to fill with a predefined values. */
+    predefinedParameters: Record<string, unknown>;
+}

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

@@ -0,0 +1,30 @@
+import { ApiOptions } from '@squidcloud/client';
+import { ApiEndpointId, HttpMethod } from '@squidcloud/client';
+import { IntegrationId } from '@squidcloud/client';
+/** The headers of an API call. */
+export type ApiHeaders = Record<string, string | number | boolean>;
+/** The context of an API call. */
+export declare class ApiCallContext {
+    readonly integrationId: IntegrationId;
+    readonly endpointId: ApiEndpointId;
+    readonly url: string;
+    readonly method: HttpMethod;
+    readonly body: unknown;
+    readonly options: ApiOptions;
+}
+/**
+ * Represents a request to call an API through a specified integration and endpoint.
+ * Includes optional method override and additional request options.
+ */
+export interface CallApiRequest<BodyType = any> {
+    /** The identifier of the integration through which the API is called. */
+    integrationId: IntegrationId;
+    /** Target API endpoint to invoke. */
+    endpointId: ApiEndpointId;
+    /** Optional request payload. */
+    body?: BodyType;
+    /** Optional HTTP method override. Default is POST. */
+    overrideMethod?: HttpMethod;
+    /** Additional request options. */
+    options: ApiOptions;
+}

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

@@ -0,0 +1,94 @@
+/** A type alias for a string that represents a webhook. */
+export type WebhookId = string;
+/** A type alias for a string that represents a trigger ID. */
+export type TriggerId = string;
+/** A type alias for a string that represents a scheduler ID. */
+export type SchedulerId = string;
+/** The supported cron expression string. */
+export type CronExpressionString = `${string} ${string} ${string} ${string} ${string}` | `${string} ${string} ${string} ${string}`;
+/** A set of predefined cron expressions. */
+export declare enum CronExpression {
+    EVERY_SECOND = "* * * * * *",
+    EVERY_5_SECONDS = "*/5 * * * * *",
+    EVERY_10_SECONDS = "*/10 * * * * *",
+    EVERY_30_SECONDS = "*/30 * * * * *",
+    EVERY_MINUTE = "*/1 * * * *",
+    EVERY_5_MINUTES = "0 */5 * * * *",
+    EVERY_10_MINUTES = "0 */10 * * * *",
+    EVERY_30_MINUTES = "0 */30 * * * *",
+    EVERY_HOUR = "0 0-23/1 * * *",
+    EVERY_2_HOURS = "0 0-23/2 * * *",
+    EVERY_3_HOURS = "0 0-23/3 * * *",
+    EVERY_4_HOURS = "0 0-23/4 * * *",
+    EVERY_5_HOURS = "0 0-23/5 * * *",
+    EVERY_6_HOURS = "0 0-23/6 * * *",
+    EVERY_7_HOURS = "0 0-23/7 * * *",
+    EVERY_8_HOURS = "0 0-23/8 * * *",
+    EVERY_9_HOURS = "0 0-23/9 * * *",
+    EVERY_10_HOURS = "0 0-23/10 * * *",
+    EVERY_11_HOURS = "0 0-23/11 * * *",
+    EVERY_12_HOURS = "0 0-23/12 * * *",
+    EVERY_DAY_AT_1AM = "0 01 * * *",
+    EVERY_DAY_AT_2AM = "0 02 * * *",
+    EVERY_DAY_AT_3AM = "0 03 * * *",
+    EVERY_DAY_AT_4AM = "0 04 * * *",
+    EVERY_DAY_AT_5AM = "0 05 * * *",
+    EVERY_DAY_AT_6AM = "0 06 * * *",
+    EVERY_DAY_AT_7AM = "0 07 * * *",
+    EVERY_DAY_AT_8AM = "0 08 * * *",
+    EVERY_DAY_AT_9AM = "0 09 * * *",
+    EVERY_DAY_AT_10AM = "0 10 * * *",
+    EVERY_DAY_AT_11AM = "0 11 * * *",
+    EVERY_DAY_AT_NOON = "0 12 * * *",
+    EVERY_DAY_AT_1PM = "0 13 * * *",
+    EVERY_DAY_AT_2PM = "0 14 * * *",
+    EVERY_DAY_AT_3PM = "0 15 * * *",
+    EVERY_DAY_AT_4PM = "0 16 * * *",
+    EVERY_DAY_AT_5PM = "0 17 * * *",
+    EVERY_DAY_AT_6PM = "0 18 * * *",
+    EVERY_DAY_AT_7PM = "0 19 * * *",
+    EVERY_DAY_AT_8PM = "0 20 * * *",
+    EVERY_DAY_AT_9PM = "0 21 * * *",
+    EVERY_DAY_AT_10PM = "0 22 * * *",
+    EVERY_DAY_AT_11PM = "0 23 * * *",
+    EVERY_DAY_AT_MIDNIGHT = "0 0 * * *",
+    EVERY_WEEK = "0 0 * * 7",
+    EVERY_WEEKDAY = "0 0 * * 1-5",
+    EVERY_WEEKEND = "0 0 * * 6,7",
+    EVERY_1ST_DAY_OF_MONTH_AT_MIDNIGHT = "0 0 1 * *",
+    EVERY_1ST_DAY_OF_MONTH_AT_NOON = "0 12 1 * *",
+    EVERY_2ND_HOUR = "0 */2 * * *",
+    EVERY_2ND_HOUR_FROM_1AM_THROUGH_11PM = "0 1-23/2 * * *",
+    EVERY_2ND_MONTH = "0 0 1 */2 *",
+    EVERY_QUARTER = "0 0 1 */3 *",
+    EVERY_6_MONTHS = "0 0 1 */6 *",
+    EVERY_YEAR = "0 0 1 1 *",
+    EVERY_30_MINUTES_BETWEEN_9AM_AND_5PM = "0 */30 9-17 * * *",
+    EVERY_30_MINUTES_BETWEEN_9AM_AND_6PM = "0 */30 9-18 * * *",
+    EVERY_30_MINUTES_BETWEEN_10AM_AND_7PM = "0 */30 10-19 * * *",
+    MONDAY_TO_FRIDAY_AT_1AM = "0 0 01 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_2AM = "0 0 02 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_3AM = "0 0 03 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_4AM = "0 0 04 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_5AM = "0 0 05 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_6AM = "0 0 06 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_7AM = "0 0 07 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_8AM = "0 0 08 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_9AM = "0 0 09 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_09_30AM = "0 30 09 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_10AM = "0 0 10 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_11AM = "0 0 11 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_11_30AM = "0 30 11 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_12PM = "0 0 12 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_1PM = "0 0 13 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_2PM = "0 0 14 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_3PM = "0 0 15 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_4PM = "0 0 16 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_5PM = "0 0 17 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_6PM = "0 0 18 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_7PM = "0 0 19 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_8PM = "0 0 20 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_9PM = "0 0 21 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_10PM = "0 0 22 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_11PM = "0 0 23 * * 1-5"
+}

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

@@ -0,0 +1,178 @@
+import { UserAiAskResponse, UserAiChatOptions } from '@squidcloud/client';
+import { ClientId, IntegrationId } from '@squidcloud/client';
+import { CollectionName, DocIdOrDocIdObj, DocumentData } from '@squidcloud/client';
+import { ClientConnectionState } from '@squidcloud/client';
+import { AiFunctionCallContextWithIntegration, SecureAiAgentContext } from './ai-agent.public-context';
+import { ApiCallContext } from './api-call.public-context';
+import { DatabaseActionType, MetricActionType, StorageActionType, TopicActionType } from './bundle-data.public-types';
+import { DistributedLockContext } from './distributed-lock.public-context';
+import { GraphqlContext } from './graphql.public-context';
+import { McpAuthorizationRequest } from './mcp.public-types';
+import { SecureMetricContext } from './metric.public-context';
+import { MutationContext, MutationType } from './mutation.public-context';
+import { NativeQueryContext } from './native-query.public-context';
+import { AiQueryContext, QueryContext } from './query.public-context';
+import { StorageContext } from './storage.public-types';
+import { TopicReadContext, TopicWriteContext } from './topic.public-context';
+/**
+ * @category Database
+ */
+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>);
+/**
+ * @category Database
+ * @category AI
+ */
+export type SecureAiQueryAction = ((context: AiQueryContext) => boolean | Promise<boolean>) | (() => boolean | Promise<boolean>);
+/**
+ * @category Storage
+ */
+export type SecureStorageAction<T extends StorageActionType> = T extends 'all' ? () => boolean | Promise<boolean> : (context: StorageContext) => boolean | Promise<boolean>;
+/**
+ * @category Queue
+ */
+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>);
+/** A function that determines access to a metric based on the action type T. */
+export type SecureMetricAction<T extends MetricActionType> = T extends 'all' ? ((context: SecureMetricContext) => boolean | Promise<boolean>) | (() => boolean | Promise<boolean>) : T extends 'write' ? ((context: SecureMetricContext) => boolean | Promise<boolean>) | (() => boolean | Promise<boolean>) : never;
+/** A function that determines access to an API call, optionally using the call context. */
+export type SecureApiAction = ((context: ApiCallContext) => boolean | Promise<boolean>) | (() => boolean | Promise<boolean>);
+/** A function that determines access to a native query, optionally using the query context. */
+export type SecureNativeQueryAction = ((context: NativeQueryContext) => boolean | Promise<boolean>) | (() => boolean | Promise<boolean>);
+/** A function that determines access to a distributed lock, optionally using the lock context. */
+export type SecureDistributedLockAction = ((context: DistributedLockContext) => boolean | Promise<boolean>) | (() => boolean | Promise<boolean>);
+/** A function that determines access to a GraphQL operation, optionally using the GraphQL context. */
+export type SecureGraphQLAction = ((context: GraphqlContext) => boolean | Promise<boolean>) | (() => boolean | Promise<boolean>);
+/**
+ * @category AI
+ */
+export type SecureAiAgentAction = ((context: SecureAiAgentContext) => boolean | Promise<boolean>) | (() => boolean | Promise<boolean>);
+/** A type defining a function that handles changes in client connection state. */
+export type ClientConnectionStateChangeAction = (clientId: ClientId, clientConnectionState: ClientConnectionState) => Promise<void> | void;
+/** A type representing a generic executable function with variable arguments. */
+export type ExecutableAction = (...args: any[]) => any;
+/**
+ * A type defining an AI function action with parameters and context.
+ * The context object may be AiFunctionCallContext (for functions with no integration type) or
+ * AiFunctionCallContextWithIntegration.
+ * @category AI
+ */
+export type AiFunctionAction<T extends Record<string, any> = any> = (params: T, context: AiFunctionCallContextWithIntegration<any, any, any>) => any;
+/**
+ * A type defining an MCP tool with parameters.
+ * @category AI
+ */
+export type McpToolAction<T extends Record<string, any> = any> = (params: T) => any;
+/**
+ * A type defining an MCP authorizer action that can authorize requests.
+ * @category AI
+ */
+export type McpAuthorizerAction = ((request: McpAuthorizationRequest) => boolean | Promise<boolean>) | (() => boolean | Promise<boolean>);
+/** A type defining a trigger function that responds to document changes. */
+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> {
+    /** The ID of the integration associated with the trigger. */
+    integrationId: IntegrationId;
+    /** The name of the collection affected by the trigger. */
+    collectionName: CollectionName;
+    /** The document ID or object representing the affected document. */
+    docId: DocIdOrDocIdObj;
+    /** The type of mutation that triggered the action. */
+    mutationType: MutationType;
+    /** The document state before the mutation, if available. */
+    docBefore?: T;
+    /** The document state after the mutation, if available. */
+    docAfter?: T;
+}
+/** A type defining a scheduled task action. */
+export type SchedulerAction = () => void | Promise<void>;
+/** Defines a function with rate or quota limits. */
+export type LimitsAction = (...args: any[]) => any | Promise<any>;
+/** Specifies the scope of a limiter, such as per IP, user, or global. */
+export type LimiterScope = 'ip' | 'user' | 'global';
+/** Specifies the renewal period for a quota limit. */
+export type QuotaRenewPeriod = 'hourly' | 'daily' | 'weekly' | 'monthly' | 'quarterly' | 'annually';
+/** Options for rate limiting. */
+export interface RateLimitOptions {
+    /** Number of executions permitted per second, allowing bursts up to 3x this limit. */
+    value: number;
+    /** Specifies the scope of the rate limit, such as per user, IP, or global. */
+    scope?: LimiterScope;
+}
+/** Options for quota limiting. */
+export interface QuotaLimitOptions {
+    /** Total number of executions allowed, reset upon backend redeployment. */
+    value: number;
+    /** Specifies the scope of the quota limit, such as per user, IP, or global. */
+    scope?: LimiterScope;
+    /** Defines the period after which the quota resets. */
+    renewPeriod?: QuotaRenewPeriod;
+}
+/**
+ * Options for rate and quota limiting backend functions.
+ *
+ * This mirrors the type in Kotlin. It is not the type the developer defines in their code, which is LimiterConfig.
+ */
+export interface LimiterOptions {
+    /** Array of rate limit configurations, allowing different limits at different scopes. */
+    rateLimit?: RateLimitOptions[];
+    /** Array of quota limit configurations, allowing different limits at different scopes. */
+    quotaLimit?: QuotaLimitOptions[];
+}
+/** A configuration type for defining rate and quota limits in a flexible format. */
+export type LimiterConfig = {
+    /** The rate limit, specified as a number, a single RateLimitOptions object, or an array of RateLimitOptions. */
+    rateLimit?: number | RateLimitOptions | Array<RateLimitOptions>;
+    /** The quota limit, specified as a number, a single QuotaLimitOptions object, or an array of QuotaLimitOptions. */
+    quotaLimit?: number | QuotaLimitOptions | Array<QuotaLimitOptions>;
+};
+/** A type defining a webhook function that processes incoming requests, with or without request context. */
+export type WebhookAction = ((request: WebhookRequest) => any) | (() => any);
+/** The context provided to a webhook function. */
+export interface WebhookRequest<T = any> {
+    /** The parsed body of the webhook request. */
+    body: T;
+    /** The unparsed body of the webhook request as a string, if available. */
+    rawBody?: string;
+    /** A record of query parameters included in the webhook request. */
+    queryParams: Record<string, string>;
+    /** A record of HTTP headers included in the webhook request. */
+    headers: Record<string, string>;
+    /** The HTTP method used for the webhook request. */
+    httpMethod: 'post' | 'get' | 'put' | 'delete';
+    /** An array of files uploaded with the webhook request, if any. */
+    files?: Array<SquidFile>;
+}
+/** An interface representing the response structure returned by a webhook function. */
+export interface WebhookResponse {
+    /** A record of HTTP headers to include in the webhook response. */
+    headers: Record<string, any>;
+    /** The body content of the webhook response. */
+    body: any;
+    /** The HTTP status code for the webhook response. */
+    statusCode: number;
+    /** A flag indicating this is a webhook response object. */
+    __isWebhookResponse__: true;
+}
+/** An interface representing a file in some Squid operations. */
+export interface SquidFile {
+    /** The binary data of the file. */
+    data: Uint8Array;
+    /** The name of the form field containing the file. */
+    fieldName: string;
+    /** The MIME type of the uploaded file. */
+    mimetype: string;
+    /** The original filename as provided by the uploader. */
+    originalName: string;
+    /** The size of the file in bytes. */
+    size: number;
+    /** The encoding of the file, if specified. */
+    encoding?: string;
+    /** An indicator that this is a Squid file. */
+    __isSquidFile__: true;
+}
+/** Defines a function for asking an LLM model a prompt. */
+export type LlmAskAction = (prompt: string, options: UserAiChatOptions) => Promise<UserAiAskResponse>;
+/**
+ * Base type for all decorators used in backend projects.
+ */
+export type ActionMethodDecorator<U> = <T extends U>(target: Object, propertyName: string, descriptor: TypedPropertyDescriptor<T>) => TypedPropertyDescriptor<T>;

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

@@ -0,0 +1,46 @@
+import { AiFileUrl } from '@squidcloud/client';
+import { IntegrationType } from '@squidcloud/client';
+/** 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 for storage. */
+export type StorageActionType = '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 type of actions for metrics. */
+export type MetricActionType = 'write' | 'all';
+/** Represents the possible data types for an AI function parameter. */
+export type AiFunctionParamType = 'string' | 'number' | 'boolean' | 'date' | 'files';
+/** Defines the structure of a parameter for an AI function. */
+export interface AiFunctionParam {
+    /** Name of the parameter. */
+    name: string;
+    /** Description of the parameter's purpose. */
+    description: string;
+    /** Data type of the parameter. */
+    type: AiFunctionParamType;
+    /** Indicates if the parameter is mandatory. */
+    required: boolean;
+    /** List of possible values for the parameter, if applicable. */
+    enum?: Array<Omit<AiFunctionParamType, 'date'>>;
+}
+/** Represents an AI function response that also includes files. */
+export interface AiFunctionResponseWithFiles {
+    /** Indicates that this is an AI function response with files. */
+    __isAiFunctionResponseWithFiles: true;
+    /** The response from the AI function. */
+    response: any;
+    /** Optional list of files associated with the response. */
+    files: Array<AiFileUrl>;
+}
+/** Additional optional readonly metadata for AI function. */
+export interface AiFunctionAttributes {
+    /**
+     * Type of integration this function is used for.
+     * Functions with defined 'integrationType' require 'integrationId' to be passed as part of the function context.
+     */
+    integrationType?: Array<IntegrationType>;
+}
+/** ID of the tenant module: either user code (see USER_CODE_MODULE_ID) or a connector ID. */
+export type TenantModuleId = string;
+/** Type for the user code module loaded by worker/local-backend code. */
+export declare const USER_CODE_MODULE_ID: TenantModuleId;

package/dist/internal-common/src/public-types-backend/distributed-lock.public-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-backend/graphql.public-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-backend/llm.public-types.d.ts

@@ -0,0 +1,10 @@
+import { LlmModelMetadata, UserAiChatModelName } from '@squidcloud/client';
+/**
+ * Options for the `@llmService` decorator.
+ */
+export interface LlmServiceOptions {
+    /**
+     * Map of model names to their metadata.
+     */
+    models: Record<UserAiChatModelName, LlmModelMetadata>;
+}

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

@@ -0,0 +1,31 @@
+/**
+ * Options for the `@mcpServer` decorator.
+ */
+export interface McpServerOptions {
+    /** Unique ID for this MCP server that will also be used in the MCP url. */
+    id: string;
+    /**
+     * The MCP description.
+     */
+    description: string;
+    /** The MCP name - it will be exposed in the MCP manifest. */
+    name: string;
+    /**
+     * The version of the MCP server.
+     * This will be exposed in the MCP manifest.
+     */
+    version: string;
+}
+/**
+ * Represents a request to authorize an MCP request.
+ *
+ * @category MCP
+ */
+export interface McpAuthorizationRequest {
+    /** The parsed body of the webhook request. */
+    body: any;
+    /** A record of query parameters included in the webhook request. */
+    queryParams: Record<string, string>;
+    /** A record of HTTP headers included in the webhook request. */
+    headers: Record<string, string>;
+}

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

@@ -0,0 +1,12 @@
+/**
+ * A context passed to functions annotated with the '@secureMetric' decorator.
+ * @category Platform
+ */
+export interface SecureMetricContext {
+    /** Name of the metric to check. */
+    name: string;
+    /** Key-value pairs for tagging the metric. */
+    tags: Record<string, string>;
+    /** Numeric value of the metric. */
+    value: number;
+}

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

@@ -0,0 +1,148 @@
+import { SquidDocIdObj, SquidDocument } from '@squidcloud/client';
+import { Paths } from '@squidcloud/client';
+/**
+ * The mutation type.
+ * @category Database
+ */
+export declare const MUTATION_TYPES: readonly ["insert", "update", "delete"];
+/**
+ * @category Database
+ */
+export type MutationType = (typeof MUTATION_TYPES)[number];
+interface BaseMutation {
+    type: MutationType;
+    squidDocIdObj: SquidDocIdObj;
+}
+/**
+ * A mutation on a document.
+ * @category Database
+ */
+export type Mutation<T = any> = UpdateMutation<T> | InsertMutation<T> | DeleteMutation;
+/**
+ * Represents a delete mutation on a document.
+ * @category Database
+ */
+export interface DeleteMutation extends BaseMutation {
+    /** Specifies that the mutation is a deletion. */
+    type: 'delete';
+}
+/**
+ * Represents an update mutation on a document.
+ * @category Database
+ */
+export interface UpdateMutation<T = any> extends BaseMutation {
+    /** Specifies that the mutation is an update. */
+    type: 'update';
+    /** The updated properties */
+    properties: {
+        [key in keyof T & string]?: Array<PropertyMutation<T[key]>>;
+    };
+}
+/**
+ * Represents an insert mutation on a document.
+ * @category Database
+ */
+export interface InsertMutation<T = any> extends BaseMutation {
+    /** Specifies that the mutation is an insertion. */
+    type: 'insert';
+    /** The inserted document */
+    properties: T;
+}
+/**
+ * A representation of a single property update.
+ * @category Database
+ */
+export type PropertyMutation<Value = any> = ApplyNumericFnPropertyMutation | ApplyStringFnPropertyMutation | ValueUpdatePropertyMutation<Value> | RemovePropertyMutation;
+/**
+ * A value update property mutation.
+ * @category Database
+ */
+export interface ValueUpdatePropertyMutation<Value = any> {
+    /** Specifies that the mutation updates a value. */
+    type: 'update';
+    /** New value to be set. */
+    value: Value;
+}
+/**
+ * Applying a numeric function to a property.
+ * @category Database
+ */
+export interface ApplyNumericFnPropertyMutation {
+    /** Specifies that the mutation applies a numeric function. */
+    type: 'applyNumericFn';
+    /** Numeric function to apply. */
+    fn: 'increment';
+    /** Value to use in the numeric function. */
+    value: number;
+}
+/**
+ * A property update that removes a property from a document.
+ * @category Database
+ */
+export interface RemovePropertyMutation {
+    /** Specifies that the mutation removes a property. */
+    type: 'removeProperty';
+}
+interface ApplyExtendString {
+    /** Specifies that the mutation applies a string function. */
+    type: 'applyStringFn';
+    /** String function to extend the existing string. */
+    fn: 'extendString';
+    /** String value to append. */
+    value: string;
+}
+interface ApplyTrimString {
+    /** Specifies that the mutation applies a string function. */
+    type: 'applyStringFn';
+    /** String function to trim the existing string. */
+    fn: 'trim';
+}
+/**
+ * A property mutation that modifies a string.
+ * @category Database
+ */
+export type ApplyStringFnPropertyMutation = ApplyExtendString | ApplyTrimString;
+/**
+ * The before and after documents of a document change.
+ * @category Database
+ */
+export interface BeforeAndAfterDocs<T = SquidDocument> {
+    /** Document state before the mutation. */
+    before: T | undefined;
+    /** Document state after the mutation. */
+    after: T | undefined;
+}
+/**
+ * The mutation context that will be provided to the security function.
+ * @category Database
+ */
+export declare class MutationContext<T = any> {
+    readonly mutation: Mutation<T>;
+    readonly beforeAndAfterDocs: BeforeAndAfterDocs<T>;
+    readonly serverTimeStamp: Date;
+    /**
+     * Returns the state of the document before the mutation was applied.
+     */
+    get before(): T | undefined;
+    /**
+     * Returns the state of the document after the mutation was applied.
+     */
+    get after(): T | undefined;
+    /**
+     * Returns the type of the mutation (insert, update, or delete).
+     */
+    getMutationType(): MutationType;
+    /** Returns true if the mutation affects the provided path. */
+    affectsPath(path: Paths<T>): boolean;
+    /**
+     * Find all affected paths starting from a root path.
+     *
+     * @example
+     * doc before - { a: { b: 1, c: 2 }, d: 3 }
+     * doc after - { a: { b: 1, c: 3 }, d: 4 }
+     * doc.affectedPaths('a') // ['a.c']
+     */
+    affectedPaths(startingRoot?: Paths<T> | string): Array<Paths<T>>;
+    private checkPath;
+}
+export {};