@eventcatalog/generator-openapi 7.9.1 → 7.11.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 (8) hide show
  1. package/dist/index.js +133 -9
  2. package/dist/index.js.map +1 -1
  3. package/dist/index.mjs +133 -9
  4. package/dist/index.mjs.map +1 -1
  5. package/dist/types.d.mts +13 -1
  6. package/dist/types.d.ts +13 -1
  7. package/dist/types.js.map +1 -1
  8. package/package.json +2 -2
package/dist/types.d.mts CHANGED
@@ -15,6 +15,17 @@ type Pointer = {
15
15
  id: string;
16
16
  version?: string;
17
17
  };
18
+ type RouteFilter = {
19
+ path?: string | string[];
20
+ prefix?: string | string[];
21
+ suffix?: string | string[];
22
+ match?: string | string[];
23
+ };
24
+ type ConsumerService = {
25
+ id: string;
26
+ version?: string;
27
+ routes?: RouteFilter[];
28
+ };
18
29
  type Service = {
19
30
  id: string;
20
31
  version?: string;
@@ -32,6 +43,7 @@ type Service = {
32
43
  markdown: string;
33
44
  }) => string;
34
45
  headers?: Record<string, string>;
46
+ consumers?: ConsumerService[];
35
47
  };
36
48
  type MessageIdConfig = {
37
49
  prefix?: string;
@@ -107,4 +119,4 @@ interface OpenAPIDocument {
107
119
  paths: OpenAPIPaths;
108
120
  }
109
121
 
110
- export type { Domain, Message, MessageIdConfig, OpenAPIDocument, OpenAPIMediaType, OpenAPIOperation, OpenAPIParameter, OpenAPIPathItem, OpenAPIPaths, Operation, Pointer, Service };
122
+ export type { ConsumerService, Domain, Message, MessageIdConfig, OpenAPIDocument, OpenAPIMediaType, OpenAPIOperation, OpenAPIParameter, OpenAPIPathItem, OpenAPIPaths, Operation, Pointer, RouteFilter, Service };
package/dist/types.d.ts CHANGED
@@ -15,6 +15,17 @@ type Pointer = {
15
15
  id: string;
16
16
  version?: string;
17
17
  };
18
+ type RouteFilter = {
19
+ path?: string | string[];
20
+ prefix?: string | string[];
21
+ suffix?: string | string[];
22
+ match?: string | string[];
23
+ };
24
+ type ConsumerService = {
25
+ id: string;
26
+ version?: string;
27
+ routes?: RouteFilter[];
28
+ };
18
29
  type Service = {
19
30
  id: string;
20
31
  version?: string;
@@ -32,6 +43,7 @@ type Service = {
32
43
  markdown: string;
33
44
  }) => string;
34
45
  headers?: Record<string, string>;
46
+ consumers?: ConsumerService[];
35
47
  };
36
48
  type MessageIdConfig = {
37
49
  prefix?: string;
@@ -107,4 +119,4 @@ interface OpenAPIDocument {
107
119
  paths: OpenAPIPaths;
108
120
  }
109
121
 
110
- export type { Domain, Message, MessageIdConfig, OpenAPIDocument, OpenAPIMediaType, OpenAPIOperation, OpenAPIParameter, OpenAPIPathItem, OpenAPIPaths, Operation, Pointer, Service };
122
+ export type { ConsumerService, Domain, Message, MessageIdConfig, OpenAPIDocument, OpenAPIMediaType, OpenAPIOperation, OpenAPIParameter, OpenAPIPathItem, OpenAPIPaths, Operation, Pointer, RouteFilter, Service };
package/dist/types.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"sources":["../src/types.ts"],"sourcesContent":["import { OpenAPIV3_1, OpenAPI } from 'openapi-types';\n\nexport type Domain = {\n id: string;\n name: string;\n version: string;\n owners?: string[];\n generateMarkdown?: ({}: { domain: Domain; markdown: string }) => string;\n draft?: boolean;\n};\n\nexport type Pointer = {\n id: string;\n version?: string;\n};\n\nexport type Service = {\n id: string;\n version?: string;\n name?: string;\n summary?: string;\n path: string | string[];\n owners?: string[];\n setMessageOwnersToServiceOwners?: boolean;\n draft?: boolean;\n writesTo?: Pointer[];\n readsFrom?: Pointer[];\n generateMarkdown?: ({}: { service: Service; document: OpenAPI.Document; markdown: string }) => string;\n headers?: Record<string, string>;\n};\n\nexport type MessageIdConfig = {\n prefix?: string;\n separator?: string;\n prefixWithServiceId?: boolean;\n};\n\nexport type Message = {\n generateMarkdown?: ({}: { operation: Operation; markdown: string }) => string;\n id?: MessageIdConfig;\n};\n\nexport type Operation = {\n path: string;\n method: string;\n operationId: string;\n summary?: string;\n description?: string;\n type: string;\n action: string;\n externalDocs?: OpenAPIV3_1.ExternalDocumentationObject;\n tags: string[];\n extensions?: {\n [key: string]: any;\n };\n deprecated?:\n | boolean\n | {\n date?: string;\n message?: string;\n };\n};\n\nexport interface OpenAPIParameter {\n name: string;\n in: string;\n required?: boolean;\n schema?: any;\n description?: string;\n}\n\nexport interface OpenAPIMediaType {\n schema?: any;\n example?: any;\n examples?: { [name: string]: { summary?: string; value: any } };\n}\n\nexport interface OpenAPIOperation {\n operationId?: string;\n parameters?: OpenAPIParameter[];\n requestBody?: {\n content?: {\n [contentType: string]: OpenAPIMediaType;\n };\n };\n responses?: {\n [statusCode: string]: {\n isSchema?: boolean;\n content?: {\n [contentType: string]: OpenAPIMediaType;\n };\n };\n };\n}\n\nexport interface OpenAPIPathItem {\n [method: string]: OpenAPIOperation;\n}\n\nexport interface OpenAPIPaths {\n [path: string]: OpenAPIPathItem;\n}\n\nexport interface OpenAPIDocument {\n paths: OpenAPIPaths;\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
1
+ {"version":3,"sources":["../src/types.ts"],"sourcesContent":["import { OpenAPIV3_1, OpenAPI } from 'openapi-types';\n\nexport type Domain = {\n id: string;\n name: string;\n version: string;\n owners?: string[];\n generateMarkdown?: ({}: { domain: Domain; markdown: string }) => string;\n draft?: boolean;\n};\n\nexport type Pointer = {\n id: string;\n version?: string;\n};\n\nexport type RouteFilter = {\n path?: string | string[];\n prefix?: string | string[];\n suffix?: string | string[];\n match?: string | string[];\n};\n\nexport type ConsumerService = {\n id: string;\n version?: string;\n routes?: RouteFilter[];\n};\n\nexport type Service = {\n id: string;\n version?: string;\n name?: string;\n summary?: string;\n path: string | string[];\n owners?: string[];\n setMessageOwnersToServiceOwners?: boolean;\n draft?: boolean;\n writesTo?: Pointer[];\n readsFrom?: Pointer[];\n generateMarkdown?: ({}: { service: Service; document: OpenAPI.Document; markdown: string }) => string;\n headers?: Record<string, string>;\n consumers?: ConsumerService[];\n};\n\nexport type MessageIdConfig = {\n prefix?: string;\n separator?: string;\n prefixWithServiceId?: boolean;\n};\n\nexport type Message = {\n generateMarkdown?: ({}: { operation: Operation; markdown: string }) => string;\n id?: MessageIdConfig;\n};\n\nexport type Operation = {\n path: string;\n method: string;\n operationId: string;\n summary?: string;\n description?: string;\n type: string;\n action: string;\n externalDocs?: OpenAPIV3_1.ExternalDocumentationObject;\n tags: string[];\n extensions?: {\n [key: string]: any;\n };\n deprecated?:\n | boolean\n | {\n date?: string;\n message?: string;\n };\n};\n\nexport interface OpenAPIParameter {\n name: string;\n in: string;\n required?: boolean;\n schema?: any;\n description?: string;\n}\n\nexport interface OpenAPIMediaType {\n schema?: any;\n example?: any;\n examples?: { [name: string]: { summary?: string; value: any } };\n}\n\nexport interface OpenAPIOperation {\n operationId?: string;\n parameters?: OpenAPIParameter[];\n requestBody?: {\n content?: {\n [contentType: string]: OpenAPIMediaType;\n };\n };\n responses?: {\n [statusCode: string]: {\n isSchema?: boolean;\n content?: {\n [contentType: string]: OpenAPIMediaType;\n };\n };\n };\n}\n\nexport interface OpenAPIPathItem {\n [method: string]: OpenAPIOperation;\n}\n\nexport interface OpenAPIPaths {\n [path: string]: OpenAPIPathItem;\n}\n\nexport interface OpenAPIDocument {\n paths: OpenAPIPaths;\n}\n"],"mappings":";;;;;;;;;;;;;;;;AAAA;AAAA;","names":[]}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@eventcatalog/generator-openapi",
3
- "version": "7.9.1",
3
+ "version": "7.11.0",
4
4
  "description": "OpenAPI generator for EventCatalog",
5
5
  "publishConfig": {
6
6
  "access": "public"
@@ -29,7 +29,7 @@
29
29
  "dependencies": {
30
30
  "@apidevtools/swagger-parser": "^10.1.0",
31
31
  "@changesets/cli": "^2.27.7",
32
- "@eventcatalog/sdk": "2.17.4",
32
+ "@eventcatalog/sdk": "^2.18.2",
33
33
  "chalk": "4.1.2",
34
34
  "js-yaml": "^4.1.0",
35
35
  "openapi-types": "^12.1.3",