updraft/src/Sync.ts

Javascript ORM-like storage in SQLite (WebSQL or other), synced to the cloud

///<reference path="./verify.ts"/>
///<reference path="./Store.ts"/>

namespace Updraft {
  export interface FindChangesOptions {
    minSyncId: number;
    maxSyncId: number;
    process(batch: number, changes: TableChange<any, any>[]): Promise<any>;
    complete(batchCount: number, success: boolean): Promise<any>;
  }

  export interface Store2 {
    syncId: number;
    syncKey: string;
    getLocal(key: string): any;
    setLocal(key: string, value: any): Promise<any>;
    getUnresolved(uris: string[]): Promise<string[]>;
    addFromSync(changes: TableChange<any, any>[], uri: string): Promise<any>;
    findChanges(params: FindChangesOptions): Promise<any>;
  }

  export interface SyncProvider {
    getStores(): Promise<string[]>;
    open(storeName: string, store: Store2): SyncConnection;
  }

  export interface SyncConnection {
    onOpened(): any;
    onChanged(syncId: number): any;
  }

  export interface FileInfo {
    name: string;
    directory: boolean;
    size: number;
  }

  export interface ReadFileResult {
    exists: boolean;
    contents?: string;
  }

  export interface EncryptedInfo {
    mode: string;
    iv: string;
    cipher: string;
  }

  export interface SyncProviderFSOptions {
    name: string;

    // crypto
    generateKey(): string;
    encrypt(key: string, data: string): EncryptedInfo;
    decrypt(key: string, data: EncryptedInfo): string;

    // compression
    compress(data: string): string;
    decompress(data: string): string;

    // filesystem
    makeUri(storeName: string, fileName: string): string;
    getStores(): Promise<string[]>;
    filesForStore(storeName: string): Promise<string[]>;
    readFile(path: string): Promise<ReadFileResult>;
    beginWrite(): Promise<SyncProviderFSWriteContext>;
  }

  export interface SyncProviderFSWriteContext {
    writeFile(path: string, data: string): Promise<any>;
    finish(): Promise<any>;
  }

}