@squidcloud/client 1.0.168 → 1.0.169

package/dist/cjs/index.js

@@ -30353,6 +30353,7 @@ function map(project, thisArg) {
 
 
 class AiChatbotClient {
+    /** @internal */
     constructor(rpcManager, socketManager, integrationId) {
         this.rpcManager = rpcManager;
         this.socketManager = socketManager;
@@ -30446,6 +30447,7 @@ class AiChatbotClient {
     }
 }
 class AiChatbotProfileReference {
+    /** @internal */
     constructor(client, integrationId, profileId) {
         this.client = client;
         this.integrationId = integrationId;
@@ -30550,6 +30552,7 @@ class AiChatbotProfileReference {
     }
 }
 class AiChatbotContextReference {
+    /** @internal */
     constructor(client, integrationId, profileId, id) {
         this.client = client;
         this.integrationId = integrationId;
@@ -30625,6 +30628,7 @@ class AiChatbotContextReference {
     }
 }
 class AiChatbotInstructionReference {
+    /** @internal */
     constructor(client, integrationId, profileId, id) {
         this.client = client;
         this.integrationId = integrationId;
@@ -30764,6 +30768,7 @@ function validateFieldSort(fieldSort) {
     (0,dist.assertTruthy)(isRightType(safeFieldSort.asc, 'boolean'), 'Asc needs to be boolean');
     validateFieldName(safeFieldSort.fieldName);
 }
+/** @internal */
 function validateOpenIdProvider(openIdProvider) {
     assertTruthy(openIdProvider, 'INVALID_PROVIDER');
     validateOpenIdProviderType(openIdProvider.providerType);
@@ -30772,6 +30777,7 @@ function validateOpenIdProvider(openIdProvider) {
     assertTruthy(openIdProvider.domain, 'INVALID_DOMAIN');
     return openIdProvider;
 }
+/** @internal */
 function validateOpenIdProviderType(providerType) {
     const providerArray = ['auth0'];
     assertTruthy(providerArray.includes(providerType), 'INVALID_OPEN_ID_PROVIDER_TYPE');
@@ -48197,13 +48203,13 @@ class GraphQLClient {
 
 ;// CONCATENATED MODULE: ./src/ai-chatbot-client.factory.ts
 
+/** @internal */
 class AiChatbotClientFactory {
     constructor(rpcManager, socketManager) {
         this.rpcManager = rpcManager;
         this.socketManager = socketManager;
         this.chatbotsMap = new Map();
     }
-    /** @internal */
     getChatbot(aiIntegrationId) {
         let client = this.chatbotsMap.get(aiIntegrationId);
         if (client)
@@ -48422,6 +48428,7 @@ class ClientIdService {
 
 ;// CONCATENATED MODULE: ./src/collection-reference.factory.ts
 
+/** @internal */
 class CollectionReferenceFactory {
     constructor(documentReferenceFactory, queryBuilderFactory, querySubscriptionManager) {
         this.documentReferenceFactory = documentReferenceFactory;
@@ -48643,6 +48650,7 @@ function reduceMutations(mutations) {
 
 /** Two transactions cannot run in parallel - this mutex is used for blocking a second transaction. */
 const RUN_IN_TRANSACTION_MUTEX = 'dataManager_runInTransaction';
+/** @internal */
 class DataManager {
     constructor(documentStore, mutationSender, socketManager, querySubscriptionManager, queryBuilderFactory, lockManager, destructManager, documentIdentityService, querySender) {
         this.documentStore = documentStore;
@@ -49472,6 +49480,7 @@ class DistributedLockImpl {
 
 ;// CONCATENATED MODULE: ./src/document-identity.service.ts
 
+/** @internal */
 class DocumentIdentityService {
     constructor(documentStore, destructManager) {
         this.documentStore = documentStore;
@@ -49498,12 +49507,11 @@ class DocumentIdentityService {
 
 
 
+/** @internal */
 class DocumentReferenceFactory {
     constructor(documentIdentityService) {
         this.documentIdentityService = documentIdentityService;
-        /** @internal */
         this.documents = new Map();
-        /** @internal */
         this.documentsForCollection = new Map();
         this.documentIdentityService.observeChanges().subscribe(this.migrateDocIds.bind(this));
     }
@@ -49522,16 +49530,10 @@ class DocumentReferenceFactory {
     setDataManager(dataManager) {
         this.dataManager = dataManager;
     }
-    /**
-     * @internal
-     */
     getDocumentsForCollection(integrationId, collectionName) {
         const collectionKey = this.getCollectionKey(integrationId, collectionName);
         return (this.documentsForCollection.get(collectionKey) || []).filter(d => d.hasData);
     }
-    /**
-     * @internal
-     */
     migrateDocIds(idResolutionMap) {
         for (const [, reference] of this.documents) {
             reference.migrateDocIds(idResolutionMap);
@@ -49679,6 +49681,7 @@ class GraphQLClientFactory {
 
 
 
+/** @internal */
 class MutationSender {
     constructor(rpcManager, lockManager, querySender) {
         this.rpcManager = rpcManager;
@@ -49713,13 +49716,13 @@ class MutationSender {
 ;// CONCATENATED MODULE: ./src/query/local-query-manager.ts
 
 
+/** @internal */
 class LocalQueryManager {
     constructor(documentStore, documentReferenceFactory, querySubscriptionManager) {
         this.documentStore = documentStore;
         this.documentReferenceFactory = documentReferenceFactory;
         this.querySubscriptionManager = querySubscriptionManager;
     }
-    /** @internal */
     peek(query) {
         if (!this.querySubscriptionManager.findValidParentOfQuery(query))
             return [];
@@ -49829,6 +49832,7 @@ const arrayMergeCustomizer = (a, b) => {
 // Exported only for tests
 const FETCH_BEYOND_LIMIT = 100;
 const LIMIT_UNDERFLOW_TRIGGER = 20;
+/** @internal */
 class QuerySubscriptionManager {
     constructor(rpcManager, clientIdService, documentStore, destructManager, documentIdentityService, querySender) {
         this.rpcManager = rpcManager;
@@ -51037,6 +51041,7 @@ function createWebSocketWrapper(url, opts = {}) {
 
 
 
+/** @internal */
 class SocketManager {
     constructor(clientIdService, region, appId, messageNotificationWrapper = NOOP_FN, destructManager, authManager) {
         this.clientIdService = clientIdService;
@@ -51233,6 +51238,7 @@ class SocketManager {
 ;// CONCATENATED MODULE: ./src/query/query-sender.ts
 
 
+/** @internal */
 class QuerySender {
     constructor(rpcManager, destructManager) {
         this.rpcManager = rpcManager;
@@ -51462,6 +51468,7 @@ class AiAssistantClient {
  * through its methods.
  */
 class AiClient {
+    /** @internal */
     constructor(aiChatbotClientFactory, rpcManager) {
         this.aiChatbotClientFactory = aiChatbotClientFactory;
         this.rpcManager = rpcManager;

package/dist/internal-common/src/public-types/ai-assistant.public-types.d.ts

@@ -0,0 +1,25 @@
+import { FunctionName } from './bundle-data.public-types';
+export type AssistantToolType = 'code_interpreter' | 'retrieval';
+export interface CreateAssistantRequest {
+    name: string;
+    instructions: string;
+    functions: Array<FunctionName>;
+    toolTypes?: Array<AssistantToolType>;
+}
+export interface DeleteAssistantRequest {
+    assistantId: string;
+}
+export interface CreateAssistantThreadRequest {
+    assistantId: string;
+}
+export interface DeleteThreadRequest {
+    threadId: string;
+}
+export interface CreateAssistantThreadRequest {
+}
+export interface CreateAssistantResponse {
+    assistantId: string;
+}
+export interface CreateAssistantThreadResponse {
+    threadId: string;
+}

package/dist/internal-common/src/public-types/ai-chatbot.public-context.d.ts

@@ -0,0 +1,12 @@
+import { AiChatbotMutationType, AiChatbotResourceType } from './ai-chatbot.public-types';
+export declare class AiChatbotChatContext {
+    readonly prompt: string;
+    readonly profileId: string;
+}
+/** A context provided to the security rules of an AI Chatbot mutation. */
+export declare class AiChatbotMutationContext {
+    readonly type: AiChatbotMutationType;
+    readonly resource: AiChatbotResourceType;
+    readonly profileId: string;
+    readonly payload: any;
+}

package/dist/internal-common/src/public-types/ai-chatbot.public-types.d.ts

@@ -0,0 +1,31 @@
+/** The supported AI model names. */
+export declare const AI_MODEL_NAMES: readonly ["gpt-3.5-turbo", "gpt-3.5-turbo-1106", "gpt-4", "claude-2", "gpt-4-1106-preview"];
+export type AiModelName = (typeof AI_MODEL_NAMES)[number];
+/** The possible sources for the LLM provider API key. */
+export type ApiKeySource = 'user' | 'system';
+export type AiChatbotContextType = 'text' | 'url' | 'file';
+interface AiChatbotContextBase {
+    type: AiChatbotContextType;
+    data: string;
+}
+export interface AiChatbotTextContext extends AiChatbotContextBase {
+    type: 'text';
+}
+export interface AiChatbotUrlContext extends AiChatbotContextBase {
+    type: 'url';
+}
+export interface AiChatbotFileContext extends AiChatbotContextBase {
+    type: 'file';
+}
+export type AiChatbotContext = AiChatbotTextContext | AiChatbotUrlContext | AiChatbotFileContext;
+export type OpenAiResponseFormat = 'text' | 'json_object';
+export interface AiChatbotChatOptions {
+    maxTokens?: number;
+    chatId?: string;
+    disableHistory?: boolean;
+    includeReference?: boolean;
+    responseFormat?: OpenAiResponseFormat;
+}
+export type AiChatbotMutationType = 'insert' | 'update' | 'delete';
+export type AiChatbotResourceType = 'instruction' | 'context' | 'profile';
+export {};

package/dist/internal-common/src/public-types/api-call.public-context.d.ts

@@ -0,0 +1,14 @@
+import { ApiEndpointId, HttpMethod } from './integrations/api.types';
+/** The headers of an API call. */
+export type ApiHeaders = Record<string, string | number | boolean>;
+/** The context of an API call. */
+export declare class ApiCallContext {
+    readonly endpointId: ApiEndpointId;
+    readonly url: string;
+    readonly method: HttpMethod;
+    readonly headers: ApiHeaders;
+    readonly body: Record<string, any>;
+    readonly queryParams: Record<string, string | number | boolean>;
+    readonly pathParams: Record<string, string>;
+    readonly serverUrlOverride: string | undefined;
+}

package/dist/internal-common/src/public-types/application.public-types.d.ts

@@ -0,0 +1,149 @@
+import { AuthIntegrationType, DatabaseIntegrationType, IntegrationConfig, IntegrationConfigTypes, IntegrationSchema, IntegrationSchemaKeys, IntegrationSchemaTypes, IntegrationTypeWithConfig } from './integrations/schemas';
+import { IntegrationType } from './integration.public-types';
+import { AppId, EnvironmentId, IntegrationId } from './communication.public-types';
+/** A type alias for a string that represents a webhook. */
+export type WebhookId = string;
+/** A type alias for a string that represents a trigger id. */
+export type TriggerId = string;
+/** A type alias for a string that represents a scheduler id. */
+export type SchedulerId = string;
+/** The supported cron expression string. */
+export type CronExpressionString = `${string} ${string} ${string} ${string} ${string}` | `${string} ${string} ${string} ${string}`;
+/** A set of predefined cron expressions. */
+export declare enum CronExpression {
+    EVERY_SECOND = "* * * * * *",
+    EVERY_5_SECONDS = "*/5 * * * * *",
+    EVERY_10_SECONDS = "*/10 * * * * *",
+    EVERY_30_SECONDS = "*/30 * * * * *",
+    EVERY_MINUTE = "*/1 * * * *",
+    EVERY_5_MINUTES = "0 */5 * * * *",
+    EVERY_10_MINUTES = "0 */10 * * * *",
+    EVERY_30_MINUTES = "0 */30 * * * *",
+    EVERY_HOUR = "0 0-23/1 * * *",
+    EVERY_2_HOURS = "0 0-23/2 * * *",
+    EVERY_3_HOURS = "0 0-23/3 * * *",
+    EVERY_4_HOURS = "0 0-23/4 * * *",
+    EVERY_5_HOURS = "0 0-23/5 * * *",
+    EVERY_6_HOURS = "0 0-23/6 * * *",
+    EVERY_7_HOURS = "0 0-23/7 * * *",
+    EVERY_8_HOURS = "0 0-23/8 * * *",
+    EVERY_9_HOURS = "0 0-23/9 * * *",
+    EVERY_10_HOURS = "0 0-23/10 * * *",
+    EVERY_11_HOURS = "0 0-23/11 * * *",
+    EVERY_12_HOURS = "0 0-23/12 * * *",
+    EVERY_DAY_AT_1AM = "0 01 * * *",
+    EVERY_DAY_AT_2AM = "0 02 * * *",
+    EVERY_DAY_AT_3AM = "0 03 * * *",
+    EVERY_DAY_AT_4AM = "0 04 * * *",
+    EVERY_DAY_AT_5AM = "0 05 * * *",
+    EVERY_DAY_AT_6AM = "0 06 * * *",
+    EVERY_DAY_AT_7AM = "0 07 * * *",
+    EVERY_DAY_AT_8AM = "0 08 * * *",
+    EVERY_DAY_AT_9AM = "0 09 * * *",
+    EVERY_DAY_AT_10AM = "0 10 * * *",
+    EVERY_DAY_AT_11AM = "0 11 * * *",
+    EVERY_DAY_AT_NOON = "0 12 * * *",
+    EVERY_DAY_AT_1PM = "0 13 * * *",
+    EVERY_DAY_AT_2PM = "0 14 * * *",
+    EVERY_DAY_AT_3PM = "0 15 * * *",
+    EVERY_DAY_AT_4PM = "0 16 * * *",
+    EVERY_DAY_AT_5PM = "0 17 * * *",
+    EVERY_DAY_AT_6PM = "0 18 * * *",
+    EVERY_DAY_AT_7PM = "0 19 * * *",
+    EVERY_DAY_AT_8PM = "0 20 * * *",
+    EVERY_DAY_AT_9PM = "0 21 * * *",
+    EVERY_DAY_AT_10PM = "0 22 * * *",
+    EVERY_DAY_AT_11PM = "0 23 * * *",
+    EVERY_DAY_AT_MIDNIGHT = "0 0 * * *",
+    EVERY_WEEK = "0 0 * * 7",
+    EVERY_WEEKDAY = "0 0 * * 1-5",
+    EVERY_WEEKEND = "0 0 * * 6,7",
+    EVERY_1ST_DAY_OF_MONTH_AT_MIDNIGHT = "0 0 1 * *",
+    EVERY_1ST_DAY_OF_MONTH_AT_NOON = "0 12 1 * *",
+    EVERY_2ND_HOUR = "0 */2 * * *",
+    EVERY_2ND_HOUR_FROM_1AM_THROUGH_11PM = "0 1-23/2 * * *",
+    EVERY_2ND_MONTH = "0 0 1 */2 *",
+    EVERY_QUARTER = "0 0 1 */3 *",
+    EVERY_6_MONTHS = "0 0 1 */6 *",
+    EVERY_YEAR = "0 0 1 1 *",
+    EVERY_30_MINUTES_BETWEEN_9AM_AND_5PM = "0 */30 9-17 * * *",
+    EVERY_30_MINUTES_BETWEEN_9AM_AND_6PM = "0 */30 9-18 * * *",
+    EVERY_30_MINUTES_BETWEEN_10AM_AND_7PM = "0 */30 10-19 * * *",
+    MONDAY_TO_FRIDAY_AT_1AM = "0 0 01 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_2AM = "0 0 02 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_3AM = "0 0 03 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_4AM = "0 0 04 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_5AM = "0 0 05 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_6AM = "0 0 06 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_7AM = "0 0 07 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_8AM = "0 0 08 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_9AM = "0 0 09 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_09_30AM = "0 30 09 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_10AM = "0 0 10 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_11AM = "0 0 11 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_11_30AM = "0 30 11 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_12PM = "0 0 12 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_1PM = "0 0 13 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_2PM = "0 0 14 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_3PM = "0 0 15 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_4PM = "0 0 16 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_5PM = "0 0 17 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_6PM = "0 0 18 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_7PM = "0 0 19 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_8PM = "0 0 20 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_9PM = "0 0 21 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_10PM = "0 0 22 * * 1-5",
+    MONDAY_TO_FRIDAY_AT_11PM = "0 0 23 * * 1-5"
+}
+export interface DeleteIntegrationRequest {
+    integrationId: IntegrationId;
+}
+export interface UpdateAllowedHostsRequest {
+    allowedHosts: string[];
+}
+export interface CreateEnvironmentRequest {
+    sourceAppId: AppId;
+    environmentId: EnvironmentId;
+}
+export interface UpdateApplicationCodeRequest {
+    appId: AppId;
+    openApiSpecStr?: string;
+    openApiControllersStr?: string;
+}
+interface BaseUpsertIntegrationRequest<T extends IntegrationTypeWithConfig, C extends IntegrationConfig> {
+    id: IntegrationId;
+    type: T;
+    config: Partial<C>;
+}
+type ConfigurationTypes = {
+    [K in IntegrationTypeWithConfig]: IntegrationConfigTypes[K];
+};
+type UpsertIntegrationRequests = {
+    [K in IntegrationTypeWithConfig]: BaseUpsertIntegrationRequest<K, ConfigurationTypes[K]>;
+};
+export type UpsertDataIntegrationRequest = UpsertIntegrationRequests[DatabaseIntegrationType];
+export type UpsertGraphQLIntegrationRequest = UpsertIntegrationRequests[IntegrationType.graphql];
+export type UpsertApiIntegrationRequest = UpsertIntegrationRequests[IntegrationType.api];
+export type UpsertAiChatbotIntegrationRequest = UpsertIntegrationRequests[IntegrationType.ai_chatbot];
+export type UpsertKafkaIntegrationRequest = UpsertIntegrationRequests[IntegrationType.kafka];
+export type UpsertConfluentIntegrationRequest = UpsertIntegrationRequests[IntegrationType.confluent];
+export type UpsertAuthIntegrationRequest = UpsertIntegrationRequests[AuthIntegrationType];
+interface BaseUpsertIntegrationSchemaRequest<T extends IntegrationType, S extends IntegrationSchema> {
+    id: IntegrationId;
+    type: T;
+    schema: S;
+}
+type SchemaTypes = {
+    [K in IntegrationSchemaKeys]: IntegrationSchemaTypes[K];
+};
+type UpsertIntegrationSchemaRequests = {
+    [K in IntegrationSchemaKeys]: BaseUpsertIntegrationSchemaRequest<K, SchemaTypes[K]>;
+};
+export type UpsertIntegrationSchemaRequest = UpsertDataIntegrationSchemaRequest | UpsertGraphQLIntegrationSchemaRequest | UpsertApiIntegrationSchemaRequest;
+export type UpsertDataIntegrationSchemaRequest = UpsertIntegrationSchemaRequests[DatabaseIntegrationType];
+export type UpsertGraphQLIntegrationSchemaRequest = UpsertIntegrationSchemaRequests[IntegrationType.graphql];
+export type UpsertApiIntegrationSchemaRequest = UpsertIntegrationSchemaRequests[IntegrationType.api];
+export interface GetSchemaRequest {
+    integrationId: IntegrationId;
+}
+export {};

package/dist/internal-common/src/public-types/base-query-builder.public-types.d.ts

@@ -0,0 +1,147 @@
+import { Observable } from 'rxjs';
+import { SerializedQuery } from './serialized-query.public-types';
+import { Pagination, PaginationOptions } from './pagination.public-types';
+import { Operator } from './query.public-types';
+import { DocumentData, FieldName, PrimitiveFieldType } from './document.public-types';
+export interface SnapshotEmitter<ReturnType> {
+    /**
+     * Returns a promise that resolves to the query results.
+     *
+     * @returns A promise that resolves to the query results.
+     */
+    snapshot(): Promise<Array<ReturnType>>;
+    /**
+     * Returns an observable that emits the query results and updates whenever the query results change unless
+     * `subscribe=false` is provided.
+     *
+     * Important: Make sure to unsubscribe from the observable when you are done with it.
+     *
+     * @param subscribe Whether to subscribe to changes to the query results. Defaults to `true`.
+     * @returns An observable for the query results.
+     */
+    snapshots(subscribe?: boolean): Observable<Array<ReturnType>>;
+    /**
+     * Returns the results of the query based on the data that is currently available on the client. This method is useful
+     * for synchronously accessing data that has already been fetched by another query. The method will return an empty
+     * array if data has not yet been populated.
+     *
+     * @returns An array of query results.
+     */
+    peek(): Array<ReturnType>;
+    limit(limit: number): SnapshotEmitter<ReturnType>;
+    /**
+     * Returns a pagination wrapper for this query.
+     * @param options The pagination options. Defaults to `{ subscribe: true, pageSize: 100 }`.
+     */
+    paginate(options?: Partial<PaginationOptions>): Pagination<ReturnType>;
+    serialize(): SerializedQuery;
+}
+/** Query builder base class. */
+export declare abstract class BaseQueryBuilder<MyDocType extends DocumentData> {
+    /**
+     * Adds a condition to the query.
+     * @param fieldName The name of the field to query.
+     * @param operator The operator to use.
+     * @param value The value to compare against.
+     * @returns The query builder.
+     */
+    abstract where(fieldName: (keyof MyDocType & FieldName) | string, operator: Operator | 'in' | 'not in', value: PrimitiveFieldType | Array<PrimitiveFieldType>): this;
+    /**
+     * A shortcut for where(fieldName, '==', value)
+     *
+     * @param fieldName The name of the field to query.
+     * @param value The value to compare against.
+     * @returns The query builder.
+     */
+    eq(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
+    /**
+     * A shortcut for where(fieldName, '!=', value)
+     * @param fieldName The name of the field to query.
+     * @param value The value to compare against.
+     * @returns The query builder.
+     */
+    neq(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
+    /**
+     * A shortcut for where(fieldName, 'in', value)
+     * @param fieldName The name of the field to query.
+     * @param value An array of values to compare against.
+     * @returns The query builder.
+     */
+    in(fieldName: (keyof MyDocType & FieldName) | string, value: Array<PrimitiveFieldType>): this;
+    /**
+     * A shortcut for where(fieldName, 'not in', value)
+     * @param fieldName The name of the field to query.
+     * @param value An array of values to compare against.
+     * @returns The query builder.
+     */
+    nin(fieldName: (keyof MyDocType & FieldName) | string, value: Array<PrimitiveFieldType>): this;
+    /**
+     * A shortcut for where(fieldName, '>', value)
+     * @param fieldName The name of the field to query.
+     * @param value The value to compare against.
+     * @returns The query builder.
+     */
+    gt(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
+    /**
+     * A shortcut for where(fieldName, '>=', value)
+     * @param fieldName The name of the field to query.
+     * @param value The value to compare against.
+     * @returns The query builder.
+     */
+    gte(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
+    /**
+     * A shortcut for where(fieldName, '<', value)
+     * @param fieldName The name of the field to query.
+     * @param value The value to compare against.
+     * @returns The query builder.
+     */
+    lt(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
+    /**
+     * A shortcut for where(fieldName, '<=', value)
+     * @param fieldName The name of the field to query.
+     * @param value The value to compare against.
+     * @returns The query builder.
+     */
+    lte(fieldName: (keyof MyDocType & FieldName) | string, value: PrimitiveFieldType): this;
+    /**
+     * A shortcut for where(fieldName, 'like', pattern).
+     *
+     * @param fieldName The name of the field to query.
+     * @param pattern The pattern to compare against. '%' is the only allowed wildcard
+     * @param caseSensitive Whether to use case-sensitive comparison. Defaults to true.
+     * @returns The query builder.
+     */
+    like(fieldName: (keyof MyDocType & FieldName) | string, pattern: string, caseSensitive?: boolean): this;
+    /**
+     * A shortcut for where(fieldName, 'not like', pattern).
+     *
+     * @param fieldName The name of the field to query.
+     * @param pattern The pattern to compare against. '%' is the only allowed wildcard
+     * @param caseSensitive Whether to use case-sensitive comparison. Defaults to true.
+     * @returns The query builder.
+     */
+    notLike(fieldName: (keyof MyDocType & FieldName) | string, pattern: string, caseSensitive?: boolean): this;
+    /**
+     * Sets a limit to the number of results returned by the query. The maximum limit is 20,000 and the default is 1,000
+     * if none is provided.
+     * @param limit The limit to set.
+     * @returns The query builder.
+     */
+    abstract limit(limit: number): this;
+    /**
+     * Adds a sort order to the query. You can add multiple sort orders to the query. The order in which you add them
+     * determines the order in which they are applied.
+     * @param fieldName The name of the field to sort by.
+     * @param asc Whether to sort in ascending order. Defaults to true.
+     * @returns The query builder.
+     */
+    abstract sortBy(fieldName: keyof MyDocType & FieldName, asc?: boolean): this;
+}
+export interface HasDereference {
+    /**
+     * Dereferences the document references in the result of this query. For example, collection.query().snapshot()
+     * returns an array of DocumentReference objects, but collection.query().dereference().snapshot() returns an array of
+     * the actual document data.
+     */
+    dereference(): any;
+}

package/dist/internal-common/src/public-types/bundle-api.public-types.d.ts

@@ -0,0 +1,57 @@
+import { MutationContext } from './mutation.public-context';
+import { ApiCallContext } from './api-call.public-context';
+import { QueryContext } from './query.public-context';
+import { AiChatbotActionType, DatabaseActionType, TopicActionType } from './bundle-data.public-types';
+import { ClientConnectionState } from './socket.public-types';
+import { DocumentData } from './document.public-types';
+import { MutationType } from './mutation.public-types';
+import { ClientId, SquidDocId } from './communication.public-types';
+import { TopicReadContext, TopicWriteContext } from './topic.public-context';
+import { NativeQueryContext } from './native-query.public-context';
+import { DistributedLockContext } from './distributed-lock.public-context';
+import { GraphqlContext } from './graphql.public-context';
+import { AiChatbotChatContext, AiChatbotMutationContext } from './ai-chatbot.public-context';
+export type SecureDatabaseAction<T extends DatabaseActionType> = T extends 'all' ? () => boolean | Promise<boolean> : T extends 'read' ? ((context: QueryContext) => boolean | Promise<boolean>) | (() => boolean | Promise<boolean>) : ((context: MutationContext) => boolean | Promise<boolean>) | (() => boolean | Promise<boolean>);
+export type SecureTopicAction<T extends TopicActionType> = T extends 'all' ? () => boolean | Promise<boolean> : T extends 'read' ? ((context: TopicReadContext) => boolean | Promise<boolean>) | (() => boolean | Promise<boolean>) : ((context: TopicWriteContext<T>) => boolean | Promise<boolean>) | (() => boolean | Promise<boolean>);
+export type SecureApiAction = ((context: ApiCallContext) => boolean | Promise<boolean>) | (() => boolean | Promise<boolean>);
+export type SecureNativeQueryAction = ((context: NativeQueryContext) => boolean | Promise<boolean>) | (() => boolean | Promise<boolean>);
+export type SecureDistributedLockAction = ((context: DistributedLockContext) => boolean | Promise<boolean>) | (() => boolean | Promise<boolean>);
+export type SecureGraphQLAction = ((context: GraphqlContext) => boolean | Promise<boolean>) | (() => boolean | Promise<boolean>);
+export type SecureAiChatbotAction<T extends AiChatbotActionType> = T extends 'all' ? () => boolean | Promise<boolean> : T extends 'chat' ? ((context: AiChatbotChatContext) => boolean | Promise<boolean>) | (() => boolean | Promise<boolean>) : ((context: AiChatbotMutationContext) => boolean | Promise<boolean>) | (() => boolean | Promise<boolean>);
+export type ClientConnectionStateChangeAction = (clientId: ClientId, clientConnectionState: ClientConnectionState) => Promise<void> | void;
+export type ExecutableAction = (...args: any[]) => any;
+export type AiFunctionAction<T extends Record<string, any> = any> = (params: T) => any;
+export type TriggerAction = ((request: TriggerRequest) => void | Promise<void>) | (() => void | Promise<void>);
+/** The context provided to a trigger function. */
+export interface TriggerRequest<T extends DocumentData = any> {
+    squidDocId: SquidDocId;
+    mutationType: MutationType;
+    docBefore?: T;
+    docAfter?: T;
+}
+export type SchedulerAction = () => void | Promise<void>;
+export type WebhookAction = ((request: WebhookRequest) => any) | (() => any);
+/** The context provided to a webhook function. */
+export interface WebhookRequest<T = any> {
+    body: T;
+    rawBody?: string;
+    queryParams: Record<string, string>;
+    headers: Record<string, string>;
+    httpMethod: 'post' | 'get' | 'put' | 'delete';
+    files?: Array<SquidFile>;
+}
+export interface WebhookResponse {
+    headers: Record<string, any>;
+    body: any;
+    statusCode: number;
+    __isWebhookResponse__: true;
+}
+export interface SquidFile {
+    data: Uint8Array;
+    fieldName: string;
+    mimetype: string;
+    originalName: string;
+    size: number;
+    encoding?: string;
+}
+export type ActionMethodDecorator<U> = <T extends U>(target: Object, propertyName: string, descriptor: TypedPropertyDescriptor<T>) => TypedPropertyDescriptor<T>;

package/dist/internal-common/src/public-types/bundle-data.public-types.d.ts

@@ -0,0 +1,8 @@
+/** The different types of actions that can be performed on a database. */
+export type DatabaseActionType = 'read' | 'write' | 'update' | 'insert' | 'delete' | 'all';
+/** The different types of actions that can be performed on a topic. */
+export type TopicActionType = 'read' | 'write' | 'all';
+/** The different types of actions that can be performed on an AI chatbot. */
+export type AiChatbotActionType = 'chat' | 'mutate' | 'all';
+export type AiFunctionParamType = 'string' | 'number' | 'boolean' | 'date';
+export type FunctionName = string;

package/dist/internal-common/src/public-types/communication.public-types.d.ts

@@ -0,0 +1,12 @@
+/** A type alias for an application id. */
+export type AppId = string;
+export declare const ENVIRONMENT_IDS: readonly ["dev", "prod"];
+export type EnvironmentId = (typeof ENVIRONMENT_IDS)[number];
+export type SquidDeveloperId = string;
+/** @deprecated. Use ENVIRONMENT_IDS. */
+export declare const allEnvironmentIds: Array<EnvironmentId>;
+/** A type alias for an integration id. */
+export type IntegrationId = string;
+export type ClientId = string;
+export type SquidDocId = string;
+export type ClientRequestId = string;

package/dist/internal-common/src/public-types/context.public-types.d.ts

@@ -0,0 +1,40 @@
+import { AppId, ClientId } from './communication.public-types';
+export type AuthType = 'Bearer' | 'ApiKey';
+/**
+ * The payload of a JWT token in case an auth token was used.
+ */
+export interface AuthWithBearer {
+    type: 'Bearer';
+    userId: string;
+    expiration: number;
+    attributes: Record<string, any>;
+}
+/**
+ * The authentication object for the current request in case an API key is used.
+ */
+export interface AuthWithApiKey {
+    type: 'ApiKey';
+    apiKey: string;
+}
+/** The authentication object for the current request. */
+export type Auth = AuthWithBearer | AuthWithApiKey;
+export interface AuthToken {
+    type: AuthType;
+    token: string;
+    integrationId?: string;
+}
+/** The context of a request to a service. */
+export interface RunContext {
+    /** Your applicationId. */
+    appId: AppId;
+    /**
+     * The id of the client that initiated this request. This is only relevant in cases that the request was initiated by
+     * a client such as when securing an api call or a DB operation. This id will not be available for triggers,
+     * schedulers, webhooks and other functions that are not directly initiated by a user action.
+     */
+    clientId?: ClientId;
+    /** The IP address of the client that initiated this request. */
+    sourceIp?: string;
+    /** The headers of the request. */
+    headers?: Record<string, any>;
+}