Skip to content

Commit 99377f5

Browse files
authored
Merge pull request #2104 from finos/release-1.2-revised
CALM Schema Release 1.2 - Timelines & Decorators
2 parents e639be9 + a5cc7c4 commit 99377f5

135 files changed

Lines changed: 5674 additions & 358 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

calm-ai/README.md

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -25,14 +25,17 @@ calm-ai/
2525
│ ├── architecture-creation.md
2626
│ ├── calm-cli-instructions.md
2727
│ ├── control-creation.md
28+
│ ├── decorator-creation.md
2829
│ ├── documentation-creation.md
2930
│ ├── flow-creation.md
3031
│ ├── interface-creation.md
3132
│ ├── metadata-creation.md
33+
│ ├── moment-creation.md
3234
│ ├── node-creation.md
3335
│ ├── pattern-creation.md
3436
│ ├── relationship-creation.md
35-
│ └── standards-creation.md
37+
│ ├── standards-creation.md
38+
│ └── timeline-creation.md
3639
└── package.json # Package metadata
3740
```
3841

@@ -45,14 +48,17 @@ Individual markdown files providing detailed guidance for specific CALM modeling
4548
| `architecture-creation.md` | Guide for creating complete CALM architecture documents with required schema structure |
4649
| `calm-cli-instructions.md` | Summary of CALM CLI commands, validation modes, and usage flags |
4750
| `control-creation.md` | Guide for defining control requirements and compliance configurations |
51+
| `decorator-creation.md` | Guide for creating decorators |
4852
| `documentation-creation.md` | Guide for generating documentation from CALM models |
4953
| `flow-creation.md` | Guide for modeling business process flows through architecture |
5054
| `interface-creation.md` | Critical guidance for interface definitions and oneOf constraints |
5155
| `metadata-creation.md` | Guide for adding metadata arrays with proper validation |
56+
| `moment-creation.md` | Guide for adding moments to timelines with proper validation |
5257
| `node-creation.md` | Guide for creating nodes (components) with proper validation |
5358
| `pattern-creation.md` | Guide for defining reusable architectural patterns |
5459
| `relationship-creation.md` | Guide for creating relationships between nodes |
5560
| `standards-creation.md` | Guide for creating JSON Schema Standards extending CALM with organizational requirements |
61+
| `timeline-creation.md` | Guide for creating architecture timelines |
5662

5763
Each tool prompt follows a consistent structure:
5864
- Overview and purpose
@@ -133,7 +139,10 @@ Configuration files in `ai-assistants/` define how to integrate CALM prompts wit
133139
"calm-prompts/flow-creation.md",
134140
"calm-prompts/pattern-creation.md",
135141
"calm-prompts/documentation-creation.md",
136-
"calm-prompts/standards-creation.md"
142+
"calm-prompts/standards-creation.md",
143+
"calm-prompts/moment-creation.md",
144+
"calm-prompts/timeline-creation.md",
145+
"calm-prompts/decorator-creation.md"
137146
]
138147
}
139148
```
@@ -165,7 +174,10 @@ Configuration files in `ai-assistants/` define how to integrate CALM prompts wit
165174
"calm-prompts/flow-creation.md",
166175
"calm-prompts/pattern-creation.md",
167176
"calm-prompts/documentation-creation.md",
168-
"calm-prompts/standards-creation.md"
177+
"calm-prompts/standards-creation.md",
178+
"calm-prompts/moment-creation.md",
179+
"calm-prompts/timeline-creation.md",
180+
"calm-prompts/decorator-creation.md"
169181
]
170182
}
171183
```
@@ -210,7 +222,7 @@ The template includes:
210222
### 2. Prompt Management
211223
- Provides modular, focused guidance for specific CALM tasks
212224
- Enforces validation requirements and best practices
213-
- References CALM schema v1.1 for accuracy
225+
- References CALM schema v1.2 for accuracy
214226
- Includes working examples and common pitfall warnings
215227

216228
### 3. Multi-provider Support
@@ -282,7 +294,7 @@ When editing `templates/CALM.chatmode_template.md`:
282294
## Validation Requirements
283295

284296
All tool prompts must:
285-
- Reference CALM schema v1.1
297+
- Reference CALM schema v1.2
286298
- Include mandatory validation steps
287299
- Provide `calm validate` commands
288300
- Emphasize `hasErrors: false` requirement
@@ -292,6 +304,6 @@ All tool prompts must:
292304
## Related Documentation
293305

294306
- **CALM CLI**: See `cli/AGENTS.md` for CLI command details
295-
- **CALM Schema**: https://calm.finos.org/release/1.1/meta/calm.json
307+
- **CALM Schema**: https://calm.finos.org/release/1.2/meta/calm.json
296308
- **User Docs**: https://calm.finos.org
297309
- **VSCode Extension**: See `calm-plugins/vscode/AGENTS.md`

calm-ai/ai-assistants/claude.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@
1616
"calm-prompts/flow-creation.md",
1717
"calm-prompts/pattern-creation.md",
1818
"calm-prompts/documentation-creation.md",
19-
"calm-prompts/standards-creation.md"
19+
"calm-prompts/standards-creation.md",
20+
"calm-prompts/moment-creation.md",
21+
"calm-prompts/timeline-creation.md",
22+
"calm-prompts/decorator-creation.md"
2023
]
2124
}

calm-ai/ai-assistants/copilot.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@
1616
"calm-prompts/flow-creation.md",
1717
"calm-prompts/pattern-creation.md",
1818
"calm-prompts/documentation-creation.md",
19-
"calm-prompts/standards-creation.md"
19+
"calm-prompts/standards-creation.md",
20+
"calm-prompts/moment-creation.md",
21+
"calm-prompts/timeline-creation.md",
22+
"calm-prompts/decorator-creation.md"
2023
]
2124
}

calm-ai/ai-assistants/kiro.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,9 @@
1616
"calm-prompts/flow-creation.md",
1717
"calm-prompts/pattern-creation.md",
1818
"calm-prompts/documentation-creation.md",
19-
"calm-prompts/standards-creation.md"
19+
"calm-prompts/standards-creation.md",
20+
"calm-prompts/moment-creation.md",
21+
"calm-prompts/timeline-creation.md",
22+
"calm-prompts/decorator-creation.md"
2023
]
2124
}

calm-ai/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@finos/calm-ai",
3-
"version": "1.0.0",
3+
"version": "1.2.0",
44
"description": "AI tools and prompts for FINOS CALM architecture modeling",
55
"private": true,
66
"main": "index.js",

calm-ai/templates/CALM.chatmode_template.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,14 @@ CALM enables modeling of:
1616
- **Flows** – business-level processes traversing your architecture
1717
- **Controls** – compliance policies and enforcement mechanisms
1818
- **Metadata** – supplemental, non-structural annotations
19+
- **Timelines** – evolution of architectures over time
20+
- **Decorators** – supplementary cross-cutting data (deployment, security, business context) attached to architecture elements without modifying the core definition
1921

2022
## Your Role
2123

2224
You specialize in helping users create, modify, and understand CALM architecture models. You have deep knowledge of:
2325

24-
- CALM schema validation requirements (release/1.1)
26+
- CALM schema validation requirements (release/1.2)
2527
- Best practices for architecture modeling
2628
- JSON schema constraints and validation rules
2729
- VSCode integration and tooling
@@ -40,7 +42,7 @@ On your first prompt in each session, you MUST:
4042

4143
## Guidelines
4244

43-
- Always validate CALM models against the 1.1 schema
45+
- Always validate CALM models against the 1.2 schema
4446
- Provide specific, actionable guidance for schema compliance
4547
- Reference the tool prompts for detailed creation instructions
4648
- Use examples that follow CALM best practices

calm-ai/tools/architecture-creation.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22

33
## Overview
44

5-
This guide provides instructions for creating complete CALM architecture documents that comply with the FINOS CALM v1.1 schema.
5+
This guide provides instructions for creating complete CALM architecture documents that comply with the FINOS CALM v1.2 schema.
66

77
## Required Schema Structure
88

99
Every CALM architecture MUST include:
1010

1111
```json
1212
{
13-
"$schema": "https://calm.finos.org/release/1.1/meta/calm.json",
13+
"$schema": "https://calm.finos.org/release/1.2/meta/calm.json",
1414
"unique-id": "string",
1515
"name": "string",
1616
"description": "string"
@@ -31,7 +31,7 @@ Every CALM architecture MUST include:
3131

3232
## Architecture Creation Checklist
3333

34-
- [ ] Include required $schema reference to CALM v1.1
34+
- [ ] Include required $schema reference to CALM v1.2
3535
- [ ] Provide unique-id (kebab-case recommended)
3636
- [ ] Add descriptive name and description
3737
- [ ] Name file with `.architecture.json` suffix
@@ -61,7 +61,7 @@ Every CALM architecture MUST include:
6161

6262
```json
6363
{
64-
"$schema": "https://calm.finos.org/release/1.1/meta/calm.json",
64+
"$schema": "https://calm.finos.org/release/1.2/meta/calm.json",
6565
"unique-id": "example-trading-system",
6666
"name": "Example Trading System",
6767
"description": "A simple trading system architecture",

calm-ai/tools/control-creation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
## Official JSON Schema Definition
88

9-
The complete control schema from the FINOS CALM v1.1 specification:
9+
The complete control schema from the FINOS CALM v1.2 specification:
1010

1111
```json
1212
{
@@ -118,7 +118,7 @@ Applied to the entire architecture document - affects all components:
118118

119119
```json
120120
{
121-
"calm-version": "1.0.0",
121+
"calm-version": "1.2.0",
122122
"architecture-version": "1.0.0",
123123
"controls": {
124124
"data-residency": {

0 commit comments

Comments
 (0)