ООО «АЙТИ ДЕВ ЛИНК»
Документация, содержащая информацию, необходимую для эксплуатации экземпляра программного обеспечения, предоставленного для проведения экспертной проверки
Версия экземпляра: 1.0.3
Российская Федерация, 2026
Сведения о документе
| Показатель | Значение |
|---|---|
| Правообладатель | ООО «АЙТИ ДЕВ ЛИНК» |
| Наименование программы для ЭВМ | DevLink StateCore |
| Наименование npm-пакета | devlink-statecore |
| Версия экземпляра | 1.0.3 |
| Страница правообладателя | https://itdevlink.ru/products/devlink-statecore |
| Экземпляр ПО для экспертной проверки | npm-пакет devlink-statecore версии 1.0.3, доступный для установки из npm registry |
| Условия использования | Бесплатное использование |
| Назначение пользователя | Разработчик или эксперт, подключающий библиотеку к JavaScript/TypeScript-проекту |
Настоящий документ является руководством пользователя-разработчика и содержит информацию, необходимую для эксплуатации экземпляра программы для ЭВМ «DevLink StateCore» версии 1.0.3, предоставленного для проведения экспертной проверки.
Документ раскрывает местонахождение экземпляра ПО, состав инсталлируемых компонентов, порядок загрузки, установки, запуска, выполнения и завершения работы, формат команд, возможные варианты команд, ожидаемые ответы программы и действия при типовых ошибочных ситуациях.
Поскольку «DevLink StateCore» является программной библиотекой, а не самостоятельным веб-сервисом или приложением с графическим интерфейсом, эксплуатация экземпляра выполняется путем установки npm-пакета в тестовый JavaScript/TypeScript-проект и запуска контрольного сценария через среду выполнения Node.js.
1. Назначение программного обеспечения
«DevLink StateCore» — программная библиотека для JavaScript/TypeScript-проектов, предназначенная для управления состоянием приложений. Библиотека предоставляет разработчику средства создания хранилища состояния, получения текущего состояния и обновления состояния приложения через программный интерфейс.
Основные эксплуатационные функции экземпляра ПО:
- создание объекта хранилища состояния приложения;
- получение текущего значения состояния;
- изменение состояния через API библиотеки;
- подписка на изменения состояния для реакции на обновления;
- использование производных значений состояния в логике приложения;
- расширение обработки изменений через middleware-механизм;
- подключение библиотеки в JavaScript/TypeScript-проект без собственной серверной инфраструктуры.
Экземпляр ПО не содержит пользовательского интерфейса, административной панели, серверной части, СУБД, встроенного механизма авторизации или системы лицензионных ключей. Управление выполнением программы осуществляется разработчиком через команды npm/Node.js и вызовы API библиотеки в исходном коде приложения.
2. Состав экземпляра ПО и место нахождения
Для экспертной проверки предоставляется инсталлируемый npm-компонент:
| Компонент | Описание |
|---|---|
| devlink-statecore@1.0.3 | npm-пакет, содержащий распространяемый экземпляр библиотеки «DevLink StateCore» версии 1.0.3 |
| package.json | служебный файл npm-пакета с метаданными и сведениями о точке входа пакета |
| README | справочная документация пакета, размещаемая вместе с npm-пакетом |
| JavaScript/TypeScript-файлы библиотеки | файлы, подключаемые в проект пользователя после установки npm-пакета |
Страница правообладателя, на которой размещены сведения о программном обеспечении:
https://itdevlink.ru/products/devlink-statecore
Страница npm-пакета для получения экземпляра ПО:
https://www.npmjs.com/package/devlink-statecore
Прямая ссылка на версию экземпляра для экспертной проверки:
https://www.npmjs.com/package/devlink-statecore/v/1.0.3
3. Требования к среде эксплуатации
Для установки и эксплуатации экземпляра ПО в тестовой среде требуется стандартная среда разработки JavaScript/TypeScript-проектов.
| Средство | Назначение | Требование |
|---|---|---|
| Операционная система | запуск терминала и среды Node.js | Windows, Linux, macOS или иная ОС, поддерживающая Node.js и npm |
| Node.js | среда выполнения JavaScript-кода | актуальная LTS-версия Node.js либо иная совместимая версия, установленная у эксперта |
| npm | пакетный менеджер для загрузки и установки npm-пакета | устанавливается вместе с Node.js либо отдельно |
| Терминал/командная строка | выполнение команд установки и запуска | PowerShell, cmd, bash, zsh или аналогичный терминал |
| Текстовый редактор | создание контрольного файла index.mjs | любой редактор кода или текстовый редактор |
| Доступ к сети Интернет | загрузка npm-пакета из npm registry | требуется при установке из публичного npm registry |
Минимальная версия Node.js в публичных сведениях о пакете отдельно не зафиксирована. Для экспертной проверки рекомендуется использовать актуальную LTS-версию Node.js. При наличии ограничений в конкретной среде эксперт может использовать иной установленный вариант Node.js, совместимый с JavaScript-модулями и npm.
4. Порядок загрузки экземпляра ПО
Загрузка экземпляра ПО выполняется одним из двух способов: прямой установкой пакета в тестовый проект или предварительным получением npm-архива пакета с последующей установкой из локального файла.
4.1. Вариант 1. Прямая установка из npm registry
Основной вариант загрузки и установки экземпляра ПО:
npm install devlink-statecore@1.0.3Ожидаемый ответ: команда завершается без ошибки, в тестовом проекте появляется зависимость devlink-statecore версии 1.0.3, создается или обновляется каталог node_modules и файл package-lock.json.
4.2. Вариант 2. Получение инсталлируемого npm-архива
При необходимости эксперт может получить набор инсталлируемых компонентов в виде npm-архива:
npm pack devlink-statecore@1.0.3Ожидаемый ответ: в текущем каталоге создается архив пакета с именем вида devlink-statecore-1.0.3.tgz. После этого пакет может быть установлен из локального архива:
npm install ./devlink-statecore-1.0.3.tgzОба варианта приводят к установке одного и того же экземпляра библиотеки версии 1.0.3.
5. Пошаговый сценарий эксплуатации для экспертной проверки
Ниже приведена полная последовательность действий, обеспечивающая загрузку, запуск, выполнение и завершение программы в тестовой среде.
Шаг 1. Создание тестового каталога
Создать отдельный каталог для проверки и перейти в него.
mkdir statecore-check
cd statecore-checkОжидаемый результат: Создан каталог statecore-check, текущая рабочая директория изменена на него.
Шаг 2. Инициализация тестового npm-проекта
Создать минимальный package.json для установки npm-пакета.
npm init -yОжидаемый результат: Создан файл package.json с базовыми параметрами проекта.
Шаг 3. Установка экземпляра ПО
Установить библиотеку DevLink StateCore версии 1.0.3.
npm install devlink-statecore@1.0.3Ожидаемый результат: Пакет devlink-statecore добавлен в зависимости проекта.
Шаг 4. Проверка установленной версии
Убедиться, что установлена версия 1.0.3.
npm list devlink-statecoreОжидаемый результат: В дереве зависимостей отображается devlink-statecore@1.0.3.
Шаг 5. Создание контрольного файла
Создать файл index.mjs и поместить в него контрольный сценарий из раздела 6 настоящего документа.
Действие: Создать файл index.mjs
Ожидаемый результат: Файл index.mjs создан в тестовом каталоге.
Шаг 6. Запуск контрольного сценария
Запустить контрольный сценарий через Node.js.
node index.mjsОжидаемый результат: В консоль выводятся ожидаемые значения состояния; выполнение завершается без ошибки.
Шаг 7. Завершение эксплуатации
Завершение происходит автоматически после окончания выполнения Node.js-скрипта. Отдельный серверный процесс библиотекой не запускается.
Действие: Завершение процесса node после выполнения сценария
Ожидаемый результат: Процесс Node.js завершается, фоновых процессов библиотеки не остается.
Шаг 8. Удаление экземпляра из тестового проекта
При необходимости удалить библиотеку из тестового проекта.
npm uninstall devlink-statecoreОжидаемый результат: Пакет удален из зависимостей проекта.
6. Контрольный сценарий выполнения программы
Для проверки работы установленного экземпляра ПО необходимо создать файл index.mjs со следующим содержимым:
import { createStore } from "devlink-statecore";
const store = createStore({ count: 0 });
console.log("initial:", JSON.stringify(store.getState()));
store.setState((state) => ({
count: state.count + 1
}));
console.log("after update:", JSON.stringify(store.getState()));Запуск контрольного сценария выполняется командой:
node index.mjsОжидаемый ответ программы в консоли:
initial: {"count":0}
after update: {"count":1}Если указанный результат получен, экземпляр ПО установлен, подключен и выполняет базовые операции управления состоянием: создание хранилища, чтение состояния и обновление состояния.
7. Описание функций и программного интерфейса
В рамках эксплуатации библиотеки пользователь-разработчик управляет выполнением ПО через программный интерфейс библиотеки. Основные функции, необходимые для экспертной проверки, приведены ниже.
| Функция/операция | Формат вызова | Входные данные | Ответ/результат |
|---|---|---|---|
| Создание хранилища состояния | createStore(initialState) | initialState — начальное состояние приложения в виде объекта JavaScript | экземпляр store, через который выполняются операции получения и изменения состояния |
| Получение текущего состояния | store.getState() | не требует параметров | текущий объект состояния |
| Обновление состояния | store.setState(updater) | updater — функция, принимающая текущее состояние и возвращающая новое состояние | состояние хранилища обновляется; последующие вызовы getState возвращают новое значение |
| Подписка на изменения состояния | store.subscribe(listener) | listener — функция-обработчик изменения состояния | после изменения состояния вызывается функция-подписчик; при наличии возвращаемой функции она используется для отмены подписки |
| Производные значения состояния | используются на основе текущего состояния, получаемого через API библиотеки | текущее состояние приложения и пользовательская функция вычисления | значение, рассчитанное на основе актуального состояния |
| Middleware-обработка | настраивается в соответствии с API библиотеки при создании/конфигурации хранилища | функция промежуточной обработки изменений состояния | дополнительная логика при обновлении состояния, например логирование или контроль изменений |
Для целей первичной экспертной проверки достаточным является выполнение контрольного сценария из раздела 6, так как он подтверждает возможность загрузки, запуска и выполнения базового функционала экземпляра ПО.
8. Формат команд и ожидаемые ответы
| Команда | Назначение | Формат / параметры | Ожидаемый ответ |
|---|---|---|---|
| node --version | Проверка наличия Node.js | node --version | Вывод версии Node.js, например v20.x.x или иной установленной версии |
| npm --version | Проверка наличия npm | npm --version | Вывод версии npm |
| mkdir statecore-check | Создание тестового каталога | mkdir <имя_каталога> | Каталог создан без ошибки |
| cd statecore-check | Переход в тестовый каталог | cd <имя_каталога> | Текущий каталог изменен |
| npm init -y | Создание package.json | npm init -y | Файл package.json создан автоматически |
| npm install devlink-statecore@1.0.3 | Загрузка и установка экземпляра ПО | npm install <имя_пакета>@<версия> | Пакет установлен; команда завершается без ошибки |
| npm pack devlink-statecore@1.0.3 | Получение инсталлируемого архива | npm pack <имя_пакета>@<версия> | Создан архив devlink-statecore-1.0.3.tgz |
| npm list devlink-statecore | Проверка установленной версии | npm list <имя_пакета> | В списке зависимостей отображается devlink-statecore@1.0.3 |
| node index.mjs | Запуск контрольного сценария | node <имя_файла>.mjs | Вывод строк initial и after update с ожидаемыми значениями состояния |
| npm uninstall devlink-statecore | Удаление экземпляра ПО из тестового проекта | npm uninstall <имя_пакета> | Пакет удален из зависимостей проекта |
9. Завершение работы программы
«DevLink StateCore» не запускает самостоятельный серверный процесс и не создает отдельную службу операционной системы. Выполнение библиотеки происходит внутри процесса JavaScript/TypeScript-приложения, которое ее подключило.
В контрольном сценарии завершение работы происходит после окончания выполнения команды node index.mjs. После завершения процесса Node.js отдельные действия по остановке библиотеки не требуются.
Если библиотека используется в составе прикладного проекта, завершение эксплуатации происходит вместе с завершением соответствующего приложения. Удаление экземпляра из тестового проекта выполняется командой:
npm uninstall devlink-statecore10. Учетные данные и доступы
Для эксплуатации экземпляра ПО логин и пароль не требуются. Программа не содержит пользовательских учетных записей, административной панели, закрытой серверной части или механизма авторизации пользователей.
Для установки из публичного npm registry не требуются учетные данные правообладателя. Если эксперт использует частный npm registry или корпоративный прокси, настройки доступа к такому registry выполняются средствами его собственной инфраструктуры и не относятся к функционалу «DevLink StateCore».
11. Типовые ошибочные ситуации и действия пользователя
| Ситуация / сообщение | Возможная причина | Действия пользователя |
|---|---|---|
| node: command not found / node не является командой | Node.js не установлен или не добавлен в PATH | Установить Node.js актуальной LTS-версии или проверить переменную PATH |
| npm: command not found / npm не является командой | npm не установлен или не добавлен в PATH | Установить npm вместе с Node.js либо проверить корректность установки |
| npm install завершается сетевой ошибкой | Нет доступа к npm registry, блокировка сети или прокси | Проверить интернет-доступ, настройки proxy/registry; при необходимости использовать npm pack/локальный архив |
| No matching version found for devlink-statecore@1.0.3 | Указанная версия недоступна в используемом registry | Проверить, что используется публичный npm registry, и повторить установку версии 1.0.3 |
| Cannot find package devlink-statecore / Cannot find module | Пакет не установлен в текущий тестовый проект | Выполнить npm install devlink-statecore@1.0.3 в каталоге проекта и проверить npm list devlink-statecore |
| Cannot use import statement outside a module | Файл запущен не как ES-модуль | Использовать файл с расширением .mjs либо настроить type: module в package.json |
| SyntaxError в index.mjs | Ошибка копирования контрольного кода или несовместимость синтаксиса со старой версией Node.js | Скопировать код из раздела 6 повторно, использовать актуальную LTS-версию Node.js |
| Вывод отличается от ожидаемого | Контрольный файл изменен или вызовы API выполнены в другой последовательности | Сверить содержимое index.mjs с разделом 6 и повторить запуск |
12. Ограничения эксплуатации
- ПО является библиотекой и не имеет самостоятельного графического интерфейса пользователя;
- ПО не требует развертывания веб-сервера, сервера приложений, СУБД или облачного хранилища;
- ПО не требует учетных записей, паролей, лицензионных ключей или отдельной активации;
- ПО используется внутри JavaScript/TypeScript-приложения и выполняется в среде, где запущено это приложение;
- эксплуатация экземпляра для экспертной проверки выполняется через npm-команды и контрольный JavaScript-файл.
13. Контрольный перечень соответствия требованиям к эксплуатационной документации
| Требование к эксплуатационной документации | Реализация в настоящем документе |
|---|---|
| Ссылка на экземпляр ПО либо набор инсталлируемых компонентов | Раздел 2 содержит ссылки на страницу правообладателя и npm-пакет; раздел 4 содержит команды npm install и npm pack для получения инсталлируемого компонента |
| Последовательность действий для загрузки программы | Разделы 4 и 5 описывают загрузку через npm install и npm pack |
| Последовательность действий для запуска программы | Разделы 5 и 6 описывают создание index.mjs и запуск node index.mjs |
| Последовательность действий для выполнения программы | Раздел 6 содержит контрольный сценарий выполнения и ожидаемый вывод |
| Последовательность действий для завершения программы | Разделы 5 и 9 описывают завершение Node.js-процесса и удаление пакета |
| Описание функций | Разделы 1 и 7 описывают функции управления состоянием и программный интерфейс |
| Описание формата и вариантов команд | Раздел 8 содержит таблицу команд, их формат, параметры и ожидаемые ответы |
| Ответы программы на команды | Разделы 6 и 8 содержат ожидаемые ответы команд и контрольного сценария |
| Логин и пароль для экспертов при наличии | Раздел 10 указывает, что логин и пароль не требуются |
14. Сведения для связи
Правообладатель: ООО «АЙТИ ДЕВ ЛИНК».
Электронная почта для связи: info@itdevlink.ru.
Техническая поддержка и сопровождение экземпляра ПО обеспечиваются командой правообладателя без фиксированного графика и без установленного SLA, если иное не предусмотрено отдельным соглашением.