ateinvoices-models

Introducción

Repositorio para almacenar y publicar el paquete npm de los modelos para la aplicación ScanDoc - Ategest.

Funcionamiento

Se ha creado un pipeline para poder publicar los cambios en el Perfil Npm fácilmente.

1. Clonamos el repositorio

2. Crear nuevo modelo

Un ejemplo básico, sería crear un nuevo modelo. Creamos dentro de la carpeta models un nuevo fichero que describa el modelo que vamos a crear. Todos los modelos deberían heredar de la interfaz básica.

export interface NewTestModel extends ParsedInvoice {
  Items: NewTestModelItems[];
  Valor_Nuevo_Test: string;
}

interface NewTestModelItems extends ParsedItems {
  Valor_Nuevo: string;
}

Además en el mismo fichero debemos crear un objeto con estos nuevos datos y los datos básicos también:

export const parsedItemTypePropertiesNewTestModel: NewTestModelItems = {
  Amount: 0,
  Description: "",
  Valor_Nuevo: "",
  ...
};

const parsedInvoiceTypePropertiesNewTestModel: NewTestModel = {
  InvoiceId: "",
  Items: [parsedItemTypePropertiesNewTestModel],
  Valor_Nuevo_Test: "",
};

Y por último en el fichero utils, debemos añadir los nuevos modelos disponibles, a los siguientes objetos:

const availableModelsItems: AvailableModelsItems = {
  general: () => Promise.resolve(parsedItem),
  "atecresa-jassway": () => Promise.resolve(parsedItemAtecresaJassway),
  "new-test-model": () => Promise.resolve(parsedItemTypePropertiesNewTestModel), // Nuevo modelo
};

const availableModels: AvailableModels = {
  general: () => Promise.resolve(parsedInvoice),
  "atecresa-jassway": () => Promise.resolve(parsedInvoiceAtecresaJassway),
  "new-test-model": () =>
    Promise.resolve(parsedInvoiceTypePropertiesNewTestModel), // Nuevo modelo
};

3. Publicar los nuevos cambios

En el futuro se creará un pipeline para hacerlo automático. Pero tras guardar los cambios debemos ejecutar los siguientes comandos:

npm version (patch|minor|major) # Dependiendo de la versión que vayamos a publicar

npm publish

git add .

git commit -m "mensaje del commit"

git push origin main

Así tendremos siempre el repositorio actualizado con la última versión y podremos repetir el proceso.