CustomJS Utils

This repository contains utils for creating Combeenation custom JS applications.

Documentation

For more detailed documentation see https://cjs.docs.combeenation.com/

Installation

The CustomJS Utils are available as npm package.

npm install @combeenation/custom-js-utils

Usage

The CustomJS Utils package contains functionalities for interacting with a Combeenation configurator, such as:

• manipulating Components and Controls
• utilize Shapediver 3D Viewer API
• general configurator tasks (eg: customized checkout, ressource upload,...)

All these functionalities can be found inside the dedicated exported classes. For example, when manipulating a Component input just import the CmpUtils class and call the desired method.

import { CmpUtils } from '@combeenation/custom-js-utils';

CmpUtils.setCmpInput(cmpName, newCmpValue);

Typings

The package also contains various TS typings. First there are the typings for all available util methods provided by this repo. These typings are prefixed with Cbn.CJS.

Furthermore the package also provides typings for "publicly" available Combeenation system code. The system code is present in every configurator and can be consumed/used by custom JS code.

These system code typings consists of two parts:

• Combeenation system code typings, prefixed with Cbn
• Typings for third party libraries, such as jQuery

Keep in mind that there can be differences between the third party typings and the code that is actually used in the configurator. For example at the time of writing, jQuery typings came in version 3.3.0 whilst we're actually using 3.1.0 in the system code. There shouldn't be any major differences regarding the API of those 2 versions but still they can be slightly different.

What does this mean for the consumer? Take good care when using third party library typings in your custom JS code and don't blindly trust auto completion & linting in the IDE here.