@squidcloud/backend 1.0.110 → 1.0.112

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;
+}