@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.
- package/dist/config.d.ts +17 -55
- package/dist/config.d.ts.map +1 -0
- package/dist/config.js +80 -89
- package/dist/const/patterns.d.ts +114 -0
- package/dist/const/patterns.d.ts.map +1 -0
- package/dist/const/patterns.js +116 -0
- package/dist/diff.d.ts +1 -0
- package/dist/diff.d.ts.map +1 -0
- package/dist/directives/normalize.d.ts +79 -0
- package/dist/directives/normalize.d.ts.map +1 -0
- package/dist/directives/normalize.js +91 -0
- package/dist/directives/validation.d.ts +146 -0
- package/dist/directives/validation.d.ts.map +1 -0
- package/dist/directives/validation.js +188 -0
- package/dist/event-emitter.d.ts +109 -0
- package/dist/event-emitter.d.ts.map +1 -0
- package/dist/event-emitter.js +138 -0
- package/dist/event-handlers.d.ts +19 -0
- package/dist/event-handlers.d.ts.map +1 -0
- package/dist/event-handlers.js +54 -0
- package/dist/event-map.d.ts +19 -0
- package/dist/event-map.d.ts.map +1 -0
- package/dist/event-map.js +35 -0
- package/dist/event-types.d.ts +313 -0
- package/dist/event-types.d.ts.map +1 -0
- package/dist/event-types.js +309 -0
- package/dist/events/base.d.ts +114 -0
- package/dist/events/base.d.ts.map +1 -0
- package/dist/events/base.js +148 -0
- package/dist/events/diff-check.d.ts +25 -0
- package/dist/events/diff-check.d.ts.map +1 -0
- package/dist/events/diff-check.js +26 -0
- package/dist/events/diff-events.d.ts +15 -0
- package/dist/events/diff-events.d.ts.map +1 -0
- package/dist/events/diff-events.js +17 -0
- package/dist/events/generate-index-metafile-events.d.ts +15 -0
- package/dist/events/generate-index-metafile-events.d.ts.map +1 -0
- package/dist/events/generate-index-metafile-events.js +17 -0
- package/dist/events/generate-index-metafile.d.ts +28 -0
- package/dist/events/generate-index-metafile.d.ts.map +1 -0
- package/dist/events/generate-index-metafile.js +29 -0
- package/dist/events/index.d.ts +19 -0
- package/dist/events/index.d.ts.map +1 -0
- package/dist/events/index.js +38 -0
- package/dist/events/render-homepage-events.d.ts +15 -0
- package/dist/events/render-homepage-events.d.ts.map +1 -0
- package/dist/events/render-homepage-events.js +17 -0
- package/dist/events/render-homepage.d.ts +22 -0
- package/dist/events/render-homepage.d.ts.map +1 -0
- package/dist/events/render-homepage.js +23 -0
- package/dist/events/render-root-types-events.d.ts +15 -0
- package/dist/events/render-root-types-events.d.ts.map +1 -0
- package/dist/events/render-root-types-events.js +17 -0
- package/dist/events/render-root-types.d.ts +22 -0
- package/dist/events/render-root-types.d.ts.map +1 -0
- package/dist/events/render-root-types.js +23 -0
- package/dist/events/render-type-entities-events.d.ts +15 -0
- package/dist/events/render-type-entities-events.d.ts.map +1 -0
- package/dist/events/render-type-entities-events.js +17 -0
- package/dist/events/render-type-entities.d.ts +25 -0
- package/dist/events/render-type-entities.d.ts.map +1 -0
- package/dist/events/render-type-entities.js +26 -0
- package/dist/events/schema-events.d.ts +15 -0
- package/dist/events/schema-events.d.ts.map +1 -0
- package/dist/events/schema-events.js +17 -0
- package/dist/events/schema-load.d.ts +22 -0
- package/dist/events/schema-load.d.ts.map +1 -0
- package/dist/events/schema-load.js +23 -0
- package/dist/generator.d.ts +1 -0
- package/dist/generator.d.ts.map +1 -0
- package/dist/generator.js +47 -5
- package/dist/graphql-config.d.ts +2 -1
- package/dist/graphql-config.d.ts.map +1 -0
- package/dist/graphql-config.js +16 -10
- package/dist/hooks.d.ts +10 -0
- package/dist/hooks.d.ts.map +1 -0
- package/dist/hooks.js +33 -0
- package/dist/index.d.ts +11 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +11 -3
- package/dist/options/builder.d.ts +157 -0
- package/dist/options/builder.d.ts.map +1 -0
- package/dist/options/builder.js +215 -0
- package/dist/printer.d.ts +3 -2
- package/dist/printer.d.ts.map +1 -0
- package/dist/printer.js +1 -1
- package/dist/renderer.d.ts +76 -23
- package/dist/renderer.d.ts.map +1 -0
- package/dist/renderer.js +411 -67
- package/package.json +15 -16
|
@@ -0,0 +1,138 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.resetEvents = exports.getEvents = void 0;
|
|
4
|
+
const node_events_1 = require("node:events");
|
|
5
|
+
/**
|
|
6
|
+
* Custom EventEmitter that supports cancellable events with sequential handler execution.
|
|
7
|
+
*
|
|
8
|
+
* Features:
|
|
9
|
+
* - Executes async handlers sequentially (one after another)
|
|
10
|
+
* - Collects errors without stopping handler execution
|
|
11
|
+
* - Supports stopPropagation to halt handler chain
|
|
12
|
+
* - Returns execution results to emitters
|
|
13
|
+
*
|
|
14
|
+
* @category Events
|
|
15
|
+
*/
|
|
16
|
+
class CancellableEventEmitter extends node_events_1.EventEmitter {
|
|
17
|
+
/**
|
|
18
|
+
* Emit an event asynchronously with cancellable event support.
|
|
19
|
+
*
|
|
20
|
+
* Handlers are executed sequentially in registration order.
|
|
21
|
+
* If a handler throws an error, it's collected but execution continues.
|
|
22
|
+
* If event.propagationStopped becomes true, remaining handlers are skipped.
|
|
23
|
+
*
|
|
24
|
+
* After all handlers execute, if the event has a defaultAction function and
|
|
25
|
+
* preventDefault() was not called, the default action is automatically executed.
|
|
26
|
+
*
|
|
27
|
+
* @param eventName - Name of the event to emit
|
|
28
|
+
* @param event - Cancellable event object with preventDefault() and stopPropagation() methods
|
|
29
|
+
* @returns Promise resolving to EmitResult with errors and cancellation status
|
|
30
|
+
*
|
|
31
|
+
* @example
|
|
32
|
+
* ```typescript
|
|
33
|
+
* const events = getEvents();
|
|
34
|
+
* const event = new SchemaLoadEvent({
|
|
35
|
+
* schemaLocation: '/path/to/schema',
|
|
36
|
+
* defaultAction: async () => {
|
|
37
|
+
* // This runs automatically if not prevented
|
|
38
|
+
* await loadSchema('/path/to/schema');
|
|
39
|
+
* }
|
|
40
|
+
* });
|
|
41
|
+
*
|
|
42
|
+
* const { errors, defaultPrevented } = await events.emitAsync('beforeLoadSchema', event);
|
|
43
|
+
*
|
|
44
|
+
* if (errors.length > 0) {
|
|
45
|
+
* console.error('Errors occurred:', errors);
|
|
46
|
+
* }
|
|
47
|
+
* ```
|
|
48
|
+
*/
|
|
49
|
+
async emitAsync(eventName, event) {
|
|
50
|
+
const errors = [];
|
|
51
|
+
// Get all registered listeners for this event
|
|
52
|
+
const listeners = this.listeners(eventName);
|
|
53
|
+
// Execute each handler sequentially
|
|
54
|
+
for (const listener of listeners) {
|
|
55
|
+
try {
|
|
56
|
+
// Call the handler - await to support async handlers
|
|
57
|
+
await Promise.resolve().then(() => {
|
|
58
|
+
listener(event);
|
|
59
|
+
});
|
|
60
|
+
// Check if handler stopped propagation to remaining handlers
|
|
61
|
+
if (event.propagationStopped) {
|
|
62
|
+
break; // Exit the loop, skipping remaining handlers
|
|
63
|
+
}
|
|
64
|
+
}
|
|
65
|
+
catch (error) {
|
|
66
|
+
// Collect error but continue executing remaining handlers
|
|
67
|
+
errors.push(error instanceof Error ? error : new Error(String(error)));
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
// Execute default action if not prevented and event has one
|
|
71
|
+
try {
|
|
72
|
+
// Call defaultAction - await to support async
|
|
73
|
+
await event.runDefaultAction();
|
|
74
|
+
}
|
|
75
|
+
catch (error) {
|
|
76
|
+
// Collect error from default action
|
|
77
|
+
errors.push(error instanceof Error ? error : new Error(String(error)));
|
|
78
|
+
}
|
|
79
|
+
return { errors, defaultPrevented: event.defaultPrevented };
|
|
80
|
+
}
|
|
81
|
+
}
|
|
82
|
+
/**
|
|
83
|
+
* Singleton instance of the CancellableEventEmitter.
|
|
84
|
+
* Shared across the entire application.
|
|
85
|
+
*/
|
|
86
|
+
let instance = null;
|
|
87
|
+
/**
|
|
88
|
+
* Get the singleton event emitter instance.
|
|
89
|
+
*
|
|
90
|
+
* Creates the instance on first call, then returns the same instance on subsequent calls.
|
|
91
|
+
* This ensures all parts of the application share the same event bus.
|
|
92
|
+
*
|
|
93
|
+
* @returns The singleton CancellableEventEmitter instance
|
|
94
|
+
*
|
|
95
|
+
* @example
|
|
96
|
+
* ```typescript
|
|
97
|
+
* // In generator.ts
|
|
98
|
+
* const events = getEvents();
|
|
99
|
+
* events.on('beforeLoadSchema', handler);
|
|
100
|
+
*
|
|
101
|
+
* // In renderer.ts - same instance!
|
|
102
|
+
* const events = getEvents();
|
|
103
|
+
* await events.emitAsync('beforeLoadSchema', event);
|
|
104
|
+
* ```
|
|
105
|
+
*
|
|
106
|
+
* @category Events
|
|
107
|
+
*/
|
|
108
|
+
const getEvents = () => {
|
|
109
|
+
instance ??= new CancellableEventEmitter();
|
|
110
|
+
return instance;
|
|
111
|
+
};
|
|
112
|
+
exports.getEvents = getEvents;
|
|
113
|
+
/**
|
|
114
|
+
* Reset the event emitter singleton.
|
|
115
|
+
*
|
|
116
|
+
* Removes all event listeners and clears the instance.
|
|
117
|
+
* The next call to getEvents() will create a fresh instance.
|
|
118
|
+
*
|
|
119
|
+
* **Important:** This should only be used in tests to ensure test isolation.
|
|
120
|
+
*
|
|
121
|
+
* @example
|
|
122
|
+
* ```typescript
|
|
123
|
+
* // In test setup
|
|
124
|
+
* afterEach(() => {
|
|
125
|
+
* resetEvents();
|
|
126
|
+
* jest.restoreAllMocks();
|
|
127
|
+
* });
|
|
128
|
+
* ```
|
|
129
|
+
*
|
|
130
|
+
* @category Events
|
|
131
|
+
*/
|
|
132
|
+
const resetEvents = () => {
|
|
133
|
+
if (instance) {
|
|
134
|
+
instance.removeAllListeners();
|
|
135
|
+
}
|
|
136
|
+
instance = null;
|
|
137
|
+
};
|
|
138
|
+
exports.resetEvents = resetEvents;
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Registers MDX module event handlers with the event emitter.
|
|
3
|
+
*
|
|
4
|
+
* Automatically detects and registers any event callback functions defined in the mdxModule
|
|
5
|
+
* that match the event callback naming convention. Logs registered handlers at debug level.
|
|
6
|
+
*
|
|
7
|
+
* @param mdxModule - The MDX module that may contain event callback functions
|
|
8
|
+
*
|
|
9
|
+
* @example
|
|
10
|
+
* ```typescript
|
|
11
|
+
* const mdxModule = {
|
|
12
|
+
* beforeLoadSchemaHook: async (event) => { console.log('Loading schema...'); },
|
|
13
|
+
* afterRenderTypeEntitiesHook: async (event) => { console.log('Rendered:', event.name); }
|
|
14
|
+
* };
|
|
15
|
+
* registerMDXEventHandlers(mdxModule);
|
|
16
|
+
* ```
|
|
17
|
+
*/
|
|
18
|
+
export declare const registerMDXEventHandlers: (mdxModule: unknown) => void;
|
|
19
|
+
//# sourceMappingURL=event-handlers.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"event-handlers.d.ts","sourceRoot":"","sources":["../src/event-handlers.ts"],"names":[],"mappings":"AAcA;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,wBAAwB,8BA+BpC,CAAC"}
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.registerMDXEventHandlers = void 0;
|
|
4
|
+
/**
|
|
5
|
+
* MDX event handler registration functionality.
|
|
6
|
+
*
|
|
7
|
+
* This module provides utilities for registering MDX module event handlers
|
|
8
|
+
* with the event emitter system. It maps event names to callback names and
|
|
9
|
+
* automatically detects and registers matching callbacks from MDX modules.
|
|
10
|
+
*
|
|
11
|
+
* @packageDocumentation
|
|
12
|
+
*/
|
|
13
|
+
const logger_1 = require("@graphql-markdown/logger");
|
|
14
|
+
const event_emitter_1 = require("./event-emitter");
|
|
15
|
+
const event_map_1 = require("./event-map");
|
|
16
|
+
/**
|
|
17
|
+
* Registers MDX module event handlers with the event emitter.
|
|
18
|
+
*
|
|
19
|
+
* Automatically detects and registers any event callback functions defined in the mdxModule
|
|
20
|
+
* that match the event callback naming convention. Logs registered handlers at debug level.
|
|
21
|
+
*
|
|
22
|
+
* @param mdxModule - The MDX module that may contain event callback functions
|
|
23
|
+
*
|
|
24
|
+
* @example
|
|
25
|
+
* ```typescript
|
|
26
|
+
* const mdxModule = {
|
|
27
|
+
* beforeLoadSchemaHook: async (event) => { console.log('Loading schema...'); },
|
|
28
|
+
* afterRenderTypeEntitiesHook: async (event) => { console.log('Rendered:', event.name); }
|
|
29
|
+
* };
|
|
30
|
+
* registerMDXEventHandlers(mdxModule);
|
|
31
|
+
* ```
|
|
32
|
+
*/
|
|
33
|
+
const registerMDXEventHandlers = (mdxModule) => {
|
|
34
|
+
if (!mdxModule || typeof mdxModule !== "object") {
|
|
35
|
+
return;
|
|
36
|
+
}
|
|
37
|
+
(0, event_emitter_1.resetEvents)(); // reset event to avoid duplicate registrations
|
|
38
|
+
const events = (0, event_emitter_1.getEvents)();
|
|
39
|
+
const registeredHandlers = new Set();
|
|
40
|
+
// Iterate through event callback mappings
|
|
41
|
+
for (const [eventName, callbackName] of Object.entries(event_map_1.EVENT_CALLBACK_MAP)) {
|
|
42
|
+
// Check if mdxModule has this callback function
|
|
43
|
+
if (callbackName in mdxModule &&
|
|
44
|
+
typeof mdxModule[callbackName] === "function") {
|
|
45
|
+
const handler = mdxModule[callbackName];
|
|
46
|
+
events.on(eventName, handler);
|
|
47
|
+
registeredHandlers.add(callbackName);
|
|
48
|
+
}
|
|
49
|
+
}
|
|
50
|
+
if (registeredHandlers.size > 0) {
|
|
51
|
+
(0, logger_1.log)(`Registered MDX event handlers: ${[...registeredHandlers].join(", ")}`, logger_1.LogLevel.debug);
|
|
52
|
+
}
|
|
53
|
+
};
|
|
54
|
+
exports.registerMDXEventHandlers = registerMDXEventHandlers;
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Event callback mapping configuration.
|
|
3
|
+
* Maps event names to their corresponding callback names in mdxModule.
|
|
4
|
+
*/
|
|
5
|
+
export declare const EVENT_CALLBACK_MAP: {
|
|
6
|
+
readonly "schema:beforeLoad": "beforeLoadSchemaHook";
|
|
7
|
+
readonly "schema:afterLoad": "afterLoadSchemaHook";
|
|
8
|
+
readonly "diff:beforeCheck": "beforeCheckDiffHook";
|
|
9
|
+
readonly "diff:afterCheck": "afterCheckDiffHook";
|
|
10
|
+
readonly "render:beforeRenderRootTypes": "beforeRenderRootTypesHook";
|
|
11
|
+
readonly "render:afterRenderRootTypes": "afterRenderRootTypesHook";
|
|
12
|
+
readonly "render:beforeRenderHomepage": "beforeRenderHomepageHook";
|
|
13
|
+
readonly "render:afterRenderHomepage": "afterRenderHomepageHook";
|
|
14
|
+
readonly "render:beforeRenderTypeEntities": "beforeRenderTypeEntitiesHook";
|
|
15
|
+
readonly "render:afterRenderTypeEntities": "afterRenderTypeEntitiesHook";
|
|
16
|
+
readonly "render:beforeGenerateIndexMetafile": "beforeGenerateIndexMetafileHook";
|
|
17
|
+
readonly "render:afterGenerateIndexMetafile": "afterGenerateIndexMetafileHook";
|
|
18
|
+
};
|
|
19
|
+
//# sourceMappingURL=event-map.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"event-map.d.ts","sourceRoot":"","sources":["../src/event-map.ts"],"names":[],"mappings":"AAeA;;;GAGG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;CAerB,CAAC"}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.EVENT_CALLBACK_MAP = void 0;
|
|
4
|
+
/**
|
|
5
|
+
* Event callback mapping configuration.
|
|
6
|
+
*
|
|
7
|
+
* This module defines the mappings between event names and their corresponding
|
|
8
|
+
* callback names in MDX modules. Kept separate to avoid circular dependencies.
|
|
9
|
+
*
|
|
10
|
+
* @packageDocumentation
|
|
11
|
+
*/
|
|
12
|
+
const schema_events_1 = require("./events/schema-events");
|
|
13
|
+
const diff_events_1 = require("./events/diff-events");
|
|
14
|
+
const render_root_types_events_1 = require("./events/render-root-types-events");
|
|
15
|
+
const render_homepage_events_1 = require("./events/render-homepage-events");
|
|
16
|
+
const render_type_entities_events_1 = require("./events/render-type-entities-events");
|
|
17
|
+
const generate_index_metafile_events_1 = require("./events/generate-index-metafile-events");
|
|
18
|
+
/**
|
|
19
|
+
* Event callback mapping configuration.
|
|
20
|
+
* Maps event names to their corresponding callback names in mdxModule.
|
|
21
|
+
*/
|
|
22
|
+
exports.EVENT_CALLBACK_MAP = {
|
|
23
|
+
[schema_events_1.SchemaEvents.BEFORE_LOAD]: "beforeLoadSchemaHook",
|
|
24
|
+
[schema_events_1.SchemaEvents.AFTER_LOAD]: "afterLoadSchemaHook",
|
|
25
|
+
[diff_events_1.DiffEvents.BEFORE_CHECK]: "beforeCheckDiffHook",
|
|
26
|
+
[diff_events_1.DiffEvents.AFTER_CHECK]: "afterCheckDiffHook",
|
|
27
|
+
[render_root_types_events_1.RenderRootTypesEvents.BEFORE_RENDER]: "beforeRenderRootTypesHook",
|
|
28
|
+
[render_root_types_events_1.RenderRootTypesEvents.AFTER_RENDER]: "afterRenderRootTypesHook",
|
|
29
|
+
[render_homepage_events_1.RenderHomepageEvents.BEFORE_RENDER]: "beforeRenderHomepageHook",
|
|
30
|
+
[render_homepage_events_1.RenderHomepageEvents.AFTER_RENDER]: "afterRenderHomepageHook",
|
|
31
|
+
[render_type_entities_events_1.RenderTypeEntitiesEvents.BEFORE_RENDER]: "beforeRenderTypeEntitiesHook",
|
|
32
|
+
[render_type_entities_events_1.RenderTypeEntitiesEvents.AFTER_RENDER]: "afterRenderTypeEntitiesHook",
|
|
33
|
+
[generate_index_metafile_events_1.GenerateIndexMetafileEvents.BEFORE_GENERATE]: "beforeGenerateIndexMetafileHook",
|
|
34
|
+
[generate_index_metafile_events_1.GenerateIndexMetafileEvents.AFTER_GENERATE]: "afterGenerateIndexMetafileHook",
|
|
35
|
+
};
|
|
@@ -0,0 +1,313 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Event system types and base classes for GraphQL-Markdown events.
|
|
3
|
+
*
|
|
4
|
+
* @packageDocumentation
|
|
5
|
+
*/
|
|
6
|
+
/**
|
|
7
|
+
* Type for default action function that can be executed by events.
|
|
8
|
+
* Returns a Promise to support both sync and async actions.
|
|
9
|
+
*/
|
|
10
|
+
export type DefaultAction = () => Promise<void>;
|
|
11
|
+
/**
|
|
12
|
+
* Deep freezes an object to make it immutable at runtime.
|
|
13
|
+
* Recursively freezes all nested objects and arrays.
|
|
14
|
+
*
|
|
15
|
+
* @param obj - The object to freeze
|
|
16
|
+
* @returns The frozen object (same reference)
|
|
17
|
+
*
|
|
18
|
+
* @example
|
|
19
|
+
* ```typescript
|
|
20
|
+
* const data = { user: { name: 'John' } };
|
|
21
|
+
* deepFreeze(data);
|
|
22
|
+
* data.user.name = 'Jane'; // Throws error in strict mode
|
|
23
|
+
* ```
|
|
24
|
+
*/
|
|
25
|
+
export declare const deepFreeze: <T>(obj: T) => T;
|
|
26
|
+
/**
|
|
27
|
+
* Base class for all cancellable events in GraphQL-Markdown.
|
|
28
|
+
*
|
|
29
|
+
* Provides common functionality:
|
|
30
|
+
* - preventDefault() to cancel default actions
|
|
31
|
+
* - stopPropagation() to halt handler chain
|
|
32
|
+
* - Configurable cancellability
|
|
33
|
+
* - Optional default action function
|
|
34
|
+
*
|
|
35
|
+
* @category Events
|
|
36
|
+
*/
|
|
37
|
+
export declare abstract class CancellableEvent {
|
|
38
|
+
/**
|
|
39
|
+
* Whether the default action has been prevented.
|
|
40
|
+
* Set to true when preventDefault() is called.
|
|
41
|
+
*/
|
|
42
|
+
private _defaultPrevented;
|
|
43
|
+
/**
|
|
44
|
+
* Whether propagation to remaining handlers has been stopped.
|
|
45
|
+
* Set to true when stopPropagation() is called.
|
|
46
|
+
*/
|
|
47
|
+
private _propagationStopped;
|
|
48
|
+
/**
|
|
49
|
+
* Whether this event can be cancelled.
|
|
50
|
+
* If false, preventDefault() has no effect.
|
|
51
|
+
*/
|
|
52
|
+
private readonly _cancellable;
|
|
53
|
+
/**
|
|
54
|
+
* Optional function to execute as the default action.
|
|
55
|
+
* Only runs if preventDefault() was not called.
|
|
56
|
+
*/
|
|
57
|
+
private readonly _defaultAction?;
|
|
58
|
+
/**
|
|
59
|
+
* Creates a new CancellableEvent.
|
|
60
|
+
*
|
|
61
|
+
* @param cancellable - Whether this event can be cancelled (default: true)
|
|
62
|
+
* @param defaultAction - Optional function to execute as default action
|
|
63
|
+
*/
|
|
64
|
+
constructor(cancellable?: boolean, defaultAction?: DefaultAction);
|
|
65
|
+
/**
|
|
66
|
+
* Gets whether the default action has been prevented.
|
|
67
|
+
*/
|
|
68
|
+
get defaultPrevented(): boolean;
|
|
69
|
+
/**
|
|
70
|
+
* Gets whether propagation has been stopped.
|
|
71
|
+
*/
|
|
72
|
+
get propagationStopped(): boolean;
|
|
73
|
+
/**
|
|
74
|
+
* Gets the default action function if one was provided.
|
|
75
|
+
*/
|
|
76
|
+
get defaultAction(): DefaultAction | undefined;
|
|
77
|
+
/**
|
|
78
|
+
* Prevents the default action from executing.
|
|
79
|
+
* Only works if the event is cancellable.
|
|
80
|
+
*
|
|
81
|
+
* @example
|
|
82
|
+
* ```typescript
|
|
83
|
+
* events.on('beforeLoadSchema', (event) => {
|
|
84
|
+
* if (shouldUseCustomLoader) {
|
|
85
|
+
* event.preventDefault(); // Stops default schema loading
|
|
86
|
+
* // Custom logic here
|
|
87
|
+
* }
|
|
88
|
+
* });
|
|
89
|
+
* ```
|
|
90
|
+
*/
|
|
91
|
+
preventDefault(): void;
|
|
92
|
+
/**
|
|
93
|
+
* Stops propagation to remaining event handlers.
|
|
94
|
+
* Handlers registered after the current one will not execute.
|
|
95
|
+
*
|
|
96
|
+
* @example
|
|
97
|
+
* ```typescript
|
|
98
|
+
* events.on('beforeLoadSchema', (event) => {
|
|
99
|
+
* if (criticalError) {
|
|
100
|
+
* event.stopPropagation(); // No more handlers run
|
|
101
|
+
* }
|
|
102
|
+
* });
|
|
103
|
+
* ```
|
|
104
|
+
*/
|
|
105
|
+
stopPropagation(): void;
|
|
106
|
+
}
|
|
107
|
+
/**
|
|
108
|
+
* Event names for schema loading lifecycle.
|
|
109
|
+
*/
|
|
110
|
+
export declare const SchemaEvents: {
|
|
111
|
+
/** Emitted before loading GraphQL schema */
|
|
112
|
+
readonly BEFORE_LOAD: "beforeLoadSchema";
|
|
113
|
+
/** Emitted after loading GraphQL schema */
|
|
114
|
+
readonly AFTER_LOAD: "afterLoadSchema";
|
|
115
|
+
};
|
|
116
|
+
/**
|
|
117
|
+
* Event names for diff checking lifecycle.
|
|
118
|
+
*/
|
|
119
|
+
export declare const DiffEvents: {
|
|
120
|
+
/** Emitted before checking schema differences */
|
|
121
|
+
readonly BEFORE_CHECK: "beforeCheckDiff";
|
|
122
|
+
/** Emitted after checking schema differences */
|
|
123
|
+
readonly AFTER_CHECK: "afterCheckDiff";
|
|
124
|
+
};
|
|
125
|
+
/**
|
|
126
|
+
* Event names for category collection lifecycle.
|
|
127
|
+
*/
|
|
128
|
+
export declare const CategoryEvents: {
|
|
129
|
+
/** Emitted before pre-collecting categories */
|
|
130
|
+
readonly BEFORE_PRE_COLLECT: "beforePreCollectCategories";
|
|
131
|
+
/** Emitted after pre-collecting categories */
|
|
132
|
+
readonly AFTER_PRE_COLLECT: "afterPreCollectCategories";
|
|
133
|
+
};
|
|
134
|
+
/**
|
|
135
|
+
* Event names for rendering lifecycle.
|
|
136
|
+
*/
|
|
137
|
+
export declare const RenderEvents: {
|
|
138
|
+
/** Emitted before rendering root types */
|
|
139
|
+
readonly BEFORE_RENDER_ROOT_TYPES: "beforeRenderRootTypes";
|
|
140
|
+
/** Emitted after rendering root types */
|
|
141
|
+
readonly AFTER_RENDER_ROOT_TYPES: "afterRenderRootTypes";
|
|
142
|
+
/** Emitted before rendering homepage */
|
|
143
|
+
readonly BEFORE_RENDER_HOMEPAGE: "beforeRenderHomepage";
|
|
144
|
+
/** Emitted after rendering homepage */
|
|
145
|
+
readonly AFTER_RENDER_HOMEPAGE: "afterRenderHomepage";
|
|
146
|
+
/** Emitted before rendering type entities */
|
|
147
|
+
readonly BEFORE_RENDER_TYPE_ENTITIES: "beforeRenderTypeEntities";
|
|
148
|
+
/** Emitted after rendering type entities */
|
|
149
|
+
readonly AFTER_RENDER_TYPE_ENTITIES: "afterRenderTypeEntities";
|
|
150
|
+
/** Emitted before generating index metafile */
|
|
151
|
+
readonly BEFORE_GENERATE_INDEX_METAFILE: "beforeGenerateIndexMetafile";
|
|
152
|
+
/** Emitted after generating index metafile */
|
|
153
|
+
readonly AFTER_GENERATE_INDEX_METAFILE: "afterGenerateIndexMetafile";
|
|
154
|
+
};
|
|
155
|
+
/**
|
|
156
|
+
* All event names combined.
|
|
157
|
+
*/
|
|
158
|
+
export declare const EventNames: {
|
|
159
|
+
/** Emitted before loading GraphQL schema */
|
|
160
|
+
readonly BEFORE_LOAD: "beforeLoadSchema";
|
|
161
|
+
/** Emitted after loading GraphQL schema */
|
|
162
|
+
readonly AFTER_LOAD: "afterLoadSchema";
|
|
163
|
+
/** Emitted before checking schema differences */
|
|
164
|
+
readonly BEFORE_CHECK: "beforeCheckDiff";
|
|
165
|
+
/** Emitted after checking schema differences */
|
|
166
|
+
readonly AFTER_CHECK: "afterCheckDiff";
|
|
167
|
+
/** Emitted before pre-collecting categories */
|
|
168
|
+
readonly BEFORE_PRE_COLLECT: "beforePreCollectCategories";
|
|
169
|
+
/** Emitted after pre-collecting categories */
|
|
170
|
+
readonly AFTER_PRE_COLLECT: "afterPreCollectCategories";
|
|
171
|
+
/** Emitted before rendering root types */
|
|
172
|
+
readonly BEFORE_RENDER_ROOT_TYPES: "beforeRenderRootTypes";
|
|
173
|
+
/** Emitted after rendering root types */
|
|
174
|
+
readonly AFTER_RENDER_ROOT_TYPES: "afterRenderRootTypes";
|
|
175
|
+
/** Emitted before rendering homepage */
|
|
176
|
+
readonly BEFORE_RENDER_HOMEPAGE: "beforeRenderHomepage";
|
|
177
|
+
/** Emitted after rendering homepage */
|
|
178
|
+
readonly AFTER_RENDER_HOMEPAGE: "afterRenderHomepage";
|
|
179
|
+
/** Emitted before rendering type entities */
|
|
180
|
+
readonly BEFORE_RENDER_TYPE_ENTITIES: "beforeRenderTypeEntities";
|
|
181
|
+
/** Emitted after rendering type entities */
|
|
182
|
+
readonly AFTER_RENDER_TYPE_ENTITIES: "afterRenderTypeEntities";
|
|
183
|
+
/** Emitted before generating index metafile */
|
|
184
|
+
readonly BEFORE_GENERATE_INDEX_METAFILE: "beforeGenerateIndexMetafile";
|
|
185
|
+
/** Emitted after generating index metafile */
|
|
186
|
+
readonly AFTER_GENERATE_INDEX_METAFILE: "afterGenerateIndexMetafile";
|
|
187
|
+
};
|
|
188
|
+
/**
|
|
189
|
+
* Event emitted before/after loading a GraphQL schema.
|
|
190
|
+
*
|
|
191
|
+
* @category Events
|
|
192
|
+
*/
|
|
193
|
+
export declare class SchemaLoadEvent extends CancellableEvent {
|
|
194
|
+
/** Path or pointer to the schema location */
|
|
195
|
+
readonly schemaLocation: string;
|
|
196
|
+
constructor(data: {
|
|
197
|
+
schemaLocation: string;
|
|
198
|
+
defaultAction?: DefaultAction;
|
|
199
|
+
cancellable?: boolean;
|
|
200
|
+
});
|
|
201
|
+
}
|
|
202
|
+
/**
|
|
203
|
+
* Event emitted before/after checking schema differences.
|
|
204
|
+
*
|
|
205
|
+
* @category Events
|
|
206
|
+
*/
|
|
207
|
+
export declare class DiffCheckEvent extends CancellableEvent {
|
|
208
|
+
/** Current schema being checked */
|
|
209
|
+
readonly schema: unknown;
|
|
210
|
+
/** Path to output directory for diff results */
|
|
211
|
+
readonly outputDir: string;
|
|
212
|
+
constructor(data: {
|
|
213
|
+
schema: unknown;
|
|
214
|
+
outputDir: string;
|
|
215
|
+
defaultAction?: DefaultAction;
|
|
216
|
+
cancellable?: boolean;
|
|
217
|
+
});
|
|
218
|
+
}
|
|
219
|
+
|
|
220
|
+
/**
|
|
221
|
+
* Event emitted before/after rendering root types.
|
|
222
|
+
*
|
|
223
|
+
* @category Events
|
|
224
|
+
*/
|
|
225
|
+
export declare class RenderRootTypesEvent extends CancellableEvent {
|
|
226
|
+
/** Root types to render */
|
|
227
|
+
readonly rootTypes: unknown;
|
|
228
|
+
constructor(data: {
|
|
229
|
+
rootTypes: unknown;
|
|
230
|
+
defaultAction?: DefaultAction;
|
|
231
|
+
cancellable?: boolean;
|
|
232
|
+
});
|
|
233
|
+
}
|
|
234
|
+
/**
|
|
235
|
+
* Event emitted before/after rendering homepage.
|
|
236
|
+
*
|
|
237
|
+
* @category Events
|
|
238
|
+
*/
|
|
239
|
+
export declare class RenderHomepageEvent extends CancellableEvent {
|
|
240
|
+
/** Output directory for homepage */
|
|
241
|
+
readonly outputDir: string;
|
|
242
|
+
constructor(data: {
|
|
243
|
+
outputDir: string;
|
|
244
|
+
defaultAction?: DefaultAction;
|
|
245
|
+
cancellable?: boolean;
|
|
246
|
+
});
|
|
247
|
+
}
|
|
248
|
+
/**
|
|
249
|
+
* Event emitted before/after rendering type entities.
|
|
250
|
+
*
|
|
251
|
+
* @category Events
|
|
252
|
+
*/
|
|
253
|
+
export declare class RenderTypeEntitiesEvent extends CancellableEvent {
|
|
254
|
+
/** Name of the type entity */
|
|
255
|
+
readonly name: string;
|
|
256
|
+
/** File path where entity will be rendered */
|
|
257
|
+
readonly filePath: string;
|
|
258
|
+
constructor(data: {
|
|
259
|
+
name: string;
|
|
260
|
+
filePath: string;
|
|
261
|
+
defaultAction?: DefaultAction;
|
|
262
|
+
cancellable?: boolean;
|
|
263
|
+
});
|
|
264
|
+
}
|
|
265
|
+
/**
|
|
266
|
+
* Event emitted before/after generating index metafile.
|
|
267
|
+
*
|
|
268
|
+
* @category Events
|
|
269
|
+
*/
|
|
270
|
+
export declare class GenerateIndexMetafileEvent extends CancellableEvent {
|
|
271
|
+
/** Directory path for the index file */
|
|
272
|
+
readonly dirPath: string;
|
|
273
|
+
/** Category name */
|
|
274
|
+
readonly category: string;
|
|
275
|
+
/** Optional configuration options */
|
|
276
|
+
readonly options?: Record<string, unknown>;
|
|
277
|
+
constructor(data: {
|
|
278
|
+
dirPath: string;
|
|
279
|
+
category: string;
|
|
280
|
+
options?: Record<string, unknown>;
|
|
281
|
+
defaultAction?: DefaultAction;
|
|
282
|
+
cancellable?: boolean;
|
|
283
|
+
});
|
|
284
|
+
}
|
|
285
|
+
/**
|
|
286
|
+
* Hook callback for schema loading events.
|
|
287
|
+
*/
|
|
288
|
+
export type SchemaLoadHook = (event: SchemaLoadEvent) => Promise<void>;
|
|
289
|
+
/**
|
|
290
|
+
* Hook callback for diff check events.
|
|
291
|
+
*/
|
|
292
|
+
export type DiffCheckHook = (event: DiffCheckEvent) => Promise<void>;
|
|
293
|
+
/**
|
|
294
|
+
* Hook callback for pre-collect categories events.
|
|
295
|
+
*/
|
|
296
|
+
export type PreCollectCategoriesHook = (event: PreCollectCategoriesEvent) => Promise<void>;
|
|
297
|
+
/**
|
|
298
|
+
* Hook callback for render root types events.
|
|
299
|
+
*/
|
|
300
|
+
export type RenderRootTypesHook = (event: RenderRootTypesEvent) => Promise<void>;
|
|
301
|
+
/**
|
|
302
|
+
* Hook callback for render homepage events.
|
|
303
|
+
*/
|
|
304
|
+
export type RenderHomepageHook = (event: RenderHomepageEvent) => Promise<void>;
|
|
305
|
+
/**
|
|
306
|
+
* Hook callback for render type entities events.
|
|
307
|
+
*/
|
|
308
|
+
export type RenderTypeEntitiesHook = (event: RenderTypeEntitiesEvent) => Promise<void>;
|
|
309
|
+
/**
|
|
310
|
+
* Hook callback for generate index metafile events.
|
|
311
|
+
*/
|
|
312
|
+
export type GenerateIndexMetafileHook = (event: GenerateIndexMetafileEvent) => Promise<void>;
|
|
313
|
+
//# sourceMappingURL=event-types.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"event-types.d.ts","sourceRoot":"","sources":["../src/event-types.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,MAAM,OAAO,CAAC,IAAI,CAAC,CAAC;AAEhD;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,UAAU,GAAI,CAAC,cAe3B,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;CACF;AAMD;;GAEG;AACH,eAAO,MAAM,YAAY;IACvB,4CAA4C;;IAE5C,2CAA2C;;CAEnC,CAAC;AAEX;;GAEG;AACH,eAAO,MAAM,UAAU;IACrB,iDAAiD;;IAEjD,gDAAgD;;CAExC,CAAC;AAEX;;GAEG;AACH,eAAO,MAAM,cAAc;IACzB,+CAA+C;;IAE/C,8CAA8C;;CAEtC,CAAC;AAEX;;GAEG;AACH,eAAO,MAAM,YAAY;IACvB,0CAA0C;;IAE1C,yCAAyC;;IAEzC,wCAAwC;;IAExC,uCAAuC;;IAEvC,6CAA6C;;IAE7C,4CAA4C;;IAE5C,+CAA+C;;IAE/C,8CAA8C;;CAEtC,CAAC;AAEX;;GAEG;AACH,eAAO,MAAM,UAAU;IAnDrB,4CAA4C;;IAE5C,2CAA2C;;IAQ3C,iDAAiD;;IAEjD,gDAAgD;;IAQhD,+CAA+C;;IAE/C,8CAA8C;;IAQ9C,0CAA0C;;IAE1C,yCAAyC;;IAEzC,wCAAwC;;IAExC,uCAAuC;;IAEvC,6CAA6C;;IAE7C,4CAA4C;;IAE5C,+CAA+C;;IAE/C,8CAA8C;;CAYtC,CAAC;AAMX;;;;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;AAED;;;;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;AAED;;;;GAIG;AACH,qBAAa,yBAA0B,SAAQ,gBAAgB;IAC7D,iCAAiC;IACjC,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAC5B,iCAAiC;IACjC,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAEzB,YAAY,IAAI,EAAE;QAChB,SAAS,EAAE,OAAO,CAAC;QACnB,OAAO,EAAE,MAAM,CAAC;QAChB,aAAa,CAAC,EAAE,aAAa,CAAC;QAC9B,WAAW,CAAC,EAAE,OAAO,CAAC;KACvB,EAIA;CACF;AAED;;;;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;AAED;;;;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;AAED;;;;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;AAED;;;;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;AAMD;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,CAAC,KAAK,EAAE,eAAe,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAEvE;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,CAAC,KAAK,EAAE,cAAc,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAErE;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG,CACrC,KAAK,EAAE,yBAAyB,KAC7B,OAAO,CAAC,IAAI,CAAC,CAAC;AAEnB;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,CAChC,KAAK,EAAE,oBAAoB,KACxB,OAAO,CAAC,IAAI,CAAC,CAAC;AAEnB;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,KAAK,EAAE,mBAAmB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAC;AAE/E;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,CACnC,KAAK,EAAE,uBAAuB,KAC3B,OAAO,CAAC,IAAI,CAAC,CAAC;AAEnB;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG,CACtC,KAAK,EAAE,0BAA0B,KAC9B,OAAO,CAAC,IAAI,CAAC,CAAC"}
|