@boristype/ws-version 0.1.0-alpha.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +161 -0
  3. package/index.d.ts +64 -0
  4. package/index.js +207 -0
  5. package/package.json +45 -0
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025 BorisType
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,161 @@
1
+ # WS Version Converter — Конвертер версий
2
+
3
+ Утилита для преобразования semver версий в формат целевой системы (4 компонента).
4
+
5
+ ## Установка
6
+
7
+ ```bash
8
+ npm install
9
+ ```
10
+
11
+ ## Использование
12
+
13
+ ```javascript
14
+ import {
15
+ convertSemverToWsVersion,
16
+ convertSemverRangeToWsRange,
17
+ compareWsVersions,
18
+ isValidWsVersion,
19
+ isValidWsRange
20
+ } from './index.js';
21
+
22
+ // Преобразование semver в ws-формат
23
+ const wsVersion = convertSemverToWsVersion('1.2.3-beta.1');
24
+ console.log(wsVersion); // "1.2.3.2001"
25
+
26
+ // Преобразование промежутков версий
27
+ const wsRange = convertSemverRangeToWsRange('^1.2.3');
28
+ console.log(wsRange); // "^1.2.3.9999"
29
+
30
+ const anyVersion = convertSemverRangeToWsRange('*');
31
+ console.log(anyVersion); // "^0.0.0.0"
32
+
33
+ // Сравнение ws-версий
34
+ const result = compareWsVersions('1.0.0.1001', '1.0.0.9999');
35
+ console.log(result); // -1 (альфа меньше обычной версии)
36
+
37
+ // Проверка валидности
38
+ console.log(isValidWsVersion('1.0.0')); // true
39
+ console.log(isValidWsRange('^1.0.0.0')); // true
40
+ console.log(isValidWsRange('~1.0.0.0')); // false (тильда не поддерживается)
41
+ ```
42
+
43
+ ## Формат целевой системы
44
+
45
+ Целевая система использует версии из 3-4 компонентов в формате `major.minor.patch[.fourth]`:
46
+
47
+ - Компоненты - неотрицательные числа
48
+ - Разделитель - точка
49
+ - Могут содержать лидирующие нули (например, `0.01.002`)
50
+ - Максимальная граница компонентов не ограничена (может превышать 255 и 65535)
51
+
52
+ ## Алгоритм преобразования
53
+
54
+ 1. **major.minor.patch** - переносятся как есть из semver
55
+ 2. **fourth** - кодирует prerelease информацию:
56
+ - Если prerelease нет → `9999` (максимальный приоритет)
57
+ - `alpha.N` → `1000 + N`
58
+ - `beta.N` → `2000 + N`
59
+ - `rc.N` → `3000 + N`
60
+ - Другие строки → `4000 + hash(string) % 1000`
61
+ - Только числа → `5000 + number`
62
+
63
+ Это обеспечивает правильный порядок: prerelease < обычная версия.
64
+
65
+ ## Ограничения
66
+
67
+ - Компоненты semver (major, minor, patch) не могут превышать 999
68
+ - Информация о build (`+metadata`) игнорируется
69
+ - Порядок сортировки semver сохраняется в ws-формате
70
+ - Prerelease версии меньше обычных версий
71
+
72
+ ## Примеры преобразования
73
+
74
+ | semver | ws-формат | Описание |
75
+ |--------|-----------|----------|
76
+ | `1.0.0` | `1.0.0.9999` | Стандартная версия |
77
+ | `1.0.0-alpha.1` | `1.0.0.1001` | Alpha с номером |
78
+ | `1.0.0-beta.5` | `1.0.0.2005` | Beta с номером |
79
+ | `1.0.0-rc.1` | `1.0.0.3001` | Release candidate |
80
+ | `2.1.0+build.123` | `2.1.0.9999` | Build metadata игнорируется |
81
+
82
+ ## Промежутки версий (Version Ranges)
83
+
84
+ Модуль поддерживает преобразование промежутков версий semver в ws-формат:
85
+
86
+ ### Поддерживаемые промежутки:
87
+ - **Точная версия**: `1.2.3` → `1.2.3.9999`
88
+ - **Caret (совместимые)**: `^1.2.3` → `^1.2.3.9999`
89
+ - **Tilde (приблизительно эквивалентные)**: `~1.2.3` → `^1.2.3.9999`
90
+ - **Любая версия**: `*` → `^0.0.0.0`
91
+
92
+ Примечание: tilde (`~`) преобразуется в caret (`^`), так как ws-формат поддерживает только caret.
93
+
94
+ ### Примеры преобразования ranges:
95
+ | semver range | ws range | Описание |
96
+ |--------------|----------|----------|
97
+ | `1.0.0` | `1.0.0.9999` | Точная версия |
98
+ | `^1.2.3` | `^1.2.3.9999` | Совместимые версии |
99
+ | `~1.2.3` | `^1.2.3.9999` | Приблизительно эквивалентные |
100
+ | `*` | `^0.0.0.0` | Любая версия |
101
+ | `^1.0.0-alpha.1` | `^1.0.0.1001` | Caret с prerelease |
102
+
103
+ **Порядок сортировки:** 1.0.0-alpha.1 < 1.0.0-beta.5 < 1.0.0-rc.1 < 1.0.0 ✅
104
+
105
+ ## API
106
+
107
+ ### `convertSemverToWsVersion(version: string): string`
108
+
109
+ Преобразует semver версию в ws-формат.
110
+
111
+ **Параметры:**
112
+ - `version` - Версия в формате semver
113
+
114
+ **Возвращает:** Версию в формате `x.y.z.w`
115
+
116
+ **Исключения:** `Error` если версия невалидна или содержит компоненты > 999
117
+
118
+ ### `compareWsVersions(version1: string, version2: string): -1 | 0 | 1`
119
+
120
+ Сравнивает две ws-версии.
121
+
122
+ **Возвращает:**
123
+ - `-1` если version1 < version2
124
+ - `0` если version1 === version2
125
+ - `1` если version1 > version2
126
+
127
+ ### `isValidWsVersion(version: string): boolean`
128
+
129
+ Проверяет валидность ws-версии.
130
+
131
+ **Параметры:**
132
+ - `version` - Версия для проверки
133
+
134
+ **Возвращает:** `true` если версия валидна
135
+
136
+ ### `convertSemverRangeToWsRange(range: string): string`
137
+
138
+ Преобразует промежуток semver версий в ws-формат.
139
+
140
+ **Параметры:**
141
+ - `range` - Промежуток версий в формате semver (например, "^1.2.3", "~1.2.3", "*")
142
+
143
+ **Возвращает:** Промежуток версий в формате ws
144
+
145
+ **Исключения:** `Error` если промежуток невалиден
146
+
147
+ ### `isValidWsRange(range: string): boolean`
148
+
149
+ Проверяет валидность ws-промежутка версий.
150
+
151
+ ## Тестирование
152
+
153
+ ```bash
154
+ npm test
155
+ # или
156
+ node test.js
157
+ ```
158
+
159
+ ## Лицензия
160
+
161
+ MIT
package/index.d.ts ADDED
@@ -0,0 +1,64 @@
1
+ /**
2
+ * Преобразует semver версию в формат целевой системы (4 компонента)
3
+ * @param version - Версия в формате semver
4
+ * @returns Версия в формате x.y.z.w
5
+ * @throws {Error} Если версия невалидна или содержит компоненты > 999
6
+ */
7
+ export function convertSemverToWsVersion(version: string): string;
8
+
9
+ /**
10
+ * Сравнивает две версии в ws-формате
11
+ * @param version1 - Первая версия
12
+ * @param version2 - Вторая версия
13
+ * @returns Результат сравнения (-1 если v1 < v2, 0 если равны, 1 если v1 > v2)
14
+ */
15
+ export function compareWsVersions(version1: string, version2: string): -1 | 0 | 1;
16
+
17
+ /**
18
+ * Проверяет валидность ws-версии
19
+ * @param version - Версия для проверки
20
+ * @returns true если версия валидна
21
+ */
22
+ export function isValidWsVersion(version: string): boolean;
23
+
24
+ /**
25
+ * Кодирует prerelease информацию в число, сохраняя порядок сортировки
26
+ * @param prerelease - Массив prerelease компонентов
27
+ * @returns Закодированный номер
28
+ */
29
+ export function encodePrereleaseToNumber(prerelease: readonly (string | number)[]): number;
30
+
31
+ /**
32
+ * Преобразует промежуток версий semver в формат ws
33
+ * @param range - Промежуток версий в формате semver (например, "^1.2.3", "~1.2.3", "*")
34
+ * @returns Промежуток версий в формате ws
35
+ * @throws {Error} Если промежуток невалиден
36
+ */
37
+ export function convertSemverRangeToWsRange(range: string): string;
38
+
39
+ /**
40
+ * Проверяет валидность ws-промежутка версий
41
+ * @param range - Промежуток версий для проверки
42
+ * @returns true если промежуток валиден
43
+ */
44
+ export function isValidWsRange(range: string): boolean;
45
+
46
+ /**
47
+ * Тип для версии в ws-формате
48
+ */
49
+ export type WsVersion = string;
50
+
51
+ /**
52
+ * Тип для промежутка версий в ws-формате
53
+ */
54
+ export type WsVersionRange = string;
55
+
56
+ /**
57
+ * Опции для преобразования версий
58
+ */
59
+ export interface ConversionOptions {
60
+ /** Максимальное значение для компонентов (по умолчанию 999) */
61
+ maxComponentValue?: number;
62
+ /** Строгая проверка semver */
63
+ strict?: boolean;
64
+ }
package/index.js ADDED
@@ -0,0 +1,207 @@
1
+ import semver from 'semver';
2
+
3
+ /**
4
+ * Преобразует semver версию в формат целевой системы (4 компонента)
5
+ * @param {string} version - Версия в формате semver
6
+ * @returns {string} Версия в формате x.y.z.w
7
+ * @throws {Error} Если версия невалидна или содержит компоненты > 999
8
+ */
9
+ function convertSemverToWsVersion(version) {
10
+ // Парсим semver версию
11
+ const parsed = semver.parse(version);
12
+ if (!parsed) {
13
+ throw new Error(`Invalid semver version: ${version}`);
14
+ }
15
+
16
+ const { major, minor, patch, prerelease } = parsed;
17
+
18
+ // Проверяем ограничения (не больше 999)
19
+ if (major > 999 || minor > 999 || patch > 999) {
20
+ throw new Error(`Version components cannot exceed 999: ${version}`);
21
+ }
22
+
23
+ // Четвертый компонент для prerelease
24
+ let fourth = 9999; // Обычные версии получают максимальное значение
25
+
26
+ if (prerelease && prerelease.length > 0) {
27
+ fourth = encodePrereleaseToNumber(prerelease);
28
+ }
29
+
30
+ return `${major}.${minor}.${patch}.${fourth}`;
31
+ }
32
+
33
+ /**
34
+ * Кодирует prerelease информацию в число, сохраняя порядок сортировки
35
+ * Обычные релизы получают значение 9999, prerelease - меньшие значения
36
+ * @param {Array} prerelease - Массив prerelease компонентов
37
+ * @returns {number} Закодированный номер
38
+ */
39
+ function encodePrereleaseToNumber(prerelease) {
40
+ if (!prerelease || prerelease.length === 0) {
41
+ return 9999; // Обычные версии имеют максимальный приоритет
42
+ }
43
+
44
+ // Определяем базовое значение на основе типа prerelease
45
+ const firstComponent = prerelease[0];
46
+ let base = 0;
47
+
48
+ if (typeof firstComponent === 'string') {
49
+ switch (firstComponent.toLowerCase()) {
50
+ case 'alpha':
51
+ base = 1000;
52
+ break;
53
+ case 'beta':
54
+ base = 2000;
55
+ break;
56
+ case 'rc':
57
+ base = 3000;
58
+ break;
59
+ default:
60
+ // Для неизвестных строковых компонентов используем хеш
61
+ base = 4000 + hashString(firstComponent) % 1000;
62
+ break;
63
+ }
64
+ } else if (typeof firstComponent === 'number') {
65
+ base = 5000;
66
+ }
67
+
68
+ // Добавляем числовой компонент если есть
69
+ let offset = 0;
70
+ if (prerelease.length > 1 && typeof prerelease[1] === 'number') {
71
+ offset = Math.min(prerelease[1], 999); // Ограничиваем 999
72
+ } else if (typeof firstComponent === 'number') {
73
+ offset = Math.min(firstComponent, 999);
74
+ }
75
+
76
+ return base + offset;
77
+ }
78
+
79
+ /**
80
+ * Простая хеш-функция для строк
81
+ * @param {string} str - Строка для хеширования
82
+ * @returns {number} Хеш-код
83
+ */
84
+ function hashString(str) {
85
+ let hash = 0;
86
+ for (let i = 0; i < str.length; i++) {
87
+ const char = str.charCodeAt(i);
88
+ hash = ((hash << 5) - hash) + char;
89
+ hash = hash & hash; // Преобразуем в 32-битное целое
90
+ }
91
+ return Math.abs(hash);
92
+ }
93
+
94
+ /**
95
+ * Сравнивает две версии в ws-формате
96
+ * @param {string} version1 - Первая версия
97
+ * @param {string} version2 - Вторая версия
98
+ * @returns {-1|0|1} Результат сравнения (-1 если v1 < v2, 0 если равны, 1 если v1 > v2)
99
+ */
100
+ function compareWsVersions(version1, version2) {
101
+ const v1Parts = version1.split('.').map(Number);
102
+ const v2Parts = version2.split('.').map(Number);
103
+
104
+ for (let i = 0; i < 4; i++) {
105
+ const v1Part = v1Parts[i] || 0;
106
+ const v2Part = v2Parts[i] || 0;
107
+
108
+ if (v1Part < v2Part) return -1;
109
+ if (v1Part > v2Part) return 1;
110
+ }
111
+
112
+ return 0;
113
+ }
114
+
115
+ /**
116
+ * Проверяет валидность ws-версии
117
+ * @param {string} version - Версия для проверки
118
+ * @returns {boolean} true если версия валидна
119
+ */
120
+ function isValidWsVersion(version) {
121
+ const parts = version.split('.');
122
+ if (parts.length < 3 || parts.length > 4) {
123
+ return false;
124
+ }
125
+
126
+ return parts.every(part => {
127
+ // Проверяем что это строка из цифр (могут быть лидирующие нули)
128
+ if (!/^\d+$/.test(part)) {
129
+ return false;
130
+ }
131
+ const num = parseInt(part, 10);
132
+ return !isNaN(num) && num >= 0;
133
+ });
134
+ }
135
+
136
+ /**
137
+ * Преобразует промежуток версий semver в формат ws
138
+ * @param {string} range - Промежуток версий в формате semver (например, "^1.2.3", "~1.2.3", "*")
139
+ * @returns {string} Промежуток версий в формате ws
140
+ * @throws {Error} Если промежуток невалиден
141
+ */
142
+ function convertSemverRangeToWsRange(range) {
143
+ // Убираем лишние пробелы
144
+ const trimmedRange = range.trim();
145
+
146
+ // Обрабатываем специальный случай *
147
+ if (trimmedRange === '*') {
148
+ return '^0.0.0.0';
149
+ }
150
+
151
+ // Проверяем наличие префиксов ^ или ~
152
+ const hasCaretPrefix = trimmedRange.startsWith('^');
153
+ const hasTildePrefix = trimmedRange.startsWith('~');
154
+
155
+ let version;
156
+ if (hasCaretPrefix || hasTildePrefix) {
157
+ // Убираем префикс для парсинга
158
+ version = trimmedRange.slice(1);
159
+ } else {
160
+ // Точная версия без префикса
161
+ version = trimmedRange;
162
+ }
163
+
164
+ // Преобразуем базовую версию
165
+ let wsVersion;
166
+ try {
167
+ wsVersion = convertSemverToWsVersion(version);
168
+ } catch (error) {
169
+ throw new Error(`Invalid version in range "${range}": ${error.message}`);
170
+ }
171
+
172
+ // Для ^ и ~ добавляем префикс ^ в ws-формате
173
+ if (hasCaretPrefix || hasTildePrefix) {
174
+ return `^${wsVersion}`;
175
+ }
176
+
177
+ // Для точных версий возвращаем как есть
178
+ return wsVersion;
179
+ }
180
+
181
+ /**
182
+ * Проверяет валидность ws-промежутка версий
183
+ * @param {string} range - Промежуток версий для проверки
184
+ * @returns {boolean} true если промежуток валиден
185
+ */
186
+ function isValidWsRange(range) {
187
+ const trimmedRange = range.trim();
188
+
189
+ // Проверяем наличие префикса ^
190
+ if (trimmedRange.startsWith('^')) {
191
+ const version = trimmedRange.slice(1);
192
+ return isValidWsVersion(version);
193
+ }
194
+
195
+ // Проверяем как обычную версию
196
+ return isValidWsVersion(trimmedRange);
197
+ }
198
+
199
+ // Экспортируем функции
200
+ export {
201
+ convertSemverToWsVersion,
202
+ convertSemverRangeToWsRange,
203
+ compareWsVersions,
204
+ isValidWsVersion,
205
+ isValidWsRange,
206
+ encodePrereleaseToNumber
207
+ };
package/package.json ADDED
@@ -0,0 +1,45 @@
1
+ {
2
+ "name": "@boristype/ws-version",
3
+ "version": "0.1.0-alpha.0",
4
+ "description": "Утилита для преобразования semver версий в формат целевой системы",
5
+ "type": "module",
6
+ "main": "index.js",
7
+ "types": "index.d.ts",
8
+ "files": [
9
+ "index.js",
10
+ "index.d.ts",
11
+ "README.md"
12
+ ],
13
+ "dependencies": {
14
+ "semver": "^7.0.0"
15
+ },
16
+ "devDependencies": {
17
+ "@types/semver": "^7.0.0",
18
+ "typescript": "^5.9.2"
19
+ },
20
+ "keywords": [
21
+ "version",
22
+ "semver",
23
+ "conversion"
24
+ ],
25
+ "author": "BorisType Project",
26
+ "license": "MIT",
27
+ "repository": {
28
+ "type": "git",
29
+ "url": "git+https://github.com/BorisType/BorisType.git"
30
+ },
31
+ "bugs": {
32
+ "url": "https://github.com/BorisType/BorisType/issues"
33
+ },
34
+ "homepage": "https://github.com/BorisType/BorisType#readme",
35
+ "publishConfig": {
36
+ "access": "public"
37
+ },
38
+ "engines": {
39
+ "node": ">=22.0.0"
40
+ },
41
+ "scripts": {
42
+ "build": "tsc",
43
+ "test": "node test.js"
44
+ }
45
+ }