DCS Client Library

Installation

Add the following dependency to the dizmo's package.json file.

"@dizmo/dcs-client-library": "^4.0.0"

Or install with

npm i @dizmo/dcs-client-library

Usage

The modules for the different data types are separated and can be individually imported

import { templates, items, allocations, dcs, config, events, analytics, language, needs, packages, translations } from '@dizmo/dcs-client-library'

// Most functions throw errors, so they can be caught when they are called
try {
    const allItems = await items.getItems2()
} catch (e) {
    console.error(e)
}

API Documentation

The modules all have separate documentation files to keep this main README short and concise.

Templates Module

Contains all template-related functions of the DCS. Documentation can be found here.

Items Module

Contains all item-related functions of the DCS. Documentation can be found here.

Allocations Module

Contains all allocation-related functions of the DCS. Documentation can be found here.

DCS Module

Contains all company and system-related functions of the DCS. Documentation can be found here.

Analytics Module

Contains the analytics functionality to process database data. Documentation can be found here.

Config Module

Contains library configuration functions. Documentation can be found here.

Language Module

Contains all language and translation related functions. Documentation can be found here.

Events Module

Contains the function that informs the client on database updates. Documentation can be found here.

Needs Module

Contains functions for creating and managing needs (requirements/demands). Documentation can be found here.

Packages Module

Contains functions for creating and managing allocation packages (reusable allocation templates). Documentation can be found here.

Translations Module

Contains DeepL translation API integration for translating text content. Documentation can be found here.

Data Structures

Common data structures used across modules. Documentation can be found here.