@squidcloud/backend 1.0.4 → 1.0.5

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

@@ -1,6 +1,7 @@
 import { DocId, DocIdObj, DocumentData, IdResolutionMap, IntegrationId } from '@squidcloud/common';
 import { DocumentReference } from './document-reference';
 import { DocumentReferenceFactory } from './document-reference.factory';
+import { JoinQueryBuilder, JoinQueryBuilderFactory } from './query/join-query-builder.factory';
 import { QueryBuilder, QueryBuilderFactory } from './query/query-builder.factory';
 import { Alias } from './query/query.types';
 export declare class CollectionReference<T extends DocumentData> {
@@ -8,10 +9,11 @@ export declare class CollectionReference<T extends DocumentData> {
     private integrationId;
     private readonly documentReferenceFactory;
     private readonly queryBuilderFactory;
+    private readonly joinQueryBuilderFactory;
     private readonly documents;
-    constructor(collectionName: string, integrationId: IntegrationId, documentReferenceFactory: DocumentReferenceFactory, queryBuilderFactory: QueryBuilderFactory);
+    constructor(collectionName: string, integrationId: IntegrationId, documentReferenceFactory: DocumentReferenceFactory, queryBuilderFactory: QueryBuilderFactory, joinQueryBuilderFactory: JoinQueryBuilderFactory);
     doc(docId?: DocId | DocIdObj): DocumentReference<T>;
-    query(): Omit<QueryBuilder<T, any, Record<Alias, DocumentReference<T>>, false>, 'join'>;
-    joinQuery<A extends Alias>(alias: A): QueryBuilder<T, A, Record<A, DocumentReference<T>>, true>;
+    query(): QueryBuilder<T>;
+    joinQuery<A extends Alias>(alias: A): JoinQueryBuilder<T, A, Record<A, DocumentReference<T>>>;
     migrateDocIds(idResolutionMap: IdResolutionMap): void;
 }

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

@@ -2,13 +2,15 @@ import { CollectionName, DocumentData, IntegrationId } from '@squidcloud/common'
 import { CollectionReference } from './collection-reference';
 import DocumentIdentityService from './document-identity.service';
 import { DocumentReferenceFactory } from './document-reference.factory';
+import { JoinQueryBuilderFactory } from './query/join-query-builder.factory';
 import { QueryBuilderFactory } from './query/query-builder.factory';
 export declare class CollectionReferenceFactory {
     private readonly documentReferenceFactory;
     private readonly queryBuilderFactory;
+    private readonly joinQueryBuilderFactory;
     private readonly documentIdentityService;
     private readonly collections;
-    constructor(documentReferenceFactory: DocumentReferenceFactory, queryBuilderFactory: QueryBuilderFactory, documentIdentityService: DocumentIdentityService);
+    constructor(documentReferenceFactory: DocumentReferenceFactory, queryBuilderFactory: QueryBuilderFactory, joinQueryBuilderFactory: JoinQueryBuilderFactory, documentIdentityService: DocumentIdentityService);
     get<T extends DocumentData>(collectionName: CollectionName, integrationId: IntegrationId): CollectionReference<T>;
     private migrateDocIds;
 }

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

@@ -1,4 +1,5 @@
 import { DocumentData, IdResolutionMap, Paths, SquidDocId } from '@squidcloud/common';
+import { Observable } from 'rxjs';
 import { DataManager } from './data.manager';
 import { QueryBuilderFactory } from './query/query-builder.factory';
 import { TransactionId } from './types';
@@ -9,7 +10,8 @@ export declare class DocumentReference<T extends DocumentData = any> {
     constructor(_squidDocId: SquidDocId, dataManager: DataManager, queryBuilderFactory: QueryBuilderFactory);
     get squidDocId(): SquidDocId;
     data(): T;
-    get(): Promise<DocumentReference<T> | undefined>;
+    snapshot(): Promise<DocumentReference<T> | undefined>;
+    snapshots(): Observable<DocumentReference<T> | undefined>;
     isDirty(): boolean;
     private isTracked;
     update(data: Partial<Record<Paths<T>, any>>, transactionId?: TransactionId): Promise<void>;

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

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

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

@@ -0,0 +1,35 @@
+import { CollectionName, DocumentData, FieldName, IntegrationId, Operator, PrimitiveFieldType, Query } from '@squidcloud/common';
+import { Observable } from 'rxjs';
+import { DocumentReference } from '../document-reference';
+import { DocumentReferenceFactory } from '../document-reference.factory';
+import { QueryBuilderFactory } from './query-builder.factory';
+import { QuerySubscriptionManager } from './query-subscription.manager';
+import { Alias } from './query.types';
+export declare class JoinQueryBuilderFactory {
+    private readonly querySubscriptionManager;
+    private readonly documentReferenceFactory;
+    private readonly queryBuilderFactory;
+    constructor(querySubscriptionManager: QuerySubscriptionManager, documentReferenceFactory: DocumentReferenceFactory, queryBuilderFactory: QueryBuilderFactory);
+    getForJoin<DocumentType extends DocumentData, MyAlias extends Alias, ReturnType extends Record<MyAlias, DocumentReference<DocumentType>>>(collectionName: CollectionName, integrationId: IntegrationId, alias: MyAlias): JoinQueryBuilder<DocumentType, MyAlias, ReturnType>;
+}
+export declare class JoinQueryBuilder<DocumentType extends DocumentData, MyAlias extends Alias, ReturnType extends Record<MyAlias, DocumentReference<DocumentType> | undefined>> {
+    private readonly collectionName;
+    private readonly integrationId;
+    private readonly querySubscriptionManager;
+    private readonly documentReferenceFactory;
+    private readonly alias;
+    private readonly joinQueryBuilderFactory;
+    private readonly queryBuilderFactory;
+    private readonly simpleQueryBuilder;
+    private readonly joins;
+    /** Record that maps the right alias to the left condition */
+    private readonly joinConditions;
+    constructor(collectionName: CollectionName, integrationId: IntegrationId, querySubscriptionManager: QuerySubscriptionManager, documentReferenceFactory: DocumentReferenceFactory, alias: MyAlias, joinQueryBuilderFactory: JoinQueryBuilderFactory, queryBuilderFactory: QueryBuilderFactory);
+    where(fieldName: (keyof DocumentType & FieldName) | string, operator: Operator | 'in' | 'not in', value: PrimitiveFieldType | Array<PrimitiveFieldType>): this;
+    limit(limit: number): this;
+    sortBy(fieldName: keyof DocumentType & FieldName, asc?: boolean): this;
+    join<J extends DocumentData, RightAlias extends Alias, RightReturnType extends Record<RightAlias, DocumentReference<J> | undefined>>(queryBuilder: JoinQueryBuilder<J, RightAlias, RightReturnType>, leftFieldName: keyof DocumentType & FieldName, rightFieldName: keyof J & FieldName): JoinQueryBuilder<DocumentType, MyAlias, ReturnType & Partial<RightReturnType>>;
+    snapshot(): Promise<Array<ReturnType>>;
+    snapshots(subscribe?: boolean): Observable<Array<ReturnType>>;
+    build(): Query;
+}

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

@@ -4,38 +4,31 @@ import DocumentIdentityService from '../document-identity.service';
 import { DocumentReference } from '../document-reference';
 import { DocumentReferenceFactory } from '../document-reference.factory';
 import { QuerySubscriptionManager } from './query-subscription.manager';
-import { Alias } from './query.types';
 export declare class QueryBuilderFactory {
     private readonly querySubscriptionManager;
     private readonly documentReferenceFactory;
     private readonly documentIdentityService;
     constructor(querySubscriptionManager: QuerySubscriptionManager, documentReferenceFactory: DocumentReferenceFactory, documentIdentityService: DocumentIdentityService);
-    getForDocument<DocumentType extends DocumentData, ReturnType extends Record<Alias, DocumentReference<DocumentType>>>(squidDocId: SquidDocId): Omit<QueryBuilder<DocumentType, any, ReturnType, false>, 'join'>;
-    get<DocumentType extends DocumentData, ReturnType extends Record<Alias, DocumentReference<DocumentType>>>(collectionName: CollectionName, integrationId: IntegrationId): Omit<QueryBuilder<DocumentType, any, ReturnType, false>, 'join'>;
-    getForJoin<DocumentType extends DocumentData, MyAlias extends Alias, ReturnType extends Record<MyAlias, DocumentReference<DocumentType>>>(collectionName: CollectionName, integrationId: IntegrationId, alias: MyAlias): QueryBuilder<DocumentType, MyAlias, ReturnType, true>;
+    getForDocument<DocumentType extends DocumentData>(squidDocId: SquidDocId): QueryBuilder<DocumentType>;
+    get<DocumentType extends DocumentData>(collectionName: CollectionName, integrationId: IntegrationId): QueryBuilder<DocumentType>;
 }
-export declare class QueryBuilder<DocumentType extends DocumentData, MyAlias extends Alias, ReturnType extends Record<MyAlias, DocumentReference<DocumentType> | undefined>, SupportsJoin extends boolean> {
+export declare class QueryBuilder<DocumentType extends DocumentData> {
     private readonly collectionName;
     private readonly integrationId;
     private readonly querySubscriptionManager;
     private readonly documentReferenceFactory;
-    private readonly alias;
-    private readonly supportsJoin;
     private readonly queryBuilderFactory;
     private readonly documentIdentityService;
     private readonly simpleQueryBuilder;
-    private readonly joins;
-    /** Record that maps the right alias to the left condition */
-    private readonly joinConditions;
-    constructor(collectionName: CollectionName, integrationId: IntegrationId, querySubscriptionManager: QuerySubscriptionManager, documentReferenceFactory: DocumentReferenceFactory, alias: MyAlias, supportsJoin: SupportsJoin, queryBuilderFactory: QueryBuilderFactory, documentIdentityService: DocumentIdentityService);
-    where(fieldName: (keyof DocumentType & FieldName) | string, operator: Operator | 'in' | 'not in', value: PrimitiveFieldType | Array<PrimitiveFieldType>): SupportsJoin extends true ? this : Omit<this, 'join'>;
-    limit(limit: number): SupportsJoin extends true ? this : Omit<this, 'join'>;
-    sortBy(fieldName: keyof DocumentType & FieldName, asc?: boolean): SupportsJoin extends true ? this : Omit<this, 'join'>;
-    join<J extends DocumentData, RightAlias extends Alias, RightReturnType extends Record<RightAlias, DocumentReference<J> | undefined>>(queryBuilder: QueryBuilder<J, RightAlias, RightReturnType, true>, leftFieldName: keyof DocumentType & FieldName, rightFieldName: keyof J & FieldName): QueryBuilder<DocumentType, MyAlias, ReturnType & Partial<RightReturnType>, true>;
-    snapshot(): SupportsJoin extends true ? Promise<Array<ReturnType>> : Promise<Array<DocumentReference<DocumentType>>>;
-    snapshots(subscribe?: boolean): SupportsJoin extends true ? Observable<Array<ReturnType>> : Observable<Array<DocumentReference<DocumentType>>>;
+    constructor(collectionName: CollectionName, integrationId: IntegrationId, querySubscriptionManager: QuerySubscriptionManager, documentReferenceFactory: DocumentReferenceFactory, queryBuilderFactory: QueryBuilderFactory, documentIdentityService: DocumentIdentityService);
+    where(fieldName: (keyof DocumentType & FieldName) | string, operator: Operator | 'in' | 'not in', value: PrimitiveFieldType | Array<PrimitiveFieldType>): this;
+    limit(limit: number): this;
+    sortBy(fieldName: keyof DocumentType & FieldName, asc?: boolean): this;
+    snapshot(): Promise<Array<DocumentReference<DocumentType>>>;
+    snapshots(subscribe?: boolean): Observable<Array<DocumentReference<DocumentType>>>;
     changes(): Observable<Changes<DocumentType>>;
     build(): Query;
+    get hash(): string;
 }
 export interface Changes<DocumentType extends DocumentData> {
     inserts: Array<DocumentReference<DocumentType>>;

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

@@ -20,6 +20,7 @@ export declare class Squid {
     private readonly lockManager;
     private readonly querySubscriptionManager;
     private readonly queryBuilderFactory;
+    private readonly joinQueryBuilderFactory;
     private readonly collectionReferenceFactory;
     private readonly backendFunctionManager;
     private readonly namedQueryManager;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squidcloud/backend",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "Squid Cloud's backend SDK",
   "main": "dist/index.js",
   "types": "dist/backend/src/index.d.ts",