@greenarmor/ges-core 0.3.1 → 0.3.2
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 +73 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
# @greenarmor/ges-core
|
|
2
|
+
|
|
3
|
+
Core types, Zod schemas, and constants for the [Green Engineering Standard Framework (GESF)](https://github.com/greenarmor/gesf).
|
|
4
|
+
|
|
5
|
+
This is the foundation package that all other GESF packages depend on. It provides shared TypeScript interfaces, runtime validation schemas, and compliance-related constants used across the framework.
|
|
6
|
+
|
|
7
|
+
## Install
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install @greenarmor/ges-core
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Exports
|
|
14
|
+
|
|
15
|
+
### Types
|
|
16
|
+
|
|
17
|
+
| Type | Description |
|
|
18
|
+
|------|-------------|
|
|
19
|
+
| `ProjectType` | Supported project types (SaaS, AI, MCP Server, Blockchain, etc.) |
|
|
20
|
+
| `FrameworkName` | Compliance framework identifiers (GDPR, OWASP, NIST, CIS) |
|
|
21
|
+
| `DataClassification` | Data sensitivity levels (Public, Internal, Confidential, Restricted) |
|
|
22
|
+
| `ControlStatus` | Control evaluation states (pass, fail, warning, not_applicable) |
|
|
23
|
+
| `ReportFormat` | Output formats (markdown, html, pdf) |
|
|
24
|
+
| `ProjectConfig` | Project configuration interface |
|
|
25
|
+
| `Requirements` | Compliance requirements configuration |
|
|
26
|
+
| `Control` | Individual compliance control |
|
|
27
|
+
| `ControlCheck` | Control evaluation result |
|
|
28
|
+
| `ComplianceScore` | Per-framework scoring result |
|
|
29
|
+
| `ScoreFile` | Overall score file structure |
|
|
30
|
+
| `AuditEntry` | Audit trail entry |
|
|
31
|
+
| `PolicyPack` | Policy pack definition |
|
|
32
|
+
| `ReportOptions` | Report generation options |
|
|
33
|
+
|
|
34
|
+
### Constants
|
|
35
|
+
|
|
36
|
+
| Constant | Description |
|
|
37
|
+
|----------|-------------|
|
|
38
|
+
| `GESF_VERSION` | Framework version string |
|
|
39
|
+
| `PROJECT_TYPES` | All supported project types with labels |
|
|
40
|
+
| `FRAMEWORKS` | Supported compliance frameworks |
|
|
41
|
+
| `DEFAULT_FRAMEWORKS` | Default frameworks for new projects |
|
|
42
|
+
| `PROJECT_TYPE_PACKS` | Mapping of project types to policy packs |
|
|
43
|
+
| `DATA_CLASSIFICATIONS` | Data classification levels |
|
|
44
|
+
| `APPROVED_ENCRYPTION` | Approved encryption algorithms |
|
|
45
|
+
| `APPROVED_HASHING` | Approved hashing algorithms (Argon2id, bcrypt) |
|
|
46
|
+
| `REJECTED_HASHING` | Rejected hashing algorithms (MD5, SHA1) |
|
|
47
|
+
| `AUDIT_LOG_FIELDS` | Required fields for audit log entries |
|
|
48
|
+
| `MUST_LOG_EVENTS` | Events that must be logged |
|
|
49
|
+
| `MUST_NOT_LOG` | Data that must never appear in logs |
|
|
50
|
+
| `DB_AUDIT_COLUMNS` | Required database audit columns |
|
|
51
|
+
|
|
52
|
+
### Schemas (Zod)
|
|
53
|
+
|
|
54
|
+
Runtime validation schemas for all types: `ProjectConfigSchema`, `ControlSchema`, `AuditEntrySchema`, `ReportOptionsSchema`, and more.
|
|
55
|
+
|
|
56
|
+
## Usage
|
|
57
|
+
|
|
58
|
+
```typescript
|
|
59
|
+
import { ControlSchema, APPROVED_ENCRYPTION, GESF_VERSION } from '@greenarmor/ges-core';
|
|
60
|
+
|
|
61
|
+
const control = ControlSchema.parse({
|
|
62
|
+
id: 'enc-001',
|
|
63
|
+
name: 'Encryption at Rest',
|
|
64
|
+
framework: 'GDPR',
|
|
65
|
+
status: 'pass',
|
|
66
|
+
});
|
|
67
|
+
|
|
68
|
+
console.log(APPROVED_ENCRYPTION); // ['AES-256-GCM', 'ChaCha20-Poly1305', ...]
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
## License
|
|
72
|
+
|
|
73
|
+
MIT
|