SDK

Node.js

Загрузка и чтение конфигов Veresk из Node.js-сервиса.

Пакет: @veresk-tool/nodejs. Нужен Node.js 18 или новее.

Установка

npm install @veresk-tool/nodejs

Подключение

Страница Integration вашего проекта генерирует этот код с подставленными CDN URL, версией и потребителем.

import { Veresk, VereskEventName } from '@veresk-tool/nodejs';

const veresk = new Veresk({
  cdnUrls: ['<CDN URL>'],
  version: 'default',
  consumer: 'backend',
  encryptSecret: process.env.VERESK_SECRET,
});

veresk.on(VereskEventName.Error, (error) => console.error(error));

// Загружает манифест и файлы, затем опрашивает обновления.
await veresk.init();

Параметр	Значение
`cdnUrls`	CDN URL проекта (со страницы Integration).
`version`	Имя версии, например `default`.
`consumer`	Имя потребителя.
`encryptSecret`	Ключ проекта. Нужен, только если часть файлов зашифрована.

Чтение конфига

Конфиги отдаются из памяти по имени файла.

// Конфиг по имени файла.
const settings = veresk.getContent<Settings>('settings.json');

// Один элемент конфига-массива.
const item = veresk.getAsListOrThrow<Item[]>('items.json', {
  find: { id: 'item-1' },
});

Замечания

Храните VERESK_SECRET в окружении, не в коде.
У версии, которую ни разу не публиковали, нет файлов для клиентов. Сначала опубликуйте её.

Git-интеграция

Храните файлы проекта в Git-репозитории параллельно с публикацией.

Unity

Загрузка конфигов Veresk в игре на Unity с кешем на устройстве.