@graphql-markdown/core 1.16.2 → 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 +82 -94
  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 -15
@@ -1,4 +1,4 @@
1
- import type { ApiGroupOverrideType, Category, Maybe, MDXSupportType, Printer, RendererDocOptions, SchemaEntitiesGroupMap, SchemaEntity } from "@graphql-markdown/types";
1
+ import type { ApiGroupOverrideType, Category, Maybe, Printer, RendererDocOptions, SchemaEntitiesGroupMap, SchemaEntity } from "@graphql-markdown/types";
2
2
  /**
3
3
  * Default group names for API types and non-API types.
4
4
  * This constant provides the base folder structure for organizing GraphQL schema entities.
@@ -6,7 +6,6 @@ import type { ApiGroupOverrideType, Category, Maybe, MDXSupportType, Printer, Re
6
6
  *
7
7
  * @property operations Folder name for GraphQL operations (queries, mutations, subscriptions)
8
8
  * @property types Folder name for GraphQL type definitions
9
- * @useDeclaredType
10
9
  *
11
10
  * @example
12
11
  * ```typescript
@@ -27,7 +26,6 @@ export declare const API_GROUPS: Required<ApiGroupOverrideType>;
27
26
  * @param type - The GraphQL schema entity to categorize
28
27
  * @param groups - Optional custom group naming configuration
29
28
  * @returns The folder name where the entity should be placed
30
- * @useDeclaredType
31
29
  *
32
30
  * @example
33
31
  * ```typescript
@@ -38,7 +36,7 @@ export declare const API_GROUPS: Required<ApiGroupOverrideType>;
38
36
  * const folder = getApiGroupFolder(objectType, { operations: "queries" }); // Returns appropriate folder
39
37
  * ```
40
38
  */
41
- export declare const getApiGroupFolder: (type: unknown, groups?: Maybe<ApiGroupOverrideType | boolean>) => string;
39
+ export declare const getApiGroupFolder: (type: unknown, groups?: Maybe<boolean | ApiGroupOverrideType>) => string;
42
40
  /**
43
41
  * Configuration options for category metafiles in the documentation.
44
42
  * These options control the appearance and behavior of category sections in the sidebar.
@@ -48,7 +46,6 @@ export declare const getApiGroupFolder: (type: unknown, groups?: Maybe<ApiGroupO
48
46
  * @property [collapsed] - Whether the category should be initially collapsed
49
47
  * @property [sidebarPosition] - Custom position in the sidebar (lower numbers appear first)
50
48
  * @property [styleClass] - CSS class to apply to the category for styling
51
- * @useDeclaredType
52
49
  *
53
50
  * @example
54
51
  * ```typescript
@@ -69,7 +66,12 @@ export interface CategoryMetafileOptions {
69
66
  /**
70
67
  * Core renderer class responsible for generating documentation files from GraphQL schema entities.
71
68
  * Handles the conversion of schema types to markdown/MDX documentation with proper organization.
72
- * @useDeclaredType
69
+ *
70
+ * HIERARCHY LEVELS WHEN categorySort IS ENABLED:
71
+ * - Level 0 (root): Query, Mutation, Subscription, Custom Groups → 01-Query, 02-Mutation, etc.
72
+ * - Level 1 (under root): Specific types within each root → 01-Objects, 02-Enums, etc.
73
+ *
74
+ * Each level has its own CategoryPositionManager that restarts numbering at 1.
73
75
  * @example
74
76
  */
75
77
  export declare class Renderer {
@@ -79,8 +81,9 @@ export declare class Renderer {
79
81
  prettify: boolean;
80
82
  options: Maybe<RendererDocOptions>;
81
83
  mdxModule: unknown;
82
- mdxModuleIndexFileSupport: boolean;
83
84
  private readonly printer;
85
+ private readonly rootLevelPositionManager;
86
+ private readonly categoryPositionManager;
84
87
  /**
85
88
  * Creates a new Renderer instance.
86
89
  *
@@ -94,15 +97,6 @@ export declare class Renderer {
94
97
  * @example
95
98
  */
96
99
  constructor(printer: Printer, outputDir: string, baseURL: string, group: Maybe<SchemaEntitiesGroupMap>, prettify: boolean, docOptions: Maybe<RendererDocOptions>, mdxModule?: unknown);
97
- /**
98
- * Checks if the provided module supports MDX index file generation.
99
- *
100
- * @param module - The module to check for MDX support
101
- * @returns True if the module supports index metafile generation
102
- * @useDeclaredType
103
- * @example
104
- */
105
- hasMDXIndexFileSupport(module?: unknown): module is Partial<MDXSupportType> & Pick<MDXSupportType, "generateIndexMetafile">;
106
100
  /**
107
101
  * Generates an index metafile for a category directory if MDX support is available.
108
102
  *
@@ -110,7 +104,6 @@ export declare class Renderer {
110
104
  * @param category - The category name
111
105
  * @param options - Configuration options for the index
112
106
  * @returns Promise that resolves when the index is generated
113
- * @useDeclaredType
114
107
  *
115
108
  * @example
116
109
  * ```typescript
@@ -129,7 +122,6 @@ export declare class Renderer {
129
122
  * @param name - The name of the schema entity
130
123
  * @param rootTypeName - The root type name this entity belongs to
131
124
  * @returns The generated directory path
132
- * @useDeclaredType
133
125
  * @example
134
126
  */
135
127
  generateCategoryMetafileType(type: unknown, name: string, rootTypeName: SchemaEntity): Promise<string>;
@@ -139,7 +131,6 @@ export declare class Renderer {
139
131
  * @param rootTypeName - The name of the root type (e.g., "Query", "Mutation")
140
132
  * @param type - The type object containing all entities to render
141
133
  * @returns Array of rendered categories or undefined
142
- * @useDeclaredType
143
134
  * @example
144
135
  */
145
136
  renderRootTypes(rootTypeName: SchemaEntity, type: unknown): Promise<Maybe<Maybe<Category>[]>>;
@@ -150,20 +141,82 @@ export declare class Renderer {
150
141
  * @param name - The name of the type entity
151
142
  * @param type - The type entity to render
152
143
  * @returns The category information for the rendered entity or undefined
153
- * @useDeclaredType
154
144
  * @example
155
145
  */
156
146
  renderTypeEntities(dirPath: string, name: string, type: unknown): Promise<Maybe<Category>>;
147
+ /**
148
+ * Pre-collects all category names that will be generated during rendering.
149
+ * This allows the position manager to assign consistent positions before
150
+ * any files are written.
151
+ *
152
+ * HIERARCHY LEVELS:
153
+ * - Root level: Query, Mutation, Subscription, Deprecated (when grouped), custom root groups
154
+ * - Nested level: operations/types (API groups), custom groups under roots
155
+ *
156
+ * CRITICAL: Categories registered must match the NAMES USED BY THE PRINTER
157
+ * when generating links. The printer uses plural forms from ROOT_TYPE_LOCALE:
158
+ * "operations", "objects", "directives", "enums", "inputs", "interfaces",
159
+ * "mutations", "queries", "scalars", "subscriptions", "unions"
160
+ *
161
+ * NOT the folder names: "operations", "types"
162
+ *
163
+ * @param rootTypeNames - Array of root type names from the schema
164
+ */
165
+ preCollectCategories(rootTypeNames: string[]): void;
157
166
  /**
158
167
  * Renders the homepage for the documentation from a template file.
159
168
  * Replaces placeholders in the template with actual values.
160
169
  *
161
170
  * @param homepageLocation - Path to the homepage template file
162
171
  * @returns Promise that resolves when the homepage is rendered
163
- * @useDeclaredType
164
172
  * @example
165
173
  */
166
174
  renderHomepage(homepageLocation: Maybe<string>): Promise<void>;
175
+ /**
176
+ * Registers custom group names from the current group configuration.
177
+ * Custom groups are always registered at the ROOT level.
178
+ *
179
+ * @param rootCategories - Set to add custom group names to
180
+ */
181
+ private registerCustomGroups;
182
+ /**
183
+ * Registers API group categories (operations/types) based on hierarchy and group configuration.
184
+ *
185
+ * @param rootCategories - Set to add root-level categories
186
+ * @param nestedCategories - Set to add nested-level categories
187
+ * @param hasCustomGroups - Whether custom groups are configured
188
+ */
189
+ private registerApiGroupCategories;
190
+ /**
191
+ * Registers entity hierarchy categories based on configuration.
192
+ *
193
+ * @param rootCategories - Set to add root-level categories
194
+ * @param nestedCategories - Set to add nested-level categories
195
+ * @param rootTypeNames - Array of root type names from schema
196
+ * @param hasCustomGroups - Whether custom groups are configured
197
+ */
198
+ private registerEntityCategories;
199
+ /**
200
+ * Registers collected categories with appropriate position managers.
201
+ * Handles both hierarchical numbering (when categorySort is enabled) and traditional modes.
202
+ *
203
+ * @param rootCategories - Set of root-level categories
204
+ * @param nestedCategories - Set of nested-level categories
205
+ */
206
+ private registerCategoriesWithManagers;
207
+ /**
208
+ * Formats a category folder name, optionally prefixing with an order number.
209
+ *
210
+ * Supports hierarchical numbering:
211
+ * - Root level items (Query, Mutation, etc.) use rootLevelPositionManager
212
+ * - Nested items (groups, types within roots) use categoryPositionManager
213
+ *
214
+ * @param categoryName - The category name to format
215
+ * @param isRootLevel - Whether this category is at the root level (default: false for nested)
216
+ * @returns The formatted folder name (e.g., "01-objects" if prefix is enabled)
217
+ * @private
218
+ */
219
+ private formatCategoryFolderName;
167
220
  }
168
221
  /**
169
222
  * Factory function to create and initialize a Renderer instance.
@@ -177,7 +230,6 @@ export declare class Renderer {
177
230
  * @param docOptions - Additional documentation options
178
231
  * @param mdxModule - Optional MDX module for enhanced features
179
232
  * @returns A configured Renderer instance
180
- * @useDeclaredType
181
233
  *
182
234
  * @example
183
235
  * ```typescript
@@ -191,4 +243,5 @@ export declare class Renderer {
191
243
  * );
192
244
  * ```
193
245
  */
194
- export declare const getRenderer: (printer: Printer, outputDir: string, baseURL: string, group: Maybe<SchemaEntitiesGroupMap>, prettify: boolean, docOptions: Maybe<RendererDocOptions>, mdxModule?: unknown) => Promise<InstanceType<typeof Renderer>>;
246
+ export declare const getRenderer: (printer: typeof import("@graphql-markdown/types").IPrinter, outputDir: string, baseURL: string, group: Maybe<Partial<Record<SchemaEntity, Record<string, Maybe<string>>>>>, prettify: boolean, docOptions: Maybe<RendererDocOptions>, mdxModule?: unknown) => Promise<Renderer>;
247
+ //# sourceMappingURL=renderer.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"renderer.d.ts","sourceRoot":"","sources":["../src/renderer.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,oBAAoB,EACpB,QAAQ,EAER,KAAK,EAEL,OAAO,EACP,kBAAkB,EAClB,sBAAsB,EACtB,YAAY,EAGb,MAAM,yBAAyB,CAAC;AA2FjC;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,UAAU,EAAE,QAAQ,CAAC,oBAAoB,CAG5C,CAAC;AAEX;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,iBAAiB,2EAS7B,CAAC;AA6CF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,WAAW,uBAAuB;IACtC,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB,SAAS,CAAC,EAAE,OAAO,CAAC;IACpB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAoGD;;;;;;;;;;GAUG;AACH,qBAAa,QAAQ;IACnB,KAAK,EAAE,KAAK,CAAC,sBAAsB,CAAC,CAAC;IACrC,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,OAAO,CAAC;IAClB,OAAO,EAAE,KAAK,CAAC,kBAAkB,CAAC,CAAC;IACnC,SAAS,EAAE,OAAO,CAAC;IAGnB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAU;IAClC,OAAO,CAAC,QAAQ,CAAC,wBAAwB,CAA0B;IACnE,OAAO,CAAC,QAAQ,CAAC,uBAAuB,CAA0B;IAElE;;;;;;;;;;;OAWG;IACH,YACE,OAAO,EAAE,OAAO,EAChB,SAAS,EAAE,MAAM,EACjB,OAAO,EAAE,MAAM,EACf,KAAK,EAAE,KAAK,CAAC,sBAAsB,CAAC,EACpC,QAAQ,EAAE,OAAO,EACjB,UAAU,EAAE,KAAK,CAAC,kBAAkB,CAAC,EACrC,SAAS,CAAC,EAAE,OAAO,EAuBpB;IAED;;;;;;;;;;;;;;;OAeG;IACG,qBAAqB,CACzB,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE,MAAM,EAChB,OAAO,CAAC,EAAE,uBAAuB,GAChC,OAAO,CAAC,IAAI,CAAC,CAuCf;IAED;;;;;;;;;OASG;IACG,4BAA4B,CAChC,IAAI,EAAE,OAAO,EACb,IAAI,EAAE,MAAM,EACZ,YAAY,EAAE,YAAY,GACzB,OAAO,CAAC,MAAM,CAAC,CAsEjB;IAED;;;;;;;OAOG;IACG,eAAe,CACnB,YAAY,EAAE,YAAY,EAC1B,IAAI,EAAE,OAAO,GACZ,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAyBnC;IAED;;;;;;;;OAQG;IACG,kBAAkB,CACtB,OAAO,EAAE,MAAM,EACf,IAAI,EAAE,MAAM,EACZ,IAAI,EAAE,OAAO,GACZ,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAkG1B;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,oBAAoB,CAAC,aAAa,EAAE,MAAM,EAAE,GAAG,IAAI,CAwClD;IAED;;;;;;;OAOG;IACG,cAAc,CAAC,gBAAgB,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAkCnE;IAED;;;;;OAKG;IACH,OAAO,CAAC,oBAAoB;IAe5B;;;;;;OAMG;IACH,OAAO,CAAC,0BAA0B;IAiClC;;;;;;;OAOG;IACH,OAAO,CAAC,wBAAwB;IAiBhC;;;;;;OAMG;IACH,OAAO,CAAC,8BAA8B;IAiCtC;;;;;;;;;;;OAWG;IACH,OAAO,CAAC,wBAAwB;CA+BjC;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,WAAW,kRAmBvB,CAAC"}