@squidcloud/client 1.0.88 → 1.0.89

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

@@ -1,2 +1,12 @@
 /** The supported Open AI model names. */
 export type OpenAiModelName = 'gpt-3.5-turbo' | 'gpt-4';
+export type AiAssistantContextType = 'text' | 'url';
+export interface AiAssistantTextContext {
+    type: 'text';
+    data: string;
+}
+export interface AiAssistantUrlContext {
+    type: 'url';
+    data: string;
+}
+export type AiAssistantContext = AiAssistantTextContext | AiAssistantUrlContext;

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

@@ -8,15 +8,14 @@ import { NamedQueryContext } from './named-query.context';
 import { GraphqlContext } from './graphql.context';
 import { DistributedLockContext } from './distributed-lock.context';
 import { AiAssistantChatContext, AiAssistantMutationContext } from './ai-assistant.context';
-export type SecureDatabaseAction<T extends DatabaseActionType> = T extends 'all' ? () => boolean | Promise<boolean> : T extends 'read' ? (context?: QueryContext) => boolean | Promise<boolean> : (context?: MutationContext) => boolean | Promise<boolean>;
-export type SecureApiAction = (context?: ApiCallContext) => boolean | Promise<boolean>;
-export type SecureNamedQueryAction = (context?: NamedQueryContext) => boolean | Promise<boolean>;
-export type SecureDistributedLockAction = (context?: DistributedLockContext) => boolean | Promise<boolean>;
-export type SecureGraphQLAction = (context?: GraphqlContext) => boolean | Promise<boolean>;
-export type SecureAiAssistantAction<T extends AiAssistantActionType> = T extends 'all' ? () => boolean | Promise<boolean> : T extends 'chat' ? (context?: AiAssistantChatContext) => boolean | Promise<boolean> : (context?: AiAssistantMutationContext) => boolean | Promise<boolean>;
-export type TransformDatabaseAction<T extends DatabaseActionType> = T extends 'read' ? (request?: TransformDatabaseReadRequest) => TransformDatabaseReadResponse | Promise<TransformDatabaseReadResponse> : (request?: TransformDatabaseWriteRequest) => TransformDatabaseWriteResponse | Promise<TransformDatabaseWriteResponse>;
+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 SecureApiAction = ((context: ApiCallContext) => boolean | Promise<boolean>) | (() => boolean | Promise<boolean>);
+export type SecureNamedQueryAction = ((context: NamedQueryContext) => 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 SecureAiAssistantAction<T extends AiAssistantActionType> = T extends 'all' ? () => boolean | Promise<boolean> : T extends 'chat' ? ((context: AiAssistantChatContext) => boolean | Promise<boolean>) | (() => boolean | Promise<boolean>) : ((context: AiAssistantMutationContext) => boolean | Promise<boolean>) | (() => boolean | Promise<boolean>);
 export type ExecutableAction = (...args: any[]) => any;
-export type TriggerAction = (request?: TriggerRequest) => void | Promise<void>;
+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;
@@ -25,7 +24,7 @@ export interface TriggerRequest<T extends DocumentData = any> {
     docAfter?: T;
 }
 export type SchedulerAction = () => void | Promise<void>;
-export type WebhookAction = (request?: WebhookRequest) => any;
+export type WebhookAction = ((request: WebhookRequest) => any) | (() => any);
 /** The context provided to a webhook function. */
 export interface WebhookRequest {
     body: any;

package/dist/common/src/integrations/ai_assistant.types.d.ts

@@ -12,9 +12,9 @@ export type AiAssistantProfile = {
     modelName: string;
     strictContext: boolean;
     instructions: Record<string, string>;
-    contexts: Record<string, AiAssistantContext>;
+    contexts: Record<string, AiAssistantContextMetadata>;
 };
-export type AiAssistantContext = {
+export type AiAssistantContextMetadata = {
     title: string;
     text: string;
     preview: boolean;

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

@@ -1,6 +1,7 @@
 import { Observable } from 'rxjs';
 import { DocumentData, FieldName, PrimitiveFieldType } from '../document.types';
 import { Operator } from '../query.types';
+import { SerializedQuery } from './serialized-query.types';
 export interface SnapshotEmitter<ReturnType> {
     /**
      * Returns a promise that resolves to the query results.
@@ -24,6 +25,7 @@ export interface SnapshotEmitter<ReturnType> {
      * @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> {

package/dist/common/src/query/index.d.ts

@@ -1,2 +1,3 @@
 export * from './query-context';
 export * from './base-query-builder';
+export * from './serialized-query.types';

package/dist/common/src/query/serialized-query.types.d.ts

@@ -0,0 +1,24 @@
+import { DocumentData } from '../document.types';
+import { Query, Alias, JoinCondition } from '../query.types';
+export type SerializedSimpleQuery = {
+    type: 'simple';
+    query: Query;
+    dereference: boolean;
+};
+export type SerializedJoinQuery = {
+    type: 'join';
+    grouped: boolean;
+    dereference: boolean;
+    root: {
+        alias: Alias;
+        query: Query;
+    };
+    leftToRight: Record<Alias, Alias[]>;
+    joins: Record<Alias, Query<DocumentData>>;
+    joinConditions: Record<Alias, JoinCondition>;
+};
+export type SerializedMergedQuery = {
+    type: 'merged';
+    queries: Array<SerializedQuery>;
+};
+export type SerializedQuery = SerializedSimpleQuery | SerializedJoinQuery | SerializedMergedQuery;

package/dist/common/src/query.types.d.ts

@@ -1,6 +1,20 @@
 import { ClientRequestId } from './communication.types';
 import { CollectionName, DocumentData, FieldName } from './document.types';
 import { Paths } from './types';
+/**
+ * An alias for a join result. This is used to disambiguate fields in the result.
+ */
+export type Alias = string;
+/**
+ * A join condition.
+ * The join conditions defines the alias for the left side of the join and the field names to join on.
+ */
+export interface JoinCondition {
+    leftAlias: Alias;
+    left: FieldName;
+    right: FieldName;
+    isInner: boolean;
+}
 /** A list of query conditions. */
 export type Condition<Doc extends DocumentData = any> = SimpleCondition<Doc> | CompositeCondition<Doc>;
 export type Conditions<Doc extends DocumentData = any> = Array<Condition<Doc>>;

package/dist/common/src/utils/nullish.d.ts

@@ -1 +1,2 @@
 export declare function isNotNullish<T>(t: T | undefined | null): t is T;
+export declare function isString(t: unknown): t is string;