@eventcatalog/generator-openapi 7.4.0 → 7.4.2

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.
package/dist/index.mjs CHANGED
@@ -561,7 +561,7 @@ var getSummary2 = (message2) => {
561
561
  }
562
562
  return escapeSpecialCharactersThatBreakMarkdown(eventCatalogMessageSummary);
563
563
  };
564
- var buildMessage = async (pathToFile, document, operation, generateMarkdown) => {
564
+ var buildMessage = async (pathToFile, document, operation, generateMarkdown, messageIdConfig) => {
565
565
  const requestBodiesAndResponses = await getSchemasByOperationId(pathToFile, operation.operationId);
566
566
  const extensions = operation.extensions || {};
567
567
  const operationTags = operation.tags.map((badge) => ({
@@ -578,6 +578,14 @@ var buildMessage = async (pathToFile, document, operation, generateMarkdown) =>
578
578
  }
579
579
  const httpVerb = operation.method.toUpperCase() || "";
580
580
  const generatedMarkdownForMessage = defaultMarkdown3(operation, requestBodiesAndResponses);
581
+ if (messageIdConfig?.prefix) {
582
+ const separator = messageIdConfig.separator || "-";
583
+ uniqueIdentifier = [messageIdConfig.prefix, uniqueIdentifier].join(separator);
584
+ }
585
+ if (messageIdConfig?.prefixWithServiceId) {
586
+ const separator = messageIdConfig.separator || "-";
587
+ uniqueIdentifier = [apiName, uniqueIdentifier].join(separator);
588
+ }
581
589
  return {
582
590
  id: extensions["x-eventcatalog-message-id"] || uniqueIdentifier,
583
591
  version: extensions["x-eventcatalog-message-version"] || document.info.version,
@@ -1717,7 +1725,7 @@ import chalk2 from "chalk";
1717
1725
  // ../../node_modules/.pnpm/boxen@8.0.1/node_modules/boxen/index.js
1718
1726
  import process2 from "process";
1719
1727
 
1720
- // ../../node_modules/.pnpm/ansi-regex@6.2.0/node_modules/ansi-regex/index.js
1728
+ // ../../node_modules/.pnpm/ansi-regex@6.2.2/node_modules/ansi-regex/index.js
1721
1729
  function ansiRegex({ onlyFirst = false } = {}) {
1722
1730
  const ST = "(?:\\u0007|\\u001B\\u005C|\\u009C)";
1723
1731
  const osc = `(?:\\u001B\\][\\s\\S]*?${ST})`;
@@ -1726,7 +1734,7 @@ function ansiRegex({ onlyFirst = false } = {}) {
1726
1734
  return new RegExp(pattern, onlyFirst ? void 0 : "g");
1727
1735
  }
1728
1736
 
1729
- // ../../node_modules/.pnpm/strip-ansi@7.1.0/node_modules/strip-ansi/index.js
1737
+ // ../../node_modules/.pnpm/strip-ansi@7.1.2/node_modules/strip-ansi/index.js
1730
1738
  var regex = ansiRegex();
1731
1739
  function stripAnsi(string) {
1732
1740
  if (typeof string !== "string") {
@@ -1735,7 +1743,7 @@ function stripAnsi(string) {
1735
1743
  return string.replace(regex, "");
1736
1744
  }
1737
1745
 
1738
- // ../../node_modules/.pnpm/get-east-asian-width@1.3.1/node_modules/get-east-asian-width/lookup.js
1746
+ // ../../node_modules/.pnpm/get-east-asian-width@1.4.0/node_modules/get-east-asian-width/lookup.js
1739
1747
  function isAmbiguous(x) {
1740
1748
  return x === 161 || x === 164 || x === 167 || x === 168 || x === 170 || x === 173 || x === 174 || x >= 176 && x <= 180 || x >= 182 && x <= 186 || x >= 188 && x <= 191 || x === 198 || x === 208 || x === 215 || x === 216 || x >= 222 && x <= 225 || x === 230 || x >= 232 && x <= 234 || x === 236 || x === 237 || x === 240 || x === 242 || x === 243 || x >= 247 && x <= 250 || x === 252 || x === 254 || x === 257 || x === 273 || x === 275 || x === 283 || x === 294 || x === 295 || x === 299 || x >= 305 && x <= 307 || x === 312 || x >= 319 && x <= 322 || x === 324 || x >= 328 && x <= 331 || x === 333 || x === 338 || x === 339 || x === 358 || x === 359 || x === 363 || x === 462 || x === 464 || x === 466 || x === 468 || x === 470 || x === 472 || x === 474 || x === 476 || x === 593 || x === 609 || x === 708 || x === 711 || x >= 713 && x <= 715 || x === 717 || x === 720 || x >= 728 && x <= 731 || x === 733 || x === 735 || x >= 768 && x <= 879 || x >= 913 && x <= 929 || x >= 931 && x <= 937 || x >= 945 && x <= 961 || x >= 963 && x <= 969 || x === 1025 || x >= 1040 && x <= 1103 || x === 1105 || x === 8208 || x >= 8211 && x <= 8214 || x === 8216 || x === 8217 || x === 8220 || x === 8221 || x >= 8224 && x <= 8226 || x >= 8228 && x <= 8231 || x === 8240 || x === 8242 || x === 8243 || x === 8245 || x === 8251 || x === 8254 || x === 8308 || x === 8319 || x >= 8321 && x <= 8324 || x === 8364 || x === 8451 || x === 8453 || x === 8457 || x === 8467 || x === 8470 || x === 8481 || x === 8482 || x === 8486 || x === 8491 || x === 8531 || x === 8532 || x >= 8539 && x <= 8542 || x >= 8544 && x <= 8555 || x >= 8560 && x <= 8569 || x === 8585 || x >= 8592 && x <= 8601 || x === 8632 || x === 8633 || x === 8658 || x === 8660 || x === 8679 || x === 8704 || x === 8706 || x === 8707 || x === 8711 || x === 8712 || x === 8715 || x === 8719 || x === 8721 || x === 8725 || x === 8730 || x >= 8733 && x <= 8736 || x === 8739 || x === 8741 || x >= 8743 && x <= 8748 || x === 8750 || x >= 8756 && x <= 8759 || x === 8764 || x === 8765 || x === 8776 || x === 8780 || x === 8786 || x === 8800 || x === 8801 || x >= 8804 && x <= 8807 || x === 8810 || x === 8811 || x === 8814 || x === 8815 || x === 8834 || x === 8835 || x === 8838 || x === 8839 || x === 8853 || x === 8857 || x === 8869 || x === 8895 || x === 8978 || x >= 9312 && x <= 9449 || x >= 9451 && x <= 9547 || x >= 9552 && x <= 9587 || x >= 9600 && x <= 9615 || x >= 9618 && x <= 9621 || x === 9632 || x === 9633 || x >= 9635 && x <= 9641 || x === 9650 || x === 9651 || x === 9654 || x === 9655 || x === 9660 || x === 9661 || x === 9664 || x === 9665 || x >= 9670 && x <= 9672 || x === 9675 || x >= 9678 && x <= 9681 || x >= 9698 && x <= 9701 || x === 9711 || x === 9733 || x === 9734 || x === 9737 || x === 9742 || x === 9743 || x === 9756 || x === 9758 || x === 9792 || x === 9794 || x === 9824 || x === 9825 || x >= 9827 && x <= 9829 || x >= 9831 && x <= 9834 || x === 9836 || x === 9837 || x === 9839 || x === 9886 || x === 9887 || x === 9919 || x >= 9926 && x <= 9933 || x >= 9935 && x <= 9939 || x >= 9941 && x <= 9953 || x === 9955 || x === 9960 || x === 9961 || x >= 9963 && x <= 9969 || x === 9972 || x >= 9974 && x <= 9977 || x === 9979 || x === 9980 || x === 9982 || x === 9983 || x === 10045 || x >= 10102 && x <= 10111 || x >= 11094 && x <= 11097 || x >= 12872 && x <= 12879 || x >= 57344 && x <= 63743 || x >= 65024 && x <= 65039 || x === 65533 || x >= 127232 && x <= 127242 || x >= 127248 && x <= 127277 || x >= 127280 && x <= 127337 || x >= 127344 && x <= 127373 || x === 127375 || x === 127376 || x >= 127387 && x <= 127404 || x >= 917760 && x <= 917999 || x >= 983040 && x <= 1048573 || x >= 1048576 && x <= 1114109;
1741
1749
  }
@@ -1743,10 +1751,10 @@ function isFullWidth(x) {
1743
1751
  return x === 12288 || x >= 65281 && x <= 65376 || x >= 65504 && x <= 65510;
1744
1752
  }
1745
1753
  function isWide(x) {
1746
- return x >= 4352 && x <= 4447 || x === 8986 || x === 8987 || x === 9001 || x === 9002 || x >= 9193 && x <= 9196 || x === 9200 || x === 9203 || x === 9725 || x === 9726 || x === 9748 || x === 9749 || x >= 9776 && x <= 9783 || x >= 9800 && x <= 9811 || x === 9855 || x >= 9866 && x <= 9871 || x === 9875 || x === 9889 || x === 9898 || x === 9899 || x === 9917 || x === 9918 || x === 9924 || x === 9925 || x === 9934 || x === 9940 || x === 9962 || x === 9970 || x === 9971 || x === 9973 || x === 9978 || x === 9981 || x === 9989 || x === 9994 || x === 9995 || x === 10024 || x === 10060 || x === 10062 || x >= 10067 && x <= 10069 || x === 10071 || x >= 10133 && x <= 10135 || x === 10160 || x === 10175 || x === 11035 || x === 11036 || x === 11088 || x === 11093 || x >= 11904 && x <= 11929 || x >= 11931 && x <= 12019 || x >= 12032 && x <= 12245 || x >= 12272 && x <= 12287 || x >= 12289 && x <= 12350 || x >= 12353 && x <= 12438 || x >= 12441 && x <= 12543 || x >= 12549 && x <= 12591 || x >= 12593 && x <= 12686 || x >= 12688 && x <= 12773 || x >= 12783 && x <= 12830 || x >= 12832 && x <= 12871 || x >= 12880 && x <= 42124 || x >= 42128 && x <= 42182 || x >= 43360 && x <= 43388 || x >= 44032 && x <= 55203 || x >= 63744 && x <= 64255 || x >= 65040 && x <= 65049 || x >= 65072 && x <= 65106 || x >= 65108 && x <= 65126 || x >= 65128 && x <= 65131 || x >= 94176 && x <= 94180 || x === 94192 || x === 94193 || x >= 94208 && x <= 100343 || x >= 100352 && x <= 101589 || x >= 101631 && x <= 101640 || x >= 110576 && x <= 110579 || x >= 110581 && x <= 110587 || x === 110589 || x === 110590 || x >= 110592 && x <= 110882 || x === 110898 || x >= 110928 && x <= 110930 || x === 110933 || x >= 110948 && x <= 110951 || x >= 110960 && x <= 111355 || x >= 119552 && x <= 119638 || x >= 119648 && x <= 119670 || x === 126980 || x === 127183 || x === 127374 || x >= 127377 && x <= 127386 || x >= 127488 && x <= 127490 || x >= 127504 && x <= 127547 || x >= 127552 && x <= 127560 || x === 127568 || x === 127569 || x >= 127584 && x <= 127589 || x >= 127744 && x <= 127776 || x >= 127789 && x <= 127797 || x >= 127799 && x <= 127868 || x >= 127870 && x <= 127891 || x >= 127904 && x <= 127946 || x >= 127951 && x <= 127955 || x >= 127968 && x <= 127984 || x === 127988 || x >= 127992 && x <= 128062 || x === 128064 || x >= 128066 && x <= 128252 || x >= 128255 && x <= 128317 || x >= 128331 && x <= 128334 || x >= 128336 && x <= 128359 || x === 128378 || x === 128405 || x === 128406 || x === 128420 || x >= 128507 && x <= 128591 || x >= 128640 && x <= 128709 || x === 128716 || x >= 128720 && x <= 128722 || x >= 128725 && x <= 128727 || x >= 128732 && x <= 128735 || x === 128747 || x === 128748 || x >= 128756 && x <= 128764 || x >= 128992 && x <= 129003 || x === 129008 || x >= 129292 && x <= 129338 || x >= 129340 && x <= 129349 || x >= 129351 && x <= 129535 || x >= 129648 && x <= 129660 || x >= 129664 && x <= 129673 || x >= 129679 && x <= 129734 || x >= 129742 && x <= 129756 || x >= 129759 && x <= 129769 || x >= 129776 && x <= 129784 || x >= 131072 && x <= 196605 || x >= 196608 && x <= 262141;
1754
+ return x >= 4352 && x <= 4447 || x === 8986 || x === 8987 || x === 9001 || x === 9002 || x >= 9193 && x <= 9196 || x === 9200 || x === 9203 || x === 9725 || x === 9726 || x === 9748 || x === 9749 || x >= 9776 && x <= 9783 || x >= 9800 && x <= 9811 || x === 9855 || x >= 9866 && x <= 9871 || x === 9875 || x === 9889 || x === 9898 || x === 9899 || x === 9917 || x === 9918 || x === 9924 || x === 9925 || x === 9934 || x === 9940 || x === 9962 || x === 9970 || x === 9971 || x === 9973 || x === 9978 || x === 9981 || x === 9989 || x === 9994 || x === 9995 || x === 10024 || x === 10060 || x === 10062 || x >= 10067 && x <= 10069 || x === 10071 || x >= 10133 && x <= 10135 || x === 10160 || x === 10175 || x === 11035 || x === 11036 || x === 11088 || x === 11093 || x >= 11904 && x <= 11929 || x >= 11931 && x <= 12019 || x >= 12032 && x <= 12245 || x >= 12272 && x <= 12287 || x >= 12289 && x <= 12350 || x >= 12353 && x <= 12438 || x >= 12441 && x <= 12543 || x >= 12549 && x <= 12591 || x >= 12593 && x <= 12686 || x >= 12688 && x <= 12773 || x >= 12783 && x <= 12830 || x >= 12832 && x <= 12871 || x >= 12880 && x <= 42124 || x >= 42128 && x <= 42182 || x >= 43360 && x <= 43388 || x >= 44032 && x <= 55203 || x >= 63744 && x <= 64255 || x >= 65040 && x <= 65049 || x >= 65072 && x <= 65106 || x >= 65108 && x <= 65126 || x >= 65128 && x <= 65131 || x >= 94176 && x <= 94180 || x >= 94192 && x <= 94198 || x >= 94208 && x <= 101589 || x >= 101631 && x <= 101662 || x >= 101760 && x <= 101874 || x >= 110576 && x <= 110579 || x >= 110581 && x <= 110587 || x === 110589 || x === 110590 || x >= 110592 && x <= 110882 || x === 110898 || x >= 110928 && x <= 110930 || x === 110933 || x >= 110948 && x <= 110951 || x >= 110960 && x <= 111355 || x >= 119552 && x <= 119638 || x >= 119648 && x <= 119670 || x === 126980 || x === 127183 || x === 127374 || x >= 127377 && x <= 127386 || x >= 127488 && x <= 127490 || x >= 127504 && x <= 127547 || x >= 127552 && x <= 127560 || x === 127568 || x === 127569 || x >= 127584 && x <= 127589 || x >= 127744 && x <= 127776 || x >= 127789 && x <= 127797 || x >= 127799 && x <= 127868 || x >= 127870 && x <= 127891 || x >= 127904 && x <= 127946 || x >= 127951 && x <= 127955 || x >= 127968 && x <= 127984 || x === 127988 || x >= 127992 && x <= 128062 || x === 128064 || x >= 128066 && x <= 128252 || x >= 128255 && x <= 128317 || x >= 128331 && x <= 128334 || x >= 128336 && x <= 128359 || x === 128378 || x === 128405 || x === 128406 || x === 128420 || x >= 128507 && x <= 128591 || x >= 128640 && x <= 128709 || x === 128716 || x >= 128720 && x <= 128722 || x >= 128725 && x <= 128728 || x >= 128732 && x <= 128735 || x === 128747 || x === 128748 || x >= 128756 && x <= 128764 || x >= 128992 && x <= 129003 || x === 129008 || x >= 129292 && x <= 129338 || x >= 129340 && x <= 129349 || x >= 129351 && x <= 129535 || x >= 129648 && x <= 129660 || x >= 129664 && x <= 129674 || x >= 129678 && x <= 129734 || x === 129736 || x >= 129741 && x <= 129756 || x >= 129759 && x <= 129770 || x >= 129775 && x <= 129784 || x >= 131072 && x <= 196605 || x >= 196608 && x <= 262141;
1747
1755
  }
1748
1756
 
1749
- // ../../node_modules/.pnpm/get-east-asian-width@1.3.1/node_modules/get-east-asian-width/index.js
1757
+ // ../../node_modules/.pnpm/get-east-asian-width@1.4.0/node_modules/get-east-asian-width/index.js
1750
1758
  function validate(codePoint) {
1751
1759
  if (!Number.isSafeInteger(codePoint)) {
1752
1760
  throw new TypeError(`Expected a code point, got \`${typeof codePoint}\`.`);
@@ -1913,7 +1921,7 @@ function camelCase(input, options) {
1913
1921
  // ../../node_modules/.pnpm/boxen@8.0.1/node_modules/boxen/index.js
1914
1922
  var import_ansi_align = __toESM(require_ansi_align(), 1);
1915
1923
 
1916
- // ../../node_modules/.pnpm/ansi-styles@6.2.1/node_modules/ansi-styles/index.js
1924
+ // ../../node_modules/.pnpm/ansi-styles@6.2.3/node_modules/ansi-styles/index.js
1917
1925
  var ANSI_BACKGROUND_OFFSET = 10;
1918
1926
  var wrapAnsi16 = (offset = 0) => (code) => `\x1B[${code + offset}m`;
1919
1927
  var wrapAnsi256 = (offset = 0) => (code) => `\x1B[${38 + offset};5;${code}m`;
@@ -2012,7 +2020,7 @@ function assembleStyles() {
2012
2020
  styles.bgColor.ansi16m = wrapAnsi16m(ANSI_BACKGROUND_OFFSET);
2013
2021
  Object.defineProperties(styles, {
2014
2022
  rgbToAnsi256: {
2015
- value: (red, green, blue) => {
2023
+ value(red, green, blue) {
2016
2024
  if (red === green && green === blue) {
2017
2025
  if (red < 8) {
2018
2026
  return 16;
@@ -2027,7 +2035,7 @@ function assembleStyles() {
2027
2035
  enumerable: false
2028
2036
  },
2029
2037
  hexToRgb: {
2030
- value: (hex) => {
2038
+ value(hex) {
2031
2039
  const matches = /[a-f\d]{6}|[a-f\d]{3}/i.exec(hex.toString(16));
2032
2040
  if (!matches) {
2033
2041
  return [0, 0, 0];
@@ -2052,7 +2060,7 @@ function assembleStyles() {
2052
2060
  enumerable: false
2053
2061
  },
2054
2062
  ansi256ToAnsi: {
2055
- value: (code) => {
2063
+ value(code) {
2056
2064
  if (code < 8) {
2057
2065
  return 30 + code;
2058
2066
  }
@@ -2099,7 +2107,7 @@ function assembleStyles() {
2099
2107
  var ansiStyles = assembleStyles();
2100
2108
  var ansi_styles_default = ansiStyles;
2101
2109
 
2102
- // ../../node_modules/.pnpm/wrap-ansi@9.0.0/node_modules/wrap-ansi/index.js
2110
+ // ../../node_modules/.pnpm/wrap-ansi@9.0.2/node_modules/wrap-ansi/index.js
2103
2111
  var ESCAPES = /* @__PURE__ */ new Set([
2104
2112
  "\x1B",
2105
2113
  "\x9B"
@@ -2814,7 +2822,7 @@ import { join } from "path";
2814
2822
  // package.json
2815
2823
  var package_default = {
2816
2824
  name: "@eventcatalog/generator-openapi",
2817
- version: "7.4.0",
2825
+ version: "7.4.2",
2818
2826
  description: "OpenAPI generator for EventCatalog",
2819
2827
  scripts: {
2820
2828
  build: "tsup",
@@ -2851,7 +2859,7 @@ var package_default = {
2851
2859
  dependencies: {
2852
2860
  "@apidevtools/swagger-parser": "^10.1.0",
2853
2861
  "@changesets/cli": "^2.27.7",
2854
- "@eventcatalog/sdk": "^2.6.9",
2862
+ "@eventcatalog/sdk": "^2.7.5",
2855
2863
  chalk: "^4",
2856
2864
  "js-yaml": "^4.1.0",
2857
2865
  "openapi-types": "^12.1.3",
@@ -2969,6 +2977,8 @@ var index_default = async (_, options) => {
2969
2977
  let serviceMarkdown = service.markdown;
2970
2978
  let serviceSpecificationsFiles = [];
2971
2979
  let serviceSpecifications = service.specifications;
2980
+ let serviceBadges = null;
2981
+ let serviceAttachments = null;
2972
2982
  const isDomainMarkedAsDraft = options.domain?.draft || null;
2973
2983
  const isServiceMarkedAsDraft = (
2974
2984
  // @ts-ignore
@@ -3032,6 +3042,8 @@ Processing domain: ${domainName} (v${domainVersion})`));
3032
3042
  owners = latestServiceInCatalog.owners || [];
3033
3043
  repository = latestServiceInCatalog.repository || null;
3034
3044
  styles2 = latestServiceInCatalog.styles || null;
3045
+ serviceBadges = latestServiceInCatalog.badges || null;
3046
+ serviceAttachments = latestServiceInCatalog.attachments || null;
3035
3047
  serviceSpecifications = {
3036
3048
  ...serviceSpecifications,
3037
3049
  ...persistPreviousSpecificationFiles ? latestServiceInCatalog.specifications : {}
@@ -3043,6 +3055,7 @@ Processing domain: ${domainName} (v${domainVersion})`));
3043
3055
  await writeService(
3044
3056
  {
3045
3057
  ...service,
3058
+ badges: serviceBadges || service.badges,
3046
3059
  markdown: serviceMarkdown,
3047
3060
  specifications: serviceSpecifications,
3048
3061
  sends,
@@ -3050,7 +3063,8 @@ Processing domain: ${domainName} (v${domainVersion})`));
3050
3063
  ...owners ? { owners } : {},
3051
3064
  ...repository ? { repository } : {},
3052
3065
  ...styles2 ? { styles: styles2 } : {},
3053
- ...isServiceMarkedAsDraft ? { draft: true } : {}
3066
+ ...isServiceMarkedAsDraft ? { draft: true } : {},
3067
+ ...serviceAttachments ? { attachments: serviceAttachments } : {}
3054
3068
  },
3055
3069
  { path: join(servicePath), override: true }
3056
3070
  );
@@ -3088,11 +3102,14 @@ var processMessagesForOpenAPISpec = async (pathToSpec, document, servicePath, op
3088
3102
  pathToSpec,
3089
3103
  document,
3090
3104
  operation,
3091
- options.messages?.generateMarkdown
3105
+ options.messages?.generateMarkdown,
3106
+ options.messages?.id
3092
3107
  );
3093
3108
  let messageMarkdown = message2.markdown;
3094
3109
  const messageType = operation.type;
3095
3110
  const messageAction = operation.action;
3111
+ let messageBadges = null;
3112
+ let messageAttachments = null;
3096
3113
  console.log(chalk4.blue(`Processing message: ${message2.name} (v${message2.version})`));
3097
3114
  const {
3098
3115
  addFileToMessage,
@@ -3103,6 +3120,8 @@ var processMessagesForOpenAPISpec = async (pathToSpec, document, servicePath, op
3103
3120
  } = getMessageTypeUtils(process.env.PROJECT_DIR, messageType);
3104
3121
  const catalogedMessage = await getMessage(message2.id, "latest");
3105
3122
  if (catalogedMessage) {
3123
+ messageBadges = catalogedMessage.badges || null;
3124
+ messageAttachments = catalogedMessage.attachments || null;
3106
3125
  if (preserveExistingMessages) {
3107
3126
  messageMarkdown = catalogedMessage.markdown;
3108
3127
  }
@@ -3118,8 +3137,10 @@ var processMessagesForOpenAPISpec = async (pathToSpec, document, servicePath, op
3118
3137
  await writeMessage(
3119
3138
  {
3120
3139
  ...message2,
3140
+ badges: messageBadges || message2.badges,
3121
3141
  markdown: messageMarkdown,
3122
3142
  ...options.owners ? { owners: options.owners } : {},
3143
+ ...messageAttachments ? { attachments: messageAttachments } : {},
3123
3144
  // only if its defined add it to the sidebar
3124
3145
  ...sidebarBadgeType === "HTTP_METHOD" ? { sidebar } : {},
3125
3146
  ...isDraft ? { draft: true } : {}