Digicom Node.js SDK

Type-safe TypeScript SDK for Digicom Nexus API project resources.

Install

npm install @digicom-mt/digicom-nodejs-sdk

Usage

import { createDigicomClient } from "@digicom-mt/digicom-nodejs-sdk";

const client = createDigicomClient({
  baseUrl: "https://api.example.com",
  token: process.env.DIGICOM_TOKEN,
  tenantId: process.env.DIGICOM_TENANT_ID,
});

const slides = await client.siteConfig.getHeroCarousel({
  projectKey: "silent-natural-farms",
});

Features

• Modular route groups (siteConfig, taxRates, brands, categories, attributeDefinitions, products, customerGroups, customers)
• Runtime-configurable baseUrl, timeout, retries, and headers
• Interceptor hooks for request, response, and error flows
• Retry with exponential backoff for transient HTTP/network failures
• Typed errors (DigicomHttpError, DigicomNetworkError, DigicomValidationError)
• Tree-shakeable ESM and CJS bundles with declaration files

Build Targets

• dist/esm for ESM consumers
• dist/cjs for CommonJS consumers
• dist/types for .d.ts declarations

Scripts

npm run build
npm run typecheck
npm run test

Build and Install Locally

npm run typecheck && npm test && npm run build
npm install

Publishing

Manual Publish

To publish the SDK manually to npm:

1. Create or update ~/.npmrc:

//registry.npmjs.org/:_authToken=[youraccesstoken]
@digicom-mt:registry=https://registry.npmjs.org/

Replace [youraccesstoken] with your npm access token.

2. Build and test the package:

npm run typecheck && npm test && npm run build

3. Publish to npm:

npm publish --access public

GitLab CI/CD Publish

Pushing to main runs the GitLab pipeline in .gitlab-ci.yml.

The pipeline:

1. Installs dependencies
2. Runs typecheck, tests, and build
3. Creates ~/.npmrc in CI using the NPM_TOKEN GitLab CI variable
4. Bumps the version automatically
5. Publishes the package to npm
6. Pushes the updated version back to main

Add these GitLab CI variables before using the pipeline:

• NPM_TOKEN: npm access token used to publish the package
• GITLAB_TOKEN: optional token with write_repository access if CI_JOB_TOKEN cannot push back to main

The CI job creates this npm config automatically:

//registry.npmjs.org/:_authToken=${NPM_TOKEN}
@digicom-mt:registry=https://registry.npmjs.org/

Versioning in CI:

• Default bump: PATCH (0.0.1)
• Major bump: include [major], BREAKING CHANGE, or !: in the commit message
• If the version-bump commit cannot be pushed with CI_JOB_TOKEN, set GITLAB_TOKEN in GitLab CI/CD variables

Versioning

This SDK follows semantic versioning:

• MAJOR: breaking API changes
• MINOR: backward-compatible features
• PATCH: backward-compatible fixes