@qualcomm-ui/mdx-vite 1.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.
- package/LICENSE.txt +31 -0
- package/dist/angular-demo-plugin/angular-demo-plugin.d.ts +17 -0
- package/dist/angular-demo-plugin/angular-demo-plugin.d.ts.map +1 -0
- package/dist/angular-demo-plugin/index.d.ts +2 -0
- package/dist/angular-demo-plugin/index.d.ts.map +1 -0
- package/dist/angular-demo-plugin/virtual.d.ts +5 -0
- package/dist/cli.d.ts +2 -0
- package/dist/cli.d.ts.map +1 -0
- package/dist/cli.js +6347 -0
- package/dist/cli.js.map +7 -0
- package/dist/docs-plugin/docs-plugin.d.ts +15 -0
- package/dist/docs-plugin/docs-plugin.d.ts.map +1 -0
- package/dist/docs-plugin/index.d.ts +6 -0
- package/dist/docs-plugin/index.d.ts.map +1 -0
- package/dist/docs-plugin/internal/config-loader.d.ts +23 -0
- package/dist/docs-plugin/internal/config-loader.d.ts.map +1 -0
- package/dist/docs-plugin/internal/config-schema.d.ts +46 -0
- package/dist/docs-plugin/internal/config-schema.d.ts.map +1 -0
- package/dist/docs-plugin/internal/index.d.ts +8 -0
- package/dist/docs-plugin/internal/index.d.ts.map +1 -0
- package/dist/docs-plugin/internal/search-indexer.d.ts +46 -0
- package/dist/docs-plugin/internal/search-indexer.d.ts.map +1 -0
- package/dist/docs-plugin/internal/services/doc-props/doc-props-indexer.d.ts +28 -0
- package/dist/docs-plugin/internal/services/doc-props/doc-props-indexer.d.ts.map +1 -0
- package/dist/docs-plugin/internal/services/doc-props/index.d.ts +2 -0
- package/dist/docs-plugin/internal/services/doc-props/index.d.ts.map +1 -0
- package/dist/docs-plugin/internal/services/index.d.ts +4 -0
- package/dist/docs-plugin/internal/services/index.d.ts.map +1 -0
- package/dist/docs-plugin/internal/services/markdown/index.d.ts +6 -0
- package/dist/docs-plugin/internal/services/markdown/index.d.ts.map +1 -0
- package/dist/docs-plugin/internal/services/markdown/markdown-file-reader.d.ts +28 -0
- package/dist/docs-plugin/internal/services/markdown/markdown-file-reader.d.ts.map +1 -0
- package/dist/docs-plugin/internal/services/markdown/markdown-indexer.d.ts +27 -0
- package/dist/docs-plugin/internal/services/markdown/markdown-indexer.d.ts.map +1 -0
- package/dist/docs-plugin/internal/services/markdown/markdown.types.d.ts +10 -0
- package/dist/docs-plugin/internal/services/markdown/markdown.types.d.ts.map +1 -0
- package/dist/docs-plugin/internal/services/markdown/remark-remove-code-blocks.d.ts +3 -0
- package/dist/docs-plugin/internal/services/markdown/remark-remove-code-blocks.d.ts.map +1 -0
- package/dist/docs-plugin/internal/services/markdown/remark-remove-jsx.d.ts +3 -0
- package/dist/docs-plugin/internal/services/markdown/remark-remove-jsx.d.ts.map +1 -0
- package/dist/docs-plugin/internal/services/nav-builder/get-route-meta.d.ts +6 -0
- package/dist/docs-plugin/internal/services/nav-builder/get-route-meta.d.ts.map +1 -0
- package/dist/docs-plugin/internal/services/nav-builder/index.d.ts +4 -0
- package/dist/docs-plugin/internal/services/nav-builder/index.d.ts.map +1 -0
- package/dist/docs-plugin/internal/services/nav-builder/nav-builder.d.ts +56 -0
- package/dist/docs-plugin/internal/services/nav-builder/nav-builder.d.ts.map +1 -0
- package/dist/docs-plugin/internal/services/nav-builder/page-map.d.ts +7 -0
- package/dist/docs-plugin/internal/services/nav-builder/page-map.d.ts.map +1 -0
- package/dist/docs-plugin/internal/transform-route-meta-array.d.ts +3 -0
- package/dist/docs-plugin/internal/transform-route-meta-array.d.ts.map +1 -0
- package/dist/docs-plugin/internal/utils.d.ts +17 -0
- package/dist/docs-plugin/internal/utils.d.ts.map +1 -0
- package/dist/docs-plugin/internal/zod.d.ts +9 -0
- package/dist/docs-plugin/internal/zod.d.ts.map +1 -0
- package/dist/docs-plugin/mdx-plugins.d.ts +38 -0
- package/dist/docs-plugin/mdx-plugins.d.ts.map +1 -0
- package/dist/docs-plugin/rehype/index.d.ts +3 -0
- package/dist/docs-plugin/rehype/index.d.ts.map +1 -0
- package/dist/docs-plugin/rehype/rehype-sectionize.d.ts +11 -0
- package/dist/docs-plugin/rehype/rehype-sectionize.d.ts.map +1 -0
- package/dist/docs-plugin/rehype/rehype-slug.d.ts +16 -0
- package/dist/docs-plugin/rehype/rehype-slug.d.ts.map +1 -0
- package/dist/docs-plugin/remark/index.d.ts +5 -0
- package/dist/docs-plugin/remark/index.d.ts.map +1 -0
- package/dist/docs-plugin/remark/remark-alerts.d.ts +13 -0
- package/dist/docs-plugin/remark/remark-alerts.d.ts.map +1 -0
- package/dist/docs-plugin/remark/remark-code-tabs.d.ts +7 -0
- package/dist/docs-plugin/remark/remark-code-tabs.d.ts.map +1 -0
- package/dist/docs-plugin/remark/remark-self-link-headings.d.ts +11 -0
- package/dist/docs-plugin/remark/remark-self-link-headings.d.ts.map +1 -0
- package/dist/docs-plugin/remark/remark-spoilers.d.ts +31 -0
- package/dist/docs-plugin/remark/remark-spoilers.d.ts.map +1 -0
- package/dist/docs-plugin/tests/markdown-indexer.spec.d.ts +2 -0
- package/dist/docs-plugin/tests/markdown-indexer.spec.d.ts.map +1 -0
- package/dist/docs-plugin/tests/remark-slug.spec.d.ts +2 -0
- package/dist/docs-plugin/tests/remark-slug.spec.d.ts.map +1 -0
- package/dist/docs-plugin/tests/remix-flat-routes.spec.d.ts +2 -0
- package/dist/docs-plugin/tests/remix-flat-routes.spec.d.ts.map +1 -0
- package/dist/docs-plugin/tests/remix.spec.d.ts +2 -0
- package/dist/docs-plugin/tests/remix.spec.d.ts.map +1 -0
- package/dist/docs-plugin/tests/utils.d.ts +3 -0
- package/dist/docs-plugin/tests/utils.d.ts.map +1 -0
- package/dist/docs-plugin/tests/vite-generouted.spec.d.ts +2 -0
- package/dist/docs-plugin/tests/vite-generouted.spec.d.ts.map +1 -0
- package/dist/docs-plugin/types.d.ts +172 -0
- package/dist/docs-plugin/types.d.ts.map +1 -0
- package/dist/docs-plugin/virtual.d.ts +5 -0
- package/dist/exports.d.ts +7 -0
- package/dist/exports.d.ts.map +1 -0
- package/dist/index.d.ts +5 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +4632 -0
- package/dist/index.js.map +7 -0
- package/dist/open-web-ui-knowledge/common.d.ts +43 -0
- package/dist/open-web-ui-knowledge/common.d.ts.map +1 -0
- package/dist/open-web-ui-knowledge/download-knowledge.d.ts +2 -0
- package/dist/open-web-ui-knowledge/download-knowledge.d.ts.map +1 -0
- package/dist/open-web-ui-knowledge/generate-knowledge.d.ts +4 -0
- package/dist/open-web-ui-knowledge/generate-knowledge.d.ts.map +1 -0
- package/dist/open-web-ui-knowledge/load-config-from-env.d.ts +3 -0
- package/dist/open-web-ui-knowledge/load-config-from-env.d.ts.map +1 -0
- package/dist/open-web-ui-knowledge/types.d.ts +54 -0
- package/dist/open-web-ui-knowledge/types.d.ts.map +1 -0
- package/dist/open-web-ui-knowledge/upload-knowledge.d.ts +2 -0
- package/dist/open-web-ui-knowledge/upload-knowledge.d.ts.map +1 -0
- package/dist/react-demo-plugin/demo-plugin-constants.d.ts +9 -0
- package/dist/react-demo-plugin/demo-plugin-constants.d.ts.map +1 -0
- package/dist/react-demo-plugin/demo-plugin-types.d.ts +37 -0
- package/dist/react-demo-plugin/demo-plugin-types.d.ts.map +1 -0
- package/dist/react-demo-plugin/demo-plugin-utils.d.ts +53 -0
- package/dist/react-demo-plugin/demo-plugin-utils.d.ts.map +1 -0
- package/dist/react-demo-plugin/generate-lazy-demo-map.d.ts +21 -0
- package/dist/react-demo-plugin/generate-lazy-demo-map.d.ts.map +1 -0
- package/dist/react-demo-plugin/index.d.ts +6 -0
- package/dist/react-demo-plugin/index.d.ts.map +1 -0
- package/dist/react-demo-plugin/react-demo-plugin.d.ts +4 -0
- package/dist/react-demo-plugin/react-demo-plugin.d.ts.map +1 -0
- package/dist/react-demo-plugin/virtual.d.ts +17 -0
- package/dist/tsbuildinfo +1 -0
- package/lib/cli.js +6 -0
- package/package.json +84 -0
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
import type { PluginOption } from "vite";
|
|
2
|
+
export interface QuiDocsPluginOptions {
|
|
3
|
+
/**
|
|
4
|
+
* Path to the qui-docs config file. This is automatically detected if omitted.
|
|
5
|
+
*/
|
|
6
|
+
configFile?: string;
|
|
7
|
+
/**
|
|
8
|
+
* The current working directory.
|
|
9
|
+
*
|
|
10
|
+
* @default process.cwd()
|
|
11
|
+
*/
|
|
12
|
+
cwd?: string;
|
|
13
|
+
}
|
|
14
|
+
export declare function quiDocsPlugin(opts?: QuiDocsPluginOptions): PluginOption;
|
|
15
|
+
//# sourceMappingURL=docs-plugin.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"docs-plugin.d.ts","sourceRoot":"","sources":["../../src/docs-plugin/docs-plugin.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAAC,YAAY,EAAgB,MAAM,MAAM,CAAA;AAarD,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;;;OAIG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;CACb;AAsJD,wBAAgB,aAAa,CAAC,IAAI,CAAC,EAAE,oBAAoB,GAAG,YAAY,CAmEvE"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/docs-plugin/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAA;AAC7B,cAAc,eAAe,CAAA;AAC7B,cAAc,UAAU,CAAA;AACxB,cAAc,UAAU,CAAA;AACxB,mBAAmB,SAAS,CAAA"}
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
import type { QuiDocsConfig } from "../types";
|
|
2
|
+
export interface ResolvedQuiDocsConfig extends QuiDocsConfig {
|
|
3
|
+
appDirectory: string;
|
|
4
|
+
/**
|
|
5
|
+
* full path to the cosmiconfig file.
|
|
6
|
+
*/
|
|
7
|
+
filePath: string;
|
|
8
|
+
pageDirectory: string;
|
|
9
|
+
}
|
|
10
|
+
export interface ConfigLoaderOptions {
|
|
11
|
+
/**
|
|
12
|
+
* Path to the qui-docs config file. This is automatically detected if omitted.
|
|
13
|
+
*/
|
|
14
|
+
configFile?: string;
|
|
15
|
+
}
|
|
16
|
+
export declare class ConfigLoader {
|
|
17
|
+
private readonly options;
|
|
18
|
+
constructor(options: ConfigLoaderOptions);
|
|
19
|
+
private getCosmiconfig;
|
|
20
|
+
private resolveConfigFromCosmiconfig;
|
|
21
|
+
loadConfig(): ResolvedQuiDocsConfig;
|
|
22
|
+
}
|
|
23
|
+
//# sourceMappingURL=config-loader.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"config-loader.d.ts","sourceRoot":"","sources":["../../../src/docs-plugin/internal/config-loader.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,UAAU,CAAA;AAW3C,MAAM,WAAW,qBAAsB,SAAQ,aAAa;IAC1D,YAAY,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB,aAAa,EAAE,MAAM,CAAA;CACtB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,qBAAa,YAAY;IACvB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAqB;gBAEjC,OAAO,EAAE,mBAAmB;IAKxC,OAAO,CAAC,cAAc;IAgBtB,OAAO,CAAC,4BAA4B;IAmBpC,UAAU,IAAI,qBAAqB;CAIpC"}
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
import { z, type ZodObject, type ZodSchema } from "zod";
|
|
2
|
+
import type { RouteMeta } from "../types";
|
|
3
|
+
export declare const navMetaSchema: ZodObject<{}>;
|
|
4
|
+
export declare const routeMetaSchema: ZodSchema<RouteMeta>;
|
|
5
|
+
export declare const configSchema: z.ZodObject<{
|
|
6
|
+
appDirectory: z.ZodOptional<z.ZodString>;
|
|
7
|
+
disableCache: z.ZodOptional<z.ZodBoolean>;
|
|
8
|
+
headings: z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodLiteral<"h1">, z.ZodLiteral<"h2">, z.ZodLiteral<"h3">, z.ZodLiteral<"h4">, z.ZodLiteral<"h5">, z.ZodLiteral<"h6">]>, "many">>;
|
|
9
|
+
hotUpdateIgnore: z.ZodOptional<z.ZodType<RegExp, z.ZodTypeDef, RegExp>>;
|
|
10
|
+
navConfig: z.ZodOptional<z.ZodArray<z.ZodUnion<[z.ZodType<RouteMeta, z.ZodTypeDef, RouteMeta>, z.ZodObject<{}, z.UnknownKeysParam, z.ZodTypeAny, {}, {}>]>, "many">>;
|
|
11
|
+
pageDirectory: z.ZodOptional<z.ZodString>;
|
|
12
|
+
routingStrategy: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"vite-generouted">, z.ZodFunction<z.ZodTuple<[z.ZodString], null>, z.ZodArray<z.ZodString, "many">>]>>;
|
|
13
|
+
typeDocProps: z.ZodOptional<z.ZodString>;
|
|
14
|
+
typeDocPropsOptions: z.ZodOptional<z.ZodObject<{
|
|
15
|
+
includeInSearchIndex: z.ZodOptional<z.ZodBoolean>;
|
|
16
|
+
}, "strip", z.ZodTypeAny, {
|
|
17
|
+
includeInSearchIndex?: boolean | undefined;
|
|
18
|
+
}, {
|
|
19
|
+
includeInSearchIndex?: boolean | undefined;
|
|
20
|
+
}>>;
|
|
21
|
+
}, "strip", z.ZodTypeAny, {
|
|
22
|
+
pageDirectory?: string | undefined;
|
|
23
|
+
typeDocProps?: string | undefined;
|
|
24
|
+
disableCache?: boolean | undefined;
|
|
25
|
+
headings?: ("h1" | "h2" | "h3" | "h4" | "h5" | "h6")[] | undefined;
|
|
26
|
+
navConfig?: (RouteMeta | {})[] | undefined;
|
|
27
|
+
routingStrategy?: "vite-generouted" | ((args_0: string) => string[]) | undefined;
|
|
28
|
+
typeDocPropsOptions?: {
|
|
29
|
+
includeInSearchIndex?: boolean | undefined;
|
|
30
|
+
} | undefined;
|
|
31
|
+
appDirectory?: string | undefined;
|
|
32
|
+
hotUpdateIgnore?: RegExp | undefined;
|
|
33
|
+
}, {
|
|
34
|
+
pageDirectory?: string | undefined;
|
|
35
|
+
typeDocProps?: string | undefined;
|
|
36
|
+
disableCache?: boolean | undefined;
|
|
37
|
+
headings?: ("h1" | "h2" | "h3" | "h4" | "h5" | "h6")[] | undefined;
|
|
38
|
+
navConfig?: (RouteMeta | {})[] | undefined;
|
|
39
|
+
routingStrategy?: "vite-generouted" | ((args_0: string) => string[]) | undefined;
|
|
40
|
+
typeDocPropsOptions?: {
|
|
41
|
+
includeInSearchIndex?: boolean | undefined;
|
|
42
|
+
} | undefined;
|
|
43
|
+
appDirectory?: string | undefined;
|
|
44
|
+
hotUpdateIgnore?: RegExp | undefined;
|
|
45
|
+
}>;
|
|
46
|
+
//# sourceMappingURL=config-schema.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"config-schema.d.ts","sourceRoot":"","sources":["../../../src/docs-plugin/internal/config-schema.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,CAAC,EAAE,KAAK,SAAS,EAAE,KAAK,SAAS,EAAC,MAAM,KAAK,CAAA;AAErD,OAAO,KAAK,EAIV,SAAS,EACV,MAAM,UAAU,CAAA;AAIjB,eAAO,MAAM,aAAa,EAAE,SAAS,CAAC,EAAE,CAItC,CAAA;AAEF,eAAO,MAAM,eAAe,EAAE,SAAS,CAAC,SAAS,CAmB7C,CAAA;AAMJ,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA0BvB,CAAA"}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
export * from "./config-loader";
|
|
2
|
+
export * from "./config-schema";
|
|
3
|
+
export * from "./search-indexer";
|
|
4
|
+
export * from "./services";
|
|
5
|
+
export * from "./transform-route-meta-array";
|
|
6
|
+
export * from "./utils";
|
|
7
|
+
export * from "./zod";
|
|
8
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/docs-plugin/internal/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAA;AAC/B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,kBAAkB,CAAA;AAChC,cAAc,YAAY,CAAA;AAC1B,cAAc,8BAA8B,CAAA;AAC5C,cAAc,SAAS,CAAA;AACvB,cAAc,OAAO,CAAA"}
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
import type { NavItem, PageMap, PageSection } from "@qualcomm-ui/mdx-common";
|
|
2
|
+
import type { QuiPropTypes } from "@qualcomm-ui/typedoc-common";
|
|
3
|
+
import type { SearchIndexerOptions } from "../types";
|
|
4
|
+
import { DocPropsIndexer, MarkdownFileReader, MarkdownIndexer, NavBuilder } from "./services";
|
|
5
|
+
export declare class SearchIndexer {
|
|
6
|
+
config: SearchIndexerOptions;
|
|
7
|
+
logWarnings: boolean;
|
|
8
|
+
private readonly docPropsIndexer;
|
|
9
|
+
private readonly markdownIndexer;
|
|
10
|
+
private readonly navBuilder;
|
|
11
|
+
private readonly fileCache;
|
|
12
|
+
private readonly allowedHeadings;
|
|
13
|
+
private readonly metaJson;
|
|
14
|
+
private readonly routeMetaNav;
|
|
15
|
+
get cachedFileCount(): number;
|
|
16
|
+
get pageDocProps(): Record<string, Record<string, QuiPropTypes>>;
|
|
17
|
+
private _pageDocProps;
|
|
18
|
+
get mdxFileCount(): number;
|
|
19
|
+
private _mdxFileCount;
|
|
20
|
+
get navItems(): NavItem[];
|
|
21
|
+
get pageMap(): PageMap;
|
|
22
|
+
private _pageMap;
|
|
23
|
+
get searchIndex(): PageSection[];
|
|
24
|
+
private _searchIndex;
|
|
25
|
+
reset(): void;
|
|
26
|
+
constructor(config: SearchIndexerOptions, logWarnings?: boolean, addons?: {
|
|
27
|
+
docPropsIndexer?: DocPropsIndexer;
|
|
28
|
+
fileCache?: MarkdownFileReader;
|
|
29
|
+
markdownIndexer?: MarkdownIndexer;
|
|
30
|
+
navBuilder?: NavBuilder;
|
|
31
|
+
});
|
|
32
|
+
/**
|
|
33
|
+
* Resolves a page's properties from the combined frontmatter and RouteMeta.
|
|
34
|
+
* RouteMeta properties take precedence.
|
|
35
|
+
*/
|
|
36
|
+
private getPageEntry;
|
|
37
|
+
/**
|
|
38
|
+
* Parses an MDX file to extract the site data for the nav items, doc props,
|
|
39
|
+
* breadcrumbs, and search index.
|
|
40
|
+
*/
|
|
41
|
+
private compileMdxFile;
|
|
42
|
+
private formatSections;
|
|
43
|
+
private compileTsxFile;
|
|
44
|
+
buildIndex(inputFileGlob: string[], logWarnings?: boolean): void;
|
|
45
|
+
}
|
|
46
|
+
//# sourceMappingURL=search-indexer.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"search-indexer.d.ts","sourceRoot":"","sources":["../../../src/docs-plugin/internal/search-indexer.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EACV,OAAO,EAEP,OAAO,EACP,WAAW,EACZ,MAAM,yBAAyB,CAAA;AAChC,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,6BAA6B,CAAA;AAE7D,OAAO,KAAK,EAGV,oBAAoB,EACrB,MAAM,UAAU,CAAA;AAEjB,OAAO,EACL,eAAe,EAQf,kBAAkB,EAClB,eAAe,EACf,UAAU,EACX,MAAM,YAAY,CAAA;AAInB,qBAAa,aAAa;IA4Cf,MAAM,EAAE,oBAAoB;IAC5B,WAAW;IA5CpB,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAiB;IACjD,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAiB;IACjD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAY;IACvC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAoB;IAC9C,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAa;IAC7C,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAmB;IAC5C,OAAO,CAAC,QAAQ,CAAC,YAAY,CAA2C;IAExE,IAAI,eAAe,IAAI,MAAM,CAE5B;IAED,IAAI,YAAY,IAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC,CAE/D;IACD,OAAO,CAAC,aAAa,CAAmD;IAExE,IAAI,YAAY,IAAI,MAAM,CAEzB;IACD,OAAO,CAAC,aAAa,CAAY;IAEjC,IAAI,QAAQ,IAAI,OAAO,EAAE,CAExB;IAED,IAAI,OAAO,IAAI,OAAO,CAErB;IACD,OAAO,CAAC,QAAQ,CAAc;IAE9B,IAAI,WAAW,IAAI,WAAW,EAAE,CAE/B;IACD,OAAO,CAAC,YAAY,CAAoB;IAExC,KAAK,IAAI,IAAI;gBAOJ,MAAM,EAAE,oBAAoB,EAC5B,WAAW,UAAO,EAEzB,MAAM,GAAE;QACN,eAAe,CAAC,EAAE,eAAe,CAAA;QACjC,SAAS,CAAC,EAAE,kBAAkB,CAAA;QAC9B,eAAe,CAAC,EAAE,eAAe,CAAA;QACjC,UAAU,CAAC,EAAE,UAAU,CAAA;KACnB;IAwBR;;;OAGG;IACH,OAAO,CAAC,YAAY;IA4DpB;;;OAGG;IACH,OAAO,CAAC,cAAc;IAmFtB,OAAO,CAAC,cAAc;IAuBtB,OAAO,CAAC,cAAc;IAqBtB,UAAU,CAAC,aAAa,EAAE,MAAM,EAAE,EAAE,WAAW,GAAE,OAAc,GAAG,IAAI;CAyBvE"}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import { type Plugin } from "unified";
|
|
2
|
+
import { type PageDocProps, type PageHeading, UniqueIdService } from "@qualcomm-ui/mdx-common";
|
|
3
|
+
import type { QuiPropTypes } from "@qualcomm-ui/typedoc-common";
|
|
4
|
+
import type { IndexedSection } from "../markdown";
|
|
5
|
+
interface DocPropEntry {
|
|
6
|
+
name: string;
|
|
7
|
+
omitFrom?: string[];
|
|
8
|
+
}
|
|
9
|
+
export declare class DocPropsIndexer {
|
|
10
|
+
docPropsEntries: DocPropEntry[];
|
|
11
|
+
idService: UniqueIdService;
|
|
12
|
+
private readonly props;
|
|
13
|
+
private pageDocProps;
|
|
14
|
+
constructor(props: Record<string, QuiPropTypes>);
|
|
15
|
+
reset(): void;
|
|
16
|
+
private extractNamesFromAttribute;
|
|
17
|
+
/**
|
|
18
|
+
* Finds all JSX `<TypeDocProps />` nodes on the current page and adds their names
|
|
19
|
+
* to an array. Once all nodes have been collected, we process them into
|
|
20
|
+
* `PageSection` entries for the search index.
|
|
21
|
+
*/
|
|
22
|
+
getTypeDocPropsNodes: Plugin;
|
|
23
|
+
build(fileContents: string, toc: PageHeading[]): IndexedSection[] | null;
|
|
24
|
+
getDocProps(): PageDocProps;
|
|
25
|
+
private assembleProp;
|
|
26
|
+
}
|
|
27
|
+
export {};
|
|
28
|
+
//# sourceMappingURL=doc-props-indexer.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"doc-props-indexer.d.ts","sourceRoot":"","sources":["../../../../../src/docs-plugin/internal/services/doc-props/doc-props-indexer.ts"],"names":[],"mappings":"AAOA,OAAO,EAAC,KAAK,MAAM,EAAU,MAAM,SAAS,CAAA;AAG5C,OAAO,EACL,KAAK,YAAY,EACjB,KAAK,WAAW,EAEhB,eAAe,EAChB,MAAM,yBAAyB,CAAA;AAChC,OAAO,KAAK,EAEV,YAAY,EACb,MAAM,6BAA6B,CAAA;AAEpC,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,aAAa,CAAA;AAuD/C,UAAU,YAAY;IACpB,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;CACpB;AAED,qBAAa,eAAe;IAC1B,eAAe,EAAE,YAAY,EAAE,CAAK;IACpC,SAAS,EAAE,eAAe,CAAwB;IAClD,OAAO,CAAC,QAAQ,CAAC,KAAK,CAA8B;IACpD,OAAO,CAAC,YAAY,CAAmB;gBAE3B,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC;IAI/C,KAAK,IAAI,IAAI;IAKb,OAAO,CAAC,yBAAyB;IA0CjC;;;;OAIG;IACH,oBAAoB,EAAE,MAAM,CA6C3B;IAED,KAAK,CAAC,YAAY,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,GAAG,cAAc,EAAE,GAAG,IAAI;IAgFxE,WAAW,IAAI,YAAY;IAY3B,OAAO,CAAC,YAAY;CAyBrB"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/docs-plugin/internal/services/doc-props/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAA"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/docs-plugin/internal/services/index.ts"],"names":[],"mappings":"AAAA,cAAc,aAAa,CAAA;AAC3B,cAAc,YAAY,CAAA;AAC1B,cAAc,eAAe,CAAA"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/docs-plugin/internal/services/markdown/index.ts"],"names":[],"mappings":"AAAA,cAAc,wBAAwB,CAAA;AACtC,cAAc,oBAAoB,CAAA;AAClC,cAAc,kBAAkB,CAAA;AAChC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,qBAAqB,CAAA"}
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
import type { PageFrontmatter } from "@qualcomm-ui/mdx-common";
|
|
2
|
+
import type { QuiPropTypes } from "@qualcomm-ui/typedoc-common";
|
|
3
|
+
import type { IndexedPage, IndexedSection } from "./markdown.types";
|
|
4
|
+
interface PageCache {
|
|
5
|
+
frontmatter: PageFrontmatter;
|
|
6
|
+
md5: string;
|
|
7
|
+
page: IndexedPage;
|
|
8
|
+
pageDocProps: Record<string, QuiPropTypes>;
|
|
9
|
+
pageDocPropSections: IndexedSection[];
|
|
10
|
+
}
|
|
11
|
+
export declare class MarkdownFileReader {
|
|
12
|
+
enabled: boolean;
|
|
13
|
+
cachedFileCount: number;
|
|
14
|
+
logWarnings: boolean;
|
|
15
|
+
private mdxCache;
|
|
16
|
+
constructor(enabled: boolean);
|
|
17
|
+
private hash;
|
|
18
|
+
reset(): void;
|
|
19
|
+
private checkCache;
|
|
20
|
+
readFile(filepath: string): {
|
|
21
|
+
cached: Omit<PageCache, "md5"> | undefined;
|
|
22
|
+
fileContents: string;
|
|
23
|
+
frontmatter: PageFrontmatter;
|
|
24
|
+
};
|
|
25
|
+
updateCache(filepath: string, fileContents: string, cacheData: Omit<PageCache, "md5">): void;
|
|
26
|
+
}
|
|
27
|
+
export {};
|
|
28
|
+
//# sourceMappingURL=markdown-file-reader.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"markdown-file-reader.d.ts","sourceRoot":"","sources":["../../../../../src/docs-plugin/internal/services/markdown/markdown-file-reader.ts"],"names":[],"mappings":"AAYA,OAAO,KAAK,EAAC,eAAe,EAAC,MAAM,yBAAyB,CAAA;AAC5D,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,6BAA6B,CAAA;AAI7D,OAAO,KAAK,EAAC,WAAW,EAAE,cAAc,EAAC,MAAM,kBAAkB,CAAA;AAEjE,UAAU,SAAS;IACjB,WAAW,EAAE,eAAe,CAAA;IAC5B,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,EAAE,WAAW,CAAA;IACjB,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAA;IAC1C,mBAAmB,EAAE,cAAc,EAAE,CAAA;CACtC;AAED,qBAAa,kBAAkB;IAKV,OAAO,EAAE,OAAO;IAJnC,eAAe,SAAI;IACnB,WAAW,UAAO;IAClB,OAAO,CAAC,QAAQ,CAAgC;gBAE7B,OAAO,EAAE,OAAO;IAEnC,OAAO,CAAC,IAAI;IAIZ,KAAK,IAAI,IAAI;IAIb,OAAO,CAAC,UAAU;IAyBlB,QAAQ,CAAC,QAAQ,EAAE,MAAM,GAAG;QAC1B,MAAM,EAAE,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,GAAG,SAAS,CAAA;QAC1C,YAAY,EAAE,MAAM,CAAA;QACpB,WAAW,EAAE,eAAe,CAAA;KAC7B;IAuDD,WAAW,CACT,QAAQ,EAAE,MAAM,EAChB,YAAY,EAAE,MAAM,EACpB,SAAS,EAAE,IAAI,CAAC,SAAS,EAAE,KAAK,CAAC,GAChC,IAAI;CAKR"}
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
import type { PageFrontmatter, PageHeading } from "@qualcomm-ui/mdx-common";
|
|
2
|
+
import type { IndexedPage } from "./markdown.types";
|
|
3
|
+
/**
|
|
4
|
+
* Parses an html string into an AST and builds the search index from the tree.
|
|
5
|
+
*/
|
|
6
|
+
export declare class MarkdownIndexer {
|
|
7
|
+
private sections;
|
|
8
|
+
private currentSection;
|
|
9
|
+
private readonly headingLevels;
|
|
10
|
+
reset(): void;
|
|
11
|
+
resetSection(): void;
|
|
12
|
+
get toc(): PageHeading[];
|
|
13
|
+
private _toc;
|
|
14
|
+
constructor(headingLevels: Set<string>);
|
|
15
|
+
private appendTocItem;
|
|
16
|
+
private warn;
|
|
17
|
+
private isHeading;
|
|
18
|
+
private isRootHeading;
|
|
19
|
+
/**
|
|
20
|
+
* Parses a heading Element node into the indexed heading data structure.
|
|
21
|
+
*/
|
|
22
|
+
private parseHeading;
|
|
23
|
+
private parseElementNode;
|
|
24
|
+
parseMarkdown(fileContents: string | Buffer, frontmatter: PageFrontmatter): IndexedPage;
|
|
25
|
+
build(html: string): IndexedPage;
|
|
26
|
+
}
|
|
27
|
+
//# sourceMappingURL=markdown-indexer.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"markdown-indexer.d.ts","sourceRoot":"","sources":["../../../../../src/docs-plugin/internal/services/markdown/markdown-indexer.ts"],"names":[],"mappings":"AAeA,OAAO,KAAK,EAAC,eAAe,EAAE,WAAW,EAAC,MAAM,yBAAyB,CAAA;AAKzE,OAAO,KAAK,EAAC,WAAW,EAAiB,MAAM,kBAAkB,CAAA;AAIjE;;GAEG;AACH,qBAAa,eAAe;IAC1B,OAAO,CAAC,QAAQ,CAAuB;IACvC,OAAO,CAAC,cAAc,CAAiB;IACvC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAa;IAE3C,KAAK,IAAI,IAAI;IAMb,YAAY,IAAI,IAAI;IAOpB,IAAI,GAAG,IAAI,WAAW,EAAE,CAEvB;IACD,OAAO,CAAC,IAAI,CAAoB;gBAEpB,aAAa,EAAE,GAAG,CAAC,MAAM,CAAC;IAKtC,OAAO,CAAC,aAAa;IAIrB,OAAO,CAAC,IAAI;IAQZ,OAAO,CAAC,SAAS;IAIjB,OAAO,CAAC,aAAa;IAIrB;;OAEG;IACH,OAAO,CAAC,YAAY;IAYpB,OAAO,CAAC,gBAAgB;IA8BxB,aAAa,CACX,YAAY,EAAE,MAAM,GAAG,MAAM,EAC7B,WAAW,EAAE,eAAe,GAC3B,WAAW;IAkCd,KAAK,CAAC,IAAI,EAAE,MAAM,GAAG,WAAW;CAoBjC"}
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import type { PageHeading, PageSectionContent } from "@qualcomm-ui/mdx-common";
|
|
2
|
+
export interface IndexedSection {
|
|
3
|
+
content: PageSectionContent[];
|
|
4
|
+
heading: PageHeading | null;
|
|
5
|
+
}
|
|
6
|
+
export interface IndexedPage {
|
|
7
|
+
sections: IndexedSection[];
|
|
8
|
+
toc: PageHeading[];
|
|
9
|
+
}
|
|
10
|
+
//# sourceMappingURL=markdown.types.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"markdown.types.d.ts","sourceRoot":"","sources":["../../../../../src/docs-plugin/internal/services/markdown/markdown.types.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAC,WAAW,EAAE,kBAAkB,EAAC,MAAM,yBAAyB,CAAA;AAE5E,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,kBAAkB,EAAE,CAAA;IAC7B,OAAO,EAAE,WAAW,GAAG,IAAI,CAAA;CAC5B;AAED,MAAM,WAAW,WAAW;IAC1B,QAAQ,EAAE,cAAc,EAAE,CAAA;IAC1B,GAAG,EAAE,WAAW,EAAE,CAAA;CACnB"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"remark-remove-code-blocks.d.ts","sourceRoot":"","sources":["../../../../../src/docs-plugin/internal/services/markdown/remark-remove-code-blocks.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,SAAS,CAAA;AAGnC,eAAO,MAAM,6BAA6B,EAAE,MAK3C,CAAA"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"remark-remove-jsx.d.ts","sourceRoot":"","sources":["../../../../../src/docs-plugin/internal/services/markdown/remark-remove-jsx.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,SAAS,CAAA;AAGnC,eAAO,MAAM,eAAe,EAAE,MAM7B,CAAA"}
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import type { RouteMetaEntryInternal, RouteMetaInternal } from "../../../types";
|
|
2
|
+
/**
|
|
3
|
+
* Retrieves the route metadata for a given path based on its path segments.
|
|
4
|
+
*/
|
|
5
|
+
export declare function getRouteMeta(pathSegments: string[], metaJson: RouteMetaInternal): RouteMetaEntryInternal | undefined | null;
|
|
6
|
+
//# sourceMappingURL=get-route-meta.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"get-route-meta.d.ts","sourceRoot":"","sources":["../../../../../src/docs-plugin/internal/services/nav-builder/get-route-meta.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAC,sBAAsB,EAAE,iBAAiB,EAAC,MAAM,gBAAgB,CAAA;AAE7E;;GAEG;AACH,wBAAgB,YAAY,CAC1B,YAAY,EAAE,MAAM,EAAE,EACtB,QAAQ,EAAE,iBAAiB,GAC1B,sBAAsB,GAAG,SAAS,GAAG,IAAI,CAgB3C"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/docs-plugin/internal/services/nav-builder/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAA;AAChC,cAAc,eAAe,CAAA;AAC7B,cAAc,YAAY,CAAA"}
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
import type { NavItem, PageFrontmatter, PageSection } from "@qualcomm-ui/mdx-common";
|
|
2
|
+
import type { NavMeta, RouteMetaEntryInternal, RouteMetaInternal } from "../../../types";
|
|
3
|
+
/**
|
|
4
|
+
* Given a flat remix route structure, computes nested navigation items for the QUI
|
|
5
|
+
* side nav.
|
|
6
|
+
*/
|
|
7
|
+
export declare class NavBuilder {
|
|
8
|
+
private initialRoutes;
|
|
9
|
+
private flatNavItems;
|
|
10
|
+
get navItems(): NavItem[];
|
|
11
|
+
private _navItems;
|
|
12
|
+
private readonly metaJson;
|
|
13
|
+
private readonly navMeta;
|
|
14
|
+
constructor(metaJson: RouteMetaInternal, navMeta: Record<number, NavMeta>);
|
|
15
|
+
add(pageSection: PageSection, pageFrontmatter: Partial<PageFrontmatter>, routeMeta?: RouteMetaEntryInternal): void;
|
|
16
|
+
reset(): void;
|
|
17
|
+
/**
|
|
18
|
+
* Sorts nav items. Nav items with an order defined take precedence over nav items
|
|
19
|
+
* without an order. Nav items with the same order are sorted alphabetically by
|
|
20
|
+
* title.
|
|
21
|
+
*/
|
|
22
|
+
private navItemSort;
|
|
23
|
+
resolveSideNavTitle(frontmatter: Partial<PageFrontmatter>, routeMeta: Partial<RouteMetaEntryInternal>, fallback: string): string;
|
|
24
|
+
/**
|
|
25
|
+
* Builds a flat list of nav items from the MDX pages and _meta.json. If a page
|
|
26
|
+
* does not exist, it is not added to the side nav (even if it has an entry in
|
|
27
|
+
* _meta.json).
|
|
28
|
+
*/
|
|
29
|
+
private buildNavItem;
|
|
30
|
+
/**
|
|
31
|
+
* Iterates through a nav item's path segments and ensures that all of its parent
|
|
32
|
+
* elements exist in the recursive structure.
|
|
33
|
+
*/
|
|
34
|
+
private ensureParent;
|
|
35
|
+
/**
|
|
36
|
+
* Deeply inserts a nav item into the array, iterating through parent routes
|
|
37
|
+
* (based on the pathSegments) and adding them if they don't exist.
|
|
38
|
+
*
|
|
39
|
+
* For example, given a leaf node 4 path segments deep, this function will create
|
|
40
|
+
* all parent nav items as nested children of the top-most nav item.
|
|
41
|
+
*/
|
|
42
|
+
private nestedInsert;
|
|
43
|
+
private buildNestedNavItems;
|
|
44
|
+
private sortNestedNavItems;
|
|
45
|
+
/**
|
|
46
|
+
* To be called after every mdx page route has been added through the {@link add}
|
|
47
|
+
* function.
|
|
48
|
+
*/
|
|
49
|
+
build(): NavItem[];
|
|
50
|
+
private groupNavItems;
|
|
51
|
+
/**
|
|
52
|
+
* Walks over the tree and builds search metadata using the nearest sectionTitle.
|
|
53
|
+
*/
|
|
54
|
+
private buildSearchMeta;
|
|
55
|
+
}
|
|
56
|
+
//# sourceMappingURL=nav-builder.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"nav-builder.d.ts","sourceRoot":"","sources":["../../../../../src/docs-plugin/internal/services/nav-builder/nav-builder.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EACV,OAAO,EACP,eAAe,EACf,WAAW,EACZ,MAAM,yBAAyB,CAAA;AAEhC,OAAO,KAAK,EACV,OAAO,EACP,sBAAsB,EACtB,iBAAiB,EAClB,MAAM,gBAAgB,CAAA;AAWvB;;;GAGG;AACH,qBAAa,UAAU;IACrB,OAAO,CAAC,aAAa,CAAqB;IAC1C,OAAO,CAAC,YAAY,CAAgB;IAEpC,IAAI,QAAQ,IAAI,OAAO,EAAE,CAExB;IACD,OAAO,CAAC,SAAS,CAAgB;IAEjC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAmB;IAC5C,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAyB;gBAErC,QAAQ,EAAE,iBAAiB,EAAE,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC;IAKzE,GAAG,CACD,WAAW,EAAE,WAAW,EACxB,eAAe,EAAE,OAAO,CAAC,eAAe,CAAC,EACzC,SAAS,CAAC,EAAE,sBAAsB,GACjC,IAAI;IAIP,KAAK,IAAI,IAAI;IAMb;;;;OAIG;IACH,OAAO,CAAC,WAAW;IA6CnB,mBAAmB,CACjB,WAAW,EAAE,OAAO,CAAC,eAAe,CAAC,EACrC,SAAS,EAAE,OAAO,CAAC,sBAAsB,CAAC,EAC1C,QAAQ,EAAE,MAAM,GACf,MAAM;IAQT;;;;OAIG;IACH,OAAO,CAAC,YAAY;IA4EpB;;;OAGG;IACH,OAAO,CAAC,YAAY;IA4CpB;;;;;;OAMG;IACH,OAAO,CAAC,YAAY;IAiBpB,OAAO,CAAC,mBAAmB;IAa3B,OAAO,CAAC,kBAAkB;IAU1B;;;OAGG;IACH,KAAK,IAAI,OAAO,EAAE;IA+BlB,OAAO,CAAC,aAAa;IA0BrB;;OAEG;IACH,OAAO,CAAC,eAAe;CA8BxB"}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import type { RouteMetaInternal, RoutingStrategy } from "../../../types";
|
|
2
|
+
export declare function getPathnameFromPathSegments(segments: string[]): string;
|
|
3
|
+
export declare function getCategoriesFromPathSegments(segments: string[], metaJson: RouteMetaInternal, frontmatterTitle: string): string[];
|
|
4
|
+
export declare function pathSegmentToCategory(segment: string): string;
|
|
5
|
+
export declare function getPathSegmentsFromFileName(filePath: string, pageDirectory: string, strategy?: RoutingStrategy): string[];
|
|
6
|
+
export declare function filterFileGlob(fileGlob: string[], ext: string, srcDir: string, router?: RoutingStrategy): string[];
|
|
7
|
+
//# sourceMappingURL=page-map.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"page-map.d.ts","sourceRoot":"","sources":["../../../../../src/docs-plugin/internal/services/nav-builder/page-map.ts"],"names":[],"mappings":"AAMA,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"}
|
|
@@ -0,0 +1 @@
|
|
|
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"}
|
|
@@ -0,0 +1,17 @@
|
|
|
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
|
|
@@ -0,0 +1 @@
|
|
|
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,CAcxC,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"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import { z } from "zod";
|
|
2
|
+
type Implements<Model> = {
|
|
3
|
+
[key in keyof Model]-?: undefined extends Model[key] ? null extends Model[key] ? z.ZodNullableType<z.ZodOptionalType<z.ZodType<Model[key]>>> : z.ZodOptionalType<z.ZodType<Model[key]>> : null extends Model[key] ? z.ZodNullableType<z.ZodType<Model[key]>> : z.ZodType<Model[key]> | z.ZodDefault<z.ZodType<Model[key]>>;
|
|
4
|
+
};
|
|
5
|
+
export declare function implement<Model = never>(): {
|
|
6
|
+
with: <Schema extends Implements<Model> & { [unknownKey in Exclude<keyof Schema, keyof Model>]: never; }>(schema: Schema) => z.ZodObject<Schema, "strip", z.ZodTypeAny, z.objectUtil.addQuestionMarks<z.baseObjectOutputType<Schema>, any> extends infer T ? { [k in keyof T]: z.objectUtil.addQuestionMarks<z.baseObjectOutputType<Schema>, any>[k]; } : never, z.baseObjectInputType<Schema> extends infer T_1 ? { [k_1 in keyof T_1]: z.baseObjectInputType<Schema>[k_1]; } : never>;
|
|
7
|
+
};
|
|
8
|
+
export {};
|
|
9
|
+
//# sourceMappingURL=zod.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
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,eAAe,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAC3D,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,GAC1C,IAAI,SAAS,KAAK,CAAC,GAAG,CAAC,GACrB,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,GACxC,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"}
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
import { type RehypeShikiOptions } from "@shikijs/rehype";
|
|
2
|
+
import type { PluggableList } from "unified";
|
|
3
|
+
import { type ConfigLoaderOptions } from "./internal";
|
|
4
|
+
/**
|
|
5
|
+
* @deprecated migrate to the {@link getRehypePlugins} function
|
|
6
|
+
*/
|
|
7
|
+
export declare const quiRehypePlugins: PluggableList;
|
|
8
|
+
export interface QuiRehypePluginOptions extends ConfigLoaderOptions {
|
|
9
|
+
rehypeShikiOptions?: Partial<RehypeShikiOptions>;
|
|
10
|
+
}
|
|
11
|
+
/**
|
|
12
|
+
* Used to retrieve all the rehype plugins required for QUI Docs MDX.
|
|
13
|
+
* These should be passed to the `mdx` vite plugin from
|
|
14
|
+
*/
|
|
15
|
+
export declare function getRehypePlugins(options?: QuiRehypePluginOptions): PluggableList;
|
|
16
|
+
/**
|
|
17
|
+
* @deprecated migrate to the {@link getRemarkPlugins} function
|
|
18
|
+
*/
|
|
19
|
+
export declare const quiRemarkPlugins: PluggableList;
|
|
20
|
+
/**
|
|
21
|
+
* @returns every remark plugin needed for QUI Docs MDX.
|
|
22
|
+
*
|
|
23
|
+
* @example
|
|
24
|
+
* ```ts
|
|
25
|
+
* // in your vite config
|
|
26
|
+
* plugins: [
|
|
27
|
+
* mdx({
|
|
28
|
+
* providerImportSource: "@mdx-js/react",
|
|
29
|
+
* rehypePlugins: [...getRehypePlugins()],
|
|
30
|
+
* remarkPlugins: [...getRemarkPlugins()],
|
|
31
|
+
* }),
|
|
32
|
+
* quiDocsPlugin(),
|
|
33
|
+
* // ... the rest of your plugins
|
|
34
|
+
* ]
|
|
35
|
+
* ```
|
|
36
|
+
*/
|
|
37
|
+
export declare function getRemarkPlugins(): PluggableList;
|
|
38
|
+
//# sourceMappingURL=mdx-plugins.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"mdx-plugins.d.ts","sourceRoot":"","sources":["../../src/docs-plugin/mdx-plugins.ts"],"names":[],"mappings":"AAGA,OAAoB,EAAC,KAAK,kBAAkB,EAAC,MAAM,iBAAiB,CAAA;AACpE,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,SAAS,CAAA;AAW1C,OAAO,EAAe,KAAK,mBAAmB,EAAC,MAAM,YAAY,CAAA;AAIjE;;GAEG;AACH,eAAO,MAAM,gBAAgB,EAAE,aAA8C,CAAA;AAE7E,MAAM,WAAW,sBAAuB,SAAQ,mBAAmB;IACjE,kBAAkB,CAAC,EAAE,OAAO,CAAC,kBAAkB,CAAC,CAAA;CACjD;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAC9B,OAAO,GAAE,sBAA2B,GACnC,aAAa,CAqBf;AAED;;GAEG;AACH,eAAO,MAAM,gBAAgB,EAAE,aAA8C,CAAA;AAE7E;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,gBAAgB,IAAI,aAAa,CAShD"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/docs-plugin/rehype/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAA;AACnC,cAAc,eAAe,CAAA"}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import type { Root } from "hast";
|
|
2
|
+
import type { Properties } from "hastscript";
|
|
3
|
+
import type { Plugin } from "unified";
|
|
4
|
+
export type RehypeSectionizeOptions = {
|
|
5
|
+
enableRootSection?: boolean | undefined;
|
|
6
|
+
idPropertyName?: string | undefined;
|
|
7
|
+
properties?: Properties | undefined;
|
|
8
|
+
rankPropertyName?: string | undefined;
|
|
9
|
+
};
|
|
10
|
+
export declare const rehypeSectionize: Plugin<[RehypeSectionizeOptions?], Root>;
|
|
11
|
+
//# sourceMappingURL=rehype-sectionize.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"rehype-sectionize.d.ts","sourceRoot":"","sources":["../../../src/docs-plugin/rehype/rehype-sectionize.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAU,IAAI,EAAc,MAAM,MAAM,CAAA;AAGpD,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,YAAY,CAAA;AAC1C,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,SAAS,CAAA;AAEnC,MAAM,MAAM,uBAAuB,GAAG;IACpC,iBAAiB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IACvC,cAAc,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACnC,UAAU,CAAC,EAAE,UAAU,GAAG,SAAS,CAAA;IACnC,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CACtC,CAAA;AAmED,eAAO,MAAM,gBAAgB,EAAE,MAAM,CAAC,CAAC,uBAAuB,CAAC,CAAC,EAAE,IAAI,CA6DrE,CAAA"}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import type { Root } from "hast";
|
|
2
|
+
import type { Plugin } from "unified";
|
|
3
|
+
export interface RehypeSlugOptions {
|
|
4
|
+
/**
|
|
5
|
+
* @default ['h2', 'h3', 'h4']
|
|
6
|
+
*/
|
|
7
|
+
allowedHeadings?: string[];
|
|
8
|
+
prefix?: string;
|
|
9
|
+
}
|
|
10
|
+
/**
|
|
11
|
+
* Converts heading text to URL-friendly slugs. Converts multi-word and PascalCase
|
|
12
|
+
* text to kebab-case. Lowercases single sentence-case words. Appends counter for
|
|
13
|
+
* duplicate slugs.
|
|
14
|
+
*/
|
|
15
|
+
export declare const rehypeSlug: Plugin<[RehypeSlugOptions?], Root>;
|
|
16
|
+
//# sourceMappingURL=rehype-slug.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"rehype-slug.d.ts","sourceRoot":"","sources":["../../../src/docs-plugin/rehype/rehype-slug.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAC,IAAI,EAAC,MAAM,MAAM,CAAA;AAG9B,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,SAAS,CAAA;AAGnC,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,EAAE,CAAA;IAC1B,MAAM,CAAC,EAAE,MAAM,CAAA;CAChB;AAID;;;;GAIG;AACH,eAAO,MAAM,UAAU,EAAE,MAAM,CAAC,CAAC,iBAAiB,CAAC,CAAC,EAAE,IAAI,CAgDzD,CAAA"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/docs-plugin/remark/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAA;AAC/B,cAAc,oBAAoB,CAAA;AAClC,cAAc,6BAA6B,CAAA;AAC3C,cAAc,mBAAmB,CAAA"}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import type { PhrasingContent, Root } from "mdast";
|
|
2
|
+
import type { Plugin } from "unified";
|
|
3
|
+
/**
|
|
4
|
+
* Alerts are a Markdown extension based on the blockquote syntax that you can use
|
|
5
|
+
* to emphasize critical information. On GitHub, they are displayed with distinctive
|
|
6
|
+
* colors and icons to indicate the significance of the content.
|
|
7
|
+
* https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts
|
|
8
|
+
*/
|
|
9
|
+
export declare const remarkAlerts: Plugin<[], Root>;
|
|
10
|
+
export declare function getAlertIcon(type: IconType): PhrasingContent;
|
|
11
|
+
type IconType = "note" | "tip" | "success" | "warning" | "caution";
|
|
12
|
+
export {};
|
|
13
|
+
//# sourceMappingURL=remark-alerts.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"remark-alerts.d.ts","sourceRoot":"","sources":["../../../src/docs-plugin/remark/remark-alerts.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAC,eAAe,EAAE,IAAI,EAAC,MAAM,OAAO,CAAA;AAChD,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,SAAS,CAAA;AAKnC;;;;;GAKG;AACH,eAAO,MAAM,YAAY,EAAE,MAAM,CAAC,EAAE,EAAE,IAAI,CAgGzC,CAAA;AAED,wBAAgB,YAAY,CAAC,IAAI,EAAE,QAAQ,GAAG,eAAe,CAqB5D;AAED,KAAK,QAAQ,GAAG,MAAM,GAAG,KAAK,GAAG,SAAS,GAAG,SAAS,GAAG,SAAS,CAAA"}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import type { Root } from "mdast";
|
|
2
|
+
import type { Plugin } from "unified";
|
|
3
|
+
/**
|
|
4
|
+
* Very cool. TODO: document this https://docs.qui.qualcomm.com/guide/markdown
|
|
5
|
+
*/
|
|
6
|
+
export declare const remarkCodeTabs: Plugin<[], Root>;
|
|
7
|
+
//# sourceMappingURL=remark-code-tabs.d.ts.map
|