@magic.batua/account/Source/Source.ts

The Account modules powers the user account management features of the Magic Batua platform.

/**
 *  @module     Source
 *  @overview   Defines the `Source` enum that allows the application to ascertain input
 *              data's source and purpose.
 *  
 *  @author     Animesh Mishra <hello@animesh.ltd>
 *  @copyright  © 2018 Animesh Ltd. All Rights Reserved.
 */

/**
 *  Often object in Magic Batua are initialised straight off the
 *  JSON sent in with the request/response. Since the content
 *  of JSON varies wildly depending on its source and purpose, some way
 *  of tracking the data source and purpose is required. This enum allows
 *  the application to do just that.
 * 
 *  ### Keys
 *  
 *  #### `Client`
 *  JSON for initially creating a Magic Batua object from client-side input.
 *  GUID and other auto-generated elements will be absent as they are generated
 *  server-side.
 *
 *  #### `Database`
 *  JSON returned by a database query. Includes all the fields a given object
 *  supports.
 *  
 *  @enum
 *  @exports Source
 */
export enum Source {
    /** @memberof Source */
    Client,

    /** @memberof Source */
    Database
}