lore-generate-new/templates/es6/config/connect.js

Generates a new Lore application

/**
 * Configuration file for connect
 *
 * This file is where you define overrides for the default connect behavior.
 */

export default {

  /**
   * Extend or override the built-in blueprints. This is helpful if you want to
   * change the interface for 'lore.connect'.
   *
   * Lore has five built-in blueprints:
   *
   *  - all       : used for calls like getState('tweet.all')
   *  - byCid     : used for calls like getState('tweet.byCid')
   *  - byId      : used for calls like getState('tweet.byId')
   *  - find      : used for calls like getState('tweet.find')
   *  - singleton : used for calls like getState('currentUser')
   */

  blueprints: {

    /**
     * As an example, the default syntax to fetch a model by id looks like this:
     *
     *   getState('tweet.byId', {
     *     id: 1
     *   })
     *
     * If you wanted to modify the syntax to use a 'where' clause (similar to the
     * 'find' blueprint) you could achieve that by overriding 'byId' blueprint with
     * the implementation below.
     *
     *   getState('tweet.find', {
     *     where: {
     *       id: 1
     *     }
     *   })
     */

    // byId: {
    //   defaults: {
    //     where: {
    //       id: null
    //     }
    //   },
    //
    //   verifyParams: function(params) {
    //     if (!params.where.id) {
    //       throw new Error('Missing required field: id');
    //     }
    //   },
    //
    //   getPayload: function (reducerState, params) {
    //     const key = params.where.id;
    //     return reducerState[key];
    //   },
    //
    //   callAction: function (action, params) {
    //     const id = params.where.id;
    //     return action(id).payload;
    //   }
    // }

  },

  /**
   * Add custom reducer-action maps here, or override existing ones
   *
   * This map determines what action gets called when the requested
   * reducer state does not exist. The blueprint is responsible for:
   *
   * 1. Validating the parameters passed to the getState method
   * 2. Extracting the desired state from the Redux Store
   * 3. Calling the action if that state does not exist
   */

  reducerActionMap: {

    /**
     * There are five blueprints built into the framework, with mappings
     * that look like this. These are examples of the mappings automatically
     * created by the framework based on conventions.
     *
     * The '*' in the mappings below is special syntax that means "put the
     * name of the model here". It allows you to say "this mapping applies
     * to all models". For example, '*.find' will apply to 'tweet.find',
     * 'user.find', etc.
     *
     * You can reuse built-in blueprints by setting the value of blueprint
     * to the name of the blueprint you want to reuse.
     */

    // '*.all': {
    //   action: null,
    //   reducer: '*.find',
    //   blueprint: 'find'
    // },
    //
    // '*.byCid': {
    //   action: null,
    //   reducer: '*.byCid',
    //   blueprint: 'byCid'
    // },
    //
    // '*.byId': {
    //   action: '*.get',
    //   reducer: '*.byId',
    //   blueprint: 'byId'
    // },
    //
    // '*.find': {
    //   action: '*.find',
    //   reducer: '*.find',
    //   blueprint: 'find'
    // },
    //
    // 'currentUser': {
    //   action: 'currentUser',
    //   reducer: 'currentUser',
    //   blueprint: 'singleton'
    // },

    /**
     * If the built-in blueprints don't work for you, you can use a custom
     * blueprint by providing an object as the value of the blueprint. The
     * code below mimics the built-in singleton blueprint.
     */

    // 'currentUser': {
    //   action: 'currentUser',
    //   reducer: 'currentUser',
    //   blueprint: {
    //     getPayload: function(reducerState, params) {
    //       return reducerState;
    //     },
    //
    //     callAction: function(action, params) {
    //       return action().payload;
    //     }
    //   }
    // }

  }

}