@graphql-markdown/core 1.16.3 → 1.17.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 (90) hide show
  1. package/dist/config.d.ts +17 -55
  2. package/dist/config.d.ts.map +1 -0
  3. package/dist/config.js +80 -89
  4. package/dist/const/patterns.d.ts +114 -0
  5. package/dist/const/patterns.d.ts.map +1 -0
  6. package/dist/const/patterns.js +116 -0
  7. package/dist/diff.d.ts +1 -0
  8. package/dist/diff.d.ts.map +1 -0
  9. package/dist/directives/normalize.d.ts +79 -0
  10. package/dist/directives/normalize.d.ts.map +1 -0
  11. package/dist/directives/normalize.js +91 -0
  12. package/dist/directives/validation.d.ts +146 -0
  13. package/dist/directives/validation.d.ts.map +1 -0
  14. package/dist/directives/validation.js +188 -0
  15. package/dist/event-emitter.d.ts +109 -0
  16. package/dist/event-emitter.d.ts.map +1 -0
  17. package/dist/event-emitter.js +138 -0
  18. package/dist/event-handlers.d.ts +19 -0
  19. package/dist/event-handlers.d.ts.map +1 -0
  20. package/dist/event-handlers.js +54 -0
  21. package/dist/event-map.d.ts +19 -0
  22. package/dist/event-map.d.ts.map +1 -0
  23. package/dist/event-map.js +35 -0
  24. package/dist/event-types.d.ts +313 -0
  25. package/dist/event-types.d.ts.map +1 -0
  26. package/dist/event-types.js +309 -0
  27. package/dist/events/base.d.ts +114 -0
  28. package/dist/events/base.d.ts.map +1 -0
  29. package/dist/events/base.js +148 -0
  30. package/dist/events/diff-check.d.ts +25 -0
  31. package/dist/events/diff-check.d.ts.map +1 -0
  32. package/dist/events/diff-check.js +26 -0
  33. package/dist/events/diff-events.d.ts +15 -0
  34. package/dist/events/diff-events.d.ts.map +1 -0
  35. package/dist/events/diff-events.js +17 -0
  36. package/dist/events/generate-index-metafile-events.d.ts +15 -0
  37. package/dist/events/generate-index-metafile-events.d.ts.map +1 -0
  38. package/dist/events/generate-index-metafile-events.js +17 -0
  39. package/dist/events/generate-index-metafile.d.ts +28 -0
  40. package/dist/events/generate-index-metafile.d.ts.map +1 -0
  41. package/dist/events/generate-index-metafile.js +29 -0
  42. package/dist/events/index.d.ts +19 -0
  43. package/dist/events/index.d.ts.map +1 -0
  44. package/dist/events/index.js +38 -0
  45. package/dist/events/render-homepage-events.d.ts +15 -0
  46. package/dist/events/render-homepage-events.d.ts.map +1 -0
  47. package/dist/events/render-homepage-events.js +17 -0
  48. package/dist/events/render-homepage.d.ts +22 -0
  49. package/dist/events/render-homepage.d.ts.map +1 -0
  50. package/dist/events/render-homepage.js +23 -0
  51. package/dist/events/render-root-types-events.d.ts +15 -0
  52. package/dist/events/render-root-types-events.d.ts.map +1 -0
  53. package/dist/events/render-root-types-events.js +17 -0
  54. package/dist/events/render-root-types.d.ts +22 -0
  55. package/dist/events/render-root-types.d.ts.map +1 -0
  56. package/dist/events/render-root-types.js +23 -0
  57. package/dist/events/render-type-entities-events.d.ts +15 -0
  58. package/dist/events/render-type-entities-events.d.ts.map +1 -0
  59. package/dist/events/render-type-entities-events.js +17 -0
  60. package/dist/events/render-type-entities.d.ts +25 -0
  61. package/dist/events/render-type-entities.d.ts.map +1 -0
  62. package/dist/events/render-type-entities.js +26 -0
  63. package/dist/events/schema-events.d.ts +15 -0
  64. package/dist/events/schema-events.d.ts.map +1 -0
  65. package/dist/events/schema-events.js +17 -0
  66. package/dist/events/schema-load.d.ts +22 -0
  67. package/dist/events/schema-load.d.ts.map +1 -0
  68. package/dist/events/schema-load.js +23 -0
  69. package/dist/generator.d.ts +1 -0
  70. package/dist/generator.d.ts.map +1 -0
  71. package/dist/generator.js +47 -5
  72. package/dist/graphql-config.d.ts +2 -1
  73. package/dist/graphql-config.d.ts.map +1 -0
  74. package/dist/graphql-config.js +16 -10
  75. package/dist/hooks.d.ts +10 -0
  76. package/dist/hooks.d.ts.map +1 -0
  77. package/dist/hooks.js +33 -0
  78. package/dist/index.d.ts +11 -0
  79. package/dist/index.d.ts.map +1 -0
  80. package/dist/index.js +11 -3
  81. package/dist/options/builder.d.ts +157 -0
  82. package/dist/options/builder.d.ts.map +1 -0
  83. package/dist/options/builder.js +215 -0
  84. package/dist/printer.d.ts +3 -2
  85. package/dist/printer.d.ts.map +1 -0
  86. package/dist/printer.js +1 -1
  87. package/dist/renderer.d.ts +76 -23
  88. package/dist/renderer.d.ts.map +1 -0
  89. package/dist/renderer.js +411 -67
  90. package/package.json +15 -16
@@ -0,0 +1,17 @@
1
+ "use strict";
2
+ /**
3
+ * Generate index metafile event constants.
4
+ *
5
+ * @packageDocumentation
6
+ */
7
+ Object.defineProperty(exports, "__esModule", { value: true });
8
+ exports.GenerateIndexMetafileEvents = void 0;
9
+ /**
10
+ * Event names for generating index metafile.
11
+ */
12
+ exports.GenerateIndexMetafileEvents = {
13
+ /** Emitted before generating index metafile */
14
+ BEFORE_GENERATE: "render:beforeGenerateIndexMetafile",
15
+ /** Emitted after generating index metafile */
16
+ AFTER_GENERATE: "render:afterGenerateIndexMetafile",
17
+ };
@@ -0,0 +1,28 @@
1
+ /**
2
+ * Generate index metafile event class.
3
+ *
4
+ * @packageDocumentation
5
+ */
6
+ import type { DefaultAction } from "@graphql-markdown/types";
7
+ import { CancellableEvent } from "./base";
8
+ /**
9
+ * Event emitted before/after generating index metafile.
10
+ *
11
+ * @category Events
12
+ */
13
+ export declare class GenerateIndexMetafileEvent extends CancellableEvent {
14
+ /** Directory path for the index file */
15
+ readonly dirPath: string;
16
+ /** Category name */
17
+ readonly category: string;
18
+ /** Optional configuration options */
19
+ readonly options?: Record<string, unknown>;
20
+ constructor(data: {
21
+ dirPath: string;
22
+ category: string;
23
+ options?: Record<string, unknown>;
24
+ defaultAction?: DefaultAction;
25
+ cancellable?: boolean;
26
+ });
27
+ }
28
+ //# sourceMappingURL=generate-index-metafile.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"generate-index-metafile.d.ts","sourceRoot":"","sources":["../../src/events/generate-index-metafile.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EAAE,gBAAgB,EAAE,MAAM,QAAQ,CAAC;AAE1C;;;;GAIG;AACH,qBAAa,0BAA2B,SAAQ,gBAAgB;IAC9D,wCAAwC;IACxC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IACzB,oBAAoB;IACpB,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAC1B,qCAAqC;IACrC,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAE3C,YAAY,IAAI,EAAE;QAChB,OAAO,EAAE,MAAM,CAAC;QAChB,QAAQ,EAAE,MAAM,CAAC;QACjB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;QAClC,aAAa,CAAC,EAAE,aAAa,CAAC;QAC9B,WAAW,CAAC,EAAE,OAAO,CAAC;KACvB,EAKA;CACF"}
@@ -0,0 +1,29 @@
1
+ "use strict";
2
+ /**
3
+ * Generate index metafile event class.
4
+ *
5
+ * @packageDocumentation
6
+ */
7
+ Object.defineProperty(exports, "__esModule", { value: true });
8
+ exports.GenerateIndexMetafileEvent = void 0;
9
+ const base_1 = require("./base");
10
+ /**
11
+ * Event emitted before/after generating index metafile.
12
+ *
13
+ * @category Events
14
+ */
15
+ class GenerateIndexMetafileEvent extends base_1.CancellableEvent {
16
+ /** Directory path for the index file */
17
+ dirPath;
18
+ /** Category name */
19
+ category;
20
+ /** Optional configuration options */
21
+ options;
22
+ constructor(data) {
23
+ super(data.cancellable, data.defaultAction);
24
+ this.dirPath = data.dirPath;
25
+ this.category = data.category;
26
+ this.options = data.options;
27
+ }
28
+ }
29
+ exports.GenerateIndexMetafileEvent = GenerateIndexMetafileEvent;
@@ -0,0 +1,19 @@
1
+ /**
2
+ * Event system for GraphQL-Markdown.
3
+ *
4
+ * @packageDocumentation
5
+ */
6
+ export { CancellableEvent, deepFreeze } from "./base";
7
+ export { SchemaEvents } from "./schema-events";
8
+ export { DiffEvents } from "./diff-events";
9
+ export { RenderRootTypesEvents } from "./render-root-types-events";
10
+ export { RenderHomepageEvents } from "./render-homepage-events";
11
+ export { RenderTypeEntitiesEvents } from "./render-type-entities-events";
12
+ export { GenerateIndexMetafileEvents } from "./generate-index-metafile-events";
13
+ export { SchemaLoadEvent } from "./schema-load";
14
+ export { DiffCheckEvent } from "./diff-check";
15
+ export { RenderRootTypesEvent } from "./render-root-types";
16
+ export { RenderHomepageEvent } from "./render-homepage";
17
+ export { RenderTypeEntitiesEvent } from "./render-type-entities";
18
+ export { GenerateIndexMetafileEvent } from "./generate-index-metafile";
19
+ //# sourceMappingURL=index.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/events/index.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAGH,OAAO,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AAGtD,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AACzE,OAAO,EAAE,2BAA2B,EAAE,MAAM,kCAAkC,CAAC;AAG/E,OAAO,EAAE,eAAe,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAC9C,OAAO,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,uBAAuB,EAAE,MAAM,wBAAwB,CAAC;AACjE,OAAO,EAAE,0BAA0B,EAAE,MAAM,2BAA2B,CAAC"}
@@ -0,0 +1,38 @@
1
+ "use strict";
2
+ /**
3
+ * Event system for GraphQL-Markdown.
4
+ *
5
+ * @packageDocumentation
6
+ */
7
+ Object.defineProperty(exports, "__esModule", { value: true });
8
+ exports.GenerateIndexMetafileEvent = exports.RenderTypeEntitiesEvent = exports.RenderHomepageEvent = exports.RenderRootTypesEvent = exports.DiffCheckEvent = exports.SchemaLoadEvent = exports.GenerateIndexMetafileEvents = exports.RenderTypeEntitiesEvents = exports.RenderHomepageEvents = exports.RenderRootTypesEvents = exports.DiffEvents = exports.SchemaEvents = exports.deepFreeze = exports.CancellableEvent = void 0;
9
+ // Base
10
+ const base_1 = require("./base");
11
+ Object.defineProperty(exports, "CancellableEvent", { enumerable: true, get: function () { return base_1.CancellableEvent; } });
12
+ Object.defineProperty(exports, "deepFreeze", { enumerable: true, get: function () { return base_1.deepFreeze; } });
13
+ // Event constants
14
+ const schema_events_1 = require("./schema-events");
15
+ Object.defineProperty(exports, "SchemaEvents", { enumerable: true, get: function () { return schema_events_1.SchemaEvents; } });
16
+ const diff_events_1 = require("./diff-events");
17
+ Object.defineProperty(exports, "DiffEvents", { enumerable: true, get: function () { return diff_events_1.DiffEvents; } });
18
+ const render_root_types_events_1 = require("./render-root-types-events");
19
+ Object.defineProperty(exports, "RenderRootTypesEvents", { enumerable: true, get: function () { return render_root_types_events_1.RenderRootTypesEvents; } });
20
+ const render_homepage_events_1 = require("./render-homepage-events");
21
+ Object.defineProperty(exports, "RenderHomepageEvents", { enumerable: true, get: function () { return render_homepage_events_1.RenderHomepageEvents; } });
22
+ const render_type_entities_events_1 = require("./render-type-entities-events");
23
+ Object.defineProperty(exports, "RenderTypeEntitiesEvents", { enumerable: true, get: function () { return render_type_entities_events_1.RenderTypeEntitiesEvents; } });
24
+ const generate_index_metafile_events_1 = require("./generate-index-metafile-events");
25
+ Object.defineProperty(exports, "GenerateIndexMetafileEvents", { enumerable: true, get: function () { return generate_index_metafile_events_1.GenerateIndexMetafileEvents; } });
26
+ // Event classes
27
+ const schema_load_1 = require("./schema-load");
28
+ Object.defineProperty(exports, "SchemaLoadEvent", { enumerable: true, get: function () { return schema_load_1.SchemaLoadEvent; } });
29
+ const diff_check_1 = require("./diff-check");
30
+ Object.defineProperty(exports, "DiffCheckEvent", { enumerable: true, get: function () { return diff_check_1.DiffCheckEvent; } });
31
+ const render_root_types_1 = require("./render-root-types");
32
+ Object.defineProperty(exports, "RenderRootTypesEvent", { enumerable: true, get: function () { return render_root_types_1.RenderRootTypesEvent; } });
33
+ const render_homepage_1 = require("./render-homepage");
34
+ Object.defineProperty(exports, "RenderHomepageEvent", { enumerable: true, get: function () { return render_homepage_1.RenderHomepageEvent; } });
35
+ const render_type_entities_1 = require("./render-type-entities");
36
+ Object.defineProperty(exports, "RenderTypeEntitiesEvent", { enumerable: true, get: function () { return render_type_entities_1.RenderTypeEntitiesEvent; } });
37
+ const generate_index_metafile_1 = require("./generate-index-metafile");
38
+ Object.defineProperty(exports, "GenerateIndexMetafileEvent", { enumerable: true, get: function () { return generate_index_metafile_1.GenerateIndexMetafileEvent; } });
@@ -0,0 +1,15 @@
1
+ /**
2
+ * Render homepage event constants.
3
+ *
4
+ * @packageDocumentation
5
+ */
6
+ /**
7
+ * Event names for rendering homepage.
8
+ */
9
+ export declare const RenderHomepageEvents: {
10
+ /** Emitted before rendering homepage */
11
+ readonly BEFORE_RENDER: "render:beforeRenderHomepage";
12
+ /** Emitted after rendering homepage */
13
+ readonly AFTER_RENDER: "render:afterRenderHomepage";
14
+ };
15
+ //# sourceMappingURL=render-homepage-events.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"render-homepage-events.d.ts","sourceRoot":"","sources":["../../src/events/render-homepage-events.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;GAEG;AACH,eAAO,MAAM,oBAAoB;IAC/B,wCAAwC;;IAExC,uCAAuC;;CAE/B,CAAC"}
@@ -0,0 +1,17 @@
1
+ "use strict";
2
+ /**
3
+ * Render homepage event constants.
4
+ *
5
+ * @packageDocumentation
6
+ */
7
+ Object.defineProperty(exports, "__esModule", { value: true });
8
+ exports.RenderHomepageEvents = void 0;
9
+ /**
10
+ * Event names for rendering homepage.
11
+ */
12
+ exports.RenderHomepageEvents = {
13
+ /** Emitted before rendering homepage */
14
+ BEFORE_RENDER: "render:beforeRenderHomepage",
15
+ /** Emitted after rendering homepage */
16
+ AFTER_RENDER: "render:afterRenderHomepage",
17
+ };
@@ -0,0 +1,22 @@
1
+ /**
2
+ * Render homepage event class.
3
+ *
4
+ * @packageDocumentation
5
+ */
6
+ import type { DefaultAction } from "@graphql-markdown/types";
7
+ import { CancellableEvent } from "./base";
8
+ /**
9
+ * Event emitted before/after rendering homepage.
10
+ *
11
+ * @category Events
12
+ */
13
+ export declare class RenderHomepageEvent extends CancellableEvent {
14
+ /** Output directory for homepage */
15
+ readonly outputDir: string;
16
+ constructor(data: {
17
+ outputDir: string;
18
+ defaultAction?: DefaultAction;
19
+ cancellable?: boolean;
20
+ });
21
+ }
22
+ //# sourceMappingURL=render-homepage.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"render-homepage.d.ts","sourceRoot":"","sources":["../../src/events/render-homepage.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EAAE,gBAAgB,EAAE,MAAM,QAAQ,CAAC;AAE1C;;;;GAIG;AACH,qBAAa,mBAAoB,SAAQ,gBAAgB;IACvD,oCAAoC;IACpC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAE3B,YAAY,IAAI,EAAE;QAChB,SAAS,EAAE,MAAM,CAAC;QAClB,aAAa,CAAC,EAAE,aAAa,CAAC;QAC9B,WAAW,CAAC,EAAE,OAAO,CAAC;KACvB,EAGA;CACF"}
@@ -0,0 +1,23 @@
1
+ "use strict";
2
+ /**
3
+ * Render homepage event class.
4
+ *
5
+ * @packageDocumentation
6
+ */
7
+ Object.defineProperty(exports, "__esModule", { value: true });
8
+ exports.RenderHomepageEvent = void 0;
9
+ const base_1 = require("./base");
10
+ /**
11
+ * Event emitted before/after rendering homepage.
12
+ *
13
+ * @category Events
14
+ */
15
+ class RenderHomepageEvent extends base_1.CancellableEvent {
16
+ /** Output directory for homepage */
17
+ outputDir;
18
+ constructor(data) {
19
+ super(data.cancellable, data.defaultAction);
20
+ this.outputDir = data.outputDir;
21
+ }
22
+ }
23
+ exports.RenderHomepageEvent = RenderHomepageEvent;
@@ -0,0 +1,15 @@
1
+ /**
2
+ * Render root types event constants.
3
+ *
4
+ * @packageDocumentation
5
+ */
6
+ /**
7
+ * Event names for rendering root types.
8
+ */
9
+ export declare const RenderRootTypesEvents: {
10
+ /** Emitted before rendering root types */
11
+ readonly BEFORE_RENDER: "render:beforeRenderRootTypes";
12
+ /** Emitted after rendering root types */
13
+ readonly AFTER_RENDER: "render:afterRenderRootTypes";
14
+ };
15
+ //# sourceMappingURL=render-root-types-events.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"render-root-types-events.d.ts","sourceRoot":"","sources":["../../src/events/render-root-types-events.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;GAEG;AACH,eAAO,MAAM,qBAAqB;IAChC,0CAA0C;;IAE1C,yCAAyC;;CAEjC,CAAC"}
@@ -0,0 +1,17 @@
1
+ "use strict";
2
+ /**
3
+ * Render root types event constants.
4
+ *
5
+ * @packageDocumentation
6
+ */
7
+ Object.defineProperty(exports, "__esModule", { value: true });
8
+ exports.RenderRootTypesEvents = void 0;
9
+ /**
10
+ * Event names for rendering root types.
11
+ */
12
+ exports.RenderRootTypesEvents = {
13
+ /** Emitted before rendering root types */
14
+ BEFORE_RENDER: "render:beforeRenderRootTypes",
15
+ /** Emitted after rendering root types */
16
+ AFTER_RENDER: "render:afterRenderRootTypes",
17
+ };
@@ -0,0 +1,22 @@
1
+ /**
2
+ * Render root types event class.
3
+ *
4
+ * @packageDocumentation
5
+ */
6
+ import type { DefaultAction } from "@graphql-markdown/types";
7
+ import { CancellableEvent } from "./base";
8
+ /**
9
+ * Event emitted before/after rendering root types.
10
+ *
11
+ * @category Events
12
+ */
13
+ export declare class RenderRootTypesEvent extends CancellableEvent {
14
+ /** Root types to render */
15
+ readonly rootTypes: unknown;
16
+ constructor(data: {
17
+ rootTypes: unknown;
18
+ defaultAction?: DefaultAction;
19
+ cancellable?: boolean;
20
+ });
21
+ }
22
+ //# sourceMappingURL=render-root-types.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"render-root-types.d.ts","sourceRoot":"","sources":["../../src/events/render-root-types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EAAE,gBAAgB,EAAE,MAAM,QAAQ,CAAC;AAE1C;;;;GAIG;AACH,qBAAa,oBAAqB,SAAQ,gBAAgB;IACxD,2BAA2B;IAC3B,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAE5B,YAAY,IAAI,EAAE;QAChB,SAAS,EAAE,OAAO,CAAC;QACnB,aAAa,CAAC,EAAE,aAAa,CAAC;QAC9B,WAAW,CAAC,EAAE,OAAO,CAAC;KACvB,EAGA;CACF"}
@@ -0,0 +1,23 @@
1
+ "use strict";
2
+ /**
3
+ * Render root types event class.
4
+ *
5
+ * @packageDocumentation
6
+ */
7
+ Object.defineProperty(exports, "__esModule", { value: true });
8
+ exports.RenderRootTypesEvent = void 0;
9
+ const base_1 = require("./base");
10
+ /**
11
+ * Event emitted before/after rendering root types.
12
+ *
13
+ * @category Events
14
+ */
15
+ class RenderRootTypesEvent extends base_1.CancellableEvent {
16
+ /** Root types to render */
17
+ rootTypes;
18
+ constructor(data) {
19
+ super(data.cancellable, data.defaultAction);
20
+ this.rootTypes = data.rootTypes;
21
+ }
22
+ }
23
+ exports.RenderRootTypesEvent = RenderRootTypesEvent;
@@ -0,0 +1,15 @@
1
+ /**
2
+ * Render type entities event constants.
3
+ *
4
+ * @packageDocumentation
5
+ */
6
+ /**
7
+ * Event names for rendering type entities.
8
+ */
9
+ export declare const RenderTypeEntitiesEvents: {
10
+ /** Emitted before rendering type entities */
11
+ readonly BEFORE_RENDER: "render:beforeRenderTypeEntities";
12
+ /** Emitted after rendering type entities */
13
+ readonly AFTER_RENDER: "render:afterRenderTypeEntities";
14
+ };
15
+ //# sourceMappingURL=render-type-entities-events.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"render-type-entities-events.d.ts","sourceRoot":"","sources":["../../src/events/render-type-entities-events.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;GAEG;AACH,eAAO,MAAM,wBAAwB;IACnC,6CAA6C;;IAE7C,4CAA4C;;CAEpC,CAAC"}
@@ -0,0 +1,17 @@
1
+ "use strict";
2
+ /**
3
+ * Render type entities event constants.
4
+ *
5
+ * @packageDocumentation
6
+ */
7
+ Object.defineProperty(exports, "__esModule", { value: true });
8
+ exports.RenderTypeEntitiesEvents = void 0;
9
+ /**
10
+ * Event names for rendering type entities.
11
+ */
12
+ exports.RenderTypeEntitiesEvents = {
13
+ /** Emitted before rendering type entities */
14
+ BEFORE_RENDER: "render:beforeRenderTypeEntities",
15
+ /** Emitted after rendering type entities */
16
+ AFTER_RENDER: "render:afterRenderTypeEntities",
17
+ };
@@ -0,0 +1,25 @@
1
+ /**
2
+ * Render type entities event class.
3
+ *
4
+ * @packageDocumentation
5
+ */
6
+ import type { DefaultAction } from "@graphql-markdown/types";
7
+ import { CancellableEvent } from "./base";
8
+ /**
9
+ * Event emitted before/after rendering type entities.
10
+ *
11
+ * @category Events
12
+ */
13
+ export declare class RenderTypeEntitiesEvent extends CancellableEvent {
14
+ /** Name of the type entity */
15
+ readonly name: string;
16
+ /** File path where entity will be rendered */
17
+ readonly filePath: string;
18
+ constructor(data: {
19
+ name: string;
20
+ filePath: string;
21
+ defaultAction?: DefaultAction;
22
+ cancellable?: boolean;
23
+ });
24
+ }
25
+ //# sourceMappingURL=render-type-entities.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"render-type-entities.d.ts","sourceRoot":"","sources":["../../src/events/render-type-entities.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EAAE,gBAAgB,EAAE,MAAM,QAAQ,CAAC;AAE1C;;;;GAIG;AACH,qBAAa,uBAAwB,SAAQ,gBAAgB;IAC3D,8BAA8B;IAC9B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,8CAA8C;IAC9C,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC;IAE1B,YAAY,IAAI,EAAE;QAChB,IAAI,EAAE,MAAM,CAAC;QACb,QAAQ,EAAE,MAAM,CAAC;QACjB,aAAa,CAAC,EAAE,aAAa,CAAC;QAC9B,WAAW,CAAC,EAAE,OAAO,CAAC;KACvB,EAIA;CACF"}
@@ -0,0 +1,26 @@
1
+ "use strict";
2
+ /**
3
+ * Render type entities event class.
4
+ *
5
+ * @packageDocumentation
6
+ */
7
+ Object.defineProperty(exports, "__esModule", { value: true });
8
+ exports.RenderTypeEntitiesEvent = void 0;
9
+ const base_1 = require("./base");
10
+ /**
11
+ * Event emitted before/after rendering type entities.
12
+ *
13
+ * @category Events
14
+ */
15
+ class RenderTypeEntitiesEvent extends base_1.CancellableEvent {
16
+ /** Name of the type entity */
17
+ name;
18
+ /** File path where entity will be rendered */
19
+ filePath;
20
+ constructor(data) {
21
+ super(data.cancellable, data.defaultAction);
22
+ this.name = data.name;
23
+ this.filePath = data.filePath;
24
+ }
25
+ }
26
+ exports.RenderTypeEntitiesEvent = RenderTypeEntitiesEvent;
@@ -0,0 +1,15 @@
1
+ /**
2
+ * Schema loading event constants.
3
+ *
4
+ * @packageDocumentation
5
+ */
6
+ /**
7
+ * Event names for schema loading lifecycle.
8
+ */
9
+ export declare const SchemaEvents: {
10
+ /** Emitted before loading GraphQL schema */
11
+ readonly BEFORE_LOAD: "schema:beforeLoad";
12
+ /** Emitted after loading GraphQL schema */
13
+ readonly AFTER_LOAD: "schema:afterLoad";
14
+ };
15
+ //# sourceMappingURL=schema-events.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"schema-events.d.ts","sourceRoot":"","sources":["../../src/events/schema-events.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;GAEG;AACH,eAAO,MAAM,YAAY;IACvB,4CAA4C;;IAE5C,2CAA2C;;CAEnC,CAAC"}
@@ -0,0 +1,17 @@
1
+ "use strict";
2
+ /**
3
+ * Schema loading event constants.
4
+ *
5
+ * @packageDocumentation
6
+ */
7
+ Object.defineProperty(exports, "__esModule", { value: true });
8
+ exports.SchemaEvents = void 0;
9
+ /**
10
+ * Event names for schema loading lifecycle.
11
+ */
12
+ exports.SchemaEvents = {
13
+ /** Emitted before loading GraphQL schema */
14
+ BEFORE_LOAD: "schema:beforeLoad",
15
+ /** Emitted after loading GraphQL schema */
16
+ AFTER_LOAD: "schema:afterLoad",
17
+ };
@@ -0,0 +1,22 @@
1
+ /**
2
+ * Schema loading event class.
3
+ *
4
+ * @packageDocumentation
5
+ */
6
+ import type { DefaultAction } from "@graphql-markdown/types";
7
+ import { CancellableEvent } from "./base";
8
+ /**
9
+ * Event emitted before/after loading a GraphQL schema.
10
+ *
11
+ * @category Events
12
+ */
13
+ export declare class SchemaLoadEvent extends CancellableEvent {
14
+ /** Path or pointer to the schema location */
15
+ readonly schemaLocation: string;
16
+ constructor(data: {
17
+ schemaLocation: string;
18
+ defaultAction?: DefaultAction;
19
+ cancellable?: boolean;
20
+ });
21
+ }
22
+ //# sourceMappingURL=schema-load.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"schema-load.d.ts","sourceRoot":"","sources":["../../src/events/schema-load.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAC7D,OAAO,EAAE,gBAAgB,EAAE,MAAM,QAAQ,CAAC;AAE1C;;;;GAIG;AACH,qBAAa,eAAgB,SAAQ,gBAAgB;IACnD,6CAA6C;IAC7C,QAAQ,CAAC,cAAc,EAAE,MAAM,CAAC;IAEhC,YAAY,IAAI,EAAE;QAChB,cAAc,EAAE,MAAM,CAAC;QACvB,aAAa,CAAC,EAAE,aAAa,CAAC;QAC9B,WAAW,CAAC,EAAE,OAAO,CAAC;KACvB,EAGA;CACF"}
@@ -0,0 +1,23 @@
1
+ "use strict";
2
+ /**
3
+ * Schema loading event class.
4
+ *
5
+ * @packageDocumentation
6
+ */
7
+ Object.defineProperty(exports, "__esModule", { value: true });
8
+ exports.SchemaLoadEvent = void 0;
9
+ const base_1 = require("./base");
10
+ /**
11
+ * Event emitted before/after loading a GraphQL schema.
12
+ *
13
+ * @category Events
14
+ */
15
+ class SchemaLoadEvent extends base_1.CancellableEvent {
16
+ /** Path or pointer to the schema location */
17
+ schemaLocation;
18
+ constructor(data) {
19
+ super(data.cancellable, data.defaultAction);
20
+ this.schemaLocation = data.schemaLocation;
21
+ }
22
+ }
23
+ exports.SchemaLoadEvent = SchemaLoadEvent;
@@ -22,3 +22,4 @@ import type { GeneratorOptions } from "@graphql-markdown/types";
22
22
  * @returns Promise that resolves when documentation is fully generated
23
23
  */
24
24
  export declare const generateDocFromSchema: ({ baseURL, customDirective, diffMethod, docOptions, force, groupByDirective, homepageLocation, linkRoot, loaders: loadersList, loggerModule, mdxParser, metatags, onlyDocDirective, outputDir, prettify, printer: printerModule, printTypeOptions, schemaLocation, skipDocDirective, tmpDir, }: GeneratorOptions) => Promise<void>;
25
+ //# sourceMappingURL=generator.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"generator.d.ts","sourceRoot":"","sources":["../src/generator.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AACH,OAAO,KAAK,EAGV,gBAAgB,EAKjB,MAAM,yBAAyB,CAAC;AA6CjC;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,qBAAqB,qUAwMjC,CAAC"}
package/dist/generator.js CHANGED
@@ -41,6 +41,9 @@ const config_1 = require("./config");
41
41
  const diff_1 = require("./diff");
42
42
  const printer_1 = require("./printer");
43
43
  const renderer_1 = require("./renderer");
44
+ const event_emitter_1 = require("./event-emitter");
45
+ const events_1 = require("./events");
46
+ const event_handlers_1 = require("./event-handlers");
44
47
  /**
45
48
  * Constant representing nanoseconds per second.
46
49
  *
@@ -75,12 +78,31 @@ const generateDocFromSchema = async ({ baseURL, customDirective, diffMethod, doc
75
78
  (0, logger_1.log)(`An error occurred while loading GraphQL loader.\nCheck your dependencies and configuration.`, "error");
76
79
  return;
77
80
  }
81
+ const events = (0, event_emitter_1.getEvents)();
82
+ const beforeLoadEvent = new events_1.SchemaLoadEvent({
83
+ schemaLocation: schemaLocation,
84
+ });
85
+ await events.emitAsync(events_1.SchemaEvents.BEFORE_LOAD, beforeLoadEvent);
78
86
  const schema = await (0, graphql_1.loadSchema)(schemaLocation, loaders);
87
+ const afterLoadEvent = new events_1.SchemaLoadEvent({
88
+ schemaLocation: schemaLocation,
89
+ });
90
+ await events.emitAsync(events_1.SchemaEvents.AFTER_LOAD, afterLoadEvent);
79
91
  if (diffMethod !== config_1.DiffMethod.NONE) {
92
+ const beforeDiffEvent = new events_1.DiffCheckEvent({
93
+ schema,
94
+ outputDir: tmpDir,
95
+ });
96
+ await events.emitAsync(events_1.DiffEvents.BEFORE_CHECK, beforeDiffEvent);
80
97
  const changed = await (0, diff_1.hasChanges)(schema, tmpDir, diffMethod);
81
98
  if (!changed) {
82
99
  (0, logger_1.log)(`No changes detected in schema "${(0, utils_1.toString)(schemaLocation)}".`);
83
100
  }
101
+ const afterDiffEvent = new events_1.DiffCheckEvent({
102
+ schema,
103
+ outputDir: tmpDir,
104
+ });
105
+ await events.emitAsync(events_1.DiffEvents.AFTER_CHECK, afterDiffEvent);
84
106
  }
85
107
  const [onlyDocDirectives, skipDocDirectives] = [
86
108
  onlyDocDirective,
@@ -91,18 +113,20 @@ const generateDocFromSchema = async ({ baseURL, customDirective, diffMethod, doc
91
113
  return schema.getDirective(name);
92
114
  })
93
115
  .filter((directive) => {
94
- return typeof directive !== "undefined";
116
+ return directive !== undefined;
95
117
  });
96
118
  });
97
119
  const rootTypes = (0, graphql_1.getSchemaMap)(schema);
98
120
  const customDirectives = (0, graphql_1.getCustomDirectives)(rootTypes, customDirective);
99
121
  const groups = (0, graphql_1.getGroups)(rootTypes, groupByDirective);
100
- const mdxModule = await (!mdxParser
101
- ? undefined
102
- : Promise.resolve(`${mdxParser}`).then(s => __importStar(require(s))).catch(() => {
122
+ const mdxModule = await (mdxParser !== undefined && mdxParser !== null
123
+ ? Promise.resolve(`${mdxParser}`).then(s => __importStar(require(s))).catch(() => {
103
124
  (0, logger_1.log)(`An error occurred while loading MDX formatter "${mdxParser}"`, logger_1.LogLevel.warn);
104
125
  return undefined;
105
- }));
126
+ })
127
+ : undefined);
128
+ // Register MDX event handlers if mdxModule loaded successfully
129
+ (0, event_handlers_1.registerMDXEventHandlers)(mdxModule);
106
130
  const printer = await (0, printer_1.getPrinter)(
107
131
  // module mandatory
108
132
  printerModule,
@@ -131,11 +155,29 @@ const generateDocFromSchema = async ({ baseURL, customDirective, diffMethod, doc
131
155
  force,
132
156
  hierarchy: printTypeOptions?.hierarchy,
133
157
  }, mdxModule);
158
+ // Pre-collect all categories before rendering to ensure consistent positions
159
+ renderer.preCollectCategories(Object.keys(rootTypes));
160
+ const beforeRenderRootTypesEvent = new events_1.RenderRootTypesEvent({
161
+ rootTypes,
162
+ });
163
+ await events.emitAsync(events_1.RenderRootTypesEvents.BEFORE_RENDER, beforeRenderRootTypesEvent);
134
164
  const pages = await Promise.all(Object.keys(rootTypes).map(async (name) => {
135
165
  const typeName = name;
136
166
  return renderer.renderRootTypes(typeName, rootTypes[typeName]);
137
167
  }));
168
+ const afterRenderRootTypesEvent = new events_1.RenderRootTypesEvent({
169
+ rootTypes,
170
+ });
171
+ await events.emitAsync(events_1.RenderRootTypesEvents.AFTER_RENDER, afterRenderRootTypesEvent);
172
+ const beforeRenderHomepageEvent = new events_1.RenderHomepageEvent({
173
+ outputDir,
174
+ });
175
+ await events.emitAsync(events_1.RenderHomepageEvents.BEFORE_RENDER, beforeRenderHomepageEvent);
138
176
  await renderer.renderHomepage(homepageLocation);
177
+ const afterRenderHomepageEvent = new events_1.RenderHomepageEvent({
178
+ outputDir,
179
+ });
180
+ await events.emitAsync(events_1.RenderHomepageEvents.AFTER_RENDER, afterRenderHomepageEvent);
139
181
  const duration = (Number(process.hrtime.bigint() - start) / NS_PER_SEC).toFixed(SEC_DECIMALS);
140
182
  (0, logger_1.log)(`Documentation successfully generated in "${outputDir}" with base URL "${baseURL}".`, "success");
141
183
  (0, logger_1.log)(`${pages.flat().length} pages generated in ${duration}s from schema "${(0, utils_1.toString)(schemaLocation)}".`);
@@ -71,7 +71,7 @@ export declare const setLoaderOptions: (loaders: LoaderOption, options: PackageO
71
71
  * @param id - The project ID to load configuration for.
72
72
  * @param options - Optional package options to apply.
73
73
  * @param throwOptions - Options for controlling throw behavior.
74
- * @returns The extension project configuration if found, otherwise undefined.
74
+ * @returns The extension project configuration if found, otherwise `undefined`.
75
75
  *
76
76
  * @throws Will throw an error if throwOnMissing or throwOnEmpty is true and
77
77
  * the corresponding condition is met.
@@ -91,3 +91,4 @@ export declare const setLoaderOptions: (loaders: LoaderOption, options: PackageO
91
91
  */
92
92
  export declare const loadConfiguration: (id: Maybe<string>, options?: Maybe<PackageOptionsConfig>, { throwOnMissing, throwOnEmpty }?: ThrowOptions) => Promise<Maybe<Readonly<ExtensionProjectConfig>>>;
93
93
  export {};
94
+ //# sourceMappingURL=graphql-config.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"graphql-config.d.ts","sourceRoot":"","sources":["../src/graphql-config.ts"],"names":[],"mappings":"AAAA;;;;;;;GAOG;AACH,OAAO,KAAK,EAEV,sBAAsB,EACtB,2BAA2B,EAC3B,YAAY,EACZ,KAAK,EAEL,oBAAoB,EACrB,MAAM,yBAAyB,CAAC;AAUjC;;;GAGG;AACH,eAAO,MAAM,cAAc,oBAA8B,CAAC;AAE1D;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,sBAAsB,EAAE,2BAEpC,CAAC;AAEF;;;;;;GAMG;AACH,UAAU,YAAY;IACpB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,YAAY,CAAC,EAAE,OAAO,CAAC;CACxB;AAWD;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,gBAAgB,wEAkB5B,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,eAAO,MAAM,iBAAiB,iKAsD7B,CAAC"}