@olympeio/runtime-node 8.7.2 → 9.0.2

package/index.d.ts

@@ -1,1181 +0,0 @@
-// @ts-ignore
-import { Observable } from "rxjs";
-
-/**
- * A client used to call remote services.
- */
-export class ServiceClient {
-
-    /**
-     * Send a request to a {@link CallService}.
-     *
-     * @param serviceId the service id
-     * @param payload the message payload, optional
-     * @return a Promise that completes when the call has been executed
-     */
-    static call(serviceId: string, payload?: Object): Promise<void>;
-
-    /**
-     * Get a value from a {@link GetService}.
-     *
-     * @param serviceId the service id
-     * @param payload the message payload
-     * @return a Promise wrapping the resulting value
-     */
-    static get(serviceId: string, payload: Object): Promise<Object>;
-
-    /**
-     * Observe values emitted by a {@link SubscribeService}.
-     *
-     * @param serviceId the service id
-     * @param payload the message payload, optional
-     * @return an Observable emitting values
-     */
-    static observe(serviceId: string, payload?: Object): Observable<Object>;
-}
-
-/**
- * A message consumed by a service.
- */
-export class ServiceMessage {
-
-    /**
-     * Get the requesting client's user tag.
-     *
-     * @return the user tag
-     */
-    userTag(): Promise<string>;
-
-    /**
-     * Get the request body.
-     *
-     * @return the request body
-     */
-    body(): Object;
-
-    /**
-     * Send an ack as response.
-     *
-     * @return a Promise that completes once the ack is sent
-     */
-    ack(): Promise<void>;
-
-    /**
-     * Send a reply message.
-     *
-     * @param payload the payload of the reply
-     * @return a Promise that completes once the reply is sent
-     */
-    reply(payload: Object): Promise<void>;
-
-    /**
-     * Send an error message.
-     *
-     * @param error the error to send
-     * @return a Promise that completes once the error is sent
-     */
-    fail(error: Error): Promise<void>;
-}
-
-/**
- * A service that processes requests.
- */
-export abstract class Service {
-
-    /**
-     * Create a new instance of the service.
-     *
-     * @param serviceId the service id
-     */
-    constructor(serviceId: string);
-
-    /**
-     * Start the service.
-     */
-    start(): Promise<void>;
-
-    /**
-     * Listen to incoming requests.
-     */
-    listen(): Observable<ServiceMessage>;
-
-    /**
-     * Stop the service.
-     */
-    stop(): Promise<void>;
-}
-
-/**
- * A service that retrieves a value upon request.
- */
-export class GetService extends Service { }
-
-/**
- * A service that executes remote procedures.
- */
-export class CallService extends Service { }
-
-/**
- * A service that allows clients to subscribe to updates.
- */
-export class SubscribeService extends Service {
-
-    /**
-     * Send a new notification to subscribers.
-     *
-     * @param payload the payload of the notification
-     * @return a Promise that completes once the notification is sent
-     */
-    notify(payload: Object): Promise<void>;
-}
-
-/**
- * List of general properties keys used by the runtime engine to set specific values on BrickContexts
- */
-export enum GlobalProperties {
-    TRANSACTION = '__transaction',
-    PRODUCTION = '__production',
-    EDITION = '__editionMode'
-}
-
-/**
- * The context of a brick is the object that contains the brick state, controls the brick lifecycle and provides
- * an API to observe and set values of this brick's properties.
- */
-export class BrickContext {
-
-    /**
-     * Register a callback to execute when the context is destroyed. Return the callback id.
-     *
-     * @param callback the callback function
-     * @return the callback id
-     */
-    onDestroy(callback: () => void): string;
-
-    /**
-     * Remove a previously registered callback with {@link BrickContext#onDestroy} method using its id.
-     *
-     * @param id the id of the callback to unregister
-     */
-    offDestroy(id: string): void;
-
-    /**
-     * Register a callback to execute every time the context is cleared.
-     * This happens every time the brick is refreshed with new inputs and during the brick destruction.
-     * Return the callback id.
-     *
-     * @param callback the callback function
-     * @return the callback id
-     */
-    onClear(callback: () => void): string;
-
-    /**
-     * Remove a previously registered callback with {@link BrickContext#onClear} method using its id.
-     *
-     * @param id the id of the callback to unregister
-     */
-    offClear(id: string): void;
-
-    /**
-     * Destroy the current context. It destroys all children context attached to this one and clear their values.
-     * The context cannot be reused after calling this function.
-     */
-    destroy(): void;
-
-    /**
-     * Clear the current context: detach and destroys all children context.
-     * The context can be reused.
-     */
-    clear(): void;
-
-    /**
-     * Set the specified property value and propagate the update to anyone observing it.
-     *
-     * @param key the property or key string
-     * @param value the new value to set
-     * @return this
-     */
-    set<T>(key: PropertyDescriptor<T> | string, value: any): this;
-
-    /**
-     * Trigger the specified event and propagate the update to anyone observing it.
-     *
-     * @param key the event or key event
-     * @return this
-     */
-    trigger<T>(key: PropertyDescriptor<T> | string): this;
-
-    /**
-     * Clear the value of the specified property and propagate that event.
-     *
-     * @param key the property or key string
-     */
-    remove<T>(key: PropertyDescriptor<T> | string);
-
-    /**
-     * Return the current value of the specified property. If there is currently no value, return null.
-     *
-     * @param key the property or key string
-     * @param global [=false] whether or not the method checks parent contexts
-     * @return the current value
-     */
-    get<T>(key: PropertyDescriptor<T> | string, global?: boolean): T | null;
-
-    /**
-     * Returns a boolean indicating whether a property has a value or not.
-     *
-     * @param key the property or key string
-     * @param global [=false] whether or not the method checks parent contexts
-     * @return whether `property` has a value or not
-     */
-    has<T>(key: PropertyDescriptor<T> | string, global?: boolean): boolean;
-
-    /**
-     * Return an observable to subscribe to value updates of the specified property.
-     * If `waitForValue` is set to FALSE (TRUE by default), the first value received by the observable is null
-     * if there is no value at subscription time.
-     * If `global` is set to TRUE (FALSE by default), it observes values coming from other contexts accessible from the current one.
-     *
-     * @param key the property or key string
-     * @param waitForValue [=true] whether or not the observable wait for a first value to get a value.
-     * @param global [=false] whether or not listen to a value coming from other contexts.
-     * @return the observable
-     */
-    observe<T>(key: PropertyDescriptor<T> | string, waitForValue?: boolean, global?: boolean): Observable<T>;
-
-    /**
-     * Subscribe to the specified observable and set its values to the context with the provided key.
-     *
-     * @param key the key used to set the values coming from the observable
-     * @param observable the observable providing values
-     * @return this context
-     */
-    repeat<T>(key: PropertyDescriptor<T> | string, observable:Observable<T>): this;
-
-    /**
-     * Run a runnable property and returns its context.
-     *
-     * @param property the runnable property or the runnable itself
-     * @return the child context or null if the runner was not found
-     */
-    runner<T>(property: PropertyDescriptor<T> | string | Brick): BrickContext | null;
-
-    /**
-     * Wait for the property to get a new value, wrapped in a promise.
-     *
-     * @param property the property
-     * @param nullable whether or not the observable accept null values (when a value is removed from the context). False by default.
-     * @param global [=false] whether or not the method checks parent contexts
-     * @return a promise of the next value of property
-     */
-    waitFor<T>(property: PropertyDescriptor<T> | string, nullable?: boolean, global?: boolean): Promise<T>;
-
-    /**
-     * Set the parent element for visual brick to be rendered.
-     *
-     * @param parent the parent container
-     * @return this
-     */
-    setParentElement(parent: Element): this;
-
-    /**
-     * Create and return a new context, child of the current one.
-     * Mainly used to run other bricks within the current one (e.g.: the iterator of the brick For Each).
-     *
-     * @param debugName a name to give to the context for debugging purpose.
-     */
-    createChild(debugName?: string): BrickContext;
-
-    /**
-     * Return the context with the specified id if accessible (in the hierarchy) from this context.
-     * Otherwise, return null.
-     *
-     * @param id the context id we want to retrieve
-     */
-    getOtherContext(id: string): BrickContext | null;
-
-    /**
-     * Listen to the creation of the context with the specified id.
-     * Executes the callback when that context becomes accessible by this current context.
-     * Return a function to unregister the listener.
-     *
-     * @param id the context id, which corresponds to the tag of the brick to be retrieved.
-     * @param callback the function to execute when the specified brick context is available
-     */
-    onContext(id: string, callback: ($: BrickContext) => void): () => void;
-
-    /**
-     * Return the parent context if it exists.
-     */
-    getParent(): BrickContext | null;
-
-    /**
-     * Return the closest transaction from this context :
-     * - look in its own transaction stack
-     * - look in the transaction stack of its parents, recursively
-     * - creates a new isolated transaction if no one is found.
-     *
-     * @return the transaction
-     */
-    getTransaction(): Transaction;
-
-    /**
-     * Get the last transaction from the stack of this context and releases it :
-     * - if the transaction is isolated, then executes it
-     * - otherwise, directly call the callback.
-     *
-     * The callback is called with 3 parameters:
-     * - whether the transaction has been executed or not (boolean)
-     * - whether the transaction succeed (always true if not executed) (boolean)
-     * - when the transaction failed, the associated error message (string), null otherwise.
-     *
-     * @param callback the callback function
-     */
-    releaseTransaction(callback: (executed: boolean, success: boolean, errMsg?: string) => void);
-
-    /**
-     * Push the specified transaction on the transaction stack of this context.
-     * This is essentially used for:
-     * - Aggregate multiple operations on the same transaction with the [Begin]--[End] bricks from DRAW.
-     * - Push a transaction from a hardcoded brick in CODE and aggregate operations on it from softcoded functions.
-     *
-     * @param transaction the transaction to push on the stack
-     */
-    pushTransaction(transaction: Transaction);
-
-    /**
-     * Remove and return the last added transaction from this context stack.
-     * If there is no transaction on the stack, return null.
-     *
-     * @return the transaction if exists
-     */
-    popTransaction(): Transaction | null;
-}
-
-/**
- * @deprecated use {@link BrickContext} instead
- */
-export class Context extends BrickContext { }
-
-/**
- * Context of UI bricks with methods to get and observe properties.
- * @deprecated use {@link BrickContext} instead and override render method of VisualBrick.
- */
-export class UIContext extends BrickContext {
-
-    /**
-     * Return a Property to get, update and observe its value
-     *
-     * @deprecated use {@link BrickContext#get} instead
-     * @param name The property name
-     */
-    getProperty<T>(name: string): Property<T> | null;
-
-    /**
-     * Return an Event to trigger or observe
-     *
-     * @deprecated use {@link BrickContext#trigger} instead
-     * @param name The event name
-     */
-    getEvent(name: string): Event | null;
-
-    /**
-     * Observe multiple properties simultaneously.
-     *
-     * @deprecated use {@link BrickContext#observe} with the RXJS operator combineLatestWith.
-     * @param properties list of properties to observe simultaneously
-     */
-    observeMany(...properties: string[]): Observable<any[]>;
-}
-
-/**
- * A property descriptor is an object that refers to the definition of a property
- */
-declare interface PropertyDescriptor<T> {
-    /**
-     * Get the property tag
-     *
-     * @return property tag
-     */
-    getTag(): string;
-}
-
-/**
- * A property allows a brick or a data object to store and provide a value under a specific identifier.
- *
- * @deprecated
- */
-declare interface Property<T> extends PropertyDescriptor<T> {
-
-    /**
-     * Get the property current value
-     * @return property value
-     */
-    get(): T | null;
-
-    /**
-     * Get a RxJS observable to subscribe to changes of the property value.
-     * @return observable on the property value
-     */
-    observe(): Observable<T>;
-
-    /**
-     * Update the property value.
-     *
-     * @param value the property value
-     */
-    set(value: T);
-}
-
-/**
- * Special brick property type that can be triggered.
- *
- * @deprecated
- */
-declare interface Event extends Property<number> {
-
-    /**
-     * Trigger the event.
-     */
-    trigger();
-}
-
-/**
- * The entry of a brick is a static object linked to the brick class itself that is used to make the link between the
- * code and the database. It stores tags linked to a specific brick :
- * - tag of the brick itself
- * - tags of properties that can be used as constants.
- */
-declare interface Entry {
-
-    /**
-     * Register a property on the brick with the specified tag.
-     *
-     * @param tag
-     * @return the property descriptor
-     */
-    addProperty<T>(tag: string): PropertyDescriptor<T>;
-
-    /**
-     * Register a new relation type with the specified tag and direction
-     *
-     * @param tag
-     * @param direction
-     */
-    addRelation(tag: string, direction: Direction): transformers.Related<any, any>;
-}
-
-/**
- * A brick is a modular piece of software. Bricks can be combined with each other to build a program.
- * Its lifecycle has 3 phases:
- * - initialisation: called whenever the brick is instantiated by its parent executor.
- * - updates: called whenever all the inputs of a brick have a value (default behaviour). This behaviour can be modified by overriding `configCoreUpdate`.
- * - destruction: when the parent executor starts to destroy itself, the brick destroys itself too.
- *
- * A headless brick that executes its core code every time an input gets a value.
- */
-export class Brick {
-
-    /**
-     * Static reference to the entry of that brick.
-     */
-    public static readonly entry: Entry;
-
-    /**
-     * Return the list of inputs tags as an ordered array.
-     */
-    readonly getInputs: () => string[];
-
-    /**
-     * Return the list of outputs tags as an ordered array
-     */
-    readonly getOutputs: () => string[];
-
-    /**
-     * Run the brick itself using the specified context.
-     *
-     * @param $ the brick context
-     */
-    run($: BrickContext);
-
-    /**
-     * Setup the brick and its context to listen to pipes and updates for its inputs and properties.
-     * Typically used as the first instruction of the {@link Brick#run run} method.
-     *
-     * @param $ the brick context.
-     */
-    protected setup($: BrickContext);
-
-    /**
-     * Called when the brick starts its lifecycle and gets initialized.
-     *
-     * @param $ the brick context
-     */
-    protected init($: BrickContext);
-
-    /**
-     * Called when the brick ends its lifecycle and gets destroyed.
-     *
-     * @param $ the brick context
-     */
-    protected destroy($: BrickContext);
-
-    /**
-     * Called every time the context is cleared.
-     *
-     * @param $ the brick context
-     */
-    protected clear($: BrickContext);
-
-    /**
-     * Called whenever the conditions to update the brick are satisfied (as defined by method `configCoreUpdate`).
-     * By default, a function updates whenever an input gets a new value, but only if all inputs have a value.
-     *
-     * @param $ the brick context
-     * @param inputs array of input values
-     * @param outputs array of output setter functions. A setter updates a specific output value of the brick.
-     */
-    protected update($: BrickContext, inputs: Array<any>, outputs: Array<(value: any) => void>): void;
-
-    /**
-     * Observe the context to define when the brick `update` method should be called.
-     *
-     * @param $ the brick context
-     * @return an observable that emit a value anytime the brick `update` method should be called.
-     */
-    protected setupExecution($: BrickContext): Observable<Array<any>>;
-
-    /**
-     * Execute the `onUpdate` class method. The `clear` callback destroys the context of the previous update and invalidates previous inputs.
-     * Override this method to change the function brick default behaviour.
-     *
-     * @deprecated
-     * @param $ the brick context
-     * @param runUpdate the function to call to update the brick
-     * @param clear the function to clear previous run
-     */
-    protected setupUpdate($: BrickContext, runUpdate: (inputs: any[]) => void, clear: () => void);
-
-    /**
-     * @deprecated use {@link BrickContext#init} instead
-     * @param $ the brick context
-     */
-    protected onInit($: BrickContext): void;
-
-    /**
-     * @deprecated use {@link BrickContext#init} instead
-     * @param $ the brick context
-     * @param inputs array of input values
-     * @param outputs array of output setter functions.
-     */
-    protected onUpdate($: BrickContext, inputs: Array<any>, outputs: Array<(value: any) => void>): void;
-
-    /**
-     * @deprecated use {@link BrickContext#init} instead
-     * @param $ the brick context
-     */
-    protected onDestroy($: BrickContext): void;
-}
-
-/**
- * A headless brick whose update is triggered by an event (control flow). Unlike a `FunctionBrick`, an `ActionBrick` updates on each incoming event, even if an input still has no value.
- * An `ActionBrick` also provides a specific output to forward the control flow (event).
- */
-export class ActionBrick extends Brick { }
-
-/**
- * A UI Brick aims to display something on the screen of a UI application.
- */
-export class VisualBrick extends Brick {
-
-    /**
-     * Return the list of properties tags as an ordered array
-     */
-    readonly getProperties: () => string[];
-
-    /**
-     * Render an element for the given `context`.
-     * Can return `null` if no element is rendered.
-     *
-     * @param $ the brick context
-     * @param properties property values that have been s
-     * @return the rendered element
-     */
-    protected render($: BrickContext, properties: any[]): Element | null;
-
-    /**
-     * Attach the `element` rendered by `render()` to its `parent` (in the DOM).
-     * Must return the function to clear the parent from that element.
-     * That function is called just before the next call to updateParent.
-     *
-     * If the `render()` method returns null, only the clear function of previous call to `updateParent()` will be called.
-     *
-     * @param parent the parent element
-     * @param element the element to attach
-     * @return the function to clear the element from its parent.
-     */
-    protected updateParent(parent: Element, element: Element): () => void;
-
-    /**
-     * Called when the DOM Element associated to that brick has been added to the document and is ready to be drawn.
-     *
-     * @deprecated override {@link VisualBrick#render} and {@link VisualBrick#updateParent} instead.
-     * @param $ the brick context
-     * @param domElement the associated DOM Element
-     */
-    protected draw($: BrickContext, domElement: Element);
-}
-
-/**
- * @deprecated use {@link VisualBrick} instead
- */
-export class UIBrick extends VisualBrick { }
-
-/**
- * Static function that must be called for every brick used in an application.
- * It registers the brick code in the registry with the specified tag and return the Entry for that brick.
- *
- * @param tag the brick unique id
- * @param brick the brick class
- * @param args Extra arguments
- */
-export function registerBrick(tag: string, brick: new () => Brick, ...args: any): Entry;
-
-export class Config {
-    /**
-     * Returns the value associated to the specified parameter id. Returns undefined if the parameter does not exist.
-     *
-     * @param id the parameter id.
-     */
-    static getParameter(id: string): any | undefined;
-}
-
-declare type SRPData = {
-    username: string,
-    login: string
-    salt: string,
-    verifier: string
-}
-
-declare enum AuthState {
-    INIT = 'init',
-    DISCONNECTED = 'disconnected',
-    GUEST = 'guest',
-    AUTHENTICATING = 'authenticating',
-    ERROR = 'error',
-    AUTHENTICATED = 'authenticated'
-}
-
-/**
- * A static class that gathers all the required methods to handle the authentication and sessions with Olympe.
- */
-export class Auth {
-
-    /**
-     * Based on the username and password, it generates a salt and verifier to configure a SRP user
-     *
-     * @param username
-     * @param password
-     */
-    static generateSRPData(username: string, password: string): SRPData;
-
-    /**
-     * Return the current state of the authentication manager
-     */
-    static getState(): AuthState;
-
-    /**
-     * Return the token currently used to identify the current session.
-     */
-    static getToken(): string;
-
-    /**
-     * Return the IDP token (zipped & base64 encoded XML) for the current user.
-     */
-    static getIDPToken(): string;
-
-    /**
-     * Return the tag of the current authenticated user.
-     */
-    static getCurrentUser(): string
-
-    /**
-     * Returns an Observable that is updated each time the user tag changes.
-     * @param {Context} context The brick context
-     */
-    static observeUser(context: Context): Observable<string>
-
-    /**
-     * Retrieve the user tag associated to the specified token
-     *
-     * @param token
-     */
-    static getUserFromToken(token: string): Promise<string>;
-
-    /**
-     * Refresh the session token to keep it alive.
-     */
-    static sendKeepAlive();
-
-    /**
-     * Try to login using SRP protocol with the specified username and password.
-     * Returns a promise resolved when logged in or that catches an error if refused.
-     *
-     * @throws {Error} If the provider's configuration is incorrect.
-     * @param username the username
-     * @param password the password
-     */
-    static loginSRP(username: string, password: string): Promise<void>;
-
-    /**
-     * Try to login using SAML protocol with the specified username and password.
-     * Returns a promise resolved when logged in or that catches an error if refused.
-     *
-     * @throws {Error} If the provider's configuration is incorrect.
-     */
-    static loginSAML(): Promise<void>;
-
-    /**
-     * Try to login using the specified token for the user.
-     * Returns a promise resolved when logged in or that catches an error if the token is not valid.
-     *
-     * @param username the username
-     * @param token the token
-     */
-    static loginToken(username: string, token: string): Promise<void>;
-
-    /**
-     * Try to login using the configured OpenID Provider.
-     * Returns a promise resolved when logged in or that catches an error if the login is not valid.
-     * @throws {Error} If the provider's configuration is incorrect.
-     */
-    static loginOpenID(): Promise<void>;
-
-    /**
-     * Log out the current user and invalidate its session token.
-     * It returns a promise resolved when the operation is done.
-     */
-    static logout(): Promise<void>;
-}
-
-/**
- * Error type used to propagate errors through flows between bricks.
- */
-export class ErrorFlow {
-    /**
-     * Create a new Error object to be sent in an error flow
-     *
-     * @param message the error message
-     * @param code the code associated to the error
-     */
-    static create(message: string, code: number): ErrorFlow;
-
-    /**
-     * Return the message of this error
-     */
-    getMessage(): string;
-
-    /**
-     * Return the code associated to this error
-     */
-    getCode(): number;
-}
-
-/* ======================
-       DATACLOUD
-====================== */
-
-export interface Relation<O extends Sync, D extends Sync> extends HasInstanceTag {
-    getTag(): string;
-    getDirection(): Direction;
-    getInverse(): Relation<D, O>;
-}
-
-export class StringPrimitive extends Sync {
-    static valueProp: PropertyDescriptor<string>;
-}
-
-export class NumberPrimitive extends Sync {
-    static valueProp: PropertyDescriptor<number>;
-}
-
-export class BooleanPrimitive extends Sync {
-    static valueProp: PropertyDescriptor<boolean>;
-}
-
-export class DatetimePrimitive extends Sync {
-    static valueProp: PropertyDescriptor<Date>;
-}
-
-export class ColorPrimitive extends Sync {
-    static valueProp: PropertyDescriptor<Color>;
-}
-
-export class Enum extends Sync {
-    create(transaction: Transaction, name?: string): string;
-    getValues(): ListDef;
-}
-
-export class EnumValue extends StringPrimitive {
-    static create(transaction: Transaction, enumModel: InstanceTag, value: string, name?: string, rank?: number): string;
-
-    static nameProp: PropertyDescriptor<string>;
-    static valueProp: PropertyDescriptor<string>;
-    static rankProp: PropertyDescriptor<number>;
-}
-
-export class File extends Sync {
-    static nameProp: PropertyDescriptor<string>;
-    static creationDateProp: PropertyDescriptor<Date>;
-    static modificationDateProp: PropertyDescriptor<Date>;
-    static mimeTypeProp: PropertyDescriptor<string>;
-    static urlProp: PropertyDescriptor<string>;
-
-    static createFile(model: InstanceTag, transaction: Transaction, name: string, content: ArrayBuffer, mimeType?: string, tag?: string): string;
-    static createFileFromURL(model: InstanceTag, transaction: Transaction, name: string, url: string, mimeType?: string, tag?: string): string;
-
-    getContentAsBinary(onSuccess: (content: ArrayBuffer) => void, onFailure?: (string) => void);
-    getContentAsString(onSuccess: (content: string) => void, onFailure?: (string) => void);
-    getContentUrl(onSuccess: (content: string) => void, onFailure?: () => void);
-    saveAs(name: string);
-}
-
-export class User extends Sync {
-    static loginProp: PropertyDescriptor<string>;
-    static saltProp: PropertyDescriptor<string>;
-    static verifierProp: PropertyDescriptor<string>;
-    static SAMLNameIdProp: PropertyDescriptor<string>;
-}
-
-export class BusinessObject extends Sync {
-    static nameProp: PropertyDescriptor<string>;
-    static instanceRel: Relation<Sync, Sync>;
-    static modelRel: Relation<Sync, Sync>;
-    static containsRel: Relation<Sync, Sync>;
-    static extendRel: Relation<Sync, Sync>;
-    static extendedByRel: Relation<Sync, Sync>;
-    static propertyRel: Relation<Sync, PropertyPrimitive>;
-}
-
-export class PropertyPrimitive extends Sync {
-    static definingModelRel: Relation<PropertyPrimitive, BusinessObject>;
-    static typeRel: Relation<PropertyPrimitive, Sync>;
-}
-
-export class RelationPrimitive extends Sync {
-    static originModelRel: Relation<BusinessObject, RelationPrimitive>;
-    static destinationModelRel: Relation<RelationPrimitive, BusinessObject>;
-}
-
-export class Color {
-    static create(r: number, g: number, b: number, a?: number): Color;
-
-    getRed(): number;
-    getGreen(): number;
-    getBlue(): number;
-    getAlpha(): number;
-    toRGBString(): string;
-    toHexString(): string;
-    equals(obj): boolean;
-}
-
-/** @deprecated */
-export class Parameter {
-    constructor(id: string);
-}
-
-/** @deprecated */
-interface HasInstanceTag {
-    getTag(): string;
-}
-
-export type InstanceTag = HasInstanceTag | string | (new () => Sync) | Entry;
-
-/** @deprecated */
-export function instanceToTag(instance: InstanceTag): string;
-/** @deprecated */
-export function onDestroy(callback: () => void): string;
-/** @deprecated */
-export function offDestroy(id: string);
-/** @deprecated */
-export function registerSync(tag: string, brick: new () => Sync, ...args: any): Entry;
-
-/** @deprecated */
-export class Sync implements HasInstanceTag {
-    static getInstance(instance: InstanceTag): Sync;
-    static getInstancesOf(model: InstanceTag): ListDef;
-
-    getTag(): string;
-    getModel(): Sync;
-    getModelTag(): string;
-    getName(): string;
-    observeProperty<T>(property: Property<T>): Observable<T>;
-    getProperty<T>(property: Property<T>): T | null;
-}
-
-/** @deprecated */
-export class DBView {
-    static get(): DBView;
-
-    exist(tag: InstanceTag): boolean;
-    name(tag: InstanceTag): string;
-    model(tag: InstanceTag): string | null;
-    extension(tag: InstanceTag): string | null;
-    isModel(tag: InstanceTag): boolean;
-    instanceOf(tag: InstanceTag, modelTag: InstanceTag): boolean;
-    isPersisted(tag: InstanceTag): boolean;
-    getProperty<T>(tag: InstanceTag, property: Property<T>, ownOnly: boolean): T | null;
-    // @ts-ignore
-    getProperties(tag: InstanceTag, ownOnly: boolean): Map<string, any>;
-    getRelated(tag: InstanceTag, relation: Relation<any, any>): string[];
-    isRelated(tag: InstanceTag, relation: Relation<any, any>, related: InstanceTag): boolean;
-    getMultiRelated(startTag: InstanceTag, relations: Relation<any, any>[]): string[];
-    getUniqueRelated(tag: InstanceTag, relation: Relation<any, any>): string | null;
-    getRecursiveRelated(startTag: InstanceTag, relation: Relation<any, any>, endTag: InstanceTag): string[];
-    findRecursive(startTag: InstanceTag, relation: Relation<any, any>, predicate: (string) => boolean): string | null;
-    findRelated(startTag: InstanceTag, relations: Relation<any, any>[], predicate: (string) => boolean): string | null;
-    findAllRelated(startTag: InstanceTag, relations: Relation<any, any>[], predicate: (string) => boolean): string[];
-    getExtendedModels(modelTag: InstanceTag, endTag?: InstanceTag): string[];
-    isExtending(modelTag: InstanceTag, extendedTag: InstanceTag): boolean;
-    getInstances(modelTag: InstanceTag): string[];
-}
-
-/** @deprecated */
-export class ListDef {
-    constructor(root: InstanceTag, transformers?: Transformer | Transformer[]);
-    getBaseTag(): string;
-    onReady(callback: (list: ListDef) => void): string;
-    offReady(id: string);
-    observeFirst(): Observable<Sync>;
-    observeAt(rank: number): Observable<Sync>;
-    getCurrentAt(rank: number): Sync | null;
-    observeRank(id: string): Observable<number>;
-    getCurrentRank(id: string): number | null;
-    observeSize(): Observable<number>;
-    getCurrentSize(): number;
-    forEach(onAdd: (item: Sync, index: string, list: ListDef) => void, onRemove: (itemTag: string) => void);
-    forEachCurrentValue(callback: (item: Sync, index: string, list: ListDef) => void);
-    transform(...transformers: Transformer[]): ListDef;
-    union(otherListDef: ListDef): ListDef;
-    filter(predicate: Predicate): ListDef;
-}
-
-/** @deprecated */
-export enum Direction {
-    DESTINATION, ORIGIN
-}
-
-/** @deprecated */
-export enum FollowRule {
-    NONE, DUMP, DELETE, RUNTIME
-}
-
-/* *************************
-        Transformers
-************************* */
-declare abstract class Transformer { }
-
-export namespace transformers {
-    /** @deprecated */
-    export class Related<O extends Sync, D extends Sync> extends Transformer implements Relation<O, D> {
-        constructor(relation: InstanceTag, direction: Direction);
-        getTag(): string;
-        getDirection(): Direction;
-        getInverse(): transformers.Related<D, O>;
-    }
-
-    /** @deprecated */
-    export class RecursiveRelated extends Transformer {
-        constructor(relation: InstanceTag, direction: Direction, minHops: number, maxHops: number);
-    }
-
-    /** @deprecated */
-    export class Distinct extends Transformer {
-        constructor();
-    }
-
-    /** @deprecated */
-    export class Filter extends Transformer {
-        constructor(predicate: Predicate);
-    }
-
-    /** @deprecated */
-    export class Limit extends Transformer {
-        constructor(limit: number, offset: number);
-    }
-
-    /** @deprecated */
-    export class Sort extends Transformer {
-        constructor(comparator: Comparator, ascending?: boolean);
-    }
-
-    /** @deprecated */
-    export class Union extends Transformer {
-        constructor(base: ListDef | InstanceTag, ...transformers: Transformer[]);
-    }
-}
-
-/* *************************
-         Predicates
-************************* */
-/** @deprecated */
-export abstract class Predicate {
-    static create(predicate: (object: Sync) => Observable<boolean>): Predicate;
-}
-
-export namespace predicates {
-    /** @deprecated */
-    export class And extends Predicate {
-        constructor(...predicates: Predicate[]);
-    }
-
-    /** @deprecated */
-    export class Or extends Predicate {
-        constructor(...predicates: Predicate[]);
-    }
-
-    /** @deprecated */
-    export class Not extends Predicate {
-        constructor(predicate: Predicate);
-    }
-
-    /** @deprecated */
-    export class Equals extends Predicate {
-        constructor(left: ValueDef, right: ValueDef);
-    }
-
-    /** @deprecated */
-    export class Contains extends Predicate {
-        constructor(source: ValueDef, value: ValueDef);
-    }
-
-    /** @deprecated */
-    export class Greater extends Predicate {
-        constructor(left: ValueDef, right: ValueDef);
-    }
-
-    /** @deprecated */
-    export class Smaller extends Predicate {
-        constructor(left: ValueDef, right: ValueDef);
-    }
-
-    /** @deprecated */
-    export class HasRelated extends Predicate {
-        constructor(relations: InstanceTag[], directions: Direction[], tag?: InstanceTag);
-    }
-
-    /** @deprecated */
-    export class InstanceOf extends Predicate {
-        constructor(models: InstanceTag[]);
-    }
-
-    /** @deprecated */
-    export class Regex extends Predicate {
-        constructor(source: ValueDef, regex: string, caseSensitive?: boolean);
-    }
-}
-
-/* *************************
-         ValueDefs
-************************* */
-declare abstract class ValueDef { }
-
-/** @deprecated */
-export namespace valuedefs {
-    /** @deprecated */
-    export class BooleanProperty extends ValueDef {
-        constructor(property: Property<boolean>, transformers?: Transformer[], baseTag?: string);
-    }
-
-    /** @deprecated */
-    export class DateTimeProperty extends ValueDef {
-        constructor(property: Property<Date>, transformers?: Transformer[], baseTag?: string);
-    }
-
-    /** @deprecated */
-    export class NumberProperty extends ValueDef {
-        constructor(property: Property<number>, transformers?: Transformer[], baseTag?: string);
-    }
-
-    /** @deprecated */
-    export class StringProperty extends ValueDef {
-        constructor(property: Property<string>, transformers?: Transformer[], baseTag?: string);
-    }
-
-    /** @deprecated */
-    export class Tag extends ValueDef {
-        constructor();
-    }
-
-    /** @deprecated */
-    export class Constant extends ValueDef {
-        constructor(value: any);
-    }
-}
-
-/* *************************
-         Comparator
-************************* */
-/** @deprecated */
-export abstract class Comparator {
-    static create(comparator: (object1: Sync, object2: Sync) => Observable<number>): Comparator;
-}
-
-export namespace comparators {
-    /** @deprecated */
-    export class Number extends Comparator {
-        constructor(value: ValueDef);
-    }
-
-    /** @deprecated */
-    export class String extends Comparator {
-        constructor(value: ValueDef);
-    }
-
-    /** @deprecated */
-    export class DateTime extends Comparator {
-        constructor(value: ValueDef);
-    }
-}
-
-interface Operation { }
-
-export class BurstTransaction {
-    constructor();
-    push(object: InstanceTag, values: Observable<Map<string, any>>);
-    complete(): Promise<void>;
-}
-
-/** @deprecated */
-export class Transaction implements Operation {
-    constructor();
-
-    getId(): string;
-    addOperation(operation: Operation): Operation;
-    persist(persist: boolean): this;
-    create(model: InstanceTag, tag?: string): CreateInstance;
-    persistInstance(tag: InstanceTag, persist?: boolean): CreateInstance;
-    delete(tag: InstanceTag, followRule?: FollowRule);
-    update<T>(instance: InstanceTag, property?: Property<T>, value?: T): UpdateInstance;
-    createRelation(relation: InstanceTag, from: InstanceTag, to: InstanceTag);
-    deleteRelation(relation: InstanceTag, from: InstanceTag, to: InstanceTag);
-    deleteAllRelations(relation: Relation<any, any>, origin: InstanceTag);
-    afterExecution(callback: (success: boolean, message?: string) => void);
-    execute(callback: (success: boolean, message?: string) => void);
-    executeAsLarge(callback: (success: boolean, message?: string) => void);
-}
-
-/** @deprecated */
-export class CreateInstance implements Operation, HasInstanceTag {
-    getTag(): string;
-    getModelTag(): string;
-    setProperty<T>(property: Property<T>, value: T): this;
-    persist(persist: boolean): this;
-    localSource();
-}
-
-/** @deprecated */
-export class UpdateInstance implements Operation, HasInstanceTag {
-    getTag(): string;
-    setProperty<T>(property: Property<T>, value: T): this;
-}