@eventcatalog/linter 0.0.1

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 (78) hide show
  1. package/README.md +583 -0
  2. package/dist/cli/index.d.ts +3 -0
  3. package/dist/cli/index.d.ts.map +1 -0
  4. package/dist/cli/index.js +54 -0
  5. package/dist/cli/index.js.map +1 -0
  6. package/dist/index.d.ts +7 -0
  7. package/dist/index.d.ts.map +1 -0
  8. package/dist/index.js +23 -0
  9. package/dist/index.js.map +1 -0
  10. package/dist/parser/index.d.ts +17 -0
  11. package/dist/parser/index.d.ts.map +1 -0
  12. package/dist/parser/index.js +43 -0
  13. package/dist/parser/index.js.map +1 -0
  14. package/dist/reporters/index.d.ts +16 -0
  15. package/dist/reporters/index.d.ts.map +1 -0
  16. package/dist/reporters/index.js +151 -0
  17. package/dist/reporters/index.js.map +1 -0
  18. package/dist/scanner/index.d.ts +14 -0
  19. package/dist/scanner/index.d.ts.map +1 -0
  20. package/dist/scanner/index.js +99 -0
  21. package/dist/scanner/index.js.map +1 -0
  22. package/dist/schemas/channel.d.ts +389 -0
  23. package/dist/schemas/channel.d.ts.map +1 -0
  24. package/dist/schemas/channel.js +20 -0
  25. package/dist/schemas/channel.js.map +1 -0
  26. package/dist/schemas/common.d.ts +550 -0
  27. package/dist/schemas/common.d.ts.map +1 -0
  28. package/dist/schemas/common.js +144 -0
  29. package/dist/schemas/common.js.map +1 -0
  30. package/dist/schemas/domain.d.ts +381 -0
  31. package/dist/schemas/domain.d.ts.map +1 -0
  32. package/dist/schemas/domain.js +13 -0
  33. package/dist/schemas/domain.js.map +1 -0
  34. package/dist/schemas/entity.d.ts +382 -0
  35. package/dist/schemas/entity.d.ts.map +1 -0
  36. package/dist/schemas/entity.js +24 -0
  37. package/dist/schemas/entity.js.map +1 -0
  38. package/dist/schemas/flow.d.ts +733 -0
  39. package/dist/schemas/flow.d.ts.map +1 -0
  40. package/dist/schemas/flow.js +70 -0
  41. package/dist/schemas/flow.js.map +1 -0
  42. package/dist/schemas/index.d.ts +3432 -0
  43. package/dist/schemas/index.d.ts.map +1 -0
  44. package/dist/schemas/index.js +47 -0
  45. package/dist/schemas/index.js.map +1 -0
  46. package/dist/schemas/message.d.ts +1076 -0
  47. package/dist/schemas/message.d.ts.map +1 -0
  48. package/dist/schemas/message.js +17 -0
  49. package/dist/schemas/message.js.map +1 -0
  50. package/dist/schemas/service.d.ts +381 -0
  51. package/dist/schemas/service.d.ts.map +1 -0
  52. package/dist/schemas/service.js +13 -0
  53. package/dist/schemas/service.js.map +1 -0
  54. package/dist/schemas/team.d.ts +45 -0
  55. package/dist/schemas/team.d.ts.map +1 -0
  56. package/dist/schemas/team.js +20 -0
  57. package/dist/schemas/team.js.map +1 -0
  58. package/dist/schemas/user.d.ts +48 -0
  59. package/dist/schemas/user.d.ts.map +1 -0
  60. package/dist/schemas/user.js +21 -0
  61. package/dist/schemas/user.js.map +1 -0
  62. package/dist/types/index.d.ts +81 -0
  63. package/dist/types/index.d.ts.map +1 -0
  64. package/dist/types/index.js +3 -0
  65. package/dist/types/index.js.map +1 -0
  66. package/dist/validators/index.d.ts +6 -0
  67. package/dist/validators/index.d.ts.map +1 -0
  68. package/dist/validators/index.js +28 -0
  69. package/dist/validators/index.js.map +1 -0
  70. package/dist/validators/reference-validator.d.ts +11 -0
  71. package/dist/validators/reference-validator.d.ts.map +1 -0
  72. package/dist/validators/reference-validator.js +171 -0
  73. package/dist/validators/reference-validator.js.map +1 -0
  74. package/dist/validators/schema-validator.d.ts +5 -0
  75. package/dist/validators/schema-validator.d.ts.map +1 -0
  76. package/dist/validators/schema-validator.js +50 -0
  77. package/dist/validators/schema-validator.js.map +1 -0
  78. package/package.json +58 -0
@@ -0,0 +1,382 @@
1
+ import { z } from 'zod';
2
+ export declare const entitySchema: z.ZodObject<{
3
+ aggregateRoot: z.ZodOptional<z.ZodBoolean>;
4
+ identifier: z.ZodOptional<z.ZodString>;
5
+ properties: z.ZodOptional<z.ZodArray<z.ZodObject<{
6
+ name: z.ZodString;
7
+ type: z.ZodString;
8
+ required: z.ZodOptional<z.ZodBoolean>;
9
+ description: z.ZodOptional<z.ZodString>;
10
+ references: z.ZodOptional<z.ZodString>;
11
+ referencesIdentifier: z.ZodOptional<z.ZodString>;
12
+ relationType: z.ZodOptional<z.ZodString>;
13
+ }, "strip", z.ZodTypeAny, {
14
+ type: string;
15
+ name: string;
16
+ description?: string | undefined;
17
+ required?: boolean | undefined;
18
+ references?: string | undefined;
19
+ referencesIdentifier?: string | undefined;
20
+ relationType?: string | undefined;
21
+ }, {
22
+ type: string;
23
+ name: string;
24
+ description?: string | undefined;
25
+ required?: boolean | undefined;
26
+ references?: string | undefined;
27
+ referencesIdentifier?: string | undefined;
28
+ relationType?: string | undefined;
29
+ }>, "many">>;
30
+ services: z.ZodOptional<z.ZodArray<z.ZodAny, "many">>;
31
+ domains: z.ZodOptional<z.ZodArray<z.ZodAny, "many">>;
32
+ } & {
33
+ id: z.ZodString;
34
+ name: z.ZodString;
35
+ summary: z.ZodOptional<z.ZodString>;
36
+ version: z.ZodEffects<z.ZodString, string, string>;
37
+ draft: z.ZodOptional<z.ZodUnion<[z.ZodBoolean, z.ZodObject<{
38
+ title: z.ZodOptional<z.ZodString>;
39
+ message: z.ZodString;
40
+ }, "strip", z.ZodTypeAny, {
41
+ message: string;
42
+ title?: string | undefined;
43
+ }, {
44
+ message: string;
45
+ title?: string | undefined;
46
+ }>]>>;
47
+ badges: z.ZodOptional<z.ZodArray<z.ZodObject<{
48
+ content: z.ZodString;
49
+ backgroundColor: z.ZodString;
50
+ textColor: z.ZodString;
51
+ icon: z.ZodOptional<z.ZodString>;
52
+ }, "strip", z.ZodTypeAny, {
53
+ content: string;
54
+ backgroundColor: string;
55
+ textColor: string;
56
+ icon?: string | undefined;
57
+ }, {
58
+ content: string;
59
+ backgroundColor: string;
60
+ textColor: string;
61
+ icon?: string | undefined;
62
+ }>, "many">>;
63
+ owners: z.ZodOptional<z.ZodArray<z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodObject<{
64
+ id: z.ZodString;
65
+ collection: z.ZodEnum<["users", "teams"]>;
66
+ }, "strip", z.ZodTypeAny, {
67
+ id: string;
68
+ collection: "users" | "teams";
69
+ }, {
70
+ id: string;
71
+ collection: "users" | "teams";
72
+ }>]>, {
73
+ id: string;
74
+ }, string | {
75
+ id: string;
76
+ collection: "users" | "teams";
77
+ }>, "many">>;
78
+ schemaPath: z.ZodOptional<z.ZodString>;
79
+ sidebar: z.ZodOptional<z.ZodObject<{
80
+ label: z.ZodOptional<z.ZodString>;
81
+ badge: z.ZodOptional<z.ZodString>;
82
+ }, "strip", z.ZodTypeAny, {
83
+ label?: string | undefined;
84
+ badge?: string | undefined;
85
+ }, {
86
+ label?: string | undefined;
87
+ badge?: string | undefined;
88
+ }>>;
89
+ repository: z.ZodOptional<z.ZodObject<{
90
+ language: z.ZodOptional<z.ZodString>;
91
+ url: z.ZodOptional<z.ZodString>;
92
+ }, "strip", z.ZodTypeAny, {
93
+ language?: string | undefined;
94
+ url?: string | undefined;
95
+ }, {
96
+ language?: string | undefined;
97
+ url?: string | undefined;
98
+ }>>;
99
+ specifications: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
100
+ openapiPath: z.ZodOptional<z.ZodString>;
101
+ asyncapiPath: z.ZodOptional<z.ZodString>;
102
+ }, "strip", z.ZodTypeAny, {
103
+ openapiPath?: string | undefined;
104
+ asyncapiPath?: string | undefined;
105
+ }, {
106
+ openapiPath?: string | undefined;
107
+ asyncapiPath?: string | undefined;
108
+ }>, z.ZodArray<z.ZodObject<{
109
+ type: z.ZodEnum<["openapi", "asyncapi"]>;
110
+ path: z.ZodString;
111
+ name: z.ZodOptional<z.ZodString>;
112
+ }, "strip", z.ZodTypeAny, {
113
+ path: string;
114
+ type: "asyncapi" | "openapi";
115
+ name?: string | undefined;
116
+ }, {
117
+ path: string;
118
+ type: "asyncapi" | "openapi";
119
+ name?: string | undefined;
120
+ }>, "many">]>>;
121
+ hidden: z.ZodOptional<z.ZodBoolean>;
122
+ resourceGroups: z.ZodOptional<z.ZodArray<z.ZodObject<{
123
+ id: z.ZodOptional<z.ZodString>;
124
+ title: z.ZodOptional<z.ZodString>;
125
+ items: z.ZodArray<z.ZodObject<{
126
+ id: z.ZodString;
127
+ version: z.ZodDefault<z.ZodOptional<z.ZodString>>;
128
+ type: z.ZodEnum<["service", "event", "command", "query", "flow", "channel", "domain", "user", "team"]>;
129
+ }, "strip", z.ZodTypeAny, {
130
+ type: "service" | "event" | "command" | "query" | "flow" | "channel" | "domain" | "user" | "team";
131
+ id: string;
132
+ version: string;
133
+ }, {
134
+ type: "service" | "event" | "command" | "query" | "flow" | "channel" | "domain" | "user" | "team";
135
+ id: string;
136
+ version?: string | undefined;
137
+ }>, "many">;
138
+ limit: z.ZodDefault<z.ZodOptional<z.ZodNumber>>;
139
+ sidebar: z.ZodDefault<z.ZodOptional<z.ZodBoolean>>;
140
+ }, "strip", z.ZodTypeAny, {
141
+ items: {
142
+ type: "service" | "event" | "command" | "query" | "flow" | "channel" | "domain" | "user" | "team";
143
+ id: string;
144
+ version: string;
145
+ }[];
146
+ limit: number;
147
+ sidebar: boolean;
148
+ id?: string | undefined;
149
+ title?: string | undefined;
150
+ }, {
151
+ items: {
152
+ type: "service" | "event" | "command" | "query" | "flow" | "channel" | "domain" | "user" | "team";
153
+ id: string;
154
+ version?: string | undefined;
155
+ }[];
156
+ id?: string | undefined;
157
+ title?: string | undefined;
158
+ limit?: number | undefined;
159
+ sidebar?: boolean | undefined;
160
+ }>, "many">>;
161
+ styles: z.ZodOptional<z.ZodObject<{
162
+ icon: z.ZodOptional<z.ZodString>;
163
+ node: z.ZodOptional<z.ZodObject<{
164
+ color: z.ZodOptional<z.ZodString>;
165
+ label: z.ZodOptional<z.ZodString>;
166
+ }, "strip", z.ZodTypeAny, {
167
+ label?: string | undefined;
168
+ color?: string | undefined;
169
+ }, {
170
+ label?: string | undefined;
171
+ color?: string | undefined;
172
+ }>>;
173
+ }, "strip", z.ZodTypeAny, {
174
+ icon?: string | undefined;
175
+ node?: {
176
+ label?: string | undefined;
177
+ color?: string | undefined;
178
+ } | undefined;
179
+ }, {
180
+ icon?: string | undefined;
181
+ node?: {
182
+ label?: string | undefined;
183
+ color?: string | undefined;
184
+ } | undefined;
185
+ }>>;
186
+ deprecated: z.ZodOptional<z.ZodUnion<[z.ZodObject<{
187
+ message: z.ZodOptional<z.ZodString>;
188
+ date: z.ZodOptional<z.ZodUnion<[z.ZodString, z.ZodDate]>>;
189
+ }, "strip", z.ZodTypeAny, {
190
+ message?: string | undefined;
191
+ date?: string | Date | undefined;
192
+ }, {
193
+ message?: string | undefined;
194
+ date?: string | Date | undefined;
195
+ }>, z.ZodOptional<z.ZodBoolean>]>>;
196
+ visualiser: z.ZodOptional<z.ZodBoolean>;
197
+ versions: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
198
+ latestVersion: z.ZodOptional<z.ZodString>;
199
+ catalog: z.ZodOptional<z.ZodObject<{
200
+ path: z.ZodString;
201
+ filePath: z.ZodString;
202
+ astroContentFilePath: z.ZodString;
203
+ publicPath: z.ZodString;
204
+ type: z.ZodString;
205
+ }, "strip", z.ZodTypeAny, {
206
+ path: string;
207
+ type: string;
208
+ filePath: string;
209
+ astroContentFilePath: string;
210
+ publicPath: string;
211
+ }, {
212
+ path: string;
213
+ type: string;
214
+ filePath: string;
215
+ astroContentFilePath: string;
216
+ publicPath: string;
217
+ }>>;
218
+ }, "strip", z.ZodTypeAny, {
219
+ id: string;
220
+ name: string;
221
+ version: string;
222
+ sidebar?: {
223
+ label?: string | undefined;
224
+ badge?: string | undefined;
225
+ } | undefined;
226
+ summary?: string | undefined;
227
+ draft?: boolean | {
228
+ message: string;
229
+ title?: string | undefined;
230
+ } | undefined;
231
+ badges?: {
232
+ content: string;
233
+ backgroundColor: string;
234
+ textColor: string;
235
+ icon?: string | undefined;
236
+ }[] | undefined;
237
+ owners?: {
238
+ id: string;
239
+ }[] | undefined;
240
+ schemaPath?: string | undefined;
241
+ repository?: {
242
+ language?: string | undefined;
243
+ url?: string | undefined;
244
+ } | undefined;
245
+ specifications?: {
246
+ openapiPath?: string | undefined;
247
+ asyncapiPath?: string | undefined;
248
+ } | {
249
+ path: string;
250
+ type: "asyncapi" | "openapi";
251
+ name?: string | undefined;
252
+ }[] | undefined;
253
+ hidden?: boolean | undefined;
254
+ resourceGroups?: {
255
+ items: {
256
+ type: "service" | "event" | "command" | "query" | "flow" | "channel" | "domain" | "user" | "team";
257
+ id: string;
258
+ version: string;
259
+ }[];
260
+ limit: number;
261
+ sidebar: boolean;
262
+ id?: string | undefined;
263
+ title?: string | undefined;
264
+ }[] | undefined;
265
+ styles?: {
266
+ icon?: string | undefined;
267
+ node?: {
268
+ label?: string | undefined;
269
+ color?: string | undefined;
270
+ } | undefined;
271
+ } | undefined;
272
+ deprecated?: boolean | {
273
+ message?: string | undefined;
274
+ date?: string | Date | undefined;
275
+ } | undefined;
276
+ visualiser?: boolean | undefined;
277
+ versions?: string[] | undefined;
278
+ latestVersion?: string | undefined;
279
+ catalog?: {
280
+ path: string;
281
+ type: string;
282
+ filePath: string;
283
+ astroContentFilePath: string;
284
+ publicPath: string;
285
+ } | undefined;
286
+ services?: any[] | undefined;
287
+ domains?: any[] | undefined;
288
+ properties?: {
289
+ type: string;
290
+ name: string;
291
+ description?: string | undefined;
292
+ required?: boolean | undefined;
293
+ references?: string | undefined;
294
+ referencesIdentifier?: string | undefined;
295
+ relationType?: string | undefined;
296
+ }[] | undefined;
297
+ aggregateRoot?: boolean | undefined;
298
+ identifier?: string | undefined;
299
+ }, {
300
+ id: string;
301
+ name: string;
302
+ version: string;
303
+ sidebar?: {
304
+ label?: string | undefined;
305
+ badge?: string | undefined;
306
+ } | undefined;
307
+ summary?: string | undefined;
308
+ draft?: boolean | {
309
+ message: string;
310
+ title?: string | undefined;
311
+ } | undefined;
312
+ badges?: {
313
+ content: string;
314
+ backgroundColor: string;
315
+ textColor: string;
316
+ icon?: string | undefined;
317
+ }[] | undefined;
318
+ owners?: (string | {
319
+ id: string;
320
+ collection: "users" | "teams";
321
+ })[] | undefined;
322
+ schemaPath?: string | undefined;
323
+ repository?: {
324
+ language?: string | undefined;
325
+ url?: string | undefined;
326
+ } | undefined;
327
+ specifications?: {
328
+ openapiPath?: string | undefined;
329
+ asyncapiPath?: string | undefined;
330
+ } | {
331
+ path: string;
332
+ type: "asyncapi" | "openapi";
333
+ name?: string | undefined;
334
+ }[] | undefined;
335
+ hidden?: boolean | undefined;
336
+ resourceGroups?: {
337
+ items: {
338
+ type: "service" | "event" | "command" | "query" | "flow" | "channel" | "domain" | "user" | "team";
339
+ id: string;
340
+ version?: string | undefined;
341
+ }[];
342
+ id?: string | undefined;
343
+ title?: string | undefined;
344
+ limit?: number | undefined;
345
+ sidebar?: boolean | undefined;
346
+ }[] | undefined;
347
+ styles?: {
348
+ icon?: string | undefined;
349
+ node?: {
350
+ label?: string | undefined;
351
+ color?: string | undefined;
352
+ } | undefined;
353
+ } | undefined;
354
+ deprecated?: boolean | {
355
+ message?: string | undefined;
356
+ date?: string | Date | undefined;
357
+ } | undefined;
358
+ visualiser?: boolean | undefined;
359
+ versions?: string[] | undefined;
360
+ latestVersion?: string | undefined;
361
+ catalog?: {
362
+ path: string;
363
+ type: string;
364
+ filePath: string;
365
+ astroContentFilePath: string;
366
+ publicPath: string;
367
+ } | undefined;
368
+ services?: any[] | undefined;
369
+ domains?: any[] | undefined;
370
+ properties?: {
371
+ type: string;
372
+ name: string;
373
+ description?: string | undefined;
374
+ required?: boolean | undefined;
375
+ references?: string | undefined;
376
+ referencesIdentifier?: string | undefined;
377
+ relationType?: string | undefined;
378
+ }[] | undefined;
379
+ aggregateRoot?: boolean | undefined;
380
+ identifier?: string | undefined;
381
+ }>;
382
+ //# sourceMappingURL=entity.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"entity.d.ts","sourceRoot":"","sources":["../../src/schemas/entity.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAaxB,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAQL,CAAC"}
@@ -0,0 +1,24 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.entitySchema = void 0;
4
+ const zod_1 = require("zod");
5
+ const common_1 = require("./common");
6
+ const propertySchema = zod_1.z.object({
7
+ name: zod_1.z.string(),
8
+ type: zod_1.z.string(),
9
+ required: zod_1.z.boolean().optional(),
10
+ description: zod_1.z.string().optional(),
11
+ references: zod_1.z.string().optional(),
12
+ referencesIdentifier: zod_1.z.string().optional(),
13
+ relationType: zod_1.z.string().optional(),
14
+ });
15
+ exports.entitySchema = zod_1.z
16
+ .object({
17
+ aggregateRoot: zod_1.z.boolean().optional(),
18
+ identifier: zod_1.z.string().optional(),
19
+ properties: zod_1.z.array(propertySchema).optional(),
20
+ services: zod_1.z.array(zod_1.z.any()).optional(), // reference('services')
21
+ domains: zod_1.z.array(zod_1.z.any()).optional(), // reference('domains')
22
+ })
23
+ .merge(common_1.baseSchema);
24
+ //# sourceMappingURL=entity.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"entity.js","sourceRoot":"","sources":["../../src/schemas/entity.ts"],"names":[],"mappings":";;;AAAA,6BAAwB;AACxB,qCAAsC;AAEtC,MAAM,cAAc,GAAG,OAAC,CAAC,MAAM,CAAC;IAC9B,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE;IAChB,IAAI,EAAE,OAAC,CAAC,MAAM,EAAE;IAChB,QAAQ,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IAChC,WAAW,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,UAAU,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,oBAAoB,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAC3C,YAAY,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;CACpC,CAAC,CAAC;AAEU,QAAA,YAAY,GAAG,OAAC;KAC1B,MAAM,CAAC;IACN,aAAa,EAAE,OAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE;IACrC,UAAU,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IACjC,UAAU,EAAE,OAAC,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,QAAQ,EAAE;IAC9C,QAAQ,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,GAAG,EAAE,CAAC,CAAC,QAAQ,EAAE,EAAE,wBAAwB;IAC/D,OAAO,EAAE,OAAC,CAAC,KAAK,CAAC,OAAC,CAAC,GAAG,EAAE,CAAC,CAAC,QAAQ,EAAE,EAAE,uBAAuB;CAC9D,CAAC;KACD,KAAK,CAAC,mBAAU,CAAC,CAAC"}