daemonraco/dfdb

/**
 * @file open-connection.i.dfdb.ts
 * @author Alejandro D. Simi
 */

import { Promise } from 'es6-promise';
import * as JSZip from 'jszip';

import { BasicDictionary } from '../basic-types.dfdb';
import { Collection } from '../collection/collection.dfdb';
import { Connection } from './connection.dfdb';
import { ConnectionSavingQueueResult } from './types.dfdb';
import { Rejection } from '../rejection.dfdb';
import { SubLogicErrors } from '../errors.sl.dfdb';
import { SubLogicFile } from './file.sl.dfdb';

/**
 * This is a workaround to access public and protected methods and properties of
 * a Connection object.
 *
 * @interface IOpenConnectionCollections
 */
export interface IOpenConnectionCollections {
    _collections: { [name: string]: Collection };
    _manifest: BasicDictionary;
    _subLogicErrors: SubLogicErrors<Connection>;

    save(): Promise<void>;
}

/**
 * This is a workaround to access public and protected methods and properties of
 * a Connection object.
 *
 * @interface IOpenConnectionConnect
 */
export interface IOpenConnectionConnect {
    _collections: { [name: string]: Collection };
    _connected: boolean;
    _dbFile: JSZip;
    _dbFullPath: string;
    _dbLockFullPath: string;
    _dbName: string;
    _dbPath: string;
    _lastRejection: Rejection;
    _manifest: BasicDictionary;
    _manifestPath: string;
    _subLogicErrors: SubLogicErrors<Connection>;
    _subLogicFile: SubLogicFile;

    loadFile(zPath: string): Promise<ConnectionSavingQueueResult>;
    save(): Promise<void>;
}

/**
 * This is a workaround to access public and protected methods and properties of
 * a Connection object.
 *
 * @interface IOpenConnectionFile
 */
export interface IOpenConnectionFile {
    _connected: boolean;
    _dbFile: JSZip;
    _dbFullPath: string;
    _fileAccessQueue: any;
    _lastRejection: Rejection;
    _manifest: BasicDictionary;
    _manifestPath: string;
    _subLogicErrors: SubLogicErrors<Connection>;

    save(): Promise<void>;
}

/**
 * This is a workaround to access public and protected methods and properties of
 * a Connection object.
 *
 * @interface IOpenConnectionInit
 */
export interface IOpenConnectionInit {
    _connected: boolean;
    _lastRejection: Rejection;
    _manifest: BasicDictionary;
    _subLogicErrors: SubLogicErrors<Connection>;

    collection(name: string): Promise<Collection>;
    save(): Promise<void>;
    lastRejection(): Rejection;
}