@squidcloud/client 1.0.87 → 1.0.89

package/dist/typescript-client/src/ai-assistant-client.d.ts

@@ -1,4 +1,4 @@
-import { IntegrationId, OpenAiModelName } from '@squidcloud/common';
+import { AiAssistantContext, IntegrationId, OpenAiModelName } from '@squidcloud/common';
 import { Observable } from 'rxjs';
 import { RpcManager } from './rpc.manager';
 import { SocketManager } from './socket.manager';
@@ -105,7 +105,7 @@ declare class AiAssistantContextReference {
      */
     insert(data: {
         title: string;
-        context: string;
+        context: AiAssistantContext;
     }): Promise<void>;
     /**
      * Updates an existing context entry on the assistant profile. This will result in an error if an entry has not yet
@@ -118,7 +118,7 @@ declare class AiAssistantContextReference {
      */
     update(data: {
         title?: string;
-        context?: string;
+        context?: AiAssistantContext;
     }): Promise<void>;
     /**
      * Deletes an existing context entry on the assistant profile. This will result in an error if an entry has not yet

package/dist/typescript-client/src/collection-reference.d.ts

@@ -1,8 +1,7 @@
-import { DocId, DocIdObj, DocumentData, SnapshotEmitter } from '@squidcloud/common';
+import { Alias, DocId, DocIdObj, DocumentData, SnapshotEmitter } from '@squidcloud/common';
 import { DocumentReference } from './document-reference';
 import { JoinQueryBuilder } from './query/join-query-builder.factory';
 import { QueryBuilder } from './query/query-builder.factory';
-import { Alias } from './query/query.types';
 /**
  *  Holds a reference to a data collection. a collection reference is a reference to a collection in a database. You
  * can

package/dist/typescript-client/src/index.d.ts

@@ -2,7 +2,7 @@ export { CollectionReference } from './collection-reference';
 export { DocumentReference } from './document-reference';
 export { JoinQueryBuilder } from './query/join-query-builder.factory';
 export { Changes, QueryBuilder } from './query/query-builder.factory';
-export { Alias, JoinCondition } from './query/query.types';
+export { deserializeQuery } from './query/deserializer';
 export { Squid, SquidOptions } from './squid';
 export { TransactionId } from './types';
 export { GraphQLClient } from './graphql-client';

package/dist/typescript-client/src/query/deserializer.d.ts

@@ -0,0 +1,3 @@
+import { SerializedQuery, SnapshotEmitter } from '@squidcloud/common';
+import { Squid } from '../squid';
+export declare function deserializeQuery<ReturnType = any>(squid: Squid, serializedQuery: SerializedQuery): SnapshotEmitter<ReturnType>;

package/dist/typescript-client/src/query/join-query-builder.factory.d.ts

@@ -1,9 +1,7 @@
-import { BaseQueryBuilder, DocumentData, FieldName, HasDereference, Operator, Pagination, PaginationOptions, PrimitiveFieldType, SnapshotEmitter } from '@squidcloud/common';
+import { Alias, BaseQueryBuilder, DocumentData, FieldName, FieldSort, HasDereference, Operator, Pagination, PaginationOptions, PrimitiveFieldType, SerializedJoinQuery, SimpleCondition, SnapshotEmitter } from '@squidcloud/common';
 import { Observable } from 'rxjs';
 import { DocumentReference } from '../document-reference';
 import { QueryBuilder } from './query-builder.factory';
-import { Alias } from './query.types';
-type SimpleJoinQueryBuilder<Aliases extends Record<Alias, Alias[]>, ReturnType extends Record<Alias, DocumentData>, LatestAlias extends Alias, RootAlias extends Alias> = Pick<JoinQueryBuilder<Aliases, ReturnType, LatestAlias, RootAlias>, 'join' | 'snapshot' | 'snapshots' | 'grouped' | 'dereference'>;
 type WithDocumentReferences<T extends Record<any, DocumentData>> = {
     [k in keyof T]: DocumentReference<Required<T>[k]>;
 };
@@ -61,6 +59,7 @@ export declare class JoinQueryBuilder<Aliases extends Record<Alias, Alias[]>, Re
      * @returns The query builder
      */
     limit(limit: number): this;
+    getLimit(): number;
     /**
      * 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.
@@ -78,16 +77,19 @@ export declare class JoinQueryBuilder<Aliases extends Record<Alias, Alias[]>, Re
      * @param options TODO
      * @returns A new query builder that can be used to query the joined documents
      */
-    join<NewAlias extends string, NewReturnType extends DocumentData, LeftAlias extends Extract<keyof ReturnType, Alias>>(queryBuilder: QueryBuilder<NewReturnType>, alias: Exclude<NewAlias, keyof ReturnType>, joinFields: {
+    join<NewAlias extends string, NewReturnType extends DocumentData, LeftAlias extends Extract<keyof ReturnType, Alias>, IsInner extends boolean = false>(queryBuilder: QueryBuilder<NewReturnType>, alias: Exclude<NewAlias, keyof ReturnType>, joinFields: {
         left: keyof Required<ReturnType>[LeftAlias] & FieldName;
         right: keyof NewReturnType & FieldName;
     }, options: {
         leftAlias: LeftAlias;
-    }): SimpleJoinQueryBuilder<Omit<Aliases, LeftAlias> & Record<LeftAlias, [...Aliases[LeftAlias], NewAlias]> & Record<NewAlias, []>, ReturnType & Partial<Record<NewAlias, NewReturnType>>, NewAlias, RootAlias>;
-    join<NewAlias extends string, NewReturnType extends DocumentData>(queryBuilder: QueryBuilder<NewReturnType>, alias: Exclude<NewAlias, keyof ReturnType>, joinFields: {
+        isInner?: IsInner;
+    }): JoinQueryBuilder<Omit<Aliases, LeftAlias> & Record<LeftAlias, [...Aliases[LeftAlias], NewAlias]> & Record<NewAlias, []>, ReturnType & (IsInner extends true ? Record<NewAlias, NewReturnType> : Partial<Record<NewAlias, NewReturnType>>), NewAlias, RootAlias>;
+    join<NewAlias extends string, NewReturnType extends DocumentData, IsInner extends boolean = false>(queryBuilder: QueryBuilder<NewReturnType>, alias: Exclude<NewAlias, keyof ReturnType>, joinFields: {
         left: keyof Required<ReturnType>[LatestAlias] & FieldName;
         right: keyof NewReturnType & FieldName;
-    }): SimpleJoinQueryBuilder<Omit<Aliases, LatestAlias> & Record<LatestAlias, [...Aliases[LatestAlias], NewAlias]> & Record<NewAlias, []>, ReturnType & Partial<Record<NewAlias, NewReturnType>>, NewAlias, RootAlias>;
+    }, options?: {
+        isInner?: IsInner;
+    }): JoinQueryBuilder<Omit<Aliases, LatestAlias> & Record<LatestAlias, [...Aliases[LatestAlias], NewAlias]> & Record<NewAlias, []>, ReturnType & (IsInner extends true ? Record<NewAlias, NewReturnType> : Partial<Record<NewAlias, NewReturnType>>), NewAlias, RootAlias>;
     /** @inheritDoc */
     snapshot(): Promise<Array<WithDocumentReferences<ReturnType>>>;
     /** @inheritDoc */
@@ -96,6 +98,12 @@ export declare class JoinQueryBuilder<Aliases extends Record<Alias, Alias[]>, Re
     grouped(): GroupedJoin<Aliases, ReturnType, RootAlias, LatestAlias>;
     /** @inheritDoc */
     dereference(): DereferencedJoin<Aliases, ReturnType, RootAlias, LatestAlias>;
+    getSortOrders(): Array<FieldSort<any>>;
+    clone(): JoinQueryBuilder<Aliases, ReturnType, LatestAlias, RootAlias>;
+    addCompositeCondition(conditions: Array<SimpleCondition>): JoinQueryBuilder<Aliases, ReturnType, LatestAlias, RootAlias>;
+    flipSortOrder(): JoinQueryBuilder<Aliases, ReturnType, LatestAlias, RootAlias>;
+    extractData(data: WithDocumentReferences<ReturnType>): any;
+    serialize(): SerializedJoinQuery;
     paginate(options?: Partial<PaginationOptions>): Pagination<WithDocumentReferences<ReturnType>>;
 }
 declare class DereferencedJoin<Aliases extends Record<Alias, Alias[]>, ReturnType extends Record<Alias, DocumentData>, RootAlias extends Alias, LatestAlias extends Alias> implements SnapshotEmitter<ReturnType>, HasGrouped {
@@ -107,7 +115,15 @@ declare class DereferencedJoin<Aliases extends Record<Alias, Alias[]>, ReturnTyp
     snapshot(): Promise<Array<ReturnType>>;
     /** @inheritDoc */
     snapshots(subscribe?: boolean): Observable<Array<ReturnType>>;
+    getSortOrders(): Array<FieldSort<any>>;
+    clone(): DereferencedJoin<Aliases, ReturnType, RootAlias, LatestAlias>;
+    addCompositeCondition(conditions: Array<SimpleCondition>): DereferencedJoin<Aliases, ReturnType, RootAlias, LatestAlias>;
+    flipSortOrder(): DereferencedJoin<Aliases, ReturnType, RootAlias, LatestAlias>;
+    limit(limit: number): DereferencedJoin<Aliases, ReturnType, RootAlias, LatestAlias>;
+    extractData(data: ReturnType): any;
     paginate(options?: Partial<PaginationOptions>): Pagination<ReturnType>;
+    serialize(): SerializedJoinQuery;
+    getLimit(): number;
 }
 declare class GroupedJoin<Aliases extends Record<Alias, Alias[]>, ReturnType extends Record<Alias, DocumentData>, RootAlias extends Alias, LatestAlias extends Alias> implements SnapshotEmitter<Grouped<Aliases, WithDocumentReferences<ReturnType>, RootAlias>>, HasDereference {
     readonly joinQueryBuilder: JoinQueryBuilder<Aliases, ReturnType, LatestAlias, RootAlias>;
@@ -120,6 +136,14 @@ declare class GroupedJoin<Aliases extends Record<Alias, Alias[]>, ReturnType ext
     /** @inheritDoc */
     dereference(): SnapshotEmitter<Grouped<Aliases, ReturnType, RootAlias>>;
     private groupData;
+    getSortOrders(): Array<FieldSort<any>>;
+    clone(): GroupedJoin<Aliases, ReturnType, RootAlias, LatestAlias>;
+    addCompositeCondition(conditions: Array<SimpleCondition>): GroupedJoin<Aliases, ReturnType, RootAlias, LatestAlias>;
+    flipSortOrder(): GroupedJoin<Aliases, ReturnType, RootAlias, LatestAlias>;
+    limit(limit: number): GroupedJoin<Aliases, ReturnType, RootAlias, LatestAlias>;
+    getLimit(): number;
+    extractData(data: Grouped<Aliases, WithDocumentReferences<ReturnType>, RootAlias>): any;
+    serialize(): SerializedJoinQuery;
     paginate(options?: Partial<PaginationOptions>): Pagination<Grouped<Aliases, WithDocumentReferences<ReturnType>, RootAlias>>;
 }
 export {};

package/dist/typescript-client/src/query/query-builder.factory.d.ts

@@ -1,4 +1,4 @@
-import { BaseQueryBuilder, DocumentData, FieldName, FieldSort, HasDereference, Operator, Pagination, PaginationOptions, PrimitiveFieldType, SnapshotEmitter } from '@squidcloud/common';
+import { BaseQueryBuilder, DocumentData, FieldName, FieldSort, HasDereference, Operator, Pagination, PaginationOptions, PrimitiveFieldType, SerializedSimpleQuery, SimpleCondition, SnapshotEmitter } from '@squidcloud/common';
 import { Observable } from 'rxjs';
 import { DocumentReference } from '../document-reference';
 /** A query builder that can be used to build a query that returns a list of documents. */
@@ -14,6 +14,7 @@ export declare class QueryBuilder<DocumentType extends DocumentData> extends Bas
     where(fieldName: (keyof DocumentType & FieldName) | string, operator: Operator | 'in' | 'not in', value: PrimitiveFieldType | Array<PrimitiveFieldType>): this;
     /** @inheritDoc */
     limit(limit: number): this;
+    getLimit(): number;
     /** @inheritDoc */
     sortBy(fieldName: keyof DocumentType & FieldName, asc?: boolean): this;
     private mergeConditions;
@@ -44,6 +45,12 @@ export declare class QueryBuilder<DocumentType extends DocumentData> extends Bas
     get hash(): string;
     /** @inheritDoc */
     dereference(): SnapshotEmitter<DocumentType>;
+    getSortOrders(): Array<FieldSort<any>>;
+    clone(): QueryBuilder<DocumentType>;
+    addCompositeCondition(conditions: Array<SimpleCondition>): QueryBuilder<DocumentType>;
+    flipSortOrder(): QueryBuilder<DocumentType>;
+    serialize(): SerializedSimpleQuery;
+    extractData(data: DocumentReference<DocumentType>): DocumentType;
     paginate(options?: Partial<PaginationOptions>): Pagination<DocumentReference<DocumentType>>;
 }
 /** Describes the changes to a query result. */

package/dist/typescript-client/src/query/query-subscription.manager.d.ts

@@ -1,10 +1,9 @@
-import { ClientRequestId, Query, QuerySubscriptionId, SquidDocId, SquidDocument } from '@squidcloud/common';
+import { Alias, ClientRequestId, JoinCondition, Query, QuerySubscriptionId, SquidDocId, SquidDocument } from '@squidcloud/common';
 import { BehaviorSubject, Observable, Subject } from 'rxjs';
 import { DestructManager } from '../destruct.manager';
 import DocumentIdentityService from '../document-identity.service';
 import { DocumentStore } from '../document-store';
 import { RpcManager } from '../rpc.manager';
-import { Alias, JoinCondition } from './query.types';
 import { ClientIdService } from '../client-id.service';
 export declare class QuerySubscriptionManager {
     private readonly rpcManager;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squidcloud/client",
-  "version": "1.0.87",
+  "version": "1.0.89",
   "description": "A typescript implementation of the Squid client",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",

package/dist/typescript-client/src/query/query.types.d.ts

@@ -1,14 +0,0 @@
-import { FieldName } from '@squidcloud/common';
-/**
- * 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;
-}