@squidcloud/backend 1.0.364 → 1.0.366

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

@@ -1,5 +1,5 @@
-import { AiFunctionId, ApiEndpointId, CollectionName, IntegrationId, IntegrationType, TopicName } from '@squidcloud/client';
-import { ActionMethodDecorator, AiFunctionAction, ClientConnectionStateChangeAction, ExecutableAction, LimiterConfig, LimitsAction, SchedulerAction, SecureAiAgentAction, SecureApiAction, SecureDatabaseAction, SecureDistributedLockAction, SecureGraphQLAction, SecureMetricAction, SecureNativeQueryAction, SecureStorageAction, SecureTopicAction, TriggerAction, WebhookAction } from '../../internal-common/src/public-types-backend/bundle-api.public-types';
+import { AiFunctionId, ApiEndpointId, CollectionName, IntegrationId, IntegrationType, LlmModelMetadata, LlmModelName, TopicName } from '@squidcloud/client';
+import { ActionMethodDecorator, AiFunctionAction, ClientConnectionStateChangeAction, ExecutableAction, LimiterConfig, LimitsAction, LlmAskAction, SchedulerAction, SecureAiAgentAction, SecureApiAction, SecureDatabaseAction, SecureDistributedLockAction, SecureGraphQLAction, SecureMetricAction, SecureNativeQueryAction, SecureStorageAction, SecureTopicAction, TriggerAction, WebhookAction } from '../../internal-common/src/public-types-backend/bundle-api.public-types';
 import { AiFunctionsConfiguratorRequest, AiFunctionsConfiguratorResponse, 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';
 /**
@@ -120,7 +120,7 @@ export declare function secureGraphQL(integrationId: IntegrationId): ActionMetho
  * 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/backend/executables/ documentation}
+ * {@link https://docs.getsquid.ai/docs/sdk/backend-sdk/executables documentation}
  * @category Decorator
  */
 export declare function executable(): ActionMethodDecorator<ExecutableAction>;
@@ -146,7 +146,7 @@ export interface AiFunctionMetadataOptions {
  * 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/ai/ai-functions/ documentation}.
+ * {@link https://docs.getsquid.ai/docs/sdk/backend-sdk/ai/ai-functions documentation}.
  * @category AI
  * @category Decorator
  */
@@ -156,7 +156,7 @@ export declare function aiFunction<ParamType extends Record<string, any> = any>(
  * 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/ai/ai-functions/ documentation}.
+ * {@link https://docs.getsquid.ai/docs/sdk/backend-sdk/ai/ai-functions documentation}.
  * @category AI
  * @category Decorator
  */
@@ -216,7 +216,7 @@ export interface TriggerOptions {
  * 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/backend/triggers/ documentation}.
+ * {@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.
@@ -231,7 +231,7 @@ export declare function trigger(id: TriggerId, collectionName: CollectionName, i
  * 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/backend/triggers/ documentation}.
+ * {@link https://docs.getsquid.ai/docs/sdk/backend-sdk/triggers documentation}.
  * @category Decorator
  */
 export declare function trigger(options: TriggerOptions): ActionMethodDecorator<TriggerAction>;
@@ -259,7 +259,7 @@ export interface SchedulerOptions {
  * expression.
  *
  * To read more about schedulers, see the
- * {@link https://docs.getsquid.ai/docs/backend/schedulers/ documentation}.
+ * {@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.
@@ -273,7 +273,7 @@ export declare function scheduler(id: SchedulerId, cronExpression: CronExpressio
  * The function will be called according to the provided cron expression.
  *
  * To read more about schedulers, see the
- * {@link https://docs.getsquid.ai/docs/backend/schedulers/ documentation}.
+ * {@link https://docs.getsquid.ai/docs/sdk/backend-sdk/schedulers documentation}.
  * @category Decorator
  */
 export declare function scheduler(options: SchedulerOptions): ActionMethodDecorator<SchedulerAction>;
@@ -288,7 +288,7 @@ export declare function scheduler(options: SchedulerOptions): ActionMethodDecora
  * `this.createWebhookResponse(<params>)`.
  *
  * To read more about webhooks, see the
- * {@link https://docs.getsquid.ai/docs/backend/webhooks/ documentation}.
+ * {@link https://docs.getsquid.ai/docs/sdk/backend-sdk/webhooks documentation}.
  * @param id The ID of the webhook. Should be unique.
  * @category Decorator
  */
@@ -405,6 +405,25 @@ export declare function secureAiAgent(agentId?: string): ActionMethodDecorator<S
  * @category Decorator
  */
 export declare function limits(options: LimiterConfig): ActionMethodDecorator<LimitsAction>;
+/**
+ * Options for the `@llmService` decorator.
+ */
+export interface LlmServiceOptions {
+    /**
+     * Map of model names to their metadata.
+     */
+    models: Record<LlmModelName, LlmModelMetadata>;
+}
+/**
+ * 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 function for handling a client connection state change.
  * @category Platform

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

@@ -3,4 +3,5 @@ export * from './metadata';
 export * from './project';
 export * from './public-types';
 export * from './service';
+export * from './llm-service';
 export * from './utils';

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

@@ -0,0 +1,12 @@
+import { SquidService } from './service';
+/**
+ * Abstract class representing a service for interacting with LLMs (Large Language Models).
+ */
+export declare abstract class SquidLlmService extends SquidService {
+    /**
+     * Asks a question to the LLM and returns the response.
+     * @param prompt The prompt to send to the LLM.
+     * @param model The name of the model to use for the request.
+     */
+    abstract ask(prompt: string, model: string): Promise<string>;
+}

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

@@ -8,4 +8,5 @@ export * from '../../internal-common/src/public-types-backend/metric.public-cont
 export * from '../../internal-common/src/public-types-backend/mutation.public-context';
 export * from '../../internal-common/src/public-types-backend/native-query.public-context';
 export * from '../../internal-common/src/public-types-backend/query.public-context';
+export * from '../../internal-common/src/public-types-backend/storage.public-types';
 export * from '../../internal-common/src/public-types-backend/topic.public-context';