@squidcloud/backend 1.0.147 → 1.0.149

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

@@ -1,193 +1,166 @@
-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 { ActionMethodDecorator, AiChatbotActionType, AiFunctionAction, AiFunctionParam, ApiEndpointId, ClientConnectionStateChangeAction, CollectionName, CronExpression, CronExpressionString, DatabaseActionType, ExecutableAction, IntegrationId, SchedulerAction, SchedulerId, SecureAiChatbotAction, SecureApiAction, SecureDatabaseAction, SecureDistributedLockAction, SecureGraphQLAction, 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 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>;

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

@@ -1,3 +1,3 @@
-export * from './actions';
-export * from './project';
-export * from './service';
+export * from './actions';
+export * from './project';
+export * from './service';