@graphql-markdown/core 1.17.0 → 1.17.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/event-handlers.d.ts +6 -3
- package/dist/event-handlers.d.ts.map +1 -1
- package/dist/event-handlers.js +10 -7
- package/dist/event-map.d.ts +3 -0
- package/dist/event-map.d.ts.map +1 -1
- package/dist/event-map.js +3 -0
- package/dist/events/base.d.ts +8 -3
- package/dist/events/base.d.ts.map +1 -1
- package/dist/events/base.js +6 -5
- package/dist/events/diff-check.d.ts +11 -11
- package/dist/events/diff-check.d.ts.map +1 -1
- package/dist/events/diff-check.js +5 -8
- package/dist/events/generate-index-metafile.d.ts +8 -11
- package/dist/events/generate-index-metafile.d.ts.map +1 -1
- package/dist/events/generate-index-metafile.js +5 -11
- package/dist/events/index.d.ts +1 -1
- package/dist/events/index.d.ts.map +1 -1
- package/dist/events/index.js +2 -2
- package/dist/events/print-type-events.d.ts +33 -0
- package/dist/events/print-type-events.d.ts.map +1 -0
- package/dist/events/print-type-events.js +35 -0
- package/dist/events/print-type.d.ts +84 -0
- package/dist/events/print-type.d.ts.map +1 -0
- package/dist/events/print-type.js +73 -0
- package/dist/events/render-homepage.d.ts +6 -7
- package/dist/events/render-homepage.d.ts.map +1 -1
- package/dist/events/render-homepage.js +5 -5
- package/dist/events/render-root-types.d.ts +6 -7
- package/dist/events/render-root-types.d.ts.map +1 -1
- package/dist/events/render-root-types.js +5 -5
- package/dist/events/render-type-entities.d.ts +7 -9
- package/dist/events/render-type-entities.d.ts.map +1 -1
- package/dist/events/render-type-entities.js +5 -8
- package/dist/events/schema-events.d.ts +4 -0
- package/dist/events/schema-events.d.ts.map +1 -1
- package/dist/events/schema-events.js +4 -0
- package/dist/events/schema-load.d.ts +13 -9
- package/dist/events/schema-load.d.ts.map +1 -1
- package/dist/events/schema-load.js +8 -8
- package/dist/generator.d.ts +79 -1
- package/dist/generator.d.ts.map +1 -1
- package/dist/generator.js +217 -49
- package/dist/index.d.ts +7 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +14 -1
- package/dist/printer.d.ts +3 -3
- package/dist/printer.d.ts.map +1 -1
- package/dist/printer.js +3 -3
- package/dist/renderer.d.ts +10 -10
- package/dist/renderer.d.ts.map +1 -1
- package/dist/renderer.js +11 -21
- package/package.json +9 -9
- package/dist/event-types.d.ts +0 -313
- package/dist/event-types.d.ts.map +0 -1
- package/dist/event-types.js +0 -309
- package/dist/hooks.d.ts +0 -10
- package/dist/hooks.d.ts.map +0 -1
- package/dist/hooks.js +0 -33
package/dist/event-types.js
DELETED
|
@@ -1,309 +0,0 @@
|
|
|
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;
|
package/dist/hooks.d.ts
DELETED
|
@@ -1,10 +0,0 @@
|
|
|
1
|
-
export type Callback = (...args: unknown[]) => unknown;
|
|
2
|
-
export interface Subscription {
|
|
3
|
-
unsubscribe: () => void;
|
|
4
|
-
}
|
|
5
|
-
export declare abstract class Hookable {
|
|
6
|
-
map: Map<string, Callback[]>;
|
|
7
|
-
subscribe(hookName: string, callback: Callback): Subscription;
|
|
8
|
-
protected emit(hookName: string, args?: unknown[]): unknown[];
|
|
9
|
-
}
|
|
10
|
-
//# sourceMappingURL=hooks.d.ts.map
|
package/dist/hooks.d.ts.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"hooks.d.ts","sourceRoot":"","sources":["../src/hooks.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,QAAQ,GAAG,CAAC,GAAG,IAAI,EAAE,OAAO,EAAE,KAAK,OAAO,CAAC;AACvD,MAAM,WAAW,YAAY;IAC3B,WAAW,EAAE,MAAM,IAAI,CAAC;CACzB;AAED,8BAAsB,QAAQ;IAC5B,GAAG,0BAAiC;IAEpC,SAAS,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,GAAG,YAAY,CAiB5D;IAED,SAAS,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,GAAE,OAAO,EAAO,GAAG,OAAO,EAAE,CAQhE;CACF"}
|
package/dist/hooks.js
DELETED
|
@@ -1,33 +0,0 @@
|
|
|
1
|
-
"use strict";
|
|
2
|
-
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
-
exports.Hookable = void 0;
|
|
4
|
-
class Hookable {
|
|
5
|
-
map = new Map();
|
|
6
|
-
subscribe(hookName, callback) {
|
|
7
|
-
if (!this.map.has(hookName))
|
|
8
|
-
this.map.set(hookName, []);
|
|
9
|
-
const arr = this.map.get(hookName) ?? [];
|
|
10
|
-
arr.push(callback);
|
|
11
|
-
return {
|
|
12
|
-
unsubscribe: () => {
|
|
13
|
-
const index = arr.indexOf(callback);
|
|
14
|
-
if (index === -1) {
|
|
15
|
-
return;
|
|
16
|
-
}
|
|
17
|
-
arr.splice(index, 1);
|
|
18
|
-
if (arr.length === 0) {
|
|
19
|
-
this.map.delete(hookName);
|
|
20
|
-
}
|
|
21
|
-
},
|
|
22
|
-
};
|
|
23
|
-
}
|
|
24
|
-
emit(hookName, args = []) {
|
|
25
|
-
const handlers = this.map.get(hookName);
|
|
26
|
-
if (handlers)
|
|
27
|
-
return handlers.map((handler) => {
|
|
28
|
-
return handler(...args);
|
|
29
|
-
});
|
|
30
|
-
return [];
|
|
31
|
-
}
|
|
32
|
-
}
|
|
33
|
-
exports.Hookable = Hookable;
|