@squidcloud/client 1.0.85 → 1.0.86

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

@@ -1,4 +1,4 @@
-import { DocumentData, Paths } from '@squidcloud/common';
+import { DeepRecord, DocumentData, Paths } from '@squidcloud/common';
 import { Observable } from 'rxjs';
 import { TransactionId } from './types';
 /**
@@ -69,7 +69,7 @@ export declare class DocumentReference<T extends DocumentData = any> {
      * @param transactionId The transaction to use for this operation. If not provided, the operation will be applied
      *   immediately.
      */
-    update(data: Partial<Record<Paths<T>, any>>, transactionId?: TransactionId): Promise<void>;
+    update(data: Partial<DeepRecord<T>>, transactionId?: TransactionId): Promise<void>;
     /**
      * Similar to {@link update}, but only updates the given path.
      * @param path The path to update.
@@ -77,7 +77,7 @@ export declare class DocumentReference<T extends DocumentData = any> {
      * @param transactionId The transaction to use for this operation. If not provided, the operation will be applied
      *   immediately.
      */
-    setInPath(path: Paths<T>, value: any, transactionId?: TransactionId): Promise<void>;
+    setInPath<K extends Paths<T>>(path: K, value: DeepRecord<T>[K], transactionId?: TransactionId): Promise<void>;
     /**
      * Similar to `update`, but only deletes the given path.
      * @param path The path to delete.

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

@@ -1,4 +1,4 @@
-import { BaseQueryBuilder, DocumentData, FieldName, HasDereference, Operator, PrimitiveFieldType, SnapshotEmitter } from '@squidcloud/common';
+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';
@@ -96,6 +96,7 @@ export declare class JoinQueryBuilder<Aliases extends Record<Alias, Alias[]>, Re
     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;
@@ -106,6 +107,7 @@ declare class DereferencedJoin<Aliases extends Record<Alias, Alias[]>, ReturnTyp
     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>;
@@ -118,5 +120,6 @@ declare class GroupedJoin<Aliases extends Record<Alias, Alias[]>, ReturnType ext
     /** @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,4 +1,4 @@
-import { BaseQueryBuilder, DocumentData, FieldName, FieldSort, HasDereference, Operator, PrimitiveFieldType, Query, SnapshotEmitter } from '@squidcloud/common';
+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. */
@@ -10,7 +10,6 @@ export declare class QueryBuilder<DocumentType extends DocumentData> extends Bas
     private readonly queryBuilderFactory;
     private readonly documentIdentityService;
     private forceFetchFromServer;
-    protected readonly query: Query<DocumentType>;
     /** @inheritDoc */
     where(fieldName: (keyof DocumentType & FieldName) | string, operator: Operator | 'in' | 'not in', value: PrimitiveFieldType | Array<PrimitiveFieldType>): this;
     /** @inheritDoc */
@@ -45,6 +44,7 @@ export declare class QueryBuilder<DocumentType extends DocumentData> extends Bas
     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> {

package/package.json

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

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

@@ -1,3 +0,0 @@
-import { JSONSchemaType } from 'ajv';
-import { QueryRegisterRequest } from './query.types';
-export declare const QueryRegisterRequestSchema: JSONSchemaType<QueryRegisterRequest>;