@tekyzinc/gsd-t 2.33.12 → 2.34.11
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 +1 -0
- package/bin/gsd-t.js +8 -0
- package/bin/scan-data-collector.js +153 -0
- package/bin/scan-diagrams-generators.js +187 -0
- package/bin/scan-diagrams.js +79 -0
- package/bin/scan-export.js +49 -0
- package/bin/scan-renderer.js +92 -0
- package/bin/scan-report-sections.js +121 -0
- package/bin/scan-report.js +181 -0
- package/bin/scan-schema-parsers.js +199 -0
- package/bin/scan-schema.js +103 -0
- package/commands/gsd-t-impact.md +33 -1
- package/commands/gsd-t-partition.md +72 -0
- package/commands/gsd-t-plan.md +31 -0
- package/commands/gsd-t-scan.md +88 -1
- package/docs/architecture.md +16 -2
- package/docs/infrastructure.md +23 -6
- package/docs/requirements.md +119 -1
- package/docs/workflows.md +67 -1
- package/package.json +1 -1
- package/templates/shared-services-contract.md +60 -0
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
# Shared Services Contract
|
|
2
|
+
**Project**: {Project Name}
|
|
3
|
+
**Milestone**: {Milestone Name}
|
|
4
|
+
**Updated**: {Date}
|
|
5
|
+
|
|
6
|
+
This contract documents backend functions and operations shared across multiple consumer surfaces.
|
|
7
|
+
All surfaces that need a shared operation MUST call it through the `shared-core` domain —
|
|
8
|
+
never implement a duplicate.
|
|
9
|
+
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
## Consumer Surfaces
|
|
13
|
+
|
|
14
|
+
| Surface | Type | Adapter Domain |
|
|
15
|
+
|--------------|----------------|---------------------|
|
|
16
|
+
| {Web App} | web | {web-api domain} |
|
|
17
|
+
| {Mobile App} | mobile | {mobile-api domain} |
|
|
18
|
+
| {CLI} | cli | {cli domain} |
|
|
19
|
+
|
|
20
|
+
---
|
|
21
|
+
|
|
22
|
+
## Shared Operations
|
|
23
|
+
|
|
24
|
+
| Operation | Description | Owner Domain | Consumers |
|
|
25
|
+
|------------------|--------------------------------------|---------------|-------------------------|
|
|
26
|
+
| {operation-name} | {what it does} | shared-core | web-api, mobile-api |
|
|
27
|
+
| {operation-name} | {what it does} | shared-core | web-api, cli |
|
|
28
|
+
|
|
29
|
+
### Function Signatures
|
|
30
|
+
|
|
31
|
+
```
|
|
32
|
+
{operationName}(params: {ParamType}): {ReturnType}
|
|
33
|
+
- {param}: {description}
|
|
34
|
+
- Returns: {description}
|
|
35
|
+
- Errors: {error conditions}
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
---
|
|
39
|
+
|
|
40
|
+
## SharedCore Domain Boundaries
|
|
41
|
+
|
|
42
|
+
**shared-core owns:**
|
|
43
|
+
- Business logic for all shared operations above
|
|
44
|
+
- Data access for shared operations
|
|
45
|
+
- Input validation for shared operations
|
|
46
|
+
|
|
47
|
+
**shared-core does NOT own:**
|
|
48
|
+
- HTTP route handlers (owned by surface-specific adapter domains)
|
|
49
|
+
- Surface-specific response formatting
|
|
50
|
+
- Auth/session handling (owned by auth domain)
|
|
51
|
+
|
|
52
|
+
---
|
|
53
|
+
|
|
54
|
+
## Violation Rule
|
|
55
|
+
|
|
56
|
+
If a surface-specific domain implements an operation that matches a shared operation above,
|
|
57
|
+
that is a **contract violation**. The implementation must be moved to shared-core.
|
|
58
|
+
|
|
59
|
+
Flag during: `gsd-t-impact` (New Consumer Analysis), `gsd-t-plan` (Duplicate Operation Scan),
|
|
60
|
+
and `gsd-t-verify` (contract compliance check).
|