@aerogel/plugin-local-first 0.1.1 → 0.1.2-next.823beb2779ebc4c5272f5e4e094cecc32cffa527

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

@@ -1,16 +1,16 @@
-import { AcceptRefs } from '@aerogel/core';
 import { Authenticator } from '@aerogel/plugin-solid';
 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';
 import { JobListener } from '@aerogel/core';
 import { JobStatus } from '@aerogel/core';
-import { ModalExpose } from '@aerogel/core';
 import { Nullable } from '@noeldemartin/utils';
 import { ObjectsMap } from '@noeldemartin/utils';
 import { Plugin as Plugin_2 } from '@aerogel/core';
@@ -18,7 +18,6 @@ import { PublicProps } from 'vue';
 import { Replace } from '@aerogel/core';
 import { Semaphore } from '@noeldemartin/utils';
 import { ServiceWithState } from '@aerogel/core';
-import { ShallowUnwrapRef } from 'vue';
 import { SolidContainer } from 'soukai-solid';
 import { SolidDocument } from 'soukai-solid';
 import { SolidModel } from 'soukai-solid';
@@ -35,18 +34,19 @@ export declare const AccountLoggedOut: DefineComponent<    {}, {}, {}, {}, {}, C
 
 export declare const AccountLoginModal: DefineComponent<    {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
 
-export declare const AccountModal: DefineComponent<    {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {
-$modalRef: ShallowUnwrapRef<AcceptRefs<ModalExpose<void>>> | null;
-}, any>;
+export declare const AccountModal: DefineComponent<    {}, {}, {}, {}, {}, ComponentOptionsMixin, ComponentOptionsMixin, {}, string, PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, ComponentProvideOptions, true, {}, any>;
 
 export declare const Cloud: Facade<CloudService>;
 
 export declare class CloudService extends _default {
     protected asyncLock: Semaphore;
     protected engine: Engine | null;
-    protected pollingInterval: NodeJS.Timeout | null;
+    protected pollingInterval: ReturnType<typeof setInterval> | 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 +61,16 @@ 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;
@@ -92,9 +92,11 @@ migrationDismissed: boolean;
 migrationJob: Nullable<Migrate>;
 migrationPostponed: boolean;
 modelCollections: Record<string, string[]>;
+rootModelCollections: Record<string, string>;
 pollingEnabled: boolean;
 pollingMinutes: number;
 ready: boolean;
+manualSetup: boolean;
 registeredModels: ModelRegistration[];
 schemaMigrations: Map<SolidModelConstructor, SolidModelConstructor | SolidSchemaDefinition>;
 setupDismissed: boolean;
@@ -120,9 +122,11 @@ migrationDismissed: boolean;
 migrationJob: Nullable<Migrate>;
 migrationPostponed: boolean;
 modelCollections: Record<string, string[]>;
+rootModelCollections: Record<string, string>;
 pollingEnabled: boolean;
 pollingMinutes: number;
 ready: boolean;
+manualSetup: boolean;
 registeredModels: ModelRegistration[];
 schemaMigrations: Map<SolidModelConstructor, SolidModelConstructor | SolidSchemaDefinition>;
 setupDismissed: boolean;
@@ -137,22 +141,24 @@ migrationJob: MigrateJobStatus | undefined;
 
 declare class LoadsChildren {
     protected localModels?: ObjectsMap<SolidModel>;
-    protected loadContainedModels(model: SolidContainer, options?: {
+    protected loadContainedModels(container: SolidContainer, options?: {
         ignoreTombstones?: boolean;
         status?: ResourceJobStatus;
+        updateProgress?: (update?: () => unknown) => Promise<void>;
         onDocumentLoaded?: () => unknown;
         onDocumentError?: (error: unknown) => unknown;
         onDocumentRead?: (document: SolidDocument) => unknown;
+        onDocumentIgnored?: (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(container: SolidContainer, options?: {
+        status?: ResourceJobStatus;
+        updateProgress?: (update?: () => unknown) => Promise<void>;
+        onDocumentLoaded?: () => unknown;
+        onDocumentError?: (error: unknown) => unknown;
+        onDocumentRead?: (document: SolidDocument) => unknown;
+    }): Promise<Record<string, EngineDocument>>;
+    private loadDocumentChildren;
+    private loadDocumentChildrenFromRemote;
 }
 
 declare class LoadsTypeIndex {
@@ -166,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;
@@ -199,6 +205,10 @@ declare interface ModelRegistration {
     path?: string;
 }
 
+export declare interface Options {
+    manualSetup?: boolean;
+}
+
 export declare interface RegisterOptions {
     path?: string;
 }
@@ -233,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;