Node JS SDK

Descripción General

El SDK de Node JS cuenta con todos los métodos necesarios para acceder a los componentes y servicios de Catalyst. Te permite declarar y definir componentes de Catalyst cuyo comportamiento está predefinido. Por ejemplo, cada componente de Catalyst tiene su objeto equivalente en NodeJS dentro del SDK, y los equivalentes de API se denominan métodos en NodeJS.

Include Catalyst SDK in Project

Si eliges la opción install dependencies en el CLI al inicializar una función de Node.js, el SDK de Node.js se incluirá automáticamente en el código boilerplate de ejemplo generado. Sin embargo, también puedes incluirlo manualmente en tu proyecto ejecutando el siguiente comando desde el directorio raíz de la función en el CLI:

npm install zcatalyst-sdk-node

También puedes instalar la última versión compatible de esta manera:

npm install zcatalyst-sdk-node@2.5.0

Initialize the SDK

El SDK de Catalyst para Node.js debe inicializarse, lo cual retornará un objeto. Puedes acceder a los componentes de Catalyst del proyecto actual a través de este objeto retornado. Los diferentes métodos de inicialización para los distintos tipos de funciones se muestran a continuación.

var catalyst = require('zcatalyst-sdk-node');
module.exports = (req, res) => 
{	
  var app = catalyst.initialize(req); 
//Esta variable app se usa para acceder a los componentes de Catalyst.
//Puedes consultar la documentación del SDK para ejemplos de código.
//Tu lógica de negocio va aquí
}

var catalyst = require('zcatalyst-sdk-node');
const express = require('express');
const expressApp = express();
expressApp.get('/',(req,res)=>
{
  var app = catalyst.initialize(req); 
//Esta variable app se usa para acceder a los componentes de Catalyst.
//Puedes consultar la documentación del SDK para ejemplos de código.
//Tu lógica de negocio va aquí
});
module.exports=expressApp;

const catalyst = require('zcatalyst-sdk-node');
module.exports = (context, basicIO) => 
{
  const app = catalyst.initialize(context);
//Esta variable app se usa para acceder a los componentes de Catalyst.
//Puedes consultar la documentación del SDK para ejemplos de código.
//Tu lógica de negocio va aquí
}

const catalyst = require('zcatalyst-sdk-node');
module.exports = (event, context) => 
{
  const app = catalyst.initialize(context);
//Esta variable app se usa para acceder a los componentes de Catalyst.
//Puedes consultar la documentación del SDK para ejemplos de código.
//Tu lógica de negocio va aquí
}

const catalyst = require('zcatalyst-sdk-node');
module.exports = (cronDetails, context) => 
{
  const app = catalyst.initialize(context);
//Esta variable app se usa para acceder a los componentes de Catalyst.
//Puedes consultar la documentación del SDK para ejemplos de código.
//Tu lógica de negocio va aquí
}

Ahora puedes acceder a los componentes usando la variable inicializada.

Initialize SDK With Scopes

Catalyst te permite inicializar el SDK en un proyecto utilizando los siguientes alcances:

• Admin: Tienes acceso sin restricciones a todos los componentes y sus respectivas funcionalidades. Por ejemplo, tienes acceso completo a Data Store para realizar todas las operaciones como lectura, escritura, eliminación, etc.

• User: Puedes restringir el acceso a componentes y funcionalidades específicas. Por ejemplo, puedes proporcionar acceso de solo lectura a Data Store.

Los fragmentos de código del SDK a continuación te permitirán inicializar el SDK usando el alcance Admin o User, y realizar una consulta SELECT en Data Store:

• Inicializar el SDK con alcance Admin

const catalyst = require('zcatalyst-sdk-node');
module.exports = async (req, res) => 
{
    const app = catalyst.initialize(req);
    const adminApp = catalyst.initialize(req, { scope: 'admin'}); 
    // objeto de la app Catalyst con alcance de administrador
    await adminApp.zcql().executeZCQLQuery('select * from test');
}

• Inicializar el proyecto de Catalyst con alcance User

const catalyst = require('zcatalyst-sdk-node');
module.exports = async (req, res) => 
{
    const app = catalyst.initialize(req);
    const userApp = catalyst.initialize(req, { scope: 'user'}); 
    // objeto de la app Catalyst con alcance de usuario 
    await userApp.zcql().executeZCQLQuery('select * from test');
}