atabey-shared 0.0.20 → 0.0.21
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/README.md +50 -0
- package/package.json +8 -2
package/README.md
ADDED
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# atabey-shared
|
|
2
|
+
|
|
3
|
+
**Shared utility modules** for Atabey — AI Governance & Multi-Agent Platform / Orchestrator.
|
|
4
|
+
|
|
5
|
+
This package contains the common low-level utilities, types, and helpers used across `atabey` and `atabey-mcp`.
|
|
6
|
+
|
|
7
|
+
[](https://www.npmjs.com/package/atabey-shared)
|
|
8
|
+
[](https://www.gnu.org/licenses/agpl-3.0)
|
|
9
|
+
|
|
10
|
+
## What's Included
|
|
11
|
+
|
|
12
|
+
| Module | Purpose |
|
|
13
|
+
|-------------|---------|
|
|
14
|
+
| `audit` | Audit logging utilities |
|
|
15
|
+
| `constants` | Framework-wide constants |
|
|
16
|
+
| `database` | SQLite / Kysely helpers |
|
|
17
|
+
| `errors` | Structured error classes |
|
|
18
|
+
| `fs` | File system utilities |
|
|
19
|
+
| `lock` | File-based locking primitives |
|
|
20
|
+
| `logger` | Structured logging (pino-based) |
|
|
21
|
+
| `pii` | PII detection & masking |
|
|
22
|
+
| `retention` | Data retention policies |
|
|
23
|
+
| `string` | String & template helpers |
|
|
24
|
+
| `types` | Shared TypeScript types |
|
|
25
|
+
|
|
26
|
+
## Installation
|
|
27
|
+
|
|
28
|
+
This package is **not intended for direct use** outside the Atabey ecosystem.
|
|
29
|
+
|
|
30
|
+
```bash
|
|
31
|
+
npm install atabey-shared
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
It is automatically installed as a dependency of `atabey` and `atabey-mcp`.
|
|
35
|
+
|
|
36
|
+
## Usage (internal)
|
|
37
|
+
|
|
38
|
+
```ts
|
|
39
|
+
import { maskPII, createAuditEntry, AtabeyLock } from 'atabey-shared';
|
|
40
|
+
```
|
|
41
|
+
|
|
42
|
+
## License
|
|
43
|
+
|
|
44
|
+
AGPL-3.0 — see [LICENSE](https://github.com/ysf-bkr/atabey/blob/main/LICENSE) in the monorepo.
|
|
45
|
+
|
|
46
|
+
## Links
|
|
47
|
+
|
|
48
|
+
- [GitHub](https://github.com/ysf-bkr/atabey)
|
|
49
|
+
- [atabey on npm](https://www.npmjs.com/package/atabey)
|
|
50
|
+
- [atabey-mcp on npm](https://www.npmjs.com/package/atabey-mcp)
|
package/package.json
CHANGED
|
@@ -1,8 +1,13 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "atabey-shared",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.21",
|
|
4
4
|
"description": "Shared utility modules for Atabey — AI Governance & Multi-Agent Platform / Orchestrator",
|
|
5
|
+
"author": "Yusuf BEKAR",
|
|
5
6
|
"license": "AGPL-3.0",
|
|
7
|
+
"repository": {
|
|
8
|
+
"type": "git",
|
|
9
|
+
"url": "git+https://github.com/ysf-bkr/atabey.git"
|
|
10
|
+
},
|
|
6
11
|
"keywords": [
|
|
7
12
|
"mcp",
|
|
8
13
|
"model-context-protocol",
|
|
@@ -16,7 +21,8 @@
|
|
|
16
21
|
],
|
|
17
22
|
"type": "module",
|
|
18
23
|
"files": [
|
|
19
|
-
"dist"
|
|
24
|
+
"dist",
|
|
25
|
+
"README.md"
|
|
20
26
|
],
|
|
21
27
|
"main": "./dist/index.js",
|
|
22
28
|
"types": "./dist/index.d.ts",
|