@cratis/screenplay-language 4.52.0 → 4.54.0

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.
Files changed (191) hide show
  1. package/README.md +15 -0
  2. package/dist/TypeReferenceSymbol.d.ts +8 -0
  3. package/dist/TypeReferenceSymbol.d.ts.map +1 -0
  4. package/dist/bundles/chunk-GJX4NJYC.js +4836 -0
  5. package/dist/bundles/chunk-GJX4NJYC.js.map +7 -0
  6. package/dist/bundles/index.js +1417 -0
  7. package/dist/bundles/index.js.map +7 -0
  8. package/dist/bundles/sub-languages/capture/index.js +677 -0
  9. package/dist/bundles/sub-languages/capture/index.js.map +7 -0
  10. package/dist/bundles/sub-languages/projection/index.js +1647 -0
  11. package/dist/bundles/sub-languages/projection/index.js.map +7 -0
  12. package/dist/code-actions.d.ts +3 -0
  13. package/dist/code-actions.d.ts.map +1 -0
  14. package/dist/completion-items.d.ts +1 -0
  15. package/dist/completion-items.d.ts.map +1 -1
  16. package/dist/completion-planner.d.ts.map +1 -1
  17. package/dist/completions.d.ts.map +1 -1
  18. package/dist/diagnostic-codes.d.ts +3 -0
  19. package/dist/diagnostic-codes.d.ts.map +1 -1
  20. package/dist/diagnostics.d.ts.map +1 -1
  21. package/dist/hover-content.d.ts.map +1 -1
  22. package/dist/index.d.ts +3 -0
  23. package/dist/index.d.ts.map +1 -1
  24. package/dist/keyword-docs.d.ts.map +1 -1
  25. package/dist/language.d.ts +1 -0
  26. package/dist/language.d.ts.map +1 -1
  27. package/dist/production-destinations.d.ts.map +1 -1
  28. package/dist/symbols.d.ts +4 -0
  29. package/dist/symbols.d.ts.map +1 -1
  30. package/dist/tokens.d.ts.map +1 -1
  31. package/dist/validation.d.ts +1 -0
  32. package/dist/validation.d.ts.map +1 -1
  33. package/package.json +13 -9
  34. package/DestinationHint.ts +0 -8
  35. package/ProductionSymbol.ts +0 -11
  36. package/completion-items.ts +0 -261
  37. package/completion-planner.ts +0 -167
  38. package/completions.ts +0 -156
  39. package/diagnostic-codes.ts +0 -43
  40. package/diagnostics.ts +0 -55
  41. package/dist/DestinationHint.js +0 -4
  42. package/dist/DestinationHint.js.map +0 -1
  43. package/dist/ProductionSymbol.js +0 -4
  44. package/dist/ProductionSymbol.js.map +0 -1
  45. package/dist/completion-items.js +0 -228
  46. package/dist/completion-items.js.map +0 -1
  47. package/dist/completion-planner.js +0 -143
  48. package/dist/completion-planner.js.map +0 -1
  49. package/dist/completions.js +0 -101
  50. package/dist/completions.js.map +0 -1
  51. package/dist/diagnostic-codes.js +0 -41
  52. package/dist/diagnostic-codes.js.map +0 -1
  53. package/dist/diagnostics.js +0 -50
  54. package/dist/diagnostics.js.map +0 -1
  55. package/dist/document-context.js +0 -85
  56. package/dist/document-context.js.map +0 -1
  57. package/dist/event-analysis-source.js +0 -19
  58. package/dist/event-analysis-source.js.map +0 -1
  59. package/dist/event-context-catalog.js +0 -116
  60. package/dist/event-context-catalog.js.map +0 -1
  61. package/dist/event-context.js +0 -88
  62. package/dist/event-context.js.map +0 -1
  63. package/dist/file-imports.js +0 -58
  64. package/dist/file-imports.js.map +0 -1
  65. package/dist/file-references.js +0 -70
  66. package/dist/file-references.js.map +0 -1
  67. package/dist/hover-content.js +0 -98
  68. package/dist/hover-content.js.map +0 -1
  69. package/dist/hover.js +0 -15
  70. package/dist/hover.js.map +0 -1
  71. package/dist/index.js +0 -61
  72. package/dist/index.js.map +0 -1
  73. package/dist/inlay-hints.js +0 -15
  74. package/dist/inlay-hints.js.map +0 -1
  75. package/dist/inline-event-validation.js +0 -131
  76. package/dist/inline-event-validation.js.map +0 -1
  77. package/dist/keyword-docs.js +0 -148
  78. package/dist/keyword-docs.js.map +0 -1
  79. package/dist/language.js +0 -196
  80. package/dist/language.js.map +0 -1
  81. package/dist/production-destinations.js +0 -32
  82. package/dist/production-destinations.js.map +0 -1
  83. package/dist/sub-language-registry.js +0 -18
  84. package/dist/sub-language-registry.js.map +0 -1
  85. package/dist/sub-languages/capture/CompletionProvider.js +0 -332
  86. package/dist/sub-languages/capture/CompletionProvider.js.map +0 -1
  87. package/dist/sub-languages/capture/HoverProvider.js +0 -87
  88. package/dist/sub-languages/capture/HoverProvider.js.map +0 -1
  89. package/dist/sub-languages/capture/Validator.js +0 -72
  90. package/dist/sub-languages/capture/Validator.js.map +0 -1
  91. package/dist/sub-languages/capture/index.js +0 -58
  92. package/dist/sub-languages/capture/index.js.map +0 -1
  93. package/dist/sub-languages/capture/language.js +0 -160
  94. package/dist/sub-languages/capture/language.js.map +0 -1
  95. package/dist/sub-languages/cdl.js +0 -74
  96. package/dist/sub-languages/cdl.js.map +0 -1
  97. package/dist/sub-languages/pdl.js +0 -73
  98. package/dist/sub-languages/pdl.js.map +0 -1
  99. package/dist/sub-languages/projection/CodeActionProvider.js +0 -93
  100. package/dist/sub-languages/projection/CodeActionProvider.js.map +0 -1
  101. package/dist/sub-languages/projection/CompletionProvider.js +0 -595
  102. package/dist/sub-languages/projection/CompletionProvider.js.map +0 -1
  103. package/dist/sub-languages/projection/HoverProvider.js +0 -333
  104. package/dist/sub-languages/projection/HoverProvider.js.map +0 -1
  105. package/dist/sub-languages/projection/Validator.js +0 -388
  106. package/dist/sub-languages/projection/Validator.js.map +0 -1
  107. package/dist/sub-languages/projection/index.js +0 -160
  108. package/dist/sub-languages/projection/index.js.map +0 -1
  109. package/dist/sub-languages/projection/language.js +0 -171
  110. package/dist/sub-languages/projection/language.js.map +0 -1
  111. package/dist/symbols.js +0 -275
  112. package/dist/symbols.js.map +0 -1
  113. package/dist/themes/screenplay-dark.js +0 -30
  114. package/dist/themes/screenplay-dark.js.map +0 -1
  115. package/dist/themes/screenplay-light.js +0 -30
  116. package/dist/themes/screenplay-light.js.map +0 -1
  117. package/dist/tokens.js +0 -147
  118. package/dist/tokens.js.map +0 -1
  119. package/dist/validation.js +0 -248
  120. package/dist/validation.js.map +0 -1
  121. package/document-context.ts +0 -93
  122. package/event-analysis-source.ts +0 -18
  123. package/event-context-catalog.ts +0 -135
  124. package/event-context.ts +0 -119
  125. package/file-imports.ts +0 -70
  126. package/file-references.ts +0 -87
  127. package/for_documentContext/when_stripping_comments.ts +0 -32
  128. package/for_eventContext/when_resolving_generated_catalog_vectors.ts +0 -15
  129. package/for_eventGenerations/when_editing_event_generations.ts +0 -57
  130. package/for_fileImports/when_finding_file_imports.ts +0 -38
  131. package/for_fileReferences/when_recognizing_an_absolute_path/with_paths_of_every_shape.ts +0 -26
  132. package/for_fileReferences/when_scanning_a_document/inside_a_code_fence.ts +0 -26
  133. package/for_fileReferences/when_scanning_a_document/with_a_bare_file_keyword.ts +0 -19
  134. package/for_fileReferences/when_scanning_a_document/with_a_file_directive.ts +0 -30
  135. package/for_fileReferences/when_scanning_a_document/with_a_property_named_file.ts +0 -25
  136. package/for_fileReferences/when_scanning_a_document/with_a_trailing_comment.ts +0 -25
  137. package/for_fileReferences/when_scanning_a_document/with_directives_on_several_constructs.ts +0 -41
  138. package/for_importablePaths/when_listing_what_a_document_can_import.ts +0 -34
  139. package/for_inlineEvents/when_analyzing_many_inline_events.ts +0 -59
  140. package/for_inlineEvents/when_authoring_inline_events.ts +0 -149
  141. package/for_inlineEvents/when_completing_many_events.ts +0 -49
  142. package/for_inlineEvents/when_indexing_command_production_ownership.ts +0 -79
  143. package/for_planCompletions/when_completing_a_file_import.ts +0 -26
  144. package/for_planCompletions/when_completing_a_specification_query.ts +0 -24
  145. package/for_planCompletions/when_completing_a_specification_step.ts +0 -42
  146. package/for_planCompletions/when_completing_an_absent_read_model.ts +0 -14
  147. package/for_planCompletions/when_completing_reaction_reads.ts +0 -36
  148. package/for_projectionCompletionProvider/when_completing_an_event_context_path.ts +0 -102
  149. package/for_projectionHoverProvider/when_hovering_an_event_context_path.ts +0 -44
  150. package/for_projectionValidator/when_validating_a_projection_with_variants.ts +0 -128
  151. package/for_projectionValidator/when_validating_event_context_paths.ts +0 -31
  152. package/for_scanDocument/when_scanning_a_query/with_a_dotted_return_type.ts +0 -34
  153. package/for_scanDocument/when_scanning_aliased_reads.ts +0 -33
  154. package/for_scanDocument/when_scanning_many_commands.ts +0 -47
  155. package/for_tokens/when_highlighting_a_file_import.ts +0 -18
  156. package/for_tokens/when_highlighting_event_metadata.ts +0 -63
  157. package/for_tokens/when_highlighting_specification_steps.ts +0 -28
  158. package/for_validateLines/when_validating_a_document/with_a_problem_of_every_coded_kind.ts +0 -77
  159. package/for_validateLines/when_validating_a_document/with_an_unknown_policy.ts +0 -33
  160. package/for_validateLines/when_validating_a_file_placed_by_an_import/with_names_declared_in_other_files.ts +0 -43
  161. package/for_validateLines/when_validating_event_context_paths/in_a_projection.ts +0 -97
  162. package/for_validateLines/when_validating_file_imports/at_every_level.ts +0 -36
  163. package/for_validateLines/when_validating_production_destinations/with_an_available_identifier.ts +0 -120
  164. package/hover-content.ts +0 -117
  165. package/hover.ts +0 -23
  166. package/index.ts +0 -125
  167. package/inlay-hints.ts +0 -17
  168. package/inline-event-validation.ts +0 -115
  169. package/keyword-docs.ts +0 -152
  170. package/language.ts +0 -212
  171. package/production-destinations.ts +0 -32
  172. package/sub-language-registry.ts +0 -42
  173. package/sub-languages/capture/CompletionProvider.ts +0 -365
  174. package/sub-languages/capture/HoverProvider.ts +0 -99
  175. package/sub-languages/capture/Validator.ts +0 -97
  176. package/sub-languages/capture/index.ts +0 -72
  177. package/sub-languages/capture/language.ts +0 -176
  178. package/sub-languages/cdl.ts +0 -76
  179. package/sub-languages/pdl.ts +0 -75
  180. package/sub-languages/projection/CodeActionProvider.ts +0 -123
  181. package/sub-languages/projection/CompletionProvider.ts +0 -660
  182. package/sub-languages/projection/HoverProvider.ts +0 -377
  183. package/sub-languages/projection/Validator.ts +0 -441
  184. package/sub-languages/projection/index.ts +0 -223
  185. package/sub-languages/projection/language.ts +0 -193
  186. package/symbols.ts +0 -374
  187. package/themes/screenplay-dark.ts +0 -33
  188. package/themes/screenplay-light.ts +0 -33
  189. package/tokens.ts +0 -174
  190. package/validation.ts +0 -443
  191. package/vitest.setup.ts +0 -5
@@ -1,365 +0,0 @@
1
- // Copyright (c) Cratis. All rights reserved.
2
- // Licensed under the MIT license. See LICENSE file in the project root for full license information.
3
-
4
- import { languages, type editor, type Position, type IRange } from 'monaco-editor';
5
-
6
- interface CompletionContext {
7
- textBeforeCursor: string;
8
- currentWord: string;
9
- indentLevel: number;
10
- lineNumber: number;
11
- wordStartColumn: number;
12
- wordEndColumn: number;
13
- }
14
-
15
- const commonPropertyPaths = [
16
- 'id',
17
- 'status',
18
- 'firstName',
19
- 'lastName',
20
- 'fullName',
21
- 'address.street',
22
- 'address.city',
23
- 'lineItems',
24
- 'lineItems.quantity',
25
- 'lineNumber',
26
- 'quantity',
27
- ];
28
-
29
- export class CompletionProvider implements languages.CompletionItemProvider {
30
- triggerCharacters = ['.', ' ', '=', '$'];
31
-
32
- provideCompletionItems(
33
- model: editor.ITextModel,
34
- position: Position,
35
- ): languages.ProviderResult<languages.CompletionList> {
36
- const context = this.buildContext(model, position);
37
- const suggestions: languages.CompletionItem[] = [];
38
-
39
- if (context.lineNumber === 1) {
40
- this.addCaptureLineCompletions(suggestions, context);
41
- } else if (this.isAfterKeyword(context, 'capture')) {
42
- this.addCaptureNameCompletions(suggestions, context);
43
- } else if (this.isAfterKeyword(context, 'source')) {
44
- this.addSourceTypeCompletions(suggestions, context);
45
- } else if (this.isAfterAppendKeyword(context)) {
46
- this.addAppendNameCompletions(suggestions, context);
47
- } else if (this.isAfterWhenKeyword(context)) {
48
- this.addWhenCompletions(suggestions, context);
49
- } else if (this.isAfterWhenFrom(context)) {
50
- this.addFromValueCompletions(suggestions, context);
51
- } else if (this.isAfterWhenTo(context)) {
52
- this.addToValueCompletions(suggestions, context);
53
- } else if (this.isAfterContextPrefix(context, '$.')) {
54
- this.addPathCompletions(suggestions, context, '$.');
55
- } else if (this.isAfterContextPrefix(context, '$previous.')) {
56
- this.addPathCompletions(suggestions, context, '$previous.');
57
- } else if (this.isAfterContextPrefix(context, '$context.')) {
58
- this.addContextCompletions(suggestions, context);
59
- } else if (this.isAfterContextPrefix(context, '$env.')) {
60
- this.addEnvironmentCompletions(suggestions, context);
61
- } else if (this.isAfterAssignment(context)) {
62
- this.addAssignmentValueCompletions(suggestions, context);
63
- } else if ((this.isStartOfLine(context) || this.isAfterIndent(context)) && context.indentLevel === 1) {
64
- this.addTopLevelStatementCompletions(suggestions, context);
65
- } else if ((this.isStartOfLine(context) || this.isAfterIndent(context)) && context.indentLevel >= 2) {
66
- this.addSourceBlockCompletions(suggestions, context, this.getCurrentSourceType(model, position.lineNumber));
67
- }
68
-
69
- return { suggestions };
70
- }
71
-
72
- private buildContext(model: editor.ITextModel, position: Position): CompletionContext {
73
- const lineContent = model.getLineContent(position.lineNumber);
74
- const textBeforeCursor = lineContent.substring(0, position.column - 1);
75
- const word = model.getWordUntilPosition(position);
76
-
77
- return {
78
- textBeforeCursor,
79
- currentWord: word.word || '',
80
- indentLevel: this.getIndentLevel(textBeforeCursor),
81
- lineNumber: position.lineNumber,
82
- wordStartColumn: word.startColumn,
83
- wordEndColumn: word.endColumn,
84
- };
85
- }
86
-
87
- private getIndentLevel(text: string): number {
88
- const match = text.match(/^(\s*)/);
89
- return match ? Math.floor(match[1].length / 2) : 0;
90
- }
91
-
92
- private isStartOfLine(context: CompletionContext): boolean {
93
- return context.textBeforeCursor.trim() === '';
94
- }
95
-
96
- private isAfterIndent(context: CompletionContext): boolean {
97
- return /^\s+$/.test(context.textBeforeCursor);
98
- }
99
-
100
- private isAfterKeyword(context: CompletionContext, keyword: string): boolean {
101
- const pattern = new RegExp(`\\b${keyword}\\s+\\w*$`);
102
- return pattern.test(context.textBeforeCursor);
103
- }
104
-
105
- private isAfterAppendKeyword(context: CompletionContext): boolean {
106
- return /\bappend\s+[\w.]*$/.test(context.textBeforeCursor);
107
- }
108
-
109
- private isAfterWhenKeyword(context: CompletionContext): boolean {
110
- return /\bwhen\s+[\w.]*$/.test(context.textBeforeCursor);
111
- }
112
-
113
- private isAfterWhenFrom(context: CompletionContext): boolean {
114
- return /\bwhen\s+[\w.]+\s+from\s+[^\s]*$/.test(context.textBeforeCursor);
115
- }
116
-
117
- private isAfterWhenTo(context: CompletionContext): boolean {
118
- return /\bwhen\s+[\w.]+\s+from\s+\S+\s+to\s+[^\s]*$/.test(context.textBeforeCursor);
119
- }
120
-
121
- private isAfterAssignment(context: CompletionContext): boolean {
122
- return /=\s*([$\w.]*)$/.test(context.textBeforeCursor);
123
- }
124
-
125
- private isAfterContextPrefix(context: CompletionContext, prefix: string): boolean {
126
- return context.textBeforeCursor.endsWith(prefix);
127
- }
128
-
129
- private addCaptureLineCompletions(suggestions: languages.CompletionItem[], context: CompletionContext): void {
130
- const trimmed = context.textBeforeCursor.trim();
131
- if (trimmed === '' || 'capture'.startsWith(trimmed)) {
132
- suggestions.push({
133
- label: 'capture',
134
- kind: languages.CompletionItemKind.Keyword,
135
- insertText: 'capture ',
136
- documentation: 'Define a capture declaration',
137
- detail: 'capture <Name>',
138
- range: this.getRangeForWord(context),
139
- });
140
- }
141
-
142
- if (trimmed.startsWith('capture ')) {
143
- this.addCaptureNameCompletions(suggestions, context);
144
- }
145
- }
146
-
147
- private addCaptureNameCompletions(suggestions: languages.CompletionItem[], context: CompletionContext): void {
148
- suggestions.push({
149
- label: 'CaptureDefinition',
150
- kind: languages.CompletionItemKind.Class,
151
- insertText: 'CaptureDefinition',
152
- documentation: 'A descriptive name for this capture declaration',
153
- detail: 'Capture name',
154
- range: this.getRangeForWord(context),
155
- });
156
- }
157
-
158
- private addSourceTypeCompletions(suggestions: languages.CompletionItem[], context: CompletionContext): void {
159
- [
160
- { label: 'api', detail: 'source api', documentation: 'Capture data by polling an HTTP API' },
161
- { label: 'webhook', detail: 'source webhook', documentation: 'Capture data from incoming webhook requests' },
162
- { label: 'message', detail: 'source message', documentation: 'Capture data from a message topic' },
163
- ].forEach((source) => {
164
- suggestions.push({
165
- label: source.label,
166
- kind: languages.CompletionItemKind.Keyword,
167
- insertText: source.label,
168
- documentation: source.documentation,
169
- detail: source.detail,
170
- range: this.getRangeForWord(context),
171
- });
172
- });
173
- }
174
-
175
- // Per source type — no `auth`/`bearer`/`url`: an API source references a named
176
- // External Service (`api <ServiceName>`) for base URL and auth; a webhook source's
177
- // authentication is configured on the source builder, not in CDL text.
178
- private addSourceBlockCompletions(suggestions: languages.CompletionItem[], context: CompletionContext, sourceType: string | null): void {
179
- const options: Record<string, Array<{ label: string; detail: string; documentation: string }>> = {
180
- api: [
181
- { label: 'api', detail: 'api <ServiceName>', documentation: 'References a configured External Service by name for the base URL and authentication' },
182
- { label: 'route', detail: 'route <path>', documentation: 'Optional path appended to the External Service base URL; if omitted, the base URL is used as-is' },
183
- { label: 'poll', detail: 'poll <interval>', documentation: 'The polling interval, for example 5m' },
184
- ],
185
- webhook: [
186
- { label: 'path', detail: 'path <route>', documentation: 'The inbound path this webhook listens on' },
187
- ],
188
- message: [
189
- { label: 'topic', detail: 'topic <name>', documentation: 'The topic or subject to subscribe to' },
190
- ],
191
- };
192
-
193
- (sourceType ? options[sourceType] ?? [] : []).forEach((option) => {
194
- suggestions.push({
195
- label: option.label,
196
- kind: languages.CompletionItemKind.Keyword,
197
- insertText: `${option.label} `,
198
- documentation: option.documentation,
199
- detail: option.detail,
200
- range: this.getRangeForWord(context),
201
- });
202
- });
203
- }
204
-
205
- private addTopLevelStatementCompletions(suggestions: languages.CompletionItem[], context: CompletionContext): void {
206
- [
207
- { label: 'key', insertText: 'key ', detail: 'key <property>', documentation: 'Identify the captured entity' },
208
- { label: 'map', insertText: 'map', detail: 'map', documentation: 'Map captured fields into a normalized shape' },
209
- { label: 'append', insertText: 'append ', detail: 'append <EventName>', documentation: 'Append an event when a condition matches' },
210
- { label: 'nested', insertText: 'nested ', detail: 'nested <property>', documentation: 'Create a nested mapping scope' },
211
- { label: 'children', insertText: 'children ', detail: 'children <collection> identified by <property>', documentation: 'Handle child collections independently' },
212
- ].forEach((statement) => {
213
- suggestions.push({
214
- label: statement.label,
215
- kind: languages.CompletionItemKind.Keyword,
216
- insertText: statement.insertText,
217
- documentation: statement.documentation,
218
- detail: statement.detail,
219
- range: this.getRangeForWord(context),
220
- });
221
- });
222
- }
223
-
224
- private addAppendNameCompletions(suggestions: languages.CompletionItem[], context: CompletionContext): void {
225
- suggestions.push({
226
- label: 'ItemChanged',
227
- kind: languages.CompletionItemKind.Class,
228
- insertText: 'ItemChanged',
229
- documentation: 'A generic event name for the appended event',
230
- detail: 'Event name',
231
- range: this.getRangeForWord(context),
232
- });
233
- }
234
-
235
- private addWhenCompletions(suggestions: languages.CompletionItem[], context: CompletionContext): void {
236
- [
237
- { label: 'added', insertText: 'added', detail: 'when added', documentation: 'Append when a child item was added' },
238
- { label: 'removed', insertText: 'removed', detail: 'when removed', documentation: 'Append when a child item was removed' },
239
- { label: 'status', insertText: 'status', detail: 'when <property>', documentation: 'Append when a property changed' },
240
- { label: 'status transition', insertText: 'status from inactive to active', detail: 'when <property> from <value> to <value>', documentation: 'Append when a property changed between two values' },
241
- { label: 'quantity', insertText: 'quantity', detail: 'when <property>', documentation: 'Append when a property changed' },
242
- { label: 'lineNumber', insertText: 'lineNumber', detail: 'when <property>', documentation: 'Append when a specific property changed' },
243
- ].forEach((option) => {
244
- suggestions.push({
245
- label: option.label,
246
- kind: languages.CompletionItemKind.Keyword,
247
- insertText: option.insertText,
248
- documentation: option.documentation,
249
- detail: option.detail,
250
- range: this.getRangeForWord(context),
251
- });
252
- });
253
- }
254
-
255
- private addFromValueCompletions(suggestions: languages.CompletionItem[], context: CompletionContext): void {
256
- [
257
- { label: '*', insertText: '*', detail: 'Wildcard', documentation: 'Match any previous value' },
258
- { label: 'inactive', insertText: 'inactive', detail: 'Common value', documentation: 'A common previous state value' },
259
- { label: 'active', insertText: 'active', detail: 'Common value', documentation: 'A common previous state value' },
260
- { label: 'true', insertText: 'true', detail: 'Boolean value', documentation: 'Boolean true' },
261
- { label: 'false', insertText: 'false', detail: 'Boolean value', documentation: 'Boolean false' },
262
- ].forEach((option) => {
263
- suggestions.push({
264
- label: option.label,
265
- kind: languages.CompletionItemKind.Value,
266
- insertText: option.insertText,
267
- documentation: option.documentation,
268
- detail: option.detail,
269
- range: this.getRangeForWord(context),
270
- });
271
- });
272
- }
273
-
274
- private addToValueCompletions(suggestions: languages.CompletionItem[], context: CompletionContext): void {
275
- ['active', 'inactive', 'pending', 'true', 'false'].forEach((value) => {
276
- suggestions.push({
277
- label: value,
278
- kind: languages.CompletionItemKind.Value,
279
- insertText: value,
280
- documentation: `Common target value: ${value}`,
281
- detail: 'Target value',
282
- range: this.getRangeForWord(context),
283
- });
284
- });
285
- }
286
-
287
- private addAssignmentValueCompletions(suggestions: languages.CompletionItem[], context: CompletionContext): void {
288
- [
289
- { label: '$.', insertText: '$.', detail: 'Current captured value', documentation: 'Reference the current captured payload' },
290
- { label: '$previous.', insertText: '$previous.', detail: 'Previous captured value', documentation: 'Reference the previous state of the payload' },
291
- { label: '$context.occurred', insertText: '$context.occurred', detail: 'Occurred timestamp', documentation: 'When the capture source produced the current data' },
292
- { label: '$context.eventSourceId', insertText: '$context.eventSourceId', detail: 'Event source identifier', documentation: 'The resolved event source identifier for the append operation' },
293
- { label: '$env.', insertText: '$env.', detail: 'Environment variable', documentation: 'Read an environment variable' },
294
- ].forEach((option) => {
295
- suggestions.push({
296
- label: option.label,
297
- kind: languages.CompletionItemKind.Variable,
298
- insertText: option.insertText,
299
- documentation: option.documentation,
300
- detail: option.detail,
301
- range: this.getRangeForWord(context),
302
- });
303
- });
304
- }
305
-
306
- private addPathCompletions(suggestions: languages.CompletionItem[], context: CompletionContext, prefix: string): void {
307
- commonPropertyPaths.forEach((path) => {
308
- suggestions.push({
309
- label: path,
310
- kind: languages.CompletionItemKind.Property,
311
- insertText: `${prefix}${path}`,
312
- documentation: `Common property path: ${prefix}${path}`,
313
- detail: prefix === '$.' ? 'Current value path' : 'Previous value path',
314
- range: this.getRangeForWord(context),
315
- });
316
- });
317
- }
318
-
319
- private addContextCompletions(suggestions: languages.CompletionItem[], context: CompletionContext): void {
320
- [
321
- { label: 'occurred', insertText: '$context.occurred', detail: 'When the event occurred', documentation: 'Timestamp for when the append event happened' },
322
- { label: 'eventSourceId', insertText: '$context.eventSourceId', detail: 'Event source identifier', documentation: 'The event source identifier used for the appended event' },
323
- ].forEach((option) => {
324
- suggestions.push({
325
- label: option.label,
326
- kind: languages.CompletionItemKind.Property,
327
- insertText: option.insertText,
328
- documentation: option.documentation,
329
- detail: option.detail,
330
- range: this.getRangeForWord(context),
331
- });
332
- });
333
- }
334
-
335
- private addEnvironmentCompletions(suggestions: languages.CompletionItem[], context: CompletionContext): void {
336
- suggestions.push({
337
- label: 'API_TOKEN',
338
- kind: languages.CompletionItemKind.Variable,
339
- insertText: '$env.API_TOKEN',
340
- documentation: 'Placeholder environment variable reference',
341
- detail: 'Environment variable',
342
- range: this.getRangeForWord(context),
343
- });
344
- }
345
-
346
- private getCurrentSourceType(model: editor.ITextModel, lineNumber: number): string | null {
347
- for (let index = lineNumber; index >= 1; index--) {
348
- const line = model.getLineContent(index).trim();
349
- const match = line.match(/^source\s+(api|webhook|message)\b/);
350
- if (match) {
351
- return match[1];
352
- }
353
- }
354
- return null;
355
- }
356
-
357
- private getRangeForWord(context: CompletionContext): IRange {
358
- return {
359
- startLineNumber: context.lineNumber,
360
- endLineNumber: context.lineNumber,
361
- startColumn: context.wordStartColumn,
362
- endColumn: context.wordEndColumn,
363
- };
364
- }
365
- }
@@ -1,99 +0,0 @@
1
- // Copyright (c) Cratis. All rights reserved.
2
- // Licensed under the MIT license. See LICENSE file in the project root for full license information.
3
-
4
- import type { editor, languages, Position, IRange } from 'monaco-editor';
5
-
6
- export class HoverProvider implements languages.HoverProvider {
7
- provideHover(model: editor.ITextModel, position: Position): languages.ProviderResult<languages.Hover> {
8
- const token = this.getTokenAtPosition(model, position);
9
- if (!token) {
10
- return null;
11
- }
12
-
13
- const keywordInfo = this.getKeywordInfo(token.word);
14
- if (keywordInfo) {
15
- return {
16
- contents: [{ value: keywordInfo }],
17
- range: token.range,
18
- };
19
- }
20
-
21
- const expressionInfo = this.getExpressionInfo(token.word);
22
- if (expressionInfo) {
23
- return {
24
- contents: [{ value: expressionInfo }],
25
- range: token.range,
26
- };
27
- }
28
-
29
- return null;
30
- }
31
-
32
- private getTokenAtPosition(model: editor.ITextModel, position: Position): { word: string; range: IRange } | null {
33
- const lineContent = model.getLineContent(position.lineNumber);
34
- const tokens = [...lineContent.matchAll(/\$context|\$previous|\$env|[a-zA-Z_][\w-]*/g)];
35
- const column = position.column - 1;
36
-
37
- for (const token of tokens) {
38
- const startIndex = token.index ?? 0;
39
- const endIndex = startIndex + token[0].length;
40
- if (column >= startIndex && column <= endIndex) {
41
- return {
42
- word: token[0],
43
- range: {
44
- startLineNumber: position.lineNumber,
45
- endLineNumber: position.lineNumber,
46
- startColumn: startIndex + 1,
47
- endColumn: endIndex + 1,
48
- },
49
- };
50
- }
51
- }
52
-
53
- return null;
54
- }
55
-
56
- // No `auth`/`bearer`/`url` — removed with the grammar. `api`, `route`, `path`, and
57
- // `topic` reflect the current source-property meanings (see grammar.md).
58
- private getKeywordInfo(word: string): string | null {
59
- const keywords: Record<string, string> = {
60
- capture: '**capture** *<Name>*\n\nDeclares a capture and gives it a unique name.',
61
- source: '**source** *<type>*\n\nDefines where the capture reads input from.',
62
- key: '**key** *<property>*\n\nSelects the property used to identify each captured item.',
63
- map: '**map**\n\nMaps source fields into a normalized shape for later append blocks.',
64
- append: '**append** *<EventName>*\n\nDeclares an event to append when the `when` clause matches.',
65
- when: '**when** *<condition>*\n\nSpecifies when an append block should fire.',
66
- nested: '**nested** *<property>*\n\nCreates a nested mapping scope for an object property.',
67
- children: '**children** *<collection>* **identified by** *<property>*\n\nCreates a scope for child collection items.',
68
- identified: '**identified**\n\nUsed with `children` to declare how child items are identified.',
69
- by: '**by**\n\nUsed in `children ... identified by`, `split ... by`, and similar clauses.',
70
- api: '**api**\n\nAs a source type (`source api`): polls an HTTP API for changes.\n\nAs a source property (`api <ServiceName>`): references a configured External Service by name for the base URL and authentication.',
71
- webhook: '**webhook**\n\nA source type for receiving webhook payloads.',
72
- message: '**message**\n\nA source type for consuming messages from a topic.',
73
- route: '**route** *<path>*\n\nOptional path appended to an API source\'s External Service base URL. If omitted, the base URL is used as-is.',
74
- poll: '**poll** *<interval>*\n\nSets the polling interval for an API source.',
75
- path: '**path** *<route>*\n\nThe inbound path a webhook source listens on.',
76
- topic: '**topic** *<name>*\n\nConfigures the topic for a message source.',
77
- from: '**from** *<value>*\n\nUsed in a `when` clause to match the previous value.',
78
- to: '**to** *<value>*\n\nUsed in a `when` clause to match the new value.',
79
- or: '**or**\n\nCombines multiple `when` conditions.',
80
- and: '**and**\n\nCombines multiple `when` conditions that must all match.',
81
- added: '**added**\n\nMatches when a child item was added.',
82
- removed: '**removed**\n\nMatches when a child item was removed.',
83
- translate: '**translate**\n\nMaps source values to new values inside a `map` block.',
84
- split: '**split** *<value>* **by** *<separator>*\n\nSplits a string into multiple mapped fields.',
85
- };
86
-
87
- return keywords[word] || null;
88
- }
89
-
90
- private getExpressionInfo(word: string): string | null {
91
- const expressions: Record<string, string> = {
92
- '$context': '**$context**\n\nCapture execution context.\n\n**Properties:**\n- `occurred` - When the current event should be considered to have occurred\n- `eventSourceId` - The resolved event source identifier',
93
- '$previous': '**$previous**\n\nThe previous state for the captured item. Use dot notation such as `$previous.status`.',
94
- '$env': '**$env**\n\nEnvironment variables. Use dot notation such as `$env.API_TOKEN`.',
95
- };
96
-
97
- return expressions[word] || null;
98
- }
99
- }
@@ -1,97 +0,0 @@
1
- // Copyright (c) Cratis. All rights reserved.
2
- // Licensed under the MIT license. See LICENSE file in the project root for full license information.
3
-
4
- import { ValidationIssue } from '../../validation';
5
-
6
- interface MeaningfulLine {
7
- line: string;
8
- trimmed: string;
9
- lineNumber: number;
10
- indent: number;
11
- }
12
-
13
- // Structural rules only, unaffected by the source-property grammar changes — the
14
- // grammar's own syntax (see grammar.md) is what the tokenizer enforces; these are
15
- // the compiler's semantic constraints on top of it. Takes plain lines rather than
16
- // a Monaco model so it stays usable outside an editor, matching ../../validation.ts.
17
- export class Validator {
18
- validate(lines: string[]): ValidationIssue[] {
19
- const issues: ValidationIssue[] = [];
20
-
21
- let firstNonEmptyLineIndex = -1;
22
- let firstLine = '';
23
- for (let index = 0; index < lines.length; index++) {
24
- const trimmed = lines[index].trim();
25
- if (trimmed && !trimmed.startsWith('#')) {
26
- firstNonEmptyLineIndex = index;
27
- firstLine = trimmed;
28
- break;
29
- }
30
- }
31
-
32
- if (!firstLine) {
33
- return issues;
34
- }
35
-
36
- const captureMatch = firstLine.match(/^capture\s+([\w.]+)\s*$/);
37
- if (!captureMatch) {
38
- issues.push(this.error(firstNonEmptyLineIndex, 1, firstLine.length + 1, 'Capture definition must start with "capture <Name>"'));
39
- return issues;
40
- }
41
-
42
- const meaningfulLines: MeaningfulLine[] = lines
43
- .map((line, index) => ({
44
- line,
45
- trimmed: line.trim(),
46
- lineNumber: index,
47
- indent: line.search(/\S/),
48
- }))
49
- .filter((entry) => entry.trimmed && !entry.trimmed.startsWith('#'));
50
-
51
- const hasSource = meaningfulLines.some((entry) => entry.trimmed.startsWith('source '));
52
- if (!hasSource) {
53
- issues.push(this.error(firstNonEmptyLineIndex, 1, firstLine.length + 1, 'Capture definition must include a "source" block'));
54
- }
55
-
56
- const hasKey = meaningfulLines.some((entry) => entry.trimmed.startsWith('key '));
57
- if (!hasKey) {
58
- issues.push(this.error(firstNonEmptyLineIndex, 1, firstLine.length + 1, 'Capture definition must include a "key" declaration'));
59
- }
60
-
61
- for (let index = 0; index < meaningfulLines.length; index++) {
62
- const current = meaningfulLines[index];
63
- if (!current.trimmed.startsWith('append ')) {
64
- continue;
65
- }
66
-
67
- let hasWhenClause = false;
68
- for (let next = index + 1; next < meaningfulLines.length; next++) {
69
- const candidate = meaningfulLines[next];
70
- if (candidate.indent <= current.indent) {
71
- break;
72
- }
73
- if (candidate.trimmed.startsWith('when ')) {
74
- hasWhenClause = true;
75
- break;
76
- }
77
- }
78
-
79
- if (!hasWhenClause) {
80
- const eventName = current.trimmed.substring('append '.length).trim() || 'unnamed append block';
81
- const startColumn = current.line.indexOf(eventName) + 1;
82
- issues.push(this.error(
83
- current.lineNumber,
84
- startColumn > 0 ? startColumn : 1,
85
- startColumn > 0 ? startColumn + eventName.length : current.line.length + 1,
86
- `Append block '${eventName}' must include a "when" clause`,
87
- ));
88
- }
89
- }
90
-
91
- return issues;
92
- }
93
-
94
- private error(line: number, startColumn: number, endColumn: number, message: string): ValidationIssue {
95
- return { severity: 'error', line, startColumn, endColumn, message };
96
- }
97
- }
@@ -1,72 +0,0 @@
1
- // Copyright (c) Cratis. All rights reserved.
2
- // Licensed under the MIT license. See LICENSE file in the project root for full license information.
3
-
4
- import type { IDisposable, editor } from 'monaco-editor';
5
- import { Monaco, languageConfiguration, languageId, monarchLanguage } from './language';
6
- import { CompletionProvider } from './CompletionProvider';
7
- import { HoverProvider } from './HoverProvider';
8
- import { Validator } from './Validator';
9
-
10
- const markerOwner = 'cdl-validator';
11
-
12
- // Keyed by Monaco instance rather than a single boolean — mirrors the composite
13
- // language's own registration guard (../../index.ts) and lets a second register()
14
- // call for the same instance hand back the existing disposer instead of doubling
15
- // up the completion/hover providers.
16
- const disposersByMonaco = new Map<Monaco, () => void>();
17
-
18
- function toMarkers(monaco: Monaco, validator: Validator, model: editor.ITextModel): editor.IMarkerData[] {
19
- return validator.validate(model.getLinesContent()).map((issue) => ({
20
- severity: issue.severity === 'error' ? monaco.MarkerSeverity.Error : monaco.MarkerSeverity.Warning,
21
- message: issue.message,
22
- startLineNumber: issue.line + 1,
23
- startColumn: issue.startColumn,
24
- endLineNumber: issue.line + 1,
25
- endColumn: issue.endColumn,
26
- }));
27
- }
28
-
29
- export function registerCaptureLanguage(monaco: Monaco): { dispose(): void } {
30
- const existing = disposersByMonaco.get(monaco);
31
- if (existing) {
32
- return { dispose: existing };
33
- }
34
-
35
- monaco.languages.register({ id: languageId });
36
- monaco.languages.setLanguageConfiguration(languageId, languageConfiguration);
37
- monaco.languages.setMonarchTokensProvider(languageId, monarchLanguage);
38
-
39
- const validator = new Validator();
40
- const disposables: IDisposable[] = [];
41
-
42
- disposables.push(monaco.languages.registerCompletionItemProvider(languageId, new CompletionProvider()));
43
- disposables.push(monaco.languages.registerHoverProvider(languageId, new HoverProvider()));
44
-
45
- const validateModel = (model: editor.ITextModel): void => {
46
- if (model.isDisposed() || model.getLanguageId() !== languageId) {
47
- return;
48
- }
49
- monaco.editor.setModelMarkers(model, markerOwner, toMarkers(monaco, validator, model));
50
- };
51
-
52
- disposables.push(monaco.editor.onDidCreateModel((model) => {
53
- if (model.getLanguageId() !== languageId) {
54
- return;
55
- }
56
- validateModel(model);
57
- disposables.push(model.onDidChangeContent(() => validateModel(model)));
58
- }));
59
-
60
- monaco.editor.getModels().forEach((model) => validateModel(model));
61
-
62
- const dispose = (): void => {
63
- disposables.forEach((disposable) => disposable.dispose());
64
- disposables.length = 0;
65
- disposersByMonaco.delete(monaco);
66
- };
67
-
68
- disposersByMonaco.set(monaco, dispose);
69
- return { dispose };
70
- }
71
-
72
- export { languageId } from './language';