@via-profit/ability 2.1.0 → 3.1.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.
- package/CHANGELOG.md +129 -0
- package/CONTRIBUTING.md +14 -0
- package/LICENSE +21 -0
- package/README.md +1058 -319
- package/SECURITY.md +33 -0
- package/dist/cache/AbilityCacheAdapter.d.ts +8 -0
- package/dist/cache/AbilityInMemoryCache.d.ts +12 -0
- package/dist/core/AbilityCondition.d.ts +21 -0
- package/dist/core/AbilityExplain.d.ts +27 -0
- package/dist/core/AbilityParser.d.ts +61 -0
- package/dist/core/AbilityPolicy.d.ts +84 -0
- package/dist/core/AbilityResolver.d.ts +35 -0
- package/dist/core/AbilityResult.d.ts +27 -0
- package/dist/core/AbilityRule.d.ts +77 -0
- package/dist/{AbilityRuleSet.d.ts → core/AbilityRuleSet.d.ts} +14 -11
- package/dist/index.d.ts +19 -11
- package/dist/index.js +2097 -303
- package/dist/parsers/dsl/AbilityDSLLexer.d.ts +24 -0
- package/dist/parsers/dsl/AbilityDSLParser.d.ts +86 -0
- package/dist/parsers/dsl/AbilityDSLSyntaxError.d.ts +13 -0
- package/dist/parsers/dsl/AbilityDSLToken.d.ts +55 -0
- package/dist/parsers/json/AbilityJSONParser.d.ts +22 -0
- package/package.json +15 -4
- package/assets/ability-01.drawio.png +0 -0
- package/build/playground.js +0 -456
- package/build/playground.js.map +0 -1
- package/dist/AbilityCondition.d.ts +0 -16
- package/dist/AbilityParser.d.ts +0 -18
- package/dist/AbilityPolicy.d.ts +0 -65
- package/dist/AbilityResolver.d.ts +0 -30
- package/dist/AbilityRule.d.ts +0 -70
- /package/dist/{AbilityCode.d.ts → core/AbilityCode.d.ts} +0 -0
- /package/dist/{AbilityCompare.d.ts → core/AbilityCompare.d.ts} +0 -0
- /package/dist/{AbilityError.d.ts → core/AbilityError.d.ts} +0 -0
- /package/dist/{AbilityMatch.d.ts → core/AbilityMatch.d.ts} +0 -0
- /package/dist/{AbilityPolicyEffect.d.ts → core/AbilityPolicyEffect.d.ts} +0 -0
package/CHANGELOG.md
ADDED
|
@@ -0,0 +1,129 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
## [3.2.0] - 2026-x3-xx
|
|
4
|
+
|
|
5
|
+
### Изменено
|
|
6
|
+
|
|
7
|
+
- Метод `AbilityPolicy.parseAll()` переименован в `AbilityPolicy.fromJSONAll()`
|
|
8
|
+
- Метод `AbilityPolicy.parse()` переименован в `AbilityPolicy.toJSON()`
|
|
9
|
+
- Метод `AbilityRule.parse()` переименован в `AbilityRule.toJSON()`
|
|
10
|
+
- Метод `AbilityRuleSet.parse()` переименован в `.toJSON()`
|
|
11
|
+
|
|
12
|
+
## [3.1.0] - 2026-03-20
|
|
13
|
+
|
|
14
|
+
### Добавлено
|
|
15
|
+
|
|
16
|
+
- Реализован кэш
|
|
17
|
+
- Добавлен кэш-провайдер `AbilityCacheProvider` для реализации кастомного кэша
|
|
18
|
+
- Реализован и включён по умолчанию `AbilityInMemoryCache` (кэш в памяти)
|
|
19
|
+
- Добавлена полноценная поддержка `environment` как третьего аргумента в:
|
|
20
|
+
- `resolver.resolve(action, resource, environment)`
|
|
21
|
+
- `resolver.enforce(action, resource, environment)`
|
|
22
|
+
- Введена возможность использовать пути вида `env.*` в правилах политик.
|
|
23
|
+
- Пример: `"subject": "env.time.hour"`
|
|
24
|
+
- Добавлена поддержка смешанных сравнений:
|
|
25
|
+
- `resource.*` ↔ `env.*`
|
|
26
|
+
- литерал ↔ `env.*`
|
|
27
|
+
- `env.*` ↔ литерал
|
|
28
|
+
|
|
29
|
+
### Breaking changes
|
|
30
|
+
|
|
31
|
+
Асинхронизация механизма проверки политик.
|
|
32
|
+
Все методы, участвующие в цепочке вычисления разрешений, теперь возвращают `Promise`.
|
|
33
|
+
|
|
34
|
+
#### Изменено
|
|
35
|
+
|
|
36
|
+
- `AbilityRule.check(resource): Promise<AbilityMatch>`
|
|
37
|
+
Ранее возвращал `AbilityMatch` синхронно.
|
|
38
|
+
|
|
39
|
+
- `AbilityRuleSet.check(resource): Promise<AbilityMatch>`
|
|
40
|
+
Теперь выполняет правила последовательно и асинхронно.
|
|
41
|
+
|
|
42
|
+
- `AbilityPolicy.check(resource): Promise<AbilityMatch>`
|
|
43
|
+
Асинхронно проверяет ruleSet в строгом порядке.
|
|
44
|
+
|
|
45
|
+
- `AbilityResolver.resolve(action, resource): Promise<AbilityResult>`
|
|
46
|
+
Теперь асинхронный метод, который дожидается выполнения всех политик.
|
|
47
|
+
|
|
48
|
+
- `AbilityResolver.enforce(action, resource): Promise<void | never>`
|
|
49
|
+
Теперь работает асинхронно.
|
|
50
|
+
|
|
51
|
+
### Миграция
|
|
52
|
+
|
|
53
|
+
1. Все вызовы `check()` должны быть обновлены:
|
|
54
|
+
|
|
55
|
+
```ts
|
|
56
|
+
await rule.check(resource);
|
|
57
|
+
await ruleSet.check(resource);
|
|
58
|
+
await policy.check(resource);
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
2. Все вызовы `resolver.resolve()` и `resolver.enforce()` теперь требуют `await`:
|
|
62
|
+
|
|
63
|
+
```ts
|
|
64
|
+
await resolver.resolve('order.update', resource);
|
|
65
|
+
await resolver.enforce('order.update', resource);
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
## [3.0.1] - 2026-03-19
|
|
69
|
+
|
|
70
|
+
## Добавлено
|
|
71
|
+
|
|
72
|
+
### 1. **Лицензия MIT** (`LICENSE`)
|
|
73
|
+
|
|
74
|
+
- Добавлен официальный файл лицензии MIT от Via Profit
|
|
75
|
+
|
|
76
|
+
### 2. **Класс `AbilityExplain.ts`**
|
|
77
|
+
|
|
78
|
+
- Новый класс для получения человекочитаемых объяснений результатов проверки
|
|
79
|
+
- Классы-наследники:
|
|
80
|
+
- `AbilityExplainRule` - объяснение для правила
|
|
81
|
+
- `AbilityExplainRuleSet` - объяснение для группы правил
|
|
82
|
+
- `AbilityExplainPolicy` - объяснение для политики
|
|
83
|
+
- Метод `toString()` форматирует вывод с отступами и символами ✓/✗
|
|
84
|
+
|
|
85
|
+
---
|
|
86
|
+
|
|
87
|
+
## Обновлено
|
|
88
|
+
|
|
89
|
+
### **AbilityParser.ts** (полная переработка)
|
|
90
|
+
|
|
91
|
+
- **Было**: Базовая генерация типов
|
|
92
|
+
- **Стало**: Расширенная система генерации TypeScript типов
|
|
93
|
+
- Новые методы:
|
|
94
|
+
- `determineTypeFromRule()` - определение типа на основе правила
|
|
95
|
+
- `getArrayType()` - обработка массивов
|
|
96
|
+
- `getPrimitiveType()` - определение примитивных типов
|
|
97
|
+
- `buildNestedStructure()` - трансформация плоской структуры во вложенную
|
|
98
|
+
- `formatTypeDefinitions()` - форматирование финального вывода
|
|
99
|
+
- `formatNestedObject()` - рекурсивное форматирование объектов
|
|
100
|
+
|
|
101
|
+
### **AbilityRule.ts**
|
|
102
|
+
|
|
103
|
+
- `id` и `name` теперь опциональные (`?`)
|
|
104
|
+
- Автогенерация `id` и `name` если не предоставлены
|
|
105
|
+
- **Новые статические методы** (фабричные методы):
|
|
106
|
+
- `equal()`, `notEqual()`, `in()`, `notIn()`
|
|
107
|
+
- `lessThan()`, `lessOrEqual()`, `moreThan()`, `moreOrEqual()`
|
|
108
|
+
|
|
109
|
+
### **AbilityRuleSet.ts**
|
|
110
|
+
|
|
111
|
+
- `id` и `name` теперь опциональные
|
|
112
|
+
- Добавлены статические методы:
|
|
113
|
+
- `and()` - создание группы с логическим И
|
|
114
|
+
- `or()` - создание группы с логическим ИЛИ
|
|
115
|
+
|
|
116
|
+
### **AbilityPolicy.ts**
|
|
117
|
+
|
|
118
|
+
- Новый метод `explain()` - получение объяснения проверки
|
|
119
|
+
- Новый статический метод `parseAll()` - парсинг массива конфигураций
|
|
120
|
+
- Улучшены комментарии к полю `action`
|
|
121
|
+
|
|
122
|
+
### **AbilityResolver.ts**
|
|
123
|
+
|
|
124
|
+
- Новый метод `resolveWithExplain()` - проверка с детальным объяснением
|
|
125
|
+
- Возвращает массив `AbilityExplain[]` для анализа результатов
|
|
126
|
+
|
|
127
|
+
---
|
|
128
|
+
|
|
129
|
+
## Обновлена документация и примеры
|
package/CONTRIBUTING.md
ADDED
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# Contributing to @via-profit/ability
|
|
2
|
+
|
|
3
|
+
## Development Setup
|
|
4
|
+
|
|
5
|
+
1. Fork the repository
|
|
6
|
+
2. Install dependencies: `npm install`
|
|
7
|
+
3. Build: `npm run build`
|
|
8
|
+
4. Test: `npm test`
|
|
9
|
+
|
|
10
|
+
## Pull Request Guidelines
|
|
11
|
+
|
|
12
|
+
- Update documentation
|
|
13
|
+
- Add tests for new features
|
|
14
|
+
- Follow existing code style
|
package/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Via Profit
|
|
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.
|