@squidcloud/client 1.0.4 → 1.0.6

package/dist/index.js.LICENSE.txt

@@ -1,3 +1,10 @@
+/*!
+ * The buffer module from node.js, for the browser.
+ *
+ * @author   Feross Aboukhadijeh <https://feross.org>
+ * @license  MIT
+ */
+
 /*! *****************************************************************************
 Copyright (c) Microsoft Corporation.
 
@@ -13,6 +20,8 @@ OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 PERFORMANCE OF THIS SOFTWARE.
 ***************************************************************************** */
 
+/*! https://mths.be/punycode v1.3.2 by @mathias */
+
 /**
  * @license
  * Lodash <https://lodash.com/>

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squidcloud/client",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "description": "A typescript implementation of the Squid client",
   "main": "dist/index.js",
   "types": "dist/typescript-client/src/index.d.ts",
@@ -21,7 +21,7 @@
     "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
     "test:e2e": "jest --config ./test/jest-e2e.json",
     "prepublish": "npm run build",
-    "publish": "npm publish --access public"
+    "publish:npm": "npm publish --access public"
   },
   "keywords": [
     "typescript",
@@ -31,6 +31,11 @@
     "realtime",
     "database"
   ],
+  "browser": {
+    "fs": false,
+    "path": false,
+    "os": false
+  },
   "author": "",
   "license": "ISC",
   "dependencies": {

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

@@ -1,4 +1,4 @@
-import { DocId, DocIdObj, IntegrationId, UserFacingDocType } from '@squidcloud/common';
+import { DocId, DocIdObj, IdResolutionMap, IntegrationId, UserFacingDocType } from '@squidcloud/common';
 import { DocumentReference } from './document-reference';
 import { DocumentReferenceFactory } from './document-reference.factory';
 import { QueryBuilder, QueryBuilderFactory } from './query/query-builder.factory';
@@ -10,7 +10,8 @@ export declare class CollectionReference<T extends UserFacingDocType> {
     private readonly queryBuilderFactory;
     private readonly documents;
     constructor(collectionName: string, integrationId: IntegrationId, documentReferenceFactory: DocumentReferenceFactory, queryBuilderFactory: QueryBuilderFactory);
-    doc(docId: DocId | DocIdObj): DocumentReference<T>;
+    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>;
+    migrateDocIds(idResolutionMap: IdResolutionMap): void;
 }

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

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

package/dist/typescript-client/src/data.manager.d.ts

@@ -1,11 +1,16 @@
-import { DocType, FullDocIdStr, LockManager, Mutation } from '@squidcloud/common';
+import { DocTimestamp, DocType, FullDocIdStr, LockManager, Mutation } from '@squidcloud/common';
 import { DbDao } from './db.dao';
 import { DestructManager } from './destruct.manager';
+import DocumentIdentityService from './document-identity.service';
 import { MutationSender } from './mutation/mutation-sender';
 import { QueryBuilderFactory } from './query/query-builder.factory';
 import { QuerySubscriptionManager } from './query/query-subscription.manager';
 import { SocketManagerInterface } from './socket.manager';
 import { TransactionId } from './types';
+export interface DocTimestampMetadata {
+    timestamp: DocTimestamp;
+    expireTimestamp: number | undefined;
+}
 export declare class DataManager {
     private readonly dbDao;
     private readonly mutationSender;
@@ -14,6 +19,7 @@ export declare class DataManager {
     private readonly queryBuilderFactory;
     private readonly lockManager;
     private readonly destructManager;
+    private readonly documentIdentityService;
     private readonly fullDocIdToLocalTimestamp;
     private currentTransactionId;
     /**
@@ -74,7 +80,7 @@ export declare class DataManager {
     private readonly docsToResync;
     private deleteExpiredTimestampsInterval;
     private handleIncomingMessages;
-    constructor(dbDao: DbDao, mutationSender: MutationSender, socketManager: SocketManagerInterface, querySubscriptionManager: QuerySubscriptionManager, queryBuilderFactory: QueryBuilderFactory, lockManager: LockManager, destructManager: DestructManager);
+    constructor(dbDao: DbDao, mutationSender: MutationSender, socketManager: SocketManagerInterface, querySubscriptionManager: QuerySubscriptionManager, queryBuilderFactory: QueryBuilderFactory, lockManager: LockManager, destructManager: DestructManager, documentIdentityService: DocumentIdentityService);
     getProperties(fullDocIdStr: FullDocIdStr): DocType | undefined;
     isDirty(fullDocIdStr: FullDocIdStr): boolean;
     /**
@@ -137,4 +143,5 @@ export declare class DataManager {
      */
     private handleOrphanDocs;
     private removeDocumentLocally;
+    private migrateDocIds;
 }

package/dist/typescript-client/src/db.dao.d.ts

@@ -17,4 +17,5 @@ export declare class DbDao {
     private getDbIdToDocForCollection;
     /** Converts multiple == conditions to $in, and multiple != conditions to $nin */
     private applyEqualityConditions;
+    migrateDocId(fullDocIdStr: FullDocIdStr, newFullDocIdStr: FullDocIdStr): void;
 }

package/dist/typescript-client/src/document-identity.service.d.ts

@@ -0,0 +1,12 @@
+import { IdResolutionMap } from '@squidcloud/common';
+import { Observable } from 'rxjs';
+import { DbDao } from './db.dao';
+import { DestructManager } from './destruct.manager';
+export default class DocumentIdentityService {
+    private readonly dbDao;
+    private readonly destructManager;
+    private readonly changeNotifier;
+    constructor(dbDao: DbDao, destructManager: DestructManager);
+    migrate(idResolutionMap: IdResolutionMap): void;
+    observeChanges(): Observable<IdResolutionMap>;
+}

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

@@ -1,12 +1,13 @@
-import { FullDocIdStr, Paths, UserFacingDocType } from '@squidcloud/common';
+import { FullDocIdStr, IdResolutionMap, Paths, UserFacingDocType } from '@squidcloud/common';
 import { DataManager } from './data.manager';
 import { QueryBuilderFactory } from './query/query-builder.factory';
 import { TransactionId } from './types';
 export declare class DocumentReference<T extends UserFacingDocType = any> {
-    readonly fullDocId: FullDocIdStr;
+    private _fullDocId;
     private readonly dataManager;
     private readonly queryBuilderFactory;
-    constructor(fullDocId: FullDocIdStr, dataManager: DataManager, queryBuilderFactory: QueryBuilderFactory);
+    constructor(_fullDocId: FullDocIdStr, dataManager: DataManager, queryBuilderFactory: QueryBuilderFactory);
+    get fullDocId(): FullDocIdStr;
     data(): T;
     get(): Promise<DocumentReference<T> | undefined>;
     isDirty(): boolean;
@@ -15,4 +16,5 @@ export declare class DocumentReference<T extends UserFacingDocType = any> {
     deleteInPath(path: Paths<T>, transactionId?: TransactionId): Promise<void>;
     insert(data: T, transactionId?: TransactionId): Promise<void>;
     delete(transactionId?: TransactionId): Promise<void>;
+    migrateDocIds(idResolutionMap: IdResolutionMap): void;
 }

package/dist/typescript-client/src/mutation/mutation-sender.d.ts

@@ -1,11 +1,11 @@
-import { ClientId, DocTimestamp, IntegrationId, LockManager, Mutation } from '@squidcloud/common';
-import { RpcManager } from '../rpc.manager';
+import { ClientId, IntegrationId, LockManager, MutateResponse, Mutation } from '@squidcloud/common';
 import { QuerySubscriptionManager } from '../query/query-subscription.manager';
+import { RpcManager } from '../rpc.manager';
 export declare class MutationSender {
     private readonly clientId;
     private readonly rpcManager;
     private readonly lockManager;
     private readonly querySubscriptionManager;
     constructor(clientId: ClientId, rpcManager: RpcManager, lockManager: LockManager, querySubscriptionManager: QuerySubscriptionManager);
-    sendMutations(mutations: Array<Mutation>, integrationId: IntegrationId): Promise<DocTimestamp>;
+    sendMutations(mutations: Array<Mutation>, integrationId: IntegrationId): Promise<MutateResponse>;
 }

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

@@ -1,5 +1,6 @@
 import { CollectionName, FieldName, FullDocIdStr, IntegrationId, Operator, PrimitiveFieldType, Query, UserFacingDocType } from '@squidcloud/common';
 import { Observable } from 'rxjs';
+import DocumentIdentityService from '../document-identity.service';
 import { DocumentReference } from '../document-reference';
 import { DocumentReferenceFactory } from '../document-reference.factory';
 import { QuerySubscriptionManager } from './query-subscription.manager';
@@ -7,7 +8,8 @@ import { Alias } from './query.types';
 export declare class QueryBuilderFactory {
     private readonly querySubscriptionManager;
     private readonly documentReferenceFactory;
-    constructor(querySubscriptionManager: QuerySubscriptionManager, documentReferenceFactory: DocumentReferenceFactory);
+    private readonly documentIdentityService;
+    constructor(querySubscriptionManager: QuerySubscriptionManager, documentReferenceFactory: DocumentReferenceFactory, documentIdentityService: DocumentIdentityService);
     getForDocument<MyDocType extends UserFacingDocType, ReturnType extends Record<Alias, DocumentReference<MyDocType>>>(fullDocId: FullDocIdStr): Omit<QueryBuilder<MyDocType, any, ReturnType, false>, 'join'>;
     get<MyDocType extends UserFacingDocType, ReturnType extends Record<Alias, DocumentReference<MyDocType>>>(collectionName: CollectionName, integrationId: IntegrationId): Omit<QueryBuilder<MyDocType, any, ReturnType, false>, 'join'>;
     getForJoin<MyDocType extends UserFacingDocType, MyAlias extends Alias, ReturnType extends Record<MyAlias, DocumentReference<MyDocType>>>(collectionName: CollectionName, integrationId: IntegrationId, alias: MyAlias): QueryBuilder<MyDocType, MyAlias, ReturnType, true>;
@@ -20,11 +22,12 @@ export declare class QueryBuilder<MyDocType extends UserFacingDocType, MyAlias e
     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);
+    constructor(collectionName: CollectionName, integrationId: IntegrationId, querySubscriptionManager: QuerySubscriptionManager, documentReferenceFactory: DocumentReferenceFactory, alias: MyAlias, supportsJoin: SupportsJoin, queryBuilderFactory: QueryBuilderFactory, documentIdentityService: DocumentIdentityService);
     where(fieldName: (keyof MyDocType & 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 MyDocType & FieldName, asc?: boolean): SupportsJoin extends true ? this : Omit<this, 'join'>;

package/dist/typescript-client/src/query/query-subscription.manager.d.ts

@@ -2,6 +2,7 @@ import { ClientId, ClientRequestId, DocType, FullDocIdStr, Query, QuerySubscript
 import { BehaviorSubject, Observable, Subject } from 'rxjs';
 import { DbDao } from '../db.dao';
 import { DestructManager } from '../destruct.manager';
+import DocumentIdentityService from '../document-identity.service';
 import { RpcManager } from '../rpc.manager';
 import { Alias, JoinCondition } from './query.types';
 export declare class QuerySubscriptionManager {
@@ -9,6 +10,7 @@ export declare class QuerySubscriptionManager {
     private readonly clientId;
     private readonly dbDao;
     private readonly destructManager;
+    private readonly documentIdentityService;
     readonly safeToSendQueriesToServer: BehaviorSubject<boolean>;
     onOrphanDocuments: Subject<string[]>;
     private readonly ongoingQueries;
@@ -20,7 +22,7 @@ export declare class QuerySubscriptionManager {
     private readonly clientRequestIdToLocalDocuments;
     private readonly localDocumentToClientRequestIds;
     private readonly queryMappingManager;
-    constructor(rpcManager: RpcManager, clientId: ClientId, dbDao: DbDao, destructManager: DestructManager);
+    constructor(rpcManager: RpcManager, clientId: ClientId, dbDao: DbDao, destructManager: DestructManager, documentIdentityService: DocumentIdentityService);
     hasOngoingQuery(clientRequestId: ClientRequestId): boolean;
     getQuery(clientRequestId: ClientRequestId): Query;
     setGotResponseFromServer(clientRequestId: ClientRequestId): void;
@@ -52,4 +54,5 @@ export declare class QuerySubscriptionManager {
     hasSubscription(clientRequestId: ClientRequestId): boolean;
     /** Sends the query request to the server and makes sure to unsubscribe once the subject completes. */
     private sendQueryToServer;
+    private migrateDocIds;
 }

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

@@ -1,7 +1,7 @@
 import { ApiEndpointId, ApiKey, AppId, CollectionName, IntegrationId, QueryName, UserFacingDocType } from '@squidcloud/common';
 import { CollectionReference } from './collection-reference';
-import { TransactionId } from './types';
 import { GraphQLClient } from './graphql-client';
+import { TransactionId } from './types';
 export interface SquidOptions {
     messageNotificationWrapper?: (fn: () => any) => any;
     appId: AppId;
@@ -26,6 +26,7 @@ export declare class Squid {
     private readonly apiManager;
     private readonly graphqlClientFactory;
     private readonly destructManager;
+    private readonly documentIdentityService;
     private static readonly squidInstancesMap;
     constructor(options: SquidOptions);
     /**

package/dist/typescript-client/src/testing/squid-env-setup.d.ts

@@ -5,6 +5,7 @@ import { CollectionReferenceFactory } from '../collection-reference.factory';
 import { DataManager } from '../data.manager';
 import { DbDao } from '../db.dao';
 import { DestructManager } from '../destruct.manager';
+import DocumentIdentityService from '../document-identity.service';
 import { DocumentReferenceFactory } from '../document-reference.factory';
 import { MutationSender } from '../mutation/mutation-sender';
 import { QueryBuilderFactory } from '../query/query-builder.factory';
@@ -50,6 +51,7 @@ export declare class SquidEnvSetup {
     readonly dataManager: DataManager;
     readonly clientId = "fakeClientId";
     readonly destructManager: DestructManager;
+    readonly documentIdentityService: DocumentIdentityService;
     readonly collectionA: CollectionReference<TestDocTypeA>;
     readonly collectionB: CollectionReference<TestDocTypeB>;
     constructor();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squidcloud/client",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "description": "A typescript implementation of the Squid client",
   "main": "dist/index.js",
   "types": "dist/typescript-client/src/index.d.ts",
@@ -21,7 +21,7 @@
     "test:debug": "node --inspect-brk -r tsconfig-paths/register -r ts-node/register node_modules/.bin/jest --runInBand",
     "test:e2e": "jest --config ./test/jest-e2e.json",
     "prepublish": "npm run build",
-    "publish": "npm publish --access public"
+    "publish:npm": "npm publish --access public"
   },
   "keywords": [
     "typescript",
@@ -31,6 +31,11 @@
     "realtime",
     "database"
   ],
+  "browser": {
+    "fs": false,
+    "path": false,
+    "os": false
+  },
   "author": "",
   "license": "ISC",
   "dependencies": {
@@ -40,7 +45,12 @@
     "lodash": "^4.17.21",
     "lokijs": "^1.5.12",
     "rxjs": "7.5.7",
-    "socket.io-client": "^4.5.2"
+    "socket.io-client": "^4.5.2",
+    "browserify-zlib": "^0.2.0",
+    "stream-browserify": "^3.0.0",
+    "https-browserify": "^1.0.0",
+    "stream-http": "^3.2.0",
+    "tty-browserify": "^0.0.1"
   },
   "devDependencies": {
     "cpx": "^1.5.0",