@graphql-markdown/printer-legacy 1.13.1 → 1.15.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 (55) hide show
  1. package/dist/const/options.d.ts +15 -2
  2. package/dist/const/options.d.ts.map +1 -1
  3. package/dist/const/options.js +20 -6
  4. package/dist/const/strings.d.ts +15 -0
  5. package/dist/const/strings.d.ts.map +1 -1
  6. package/dist/const/strings.js +9 -0
  7. package/dist/directive.d.ts +3 -3
  8. package/dist/directive.d.ts.map +1 -1
  9. package/dist/directive.js +8 -4
  10. package/dist/events.d.ts +77 -0
  11. package/dist/events.d.ts.map +1 -0
  12. package/dist/events.js +85 -0
  13. package/dist/example.d.ts.map +1 -1
  14. package/dist/example.js +12 -7
  15. package/dist/format-helpers.d.ts +9 -0
  16. package/dist/format-helpers.d.ts.map +1 -1
  17. package/dist/format-helpers.js +10 -1
  18. package/dist/formatter.js +1 -1
  19. package/dist/graphql/directive.d.ts +3 -3
  20. package/dist/graphql/directive.d.ts.map +1 -1
  21. package/dist/graphql/directive.js +3 -3
  22. package/dist/graphql/enum.d.ts +3 -3
  23. package/dist/graphql/enum.d.ts.map +1 -1
  24. package/dist/graphql/enum.js +2 -2
  25. package/dist/graphql/input.d.ts +13 -0
  26. package/dist/graphql/input.d.ts.map +1 -1
  27. package/dist/graphql/input.js +8 -0
  28. package/dist/graphql/object.d.ts +3 -3
  29. package/dist/graphql/object.d.ts.map +1 -1
  30. package/dist/graphql/object.js +4 -4
  31. package/dist/graphql/operation.d.ts +6 -7
  32. package/dist/graphql/operation.d.ts.map +1 -1
  33. package/dist/graphql/operation.js +41 -8
  34. package/dist/graphql/scalar.d.ts +5 -5
  35. package/dist/graphql/scalar.d.ts.map +1 -1
  36. package/dist/graphql/scalar.js +7 -7
  37. package/dist/graphql/union.d.ts +3 -3
  38. package/dist/graphql/union.d.ts.map +1 -1
  39. package/dist/graphql/union.js +2 -2
  40. package/dist/group.d.ts.map +1 -1
  41. package/dist/group.js +7 -6
  42. package/dist/index.d.ts +2 -0
  43. package/dist/index.d.ts.map +1 -1
  44. package/dist/index.js +5 -1
  45. package/dist/link.d.ts +2 -2
  46. package/dist/link.d.ts.map +1 -1
  47. package/dist/link.js +54 -13
  48. package/dist/mdx/index.js +2 -2
  49. package/dist/printer.d.ts +67 -22
  50. package/dist/printer.d.ts.map +1 -1
  51. package/dist/printer.js +270 -117
  52. package/dist/section.d.ts +3 -3
  53. package/dist/section.d.ts.map +1 -1
  54. package/dist/section.js +34 -13
  55. package/package.json +19 -10
package/dist/printer.d.ts CHANGED
@@ -7,7 +7,10 @@
7
7
  * @module printer
8
8
  * @packageDocumentation
9
9
  */
10
- import type { CustomDirectiveMap, Formatter, GraphQLDirective, GraphQLSchema, IPrinter, MDXString, Maybe, MetaInfo, PrinterEventEmitter, PrintTypeOptions, PrinterConfigPrintTypeOptions, SchemaEntitiesGroupMap, TypeDeprecatedOption } from "@graphql-markdown/types";
10
+ import type { CustomDirectiveMap, DeprecatedPrintTypeOptions, Formatter, GraphQLDirective, GraphQLSchema, IPrinter, Maybe, MDXString, MetaInfo, PageSection, PrinterConfigPrintTypeOptions, PrinterEventEmitter, PrintTypeOptions, SchemaEntitiesGroupMap, TypeDeprecatedOption } from "@graphql-markdown/types";
11
+ type InitPrintTypeOptions = DeprecatedPrintTypeOptions & Omit<PrinterConfigPrintTypeOptions, "exampleSection"> & {
12
+ exampleSection?: DeprecatedPrintTypeOptions["exampleSection"] | PrinterConfigPrintTypeOptions["exampleSection"];
13
+ };
11
14
  /**
12
15
  * The Printer class implements the core functionality for generating Markdown documentation
13
16
  * from GraphQL schema types.
@@ -27,16 +30,6 @@ import type { CustomDirectiveMap, Formatter, GraphQLDirective, GraphQLSchema, IP
27
30
  * ```
28
31
  */
29
32
  export declare class Printer implements IPrinter {
30
- /**
31
- * Global printer configuration options
32
- */
33
- static options: Readonly<Maybe<PrintTypeOptions>>;
34
- /**
35
- * Optional event emitter for print events.
36
- * When set, the printer will emit events before/after printCode and printType,
37
- * allowing external code to intercept and modify the output.
38
- */
39
- static eventEmitter: Maybe<PrinterEventEmitter>;
40
33
  /**
41
34
  * Prints type descriptions
42
35
  */
@@ -44,15 +37,38 @@ export declare class Printer implements IPrinter {
44
37
  /**
45
38
  * Prints custom directives
46
39
  */
47
- static readonly printCustomDirectives: (type: unknown, options: PrintTypeOptions) => string;
40
+ static readonly printCustomDirectives: (type: unknown, options: PrintTypeOptions) => Maybe<PageSection>;
48
41
  /**
49
42
  * Prints custom tags
50
43
  */
51
44
  static readonly printCustomTags: (type: unknown, options: PrintTypeOptions) => string | MDXString;
45
+ private static _eventEmitter;
46
+ private static _options;
47
+ private static _deprecatedOptions;
48
+ private static _mdxDeclaration;
49
+ /**
50
+ * Global printer configuration options
51
+ */
52
+ static get options(): Readonly<Maybe<PrintTypeOptions>>;
53
+ /**
54
+ * Backward-compat section toggles extracted from legacy config options.
55
+ *
56
+ * These flags are applied only during section order composition.
57
+ */
58
+ static get deprecatedOptions(): Readonly<Maybe<DeprecatedPrintTypeOptions>>;
59
+ /**
60
+ * Optional event emitter for print events.
61
+ * When set, the printer will emit events before/after printCode and printType,
62
+ * allowing external code to intercept and modify the output.
63
+ */
64
+ static get eventEmitter(): Maybe<PrinterEventEmitter>;
52
65
  /**
53
66
  * Prints mdx modules import declaration
54
67
  */
55
- static mdxDeclaration: Readonly<Maybe<string>>;
68
+ static get mdxDeclaration(): Readonly<Maybe<string>>;
69
+ static set options(options: Readonly<Maybe<PrintTypeOptions>>);
70
+ static set eventEmitter(eventEmitter: Maybe<PrinterEventEmitter>);
71
+ static set mdxDeclaration(mdxDeclaration: Readonly<Maybe<string>>);
56
72
  /**
57
73
  * Initializes the printer with the given schema and configuration.
58
74
  *
@@ -64,15 +80,16 @@ export declare class Printer implements IPrinter {
64
80
  * @param mdxDeclaration - Optional MDX import declaration
65
81
  * @param eventEmitter - Optional event emitter for print events interception
66
82
  */
67
- static init(schema: Maybe<GraphQLSchema>, baseURL?: Maybe<string>, linkRoot?: Maybe<string>, { customDirectives, groups, meta, metatags, onlyDocDirectives, printTypeOptions, skipDocDirectives }?: {
83
+ static init(schema: Maybe<GraphQLSchema>, baseURL?: Maybe<string>, linkRoot?: Maybe<string>, { customDirectives, groups, meta, metatags, onlyDocDirectives, printTypeOptions, skipDocDirectives, sectionHeaderId }?: {
68
84
  customDirectives?: CustomDirectiveMap;
69
85
  deprecated?: TypeDeprecatedOption;
70
86
  groups?: SchemaEntitiesGroupMap;
71
87
  meta?: Maybe<MetaInfo>;
72
88
  metatags?: Record<string, string>[];
73
89
  onlyDocDirectives?: GraphQLDirective[];
74
- printTypeOptions?: PrinterConfigPrintTypeOptions;
90
+ printTypeOptions?: InitPrintTypeOptions;
75
91
  skipDocDirectives?: GraphQLDirective[];
92
+ sectionHeaderId?: boolean;
76
93
  }, formatter?: Partial<Formatter>, mdxDeclaration?: Maybe<string>, eventEmitter?: Maybe<PrinterEventEmitter>): Promise<void>;
77
94
  /**
78
95
  * Prints the header section of a type documentation
@@ -115,18 +132,17 @@ export declare class Printer implements IPrinter {
115
132
  *
116
133
  * @param type - GraphQL type to generate example for
117
134
  * @param options - Printer configuration options
118
- * @returns Formatted example section string or empty string if no example
135
+ * @returns Example page section or undefined when no example is available
119
136
  */
120
- static readonly printExample: (type: unknown, options: PrintTypeOptions) => string;
137
+ static readonly printExample: (type: unknown, options: PrintTypeOptions) => Maybe<PageSection>;
121
138
  /**
122
139
  * Prints metadata information for a GraphQL type
123
140
  *
124
141
  * @param type - GraphQL type to print metadata for
125
142
  * @param options - Printer configuration options
126
- * @returns Formatted metadata string as MDX or plain string
127
- * @throws When type is not supported
143
+ * @returns Metadata section (or section list) for supported types, otherwise undefined
128
144
  */
129
- static readonly printTypeMetadata: (type: unknown, options: PrintTypeOptions) => string | MDXString;
145
+ static readonly printTypeMetadata: (type: unknown, options: PrintTypeOptions) => Maybe<PageSection[] | PageSection>;
130
146
  /**
131
147
  * Prints related type information
132
148
  *
@@ -154,8 +170,7 @@ export declare class Printer implements IPrinter {
154
170
  * @example
155
171
  * ```typescript
156
172
  * const doc = await Printer.printType('User', UserType, {
157
- * frontMatter: true,
158
- * codeSection: true
173
+ * frontMatter: true
159
174
  * });
160
175
  * ```
161
176
  *
@@ -172,8 +187,38 @@ export declare class Printer implements IPrinter {
172
187
  *
173
188
  * When an event emitter is configured, emits events:
174
189
  * - `print:beforePrintType` - Before generating documentation
190
+ * - `print:beforeComposePageType` - Before composing section order and final page output
175
191
  * - `print:afterPrintType` - After generating documentation (output can be modified)
176
192
  */
177
193
  static readonly printType: (name: Maybe<string>, type: unknown, options?: Maybe<Partial<PrintTypeOptions>>) => Promise<Maybe<MDXString>>;
194
+ /**
195
+ * Renders a page section, optionally prefixing a heading when a title is present.
196
+ */
197
+ private static readonly renderPageSection;
198
+ /**
199
+ * Returns the default content section order for type pages.
200
+ *
201
+ * Applies backward-compatibility toggles from deprecated section flags.
202
+ */
203
+ private static readonly getDeprecatedTypePageSectionOrder;
204
+ /**
205
+ * Runtime guard for built-in page content section keys.
206
+ */
207
+ private static readonly isTypePageContentSection;
208
+ /**
209
+ * Runtime guard for header-only page section keys.
210
+ */
211
+ private static readonly isTypePageHeaderSection;
212
+ /**
213
+ * Normalizes event-driven section order, allowing built-in section keys and
214
+ * any custom keys that were added to the sections map by an event handler.
215
+ * Keys that are neither built-in nor present in the sections map are dropped.
216
+ */
217
+ private static readonly sanitizeTypePageSectionOrder;
218
+ /**
219
+ * Normalizes mixed section value shapes to the internal PageSection format.
220
+ */
221
+ private static readonly normalizePageSection;
178
222
  }
223
+ export {};
179
224
  //# sourceMappingURL=printer.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"printer.d.ts","sourceRoot":"","sources":["../src/printer.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EACV,kBAAkB,EAClB,SAAS,EACT,gBAAgB,EAEhB,aAAa,EACb,QAAQ,EACR,SAAS,EACT,KAAK,EACL,QAAQ,EACR,mBAAmB,EACnB,gBAAgB,EAChB,6BAA6B,EAC7B,sBAAsB,EACtB,oBAAoB,EACrB,MAAM,yBAAyB,CAAC;AA0EjC;;;;;;;;;;;;;;;;;GAiBG;AACH,qBAAa,OAAQ,YAAW,QAAQ;IACtC;;OAEG;IACH,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAElD;;;;OAIG;IACH,MAAM,CAAC,YAAY,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;IAEhD;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,gBAAgB,gGAAoB;IAEpD;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,qBAAqB,uDAAyB;IAE9D;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,eAAe,mEAAmB;IAElD;;OAEG;IACH,MAAM,CAAC,cAAc,EAAE,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;IAE/C;;;;;;;;;;OAUG;IACH,OAAa,IAAI,CACf,MAAM,EAAE,KAAK,CAAC,aAAa,CAAC,EAC5B,OAAO,GAAE,KAAK,CAAC,MAAM,CAAY,EACjC,QAAQ,GAAE,KAAK,CAAC,MAAM,CAAO,EAC7B,EACE,gBAAgB,EAChB,MAAM,EACN,IAAI,EACJ,QAAQ,EACR,iBAAiB,EACjB,gBAAgB,EAChB,iBAAiB,EAClB,GAAE;QACD,gBAAgB,CAAC,EAAE,kBAAkB,CAAC;QACtC,UAAU,CAAC,EAAE,oBAAoB,CAAC;QAClC,MAAM,CAAC,EAAE,sBAAsB,CAAC;QAChC,IAAI,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;QACvB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC;QACpC,iBAAiB,CAAC,EAAE,gBAAgB,EAAE,CAAC;QACvC,gBAAgB,CAAC,EAAE,6BAA6B,CAAC;QACjD,iBAAiB,CAAC,EAAE,gBAAgB,EAAE,CAAC;KACjB,EACxB,SAAS,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC,EAC9B,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,EAC9B,YAAY,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,GACxC,OAAO,CAAC,IAAI,CAAC,CAyCf;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,QAAQ,CAAC,WAAW,mEAYzB;IAEF;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,CAAC,SAAS,uDAwCvB;IAEF;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,QAAQ,CAAC,cAAc,kFA8C5B;IAEF;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,CAAC,YAAY,uDAmB1B;IAEF;;;;;;;OAOG;IACH,MAAM,CAAC,QAAQ,CAAC,iBAAiB,mEA2B/B;IAEF;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,CAAC,cAAc,mEAQ5B;IAEF;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,CAAC,aAAa,yEAiB3B;IAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,MAAM,CAAC,QAAQ,CAAC,SAAS,gHA4GvB;CACH"}
1
+ {"version":3,"file":"printer.d.ts","sourceRoot":"","sources":["../src/printer.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,KAAK,EACV,kBAAkB,EAClB,0BAA0B,EAC1B,SAAS,EACT,gBAAgB,EAEhB,aAAa,EACb,QAAQ,EACR,KAAK,EACL,SAAS,EACT,QAAQ,EAER,WAAW,EAEX,6BAA6B,EAC7B,mBAAmB,EACnB,gBAAgB,EAChB,sBAAsB,EACtB,oBAAoB,EACrB,MAAM,yBAAyB,CAAC;AAsGjC,KAAK,oBAAoB,GAAG,0BAA0B,GACpD,IAAI,CAAC,6BAA6B,EAAE,gBAAgB,CAAC,GAAG;IACtD,cAAc,CAAC,EACX,0BAA0B,CAAC,gBAAgB,CAAC,GAC5C,6BAA6B,CAAC,gBAAgB,CAAC,CAAC;CACrD,CAAC;AAEJ;;;;;;;;;;;;;;;;;GAiBG;AACH,qBAAa,OAAQ,YAAW,QAAQ;IACtC;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,gBAAgB,gGAAoB;IAEpD;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,qBAAqB,mEAAyB;IAE9D;;OAEG;IACH,MAAM,CAAC,QAAQ,CAAC,eAAe,mEAAmB;IAElD,OAAO,CAAC,MAAM,CAAC,aAAa,CAA6B;IAEzD,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAoC;IAE3D,OAAO,CAAC,MAAM,CAAC,kBAAkB,CAE/B;IAEF,OAAO,CAAC,MAAM,CAAC,eAAe,CAA0B;IAExD;;OAEG;IACH,MAAM,KAAK,OAAO,IAAI,QAAQ,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,CAEtD;IAED;;;;OAIG;IACH,MAAM,KAAK,iBAAiB,IAAI,QAAQ,CAAC,KAAK,CAAC,0BAA0B,CAAC,CAAC,CAE1E;IAED;;;;OAIG;IACH,MAAM,KAAK,YAAY,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAEpD;IAED;;OAEG;IACH,MAAM,KAAK,cAAc,IAAI,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAEnD;IAED,MAAM,KAAK,OAAO,CAAC,OAAO,EAAE,QAAQ,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC,EAE5D;IAED,MAAM,KAAK,YAAY,CAAC,YAAY,EAAE,KAAK,CAAC,mBAAmB,CAAC,EAE/D;IAED,MAAM,KAAK,cAAc,CAAC,cAAc,EAAE,QAAQ,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,EAEhE;IAED;;;;;;;;;;OAUG;IACH,OAAa,IAAI,CACf,MAAM,EAAE,KAAK,CAAC,aAAa,CAAC,EAC5B,OAAO,GAAE,KAAK,CAAC,MAAM,CAAY,EACjC,QAAQ,GAAE,KAAK,CAAC,MAAM,CAAO,EAC7B,EACE,gBAAgB,EAChB,MAAM,EACN,IAAI,EACJ,QAAQ,EACR,iBAAiB,EACjB,gBAAgB,EAChB,iBAAiB,EACjB,eAAe,EAChB,GAAE;QACD,gBAAgB,CAAC,EAAE,kBAAkB,CAAC;QACtC,UAAU,CAAC,EAAE,oBAAoB,CAAC;QAClC,MAAM,CAAC,EAAE,sBAAsB,CAAC;QAChC,IAAI,CAAC,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;QACvB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC;QACpC,iBAAiB,CAAC,EAAE,gBAAgB,EAAE,CAAC;QACvC,gBAAgB,CAAC,EAAE,oBAAoB,CAAC;QACxC,iBAAiB,CAAC,EAAE,gBAAgB,EAAE,CAAC;QACvC,eAAe,CAAC,EAAE,OAAO,CAAC;KACJ,EACxB,SAAS,CAAC,EAAE,OAAO,CAAC,SAAS,CAAC,EAC9B,cAAc,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,EAC9B,YAAY,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,GACxC,OAAO,CAAC,IAAI,CAAC,CA0Df;IAED;;;;;;;OAOG;IACH,MAAM,CAAC,QAAQ,CAAC,WAAW,mEAYzB;IAEF;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,CAAC,SAAS,uDAoCvB;IAEF;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,QAAQ,CAAC,cAAc,kFAoC5B;IAEF;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,CAAC,YAAY,mEAc1B;IAEF;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,CAAC,iBAAiB,mFA2B/B;IAEF;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,CAAC,cAAc,mEAK5B;IAEF;;;;;;OAMG;IACH,MAAM,CAAC,QAAQ,CAAC,aAAa,yEAiB3B;IAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,MAAM,CAAC,QAAQ,CAAC,SAAS,gHA+HvB;IAEF;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,iBAAiB,CAsDvC;IAEF;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,iCAAiC,CAmBvD;IAEF;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,wBAAwB,CAO9C;IAEF;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,uBAAuB,CAO7C;IAEF;;;;OAIG;IACH,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,4BAA4B,CAgBlD;IAEF;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,oBAAoB,CAY1C;CACH"}