manuales_desarrollo

Manuales de desarrollo de YeboYebo

---

Project maintained by yeboyebo Hosted on GitHub Pages — Theme by mattgraham

Quimera / Schemas

Los schemas son mapas que establecen la correspondencia entre las estructuras de datos que recibimos o enviamos a las APIs y los objetos que internamente manejamos en Quimera.

Declaración

Los schemas se declaran en el fichero [extension]/static/schemas.js

Ejemplo:

import { Schema, Field } from 'core/lib'

export default (parent) => ({
  ...parent,
  categorias:
    Schema('to_categorias', 'idcategoria')
      .fields({
        idCategoria: Field.Int('idcategoria', 'ID').auto(),
        nombre: Field.Text('nombre', 'Nombre'),
        idCatPadre: Field.Int('idcatpadre', 'Id Categoria Padre'),
        metatags: Field.Text('metatags', 'Meta Tags'),
      .filter(() => ['1', 'eq', '1'])
      .order(() => ({ field: 'idcategoria', direction: 'ASC' })),
})

El primer parámetro del schema denota el nombre de la API a llamar. Así, un valor to_categorias llamará al fichero de API to_categorias_api.

El segundo parámetro indica cuál de las propiedades del schema es la clave primaria. Su valor es el de servidor (idcategoria, no idCategoria).

Subschemas

Podemos introducir subschemas en nuestros schemas para definir listas de registros asociadas a los registros de nuestro esquema, por ejemplo, líneas de una factura.

  Schema('to_carritos', 'idcarrito')
    .fields({
      idCarrito: Field.Int('idcarrito', 'Id. Carrito'),
      nombreCliente: Field.Text('nombrecliente', 'Nombre Cliente').required(),
      total: Field.Currency('total', 'Total'),
    })
    .subschemas({
      lineasCarrito: Subschema.List('lineas', 'lineaCarrito')
    }),

El único tipo soportado por ahora en los subschemas es List (array de registros), sus parámetros son:

• apiKey: clave del subschema en los datos provenientes la API (lineas en el ejemplo).
• esquema: nombre del esquema asociado al subschema (lineaCarrito en el ejemplo), que debe estar declarado por su parte en el correspondiente fichero schemas.js.

Sobrecarga

Podemos ampliar un esquema en una extensión para añadir campos u otras propiedades.

export default (parent) => ({
  ...parent,
  carrito: parent.carrito.fields({
    fechaEntrega: Field.Date('vb_fechaentrega', 'F. Entrega')
  }),
  ...
}

Más

• Volver al Índice