@squidcloud/backend 1.0.111 → 1.0.112

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

@@ -1,170 +1,170 @@
-import { ActionMethodDecorator, AiAssistantActionType, ApiEndpointId, ClientConnectionStateChangeAction, CollectionName, CronExpression, CronExpressionString, DatabaseActionType, ExecutableAction, IntegrationId, QueryName, SchedulerAction, SchedulerId, SecureAiAssistantAction, SecureApiAction, SecureDatabaseAction, SecureDistributedLockAction, SecureGraphQLAction, SecureNamedQueryAction, 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 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 GraphQL integration, 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 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 Assistant. The decorator takes the AI Assistant
- * 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-assistant 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 secureAiAssistant<T extends AiAssistantActionType>(integrationId: IntegrationId, type: T, profileId?: string): ActionMethodDecorator<SecureAiAssistantAction<T>>;
-/** Decorator that marks a function for handling a client connection state change */
-export declare function clientConnectionStateHandler(): ActionMethodDecorator<ClientConnectionStateChangeAction>;
+import { ActionMethodDecorator, AiAssistantActionType, ApiEndpointId, ClientConnectionStateChangeAction, CollectionName, CronExpression, CronExpressionString, DatabaseActionType, ExecutableAction, IntegrationId, QueryName, SchedulerAction, SchedulerId, SecureAiAssistantAction, SecureApiAction, SecureDatabaseAction, SecureDistributedLockAction, SecureGraphQLAction, SecureNamedQueryAction, 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 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 GraphQL integration, 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 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 Assistant. The decorator takes the AI Assistant
+ * 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-assistant 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 secureAiAssistant<T extends AiAssistantActionType>(integrationId: IntegrationId, type: T, profileId?: string): ActionMethodDecorator<SecureAiAssistantAction<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';

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

@@ -1,256 +1,256 @@
-import { AiAssistantActionType, ApiEndpointId, ApplicationBundleData, CollectionName, DatabaseActionType, IntegrationId, QueryName, SchedulerId, ServiceFunctionName, TriggerId, WebhookId } from '@squidcloud/common';
-declare class Meta {
-    data: ApplicationBundleData;
-    /**
-     * @secureDatabase("read", "ExampleIntegration")
-     *
-     * Applying the decorator above to the myMethod method on the MyService
-     * class will generate the following metadata:
-     *
-     * data: {
-     *   databases: {
-     *     ExampleIntegration: {
-     *       security: {
-     *         read: ['MyService:myMethod']
-     *       }
-     *     }
-     *   }
-     * }
-     */
-    secureDatabase(type: DatabaseActionType, serviceFunction: ServiceFunctionName, integrationId?: IntegrationId): void;
-    /**
-     * @secureCollection("ExampleCollection", "read", "ExampleIntegration")
-     *
-     * Applying the decorator above to the myMethod method on the MyService
-     * class will generate the following metadata:
-     *
-     * data: {
-     *   databases: {
-     *     ExampleIntegration: {
-     *       collections: {
-     *         ExampleCollection: {
-     *           security: {
-     *             read: ['MyService:myMethod']
-     *           }
-     *         }
-     *       }
-     *     }
-     *   }
-     * }
-     */
-    secureCollection(collectionName: CollectionName, type: DatabaseActionType, serviceFunction: ServiceFunctionName, integrationId?: IntegrationId): void;
-    /**
-     * @secureApi("ExampleIntegration", "myEndpoint")
-     *
-     * Applying the decorator above to the myMethod method on the MyService
-     * class will generate the following metadata:
-     *
-     * data: {
-     *   apis: {
-     *     ExampleIntegration: {
-     *       myEndpoint: {
-     *         security: ['MyService:myMethod']
-     *       }
-     *     }
-     *   }
-     * }
-     */
-    secureApi(integrationId: IntegrationId, endpointId: ApiEndpointId | undefined, serviceFunction: ServiceFunctionName): void;
-    /**
-     * @secureGraphQL("ExampleIntegration")
-     *
-     * Applying the decorator above to the myMethod method on the MyService
-     * class will generate the following metadata:
-     *
-     * data: {
-     *   graphql: {
-     *     ExampleIntegration: {
-     *       security: ['MyService:myMethod']
-     *     }
-     *   }
-     * }
-     */
-    secureGraphQL(integrationId: IntegrationId, serviceFunction: ServiceFunctionName): void;
-    /**
-     * @transformDatabase(""read", "ExampleIntegration")
-     *
-     * Applying the decorator above to the myMethod method on the MyService
-     * class will generate the following metadata:
-     *
-     * data: {
-     *   databases: {
-     *     ExampleIntegration: {
-     *       transform: {
-     *         read: {
-     *           type: "read"
-     *           functionName: "MyService:myMethod"
-     *         }
-     *       }
-     *     }
-     *   }
-     * }
-     */
-    transformDatabase(type: DatabaseActionType, serviceFunction: ServiceFunctionName, integrationId?: IntegrationId): void;
-    /**
-     * @transformCollection("ExampleCollection", "read", "ExampleIntegration")
-     *
-     * Applying the decorator above to the myMethod method on the MyService
-     * class will generate the following metadata:
-     *
-     * data: {
-     *   databases: {
-     *     ExampleIntegration: {
-     *       collections: {
-     *         ExampleCollection: {
-     *           transform: {
-     *             read: {
-     *               type: "read"
-     *               functionName: "MyService:myMethod"
-     *             }
-     *           }
-     *         }
-     *       }
-     *     }
-     *   }
-     * }
-     */
-    transformCollection(collectionName: CollectionName, type: DatabaseActionType, serviceFunction: ServiceFunctionName, integrationId?: IntegrationId): void;
-    /**
-     * @executable()
-     *
-     * Applying the decorator above to the myMethod method on the MyService
-     * class will generate the following metadata:
-     *
-     * data: {
-     *   executables: {
-     *     myExecutable: {
-     *       serviceName: "MyService:myMethod",
-     *     }
-     *   }
-     * }
-     */
-    executable(serviceFunction: ServiceFunctionName): void;
-    /**
-     * @trigger("my-trigger", "ExampleCollection", "ExampleIntegration")
-     *
-     * Applying the decorator above to the myMethod method on the MyService
-     * class will generate the following metadata:
-     *
-     * data: {
-     *   triggers: {
-     *     "my-trigger": {
-     *       integrationId: "ExampleIntegration"
-     *       collectionName: "ExampleCollection"
-     *       functionName: "MyService:myMethod",
-     *     }
-     *   }
-     * }
-     */
-    trigger(id: TriggerId, collectionName: CollectionName, serviceFunction: ServiceFunctionName, integrationId?: IntegrationId): void;
-    /**
-     * @scheduler("my-scheduler", "CronExpression", true)
-     *
-     * Applying the decorator above to the myMethod method on the MyService
-     * class will generate the following metadata:
-     *
-     * data: {
-     *   schedulers: {
-     *     "my-scheduler", {
-     *       cronExpression: "CronExpression"
-     *       functionName: "MyService:myMethod",
-     *     }
-     *   }
-     * }
-     */
-    scheduler(id: SchedulerId, cronExpression: string, serviceFunction: ServiceFunctionName, exclusive: boolean): void;
-    /**
-     * @webhook("my-webhook")
-     *
-     * Applying the decorator above to the myMethod method on the MyService
-     * class will generate the following metadata:
-     *
-     * data: {
-     *   webhooks: {
-     *     "my-webhook", {
-     *       functionName: "MyService:myMethod",
-     *     }
-     *   }
-     * }
-     */
-    webhook(id: WebhookId, serviceFunction: ServiceFunctionName): void;
-    /**
-     * @namedQuery('exampleIntegration', 'my-query')
-     * static  myQuery = "select * from my-table where id = ${id}";
-     *
-     * Applying the decorator above to the myQuery static string in MyService
-     * class will generate the following metadata:
-     *
-     *
-     *
-     * data: {
-     *   namedQueries: {
-     *     "exampleIntegration", {
-     *       my-query: {
-     *         queryString: "select * from my-table where id = $id"
-     *       }
-     *     }
-     *   }
-     * }
-     */
-    namedQuery(integrationId: IntegrationId, name: QueryName, queryString: string): void;
-    /**
-     * @secureNamedQuery("exampleIntegration", "queryName")
-     *
-     * Applying the decorator above to the myMethod method on the MyService
-     * class will generate the following metadata:
-     *
-     * data: {
-     *   namedQueries: {
-     *     exampleIntegration: {
-     *       queryName: {
-     *         security: MyService:myMethod
-     *       }
-     *     }
-     *   }
-     * }
-     */
-    secureNamedQuery(integrationId: IntegrationId, name: QueryName, serviceFunction: ServiceFunctionName): void;
-    /**
-     * @secureDistributedLock("mutex", true)
-     *
-     * Applying the decorator above to the myMethod method on the MyService
-     * class will generate the following metadata:
-     *
-     * data: {
-     *   distributedLocks: {
-     *     security: [MyService:myMethod]
-     *   }
-     * }
-     */
-    secureDistributedLock(mutex: string | undefined, serviceFunction: ServiceFunctionName): void;
-    /**
-     * @secureAiAssistant(ExampleIntegration, "chat", myProfile)
-     *
-     * Applying the decorator above to the myMethod method on the MyService
-     * class will generate the following metadata:
-     *
-     * data: {
-     *   aiAssistants: {
-     *     ExampleIntegration: {
-     *       myProfile: {
-     *         security: {
-     *           chat: ['MyService:myMethod']
-     *         }
-     *       }
-     *     }
-     *   }
-     * }
-     */
-    secureAiAssistant(type: AiAssistantActionType, integrationId: IntegrationId, profileId: string | undefined, serviceFunction: ServiceFunctionName): void;
-    clientConnectionChangeHandler(serviceFunction: ServiceFunctionName): void;
-}
-/**
- * @internal
- */
-export declare const metadata: Meta;
-export {};
+import { AiAssistantActionType, ApiEndpointId, ApplicationBundleData, CollectionName, DatabaseActionType, IntegrationId, QueryName, SchedulerId, ServiceFunctionName, TriggerId, WebhookId } from '@squidcloud/common';
+declare class Meta {
+    data: ApplicationBundleData;
+    /**
+     * @secureDatabase("read", "ExampleIntegration")
+     *
+     * Applying the decorator above to the myMethod method on the MyService
+     * class will generate the following metadata:
+     *
+     * data: {
+     *   databases: {
+     *     ExampleIntegration: {
+     *       security: {
+     *         read: ['MyService:myMethod']
+     *       }
+     *     }
+     *   }
+     * }
+     */
+    secureDatabase(type: DatabaseActionType, serviceFunction: ServiceFunctionName, integrationId?: IntegrationId): void;
+    /**
+     * @secureCollection("ExampleCollection", "read", "ExampleIntegration")
+     *
+     * Applying the decorator above to the myMethod method on the MyService
+     * class will generate the following metadata:
+     *
+     * data: {
+     *   databases: {
+     *     ExampleIntegration: {
+     *       collections: {
+     *         ExampleCollection: {
+     *           security: {
+     *             read: ['MyService:myMethod']
+     *           }
+     *         }
+     *       }
+     *     }
+     *   }
+     * }
+     */
+    secureCollection(collectionName: CollectionName, type: DatabaseActionType, serviceFunction: ServiceFunctionName, integrationId?: IntegrationId): void;
+    /**
+     * @secureApi("ExampleIntegration", "myEndpoint")
+     *
+     * Applying the decorator above to the myMethod method on the MyService
+     * class will generate the following metadata:
+     *
+     * data: {
+     *   apis: {
+     *     ExampleIntegration: {
+     *       myEndpoint: {
+     *         security: ['MyService:myMethod']
+     *       }
+     *     }
+     *   }
+     * }
+     */
+    secureApi(integrationId: IntegrationId, endpointId: ApiEndpointId | undefined, serviceFunction: ServiceFunctionName): void;
+    /**
+     * @secureGraphQL("ExampleIntegration")
+     *
+     * Applying the decorator above to the myMethod method on the MyService
+     * class will generate the following metadata:
+     *
+     * data: {
+     *   graphql: {
+     *     ExampleIntegration: {
+     *       security: ['MyService:myMethod']
+     *     }
+     *   }
+     * }
+     */
+    secureGraphQL(integrationId: IntegrationId, serviceFunction: ServiceFunctionName): void;
+    /**
+     * @transformDatabase(""read", "ExampleIntegration")
+     *
+     * Applying the decorator above to the myMethod method on the MyService
+     * class will generate the following metadata:
+     *
+     * data: {
+     *   databases: {
+     *     ExampleIntegration: {
+     *       transform: {
+     *         read: {
+     *           type: "read"
+     *           functionName: "MyService:myMethod"
+     *         }
+     *       }
+     *     }
+     *   }
+     * }
+     */
+    transformDatabase(type: DatabaseActionType, serviceFunction: ServiceFunctionName, integrationId?: IntegrationId): void;
+    /**
+     * @transformCollection("ExampleCollection", "read", "ExampleIntegration")
+     *
+     * Applying the decorator above to the myMethod method on the MyService
+     * class will generate the following metadata:
+     *
+     * data: {
+     *   databases: {
+     *     ExampleIntegration: {
+     *       collections: {
+     *         ExampleCollection: {
+     *           transform: {
+     *             read: {
+     *               type: "read"
+     *               functionName: "MyService:myMethod"
+     *             }
+     *           }
+     *         }
+     *       }
+     *     }
+     *   }
+     * }
+     */
+    transformCollection(collectionName: CollectionName, type: DatabaseActionType, serviceFunction: ServiceFunctionName, integrationId?: IntegrationId): void;
+    /**
+     * @executable()
+     *
+     * Applying the decorator above to the myMethod method on the MyService
+     * class will generate the following metadata:
+     *
+     * data: {
+     *   executables: {
+     *     myExecutable: {
+     *       serviceName: "MyService:myMethod",
+     *     }
+     *   }
+     * }
+     */
+    executable(serviceFunction: ServiceFunctionName): void;
+    /**
+     * @trigger("my-trigger", "ExampleCollection", "ExampleIntegration")
+     *
+     * Applying the decorator above to the myMethod method on the MyService
+     * class will generate the following metadata:
+     *
+     * data: {
+     *   triggers: {
+     *     "my-trigger": {
+     *       integrationId: "ExampleIntegration"
+     *       collectionName: "ExampleCollection"
+     *       functionName: "MyService:myMethod",
+     *     }
+     *   }
+     * }
+     */
+    trigger(id: TriggerId, collectionName: CollectionName, serviceFunction: ServiceFunctionName, integrationId?: IntegrationId): void;
+    /**
+     * @scheduler("my-scheduler", "CronExpression", true)
+     *
+     * Applying the decorator above to the myMethod method on the MyService
+     * class will generate the following metadata:
+     *
+     * data: {
+     *   schedulers: {
+     *     "my-scheduler", {
+     *       cronExpression: "CronExpression"
+     *       functionName: "MyService:myMethod",
+     *     }
+     *   }
+     * }
+     */
+    scheduler(id: SchedulerId, cronExpression: string, serviceFunction: ServiceFunctionName, exclusive: boolean): void;
+    /**
+     * @webhook("my-webhook")
+     *
+     * Applying the decorator above to the myMethod method on the MyService
+     * class will generate the following metadata:
+     *
+     * data: {
+     *   webhooks: {
+     *     "my-webhook", {
+     *       functionName: "MyService:myMethod",
+     *     }
+     *   }
+     * }
+     */
+    webhook(id: WebhookId, serviceFunction: ServiceFunctionName): void;
+    /**
+     * @namedQuery('exampleIntegration', 'my-query')
+     * static  myQuery = "select * from my-table where id = ${id}";
+     *
+     * Applying the decorator above to the myQuery static string in MyService
+     * class will generate the following metadata:
+     *
+     *
+     *
+     * data: {
+     *   namedQueries: {
+     *     "exampleIntegration", {
+     *       my-query: {
+     *         queryString: "select * from my-table where id = $id"
+     *       }
+     *     }
+     *   }
+     * }
+     */
+    namedQuery(integrationId: IntegrationId, name: QueryName, queryString: string): void;
+    /**
+     * @secureNamedQuery("exampleIntegration", "queryName")
+     *
+     * Applying the decorator above to the myMethod method on the MyService
+     * class will generate the following metadata:
+     *
+     * data: {
+     *   namedQueries: {
+     *     exampleIntegration: {
+     *       queryName: {
+     *         security: MyService:myMethod
+     *       }
+     *     }
+     *   }
+     * }
+     */
+    secureNamedQuery(integrationId: IntegrationId, name: QueryName, serviceFunction: ServiceFunctionName): void;
+    /**
+     * @secureDistributedLock("mutex", true)
+     *
+     * Applying the decorator above to the myMethod method on the MyService
+     * class will generate the following metadata:
+     *
+     * data: {
+     *   distributedLocks: {
+     *     security: [MyService:myMethod]
+     *   }
+     * }
+     */
+    secureDistributedLock(mutex: string | undefined, serviceFunction: ServiceFunctionName): void;
+    /**
+     * @secureAiAssistant(ExampleIntegration, "chat", myProfile)
+     *
+     * Applying the decorator above to the myMethod method on the MyService
+     * class will generate the following metadata:
+     *
+     * data: {
+     *   aiAssistants: {
+     *     ExampleIntegration: {
+     *       myProfile: {
+     *         security: {
+     *           chat: ['MyService:myMethod']
+     *         }
+     *       }
+     *     }
+     *   }
+     * }
+     */
+    secureAiAssistant(type: AiAssistantActionType, integrationId: IntegrationId, profileId: string | undefined, serviceFunction: ServiceFunctionName): void;
+    clientConnectionChangeHandler(serviceFunction: ServiceFunctionName): void;
+}
+/**
+ * @internal
+ */
+export declare const metadata: Meta;
+export {};

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

@@ -1,7 +1,7 @@
-/**
- * The SquidProject class is the entry point for the Squid backend project.
- */
-export declare class SquidProject {
-    private metadata;
-    private cleanup;
-}
+/**
+ * The SquidProject class is the entry point for the Squid backend project.
+ */
+export declare class SquidProject {
+    private metadata;
+    private cleanup;
+}

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

@@ -1,83 +1,83 @@
-import { Squid } from '@squidcloud/client';
-import { AuthWithApiKey, AuthWithBearer, Logger, RunContext, SecretKey, SecretValue, ServiceConfig, SupportedSquidRegion, WebhookResponse } from '@squidcloud/common';
-/**
- * A base class for all the different types of Squid backend services. This class serves as a container
- * for the various methods implemented in the backend in order to customize the Squid backend for an application.
- */
-export declare class SquidService {
-    /** The list of your application's secrets as defined in the Squid Cloud Console. */
-    readonly secrets: Record<SecretKey, SecretValue>;
-    /**
-     * A logger instance for your application. If you connected one of the observability integrations, the logger will be
-     * reported to the observability service.
-     */
-    readonly logger: Logger;
-    private readonly backendApiKey;
-    /**
-     * The context object for the current request. This object contains information about the current request, such as
-     * the current user, the IP address, the user agent used, the request headers, and more.
-     */
-    readonly context: RunContext;
-    private readonly codeDir;
-    /**
-     * Your application's region. When developing locally, the region will be set to `local`.
-     */
-    readonly region: SupportedSquidRegion;
-    private readonly auth;
-    private readonly config;
-    /**
-     * @internal
-     */
-    constructor(config: ServiceConfig);
-    /**
-     * Returns the API key used by the backend for your application.
-     */
-    getApiKey(): string;
-    /**
-     * Returns the Squid client instance for your application.
-     *
-     * @returns the Squid client instance for your application.
-     */
-    get squid(): Squid;
-    /**
-     * Returns the assets directory for your application.
-     * To read more about the assets directory, see the [Squid
-     * documentation](https://docs.squid.cloud/docs/development-tools/backend/project-structure#assets-directory).
-     *
-     * @returns the assets directory for your application.
-     */
-    get assetsDirectory(): string;
-    /**
-     * Returns the auth object for the current request or undefined if unauthenticated or if using an API key.
-     *
-     * @returns The auth object for the current request or undefined if unauthenticated or if using an API key.
-     */
-    getUserAuth(): AuthWithBearer | undefined;
-    /**
-     * Returns the auth object for the current request or undefined if unauthenticated or if using a user token.
-     *
-     * @returns The auth object for the current request or undefined if unauthenticated or if using a user token.
-     */
-    getApiKeyAuth(): AuthWithApiKey | undefined;
-    /**
-     * Returns true if the current request is authenticated (using a user token or an API key).
-     *
-     * @returns true if the current request is authenticated (using a user token or an API key).
-     */
-    isAuthenticated(): boolean;
-    /**
-     * Asserts that the current request is authenticated (using a user token or an API key).
-     * @throws UNAUTHORIZED if the current request is not authenticated.
-     */
-    assertIsAuthenticated(): void;
-    /**
-     * A helper method to create a webhook response. This method should be used inside a webhook handler (function
-     * decorated with @webhook).
-     *
-     * @param body The body of the response.
-     * @param statusCode The status code of the response.
-     * @param headers The headers of the response.
-     * @returns The webhook response.
-     */
-    createWebhookResponse(body?: any, statusCode?: number, headers?: Record<string, any>): WebhookResponse;
-}
+import { Squid } from '@squidcloud/client';
+import { AuthWithApiKey, AuthWithBearer, Logger, RunContext, SecretKey, SecretValue, ServiceConfig, SupportedSquidRegion, WebhookResponse } from '@squidcloud/common';
+/**
+ * A base class for all the different types of Squid backend services. This class serves as a container
+ * for the various methods implemented in the backend in order to customize the Squid backend for an application.
+ */
+export declare class SquidService {
+    /** The list of your application's secrets as defined in the Squid Cloud Console. */
+    readonly secrets: Record<SecretKey, SecretValue>;
+    /**
+     * A logger instance for your application. If you connected one of the observability integrations, the logger will be
+     * reported to the observability service.
+     */
+    readonly logger: Logger;
+    private readonly backendApiKey;
+    /**
+     * The context object for the current request. This object contains information about the current request, such as
+     * the current user, the IP address, the user agent used, the request headers, and more.
+     */
+    readonly context: RunContext;
+    private readonly codeDir;
+    /**
+     * Your application's region. When developing locally, the region will be set to `local`.
+     */
+    readonly region: SupportedSquidRegion;
+    private readonly auth;
+    private readonly config;
+    /**
+     * @internal
+     */
+    constructor(config: ServiceConfig);
+    /**
+     * Returns the API key used by the backend for your application.
+     */
+    getApiKey(): string;
+    /**
+     * Returns the Squid client instance for your application.
+     *
+     * @returns the Squid client instance for your application.
+     */
+    get squid(): Squid;
+    /**
+     * Returns the assets directory for your application.
+     * To read more about the assets directory, see the [Squid
+     * documentation](https://docs.squid.cloud/docs/development-tools/backend/project-structure#assets-directory).
+     *
+     * @returns the assets directory for your application.
+     */
+    get assetsDirectory(): string;
+    /**
+     * Returns the auth object for the current request or undefined if unauthenticated or if using an API key.
+     *
+     * @returns The auth object for the current request or undefined if unauthenticated or if using an API key.
+     */
+    getUserAuth(): AuthWithBearer | undefined;
+    /**
+     * Returns the auth object for the current request or undefined if unauthenticated or if using a user token.
+     *
+     * @returns The auth object for the current request or undefined if unauthenticated or if using a user token.
+     */
+    getApiKeyAuth(): AuthWithApiKey | undefined;
+    /**
+     * Returns true if the current request is authenticated (using a user token or an API key).
+     *
+     * @returns true if the current request is authenticated (using a user token or an API key).
+     */
+    isAuthenticated(): boolean;
+    /**
+     * Asserts that the current request is authenticated (using a user token or an API key).
+     * @throws UNAUTHORIZED if the current request is not authenticated.
+     */
+    assertIsAuthenticated(): void;
+    /**
+     * A helper method to create a webhook response. This method should be used inside a webhook handler (function
+     * decorated with @webhook).
+     *
+     * @param body The body of the response.
+     * @param statusCode The status code of the response.
+     * @param headers The headers of the response.
+     * @returns The webhook response.
+     */
+    createWebhookResponse(body?: any, statusCode?: number, headers?: Record<string, any>): WebhookResponse;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squidcloud/backend",
-  "version": "1.0.111",
+  "version": "1.0.112",
   "description": "Squid Cloud's backend SDK",
   "main": "dist/index.js",
   "types": "dist/backend/src/index.d.ts",