@squidcloud/client 1.0.97 → 1.0.99

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

@@ -33,21 +33,27 @@ export declare class DocumentReference<T extends DocumentData = any> {
      */
     get hasData(): boolean;
     /**
-     * Returns a document reference with the latest data from the server or undefined if the document does not exist on
-     * the server.
+     * A promise that resolves with the latest data from the server or undefined if the document does not exist on the
+     * server.
      *
-     * @returns A document reference with the latest data from the server or undefined if the document does not exist on
+     * @returns A promise that resolves with latest data from the server or undefined if the document does not exist on
      * the server.
      */
-    snapshot(): Promise<DocumentReference<T> | undefined>;
+    snapshot(): Promise<T | undefined>;
+    /**
+     * Returns an observable that emits the latest data from the server or undefined if the document is deleted or does
+     * not exist on the server.
+     *
+     * @returns An observable that emits the latest data from the server or undefined if the document is deleted or does
+     * not exist on the server.
+     */
+    snapshots(): Observable<T | undefined>;
     /**
-     * Returns an observable that emits a document reference with the latest data from the server or undefined if the
-     * document is deleted or does not exist on the server.
+     * Returns the data that is currently available on the client or undefined if data has not yet been populated.
      *
-     * @returns An observable that emits a document reference with the latest data from the server or undefined if the
-     * document is deleted or does not exist on the server.
+     * @returns The data that is currently available on the client or undefined if data has not yet been populated.
      */
-    snapshots(): Observable<DocumentReference<T> | undefined>;
+    peek(): T | undefined;
     /**
      * Returns whether the locally available version of the document may not be the latest version on the server.
      *

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

@@ -94,6 +94,10 @@ export declare class JoinQueryBuilder<Aliases extends Record<Alias, Alias[]>, Re
     snapshot(): Promise<Array<WithDocumentReferences<ReturnType>>>;
     /** @inheritDoc */
     snapshots(subscribe?: boolean): Observable<Array<WithDocumentReferences<ReturnType>>>;
+    /**
+     * @inheritDoc
+     */
+    peek(): Array<WithDocumentReferences<ReturnType>>;
     /** @inheritDoc */
     grouped(): GroupedJoin<Aliases, ReturnType, RootAlias, LatestAlias>;
     /** @inheritDoc */
@@ -115,6 +119,10 @@ declare class DereferencedJoin<Aliases extends Record<Alias, Alias[]>, ReturnTyp
     snapshot(): Promise<Array<ReturnType>>;
     /** @inheritDoc */
     snapshots(subscribe?: boolean): Observable<Array<ReturnType>>;
+    /**
+     * @inheritDoc
+     */
+    peek(): Array<ReturnType>;
     getSortOrders(): Array<FieldSort<any>>;
     clone(): DereferencedJoin<Aliases, ReturnType, RootAlias, LatestAlias>;
     addCompositeCondition(conditions: Array<SimpleCondition>): DereferencedJoin<Aliases, ReturnType, RootAlias, LatestAlias>;
@@ -133,6 +141,10 @@ declare class GroupedJoin<Aliases extends Record<Alias, Alias[]>, ReturnType ext
     snapshot(): Promise<Array<Grouped<Aliases, WithDocumentReferences<ReturnType>, RootAlias>>>;
     /** @inheritDoc */
     snapshots(subscribe?: boolean): Observable<Array<Grouped<Aliases, WithDocumentReferences<ReturnType>, RootAlias>>>;
+    /**
+     * @inheritDoc
+     */
+    peek(): Array<Grouped<Aliases, WithDocumentReferences<ReturnType>, RootAlias>>;
     /** @inheritDoc */
     dereference(): SnapshotEmitter<Grouped<Aliases, ReturnType, RootAlias>>;
     private groupData;

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

@@ -30,11 +30,7 @@ export declare class QueryBuilder<DocumentType extends DocumentData> extends Bas
      */
     setForceFetchFromServer(): this;
     /**
-     * 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.
+     * @inheritDoc
      */
     peek(): Array<DocumentReference<DocumentType>>;
     /**

package/package.json

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