@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,309 @@
1
+ "use strict";
2
+ /**
3
+ * Event system types and base classes for GraphQL-Markdown events.
4
+ *
5
+ * @packageDocumentation
6
+ */
7
+ Object.defineProperty(exports, "__esModule", { value: true });
8
+ exports.GenerateIndexMetafileEvent = exports.RenderTypeEntitiesEvent = exports.RenderHomepageEvent = exports.RenderRootTypesEvent = exports.PreCollectCategoriesEvent = exports.DiffCheckEvent = exports.SchemaLoadEvent = exports.EventNames = exports.RenderEvents = exports.CategoryEvents = exports.DiffEvents = exports.SchemaEvents = exports.CancellableEvent = exports.deepFreeze = void 0;
9
+ /**
10
+ * Deep freezes an object to make it immutable at runtime.
11
+ * Recursively freezes all nested objects and arrays.
12
+ *
13
+ * @param obj - The object to freeze
14
+ * @returns The frozen object (same reference)
15
+ *
16
+ * @example
17
+ * ```typescript
18
+ * const data = { user: { name: 'John' } };
19
+ * deepFreeze(data);
20
+ * data.user.name = 'Jane'; // Throws error in strict mode
21
+ * ```
22
+ */
23
+ const deepFreeze = (obj) => {
24
+ // Get all property names including symbols
25
+ const propNames = Object.getOwnPropertyNames(obj);
26
+ // Freeze properties before freezing self
27
+ for (const name of propNames) {
28
+ const value = obj[name];
29
+ // Recursively freeze nested objects
30
+ if (value && typeof value === "object") {
31
+ (0, exports.deepFreeze)(value);
32
+ }
33
+ }
34
+ return Object.freeze(obj);
35
+ };
36
+ exports.deepFreeze = deepFreeze;
37
+ /**
38
+ * Base class for all cancellable events in GraphQL-Markdown.
39
+ *
40
+ * Provides common functionality:
41
+ * - preventDefault() to cancel default actions
42
+ * - stopPropagation() to halt handler chain
43
+ * - Configurable cancellability
44
+ * - Optional default action function
45
+ *
46
+ * @category Events
47
+ */
48
+ class CancellableEvent {
49
+ /**
50
+ * Whether the default action has been prevented.
51
+ * Set to true when preventDefault() is called.
52
+ */
53
+ _defaultPrevented = false;
54
+ /**
55
+ * Whether propagation to remaining handlers has been stopped.
56
+ * Set to true when stopPropagation() is called.
57
+ */
58
+ _propagationStopped = false;
59
+ /**
60
+ * Whether this event can be cancelled.
61
+ * If false, preventDefault() has no effect.
62
+ */
63
+ _cancellable;
64
+ /**
65
+ * Optional function to execute as the default action.
66
+ * Only runs if preventDefault() was not called.
67
+ */
68
+ _defaultAction;
69
+ /**
70
+ * Creates a new CancellableEvent.
71
+ *
72
+ * @param cancellable - Whether this event can be cancelled (default: true)
73
+ * @param defaultAction - Optional function to execute as default action
74
+ */
75
+ constructor(cancellable = true, defaultAction) {
76
+ this._cancellable = cancellable;
77
+ this._defaultAction = defaultAction;
78
+ }
79
+ /**
80
+ * Gets whether the default action has been prevented.
81
+ */
82
+ get defaultPrevented() {
83
+ return this._defaultPrevented;
84
+ }
85
+ /**
86
+ * Gets whether propagation has been stopped.
87
+ */
88
+ get propagationStopped() {
89
+ return this._propagationStopped;
90
+ }
91
+ /**
92
+ * Gets the default action function if one was provided.
93
+ */
94
+ get defaultAction() {
95
+ return this._defaultAction;
96
+ }
97
+ /**
98
+ * Prevents the default action from executing.
99
+ * Only works if the event is cancellable.
100
+ *
101
+ * @example
102
+ * ```typescript
103
+ * events.on('beforeLoadSchema', (event) => {
104
+ * if (shouldUseCustomLoader) {
105
+ * event.preventDefault(); // Stops default schema loading
106
+ * // Custom logic here
107
+ * }
108
+ * });
109
+ * ```
110
+ */
111
+ preventDefault() {
112
+ if (this._cancellable) {
113
+ this._defaultPrevented = true;
114
+ }
115
+ }
116
+ /**
117
+ * Stops propagation to remaining event handlers.
118
+ * Handlers registered after the current one will not execute.
119
+ *
120
+ * @example
121
+ * ```typescript
122
+ * events.on('beforeLoadSchema', (event) => {
123
+ * if (criticalError) {
124
+ * event.stopPropagation(); // No more handlers run
125
+ * }
126
+ * });
127
+ * ```
128
+ */
129
+ stopPropagation() {
130
+ this._propagationStopped = true;
131
+ }
132
+ }
133
+ exports.CancellableEvent = CancellableEvent;
134
+ // =============================================================================
135
+ // EVENT NAME CONSTANTS
136
+ // =============================================================================
137
+ /**
138
+ * Event names for schema loading lifecycle.
139
+ */
140
+ exports.SchemaEvents = {
141
+ /** Emitted before loading GraphQL schema */
142
+ BEFORE_LOAD: "beforeLoadSchema",
143
+ /** Emitted after loading GraphQL schema */
144
+ AFTER_LOAD: "afterLoadSchema",
145
+ };
146
+ /**
147
+ * Event names for diff checking lifecycle.
148
+ */
149
+ exports.DiffEvents = {
150
+ /** Emitted before checking schema differences */
151
+ BEFORE_CHECK: "beforeCheckDiff",
152
+ /** Emitted after checking schema differences */
153
+ AFTER_CHECK: "afterCheckDiff",
154
+ };
155
+ /**
156
+ * Event names for category collection lifecycle.
157
+ */
158
+ exports.CategoryEvents = {
159
+ /** Emitted before pre-collecting categories */
160
+ BEFORE_PRE_COLLECT: "beforePreCollectCategories",
161
+ /** Emitted after pre-collecting categories */
162
+ AFTER_PRE_COLLECT: "afterPreCollectCategories",
163
+ };
164
+ /**
165
+ * Event names for rendering lifecycle.
166
+ */
167
+ exports.RenderEvents = {
168
+ /** Emitted before rendering root types */
169
+ BEFORE_RENDER_ROOT_TYPES: "beforeRenderRootTypes",
170
+ /** Emitted after rendering root types */
171
+ AFTER_RENDER_ROOT_TYPES: "afterRenderRootTypes",
172
+ /** Emitted before rendering homepage */
173
+ BEFORE_RENDER_HOMEPAGE: "beforeRenderHomepage",
174
+ /** Emitted after rendering homepage */
175
+ AFTER_RENDER_HOMEPAGE: "afterRenderHomepage",
176
+ /** Emitted before rendering type entities */
177
+ BEFORE_RENDER_TYPE_ENTITIES: "beforeRenderTypeEntities",
178
+ /** Emitted after rendering type entities */
179
+ AFTER_RENDER_TYPE_ENTITIES: "afterRenderTypeEntities",
180
+ /** Emitted before generating index metafile */
181
+ BEFORE_GENERATE_INDEX_METAFILE: "beforeGenerateIndexMetafile",
182
+ /** Emitted after generating index metafile */
183
+ AFTER_GENERATE_INDEX_METAFILE: "afterGenerateIndexMetafile",
184
+ };
185
+ /**
186
+ * All event names combined.
187
+ */
188
+ exports.EventNames = {
189
+ ...exports.SchemaEvents,
190
+ ...exports.DiffEvents,
191
+ ...exports.CategoryEvents,
192
+ ...exports.RenderEvents,
193
+ };
194
+ // =============================================================================
195
+ // SPECIFIC EVENT CLASSES
196
+ // =============================================================================
197
+ /**
198
+ * Event emitted before/after loading a GraphQL schema.
199
+ *
200
+ * @category Events
201
+ */
202
+ class SchemaLoadEvent extends CancellableEvent {
203
+ /** Path or pointer to the schema location */
204
+ schemaLocation;
205
+ constructor(data) {
206
+ super(data.cancellable, data.defaultAction);
207
+ this.schemaLocation = data.schemaLocation;
208
+ }
209
+ }
210
+ exports.SchemaLoadEvent = SchemaLoadEvent;
211
+ /**
212
+ * Event emitted before/after checking schema differences.
213
+ *
214
+ * @category Events
215
+ */
216
+ class DiffCheckEvent extends CancellableEvent {
217
+ /** Current schema being checked */
218
+ schema;
219
+ /** Path to output directory for diff results */
220
+ outputDir;
221
+ constructor(data) {
222
+ super(data.cancellable, data.defaultAction);
223
+ this.schema = data.schema;
224
+ this.outputDir = data.outputDir;
225
+ }
226
+ }
227
+ exports.DiffCheckEvent = DiffCheckEvent;
228
+ /**
229
+ * Event emitted before/after pre-collecting categories.
230
+ *
231
+ * @category Events
232
+ */
233
+ class PreCollectCategoriesEvent extends CancellableEvent {
234
+ /** Root types being processed */
235
+ rootTypes;
236
+ /** Base URL for documentation */
237
+ baseURL;
238
+ constructor(data) {
239
+ super(data.cancellable, data.defaultAction);
240
+ this.rootTypes = data.rootTypes;
241
+ this.baseURL = data.baseURL;
242
+ }
243
+ }
244
+ exports.PreCollectCategoriesEvent = PreCollectCategoriesEvent;
245
+ /**
246
+ * Event emitted before/after rendering root types.
247
+ *
248
+ * @category Events
249
+ */
250
+ class RenderRootTypesEvent extends CancellableEvent {
251
+ /** Root types to render */
252
+ rootTypes;
253
+ constructor(data) {
254
+ super(data.cancellable, data.defaultAction);
255
+ this.rootTypes = data.rootTypes;
256
+ }
257
+ }
258
+ exports.RenderRootTypesEvent = RenderRootTypesEvent;
259
+ /**
260
+ * Event emitted before/after rendering homepage.
261
+ *
262
+ * @category Events
263
+ */
264
+ class RenderHomepageEvent extends CancellableEvent {
265
+ /** Output directory for homepage */
266
+ outputDir;
267
+ constructor(data) {
268
+ super(data.cancellable, data.defaultAction);
269
+ this.outputDir = data.outputDir;
270
+ }
271
+ }
272
+ exports.RenderHomepageEvent = RenderHomepageEvent;
273
+ /**
274
+ * Event emitted before/after rendering type entities.
275
+ *
276
+ * @category Events
277
+ */
278
+ class RenderTypeEntitiesEvent extends CancellableEvent {
279
+ /** Name of the type entity */
280
+ name;
281
+ /** File path where entity will be rendered */
282
+ filePath;
283
+ constructor(data) {
284
+ super(data.cancellable, data.defaultAction);
285
+ this.name = data.name;
286
+ this.filePath = data.filePath;
287
+ }
288
+ }
289
+ exports.RenderTypeEntitiesEvent = RenderTypeEntitiesEvent;
290
+ /**
291
+ * Event emitted before/after generating index metafile.
292
+ *
293
+ * @category Events
294
+ */
295
+ class GenerateIndexMetafileEvent extends CancellableEvent {
296
+ /** Directory path for the index file */
297
+ dirPath;
298
+ /** Category name */
299
+ category;
300
+ /** Optional configuration options */
301
+ options;
302
+ constructor(data) {
303
+ super(data.cancellable, data.defaultAction);
304
+ this.dirPath = data.dirPath;
305
+ this.category = data.category;
306
+ this.options = data.options;
307
+ }
308
+ }
309
+ exports.GenerateIndexMetafileEvent = GenerateIndexMetafileEvent;
@@ -0,0 +1,114 @@
1
+ /**
2
+ * Base event class and utilities for GraphQL-Markdown events.
3
+ *
4
+ * @packageDocumentation
5
+ */
6
+ import type { DefaultAction } from "@graphql-markdown/types";
7
+ /**
8
+ * Deep freezes an object to make it immutable at runtime.
9
+ * Recursively freezes all nested objects and arrays.
10
+ *
11
+ * @param obj - The object to freeze
12
+ * @returns The frozen object (same reference)
13
+ *
14
+ * @example
15
+ * ```typescript
16
+ * const data = { user: { name: 'John' } };
17
+ * deepFreeze(data);
18
+ * data.user.name = 'Jane'; // Throws error in strict mode
19
+ * ```
20
+ */
21
+ export declare const deepFreeze: <T extends Record<PropertyKey, any>>(obj: T) => T;
22
+ /**
23
+ * Base class for all cancellable events in GraphQL-Markdown.
24
+ *
25
+ * Provides common functionality:
26
+ * - preventDefault() to cancel default actions
27
+ * - stopPropagation() to halt handler chain
28
+ * - Configurable cancellability
29
+ * - Optional default action function
30
+ *
31
+ * @category Events
32
+ */
33
+ export declare abstract class CancellableEvent {
34
+ /**
35
+ * Whether the default action has been prevented.
36
+ * Set to true when preventDefault() is called.
37
+ */
38
+ private _defaultPrevented;
39
+ /**
40
+ * Whether propagation to remaining handlers has been stopped.
41
+ * Set to true when stopPropagation() is called.
42
+ */
43
+ private _propagationStopped;
44
+ /**
45
+ * Whether this event can be cancelled.
46
+ * If false, preventDefault() has no effect.
47
+ */
48
+ private readonly _cancellable;
49
+ /**
50
+ * Optional function to execute as the default action.
51
+ * Only runs if preventDefault() was not called.
52
+ */
53
+ private readonly _defaultAction?;
54
+ /**
55
+ * Creates a new CancellableEvent.
56
+ *
57
+ * @param cancellable - Whether this event can be cancelled (default: true)
58
+ * @param defaultAction - Optional function to execute as default action
59
+ */
60
+ constructor(cancellable?: boolean, defaultAction?: DefaultAction);
61
+ /**
62
+ * Gets whether the default action has been prevented.
63
+ */
64
+ get defaultPrevented(): boolean;
65
+ /**
66
+ * Gets whether propagation has been stopped.
67
+ */
68
+ get propagationStopped(): boolean;
69
+ /**
70
+ * Gets the default action function if one was provided.
71
+ */
72
+ get defaultAction(): DefaultAction | undefined;
73
+ /**
74
+ * Prevents the default action from executing.
75
+ * Only works if the event is cancellable.
76
+ *
77
+ * @example
78
+ * ```typescript
79
+ * events.on('beforeLoadSchema', (event) => {
80
+ * if (shouldUseCustomLoader) {
81
+ * event.preventDefault(); // Stops default schema loading
82
+ * // Custom logic here
83
+ * }
84
+ * });
85
+ * ```
86
+ */
87
+ preventDefault(): void;
88
+ /**
89
+ * Stops propagation to remaining event handlers.
90
+ * Handlers registered after the current one will not execute.
91
+ *
92
+ * @example
93
+ * ```typescript
94
+ * events.on('beforeLoadSchema', (event) => {
95
+ * if (criticalError) {
96
+ * event.stopPropagation(); // No more handlers run
97
+ * }
98
+ * });
99
+ * ```
100
+ */
101
+ stopPropagation(): void;
102
+ /**
103
+ * Executes the default action for an event if it hasn't been prevented.
104
+ *
105
+ * @returns A promise that resolves when the default action completes, or void if the action was prevented or no default action is defined
106
+ *
107
+ * @remarks
108
+ * This method will only execute the `_defaultAction` if:
109
+ * - The event's default has not been prevented (`_defaultPrevented` is false)
110
+ * - A default action function has been defined (`_defaultAction` is a function)
111
+ */
112
+ runDefaultAction(): Promise<void>;
113
+ }
114
+ //# sourceMappingURL=base.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"base.d.ts","sourceRoot":"","sources":["../../src/events/base.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAE7D;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,UAAU,GAAI,CAAC,+CAc3B,CAAC;AAEF;;;;;;;;;;GAUG;AACH,8BAAsB,gBAAgB;IACpC;;;OAGG;IACH,OAAO,CAAC,iBAAiB,CAAS;IAElC;;;OAGG;IACH,OAAO,CAAC,mBAAmB,CAAS;IAEpC;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAU;IAEvC;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAgB;IAEhD;;;;;OAKG;IACH,YAAY,WAAW,UAAO,EAAE,aAAa,CAAC,EAAE,aAAa,EAG5D;IAED;;OAEG;IACH,IAAI,gBAAgB,IAAI,OAAO,CAE9B;IAED;;OAEG;IACH,IAAI,kBAAkB,IAAI,OAAO,CAEhC;IAED;;OAEG;IACH,IAAI,aAAa,IAAI,aAAa,GAAG,SAAS,CAE7C;IAED;;;;;;;;;;;;;OAaG;IACH,cAAc,IAAI,IAAI,CAIrB;IAED;;;;;;;;;;;;OAYG;IACH,eAAe,IAAI,IAAI,CAEtB;IAED;;;;;;;;;OASG;IACG,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC,CAKtC;CACF"}
@@ -0,0 +1,148 @@
1
+ "use strict";
2
+ /**
3
+ * Base event class and utilities for GraphQL-Markdown events.
4
+ *
5
+ * @packageDocumentation
6
+ */
7
+ Object.defineProperty(exports, "__esModule", { value: true });
8
+ exports.CancellableEvent = exports.deepFreeze = void 0;
9
+ /**
10
+ * Deep freezes an object to make it immutable at runtime.
11
+ * Recursively freezes all nested objects and arrays.
12
+ *
13
+ * @param obj - The object to freeze
14
+ * @returns The frozen object (same reference)
15
+ *
16
+ * @example
17
+ * ```typescript
18
+ * const data = { user: { name: 'John' } };
19
+ * deepFreeze(data);
20
+ * data.user.name = 'Jane'; // Throws error in strict mode
21
+ * ```
22
+ */
23
+ const deepFreeze = (obj) => {
24
+ // Get all property names including symbols
25
+ const propNames = Reflect.ownKeys(obj);
26
+ // Freeze properties before freezing self
27
+ for (const name of propNames) {
28
+ const value = obj[name];
29
+ if ((value && typeof value === "object") || typeof value === "function") {
30
+ (0, exports.deepFreeze)(value);
31
+ }
32
+ }
33
+ return Object.freeze(obj);
34
+ };
35
+ exports.deepFreeze = deepFreeze;
36
+ /**
37
+ * Base class for all cancellable events in GraphQL-Markdown.
38
+ *
39
+ * Provides common functionality:
40
+ * - preventDefault() to cancel default actions
41
+ * - stopPropagation() to halt handler chain
42
+ * - Configurable cancellability
43
+ * - Optional default action function
44
+ *
45
+ * @category Events
46
+ */
47
+ class CancellableEvent {
48
+ /**
49
+ * Whether the default action has been prevented.
50
+ * Set to true when preventDefault() is called.
51
+ */
52
+ _defaultPrevented = false;
53
+ /**
54
+ * Whether propagation to remaining handlers has been stopped.
55
+ * Set to true when stopPropagation() is called.
56
+ */
57
+ _propagationStopped = false;
58
+ /**
59
+ * Whether this event can be cancelled.
60
+ * If false, preventDefault() has no effect.
61
+ */
62
+ _cancellable;
63
+ /**
64
+ * Optional function to execute as the default action.
65
+ * Only runs if preventDefault() was not called.
66
+ */
67
+ _defaultAction;
68
+ /**
69
+ * Creates a new CancellableEvent.
70
+ *
71
+ * @param cancellable - Whether this event can be cancelled (default: true)
72
+ * @param defaultAction - Optional function to execute as default action
73
+ */
74
+ constructor(cancellable = true, defaultAction) {
75
+ this._cancellable = cancellable;
76
+ this._defaultAction = defaultAction;
77
+ }
78
+ /**
79
+ * Gets whether the default action has been prevented.
80
+ */
81
+ get defaultPrevented() {
82
+ return this._defaultPrevented;
83
+ }
84
+ /**
85
+ * Gets whether propagation has been stopped.
86
+ */
87
+ get propagationStopped() {
88
+ return this._propagationStopped;
89
+ }
90
+ /**
91
+ * Gets the default action function if one was provided.
92
+ */
93
+ get defaultAction() {
94
+ return this._defaultAction;
95
+ }
96
+ /**
97
+ * Prevents the default action from executing.
98
+ * Only works if the event is cancellable.
99
+ *
100
+ * @example
101
+ * ```typescript
102
+ * events.on('beforeLoadSchema', (event) => {
103
+ * if (shouldUseCustomLoader) {
104
+ * event.preventDefault(); // Stops default schema loading
105
+ * // Custom logic here
106
+ * }
107
+ * });
108
+ * ```
109
+ */
110
+ preventDefault() {
111
+ if (this._cancellable) {
112
+ this._defaultPrevented = true;
113
+ }
114
+ }
115
+ /**
116
+ * Stops propagation to remaining event handlers.
117
+ * Handlers registered after the current one will not execute.
118
+ *
119
+ * @example
120
+ * ```typescript
121
+ * events.on('beforeLoadSchema', (event) => {
122
+ * if (criticalError) {
123
+ * event.stopPropagation(); // No more handlers run
124
+ * }
125
+ * });
126
+ * ```
127
+ */
128
+ stopPropagation() {
129
+ this._propagationStopped = true;
130
+ }
131
+ /**
132
+ * Executes the default action for an event if it hasn't been prevented.
133
+ *
134
+ * @returns A promise that resolves when the default action completes, or void if the action was prevented or no default action is defined
135
+ *
136
+ * @remarks
137
+ * This method will only execute the `_defaultAction` if:
138
+ * - The event's default has not been prevented (`_defaultPrevented` is false)
139
+ * - A default action function has been defined (`_defaultAction` is a function)
140
+ */
141
+ async runDefaultAction() {
142
+ if (!this._defaultPrevented && typeof this._defaultAction === "function") {
143
+ return this._defaultAction();
144
+ }
145
+ return void 0;
146
+ }
147
+ }
148
+ exports.CancellableEvent = CancellableEvent;
@@ -0,0 +1,25 @@
1
+ /**
2
+ * Diff checking 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 checking schema differences.
10
+ *
11
+ * @category Events
12
+ */
13
+ export declare class DiffCheckEvent extends CancellableEvent {
14
+ /** Current schema being checked */
15
+ readonly schema: unknown;
16
+ /** Path to output directory for diff results */
17
+ readonly outputDir: string;
18
+ constructor(data: {
19
+ schema: unknown;
20
+ outputDir: string;
21
+ defaultAction?: DefaultAction;
22
+ cancellable?: boolean;
23
+ });
24
+ }
25
+ //# sourceMappingURL=diff-check.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"diff-check.d.ts","sourceRoot":"","sources":["../../src/events/diff-check.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,cAAe,SAAQ,gBAAgB;IAClD,mCAAmC;IACnC,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;IACzB,gDAAgD;IAChD,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAE3B,YAAY,IAAI,EAAE;QAChB,MAAM,EAAE,OAAO,CAAC;QAChB,SAAS,EAAE,MAAM,CAAC;QAClB,aAAa,CAAC,EAAE,aAAa,CAAC;QAC9B,WAAW,CAAC,EAAE,OAAO,CAAC;KACvB,EAIA;CACF"}
@@ -0,0 +1,26 @@
1
+ "use strict";
2
+ /**
3
+ * Diff checking event class.
4
+ *
5
+ * @packageDocumentation
6
+ */
7
+ Object.defineProperty(exports, "__esModule", { value: true });
8
+ exports.DiffCheckEvent = void 0;
9
+ const base_1 = require("./base");
10
+ /**
11
+ * Event emitted before/after checking schema differences.
12
+ *
13
+ * @category Events
14
+ */
15
+ class DiffCheckEvent extends base_1.CancellableEvent {
16
+ /** Current schema being checked */
17
+ schema;
18
+ /** Path to output directory for diff results */
19
+ outputDir;
20
+ constructor(data) {
21
+ super(data.cancellable, data.defaultAction);
22
+ this.schema = data.schema;
23
+ this.outputDir = data.outputDir;
24
+ }
25
+ }
26
+ exports.DiffCheckEvent = DiffCheckEvent;
@@ -0,0 +1,15 @@
1
+ /**
2
+ * Diff checking event constants.
3
+ *
4
+ * @packageDocumentation
5
+ */
6
+ /**
7
+ * Event names for diff checking lifecycle.
8
+ */
9
+ export declare const DiffEvents: {
10
+ /** Emitted before checking schema differences */
11
+ readonly BEFORE_CHECK: "diff:beforeCheck";
12
+ /** Emitted after checking schema differences */
13
+ readonly AFTER_CHECK: "diff:afterCheck";
14
+ };
15
+ //# sourceMappingURL=diff-events.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"diff-events.d.ts","sourceRoot":"","sources":["../../src/events/diff-events.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;GAEG;AACH,eAAO,MAAM,UAAU;IACrB,iDAAiD;;IAEjD,gDAAgD;;CAExC,CAAC"}
@@ -0,0 +1,17 @@
1
+ "use strict";
2
+ /**
3
+ * Diff checking event constants.
4
+ *
5
+ * @packageDocumentation
6
+ */
7
+ Object.defineProperty(exports, "__esModule", { value: true });
8
+ exports.DiffEvents = void 0;
9
+ /**
10
+ * Event names for diff checking lifecycle.
11
+ */
12
+ exports.DiffEvents = {
13
+ /** Emitted before checking schema differences */
14
+ BEFORE_CHECK: "diff:beforeCheck",
15
+ /** Emitted after checking schema differences */
16
+ AFTER_CHECK: "diff:afterCheck",
17
+ };
@@ -0,0 +1,15 @@
1
+ /**
2
+ * Generate index metafile event constants.
3
+ *
4
+ * @packageDocumentation
5
+ */
6
+ /**
7
+ * Event names for generating index metafile.
8
+ */
9
+ export declare const GenerateIndexMetafileEvents: {
10
+ /** Emitted before generating index metafile */
11
+ readonly BEFORE_GENERATE: "render:beforeGenerateIndexMetafile";
12
+ /** Emitted after generating index metafile */
13
+ readonly AFTER_GENERATE: "render:afterGenerateIndexMetafile";
14
+ };
15
+ //# sourceMappingURL=generate-index-metafile-events.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"generate-index-metafile-events.d.ts","sourceRoot":"","sources":["../../src/events/generate-index-metafile-events.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;GAEG;AACH,eAAO,MAAM,2BAA2B;IACtC,+CAA+C;;IAE/C,8CAA8C;;CAEtC,CAAC"}