@squidcloud/client 1.0.147 → 1.0.149

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

@@ -1,147 +1,147 @@
-import { Observable } from 'rxjs';
-import { DocumentData, FieldName, PrimitiveFieldType } from '../document.types';
-import { Operator } from '../query.types';
-import { SerializedQuery } from './serialized-query.types';
-import { PaginationOptions, Pagination } from './pagination';
-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;
-}
+import { Observable } from 'rxjs';
+import { DocumentData, FieldName, PrimitiveFieldType } from '../document.types';
+import { Operator } from '../query.types';
+import { SerializedQuery } from './serialized-query.types';
+import { PaginationOptions, Pagination } from './pagination';
+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/common/src/query/index.d.ts

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

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

@@ -1,62 +1,62 @@
-import { Observable } from 'rxjs';
-/** The state of a pagination. */
-export interface PaginationState<ReturnType> {
-    /** The page data. */
-    data: Array<ReturnType>;
-    /** Whether there is a next page. */
-    hasNext: boolean;
-    /** Whether there is a previous page. */
-    hasPrev: boolean;
-}
-/** Pagination options */
-export interface PaginationOptions {
-    /** Whether to show real-time updates. Defaults to true. */
-    subscribe: boolean;
-    /** The number of items in a page. Defaults to 100. */
-    pageSize: number;
-}
-interface InternalState<ReturnType> {
-    data: ReturnType[];
-    extractedData: any[];
-    numBefore: number;
-    numAfter: number;
-}
-export declare class Pagination<ReturnType> {
-    private readonly options;
-    private internalStateObserver;
-    private firstElement;
-    private readonly isDestroyed;
-    private templateSnapshotEmitter;
-    private snapshotSubject;
-    private onFirstPage;
-    private navigatingToLastPage;
-    private lastElement;
-    private goToFirstPage;
-    private static compareValues;
-    private compare;
-    private dataReceived;
-    private doNewQuery;
-    private waitForInternalState;
-    private internalStateToState;
-    /** Unsubscribes from the pagination. */
-    unsubscribe(): void;
-    prevInternal(internalState: InternalState<ReturnType>): void;
-    /** Returns a promise that resolves when the previous page of data is available. */
-    prev(): Promise<PaginationState<ReturnType>>;
-    /** Returns a promise that resolves when the next page of data is available. */
-    next(): Promise<PaginationState<ReturnType>>;
-    /** Returns a promise that resolves when the page data is available. */
-    waitForData(): Promise<PaginationState<ReturnType>>;
-    /** Returns an observable that emits the current state of the pagination. */
-    observeState(): Observable<PaginationState<ReturnType>>;
-    /** Jumps to the first page of the pagination. */
-    first(): Promise<PaginationState<ReturnType>>;
-    /** Refreshes the current page of the pagination. */
-    refreshPage(): Promise<PaginationState<ReturnType>>;
-    /**
-     * Jumps to the last page of the pagination. This page will always have the last <pageSize> elements of the
-     * underlying query, regardless of whether the total document count is evenly divisible by the page size.
-     */
-    last(): Promise<PaginationState<ReturnType>>;
-}
-export {};
+import { Observable } from 'rxjs';
+/** The state of a pagination. */
+export interface PaginationState<ReturnType> {
+    /** The page data. */
+    data: Array<ReturnType>;
+    /** Whether there is a next page. */
+    hasNext: boolean;
+    /** Whether there is a previous page. */
+    hasPrev: boolean;
+}
+/** Pagination options */
+export interface PaginationOptions {
+    /** Whether to show real-time updates. Defaults to true. */
+    subscribe: boolean;
+    /** The number of items in a page. Defaults to 100. */
+    pageSize: number;
+}
+interface InternalState<ReturnType> {
+    data: ReturnType[];
+    extractedData: any[];
+    numBefore: number;
+    numAfter: number;
+}
+export declare class Pagination<ReturnType> {
+    private readonly options;
+    private internalStateObserver;
+    private firstElement;
+    private readonly isDestroyed;
+    private templateSnapshotEmitter;
+    private snapshotSubject;
+    private onFirstPage;
+    private navigatingToLastPage;
+    private lastElement;
+    private goToFirstPage;
+    private static compareValues;
+    private compare;
+    private dataReceived;
+    private doNewQuery;
+    private waitForInternalState;
+    private internalStateToState;
+    /** Unsubscribes from the pagination. */
+    unsubscribe(): void;
+    prevInternal(internalState: InternalState<ReturnType>): void;
+    /** Returns a promise that resolves when the previous page of data is available. */
+    prev(): Promise<PaginationState<ReturnType>>;
+    /** Returns a promise that resolves when the next page of data is available. */
+    next(): Promise<PaginationState<ReturnType>>;
+    /** Returns a promise that resolves when the page data is available. */
+    waitForData(): Promise<PaginationState<ReturnType>>;
+    /** Returns an observable that emits the current state of the pagination. */
+    observeState(): Observable<PaginationState<ReturnType>>;
+    /** Jumps to the first page of the pagination. */
+    first(): Promise<PaginationState<ReturnType>>;
+    /** Refreshes the current page of the pagination. */
+    refreshPage(): Promise<PaginationState<ReturnType>>;
+    /**
+     * Jumps to the last page of the pagination. This page will always have the last <pageSize> elements of the
+     * underlying query, regardless of whether the total document count is evenly divisible by the page size.
+     */
+    last(): Promise<PaginationState<ReturnType>>;
+}
+export {};