@greenarmor/ges-doc-generator 0.3.0 → 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 +62 -0
- package/package.json +2 -2
package/README.md
ADDED
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
# @greenarmor/ges-doc-generator
|
|
2
|
+
|
|
3
|
+
Compliance and security document template generation for the [Green Engineering Standard Framework (GESF)](https://github.com/greenarmor/gesf).
|
|
4
|
+
|
|
5
|
+
Generates structured Markdown documents, YAML configuration, and JSON metadata files for compliance directories including GDPR policies, security standards, threat models, and data inventories.
|
|
6
|
+
|
|
7
|
+
## Install
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install @greenarmor/ges-doc-generator
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Exports
|
|
14
|
+
|
|
15
|
+
| Export | Description |
|
|
16
|
+
|--------|-------------|
|
|
17
|
+
| `GeneratedFile` | Interface for generated output (filePath + content) |
|
|
18
|
+
| `generateComplianceDocs(name, type)` | Generate all compliance documents (GDPR, retention, DPIA, etc.) |
|
|
19
|
+
| `generateSecurityDocs(name, type)` | Generate all security documents (threat model, encryption, IR, etc.) |
|
|
20
|
+
| `generateConfigYaml(config)` | Generate `.ges/config.yaml` |
|
|
21
|
+
| `generateMetadataJson(config)` | Generate `.ges/metadata.json` |
|
|
22
|
+
| `generateConfigJson(config)` | Generate `.ges/config.json` |
|
|
23
|
+
| `generateFrameworkVersionJson()` | Generate `.ges/framework-version.json` |
|
|
24
|
+
| `generateScoreJson()` | Generate initial `.ges/score.json` |
|
|
25
|
+
|
|
26
|
+
## Usage
|
|
27
|
+
|
|
28
|
+
```typescript
|
|
29
|
+
import {
|
|
30
|
+
generateComplianceDocs,
|
|
31
|
+
generateSecurityDocs,
|
|
32
|
+
generateConfigYaml
|
|
33
|
+
} from '@greenarmor/ges-doc-generator';
|
|
34
|
+
|
|
35
|
+
const compliance = generateComplianceDocs('MyApp', 'saas');
|
|
36
|
+
const security = generateSecurityDocs('MyApp', 'saas');
|
|
37
|
+
|
|
38
|
+
// Write all files
|
|
39
|
+
[...compliance, ...security].forEach(file => {
|
|
40
|
+
fs.writeFileSync(file.filePath, file.content);
|
|
41
|
+
});
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
## Generated Documents
|
|
45
|
+
|
|
46
|
+
**Compliance** (`compliance/`):
|
|
47
|
+
- GDPR policy, data inventory, retention policy, processing records, risk register, access control matrix, privacy impact assessment
|
|
48
|
+
|
|
49
|
+
**Security** (`security/`):
|
|
50
|
+
- Threat model, key management, logging policy, backup policy, incident response, disaster recovery, encryption standard
|
|
51
|
+
|
|
52
|
+
**Configuration** (`.ges/`):
|
|
53
|
+
- config.yaml, metadata.json, score.json, framework-version.json
|
|
54
|
+
|
|
55
|
+
## Related Packages
|
|
56
|
+
|
|
57
|
+
- [`@greenarmor/ges-core`](https://www.npmjs.com/package/@greenarmor/ges-core) — Types and constants
|
|
58
|
+
- [`@greenarmor/ges-cicd-generator`](https://www.npmjs.com/package/@greenarmor/ges-cicd-generator) — CI/CD workflow generation
|
|
59
|
+
|
|
60
|
+
## License
|
|
61
|
+
|
|
62
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@greenarmor/ges-doc-generator",
|
|
3
|
-
"version": "0.3.
|
|
3
|
+
"version": "0.3.2",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "GESF Documentation Generator - Compliance and security document templates",
|
|
6
6
|
"main": "./dist/index.js",
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
}
|
|
13
13
|
},
|
|
14
14
|
"dependencies": {
|
|
15
|
-
"@greenarmor/ges-core": "0.3.
|
|
15
|
+
"@greenarmor/ges-core": "0.3.2"
|
|
16
16
|
},
|
|
17
17
|
"devDependencies": {
|
|
18
18
|
"typescript": "^6.0.0",
|