@qualcomm-ui/mdx-vite 2.17.1 → 3.0.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 (167) hide show
  1. package/dist/cli.js +1687 -3343
  2. package/dist/cli.js.map +4 -4
  3. package/dist/docs-plugin/{internal → config}/config-loader.d.ts +1 -9
  4. package/dist/docs-plugin/config/config-loader.d.ts.map +1 -0
  5. package/dist/docs-plugin/config/config-schema.d.ts +50 -0
  6. package/dist/docs-plugin/config/config-schema.d.ts.map +1 -0
  7. package/dist/docs-plugin/config/index.d.ts +4 -0
  8. package/dist/docs-plugin/config/index.d.ts.map +1 -0
  9. package/dist/docs-plugin/config/types.d.ts +266 -0
  10. package/dist/docs-plugin/config/types.d.ts.map +1 -0
  11. package/dist/docs-plugin/config/zod.d.ts.map +1 -0
  12. package/dist/docs-plugin/{internal/services/doc-props → doc-props}/doc-props-indexer.d.ts +1 -1
  13. package/dist/docs-plugin/doc-props/doc-props-indexer.d.ts.map +1 -0
  14. package/dist/docs-plugin/doc-props/index.d.ts.map +1 -0
  15. package/dist/docs-plugin/docs-plugin.d.ts.map +1 -1
  16. package/dist/docs-plugin/generate-page-map.d.ts.map +1 -1
  17. package/dist/docs-plugin/index.d.ts +2 -1
  18. package/dist/docs-plugin/index.d.ts.map +1 -1
  19. package/dist/docs-plugin/markdown/create-slug.d.ts +16 -0
  20. package/dist/docs-plugin/markdown/create-slug.d.ts.map +1 -0
  21. package/dist/docs-plugin/markdown/frontmatter-schema.d.ts +7 -0
  22. package/dist/docs-plugin/markdown/frontmatter-schema.d.ts.map +1 -0
  23. package/dist/docs-plugin/markdown/index.d.ts +6 -0
  24. package/dist/docs-plugin/markdown/index.d.ts.map +1 -0
  25. package/dist/docs-plugin/markdown/knowledge/filter-frontmatter.d.ts +3 -0
  26. package/dist/docs-plugin/markdown/knowledge/filter-frontmatter.d.ts.map +1 -0
  27. package/dist/docs-plugin/markdown/knowledge/index.d.ts +2 -0
  28. package/dist/docs-plugin/markdown/knowledge/index.d.ts.map +1 -0
  29. package/dist/docs-plugin/markdown/knowledge/knowledge-exporter.d.ts +36 -0
  30. package/dist/docs-plugin/markdown/knowledge/knowledge-exporter.d.ts.map +1 -0
  31. package/dist/{ai-knowledge/generator → docs-plugin/markdown/knowledge/plugins}/demo-plugin.d.ts +1 -1
  32. package/dist/docs-plugin/markdown/knowledge/plugins/demo-plugin.d.ts.map +1 -0
  33. package/dist/{ai-knowledge/generator → docs-plugin/markdown/knowledge/plugins}/doc-props-plugin.d.ts +11 -1
  34. package/dist/docs-plugin/markdown/knowledge/plugins/doc-props-plugin.d.ts.map +1 -0
  35. package/dist/docs-plugin/markdown/knowledge/plugins/filter-text-directives.d.ts.map +1 -0
  36. package/dist/docs-plugin/markdown/knowledge/plugins/index.d.ts +6 -0
  37. package/dist/docs-plugin/markdown/knowledge/plugins/index.d.ts.map +1 -0
  38. package/dist/docs-plugin/markdown/knowledge/plugins/npm-install-tabs-plugin.d.ts.map +1 -0
  39. package/dist/docs-plugin/markdown/knowledge/plugins/qds-theme-plugin.d.ts.map +1 -0
  40. package/dist/{ai-knowledge/generator → docs-plugin/markdown/knowledge}/section-extractor.d.ts +17 -4
  41. package/dist/docs-plugin/markdown/knowledge/section-extractor.d.ts.map +1 -0
  42. package/dist/{ai-knowledge/generator/generator.types.d.ts → docs-plugin/markdown/knowledge/types.d.ts} +2 -10
  43. package/dist/docs-plugin/markdown/knowledge/types.d.ts.map +1 -0
  44. package/dist/{ai-knowledge/generator → docs-plugin/markdown/knowledge}/utils.d.ts +2 -2
  45. package/dist/docs-plugin/markdown/knowledge/utils.d.ts.map +1 -0
  46. package/dist/docs-plugin/{internal/services/markdown → markdown}/markdown-file-reader.d.ts +13 -7
  47. package/dist/docs-plugin/markdown/markdown-file-reader.d.ts.map +1 -0
  48. package/dist/docs-plugin/{internal/services/markdown → markdown}/markdown.types.d.ts +5 -3
  49. package/dist/docs-plugin/markdown/markdown.types.d.ts.map +1 -0
  50. package/dist/docs-plugin/markdown/mdx-utils.d.ts.map +1 -0
  51. package/dist/docs-plugin/markdown/remark-pipeline.d.ts +36 -0
  52. package/dist/docs-plugin/markdown/remark-pipeline.d.ts.map +1 -0
  53. package/dist/docs-plugin/mdx-plugins.d.ts +1 -9
  54. package/dist/docs-plugin/mdx-plugins.d.ts.map +1 -1
  55. package/dist/docs-plugin/{internal/services/nav-builder → nav-builder}/get-route-meta.d.ts +1 -1
  56. package/dist/docs-plugin/nav-builder/get-route-meta.d.ts.map +1 -0
  57. package/dist/docs-plugin/nav-builder/index.d.ts +6 -0
  58. package/dist/docs-plugin/nav-builder/index.d.ts.map +1 -0
  59. package/dist/docs-plugin/{internal/services/nav-builder → nav-builder}/nav-builder.d.ts +1 -1
  60. package/dist/docs-plugin/nav-builder/nav-builder.d.ts.map +1 -0
  61. package/dist/docs-plugin/{internal/services/nav-builder → nav-builder}/page-map.d.ts +2 -1
  62. package/dist/docs-plugin/nav-builder/page-map.d.ts.map +1 -0
  63. package/dist/docs-plugin/nav-builder/transform-route-meta-array.d.ts +3 -0
  64. package/dist/docs-plugin/nav-builder/transform-route-meta-array.d.ts.map +1 -0
  65. package/dist/docs-plugin/nav-builder/types.d.ts +86 -0
  66. package/dist/docs-plugin/nav-builder/types.d.ts.map +1 -0
  67. package/dist/docs-plugin/path-utils.d.ts +9 -0
  68. package/dist/docs-plugin/path-utils.d.ts.map +1 -0
  69. package/dist/docs-plugin/plugin-state.d.ts +57 -0
  70. package/dist/docs-plugin/plugin-state.d.ts.map +1 -0
  71. package/dist/docs-plugin/rehype/rehype-slug.d.ts.map +1 -1
  72. package/dist/docs-plugin/remark/index.d.ts +3 -0
  73. package/dist/docs-plugin/remark/index.d.ts.map +1 -1
  74. package/dist/docs-plugin/remark/remark-remove-code-blocks.d.ts.map +1 -0
  75. package/dist/docs-plugin/remark/remark-remove-jsx.d.ts.map +1 -0
  76. package/dist/docs-plugin/remark/remark-steps.d.ts.map +1 -1
  77. package/dist/docs-plugin/{internal/search-indexer.d.ts → search-indexer.d.ts} +13 -9
  78. package/dist/docs-plugin/search-indexer.d.ts.map +1 -0
  79. package/dist/docs-plugin/virtual.d.ts +39 -0
  80. package/dist/index.js +2543 -6213
  81. package/dist/index.js.map +4 -4
  82. package/dist/open-web-ui/api.d.ts.map +1 -0
  83. package/dist/{ai-knowledge/open-web-ui → open-web-ui}/common.d.ts +4 -12
  84. package/dist/open-web-ui/common.d.ts.map +1 -0
  85. package/dist/open-web-ui/download-knowledge.d.ts.map +1 -0
  86. package/dist/open-web-ui/env.d.ts +11 -0
  87. package/dist/open-web-ui/env.d.ts.map +1 -0
  88. package/dist/{ai-knowledge/open-web-ui → open-web-ui}/knowledge-cleaner.d.ts +5 -1
  89. package/dist/open-web-ui/knowledge-cleaner.d.ts.map +1 -0
  90. package/dist/open-web-ui/upload-knowledge.d.ts.map +1 -0
  91. package/dist/react-demo-plugin/index.d.ts +0 -1
  92. package/dist/react-demo-plugin/index.d.ts.map +1 -1
  93. package/dist/tsbuildinfo +1 -1
  94. package/package.json +2 -3
  95. package/dist/ai-knowledge/env.d.ts +0 -27
  96. package/dist/ai-knowledge/env.d.ts.map +0 -1
  97. package/dist/ai-knowledge/generator/command.d.ts +0 -9
  98. package/dist/ai-knowledge/generator/command.d.ts.map +0 -1
  99. package/dist/ai-knowledge/generator/config.d.ts +0 -4
  100. package/dist/ai-knowledge/generator/config.d.ts.map +0 -1
  101. package/dist/ai-knowledge/generator/demo-plugin.d.ts.map +0 -1
  102. package/dist/ai-knowledge/generator/doc-props-plugin.d.ts.map +0 -1
  103. package/dist/ai-knowledge/generator/filter-text-directives.d.ts.map +0 -1
  104. package/dist/ai-knowledge/generator/generator.types.d.ts.map +0 -1
  105. package/dist/ai-knowledge/generator/index.d.ts +0 -2
  106. package/dist/ai-knowledge/generator/index.d.ts.map +0 -1
  107. package/dist/ai-knowledge/generator/knowledge-generator.d.ts +0 -35
  108. package/dist/ai-knowledge/generator/knowledge-generator.d.ts.map +0 -1
  109. package/dist/ai-knowledge/generator/npm-install-tabs-plugin.d.ts.map +0 -1
  110. package/dist/ai-knowledge/generator/qds-theme-plugin.d.ts.map +0 -1
  111. package/dist/ai-knowledge/generator/section-extractor.d.ts.map +0 -1
  112. package/dist/ai-knowledge/generator/section.types.d.ts +0 -96
  113. package/dist/ai-knowledge/generator/section.types.d.ts.map +0 -1
  114. package/dist/ai-knowledge/generator/utils.d.ts.map +0 -1
  115. package/dist/ai-knowledge/open-web-ui/api.d.ts.map +0 -1
  116. package/dist/ai-knowledge/open-web-ui/common.d.ts.map +0 -1
  117. package/dist/ai-knowledge/open-web-ui/download-knowledge.d.ts.map +0 -1
  118. package/dist/ai-knowledge/open-web-ui/knowledge-cleaner.d.ts.map +0 -1
  119. package/dist/ai-knowledge/open-web-ui/upload-knowledge.d.ts.map +0 -1
  120. package/dist/ai-knowledge/types.d.ts +0 -57
  121. package/dist/ai-knowledge/types.d.ts.map +0 -1
  122. package/dist/docs-plugin/internal/config-loader.d.ts.map +0 -1
  123. package/dist/docs-plugin/internal/config-schema.d.ts +0 -124
  124. package/dist/docs-plugin/internal/config-schema.d.ts.map +0 -1
  125. package/dist/docs-plugin/internal/index.d.ts +0 -8
  126. package/dist/docs-plugin/internal/index.d.ts.map +0 -1
  127. package/dist/docs-plugin/internal/search-indexer.d.ts.map +0 -1
  128. package/dist/docs-plugin/internal/services/doc-props/doc-props-indexer.d.ts.map +0 -1
  129. package/dist/docs-plugin/internal/services/doc-props/index.d.ts.map +0 -1
  130. package/dist/docs-plugin/internal/services/index.d.ts +0 -4
  131. package/dist/docs-plugin/internal/services/index.d.ts.map +0 -1
  132. package/dist/docs-plugin/internal/services/markdown/index.d.ts +0 -6
  133. package/dist/docs-plugin/internal/services/markdown/index.d.ts.map +0 -1
  134. package/dist/docs-plugin/internal/services/markdown/markdown-file-reader.d.ts.map +0 -1
  135. package/dist/docs-plugin/internal/services/markdown/markdown-indexer.d.ts +0 -27
  136. package/dist/docs-plugin/internal/services/markdown/markdown-indexer.d.ts.map +0 -1
  137. package/dist/docs-plugin/internal/services/markdown/markdown.types.d.ts.map +0 -1
  138. package/dist/docs-plugin/internal/services/markdown/remark-remove-code-blocks.d.ts.map +0 -1
  139. package/dist/docs-plugin/internal/services/markdown/remark-remove-jsx.d.ts.map +0 -1
  140. package/dist/docs-plugin/internal/services/mdx-utils.d.ts.map +0 -1
  141. package/dist/docs-plugin/internal/services/nav-builder/get-route-meta.d.ts.map +0 -1
  142. package/dist/docs-plugin/internal/services/nav-builder/index.d.ts +0 -4
  143. package/dist/docs-plugin/internal/services/nav-builder/index.d.ts.map +0 -1
  144. package/dist/docs-plugin/internal/services/nav-builder/nav-builder.d.ts.map +0 -1
  145. package/dist/docs-plugin/internal/services/nav-builder/page-map.d.ts.map +0 -1
  146. package/dist/docs-plugin/internal/transform-route-meta-array.d.ts +0 -3
  147. package/dist/docs-plugin/internal/transform-route-meta-array.d.ts.map +0 -1
  148. package/dist/docs-plugin/internal/utils.d.ts +0 -17
  149. package/dist/docs-plugin/internal/utils.d.ts.map +0 -1
  150. package/dist/docs-plugin/internal/zod.d.ts.map +0 -1
  151. package/dist/docs-plugin/shiki/internal/tests/shiki-transformer-tailwind.spec.d.ts +0 -2
  152. package/dist/docs-plugin/shiki/internal/tests/shiki-transformer-tailwind.spec.d.ts.map +0 -1
  153. package/dist/docs-plugin/types.d.ts +0 -428
  154. package/dist/docs-plugin/types.d.ts.map +0 -1
  155. package/dist/react-demo-plugin/generate-lazy-demo-map.d.ts +0 -21
  156. package/dist/react-demo-plugin/generate-lazy-demo-map.d.ts.map +0 -1
  157. /package/dist/docs-plugin/{internal → config}/zod.d.ts +0 -0
  158. /package/dist/docs-plugin/{internal/services/doc-props → doc-props}/index.d.ts +0 -0
  159. /package/dist/{ai-knowledge/generator → docs-plugin/markdown/knowledge/plugins}/filter-text-directives.d.ts +0 -0
  160. /package/dist/{ai-knowledge/generator → docs-plugin/markdown/knowledge/plugins}/npm-install-tabs-plugin.d.ts +0 -0
  161. /package/dist/{ai-knowledge/generator → docs-plugin/markdown/knowledge/plugins}/qds-theme-plugin.d.ts +0 -0
  162. /package/dist/docs-plugin/{internal/services → markdown}/mdx-utils.d.ts +0 -0
  163. /package/dist/docs-plugin/{internal/services/markdown → remark}/remark-remove-code-blocks.d.ts +0 -0
  164. /package/dist/docs-plugin/{internal/services/markdown → remark}/remark-remove-jsx.d.ts +0 -0
  165. /package/dist/{ai-knowledge/open-web-ui → open-web-ui}/api.d.ts +0 -0
  166. /package/dist/{ai-knowledge/open-web-ui → open-web-ui}/download-knowledge.d.ts +0 -0
  167. /package/dist/{ai-knowledge/open-web-ui → open-web-ui}/upload-knowledge.d.ts +0 -0
@@ -1 +0,0 @@
1
- {"version":3,"file":"page-map.d.ts","sourceRoot":"","sources":["../../../../../src/docs-plugin/internal/services/nav-builder/page-map.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAC,iBAAiB,EAAE,eAAe,EAAC,MAAM,gBAAgB,CAAA;AAItE,wBAAgB,2BAA2B,CAAC,QAAQ,EAAE,MAAM,EAAE,UAE7D;AAED,wBAAgB,6BAA6B,CAC3C,QAAQ,EAAE,MAAM,EAAE,EAClB,QAAQ,EAAE,iBAAiB,EAE3B,gBAAgB,EAAE,MAAM,GACvB,MAAM,EAAE,CAeV;AAGD,wBAAgB,qBAAqB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAU7D;AA+JD,wBAAgB,2BAA2B,CACzC,QAAQ,EAAE,MAAM,EAChB,aAAa,EAAE,MAAM,EACrB,QAAQ,CAAC,EAAE,eAAe,GACzB,MAAM,EAAE,CAaV;AAED,wBAAgB,cAAc,CAC5B,QAAQ,EAAE,MAAM,EAAE,EAClB,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,MAAM,EACd,MAAM,CAAC,EAAE,eAAe,GACvB,MAAM,EAAE,CA2BV"}
@@ -1,3 +0,0 @@
1
- import type { NavConfig, NavMeta, RouteMetaInternal } from "../types";
2
- export declare function transformRouteMetaArray(meta: NavConfig[], routeMetaNav: Record<string, NavMeta>): RouteMetaInternal;
3
- //# sourceMappingURL=transform-route-meta-array.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"transform-route-meta-array.d.ts","sourceRoot":"","sources":["../../../src/docs-plugin/internal/transform-route-meta-array.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAC,SAAS,EAAE,OAAO,EAAa,iBAAiB,EAAC,MAAM,UAAU,CAAA;AAE9E,wBAAgB,uBAAuB,CACrC,IAAI,EAAE,SAAS,EAAE,EACjB,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GACpC,iBAAiB,CAsCnB"}
@@ -1,17 +0,0 @@
1
- import { type ZodObject } from "zod";
2
- export declare const isDefined: (value: string | boolean | object | null | undefined | number) => boolean;
3
- export declare function defined<T>(value: T | null | undefined): value is T;
4
- /**
5
- * Used to validate the MDX frontmatter and emit warnings for pages that violate the
6
- * schema.
7
- */
8
- export declare const frontmatterSchema: ZodObject<{}>;
9
- /**
10
- * Winblows fix
11
- */
12
- export declare function fixPath(str: string): string;
13
- /**
14
- * Removes the trailing slash from a string.
15
- */
16
- export declare function removeTrailingSlash(str: string): string;
17
- //# sourceMappingURL=utils.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/docs-plugin/internal/utils.ts"],"names":[],"mappings":"AAGA,OAAO,EAAI,KAAK,SAAS,EAAC,MAAM,KAAK,CAAA;AAMrC,eAAO,MAAM,SAAS,GACpB,OAAO,MAAM,GAAG,OAAO,GAAG,MAAM,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,KAC3D,OAAyD,CAAA;AAE5D,wBAAgB,OAAO,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI,GAAG,SAAS,GAAG,KAAK,IAAI,CAAC,CAElE;AAED;;;GAGG;AACH,eAAO,MAAM,iBAAiB,EAAE,SAAS,CAAC,EAAE,CAiBxC,CAAA;AAEJ;;GAEG;AACH,wBAAgB,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAE3C;AAED;;GAEG;AACH,wBAAgB,mBAAmB,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAEvD"}
@@ -1 +0,0 @@
1
- {"version":3,"file":"zod.d.ts","sourceRoot":"","sources":["../../../src/docs-plugin/internal/zod.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,CAAC,EAAC,MAAM,KAAK,CAAA;AAErB,KAAK,UAAU,CAAC,KAAK,IAAI;KACtB,GAAG,IAAI,MAAM,KAAK,CAAC,CAAC,GAAG,SAAS,SAAS,KAAK,CAAC,GAAG,CAAC,GAChD,IAAI,SAAS,KAAK,CAAC,GAAG,CAAC,GACrB,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GACnD,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,GACtC,IAAI,SAAS,KAAK,CAAC,GAAG,CAAC,GACrB,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,GACpC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;CAClE,CAAA;AAED,wBAAgB,SAAS,CAAC,KAAK,GAAG,KAAK;WAGjC,MAAM,SAAS,UAAU,CAAC,KAAK,CAAC,GAAG,GAChC,UAAU,IAAI,OAAO,CAAC,MAAM,MAAM,EAAE,MAAM,KAAK,CAAC,GAAG,KAAK,GAC1D,UAEO,MAAM;EAGnB"}
@@ -1,2 +0,0 @@
1
- export {};
2
- //# sourceMappingURL=shiki-transformer-tailwind.spec.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"shiki-transformer-tailwind.spec.d.ts","sourceRoot":"","sources":["../../../../../src/docs-plugin/shiki/internal/tests/shiki-transformer-tailwind.spec.ts"],"names":[],"mappings":""}
@@ -1,428 +0,0 @@
1
- import type { PageFrontmatter, TocHeading } from "@qualcomm-ui/mdx-common";
2
- import type { QuiPropTypes } from "@qualcomm-ui/typedoc-common";
3
- export type RoutingStrategy = "vite-generouted" | ((filePath: string) => string[]);
4
- export interface KnowledgeFrontmatterConfig {
5
- /**
6
- * Glob patterns for frontmatter fields to exclude (applied after include).
7
- */
8
- exclude?: string[];
9
- /**
10
- * Extra key-value pairs to add to the output frontmatter.
11
- * Applied after include/exclude filtering.
12
- */
13
- extraFields?: Record<string, string | string[]>;
14
- /**
15
- * Glob patterns for frontmatter fields to include in output.
16
- * Use ["*"] to include all fields.
17
- */
18
- include?: string[];
19
- }
20
- /**
21
- * Controls how page timestamp metadata is populated from git history.
22
- * - "off": No timestamp data is added
23
- * - "timestamp": Only `updatedOn` is populated
24
- * - "user-and-timestamp": Both `updatedOn` and `updatedBy` are populated
25
- */
26
- export type PageTimestampMetadataMode = "off" | "timestamp" | "user-and-timestamp";
27
- /**
28
- * Side nav item data.
29
- */
30
- export interface NavMeta {
31
- id?: never;
32
- /**
33
- * A label that describes a group of nav items.
34
- */
35
- sectionTitle?: string;
36
- /**
37
- * Render a horizontal separator.
38
- */
39
- separator?: boolean;
40
- }
41
- export interface RouteMetaEntryInternal extends Pick<PageFrontmatter, "group" | "hideToc" | "hideSideNav" | "hideFromSearch" | "hideBreadcrumbs" | "hidePageLinks" | "hidden" | "sideNavTitle"> {
42
- /**
43
- * Nested routes.
44
- */
45
- children?: RouteMetaInternal;
46
- /**
47
- * If `true`, the side nav item will be expanded on initial load. Does nothing if
48
- * the entry is a leaf node.
49
- */
50
- expanded?: boolean;
51
- /**
52
- * Order for the groups within this item's hierarchy.
53
- */
54
- groupOrder?: string[];
55
- /**
56
- * If specified, the route will be sorted amongst adjacent routes in this order.
57
- * Adjacent routes are routes at the same depth that share a parent.
58
- */
59
- order?: number;
60
- /**
61
- * If `true`, the route will be flagged as restricted. This flag does nothing
62
- * internally. You will need to handle this in your application.
63
- */
64
- restricted?: boolean;
65
- /**
66
- * This property is only available for top-level items.
67
- */
68
- sectionTitle?: never;
69
- /**
70
- * This property is only available for top-level items.
71
- */
72
- separator?: never;
73
- /**
74
- * The title of the item in the side nav. Will be parsed from the page's
75
- * frontmatter if it is not defined in the RouteMeta.
76
- */
77
- title?: string;
78
- }
79
- export interface RouteMetaNavInternal {
80
- /**
81
- * A label that renders above the item's content.
82
- */
83
- sectionTitle?: string;
84
- /**
85
- * Whether to render this item as a separator. If this property is supplied, a
86
- * horizontal separator will be drawn and all content will be ignored.
87
- */
88
- separator?: boolean;
89
- }
90
- export type RouteMetaInternal = Record<string, RouteMetaEntryInternal>;
91
- export type NavConfig = RouteMeta | NavMeta;
92
- export interface RouteMeta extends Omit<RouteMetaEntryInternal, "children" | "order"> {
93
- /**
94
- * Nested routes.
95
- *
96
- * @inheritDoc
97
- */
98
- children?: RouteMeta[];
99
- /**
100
- * The path segment for this route.
101
- */
102
- id: string;
103
- /**
104
- * By default, pages with a RouteMeta are ordered before pages that are not
105
- * defined. Set this property to `true` to disable that behavior.
106
- *
107
- * @default false
108
- */
109
- ignoreRouteMetaOrder?: boolean;
110
- }
111
- export interface QuiDocsTypeDocOptions {
112
- /**
113
- * Whether to include each page's TypeDocProps property documentation in the
114
- * search index. If this is true, the property documentation for each occurrence
115
- * of `<TypeDocProps />` will be built into the search index.
116
- */
117
- includeInSearchIndex?: boolean | undefined;
118
- }
119
- export interface KnowledgeIntegrationConfig {
120
- /**
121
- * Base URL for documentation links in the generated output.
122
- */
123
- baseUrl?: string;
124
- /**
125
- * Description for the knowledge output.
126
- */
127
- description?: string;
128
- /**
129
- * Glob patterns to exclude, relative to the resolved page directory. Supports
130
- * full glob syntax via minimatch.
131
- *
132
- * @example
133
- * ```ts
134
- * exclude: ['**\/internal/**', 'guide/drafts/*', '*.draft.mdx']
135
- * ```
136
- */
137
- exclude?: string[];
138
- /**
139
- * Configuration for per-page Markdown exports served from the public directory.
140
- *
141
- * @inheritDoc
142
- */
143
- exports?: KnowledgeExportsConfig;
144
- /**
145
- * Extra files to include in knowledge output beyond the generated page content.
146
- */
147
- extraFiles?: KnowledgeExtraFile[];
148
- /**
149
- * Configuration for which frontmatter fields to include in the generated
150
- * Markdown output. Uses glob patterns for flexible field selection.
151
- */
152
- frontmatter?: KnowledgeFrontmatterConfig;
153
- /**
154
- * Metadata key-value pairs to include in per-page output.
155
- */
156
- metadata?: Record<string, string>;
157
- /**
158
- * Name for the knowledge output.
159
- */
160
- name?: string;
161
- /**
162
- * Output mode for knowledge generation.
163
- */
164
- outputMode?: "per-page" | "aggregated";
165
- /**
166
- * Output path for generated knowledge files.
167
- */
168
- outputPath?: string;
169
- /**
170
- * Prefix to prepend to each page ID.
171
- */
172
- pageIdPrefix?: string;
173
- /**
174
- * Prefix to prepend to each page title.
175
- */
176
- pageTitlePrefix?: string;
177
- }
178
- /**
179
- * Extra content to include in knowledge output. Assumed to be Markdown.
180
- */
181
- export interface KnowledgeExtraFile {
182
- /**
183
- * The Markdown content for this file.
184
- */
185
- contents: string;
186
- /**
187
- * Unique identifier for this file, used for the output filename.
188
- */
189
- id: string;
190
- /**
191
- * Whether to process this file as MDX content, replacing relative URLs, and
192
- * applying other transformations as if the file were authored as mdx
193
- * documentation.
194
- */
195
- processAsMdx?: boolean;
196
- /**
197
- * Display title for this content.
198
- */
199
- title?: string;
200
- }
201
- /**
202
- * Configuration for per-page Markdown exports. Inherits from parent
203
- * KnowledgeIntegrationConfig unless overridden.
204
- */
205
- export interface KnowledgeExportsConfig {
206
- /**
207
- * Enable per-page markdown exports. When true, generates downloadable
208
- * markdown files during build and exposes export metadata in siteData.
209
- *
210
- * @default false
211
- */
212
- enabled?: boolean;
213
- /**
214
- * Glob patterns to exclude from exports. Overrides the parent exclude config.
215
- */
216
- exclude?: string[];
217
- /**
218
- * Extra files to include in exports. Overrides the parent extraFiles config.
219
- */
220
- extraFiles?: KnowledgeExtraFile[];
221
- /**
222
- * Configuration for which frontmatter fields to include in the generated
223
- * Markdown output. Overrides the parent frontmatter config.
224
- */
225
- frontmatter?: KnowledgeFrontmatterConfig;
226
- /**
227
- * Generate bulk.zip containing all markdown files.
228
- *
229
- * @default true
230
- */
231
- generateBulkZip?: boolean;
232
- /**
233
- * Generate manifest.json with file metadata and MD5 hashes.
234
- *
235
- * @default true
236
- */
237
- generateManifest?: boolean;
238
- /**
239
- * Output directory for manifest.json and bulk.zip, relative to public dir.
240
- *
241
- * @default 'exports'
242
- */
243
- manifestPath?: string;
244
- /**
245
- * Metadata key-value pairs for exports. Overrides the parent metadata config.
246
- */
247
- metadata?: Record<string, string>;
248
- /**
249
- * Prefix to prepend to each page title. Overrides the parent pageTitlePrefix.
250
- */
251
- pageTitlePrefix?: string;
252
- /**
253
- * Configuration for JSON section exports. Sections are automatically
254
- * generated when exports are enabled.
255
- */
256
- sections?: SectionExportConfig;
257
- /**
258
- * Output directory for exported markdown files, relative to public dir.
259
- *
260
- * @default 'exports/md'
261
- */
262
- staticPath?: string;
263
- }
264
- /**
265
- * Configuration for header-scoped section exports.
266
- */
267
- export interface SectionExportConfig {
268
- /**
269
- * Header depths that define section boundaries.
270
- * @default [1, 2, 3]
271
- */
272
- depths?: number[];
273
- /**
274
- * Minimum content length to create a section entry.
275
- * @default 0
276
- */
277
- minContentLength?: number;
278
- /**
279
- * Output path for sections.json, relative to the manifest path.
280
- * @default 'sections.json'
281
- */
282
- outputPath?: string;
283
- }
284
- /**
285
- * Environment-specific knowledge generation configuration. Extends the base
286
- * integration config with a required output path.
287
- */
288
- export interface KnowledgeEnvironment extends KnowledgeIntegrationConfig {
289
- /**
290
- * Unique identifier for this environment.
291
- */
292
- id: string;
293
- /**
294
- * Output directory for this environment's generated knowledge files.
295
- */
296
- outputPath: string;
297
- }
298
- /**
299
- * OpenWebUI integration configuration. References a generation environment
300
- * and specifies how to load credentials.
301
- */
302
- export interface OpenWebUiIntegration {
303
- /**
304
- * Path to env file containing `OPEN_WEB_UI_*` variables. Defaults to
305
- * `.env.{id}` by convention.
306
- */
307
- envFile?: string;
308
- /**
309
- * Environment identifier. Must match an `id` in `knowledge.environments`.
310
- */
311
- id: string;
312
- }
313
- /**
314
- * Container for platform-specific integration configurations.
315
- */
316
- export interface KnowledgeIntegrations {
317
- /**
318
- * OpenWebUI integration configurations.
319
- */
320
- openWebUi?: OpenWebUiIntegration[];
321
- }
322
- export interface KnowledgeConfig {
323
- /**
324
- * Generation environments. Each environment inherits global settings but can
325
- * override them.
326
- *
327
- * @inheritDoc
328
- */
329
- environments?: KnowledgeEnvironment[];
330
- /**
331
- * Shared configuration inherited by all environments.
332
- *
333
- * @inheritDoc
334
- */
335
- global?: KnowledgeIntegrationConfig;
336
- /**
337
- * Platform-specific integration configurations for uploading generated
338
- * knowledge to external services.
339
- */
340
- integrations?: KnowledgeIntegrations;
341
- }
342
- export interface SearchIndexerOptions {
343
- /**
344
- * Disable the file cache. This cache stores the result of parsed MDX files based
345
- * on each file's md5 checksum. On subsequent edits, values are retrieved from the
346
- * cache and parsing is avoided for files that have not changed.
347
- */
348
- disableCache?: boolean;
349
- /**
350
- * ToC headings.
351
- *
352
- * @default ['h2','h3','h4']
353
- */
354
- headings?: TocHeading[];
355
- /**
356
- * Optional property for defining nav item hierarchy and page metadata.
357
- *
358
- * @inheritDoc
359
- */
360
- navConfig?: NavConfig[];
361
- /**
362
- * Name of the directory where the MDX pages are located. NOT the full path to the
363
- * directory.
364
- */
365
- pageDirectory: string;
366
- /**
367
- * Controls how page timestamp metadata is populated from git history.
368
- *
369
- * @default "off"
370
- */
371
- pageTimestampMetadata?: PageTimestampMetadataMode;
372
- /**
373
- * Strategy to use for building each route's path segments. Omit this property if
374
- * you are using the default {@link https://github.com/kiliman/remix-flat-routes
375
- * remix-flat-routes} configuration.
376
- */
377
- routingStrategy?: RoutingStrategy;
378
- /**
379
- * Resolved path to the React Router app directory.
380
- */
381
- srcDir: string;
382
- /**
383
- * Resolved QUI TypeDoc props.
384
- */
385
- typeDocProps?: Record<string, QuiPropTypes>;
386
- /**
387
- * Options for TypeDoc property documentation.
388
- */
389
- typeDocPropsOptions?: QuiDocsTypeDocOptions;
390
- }
391
- export interface QuiDocsConfig extends Omit<SearchIndexerOptions, "srcDir" | "pageDirectory" | "typeDocProps"> {
392
- /**
393
- * Root app directory. NOT the full path to the directory.
394
- *
395
- * @default 'app'
396
- */
397
- appDirectory?: string;
398
- /**
399
- * Matched files will not trigger a rebuild on hot update.
400
- */
401
- hotUpdateIgnore?: RegExp;
402
- /**
403
- * Knowledge generation configuration for LLM integrations.
404
- *
405
- * @inheritDoc
406
- */
407
- knowledge?: KnowledgeConfig;
408
- /**
409
- * Name of the directory where the MDX pages are located. NOT the full path to the
410
- * directory. This is relative to the {@link appDirectory}.
411
- *
412
- * @default 'routes'
413
- */
414
- pageDirectory?: string;
415
- /**
416
- * Relative path to the typeDocProps json file. If the `<TypeDocProps />`
417
- * component is used in an mdx page, the data for its referenced entity will be
418
- * made available for property documentation rendering.
419
- *
420
- * Refer to the {@link https://docs.qui.qualcomm.com/guide/typedoc QUI typedoc guide} to learn more.
421
- */
422
- typeDocProps?: string;
423
- /**
424
- * Options for TypeDoc property documentation.
425
- */
426
- typeDocPropsOptions?: QuiDocsTypeDocOptions;
427
- }
428
- //# sourceMappingURL=types.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/docs-plugin/types.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAC,eAAe,EAAE,UAAU,EAAC,MAAM,yBAAyB,CAAA;AACxE,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,6BAA6B,CAAA;AAE7D,MAAM,MAAM,eAAe,GACvB,iBAAiB,GACjB,CAAC,CAAC,QAAQ,EAAE,MAAM,KAAK,MAAM,EAAE,CAAC,CAAA;AAEpC,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;IAClB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IAC/C;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;CACnB;AAED;;;;;GAKG;AACH,MAAM,MAAM,yBAAyB,GACjC,KAAK,GACL,WAAW,GACX,oBAAoB,CAAA;AAExB;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,EAAE,CAAC,EAAE,KAAK,CAAA;IAEV;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB;AAED,MAAM,WAAW,sBACf,SAAQ,IAAI,CACV,eAAe,EACb,OAAO,GACP,SAAS,GACT,aAAa,GACb,gBAAgB,GAChB,iBAAiB,GACjB,eAAe,GACf,QAAQ,GACR,cAAc,CACjB;IACD;;OAEG;IACH,QAAQ,CAAC,EAAE,iBAAiB,CAAA;IAE5B;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,EAAE,CAAA;IAErB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAA;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,KAAK,CAAA;IAEjB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;CACpB;AAED,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,sBAAsB,CAAC,CAAA;AAEtE,MAAM,MAAM,SAAS,GAAG,SAAS,GAAG,OAAO,CAAA;AAE3C,MAAM,WAAW,SACf,SAAQ,IAAI,CAAC,sBAAsB,EAAE,UAAU,GAAG,OAAO,CAAC;IAC1D;;;;OAIG;IACH,QAAQ,CAAC,EAAE,SAAS,EAAE,CAAA;IAEtB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;;;;OAKG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAA;CAC/B;AAED,MAAM,WAAW,qBAAqB;IACpC;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;CAC3C;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;;;;;;;OAQG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;IAElB;;;;OAIG;IACH,OAAO,CAAC,EAAE,sBAAsB,CAAA;IAEhC;;OAEG;IACH,UAAU,CAAC,EAAE,kBAAkB,EAAE,CAAA;IAEjC;;;OAGG;IACH,WAAW,CAAC,EAAE,0BAA0B,CAAA;IAExC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAEjC;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,UAAU,CAAC,EAAE,UAAU,GAAG,YAAY,CAAA;IAEtC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;;;OAIG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IAEtB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACrC;;;;;OAKG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IAEjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,kBAAkB,EAAE,CAAA;IAEjC;;;OAGG;IACH,WAAW,CAAC,EAAE,0BAA0B,CAAA;IAExC;;;;OAIG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IAEzB;;;;OAIG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAA;IAE1B;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAEjC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;IAExB;;;OAGG;IACH,QAAQ,CAAC,EAAE,mBAAmB,CAAA;IAE9B;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IAEjB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IAEzB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAqB,SAAQ,0BAA0B;IACtE;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;CACnB;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;CACX;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,SAAS,CAAC,EAAE,oBAAoB,EAAE,CAAA;CACnC;AAED,MAAM,WAAW,eAAe;IAC9B;;;;;OAKG;IACH,YAAY,CAAC,EAAE,oBAAoB,EAAE,CAAA;IAErC;;;;OAIG;IACH,MAAM,CAAC,EAAE,0BAA0B,CAAA;IAEnC;;;OAGG;IACH,YAAY,CAAC,EAAE,qBAAqB,CAAA;CACrC;AAED,MAAM,WAAW,oBAAoB;IACnC;;;;OAIG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IAEtB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,UAAU,EAAE,CAAA;IAEvB;;;;OAIG;IACH,SAAS,CAAC,EAAE,SAAS,EAAE,CAAA;IAEvB;;;OAGG;IACH,aAAa,EAAE,MAAM,CAAA;IAErB;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,yBAAyB,CAAA;IAEjD;;;;OAIG;IACH,eAAe,CAAC,EAAE,eAAe,CAAA;IAEjC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAA;IAE3C;;OAEG;IACH,mBAAmB,CAAC,EAAE,qBAAqB,CAAA;CAC5C;AAED,MAAM,WAAW,aACf,SAAQ,IAAI,CACV,oBAAoB,EACpB,QAAQ,GAAG,eAAe,GAAG,cAAc,CAC5C;IACD;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;IAExB;;;;OAIG;IACH,SAAS,CAAC,EAAE,eAAe,CAAA;IAE3B;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,mBAAmB,CAAC,EAAE,qBAAqB,CAAA;CAC5C"}
@@ -1,21 +0,0 @@
1
- export interface DemoScanConfig {
2
- /**
3
- * @default "src/routes/**\/demos/*.tsx"
4
- */
5
- demoPattern?: string;
6
- /**
7
- * The directory where the routes are located. Must be relative to the project
8
- * root. The demoPattern should start with this directory:
9
- *
10
- * @example
11
- * ```js
12
- * {
13
- * demoPattern = "src/routes/**\/demos/*.tsx",
14
- * routesDir = "src/routes",
15
- * }
16
- * ```
17
- */
18
- routesDir?: string;
19
- }
20
- export declare function addGenerateLazyDemoMapCommand(): void;
21
- //# sourceMappingURL=generate-lazy-demo-map.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"generate-lazy-demo-map.d.ts","sourceRoot":"","sources":["../../src/react-demo-plugin/generate-lazy-demo-map.ts"],"names":[],"mappings":"AAkBA,MAAM,WAAW,cAAc;IAC7B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;;;;;;;;;;OAWG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAiED,wBAAgB,6BAA6B,SAuB5C"}
File without changes