@eventcatalog/generator-asyncapi 4.3.0 → 4.4.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 (7) hide show
  1. package/dist/index.d.mts +10 -0
  2. package/dist/index.d.ts +10 -0
  3. package/dist/index.js +16 -6
  4. package/dist/index.js.map +1 -1
  5. package/dist/index.mjs +16 -6
  6. package/dist/index.mjs.map +1 -1
  7. package/package.json +2 -2
package/dist/index.d.mts CHANGED
@@ -6,6 +6,7 @@ declare const optionsSchema: z.ZodObject<{
6
6
  services: z.ZodArray<z.ZodObject<{
7
7
  id: z.ZodString;
8
8
  path: z.ZodString;
9
+ draft: z.ZodOptional<z.ZodBoolean>;
9
10
  name: z.ZodOptional<z.ZodString>;
10
11
  owners: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
11
12
  generateMarkdown: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodObject<{
@@ -44,6 +45,7 @@ declare const optionsSchema: z.ZodObject<{
44
45
  }, "strip", z.ZodTypeAny, {
45
46
  path: string;
46
47
  id: string;
48
+ draft?: boolean | undefined;
47
49
  name?: string | undefined;
48
50
  owners?: string[] | undefined;
49
51
  generateMarkdown?: ((args_0: {
@@ -58,6 +60,7 @@ declare const optionsSchema: z.ZodObject<{
58
60
  }, {
59
61
  path: string;
60
62
  id: string;
63
+ draft?: boolean | undefined;
61
64
  name?: string | undefined;
62
65
  owners?: string[] | undefined;
63
66
  generateMarkdown?: ((args_0: {
@@ -102,6 +105,7 @@ declare const optionsSchema: z.ZodObject<{
102
105
  name: z.ZodString;
103
106
  owners: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
104
107
  version: z.ZodString;
108
+ draft: z.ZodOptional<z.ZodBoolean>;
105
109
  generateMarkdown: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodObject<{
106
110
  domain: z.ZodObject<{
107
111
  id: z.ZodString;
@@ -136,6 +140,7 @@ declare const optionsSchema: z.ZodObject<{
136
140
  id: string;
137
141
  name: string;
138
142
  version: string;
143
+ draft?: boolean | undefined;
139
144
  owners?: string[] | undefined;
140
145
  generateMarkdown?: ((args_0: {
141
146
  domain: {
@@ -149,6 +154,7 @@ declare const optionsSchema: z.ZodObject<{
149
154
  id: string;
150
155
  name: string;
151
156
  version: string;
157
+ draft?: boolean | undefined;
152
158
  owners?: string[] | undefined;
153
159
  generateMarkdown?: ((args_0: {
154
160
  domain: {
@@ -167,6 +173,7 @@ declare const optionsSchema: z.ZodObject<{
167
173
  services: {
168
174
  path: string;
169
175
  id: string;
176
+ draft?: boolean | undefined;
170
177
  name?: string | undefined;
171
178
  owners?: string[] | undefined;
172
179
  generateMarkdown?: ((args_0: {
@@ -192,6 +199,7 @@ declare const optionsSchema: z.ZodObject<{
192
199
  id: string;
193
200
  name: string;
194
201
  version: string;
202
+ draft?: boolean | undefined;
195
203
  owners?: string[] | undefined;
196
204
  generateMarkdown?: ((args_0: {
197
205
  domain: {
@@ -210,6 +218,7 @@ declare const optionsSchema: z.ZodObject<{
210
218
  services: {
211
219
  path: string;
212
220
  id: string;
221
+ draft?: boolean | undefined;
213
222
  name?: string | undefined;
214
223
  owners?: string[] | undefined;
215
224
  generateMarkdown?: ((args_0: {
@@ -235,6 +244,7 @@ declare const optionsSchema: z.ZodObject<{
235
244
  id: string;
236
245
  name: string;
237
246
  version: string;
247
+ draft?: boolean | undefined;
238
248
  owners?: string[] | undefined;
239
249
  generateMarkdown?: ((args_0: {
240
250
  domain: {
package/dist/index.d.ts CHANGED
@@ -6,6 +6,7 @@ declare const optionsSchema: z.ZodObject<{
6
6
  services: z.ZodArray<z.ZodObject<{
7
7
  id: z.ZodString;
8
8
  path: z.ZodString;
9
+ draft: z.ZodOptional<z.ZodBoolean>;
9
10
  name: z.ZodOptional<z.ZodString>;
10
11
  owners: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
11
12
  generateMarkdown: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodObject<{
@@ -44,6 +45,7 @@ declare const optionsSchema: z.ZodObject<{
44
45
  }, "strip", z.ZodTypeAny, {
45
46
  path: string;
46
47
  id: string;
48
+ draft?: boolean | undefined;
47
49
  name?: string | undefined;
48
50
  owners?: string[] | undefined;
49
51
  generateMarkdown?: ((args_0: {
@@ -58,6 +60,7 @@ declare const optionsSchema: z.ZodObject<{
58
60
  }, {
59
61
  path: string;
60
62
  id: string;
63
+ draft?: boolean | undefined;
61
64
  name?: string | undefined;
62
65
  owners?: string[] | undefined;
63
66
  generateMarkdown?: ((args_0: {
@@ -102,6 +105,7 @@ declare const optionsSchema: z.ZodObject<{
102
105
  name: z.ZodString;
103
106
  owners: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
104
107
  version: z.ZodString;
108
+ draft: z.ZodOptional<z.ZodBoolean>;
105
109
  generateMarkdown: z.ZodOptional<z.ZodFunction<z.ZodTuple<[z.ZodObject<{
106
110
  domain: z.ZodObject<{
107
111
  id: z.ZodString;
@@ -136,6 +140,7 @@ declare const optionsSchema: z.ZodObject<{
136
140
  id: string;
137
141
  name: string;
138
142
  version: string;
143
+ draft?: boolean | undefined;
139
144
  owners?: string[] | undefined;
140
145
  generateMarkdown?: ((args_0: {
141
146
  domain: {
@@ -149,6 +154,7 @@ declare const optionsSchema: z.ZodObject<{
149
154
  id: string;
150
155
  name: string;
151
156
  version: string;
157
+ draft?: boolean | undefined;
152
158
  owners?: string[] | undefined;
153
159
  generateMarkdown?: ((args_0: {
154
160
  domain: {
@@ -167,6 +173,7 @@ declare const optionsSchema: z.ZodObject<{
167
173
  services: {
168
174
  path: string;
169
175
  id: string;
176
+ draft?: boolean | undefined;
170
177
  name?: string | undefined;
171
178
  owners?: string[] | undefined;
172
179
  generateMarkdown?: ((args_0: {
@@ -192,6 +199,7 @@ declare const optionsSchema: z.ZodObject<{
192
199
  id: string;
193
200
  name: string;
194
201
  version: string;
202
+ draft?: boolean | undefined;
195
203
  owners?: string[] | undefined;
196
204
  generateMarkdown?: ((args_0: {
197
205
  domain: {
@@ -210,6 +218,7 @@ declare const optionsSchema: z.ZodObject<{
210
218
  services: {
211
219
  path: string;
212
220
  id: string;
221
+ draft?: boolean | undefined;
213
222
  name?: string | undefined;
214
223
  owners?: string[] | undefined;
215
224
  generateMarkdown?: ((args_0: {
@@ -235,6 +244,7 @@ declare const optionsSchema: z.ZodObject<{
235
244
  id: string;
236
245
  name: string;
237
246
  version: string;
247
+ draft?: boolean | undefined;
238
248
  owners?: string[] | undefined;
239
249
  generateMarkdown?: ((args_0: {
240
250
  domain: {
package/dist/index.js CHANGED
@@ -1541,7 +1541,7 @@ var import_path2 = __toESM(require("path"));
1541
1541
  // package.json
1542
1542
  var package_default = {
1543
1543
  name: "@eventcatalog/generator-asyncapi",
1544
- version: "4.3.0",
1544
+ version: "4.4.0",
1545
1545
  description: "AsyncAPI generator for EventCatalog",
1546
1546
  scripts: {
1547
1547
  build: "tsup",
@@ -1579,7 +1579,7 @@ var package_default = {
1579
1579
  dependencies: {
1580
1580
  "@asyncapi/avro-schema-parser": "^3.0.24",
1581
1581
  "@asyncapi/parser": "^3.3.0",
1582
- "@eventcatalog/sdk": "^2.5.5",
1582
+ "@eventcatalog/sdk": "^2.6.9",
1583
1583
  chalk: "^4",
1584
1584
  "fs-extra": "^11.2.0",
1585
1585
  glob: "^11.0.0",
@@ -2661,6 +2661,7 @@ var optionsSchema = import_zod.z.object({
2661
2661
  import_zod.z.object({
2662
2662
  id: import_zod.z.string({ required_error: "The service id is required. please provide the service id" }),
2663
2663
  path: import_zod.z.string({ required_error: "The service path is required. please provide the path to specification file" }),
2664
+ draft: import_zod.z.boolean().optional(),
2664
2665
  name: import_zod.z.string().optional(),
2665
2666
  owners: import_zod.z.array(import_zod.z.string()).optional(),
2666
2667
  generateMarkdown: import_zod.z.function().args(
@@ -2692,6 +2693,7 @@ var optionsSchema = import_zod.z.object({
2692
2693
  name: import_zod.z.string({ required_error: "The domain name is required. please provide a domain name" }),
2693
2694
  owners: import_zod.z.array(import_zod.z.string()).optional(),
2694
2695
  version: import_zod.z.string({ required_error: "The domain version is required. please provide a domain version" }),
2696
+ draft: import_zod.z.boolean().optional(),
2695
2697
  // function that takes options (including domain) and returns a string
2696
2698
  generateMarkdown: import_zod.z.function().args(
2697
2699
  import_zod.z.object({
@@ -2797,6 +2799,8 @@ var index_default = async (config, options) => {
2797
2799
  const operations = document2.allOperations();
2798
2800
  const channels = document2.allChannels();
2799
2801
  const documentTags = document2.info().tags().all() || [];
2802
+ const isDomainMarkedAsDraft = options.domain?.draft || false;
2803
+ const isServiceMarkedAsDraft = isDomainMarkedAsDraft || document2.info().extensions().get("x-eventcatalog-draft")?.value() || service.draft || false;
2800
2804
  const serviceId = service.id;
2801
2805
  const serviceName = service.name || document2.info().title();
2802
2806
  const version = document2.info().version();
@@ -2821,6 +2825,7 @@ var index_default = async (config, options) => {
2821
2825
  const { id: domainId, name: domainName, version: domainVersion, owners: domainOwners } = options.domain;
2822
2826
  const domain = await getDomain(options.domain.id, domainVersion || "latest");
2823
2827
  const currentDomain = await getDomain(options.domain.id, "latest");
2828
+ const domainIsDraft = isDomainMarkedAsDraft || currentDomain?.draft || false;
2824
2829
  console.log(import_chalk3.default.blue(`
2825
2830
  Processing domain: ${domainName} (v${domainVersion})`));
2826
2831
  if (currentDomain && currentDomain.version !== domainVersion) {
@@ -2834,7 +2839,8 @@ Processing domain: ${domainName} (v${domainVersion})`));
2834
2839
  name: domainName,
2835
2840
  version: domainVersion,
2836
2841
  markdown: options.domain?.generateMarkdown ? options.domain.generateMarkdown({ domain: options.domain, markdown: generatedMarkdownForDomain }) : generatedMarkdownForDomain,
2837
- ...domainOwners && { owners: domainOwners }
2842
+ ...domainOwners && { owners: domainOwners },
2843
+ ...domainIsDraft && { draft: true }
2838
2844
  // services: [{ id: serviceId, version: version }],
2839
2845
  });
2840
2846
  console.log(import_chalk3.default.cyan(` - Domain (v${domainVersion}) created`));
@@ -2882,7 +2888,8 @@ Processing domain: ${domainName} (v${domainVersion})`));
2882
2888
  ...Object.keys(paramsForCatalog).length > 0 && { parameters: paramsForCatalog },
2883
2889
  ...channel.address() && { address: channel.address() },
2884
2890
  ...channelAsJSON?.summary && { summary: channelAsJSON.summary },
2885
- ...protocols.length > 0 && { protocols }
2891
+ ...protocols.length > 0 && { protocols },
2892
+ ...(isDomainMarkedAsDraft || isServiceMarkedAsDraft) && { draft: true }
2886
2893
  },
2887
2894
  { override: true }
2888
2895
  );
@@ -2895,6 +2902,7 @@ Processing domain: ${domainName} (v${domainVersion})`));
2895
2902
  const messageVersion = message.extensions().get("x-eventcatalog-message-version")?.value() || version;
2896
2903
  const deprecatedDate = message.extensions().get("x-eventcatalog-deprecated-date")?.value() || null;
2897
2904
  const deprecatedMessage = message.extensions().get("x-eventcatalog-deprecated-message")?.value() || null;
2905
+ const isMessageMarkedAsDraft = isDomainMarkedAsDraft || isServiceMarkedAsDraft || message.extensions().get("x-eventcatalog-draft")?.value() || null;
2898
2906
  const serviceOwnsMessageContract = isServiceMessageOwner(message);
2899
2907
  const isReceived = operation.action() === "receive" || operation.action() === "subscribe";
2900
2908
  const isSent = operation.action() === "send" || operation.action() === "publish";
@@ -2940,7 +2948,8 @@ Processing domain: ${domainName} (v${domainVersion})`));
2940
2948
  ...channelsForMessage.length > 0 && { channels: channelsForMessage },
2941
2949
  ...deprecatedDate && {
2942
2950
  deprecated: { date: deprecatedDate, ...deprecatedMessage && { message: deprecatedMessage } }
2943
- }
2951
+ },
2952
+ ...isMessageMarkedAsDraft && { draft: true }
2944
2953
  },
2945
2954
  {
2946
2955
  override: true,
@@ -3007,7 +3016,8 @@ Processing domain: ${domainName} (v${domainVersion})`));
3007
3016
  },
3008
3017
  ...owners && { owners },
3009
3018
  ...repository && { repository },
3010
- ...styles2 && { styles: styles2 }
3019
+ ...styles2 && { styles: styles2 },
3020
+ ...isServiceMarkedAsDraft && { draft: true }
3011
3021
  },
3012
3022
  {
3013
3023
  path: servicePath,