uuid-cbr 0.1.0 → 0.1.1

package/README.md

@@ -1,38 +1,40 @@
 # UUID-CBR
 
-> Генератор уникальных идентификаторов (УИд) по требованиям Банка России (Указание 5251-У, Положение 758-П)
+> Генератор УИд для Node.js по требованиям Банка России.
 
-Реализация алгоритма формирования УИд на основе UUID v1 с контрольным символом, полностью соответствующая официальному примеру ЦБ на C.
+Пакет формирует УИд на основе UUID v1 с контрольным символом и повторяет поведение официального примера Банка России на C.
 
-### Установка
+## Установка
 
 ```bash
 npm install uuid-cbr
 ```
 
-### Форматы модуля
+## Быстрый старт
 
-Пакет публикуется сразу в двух вариантах:
-
-- `require("uuid-cbr")` для CommonJS
-- `import { generate } from "uuid-cbr"` для ESM
-- встроенные декларации `index.d.ts` для TypeScript
+CommonJS:
 
 ```js
 const { generate } = require("uuid-cbr");
+
+const uid = generate();
 ```
 
+ESM:
+
 ```js
 import { generate } from "uuid-cbr";
+
+const uid = generate();
 ```
 
-### API
+## Основные методы
 
-#### `generate(datetime?)`
+### `generate(datetime?)`
 
-Формирует УИд — строку из 38 символов в формате `8-4-4-4-12-1`, где последний символ — контрольный.
+Формирует УИд в формате `8-4-4-4-12-1`, где последний символ является контрольным.
 
-```JavaScript
+```js
 const { generate } = require("uuid-cbr");
 
 const uid = generate(new Date("2021-09-24T09:55:09.332Z"));
@@ -42,54 +44,54 @@ const uidNow = generate();
 // генерация для текущего момента
 ```
 
-#### `isValid(uuid)`
+### `isValid(uuid)`
 
-Проверяет строку: формат UUID v1, variant-биты, контрольный символ.
+Проверяет формат UUID v1, variant-биты и контрольный символ.
 
-```JavaScript
+```js
 const { isValid } = require("uuid-cbr");
 
 isValid("80c57a90-1d1d-11ec-adda-26dbb65f1526-0"); // true
-isValid("not-a-uuid");                               // false
+isValid("not-a-uuid"); // false
 ```
 
-#### `toDate(uuid)`
+### `toDate(uuid)`
 
 Извлекает дату из UUID-части идентификатора.
 
-```JavaScript
+```js
 const { toDate } = require("uuid-cbr");
 
 toDate("80c57a90-1d1d-11ec-adda-26dbb65f1526-0");
 // 2021-09-24T09:55:09.332Z
 ```
 
-#### `info(uuid)`
+### `info(uuid)`
 
-Метаданные идентификатора: длина, валидность, контрольный символ, clock sequence, дата.
+Возвращает длину, валидность, контрольный символ, clock sequence и дату.
 
-```JavaScript
+```js
 const { info } = require("uuid-cbr");
 
 info("80c57a90-1d1d-11ec-adda-26dbb65f1526-0");
 // { len: 38, valid: true, controlNum: '0', gClockSeq: ..., datetime: 2021-09-24T09:55:09.332Z }
 ```
 
-#### `getTime(datetime?)`
+### `getTime(datetime?)`
 
-Возвращает метку времени в 100-наносекундных интервалах (Number) — то же значение, которое кодируется в UUID.
+Возвращает ту же метку времени в 100-нс интервалах, которая кодируется в UUID.
 
-```JavaScript
+```js
 const { getTime } = require("uuid-cbr");
 
 getTime(new Date("2021-09-24T09:55:09.332Z"));
 ```
 
-#### `uid_init(options?)` / `uid_deinit()`
+## Управление генератором
 
-Lifecycle-управление генератором, аналог `uid_init` и `uid_deinit` из официального C-примера ЦБ.
+Если нужен управляемый state генератора, используйте `uid_init`, `uid_create` и `uid_deinit`.
 
-```JavaScript
+```js
 const { uid_init, uid_deinit, uid_create } = require("uuid-cbr");
 
 uid_init({
@@ -101,60 +103,12 @@ const uid = uid_create(new Date("2021-09-24T09:55:09.332Z"));
 uid_deinit();
 ```
 
-`options`:
-
-- `node` — 6 байт (Buffer, Array или hex-строка). По умолчанию — случайные.
-- `clockSeq` — 13-битное значение clock sequence. По умолчанию — случайное.
-
-#### `uid_create(datetime?)` / `uuid_create(datetime?)`
-
-- `uid_create` — формирует УИд-строку (аналог `generate`).
-- `uuid_create` — возвращает структуру полей UUID: `time_low`, `time_mid`, `time_hi_and_version`, `clock_seq_hi_and_reserved`, `clock_seq_low`, `node`.
-
-`uuid_init` / `uuid_deinit` — алиасы для `uid_init` / `uid_deinit`.
-
-### Тесты
-
-```bash
-npm test
-```
-
-Тесты запускаются через встроенный раннер Node.js `node:test` и покрывают поведение публичного API как unit-тесты.
-
-### Сверка с официальным алгоритмом
-
-```bash
-npm run compare:official
-```
-
-Скрипт собирает УИд при детерминированных входных данных и побайтово сравнивает результат с эталонной реализацией, эквивалентной официальному C-коду ЦБ.
-
-### Проверка перед публикацией
-
-```bash
-npm run verify:publish
-```
-
-Эта команда последовательно выполняет:
-
-- unit-тесты;
-- сверку с официальным алгоритмом;
-- `npm pack --dry-run`, чтобы проверить состав публикуемого пакета.
-
-При `npm publish` эта проверка запускается автоматически через `prepublishOnly`.
-
-### Что попадает в npm
-
-В опубликованный пакет входят только файлы рантайма:
-
-- `index.js`
-- `index.mjs`
-- `index.d.ts`
-- `README.md`
+- `node` — 6 байт: Buffer, Array или hex-строка. По умолчанию случайные.
+- `clockSeq` — 13-битный clock sequence. По умолчанию случайный.
 
-Тесты, служебные скрипты, локальные временные файлы и официальный reference-архив остаются в репозитории, но не публикуются в npm.
+## Совместимость API
 
-### Официальные материалы
+- `uid_create` формирует УИд-строку, аналог `generate`.
+- `uuid_create` возвращает поля UUID: `time_low`, `time_mid`, `time_hi_and_version`, `clock_seq_hi_and_reserved`, `clock_seq_low`, `node`.
 
-- [docs/official/README.md](docs/official/README.md) — описание сохранённых документов
-- [docs/official/cbr-algorithm-findings.md](docs/official/cbr-algorithm-findings.md) — результаты сверки с официальным примером
+`uuid_init` и `uuid_deinit` это алиасы `uid_init` и `uid_deinit`.

package/package.json

@@ -1,12 +1,17 @@
 {
   "name": "uuid-cbr",
-  "version": "0.1.0",
-  "description": "Генератор уникальных идентификаторов (УИд) по требованиям Банка России",
+  "version": "0.1.1",
+  "description": "Bank of Russia UID generator for Node.js based on UUID v1 with checksum",
   "keywords": [
     "uuid",
-    "ЦБ",
-    "cb",
-    "cbr"
+    "uid",
+    "uuid-v1",
+    "cbr",
+    "bank-of-russia",
+    "central-bank-russia",
+    "bank-russia",
+    "bank-rossii",
+    "checksum"
   ],
   "main": "index.js",
   "module": "index.mjs",
@@ -27,6 +32,10 @@
   ],
   "sideEffects": false,
   "author": "kdinisv",
+  "homepage": "https://github.com/kdinisv/uuid-cbr#readme",
+  "bugs": {
+    "url": "https://github.com/kdinisv/uuid-cbr/issues"
+  },
   "repository": {
     "type": "git",
     "url": "https://github.com/kdinisv/uuid-cbr"