@aerogel/plugin-local-first 0.1.0 → 0.1.1-next.26f3c2c807213724de7500a899a6712abae430ad

package/dist/aerogel-plugin-local-first.d.ts

@@ -4,7 +4,9 @@ import { ComponentOptionsMixin } from 'vue';
 import { ComponentProvideOptions } from 'vue';
 import { Cr } from '@noeldemartin/utils';
 import { DefineComponent } from 'vue';
+import { DocumentsCache } from 'soukai-solid';
 import { Engine } from 'soukai';
+import { EngineDocument } from 'soukai';
 import { ErrorSource } from '@aerogel/core';
 import { Facade } from '@noeldemartin/utils';
 import { Job } from '@aerogel/core';
@@ -45,8 +47,11 @@ export declare class CloudService extends _default {
     protected asyncLock: Semaphore;
     protected engine: Engine | null;
     protected pollingInterval: NodeJS.Timeout | null;
+    protected documentsCache: DocumentsCache | null;
     whenReady<T>(callback: () => T): Promise<T>;
     setup(modelUrlMappings?: WeakMap<SolidModelConstructor, Record<string, string>>): Promise<void>;
+    getEngine(): Engine | null;
+    requireEngine(): Engine;
     dismissSetup(): void;
     dismissMigration(): void;
     postponeMigration(): void;
@@ -61,16 +66,17 @@ export declare class CloudService extends _default {
     register(modelClass: SolidModelConstructor, options?: RegisterOptions): Promise<void>;
     registerSchemaMigration(modelClass: SolidModelConstructor, schema: SolidModelConstructor | SolidSchemaDefinition): void;
     requireRemoteCollection(modelClass: SolidModelConstructor): string;
+    getDocumentsCache(): DocumentsCache;
     protected boot(): Promise<void>;
     protected getDirtyLocalModels(): SolidModel[];
     protected getModelsIn(urls: string[], model: SolidModel): SolidModel[];
-    protected requireEngine(): Engine;
     protected setReady(ready: boolean): Promise<void>;
     protected backup(modelUrlMappings?: WeakMap<SolidModelConstructor, Record<string, string>>): Promise<void>;
     protected onApplicationReady(): Promise<void>;
     protected onApplicationMounted(): Promise<void>;
     protected login(authenticator: Authenticator): void;
-    protected logout(): void;
+    protected logout(): Promise<void>;
+    private watchNetworkStatus;
     private syncOnStartup;
     private bustDocumentsCache;
     private registerModels;
@@ -78,6 +84,7 @@ export declare class CloudService extends _default {
 
 declare const CloudStatus: {
     readonly Disconnected: "disconnected";
+    readonly Offline: "offline";
     readonly Online: "online";
     readonly Syncing: "syncing";
     readonly Migrating: "migrating";
@@ -93,6 +100,7 @@ modelCollections: Record<string, string[]>;
 pollingEnabled: boolean;
 pollingMinutes: number;
 ready: boolean;
+manualSetup: boolean;
 registeredModels: ModelRegistration[];
 schemaMigrations: Map<SolidModelConstructor, SolidModelConstructor | SolidSchemaDefinition>;
 setupDismissed: boolean;
@@ -104,6 +112,7 @@ syncJob: Nullable<Sync>;
 }, {
 disconnected: boolean;
 online: boolean;
+offline: boolean;
 syncing: boolean;
 migrating: boolean;
 localChanges: number;
@@ -120,6 +129,7 @@ modelCollections: Record<string, string[]>;
 pollingEnabled: boolean;
 pollingMinutes: number;
 ready: boolean;
+manualSetup: boolean;
 registeredModels: ModelRegistration[];
 schemaMigrations: Map<SolidModelConstructor, SolidModelConstructor | SolidSchemaDefinition>;
 setupDismissed: boolean;
@@ -141,15 +151,14 @@ declare class LoadsChildren {
         onDocumentError?: (error: unknown) => unknown;
         onDocumentRead?: (document: SolidDocument) => unknown;
     }): Promise<SolidModel[]>;
-    protected loadDocumentChildren(model: SolidContainer, documentUrl: string, documents: ObjectsMap<SolidDocument>, onDocumentError?: (error: unknown) => unknown, onDocumentRead?: (document: SolidDocument) => unknown): Promise<{
-        children: Record<string, SolidModel[]>;
-        tombstones: Tombstone[];
-    }>;
-    protected loadDocumentChildrenFromLocal(model: SolidModel, document: SolidDocument): Promise<Record<string, SolidModel[]>>;
-    protected loadDocumentChildrenFromRemote(model: SolidContainer, documentUrl: string, onDocumentError?: (error: unknown) => unknown, onDocumentRead?: (document: SolidDocument) => unknown): Promise<{
-        children: Record<string, SolidModel[]>;
-        tombstones: Tombstone[];
-    }>;
+    protected loadContainedDocuments(model: SolidContainer, options?: {
+        status?: ResourceJobStatus;
+        onDocumentLoaded?: () => unknown;
+        onDocumentError?: (error: unknown) => unknown;
+        onDocumentRead?: (document: SolidDocument) => unknown;
+    }): Promise<Record<string, EngineDocument>>;
+    private loadDocumentChildren;
+    private loadDocumentChildrenFromRemote;
 }
 
 declare class LoadsTypeIndex {
@@ -163,7 +172,7 @@ declare class LoadsTypeIndex {
     }): Promise<SolidTypeIndex>;
 }
 
-declare function localFirst(): Plugin_2;
+declare function localFirst(options?: Options): Plugin_2;
 export default localFirst;
 
 export declare type LocalFirstServices = typeof services;
@@ -196,6 +205,10 @@ declare interface ModelRegistration {
     path?: string;
 }
 
+export declare interface Options {
+    manualSetup?: boolean;
+}
+
 export declare interface RegisterOptions {
     path?: string;
 }
@@ -230,12 +243,13 @@ declare class Sync extends Sync_base {
     private pullChanges;
     private pushChanges;
     private fetchRemoteModels;
+    private fetchRemoteModelsFromContainer;
     private fetchRemoteModelsForLocal;
     private getTypeRegistrations;
     private updateTypeRegistrations;
     private loadChildren;
     private deleteChild;
-    private saveModelAndChildren;
+    private saveModelAndRelated;
     private synchronizeModels;
     private reconcileInconsistencies;
     private synchronizeContainerDocuments;