@squidcloud/backend 1.0.338 → 1.0.339

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

@@ -1,5 +1,7 @@
-import { AiFunctionAttributes, AiFunctionParam, ApiEndpointId, CollectionName, CronExpression, CronExpressionString, DatabaseActionType, IntegrationId, MetricActionType, MutationType, SchedulerId, StorageActionType, TopicActionType, TopicName, TriggerId, WebhookId } from '@squidcloud/client';
-import { ActionMethodDecorator, AiFunctionAction, ClientConnectionStateChangeAction, ExecutableAction, LimitedAction, LimiterConfig, LimiterOptions, SchedulerAction, SecureAiAgentAction, SecureApiAction, SecureDatabaseAction, SecureDistributedLockAction, SecureGraphQLAction, SecureMetricAction, SecureNativeQueryAction, SecureStorageAction, SecureTopicAction, TriggerAction, WebhookAction } from '../../internal-common/src/public-types-backend/bundle-api.public-types';
+import { ApiEndpointId, CollectionName, IntegrationId, TopicName } from '@squidcloud/client';
+import { ActionMethodDecorator, AiFunctionAction, ClientConnectionStateChangeAction, ExecutableAction, LimitsAction, LimiterConfig, SchedulerAction, SecureAiAgentAction, SecureApiAction, SecureDatabaseAction, SecureDistributedLockAction, SecureGraphQLAction, SecureMetricAction, SecureNativeQueryAction, SecureStorageAction, SecureTopicAction, TriggerAction, WebhookAction } from '../../internal-common/src/public-types-backend/bundle-api.public-types';
+import { CronExpression, CronExpressionString, MutationType, SchedulerId, TriggerId, WebhookId } from './public-types';
+import { AiFunctionAttributes, AiFunctionParam, DatabaseActionType, MetricActionType, StorageActionType, TopicActionType } from '../../internal-common/src/public-types-backend/bundle-data.public-types';
 /**
  * Decorator that marks a function for securing a database.
  * The decorator takes a type of action and an optional integration ID.
@@ -14,6 +16,8 @@ import { ActionMethodDecorator, AiFunctionAction, ClientConnectionStateChangeAct
  * {@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>>;
 /**
@@ -31,9 +35,15 @@ export declare function secureDatabase<T extends DatabaseActionType>(type: T, in
  * @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. */
+/**
+ * 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.
@@ -48,6 +58,8 @@ export declare function secureStorage<T extends StorageActionType>(type: T, inte
  * @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>>;
 /**
@@ -56,15 +68,17 @@ export declare function secureTopic<T extends TopicActionType>(topicName: TopicN
  *
  * 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.
- * @param metricNamePrefix The name prefix of the metric to secure.
- * @param type The type of action to secure.
+ * 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;
 }
 /**
@@ -80,6 +94,7 @@ export interface SecureMetricOptions<T extends MetricActionType> {
  * {@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>;
 /**
@@ -92,6 +107,7 @@ export declare function secureApi(integrationId: IntegrationId, endpointId?: Api
  * 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>;
 /**
@@ -105,12 +121,19 @@ export declare function secureGraphQL(integrationId: IntegrationId): ActionMetho
  *
  * For detailed guidance on executable functions, see:
  * {@link https://docs.getsquid.ai/docs/backend/executables/ documentation}
+ * @category Decorator
  */
 export declare function executable(): ActionMethodDecorator<ExecutableAction>;
-/** Options for the `@aiFunction` annotation. */
+/**
+ * Options for the `@aiFunction` annotation.
+ * @category AI
+ */
 export interface AiFunctionOptions {
+    /** 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;
 }
 /**
@@ -119,6 +142,8 @@ export interface AiFunctionOptions {
  *
  * To read more about exposing an executable, see the
  * {@link https://docs.getsquid.ai/docs/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): ActionMethodDecorator<AiFunctionAction<ParamType>>;
 /**
@@ -127,9 +152,14 @@ export declare function aiFunction<ParamType extends Record<string, any> = any>(
  *
  * To read more about exposing an executable, see the
  * {@link https://docs.getsquid.ai/docs/ai/ai-functions/ documentation}.
+ * @category AI
+ * @category Decorator
  */
 export declare function aiFunction<ParamType extends Record<string, any> = any>(options: AiFunctionOptions): ActionMethodDecorator<AiFunctionAction<ParamType>>;
-/** Options for the `@trigger` annotation. */
+/**
+ * Options for the `@trigger` annotation.
+ * @category Platform
+ */
 export interface TriggerOptions {
     /**
      * The ID of the trigger. Should be unique.
@@ -158,6 +188,7 @@ export interface TriggerOptions {
  * @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>;
 /**
@@ -167,9 +198,13 @@ export declare function trigger(id: TriggerId, collectionName: CollectionName, i
  *
  * To read more about triggers, see the
  * {@link https://docs.getsquid.ai/docs/backend/triggers/ documentation}.
+ * @category Decorator
  */
 export declare function trigger(options: TriggerOptions): ActionMethodDecorator<TriggerAction>;
-/** Options for the `@scheduler` annotation. */
+/**
+ * Options for the `@scheduler` annotation.
+ * @category Platform
+ */
 export interface SchedulerOptions {
     /** The cron expression (in UTC) to schedule the function on. */
     cron: CronExpression | CronExpressionString;
@@ -196,6 +231,7 @@ export interface SchedulerOptions {
  * @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>;
 /**
@@ -204,6 +240,7 @@ export declare function scheduler(id: SchedulerId, cronExpression: CronExpressio
  *
  * To read more about schedulers, see the
  * {@link https://docs.getsquid.ai/docs/backend/schedulers/ documentation}.
+ * @category Decorator
  */
 export declare function scheduler(options: SchedulerOptions): ActionMethodDecorator<SchedulerAction>;
 /**
@@ -219,6 +256,7 @@ export declare function scheduler(options: SchedulerOptions): ActionMethodDecora
  * To read more about webhooks, see the
  * {@link https://docs.getsquid.ai/docs/backend/webhooks/ documentation}.
  * @param id The ID of the webhook. Should be unique.
+ * @category Decorator
  */
 export declare function webhook(id: WebhookId): ActionMethodDecorator<WebhookAction>;
 /**
@@ -234,6 +272,8 @@ export declare function webhook(id: WebhookId): ActionMethodDecorator<WebhookAct
  *
  * @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>;
 /**
@@ -245,6 +285,7 @@ export declare function secureNativeQuery(integrationId: IntegrationId): ActionM
  * 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>;
 /**
@@ -258,6 +299,8 @@ export declare function secureDistributedLock(mutex?: string): ActionMethodDecor
  * {@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>;
 /**
@@ -325,15 +368,11 @@ export declare function secureAiAgent(agentId?: string): ActionMethodDecorator<S
  * 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<LimitedAction>;
-/** Decorator that marks a function for handling a client connection state change */
-export declare function clientConnectionStateHandler(): ActionMethodDecorator<ClientConnectionStateChangeAction>;
+export declare function limits(options: LimiterConfig): ActionMethodDecorator<LimitsAction>;
 /**
- * Convert LimiterConfig to LimiterOptions.
- *
- * This decouples the required syntax for the developer from the internal implementation.
- *
- * @param config LimiterConfig to convert.
+ * Decorator that marks a function for handling a client connection state change.
+ * @category Platform
  */
-export declare function limiterConfigToOptions(config: LimiterConfig): LimiterOptions;
+export declare function clientConnectionStateHandler(): ActionMethodDecorator<ClientConnectionStateChangeAction>;

package/dist/backend/src/public-types.d.ts

@@ -1,5 +1,6 @@
-export * from '../../internal-common/src/public-types-backend/ai-chatbot.public-context';
+export * from '../../internal-common/src/public-types-backend/ai-agent.public-context';
 export * from '../../internal-common/src/public-types-backend/api-call.public-context';
+export * from '../../internal-common/src/public-types-backend/application.public-types';
 export * from '../../internal-common/src/public-types-backend/bundle-api.public-types';
 export * from '../../internal-common/src/public-types-backend/distributed-lock.public-context';
 export * from '../../internal-common/src/public-types-backend/graphql.public-context';