@springtree/eva-suite-uri-parser

A Node.js module that supports URI handling for EVA suite web applications. These URIs are used for inter-application communication and authentication.

Installation

npm install @springtree/eva-suite-uri-parser --save

Usage

Javascript

var { EvaIntentBuilder, EvaIntentParser, Order } = require('@springtree/eva-suite-uri-parser');

const intentBuilder = new EvaIntentBuilder();
const intentUrl = intentBuilder.buildUrl(Order.Create, {
  type: 0,
  organizationUnitID: 27,
  customerID: 1101,
  currencyID: 'USD'
});

const intentParser = new EvaIntentParser();
const intent = intentParser.parseUrl(`https://localhost:8080/admin?ou=1&i=listUsers`);

TypeScript

import { EvaIntentBuilder, EvaIntentParser, Order } from '@springtree/eva-suite-uri-parser';

const intentBuilder = new EvaIntentBuilder();
const intentUrl = intentBuilder.buildUrl(Order.Create, {
  type: 0,
  organizationUnitID: 27,
  customerID: 1101,
  currencyID: 'USD'
});

const intentParser = new EvaIntentParser();
const intent = intentParser.parseUrl(`https://localhost:8080/admin?ou=1&i=listUsers`);

Test

npm run test

Discount intents

| Action | Export | Description| | ------ | ------ | ---------- | | createDiscount | Discount.Create | Start creating a new discount. Payload can contain information to get started and target OrganizationUnitID | | viewDiscount | Discount.View | Navigate to a discounts details | | listDiscount | Discount.List | Navigate to the discount list for an OrganizationUnitID |

Order intents

| Action | Export | Description| | ------ | ------ | ---------- | | createOrder | Order.Create | Start creating a new order. Payload can contain an existing OrderID to copy | | viewOrder | Order.View | Navigate to an orders details | | listOrder | Order.List | Navigate to the order list for an OrganizationUnitID |

OrganizationUnit intents

| Action | Export | Description| | ------ | ------ | ---------- | | viewOrganizationUnit | OrganizationUnit.View | Navigate to an organization units details | | listOrganizationUnit | OrganizationUnit.List | Navigate to the list of organization units | | viewOpeningHours | OrganizationUnit.ViewOpeningHours | Navigate to the opening hours of an organization unit |

User tasks intents

| Action | Export | Description| | ------ | ------ | ---------- | | listUserTasks | UserTask.List | Show list of all the user taks for the selected organisation unit |

Cycle counts intents

| Action | Export | Description| | ------ | ------ | ---------- | | listCycleCountZones | CycleCount.List | Show list of all the cycle counts for the selected organisation unit |

Settings intents

| Action | Export | Description| | ------ | ------ | ---------- | | listSettings | Settings.List | Show list of all the settings at root level or for the selected organisation unit |

Return to supplier intents

| Action | Export | Description| | ------ | ------ | ---------- | | createReturnToSupplierRequest | ReturnToSupplier.Create | Creates a new RTS request | | viewReturnToSupplierRequest | ReturnToSupplier.View | Navigate to an RTS request | | listReturnToSupplierRequests | ReturnToSupplier.List | Navigate to the RTS request list for an OrganizationUnitID (optionally) |

Product bundle intents

| Action | Export | Description| | ------ | ------ | ---------- | | createProductBundle | ProductBundle.Create | Creates a new product bundle | | viewProductBundle | ProductBundle.View | Navigate to an product bundle | | listProductBundles | ProductBundle.List | Navigate to the product bundle list for an OrganizationUnitID (optionally) | | searchProductBundle | ProductBundle.Search | Navigate to the search results page for product bundles |

Role

| Action | Export | Description| | ------ | ------ | ---------- | | createRole | Role.Create | Creates a new role | | viewRole | Role.View | Navigate to a role | | listRole | Role.List | Navigate to the role list | | searchRole | Role.Search | Navigate to the search results page for roles |

Financial Period Export

| Action | Export | Description| | ------ | ------ | ---------- | | createFinancialPeriodExport | FinancialPeriodExport.Create | Creates a new financial period export | | viewFinancialPeriodExport | FinancialPeriodExport.View | Navigate to a financial period export | | listFinancialPeriodExports | FinancialPeriodExport.List | Navigate to the financial period export list |

Tax Rate

| Action | Export | Description| | ------ | ------ | ---------- | | createTaxRate | TaxRate.Create | Creates a new tax rate | | viewTaxRate | TaxRate.View | Navigate to a tax rate | | listTaxRate | TaxRate.List | Navigate to the tax rate list |