connect-concierge
Connect middlewares for VTEX backoffice app Concierge
Last updated a year ago by breno .
Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install connect-concierge 
SYNC missed versions from official npm registry.

connect-concierge Build Status

Coleção de middlewares usados na aplicação de backoffice Concierge. É compatível com connect e grunt-connect (para poder ser usado em desenvolvimento).

Ao desenvolver um admin, deve ser usado com o grunt-vtex

Instalação

$ npm install --save-dev connect-concierge

Pré-requisitos

  1. O index do admin deve ser um .dust. Se ele é um .html, basta alterar a extensão.
  2. O package.json do admin deve conter a chave paths. Exemplo:
"paths": [
  "/admin/checkout"
],

Integrando com um admin

No Gruntfile do admin desejado:

GruntVTEX = require 'grunt-vtex'
Concierge = require 'connect-concierge'

module.exports = (grunt) ->
  pkg = grunt.file.readJSON('package.json')

  concierge = new Concierge({grunt: grunt, verbose: grunt.option('verbose')})
  middlewares = concierge.getMiddlewares()

  defaultConfig = GruntVTEX.generateConfig(grunt, pkg, {
    relativePath: 'admin/checkout'
    replaceGlob: "build/**/{index.html,index.dust,app.js,app.min.js}"
    proxyTarget: 'https://portal.vtexcommercebeta.com.br:443'
    additionalMiddlewares: middlewares
  })

Detalhes importantes:

  • A opção relativePath deve seguir o modelo 'admin/nome-do-admin'. Barras extras quebrarão sua aplicação
  • Certifique-se que a opção replaceGlob inclui o index.dust

Também é necessário incluir a task getTags do grunt-vtex no inicio da task default:

tasks = {
  default: ['getTags', 'build', 'connect', 'watch']
}

Configure o NODE_ENV para usar somente as opções de desenvolvimento:

GruntVTEX = require 'grunt-vtex'
Concierge = require 'connect-concierge'
process.env.NODE_ENV = 'development'

Ignorando middlewares

options = {
  exclude: ['licenseManagerCall', 'renderTemplate']
}

concierge = new Concierge(grunt: grunt, verbose: grunt.option('verbose'))
middlewares = concierge.getMiddlewares(options)

Helpers

Diversos helpers podem ser usados no seu index.dust para tornar sua vida mais fácil!

topbarData

Busca informações da Topbar do License Manager

<script>vtex.topbar.topbar = new vtex.topbar.Topbar({@topbarData /})</script>
version

Resolve versão mais recenente de um app no major especificado.

<script src='//io.vtex.com.br/alfredo-ui/{@version app="alfredo-ui" major="2" /}/alfredo-tpls.js'></script>

O helper version também recebe um parâmetro opcional env. Default: stable

aclData

Busca dados de ACL para um determinado app

<script>window.vtex.acl = {@aclData app="OMS" /}</script>
conciergeData

Expôe informações de usuário (userId e email), accountName, e environment

<script>window.vtex.conciergeData = {@conciergeData /}</script>
featuresData

Expôe as feature flags disponíveis

<script>window.vtex.features = {@featuresData /}</script>

Middlewares

O método getMiddlewares() devolve um array com os middlewares para desenvolvimento já na ordem correta.

Alguns middlewares são usados apenas em ambiente de desenvolvimento, outros apenas em produção:

  • prepareReq (dev): Prepara dados da requisição
    • Parse de cookies
  • checkHosts: Verifica se o host é VTEX
  • replaceHost (dev): Altera o host .vtexlocal.com.brpara .vtexcommercebeta.com.br
  • redirectToKnownHost (prod): Se o host não estiver na lista de hosts conhecidos, consulta o License Manager para saber o accountName e redireciona para .vtexcommercestable. Hosts conhecidos:
    • vtexcommerce
    • vtexcommercebeta
    • vtexcommercealfa
    • vtexcommercestable
    • vtexlocal
    • vtexpayments
    • vtexlab
    • myvtex
  • connectVtexid (dev): Utiliza o módulo connect-vtexid para resolver autenticação
  • getAccountName: Resolve accountName, respeitando a ordem de prioridade:
    1. Header X-VTEX-AccountName
    2. Cookie concierge-account
    3. Querystring an
    4. Host
  • getEnvironment: Resolve environment, respeitando a ordem de prioridade:
    1. Header X-VTEX-Environment
    2. Cookie concierge-env
    3. Querystring environment
    4. Host
  • resolveTags (dev): Verifica existencia do tags.json baixado pelo grunt
  • resolveTemplate (dev): Procura o arquivo index.dust no filesystem
  • licenseManagerCall: Busca informações da Topbar e faz cache por 5 minutos
  • featureToggleCall: Busca informações das feature flags disponiveis para esse admin. Faz cache por 8 minutos
  • renderTemplate: Devolve resposta com html renderizado

Current Tags

  • 0.16.47                                ...           latest (a year ago)

127 Versions

  • 0.16.47                                ...           a year ago
  • 0.16.46                                ...           2 years ago
  • 0.16.45                                ...           3 years ago
  • 0.16.44                                ...           3 years ago
  • 0.16.43                                ...           3 years ago
  • 0.16.42                                ...           3 years ago
  • 0.16.41                                ...           3 years ago
  • 0.16.40                                ...           3 years ago
  • 0.16.39                                ...           3 years ago
  • 0.16.38                                ...           3 years ago
  • 0.16.37                                ...           3 years ago
  • 0.16.36                                ...           3 years ago
  • 0.16.35                                ...           3 years ago
  • 0.16.34                                ...           3 years ago
  • 0.16.33                                ...           3 years ago
  • 0.16.32                                ...           3 years ago
  • 0.16.31                                ...           3 years ago
  • 0.16.30                                ...           3 years ago
  • 0.16.29                                ...           3 years ago
  • 0.16.28                                ...           3 years ago
  • 0.16.27                                ...           3 years ago
  • 0.16.26                                ...           3 years ago
  • 0.16.25                                ...           3 years ago
  • 0.16.24                                ...           3 years ago
  • 0.16.23                                ...           3 years ago
  • 0.16.22                                ...           3 years ago
  • 0.16.21                                ...           4 years ago
  • 0.16.20                                ...           4 years ago
  • 0.16.19                                ...           4 years ago
  • 0.16.18                                ...           4 years ago
  • 0.16.17                                ...           4 years ago
  • 0.16.16                                ...           4 years ago
  • 0.16.15                                ...           4 years ago
  • 0.16.14                                ...           4 years ago
  • 0.16.13                                ...           4 years ago
  • 0.16.12                                ...           4 years ago
  • 0.16.11                                ...           4 years ago
  • 0.16.10                                ...           4 years ago
  • 0.16.9                                ...           4 years ago
  • 0.16.8                                ...           4 years ago
  • 0.16.7                                ...           4 years ago
  • 0.16.6                                ...           4 years ago
  • 0.16.5                                ...           4 years ago
  • 0.16.4                                ...           4 years ago
  • 0.16.3                                ...           4 years ago
  • 0.16.2                                ...           4 years ago
  • 0.16.1                                ...           4 years ago
  • 0.16.0                                ...           4 years ago
  • 0.15.3                                ...           4 years ago
  • 0.15.2                                ...           4 years ago
  • 0.15.1                                ...           4 years ago
  • 0.14.3                                ...           4 years ago
  • 0.14.2                                ...           4 years ago
  • 0.14.1                                ...           4 years ago
  • 0.14.0                                ...           4 years ago
  • 0.13.1                                ...           4 years ago
  • 0.13.0                                ...           4 years ago
  • 0.12.8                                ...           4 years ago
  • 0.12.7                                ...           4 years ago
  • 0.12.6                                ...           4 years ago
  • 0.12.5                                ...           4 years ago
  • 0.12.4                                ...           4 years ago
  • 0.12.3                                ...           4 years ago
  • 0.12.2                                ...           5 years ago
  • 0.12.1                                ...           5 years ago
  • 0.12.0                                ...           5 years ago
  • 0.11.9                                ...           5 years ago
  • 0.11.7                                ...           5 years ago
  • 0.11.6                                ...           5 years ago
  • 0.11.4                                ...           5 years ago
  • 0.11.3                                ...           5 years ago
  • 0.11.2                                ...           5 years ago
  • 0.11.1                                ...           5 years ago
  • 0.11.0                                ...           5 years ago
  • 0.10.1                                ...           5 years ago
  • 0.10.0                                ...           5 years ago
  • 0.9.2                                ...           5 years ago
  • 0.9.1                                ...           5 years ago
  • 0.9.0                                ...           5 years ago
  • 0.8.0                                ...           5 years ago
  • 0.7.4                                ...           5 years ago
  • 0.7.3                                ...           5 years ago
  • 0.7.2                                ...           5 years ago
  • 0.7.1                                ...           5 years ago
  • 0.5.10                                ...           5 years ago
  • 0.5.9                                ...           5 years ago
  • 0.7.0                                ...           5 years ago
  • 0.5.8                                ...           5 years ago
  • 0.6.0                                ...           5 years ago
  • 0.5.7                                ...           5 years ago
  • 0.5.6                                ...           5 years ago
  • 0.5.5                                ...           5 years ago
  • 0.5.4                                ...           5 years ago
  • 0.5.3                                ...           5 years ago
  • 0.5.2                                ...           5 years ago
  • 0.5.1                                ...           5 years ago
  • 0.5.0                                ...           5 years ago
  • 0.4.1                                ...           5 years ago
  • 0.4.0                                ...           5 years ago
  • 0.3.20                                ...           5 years ago
  • 0.3.19                                ...           5 years ago
  • 0.3.18                                ...           5 years ago
  • 0.3.17                                ...           5 years ago
  • 0.3.16                                ...           5 years ago
  • 0.3.15                                ...           5 years ago
  • 0.3.14                                ...           5 years ago
  • 0.3.13                                ...           5 years ago
  • 0.3.12                                ...           5 years ago
  • 0.3.11                                ...           5 years ago
  • 0.3.10                                ...           5 years ago
  • 0.3.9                                ...           5 years ago
  • 0.3.7                                ...           5 years ago
  • 0.3.6                                ...           5 years ago
  • 0.3.5                                ...           5 years ago
  • 0.3.3                                ...           5 years ago
  • 0.3.2                                ...           5 years ago
  • 0.3.1                                ...           5 years ago
  • 0.2.0                                ...           5 years ago
  • 0.1.6                                ...           6 years ago
  • 0.1.5                                ...           6 years ago
  • 0.1.4                                ...           6 years ago
  • 0.1.3                                ...           6 years ago
  • 0.1.1                                ...           6 years ago
  • 0.1.0                                ...           6 years ago
  • 0.0.3                                ...           6 years ago
  • 0.0.2                                ...           6 years ago
  • 0.0.1                                ...           6 years ago
Downloads
Today 0
This Week 1
This Month 1
Last Day 0
Last Week 0
Last Month 9
Dependencies (10)
Dev Dependencies (9)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |