@squidcloud/backend 1.0.145 → 1.0.146-beta

package/dist/backend/src/actions.d.ts

@@ -1,193 +1,480 @@
-import { ActionMethodDecorator, AiChatbotActionType, AiFunctionAction, AiFunctionParam, ApiEndpointId, ClientConnectionStateChangeAction, CollectionName, CronExpression, CronExpressionString, DatabaseActionType, ExecutableAction, IntegrationId, QueryName, SchedulerAction, SchedulerId, SecureAiChatbotAction, SecureApiAction, SecureDatabaseAction, SecureDistributedLockAction, SecureGraphQLAction, SecureNamedQueryAction, SecureNativeQueryAction, TriggerAction, TriggerId, WebhookAction, WebhookId } from '@squidcloud/common';
-/**
- * Decorator that marks a function for securing a database.
- * The decorator takes a type of action and an optional integration ID.
- * If no integration ID is provided, the `built_in_db` integration is used.
- *
- * The function should return a boolean or a `Promise` of a boolean indicating
- * whether the action is allowed.
- * In addition, depending on the action, the function can take a context object
- * as a parameter. The context object contains information about the action.
- *
- * To read more about securing a database, see the
- * {@link https://docs.squid.cloud/docs/development-tools/backend/security-rules/secure-data-access#securedatabase documentation}.
- * @param type The type af action to secure.
- * @param integrationId The ID of the integration to secure.
- */
-export declare function secureDatabase<T extends DatabaseActionType>(type: T, integrationId?: IntegrationId): ActionMethodDecorator<SecureDatabaseAction<T>>;
-/**
- * Decorator that marks a function for securing a collection inside a database.
- * The decorator takes the collection, type of action, and an optional integration ID.
- * If no integration ID is provided, the `built_in_db` integration is used.
- *
- * The function should return a boolean or a `Promise` of a boolean indicating
- * whether the action is allowed.
- * In addition, depending on the action, the function can take a context object
- * as a parameter. The context object contains information about the action.
- *
- * To read more about securing a collection rules, see the
- * {@link https://docs.squid.cloud/docs/development-tools/backend/security-rules/secure-data-access#securecollection documentation}.
- * @param collectionName The name of the collection to secure.
- * @param type The type af action to secure.
- * @param integrationId The ID of the integration to secure.
- */
-export declare function secureCollection<T extends DatabaseActionType>(collectionName: CollectionName, type: T, integrationId?: IntegrationId): ActionMethodDecorator<SecureDatabaseAction<T>>;
-/**
- * Decorator that marks a function for securing an API or an endpoint inside an API.
- * The decorator takes the API integration ID, and an optional endpoint ID.
- * If no endpoint ID is provided, the function will secure the whole API.
- *
- * The function should return a boolean or a `Promise` of a boolean indicating
- * whether the action is allowed.
- * The function takes a context object as a parameter. The context object contains information about the action.
- *
- * To read more about securing an API, see the
- * {@link https://docs.squid.cloud/docs/development-tools/backend/security-rules/secure-api documentation}.
- * @param integrationId The ID of the integration to secure.
- * @param endpointId The ID of the endpoint to secure.
- */
-export declare function secureApi(integrationId: IntegrationId, endpointId?: ApiEndpointId): ActionMethodDecorator<SecureApiAction>;
-/**
- * Decorator that marks a function for securing a GraphQL integration.
- *
- * The function should return a boolean or a `Promise` of a boolean indicating
- * whether the action is allowed.
- * The function takes a context object as a parameter. The context object contains information about the action.
- *
- * To read more about securing a GraphQL integration, see the
- * {@link https://docs.squid.cloud/docs/development-tools/backend/security-rules/secure-graphql documentation}.
- * @param integrationId
- */
-export declare function secureGraphQL(integrationId: IntegrationId): ActionMethodDecorator<SecureGraphQLAction>;
-/**
- * Decorator that marks a function for exposing it as an executable.
- * The function can accept any parameter that can be serialized to JSON and return any parameter that can be serialzied
- * to JSON.
- *
- * Once the function is exposed, it can be called from the Squid Cloud SDK using the `executeFunction` method.
- * To read more about exposing an executable, see the
- * {@link https://docs.squid.cloud/docs/development-tools/backend/executables documentation}.
- */
-export declare function executable(): ActionMethodDecorator<ExecutableAction>;
-/**
- * Decorator that marks a function for exposing it to the AI assistant.
- * The function accepts a JSON object as described in the description of the function in the annotation.
- *
- * TODO - add docs
- * To read more about exposing an executable, see the
- * {@link https://docs.squid.cloud/docs/development-tools/backend/executables documentation}.
- */
-export declare function aiFunction<ParamType extends Record<string, any> = any>(description: string, params: Array<AiFunctionParam>): ActionMethodDecorator<AiFunctionAction<ParamType>>;
-/**
- * Decorator that marks a function as a trigger to a change in a collection. The function will be called each time a
- * change is made to the collection.
- * The function accepts a context object as a parameter. The context object contains information about the change.
- *
- * To read more about triggers, see the
- * {@link https://docs.squid.cloud/docs/development-tools/backend/triggers documentation}.
- *
- * @param ID The ID of the trigger. Should be unique.
- * @param collectionName The name of the collection to trigger on.
- * @param integrationId The ID of the integration to trigger on. If not provided, the `built_in_db` integration is
- *   used.
- */
-export declare function trigger(id: TriggerId, collectionName: CollectionName, integrationId?: IntegrationId): ActionMethodDecorator<TriggerAction>;
-/**
- * Decorator that marks a function as a scheduler. The function will be called according to the provided cron
- * expression.
- *
- * To read more about schedulers, see the
- * {@link https://docs.squid.cloud/docs/development-tools/backend/schedulers documentation}.
- *
- * @param ID The ID of the scheduler. Should be unique.
- * @param cronExpression The cron expression to schedule the function on.
- * @param exclusive Whether the scheduler should be exclusive. If set to true, the scheduler will not trigger if the
- *   previous scheduler is still running.
- */
-export declare function scheduler(id: SchedulerId, cronExpression: CronExpression | CronExpressionString, exclusive?: boolean): ActionMethodDecorator<SchedulerAction>;
-/**
- * Decorator that marks a function as a webhook. The function will be called when a webhook is triggered.
- * Once the webhook is created, it will be exposed as a URL with the provided webhook ID with this format:
- * `https://<your app Id>.<app region>.squid.cloud/webhooks/<webhook-id>`.
- *
- * The function accepts a context object as a parameter. The context object contains information about the webhook.
- * The function can return any value that can be serialized to JSON or a `WebhookResponse` object that can be created
- * using:
- * `this.createWebhookResponse(<params>)`.
- *
- * To read more about webhooks, see the
- * {@link https://docs.squid.cloud/docs/development-tools/backend/webhooks documentation}.
- * @param ID The ID of the webhook. Should be unique.
- */
-export declare function webhook(id: WebhookId): ActionMethodDecorator<WebhookAction>;
-/**
- * A decorator that can be applied on a static string property of a class to mark it as a named query.
- * The string can be any valid SQL in the given integration and can accept named parameters
- *
- * A named query can be invoked from the SDK using the `executeNamedQuery` method.
- *
- * To read more about named queries, see the
- * {@link https://docs.squid.cloud/docs/development-tools/backend/named-queries documentation}.
- *
- * @param integrationId The database integration ID (Note that the `built_in_db` does not support named queries)
- * @param name The name of the query that will be used to call it from the SDK.
- */
-export declare function namedQuery(integrationId: string, name: string): any;
-/**
- * A decorator that can be used to secure a named query. Named queries are secured by default and can be invoked only
- * if the decorated function allows it.
- * The function returns a boolean or a `Promise` of a boolean that indicates whether the query can be executed or not.
- *
- * The function accepts a context object as a parameter. The context object contains information about the query.
- *
- * To read more about securing a Named Query, see the
- * {@link https://docs.squid.cloud/docs/development-tools/backend/security-rules/secure-data-access#securenamedquery documentation}.
- *
- * @param integrationId The database integration ID.
- * @param queryName The name of the query.
- */
-export declare function secureNamedQuery(integrationId: IntegrationId, queryName: QueryName): ActionMethodDecorator<SecureNamedQueryAction>;
-/**
- * A decorator that can be used to secure a native query. Native queries are not secured by default and must be
- * explicitly secured using this decorator. The decorated function must return a boolean or a `Promise` of a boolean
- * that indicates whether the query can be executed or not.
- *
- * The function accepts a context object as a parameter. The context object contains information about the query.
- *
- * To read more about securing a Native Query, see the
- * {@link https://docs.squid.cloud/docs/development-tools/backend/security-rules/secure-data-access#securenativequery documentation}.
- *
- * @param integrationId The database integration ID.
- * @returns A decorator function that can be used to secure a native query.
- */
-export declare function secureNativeQuery(integrationId: IntegrationId): ActionMethodDecorator<SecureNativeQueryAction>;
-/**
- * A decorator that can be used to secure a distributed lock. Distributed locks are secured by default and can be
- * invoked only if the decorated function allows it. The function returns a boolean or a `Promise` of a boolean that
- * indicates whether the lock can be acquired or not.
- *
- * The function accepts a context object as a parameter. The context object contains information about the mutex and
- * the request.
- *
- * @param mutex The mutex to lock on. If none provided, the rule will apply for all mutexes.
- */
-export declare function secureDistributedLock(mutex?: string): ActionMethodDecorator<SecureDistributedLockAction>;
-/**
- * A decorator that can be used to secure an AI chatbot. The decorator takes the AI Chatbot
- * integration ID, the action type (`chat` or `mutate`), and an optional profile ID. If no profile ID
- * is provided, the function will secure all requests to the integration (for the given action type).
- *
- * The function should return a boolean or a `Promise` of a boolean indicating
- * whether the action is allowed.
- * The function takes a context object as a parameter. The context object contains information about the action.
- *
- * To read more about named queries, see the
- * {@link https://docs.squid.cloud/docs/development-tools/backend/security-rules/secure-ai-chatbot documentation}.
- *
- @param integrationId The ID of the integration to secure.
- @param type The type af action to secure.
- @param profileId The ID of the profile to secure.
- */
-export declare function secureAiChatbot<T extends AiChatbotActionType>(integrationId: IntegrationId, type: T, profileId?: string): ActionMethodDecorator<SecureAiChatbotAction<T>>;
-/** Decorator that marks a function for handling a client connection state change */
-export declare function clientConnectionStateHandler(): ActionMethodDecorator<ClientConnectionStateChangeAction>;
+import { AiFunctionId, ApiEndpointId, CollectionName, IntegrationId, IntegrationType, TopicName } from '@squidcloud/client';
+import { JSONSchema } from 'json-schema-typed';
+import { ActionMethodDecorator, AiFunctionAction, ClientConnectionStateChangeAction, ExecutableAction, LimiterConfig, LimitsAction, LlmAskAction, McpAuthorizerAction, McpToolAction, SchedulerAction, SecureAiAgentAction, SecureAiQueryAction, SecureApiAction, SecureDatabaseAction, SecureDistributedLockAction, SecureGraphQLAction, SecureMetricAction, SecureNativeQueryAction, SecureStorageAction, SecureTopicAction, TriggerAction, WebhookAction } from '../../internal-common/src/public-types-backend/bundle-api.public-types';
+import { AiFunctionAttributes, AiFunctionParam, DatabaseActionType, MetricActionType, StorageActionType, TopicActionType } from '../../internal-common/src/public-types-backend/bundle-data.public-types';
+import { AiFunctionsConfiguratorRequest, AiFunctionsConfiguratorResponse, CronExpression, CronExpressionString, LlmServiceOptions, McpServerOptions, MutationType, SchedulerId, TriggerId, WebhookId } from './public-types';
+/**
+ * Decorator that marks a function for securing a database.
+ * The decorator takes a type of action and an optional integration ID.
+ * If no integration ID is provided, the `built_in_db` integration is used.
+ *
+ * The function should return a boolean or a `Promise` of a boolean indicating
+ * whether the action is allowed.
+ * In addition, depending on the action, the function can take a context object
+ * as a parameter. The context object contains information about the action.
+ *
+ * To read more about securing a database, see the
+ * {@link https://docs.getsquid.ai/docs/security/security-rules/secure-data-access#securedatabase documentation}.
+ * @param type The type of action to secure.
+ * @param integrationId The ID of the integration to secure.
+ * @category Database
+ * @category Decorator
+ */
+export declare function secureDatabase<T extends DatabaseActionType>(type: T, integrationId?: IntegrationId): ActionMethodDecorator<SecureDatabaseAction<T>>;
+/**
+ * Decorator that marks a function for securing a database for querying it with AI (`executeAiQuery`).
+ *
+ * The decorator takes an optional integration ID.
+ * If no integration ID is provided, the `built_in_db` integration is used.
+ *
+ * The function should return a boolean or a `Promise` of a boolean indicating
+ * whether the action is allowed.
+ * In addition, the function takes a context object as a parameter.
+ * The context object contains information about the action.
+ *
+ * @param integrationId The ID of the integration to secure.
+ * @category Database
+ * @category Decorator
+ * @category AI
+ */
+export declare function secureAiQuery(integrationId?: IntegrationId): ActionMethodDecorator<SecureAiQueryAction>;
+/**
+ * Decorator that marks a function for securing a collection inside a database.
+ * The decorator takes the collection, type of action, and an optional integration ID.
+ * If no integration ID is provided, the `built_in_db` integration is used.
+ *
+ * The function should return a boolean or a `Promise` of a boolean indicating
+ * whether the action is allowed.
+ * In addition, depending on the action, the function can take a context object
+ * as a parameter. The context object contains information about the action.
+ *
+ * To read more about securing a collection rules, see the
+ * {@link https://docs.getsquid.ai/docs/security/security-rules/secure-data-access#securecollection documentation}.
+ * @param collectionName The name of the collection to secure.
+ * @param type The type of action to secure.
+ * @param integrationId The ID of the integration to secure.
+ * @category Database
+ * @category Decorator
+ */
+export declare function secureCollection<T extends DatabaseActionType>(collectionName: CollectionName, type: T, integrationId?: IntegrationId): ActionMethodDecorator<SecureDatabaseAction<T>>;
+/**
+ * The decorator allows protects storage buckets so only authorized users can access it.
+ * @category Storage
+ * @category Decorator
+ */
+export declare function secureStorage<T extends StorageActionType>(type: T, integrationId?: IntegrationId): ActionMethodDecorator<SecureStorageAction<T>>;
+/**
+ * Decorator that marks a function for securing a topic in a message queue.
+ * The decorator takes the topic name, type of action, and an optional integration ID.
+ * If no integration ID is provided, the `built_in_queue` integration is used.
+ *
+ * The function should return a boolean or a `Promise` of a boolean indicating
+ * whether the action is allowed.
+ *
+ * To read more about securing a topic, see the
+ * {@link https://docs.getsquid.ai/docs/security/security-rules/secure-data-access documentation}.
+ * @param topicName The name of the topic to secure.
+ * @param type The type of action to secure.
+ * @param integrationId The ID of the integration to secure.
+ * @category Queue
+ * @category Decorator
+ */
+export declare function secureTopic<T extends TopicActionType>(topicName: TopicName, type: T, integrationId?: IntegrationId): ActionMethodDecorator<SecureTopicAction<T>>;
+/**
+ * Decorator that marks a function for securing a metric.
+ * The decorator takes the metric name prefix and type of action.
+ *
+ * The function should return a boolean or a `Promise` of a boolean indicating
+ * whether the action is allowed.
+ * @category Decorator
+ */
+export declare function secureMetric<T extends MetricActionType>(options: SecureMetricOptions<T>): ActionMethodDecorator<SecureMetricAction<T>>;
+/**
+ * Options for '@secureMetrics' decorator.
+ * @category Platform
+ */
+export interface SecureMetricOptions<T extends MetricActionType> {
+    /** The name prefix of the metric to secure. */
+    metricNamePrefix?: string;
+    /** The type of action to secure. */
+    type: T;
+}
+/**
+ * Decorator that marks a function for securing an API or an endpoint inside an API.
+ * The decorator takes the API integration ID, and an optional endpoint ID.
+ * If no endpoint ID is provided, the function will secure the whole API.
+ *
+ * The function should return a boolean or a `Promise` of a boolean indicating
+ * whether the action is allowed.
+ * The function takes a context object as a parameter. The context object contains information about the action.
+ *
+ * To read more about securing an API, see the
+ * {@link https://docs.getsquid.ai/docs/security/security-rules/secure-api documentation}.
+ * @param integrationId The ID of the integration to secure.
+ * @param endpointId The ID of the endpoint to secure.
+ * @category Decorator
+ */
+export declare function secureApi(integrationId: IntegrationId, endpointId?: ApiEndpointId): ActionMethodDecorator<SecureApiAction>;
+/**
+ * Decorator that marks a function for securing a GraphQL integration.
+ *
+ * The function should return a boolean or a `Promise` of a boolean indicating
+ * whether the action is allowed.
+ * The function takes a context object as a parameter. The context object contains information about the action.
+ *
+ * To read more about securing a GraphQL integration, see the
+ * {@link https://docs.getsquid.ai/docs/security/security-rules/secure-graphql/ documentation}.
+ * @param integrationId
+ * @category Decorator
+ */
+export declare function secureGraphQL(integrationId: IntegrationId): ActionMethodDecorator<SecureGraphQLAction>;
+/**
+ * Decorator marking a function as executable, making it accessible via the Squid SDK.
+ *
+ * Functions decorated with `@executable`:
+ * - May accept and return parameters serializable to JSON.
+ * - Automatically handle files or arrays of files from the client, receiving them as SquidFile objects.
+ *
+ * Once exposed, the decorated function can be executed using Squid's `executeFunction` method.
+ *
+ * For detailed guidance on executable functions, see:
+ * {@link https://docs.getsquid.ai/docs/sdk/backend-sdk/executables documentation}
+ * @category Decorator
+ */
+export declare function executable(): ActionMethodDecorator<ExecutableAction>;
+/**
+ * Options for the `@aiFunction` annotation.
+ * @category AI
+ */
+export interface AiFunctionMetadataOptions {
+    /**
+     *  Unique AI function ID. If not set, the function name (excluding the class name) is used as the default ID.
+     *  If not provided the ID of the function is constructed as 'ClassName:FunctionName'.
+     */
+    id?: AiFunctionId;
+    /** Describes the capabilities of the function. This is used by the AI agent to determine when to call it. */
+    description: string;
+    /** Parameters for the AI function. These parameters are passed to the function by the calling agent. */
+    params: Array<AiFunctionParam>;
+    /** Additional optional attributes for the function. Example: related integrations. */
+    attributes?: AiFunctionAttributes;
+    /**
+     * The categories this function is associated with.
+     *
+     * Can be many or none. If no categories are specified, then the function is lumped into a default category.
+     *
+     * The Studio will group the functions into the categories for easier discovery.
+     *
+     * If multiple categories are given, the function will appear once in each category section in the Studio.
+     */
+    categories?: string[];
+    /** Mark the function as internal-only. Hides the function from appearing in the Studio. */
+    internal?: boolean;
+}
+/**
+ * Options for the `@mcpTool` annotation.
+ * @category AI
+ */
+export interface McpToolMetadataOptions {
+    /** Describes the capabilities of the function. This is used by the AI agent to determine when to call it. */
+    description: string;
+    /** Parameters for the MCP Tool. */
+    inputSchema: JSONSchema;
+    /** (Optional) The tool output schema. */
+    outputSchema?: JSONSchema;
+}
+/**
+ * Decorator that marks a function for exposing it to the AI assistant.
+ * The function accepts a JSON object as described in the description of the function in the annotation.
+ *
+ * To read more about exposing an executable, see the
+ * {@link https://docs.getsquid.ai/docs/sdk/backend-sdk/ai/ai-functions documentation}.
+ * @category AI
+ * @category Decorator
+ */
+export declare function aiFunction<ParamType extends Record<string, any> = any>(description: string, params: Array<AiFunctionParam>, attributes?: AiFunctionAttributes, categories?: Array<string>, internal?: boolean): ActionMethodDecorator<AiFunctionAction<ParamType>>;
+/**
+ * Decorator that marks a function for exposing it to the AI assistant.
+ * The function accepts a JSON object as described in the description of the function in the annotation.
+ *
+ * To read more about exposing an executable, see the
+ * {@link https://docs.getsquid.ai/docs/sdk/backend-sdk/ai/ai-functions documentation}.
+ * @category AI
+ * @category Decorator
+ */
+export declare function aiFunction<ParamType extends Record<string, any> = any>(options: AiFunctionMetadataOptions): ActionMethodDecorator<AiFunctionAction<ParamType>>;
+/**
+ * Options for the `@aiFunctionsConfigurator` annotation.
+ * @category AI
+ */
+export interface AiFunctionsConfiguratorMetadataOptions {
+    /**
+     *  Unique AI function configurator ID.
+     *  If not set, the function name (excluding the class name) is used as the default ID.
+     *  If not provided the ID of the function is constructed as 'ClassName:FunctionName'.
+     */
+    id?: AiFunctionId;
+    /**
+     * Integration types this configurator should be called for to compute effective AI function overrides.
+     */
+    integrationTypes: Array<IntegrationType>;
+}
+/**
+ * A type defining an AI functions configurator action.
+ * @category AI
+ */
+export type AiFunctionsConfiguratorAction = (req: AiFunctionsConfiguratorRequest) => AiFunctionsConfiguratorResponse;
+/**
+ * Decorator that marks a function as a configurator for AI functions used for connected integrations.
+ * The configurator function accepts connected integration options and returns AI functions overrides.
+ * The configurator function is called only for connected integrations with non-default connection options.
+ * @category AI
+ * @category Decorator
+ */
+export declare function aiFunctionsConfigurator(options: AiFunctionsConfiguratorMetadataOptions): ActionMethodDecorator<AiFunctionsConfiguratorAction>;
+/**
+ * Options for the `@trigger` annotation.
+ * @category Platform
+ */
+export interface TriggerOptions {
+    /**
+     * The ID of the trigger. Should be unique.
+     * If not used `ClassName.FunctionName` is used as an ID.
+     */
+    id?: string;
+    /** Name of the collection to trigger on. */
+    collection: string;
+    /** The ID of the integration to trigger on. If not provided, the `built_in_db` integration is used. */
+    integrationId?: string;
+    /**
+     * Types of mutations processed by the function annotated as `@trigger`.
+     * If not defined the function is called for all kinds of mutations.
+     */
+    mutationTypes?: Array<MutationType>;
+}
+/**
+ * Decorator that marks a function as a trigger to a change in a collection. The function will be called each time a
+ * change is made to the collection.
+ * The function accepts a context object as a parameter. The context object contains information about the change.
+ *
+ * To read more about triggers, see the
+ * {@link https://docs.getsquid.ai/docs/sdk/backend-sdk/triggers documentation}.
+ *
+ * @param id The ID of the trigger. Should be unique.
+ * @param collectionName The name of the collection to trigger on.
+ * @param integrationId The ID of the integration to trigger on. If not provided, the `built_in_db` integration is
+ *   used.
+ * @category Decorator
+ */
+export declare function trigger(id: TriggerId, collectionName: CollectionName, integrationId?: IntegrationId): ActionMethodDecorator<TriggerAction>;
+/**
+ * Decorator that marks a function as a trigger to a change in a collection. The function will be called each time a
+ * change is made to the collection.
+ * The function accepts a context object as a parameter. The context object contains information about the change.
+ *
+ * To read more about triggers, see the
+ * {@link https://docs.getsquid.ai/docs/sdk/backend-sdk/triggers documentation}.
+ * @category Decorator
+ */
+export declare function trigger(options: TriggerOptions): ActionMethodDecorator<TriggerAction>;
+/**
+ * Options for the `@scheduler` annotation.
+ * @category Platform
+ */
+export interface SchedulerOptions {
+    /** The cron expression (in UTC) to schedule the function on. */
+    cron: CronExpression | CronExpressionString;
+    /**
+     * The ID of the scheduler. Must be unique.
+     * If not provided the ID of the scheduler is constructed as 'ClassName:FunctionName'.
+     */
+    id?: SchedulerId;
+    /**
+     * Whether the scheduler should be exclusive.
+     * If set to true, the scheduler will not trigger if the previous scheduler is still running.
+     * Default: true.
+     */
+    exclusive?: boolean;
+}
+/**
+ * Decorator that marks a function as a scheduler. The function will be called according to the provided cron
+ * expression.
+ *
+ * To read more about schedulers, see the
+ * {@link https://docs.getsquid.ai/docs/sdk/backend-sdk/schedulers documentation}.
+ *
+ * @param id The ID of the scheduler. Should be unique.
+ * @param cronExpression The cron expression (in UTC) to schedule the function on.
+ * @param exclusive Whether the scheduler should be exclusive. If set to true, the scheduler will not trigger if the
+ *   previous scheduler is still running. Default: true.
+ * @category Decorator
+ */
+export declare function scheduler(id: SchedulerId, cronExpression: CronExpression | CronExpressionString, exclusive?: boolean): ActionMethodDecorator<SchedulerAction>;
+/**
+ * Decorator that marks a function as a scheduler.
+ * The function will be called according to the provided cron expression.
+ *
+ * To read more about schedulers, see the
+ * {@link https://docs.getsquid.ai/docs/sdk/backend-sdk/schedulers documentation}.
+ * @category Decorator
+ */
+export declare function scheduler(options: SchedulerOptions): ActionMethodDecorator<SchedulerAction>;
+/**
+ * Decorator that marks a function as a webhook. The function will be called when a webhook is triggered.
+ * Once the webhook is created, it will be exposed as a URL with the provided webhook ID with this format:
+ * `https://<your app ID>.<app region>.squid.cloud/webhooks/<webhook-id>`.
+ *
+ * The function accepts a context object as a parameter. The context object contains information about the webhook.
+ * The function can return any value that can be serialized to JSON or a `WebhookResponse` object that can be created
+ * using:
+ * `this.createWebhookResponse(<params>)`.
+ *
+ * To read more about webhooks, see the
+ * {@link https://docs.getsquid.ai/docs/sdk/backend-sdk/webhooks documentation}.
+ * @param id The ID of the webhook. Should be unique.
+ * @category Decorator
+ */
+export declare function webhook(id: WebhookId): ActionMethodDecorator<WebhookAction>;
+/**
+ * A decorator that can be used to secure a native query. Native queries are not secured by default and must be
+ * explicitly secured using this decorator. The decorated function must return a boolean or a `Promise` of a boolean
+ * that indicates whether the query can be executed or not.
+ *
+ * The function accepts a context object as a parameter. The context object contains information about the query.
+ *
+ * To read more about securing a Native Query, see the
+ * {@link https://docs.getsquid.ai/docs/security/security-rules/secure-data-access#securing-native-queries
+ * documentation}.
+ *
+ * @param integrationId The database integration ID.
+ * @returns A decorator function that can be used to secure a native query.
+ * @category Database
+ * @category Decorator
+ */
+export declare function secureNativeQuery(integrationId: IntegrationId): ActionMethodDecorator<SecureNativeQueryAction>;
+/**
+ * A decorator that can be used to secure a distributed lock. Distributed locks are secured by default and can be
+ * invoked only if the decorated function allows it. The function returns a boolean or a `Promise` of a boolean that
+ * indicates whether the lock can be acquired or not.
+ *
+ * The function accepts a context object as a parameter. The context object contains information about the mutex and
+ * the request.
+ *
+ * @param mutex The mutex to lock on. If none provided, the rule will apply for all mutexes.
+ * @category Decorator
+ */
+export declare function secureDistributedLock(mutex?: string): ActionMethodDecorator<SecureDistributedLockAction>;
+/**
+ * A decorator that can be used to secure an AI agent.
+ *
+ * The function should return a boolean or a `Promise` of a boolean indicating
+ * whether the action is allowed.
+ * The function takes a context object as a parameter. The context object contains information about the action.
+ *
+ * To read more about securing an AI agent, see the
+ * {@link https://docs.getsquid.ai/docs/security/security-rules/secure-ai-agents documentation}.
+ *
+ @param agentId The ID of the agent to secure - if not provided, this will apply to all agents.
+ @category AI
+ @category Decorator
+ */
+export declare function secureAiAgent(agentId?: string): ActionMethodDecorator<SecureAiAgentAction>;
+/**
+ * A decorator that can be used to rate/quota limit a function. In its simplest form, the decorator
+ * can take the query rate that is allowed for the given function and/or how many total calls are
+ * permitted and will enforce those limits.
+ *
+ * It will either execute the function or return an Error if the rate/quota limits are exceeded.
+ *
+ * Rate Limit behavior:
+ * - The rate limit unit is QPS (Queries Per Second).
+ * - Bursts of up to 3x the given rate are permitted.
+ * - The consumption bucket refills gradually.
+ *
+ * Quota Limit behavior:
+ * - Has a `renewPeriod` field that defaults to "monthly".
+ * - The "monthly" period is defined as 30 days.
+ * - The "quarterly" period is defined as 90 days.
+ * - Renews occur at the top of the hour (##:00 for HH:mm).
+ * - No carry-over of unused quota from one period to the next.
+ * - Changes to the limit value for a specific limit combo (function & scope & renewPeriod) will
+ *   reset the active count. For example, if a user has made 10 calls and the limit is changed from
+ *   20 to 15, the user will be able to make 15 more calls (not 5).
+ *
+ * Limits can be defined with more specifics and multiple limits can be
+ * defined for a single function.
+ *
+ * Examples:
+ * - Basic definition using defaults:
+ *   ```
+ *   @limits({ rateLimit: 5 }) // Only rate limit.
+ *   @limits({ quotaLimit: 20 }) // Only quota limit.
+ *   @limits({ rateLimit: 5, quotaLimit: 20 }) // Both rate and quota.
+ *   ```
+ *   Defaults to "global" scope and "monthly" renewPeriod.
+ * - As objects defining scope and renewPeriod:
+ *   ```
+ *   @limits({
+ *     rateLimit: {
+ *       value: 5,
+ *       scope: 'global'
+ *     },
+ *     quotaLimit: {
+ *       value: 20,
+ *       scope: 'global',
+ *       renewPeriod: 'monthly'
+ *     }
+ *   })
+ *   ```
+ * - As arrays of objects defining scope and renewPeriod
+ *   ```
+ *   @limits({
+ *     rateLimit: [
+ *       { value: 5, scope: 'global' },
+ *       { value: 2, scope: 'user' }
+ *     ],
+ *     quotaLimit: [
+ *       { value: 20, scope: 'global', renewPeriod: 'monthly' },
+ *       { value: 5000, scope: 'ip', renewPeriod: 'annually' }
+ *     ]
+ *   })
+ *   ```
+ *
+ * All matching limits are consumed for each call. For example, an "IP" scoped limit will be
+ * consumed in addition to a "global" scoped limit.
+ *
+ * @param options LimiterConfig object specifying what kind of limits are desired.
+ * @category Decorator
+ */
+export declare function limits(options: LimiterConfig): ActionMethodDecorator<LimitsAction>;
+/**
+ * Decorator‐factory that takes service options and returns a ClassDecorator.
+ * @category Decorator
+ */
+export declare function llmService(opts: LlmServiceOptions): ClassDecorator;
+/**
+ * A decorator to mark a function to call to ask an LLM for a response.
+ * @category Decorator
+ */
+export declare function llmAsk(): ActionMethodDecorator<LlmAskAction>;
+/**
+ * Decorator that marks a class as an MCP server.
+ * @category Decorator
+ */
+export declare function mcpServer(opts: McpServerOptions): ClassDecorator;
+/**
+ * A decorator to mark a function as a tool that can be used by the MCP .
+ * @param options Options for the MCP tool.
+ * @category Decorator
+ */
+export declare function mcpTool(options: McpToolMetadataOptions): ActionMethodDecorator<McpToolAction>;
+/**
+ * A decorator to mark a function as authorized request handler for the MCP.
+ * @category Decorator
+ */
+export declare function mcpAuthorizer(): ActionMethodDecorator<McpAuthorizerAction>;
+/**
+ * Decorator that marks a function for handling a client connection state change.
+ * @category Platform
+ */
+export declare function clientConnectionStateHandler(): ActionMethodDecorator<ClientConnectionStateChangeAction>;