@vara/custom-logic-sdk/src/constants/constants.js

Server Side JavaScript SDK for Custom Business Logic

/**
 * Created by stevenchin on 2/1/17.
 */

const constants = {
  ROUTE_PATTERNS: {
    CL_FUNCTION_PATH_PREFIX: '/functions',
    CL_ACTION_PATH_PREFIX: '/actions',
  },
  TX_API_PATHS: {
    STANDALONE_FUNCTIONS: '/run',
  },
  CUSTOM_LOGIC: {
    FUNCTIONS: {
      EXECUTION_MODES: {
        SYNC: 'sync',
        ASYNC: 'async',
      },
      TYPES: {
        POST_HOOK: 'postHook',
        PRE_HOOK: 'preHook',
        STANDALONE: 'standalone',
      },
      RESPONSE_MODES: {
        MERGE: 'merge',
        REPLACE: 'replace',
      },
      CHAR_ENCODINGS: {
        UTF8: 'utf8',
        BASE64: 'base64',
      },
    },
    PROTOCOL: {
      PROTOCOL_VERSION_REQ_HEADER: 'X-Tx-CL-Version',
      VERSIONS: {
        V_1_0: '1.0',
        LATEST: '1.0',
      },
    },
    ACTIONS: {
      TYPES: {
        CL_ACTION: 'clAction',
      },
    },
  },
  // list of error properties that are allowed to be returned to the Etx API and subsequently end users/clients
  ERROR_PROP_WHITELIST: [
    'name',
    'message',
    'code',
    'statusCode',
  ],
};

constants.ROUTE_PATTERNS.CL_FUNCTION_PATH = `${constants.ROUTE_PATTERNS.CL_FUNCTION_PATH_PREFIX}/:name`;
constants.ROUTE_PATTERNS.CL_ACTION_PATH = `${constants.ROUTE_PATTERNS.CL_ACTION_PATH_PREFIX}/:name`;

module.exports = constants;