suiteecommerce

v1.4.0

Published

3 years ago

Paquete de npm para uso en proyectos privados de Existaya. El mismo pretende estandarizar la programción asociada a proyetos de e-commerce facilitando módulos/librerías en javascript para su uso en diversos frameworks.

Downloads

159

0High
0Medium
0Low

existaya

Suite Ecommerce (Frontend)

Paquete de npm para uso en proyectos privados de Existaya. El mismo pretende estandarizar la programción asociada a proyetos de e-commerce facilitando módulos/librerías en javascript para su uso en diversos frameworks.

Versionamiento

Este paquete, al ser npm, utiliza un sistema de versión semántica (más información en About Semantic Versioning).

Relación entre versión del paquete y versión de Suite Ecommerce (Backend)

Por cada versión del Suite Ecommerce (Backend) se pueden utilizar las siguientes versiones:

| Versión Backend | Versiones Frontend | |--|--| | 1.0.0 | 1x |

Mantenimiento del paquete

Descripción: Suite Ecommerce es un proyecto Javascript/NPM que usa TypeScript (más información relacionada en página oficial de TypeScript) como compilador de Javascript.

Estructura

| Fichero | Descripción | Observaciones | |--|--|--| | package.json | Json usado para configurar el paquete NPM. Se configuran las dependencias entre otras cosas. | Importante en este fichero en el poder actualizar la versión del paquete con base en las reglas de versionamiento semántico. | | tsconfig.json | Json usado para configurar TypeScript y su proceso de compilación. | | | src/main.ts | Fichero TypeScript principal donde comunmente se exportarán los módulos que se requeiran sean públicos para su uso en los proyectos donde se instale el paquete. | También sirve para exponer pruebas corriendo el comando npm run tsandplay | | src/lib/ | Directorio donde vivirán los ficheros con sus respectivos módulos a exportar. | |

Configuraciones más notables en tscongif.json

| Propiedad | Descripción | Valor | |--|--|--| | | | |

Dependencias del paquete

Comandos disponibles en ./package.json

Publicación/Actualización del paquete Pasos para la publicación del paquete y actualización del mismo en NPM:

Correr el comando npm login y seguir los pasos indicados durante el proceso. Este comando es sólo necesario la primera vez que se publique el paquete.
Editar la versión del paquete en el fichero ./package.json siguiendo las indicaciones del sitema versionamiento semántico.
Correr el comando npm publish y esperar el resultado.

Instalación del paquete en proyectos

Instalación

npm i suiteecommerce --save

Actualización

npm update --save

Uso del paquete en proyectos

Configuración/Uso para Angular, Ionic-Angular y proyectos TypeScript En el fichero src/app/app.module.ts importar la siguiente dependencia:

import { Config } from 'suiteecommerce/dist/main';
// Configurar las propiedades necesarias.
Config.urlBase = 'my web service url';

Para usarlo en un componente de Angular o Ionic-Angular se debe importar el módulo deseado. Por ejemplo:

import { Productos, ...otros módulos... } from 'suiteecommerce/dist/main';
...
ngOnInit() {
    Productos.listar().then((res: any) => {}).catch((error: any) => {});
}

Configuración/Uso para jQuery En el ./index.html del proyecto se debe incluir en el header el siguiente script:

<script src="./node_modules/suiteecommerce/dist/main.map.js"></script>

Para usarlo se debe llamar directamente al módulo deseado y su respectivo método. Por ejemplo:

$(document).ready(() => {
    // Configurar las propiedades necesarias.
    Config.urlBase = 'my web service url';
    Productos.listar().then((res: any) => {}).catch((error: any) => {});
});

Configuración/Uso para en Nodejs (backend side) Requerir el paquete de configuración:

var SuiteEcommerceConfig = require('suiteecommerce').Config;
// Configurar las propiedades necesarias.
SuiteEcommerceConfig.urlBase = 'my web service url';

Requerir los modulos necesarios. Por ejemplo:

var SuiteEcommerceProductos = require('suiteecommerce').Productos;
SuiteEcommerceProductos.listar().then((res: any) => {}).catch((error: any) => {});

API

Listado descriptivo de los módulos/objetos (propiedades/métodos) que se manejan en el paquete para uso en los proyectos.

Configuración

Objetos/Métodos/Propiedades

Usuarios

Objetos/Métodos/Propiedades

| Tipo | Tipo de campo | Nombre | Descripción | |--|--|--|--| | Clase | IUsuario | Usuarios | ??? |

Productos

Objetos/Métodos/Propiedades

| Tipo | Tipo de campo | Nombre | Descripción | |--|--|--|--| | Clase | IProductos | Productos | ??? |

Carro de compra

Objetos/Métodos/Propiedades

| Tipo | Tipo de campo | Nombre | Descripción | |--|--|--|--| | Clase | ICarro | Carro | ??? |

Direcciones

Objetos/Métodos/Propiedades

| Tipo | Tipo de campo | Nombre | Descripción | |--|--|--|--| | Clase | IDireccion | Direcciones | ??? |

Métodos de pago

Objetos/Métodos/Propiedades

| Tipo | Tipo de campo | Nombre | Descripción | |--|--|--|--| | Clase | IMetodosDePago | MetodosDePago | ??? |

Interfaces

Objetos/Métodos/Propiedades

IUsuario

IProducto

IDireccion

| Tipo | Tipo de campo | Nombre | Descripción | |--|--|--|--| | Propiedad | string | nombre | El nombre de la dirección. | | ??? | ??? | ??? | ? |

IMetodosDePago

| Tipo | Tipo de campo | Nombre | Descripción | |--|--|--|--| | Propiedad | string | nombre | El nombre del método de pago. | | ??? | ??? | ??? | ? |

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

Suite Ecommerce (Frontend)

Versionamiento

Relación entre versión del paquete y versión de Suite Ecommerce (Backend)

Mantenimiento del paquete

Instalación del paquete en proyectos

Uso del paquete en proyectos

API