@qualcomm-ui/mdx-common 1.0.0

package/LICENSE.txt

@@ -0,0 +1,31 @@
+Copyright (c) Qualcomm Technologies, Inc. and/or its subsidiaries.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted (subject to the limitations in the
+disclaimer below) provided that the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+
+    * Redistributions in binary form must reproduce the above
+      copyright notice, this list of conditions and the following
+      disclaimer in the documentation and/or other materials provided
+      with the distribution.
+
+    * Neither the name of Qualcomm Technologies, Inc. nor the names of its
+      contributors may be used to endorse or promote products derived
+      from this software without specific prior written permission.
+
+NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE
+GRANTED BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT
+HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED
+WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
+GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
+IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
+OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
+IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/dist/demo-plugin.types.d.ts

@@ -0,0 +1,58 @@
+export interface SourceCodeData {
+    fileName: string;
+    filePath?: string;
+    highlighted: {
+        full: string;
+        preview?: string;
+    };
+    raw: {
+        full: string;
+        preview: string;
+        withoutImports: string;
+    };
+}
+export interface ReactDemoData {
+    demoName: string;
+    errorMessage?: string;
+    fileName: string;
+    imports: string[];
+    pageId: string;
+    sourceCode: SourceCodeData[];
+}
+export interface ReactDemoWithScope extends ReactDemoData {
+    demoName: string;
+    scope: Record<string, any>;
+}
+export interface PreviewBlock {
+    content: string;
+    endLine: number;
+    startLine: number;
+}
+export interface AngularDemoInfo {
+    componentClass: string;
+    dimensions?: {
+        height: number;
+    };
+    filePath: string;
+    hasDefaultExport: boolean;
+    id: string;
+    imports: string[];
+    initialHtml?: string;
+    isStandalone: boolean;
+    lastModified: number;
+    pageId: string;
+    selector: string;
+    sourceCode: SourceCodeData[];
+}
+export interface PreviewContext {
+    content: string;
+    context: "template" | "typescript";
+    endLine: number;
+    startLine: number;
+}
+export interface ExtractedPreview {
+    formattedPreview?: string;
+    previewBlocks?: PreviewContext[];
+    sourceWithoutPreviews: string;
+}
+//# sourceMappingURL=demo-plugin.types.d.ts.map

package/dist/demo-plugin.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"demo-plugin.types.d.ts","sourceRoot":"","sources":["../src/demo-plugin.types.ts"],"names":[],"mappings":"AAGA,MAAM,WAAW,cAAc;IAC7B,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,WAAW,EAAE;QACX,IAAI,EAAE,MAAM,CAAA;QACZ,OAAO,CAAC,EAAE,MAAM,CAAA;KACjB,CAAA;IACD,GAAG,EAAE;QACH,IAAI,EAAE,MAAM,CAAA;QACZ,OAAO,EAAE,MAAM,CAAA;QACf,cAAc,EAAE,MAAM,CAAA;KACvB,CAAA;CACF;AAED,MAAM,WAAW,aAAa;IAC5B,QAAQ,EAAE,MAAM,CAAA;IAChB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,MAAM,EAAE,MAAM,CAAA;IACd,UAAU,EAAE,cAAc,EAAE,CAAA;CAC7B;AAED,MAAM,WAAW,kBAAmB,SAAQ,aAAa;IACvD,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;CAC3B;AAED,MAAM,WAAW,YAAY;IAC3B,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,MAAM,CAAA;IACf,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,eAAe;IAC9B,cAAc,EAAE,MAAM,CAAA;IACtB,UAAU,CAAC,EAAE;QACX,MAAM,EAAE,MAAM,CAAA;KACf,CAAA;IACD,QAAQ,EAAE,MAAM,CAAA;IAChB,gBAAgB,EAAE,OAAO,CAAA;IACzB,EAAE,EAAE,MAAM,CAAA;IACV,OAAO,EAAE,MAAM,EAAE,CAAA;IACjB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,YAAY,EAAE,OAAO,CAAA;IACrB,YAAY,EAAE,MAAM,CAAA;IACpB,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,MAAM,CAAA;IAChB,UAAU,EAAE,cAAc,EAAE,CAAA;CAC7B;AAED,MAAM,WAAW,cAAc;IAC7B,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,UAAU,GAAG,YAAY,CAAA;IAClC,OAAO,EAAE,MAAM,CAAA;IACf,SAAS,EAAE,MAAM,CAAA;CAClB;AAED,MAAM,WAAW,gBAAgB;IAC/B,gBAAgB,CAAC,EAAE,MAAM,CAAA;IACzB,aAAa,CAAC,EAAE,cAAc,EAAE,CAAA;IAChC,qBAAqB,EAAE,MAAM,CAAA;CAC9B"}

package/dist/docs-plugin.types.d.ts

@@ -0,0 +1,242 @@
+import type { QuiPropDeclaration, QuiPropTypes } from "@qualcomm-ui/typedoc-common";
+export interface PageHeading {
+    /**
+     * h1 is 1, h2 is 2, etc...
+     */
+    headingLevel: number;
+    /**
+     * Automatically generated, unique ID. Used to generate anchor links.
+     */
+    id: string;
+    /**
+     * Heading HTML tag.
+     */
+    tagName: string;
+    /**
+     * The text content of the heading.
+     */
+    textContent: string;
+}
+/**
+ * Page data, defined in each MDX file's {@link https://mdxjs.com/guides/frontmatter/ frontmatter} section.
+ *
+ * @docLink /api/page-frontmatter
+ *
+ * @public
+ */
+export interface PageFrontmatter {
+    /**
+     * Override the categories used to render the breadcrumb labels. Note that this
+     * will only match up to the length of the route's path segments. If a route only
+     * has 1 path segment, and you supply 2 categories, only the first category will be
+     * accounted for.
+     */
+    categories?: string[];
+    /**
+     * Used for grouping pages at the same level under a common section heading.
+     */
+    group?: string;
+    /**
+     * If true, this route will not be shown in the side navigation or adjacent
+     * routes' page links.
+     */
+    hidden?: boolean;
+    /**
+     * If true, the breadcrumbs will not render on this route.
+     */
+    hideBreadcrumbs?: boolean;
+    /**
+     * If true, this page's contents will not be added to the search index.
+     */
+    hideFromSearch?: boolean;
+    /**
+     * If true, the page links will be hidden on this route.
+     */
+    hidePageLinks?: boolean;
+    /**
+     * If true, the side navigation will be hidden on this route.
+     */
+    hideSideNav?: boolean;
+    /**
+     * If true, the table of contents be hidden on this route.
+     */
+    hideToc?: boolean;
+    /**
+     * Optional id. Used to associate the page with its entry in the _meta.json.
+     */
+    id?: string;
+    /**
+     * If `true`, the route will be flagged as restricted. This flag does nothing
+     * internally. You will need to handle this in your application.
+     */
+    restricted?: boolean;
+    /**
+     * Title for the page in the side nav. Takes precedence over {@link title}.
+     */
+    sideNavTitle?: string;
+    /**
+     * The title of the page.
+     */
+    title: string;
+}
+export interface PageSectionContent {
+    /**
+     * The tagName of the HTML section.
+     */
+    tagName: string;
+    /**
+     * The text paragraphs of the indexed section.
+     */
+    text: string[];
+}
+/**
+ * The data structure of each linkable entity in the search index.
+ *
+ * @public
+ */
+export interface PageSection extends PageFrontmatter {
+    /**
+     * The `Capital Case` transformed path segments.
+     */
+    categories: string[];
+    /**
+     * The text content of the indexed section.
+     */
+    content?: string;
+    /**
+     * The section content of the indexed section with a bit more metadata.
+     */
+    contentSections?: PageSectionContent[];
+    /**
+     * Text content of the {@link content}'s closest heading.
+     */
+    heading?: string;
+    /**
+     * Depth of the {@link content}'s closest heading.
+     */
+    headingLevel?: number;
+    /**
+     * The href to the page content with a # pointing to the nearest anchor tag.
+     */
+    href?: string;
+    /**
+     * The id of the page, typically the shortened filepath.
+     */
+    id: string;
+    /**
+     * For use with the experimental TypeDoc integration. If true, this content is
+     * part of a prop table.
+     */
+    isDocProp?: boolean;
+    /**
+     * The href to the page.
+     */
+    pathname: string;
+    /**
+     * The route path segments separated by `/`.
+     */
+    pathSegments: string[];
+    /**
+     * Page table of contents.
+     */
+    toc?: PageHeading[];
+}
+/**
+ * The PageMap is a record of the available routes in the application. Each key is
+ * the route's pathname.
+ *
+ * @public
+ */
+export type PageMap = Record<string, PageSection>;
+export interface NavItem {
+    /**
+     * The depth of the nav item. The root nav item starts at 1. Each child has n+1
+     * depth, where n is the depth of the parent item.
+     */
+    depth: number;
+    /**
+     * If `true`, the side nav item will be expanded on initial load. Does nothing if
+     * the entry is a page.
+     */
+    expanded?: boolean;
+    /**
+     * Used for grouping pages at the same level under a common section heading.
+     */
+    group?: string;
+    /**
+     * Path segment.
+     */
+    id: string;
+    items?: NavItem[];
+    /**
+     * The order of the item relative to other items at the same depth. If an item's
+     * order is not defined, it is unordered. Unordered items appear after ordered
+     * items. Unordered items are sorted alphabetically.
+     */
+    order?: number;
+    /**
+     * Pathname, only applicable to pages (not folders).
+     */
+    pathname?: string;
+    /**
+     * The route path segments.
+     */
+    pathSegments: string[];
+    /**
+     * Additional metadata to be used for filtering the nav tree.
+     */
+    searchMeta?: string[];
+    /**
+     * A label that renders above the item's content.
+     */
+    sectionTitle?: string;
+    /**
+     * Whether to render this item as a separator. If this property is supplied, a
+     * horizontal separator will be drawn and all content will be ignored.
+     */
+    separator?: boolean;
+    /**
+     * The title of the nav item, obtained from the _meta.json or the page's
+     * frontmatter.
+     */
+    title: string;
+}
+export type TocHeading = "h1" | "h2" | "h3" | "h4" | "h5" | "h6";
+export type PagePropType = QuiPropDeclaration & {
+    id: string;
+};
+export type PagePropTypes = QuiPropTypes & {
+    input?: PagePropType[] | undefined;
+    output?: PagePropType[] | undefined;
+    props?: PagePropType[] | undefined;
+    publicMethods?: PagePropType[] | undefined;
+};
+export type PageDocProps = Record<string, PagePropTypes>;
+export interface SiteData {
+    /**
+     * Nav items, typically used for the site's side navigation.
+     *
+     * @inheritDoc
+     */
+    navItems: NavItem[];
+    /**
+     * If QUI DocProps are detected on a page, they will be added to this array. The
+     * key is the route's pathname.
+     *
+     * @inheritDoc
+     */
+    pageDocProps?: PageDocProps;
+    /**
+     * The available routes in the application. Each key is
+     * the route's pathname.
+     *
+     * @inheritDoc
+     */
+    pageMap: PageMap;
+    /**
+     * A compiled array of page content, separated by each heading's individual
+     * segments of text content.
+     */
+    searchIndex: PageSection[];
+}
+//# sourceMappingURL=docs-plugin.types.d.ts.map

package/dist/docs-plugin.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"docs-plugin.types.d.ts","sourceRoot":"","sources":["../src/docs-plugin.types.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,kBAAkB,EAClB,YAAY,EACb,MAAM,6BAA6B,CAAA;AAEpC,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,YAAY,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;CACpB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,eAAe;IAC9B;;;;;OAKG;IACH,UAAU,CAAC,EAAE,MAAM,EAAE,CAAA;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;;OAGG;IACH,MAAM,CAAC,EAAE,OAAO,CAAA;IAEhB;;OAEG;IACH,eAAe,CAAC,EAAE,OAAO,CAAA;IAEzB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IAExB;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAA;IAEvB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAA;IAErB;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IAEjB;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAA;IAEX;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,IAAI,EAAE,MAAM,EAAE,CAAA;CACf;AAED;;;;GAIG;AACH,MAAM,WAAW,WAAY,SAAQ,eAAe;IAClD;;OAEG;IACH,UAAU,EAAE,MAAM,EAAE,CAAA;IAEpB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,eAAe,CAAC,EAAE,kBAAkB,EAAE,CAAA;IAEtC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;IAEnB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,YAAY,EAAE,MAAM,EAAE,CAAA;IAEtB;;OAEG;IACH,GAAG,CAAC,EAAE,WAAW,EAAE,CAAA;CACpB;AAED;;;;;GAKG;AACH,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;AAEjD,MAAM,WAAW,OAAO;IACtB;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAA;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV,KAAK,CAAC,EAAE,OAAO,EAAE,CAAA;IAEjB;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,YAAY,EAAE,MAAM,EAAE,CAAA;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,EAAE,CAAA;IAErB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;;OAGG;IACH,SAAS,CAAC,EAAE,OAAO,CAAA;IAEnB;;;OAGG;IACH,KAAK,EAAE,MAAM,CAAA;CACd;AAED,MAAM,MAAM,UAAU,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAA;AAEhE,MAAM,MAAM,YAAY,GAAG,kBAAkB,GAAG;IAAC,EAAE,EAAE,MAAM,CAAA;CAAC,CAAA;AAE5D,MAAM,MAAM,aAAa,GAAG,YAAY,GAAG;IACzC,KAAK,CAAC,EAAE,YAAY,EAAE,GAAG,SAAS,CAAA;IAClC,MAAM,CAAC,EAAE,YAAY,EAAE,GAAG,SAAS,CAAA;IACnC,KAAK,CAAC,EAAE,YAAY,EAAE,GAAG,SAAS,CAAA;IAClC,aAAa,CAAC,EAAE,YAAY,EAAE,GAAG,SAAS,CAAA;CAC3C,CAAA;AAED,MAAM,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAA;AAExD,MAAM,WAAW,QAAQ;IACvB;;;;OAIG;IACH,QAAQ,EAAE,OAAO,EAAE,CAAA;IAEnB;;;;;OAKG;IACH,YAAY,CAAC,EAAE,YAAY,CAAA;IAE3B;;;;;OAKG;IACH,OAAO,EAAE,OAAO,CAAA;IAEhB;;;OAGG;IACH,WAAW,EAAE,WAAW,EAAE,CAAA;CAC3B"}

package/dist/exports.d.ts

@@ -0,0 +1,2 @@
+export * from "@qualcomm-ui/typedoc-common";
+//# sourceMappingURL=exports.d.ts.map

package/dist/exports.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"exports.d.ts","sourceRoot":"","sources":["../src/exports.ts"],"names":[],"mappings":"AAGA,cAAc,6BAA6B,CAAA"}

package/dist/id-service/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./unique-id-service";
+//# sourceMappingURL=index.d.ts.map

package/dist/id-service/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/id-service/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAA"}

package/dist/id-service/unique-id-service.d.ts

@@ -0,0 +1,7 @@
+export declare class UniqueIdService {
+    pathname: string;
+    private idMap;
+    reset(): void;
+    add(idParam: string): string;
+}
+//# sourceMappingURL=unique-id-service.d.ts.map

package/dist/id-service/unique-id-service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"unique-id-service.d.ts","sourceRoot":"","sources":["../../src/id-service/unique-id-service.ts"],"names":[],"mappings":"AAGA,qBAAa,eAAe;IAC1B,QAAQ,EAAE,MAAM,CAAK;IACrB,OAAO,CAAC,KAAK,CAA6B;IAE1C,KAAK;IAIL,GAAG,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM;CAW7B"}

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+export type * from "./demo-plugin.types";
+export type * from "./docs-plugin.types";
+export * from "./id-service";
+export * from "./search";
+export * from "./shiki-themes";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,mBAAmB,qBAAqB,CAAA;AACxC,mBAAmB,qBAAqB,CAAA;AACxC,cAAc,cAAc,CAAA;AAC5B,cAAc,UAAU,CAAA;AACxB,cAAc,gBAAgB,CAAA"}