@squidcloud/client 1.0.86 → 1.0.87

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

@@ -1,125 +1,125 @@
-import { BaseQueryBuilder, DocumentData, FieldName, HasDereference, Operator, Pagination, PaginationOptions, PrimitiveFieldType, 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]>;
-};
-type Grouped<Aliases extends Record<Alias, Alias[]>, ReturnType extends Record<Alias, any>, RootAlias extends Alias> = Aliases[RootAlias] extends [] ? Required<ReturnType>[RootAlias] : Record<RootAlias, Required<ReturnType>[RootAlias]> & OtherGroups<Aliases, ReturnType, Aliases[RootAlias]>;
-type OtherGroups<Aliases extends Record<Alias, Alias[]>, ReturnType extends Record<Alias, any>, ManyRootAliases extends Alias[]> = ManyRootAliases extends [infer First extends Alias, ...infer Rest extends Alias[]] ? Record<First, Array<Grouped<Aliases, ReturnType, First>>> & OtherGroups<Aliases, ReturnType, Rest> : Record<Alias, never>;
-interface HasGrouped {
-    /**
-     * Transforms this join query result to a nested data structure. For example, a join between teachers and students
-     * normally returns a result of the form:
-     *   [
-     *     { teacher: {name: 'Mr. Smith'}, student: {name: 'John Doe'} },
-     *     { teacher: {name: 'Mr. Smith'}, student: {name: 'Jane Smith'} },
-     *     { teacher: {name: 'Mr. EmptyClass'}, student: undefined },
-     *   ]
-     * into a result of the form:
-     *   [
-     *    { teacher: {name: 'Mr. Smith'}, students: [
-     *      { name: 'John Doe' },
-     *      { name: 'Jane Smith' },
-     *    ]},
-     *    { teacher: {name: 'Mr. EmptyClass'}, students: [] },
-     *   ]
-     */
-    grouped(): any;
-}
-/**
- * A query builder that can participate in a join.
- * To learn more about join queries, see
- * {@link https://docs.squid.cloud/docs/client-sdk/queries#joining-data-across-collections-and-integrations}.
- */
-export declare class JoinQueryBuilder<Aliases extends Record<Alias, Alias[]>, ReturnType extends Record<Alias, DocumentData>, LatestAlias extends Alias, RootAlias extends Alias> extends BaseQueryBuilder<ReturnType> implements SnapshotEmitter<WithDocumentReferences<ReturnType>>, HasGrouped, HasDereference {
-    private readonly collectionName;
-    private readonly integrationId;
-    private readonly querySubscriptionManager;
-    private readonly documentReferenceFactory;
-    private readonly queryBuilderFactory;
-    private readonly latestAlias;
-    private readonly joins;
-    private readonly joinConditions;
-    private readonly queryBuilder;
-    /**
-     * 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
-     */
-    where(fieldName: (keyof ReturnType[LatestAlias] & FieldName) | string, operator: Operator | 'in' | 'not in', value: PrimitiveFieldType | Array<PrimitiveFieldType>): 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 maximum number of results to return
-     * @returns The query builder
-     */
-    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
-     */
-    sortBy(fieldName: keyof ReturnType[RootAlias] & FieldName, asc?: boolean): this;
-    /**
-     * Joins this query with another join query and return a new query builder that can be used to query the joined
-     * documents.
-     * @param queryBuilder The query builder to join with
-     * @param alias TODO
-     * @param joinFields TODO
-     * @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: {
-        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: {
-        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>;
-    /** @inheritDoc */
-    snapshot(): Promise<Array<WithDocumentReferences<ReturnType>>>;
-    /** @inheritDoc */
-    snapshots(subscribe?: boolean): Observable<Array<WithDocumentReferences<ReturnType>>>;
-    /** @inheritDoc */
-    grouped(): GroupedJoin<Aliases, ReturnType, RootAlias, LatestAlias>;
-    /** @inheritDoc */
-    dereference(): DereferencedJoin<Aliases, ReturnType, RootAlias, LatestAlias>;
-    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 {
-    private readonly joinQueryBuilder;
-    constructor(joinQueryBuilder: JoinQueryBuilder<Aliases, ReturnType, LatestAlias, RootAlias>);
-    /** @inheritDoc */
-    grouped(): SnapshotEmitter<Grouped<Aliases, ReturnType, RootAlias>>;
-    /** @inheritDoc */
-    snapshot(): Promise<Array<ReturnType>>;
-    /** @inheritDoc */
-    snapshots(subscribe?: boolean): Observable<Array<ReturnType>>;
-    paginate(options?: Partial<PaginationOptions>): Pagination<ReturnType>;
-}
-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>;
-    /** internal */
-    constructor(joinQueryBuilder: JoinQueryBuilder<Aliases, ReturnType, LatestAlias, RootAlias>);
-    /** @inheritDoc */
-    snapshot(): Promise<Array<Grouped<Aliases, WithDocumentReferences<ReturnType>, RootAlias>>>;
-    /** @inheritDoc */
-    snapshots(subscribe?: boolean): Observable<Array<Grouped<Aliases, WithDocumentReferences<ReturnType>, RootAlias>>>;
-    /** @inheritDoc */
-    dereference(): SnapshotEmitter<Grouped<Aliases, ReturnType, RootAlias>>;
-    private groupData;
-    paginate(options?: Partial<PaginationOptions>): Pagination<Grouped<Aliases, WithDocumentReferences<ReturnType>, RootAlias>>;
-}
-export {};
+import { BaseQueryBuilder, DocumentData, FieldName, HasDereference, Operator, Pagination, PaginationOptions, PrimitiveFieldType, 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]>;
+};
+type Grouped<Aliases extends Record<Alias, Alias[]>, ReturnType extends Record<Alias, any>, RootAlias extends Alias> = Aliases[RootAlias] extends [] ? Required<ReturnType>[RootAlias] : Record<RootAlias, Required<ReturnType>[RootAlias]> & OtherGroups<Aliases, ReturnType, Aliases[RootAlias]>;
+type OtherGroups<Aliases extends Record<Alias, Alias[]>, ReturnType extends Record<Alias, any>, ManyRootAliases extends Alias[]> = ManyRootAliases extends [infer First extends Alias, ...infer Rest extends Alias[]] ? Record<First, Array<Grouped<Aliases, ReturnType, First>>> & OtherGroups<Aliases, ReturnType, Rest> : Record<Alias, never>;
+interface HasGrouped {
+    /**
+     * Transforms this join query result to a nested data structure. For example, a join between teachers and students
+     * normally returns a result of the form:
+     *   [
+     *     { teacher: {name: 'Mr. Smith'}, student: {name: 'John Doe'} },
+     *     { teacher: {name: 'Mr. Smith'}, student: {name: 'Jane Smith'} },
+     *     { teacher: {name: 'Mr. EmptyClass'}, student: undefined },
+     *   ]
+     * into a result of the form:
+     *   [
+     *    { teacher: {name: 'Mr. Smith'}, students: [
+     *      { name: 'John Doe' },
+     *      { name: 'Jane Smith' },
+     *    ]},
+     *    { teacher: {name: 'Mr. EmptyClass'}, students: [] },
+     *   ]
+     */
+    grouped(): any;
+}
+/**
+ * A query builder that can participate in a join.
+ * To learn more about join queries, see
+ * {@link https://docs.squid.cloud/docs/client-sdk/queries#joining-data-across-collections-and-integrations}.
+ */
+export declare class JoinQueryBuilder<Aliases extends Record<Alias, Alias[]>, ReturnType extends Record<Alias, DocumentData>, LatestAlias extends Alias, RootAlias extends Alias> extends BaseQueryBuilder<ReturnType> implements SnapshotEmitter<WithDocumentReferences<ReturnType>>, HasGrouped, HasDereference {
+    private readonly collectionName;
+    private readonly integrationId;
+    private readonly querySubscriptionManager;
+    private readonly documentReferenceFactory;
+    private readonly queryBuilderFactory;
+    private readonly latestAlias;
+    private readonly joins;
+    private readonly joinConditions;
+    private readonly queryBuilder;
+    /**
+     * 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
+     */
+    where(fieldName: (keyof ReturnType[LatestAlias] & FieldName) | string, operator: Operator | 'in' | 'not in', value: PrimitiveFieldType | Array<PrimitiveFieldType>): 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 maximum number of results to return
+     * @returns The query builder
+     */
+    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
+     */
+    sortBy(fieldName: keyof ReturnType[RootAlias] & FieldName, asc?: boolean): this;
+    /**
+     * Joins this query with another join query and return a new query builder that can be used to query the joined
+     * documents.
+     * @param queryBuilder The query builder to join with
+     * @param alias TODO
+     * @param joinFields TODO
+     * @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: {
+        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: {
+        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>;
+    /** @inheritDoc */
+    snapshot(): Promise<Array<WithDocumentReferences<ReturnType>>>;
+    /** @inheritDoc */
+    snapshots(subscribe?: boolean): Observable<Array<WithDocumentReferences<ReturnType>>>;
+    /** @inheritDoc */
+    grouped(): GroupedJoin<Aliases, ReturnType, RootAlias, LatestAlias>;
+    /** @inheritDoc */
+    dereference(): DereferencedJoin<Aliases, ReturnType, RootAlias, LatestAlias>;
+    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 {
+    private readonly joinQueryBuilder;
+    constructor(joinQueryBuilder: JoinQueryBuilder<Aliases, ReturnType, LatestAlias, RootAlias>);
+    /** @inheritDoc */
+    grouped(): SnapshotEmitter<Grouped<Aliases, ReturnType, RootAlias>>;
+    /** @inheritDoc */
+    snapshot(): Promise<Array<ReturnType>>;
+    /** @inheritDoc */
+    snapshots(subscribe?: boolean): Observable<Array<ReturnType>>;
+    paginate(options?: Partial<PaginationOptions>): Pagination<ReturnType>;
+}
+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>;
+    /** internal */
+    constructor(joinQueryBuilder: JoinQueryBuilder<Aliases, ReturnType, LatestAlias, RootAlias>);
+    /** @inheritDoc */
+    snapshot(): Promise<Array<Grouped<Aliases, WithDocumentReferences<ReturnType>, RootAlias>>>;
+    /** @inheritDoc */
+    snapshots(subscribe?: boolean): Observable<Array<Grouped<Aliases, WithDocumentReferences<ReturnType>, RootAlias>>>;
+    /** @inheritDoc */
+    dereference(): SnapshotEmitter<Grouped<Aliases, ReturnType, RootAlias>>;
+    private groupData;
+    paginate(options?: Partial<PaginationOptions>): Pagination<Grouped<Aliases, WithDocumentReferences<ReturnType>, RootAlias>>;
+}
+export {};

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

@@ -1,64 +1,64 @@
-import { BaseQueryBuilder, DocumentData, FieldName, FieldSort, HasDereference, Operator, Pagination, PaginationOptions, PrimitiveFieldType, 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. */
-export declare class QueryBuilder<DocumentType extends DocumentData> extends BaseQueryBuilder<DocumentType> implements SnapshotEmitter<DocumentReference<DocumentType>>, HasDereference {
-    private readonly collectionName;
-    private readonly integrationId;
-    private readonly querySubscriptionManager;
-    private readonly documentReferenceFactory;
-    private readonly queryBuilderFactory;
-    private readonly documentIdentityService;
-    private forceFetchFromServer;
-    /** @inheritDoc */
-    where(fieldName: (keyof DocumentType & FieldName) | string, operator: Operator | 'in' | 'not in', value: PrimitiveFieldType | Array<PrimitiveFieldType>): this;
-    /** @inheritDoc */
-    limit(limit: number): this;
-    /** @inheritDoc */
-    sortBy(fieldName: keyof DocumentType & FieldName, asc?: boolean): this;
-    private mergeConditions;
-    getSortOrder(): FieldSort<DocumentType>[];
-    /**
-     * @inheritDoc
-     */
-    snapshot(): Promise<Array<DocumentReference<DocumentType>>>;
-    /**
-     * Forces the query to return data from the server even if there is a query that already returned the requested
-     * result.
-     */
-    setForceFetchFromServer(): this;
-    /**
-     * @inheritDoc
-     */
-    snapshots(subscribe?: boolean): Observable<Array<DocumentReference<DocumentType>>>;
-    /**
-     * @inheritDoc
-     */
-    changes(): Observable<Changes<DocumentType>>;
-    /**
-     * A unique hash for the query. Identical queries should return the same hash
-     * value.
-     *
-     * @returns The query's hash string.
-     */
-    get hash(): string;
-    /** @inheritDoc */
-    dereference(): SnapshotEmitter<DocumentType>;
-    paginate(options?: Partial<PaginationOptions>): Pagination<DocumentReference<DocumentType>>;
-}
-/** Describes the changes to a query result. */
-export declare class Changes<DocumentType extends DocumentData> {
-    /** The newly inserted documents to the query result */
-    readonly inserts: Array<DocumentReference<DocumentType>>;
-    /** The documents that were updated in the query result */
-    readonly updates: Array<DocumentReference<DocumentType>>;
-    /** The actual document data that was deleted from the query result */
-    readonly deletes: Array<DocumentType>;
-    constructor(
-    /** The newly inserted documents to the query result */
-    inserts: Array<DocumentReference<DocumentType>>, 
-    /** The documents that were updated in the query result */
-    updates: Array<DocumentReference<DocumentType>>, 
-    /** The actual document data that was deleted from the query result */
-    deletes: Array<DocumentType>);
-}
+import { BaseQueryBuilder, DocumentData, FieldName, FieldSort, HasDereference, Operator, Pagination, PaginationOptions, PrimitiveFieldType, 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. */
+export declare class QueryBuilder<DocumentType extends DocumentData> extends BaseQueryBuilder<DocumentType> implements SnapshotEmitter<DocumentReference<DocumentType>>, HasDereference {
+    private readonly collectionName;
+    private readonly integrationId;
+    private readonly querySubscriptionManager;
+    private readonly documentReferenceFactory;
+    private readonly queryBuilderFactory;
+    private readonly documentIdentityService;
+    private forceFetchFromServer;
+    /** @inheritDoc */
+    where(fieldName: (keyof DocumentType & FieldName) | string, operator: Operator | 'in' | 'not in', value: PrimitiveFieldType | Array<PrimitiveFieldType>): this;
+    /** @inheritDoc */
+    limit(limit: number): this;
+    /** @inheritDoc */
+    sortBy(fieldName: keyof DocumentType & FieldName, asc?: boolean): this;
+    private mergeConditions;
+    getSortOrder(): FieldSort<DocumentType>[];
+    /**
+     * @inheritDoc
+     */
+    snapshot(): Promise<Array<DocumentReference<DocumentType>>>;
+    /**
+     * Forces the query to return data from the server even if there is a query that already returned the requested
+     * result.
+     */
+    setForceFetchFromServer(): this;
+    /**
+     * @inheritDoc
+     */
+    snapshots(subscribe?: boolean): Observable<Array<DocumentReference<DocumentType>>>;
+    /**
+     * @inheritDoc
+     */
+    changes(): Observable<Changes<DocumentType>>;
+    /**
+     * A unique hash for the query. Identical queries should return the same hash
+     * value.
+     *
+     * @returns The query's hash string.
+     */
+    get hash(): string;
+    /** @inheritDoc */
+    dereference(): SnapshotEmitter<DocumentType>;
+    paginate(options?: Partial<PaginationOptions>): Pagination<DocumentReference<DocumentType>>;
+}
+/** Describes the changes to a query result. */
+export declare class Changes<DocumentType extends DocumentData> {
+    /** The newly inserted documents to the query result */
+    readonly inserts: Array<DocumentReference<DocumentType>>;
+    /** The documents that were updated in the query result */
+    readonly updates: Array<DocumentReference<DocumentType>>;
+    /** The actual document data that was deleted from the query result */
+    readonly deletes: Array<DocumentType>;
+    constructor(
+    /** The newly inserted documents to the query result */
+    inserts: Array<DocumentReference<DocumentType>>, 
+    /** The documents that were updated in the query result */
+    updates: Array<DocumentReference<DocumentType>>, 
+    /** The actual document data that was deleted from the query result */
+    deletes: Array<DocumentType>);
+}