base-domain/src/lib/resource-client-interface.coffee

simple module to help build Domain-Driven Design

Promise = require('es6-promise').Promise

###*
interface of client accessing to resource.
Used in BaseRepository

LoopBackClient in loopback-promised package implements this interface.

see https://github.com/CureApp/loopback-promised

@class ResourceClientInterface
@module base-domain
###
class ResourceClientInterface


    ###*
    Create new instance of Model class, saved in database

    @method create
    @public
    @param {Object} data
    @return {Promise<Object>}
    ###
    create: (data = {}) ->
        @mock(data)


    ###*
    Update or insert a model instance
    The update will override any specified attributes in the request data object. It won’t remove  existing ones unless the value is set to null.

    @method upsert
    @public
    @param {Object} data
    @return {Promise<Object>}
    ###
    upsert: (data = {}) ->
        @mock(data)


    ###*
    Find object by ID.

    @method findById
    @public
    @param {String} id
    @return {Promise<Object>}
    ###
    findById: (id) ->
        @mock(id)



    ###*
    Find all model instances that match filter specification.

    @method find
    @public
    @param {Object} filter
    @return {Promise<Array>}
    ###
    find: (filter) ->
        return Promise.resolve([{id: 'dummy', mock: true}])

    ###*
    Find one model instance that matches filter specification. Same as find, but limited to one result

    @method findOne
    @public
    @param {Object} filter
    @return {Promise<Object>}
    ###
    findOne: (filter) ->
        @mock(filter)


    ###*
    Destroy model instance with the specified ID.

    @method destroyById
    @public
    @param {String} id
    @return {Promise}
    ###
    destroyById: (id) ->
        Promise.resolve({})


    ###*
    Update set of attributes.

    @method updateAttributes
    @public
    @param {Object} data
    @return {Promise<Object>}
    ###
    updateAttributes: (id, data) ->
        @mock(id, data)



    ###*
    return Promise object as mock

    @method mock
    @private
    ###
    mock: (arg1, arg2) ->
        return Promise.resolve(id: 'dummy', mock: true, arg1: arg1, arg2: arg2)


module.exports = ResourceClientInterface