@limetech/kompendium 1.1.1

package/dist/collection/components/taglist/taglist.css

@@ -0,0 +1,58 @@
+:host {
+  isolation: isolate;
+  display: flex;
+  flex-direction: column;
+  align-items: flex-start;
+  gap: 0.5rem;
+  padding: 0.5rem 0 0 0;
+}
+
+.tag-list {
+  position: relative;
+  display: flex;
+  gap: 0.25rem;
+  align-items: center;
+  justify-content: center;
+  padding: 0.125rem 0.25rem 0.125rem 0.25rem;
+  border-radius: 0.25rem;
+}
+.tag-list:before, .tag-list:after {
+  content: "";
+  position: absolute;
+  inset: 0;
+  border-radius: inherit;
+  pointer-events: none;
+}
+.tag-list:before {
+  border: 1px dotted;
+  opacity: 0.4;
+}
+.tag-list:after {
+  background-color: currentColor;
+  opacity: 0.04;
+}
+.tag-list {
+  color: rgb(var(--kompendium-contrast-1100));
+}
+
+.tag--private {
+  color: rgb(var(--kompendium-color-orange-default));
+}
+
+.tag--beta {
+  color: rgb(var(--kompendium-color-blue-default));
+}
+
+.tag--deprecated {
+  color: rgb(var(--kompendium-color-red-default));
+}
+
+code {
+  font-family: var(--kompendium-font-code);
+  font-size: 0.75rem;
+}
+
+svg {
+  width: 0.75rem;
+  opacity: 0.7;
+}

package/dist/collection/components/taglist/taglist.js

@@ -0,0 +1,82 @@
+import { h } from "@stencil/core";
+/**
+ * asd
+ */
+export class Taglist {
+    constructor() {
+        /**
+         * Set to `true` if the list should be rendered in compact mode
+         */
+        this.compact = false;
+    }
+    render() {
+        return this.tags.map(this.renderTag);
+    }
+    renderTag(tag) {
+        const classList = {
+            'tag-list': true,
+        };
+        classList[`tag--${tag.name}`] = true;
+        return (h("div", { class: classList }, h("svg", { xmlns: "http://www.w3.org/2000/svg", viewBox: "0 0 24 24" }, h("path", { d: "M5 2h14a1 1 0 0 1 1 1v19.143a.5.5 0 0 1-.766.424L12 18.03l-7.234 4.536A.5.5 0 0 1 4 22.143V3a1 1 0 0 1 1-1z", fill: "currentColor" })), h("code", null, "@", tag.name), h("kompendium-markdown", { text: tag.text })));
+    }
+    static get is() { return "kompendium-taglist"; }
+    static get encapsulation() { return "shadow"; }
+    static get originalStyleUrls() {
+        return {
+            "$": ["taglist.scss"]
+        };
+    }
+    static get styleUrls() {
+        return {
+            "$": ["taglist.css"]
+        };
+    }
+    static get properties() {
+        return {
+            "tags": {
+                "type": "unknown",
+                "mutable": false,
+                "complexType": {
+                    "original": "JsonDocsTag[]",
+                    "resolved": "JsonDocsTag[]",
+                    "references": {
+                        "JsonDocsTag": {
+                            "location": "import",
+                            "path": "@stencil/core/internal",
+                            "id": "node_modules::JsonDocsTag"
+                        }
+                    }
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": "List of tags to render"
+                },
+                "getter": false,
+                "setter": false
+            },
+            "compact": {
+                "type": "boolean",
+                "mutable": false,
+                "complexType": {
+                    "original": "boolean",
+                    "resolved": "boolean",
+                    "references": {}
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": "Set to `true` if the list should be rendered in compact mode"
+                },
+                "getter": false,
+                "setter": false,
+                "reflect": false,
+                "attribute": "compact",
+                "defaultValue": "false"
+            }
+        };
+    }
+}
+//# sourceMappingURL=taglist.js.map

package/dist/collection/components/taglist/taglist.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"taglist.js","sourceRoot":"","sources":["../../../src/components/taglist/taglist.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,eAAe,CAAC;AAGnD;;GAEG;AAMH,MAAM,OAAO,OAAO;IALpB;QAYI;;WAEG;QAEI,YAAO,GAAG,KAAK,CAAC;KA0B1B;IAxBG,MAAM;QACF,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACzC,CAAC;IAEO,SAAS,CAAC,GAAgB;QAC9B,MAAM,SAAS,GAAG;YACd,UAAU,EAAE,IAAI;SACnB,CAAC;QAEF,SAAS,CAAC,QAAQ,GAAG,CAAC,IAAI,EAAE,CAAC,GAAG,IAAI,CAAC;QAErC,OAAO,CACH,WAAK,KAAK,EAAE,SAAS;YACjB,WAAK,KAAK,EAAC,4BAA4B,EAAC,OAAO,EAAC,WAAW;gBACvD,YACI,CAAC,EAAC,6GAA6G,EAC/G,IAAI,EAAC,cAAc,GACf,CACN;YACN;;gBAAQ,GAAG,CAAC,IAAI,CAAQ;YACxB,2BAAqB,IAAI,EAAE,GAAG,CAAC,IAAI,GAAI,CACrC,CACT,CAAC;IACN,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CACJ","sourcesContent":["import { Component, h, Prop } from '@stencil/core';\nimport { JsonDocsTag } from '@stencil/core/internal';\n\n/**\n * asd\n */\n@Component({\n    tag: 'kompendium-taglist',\n    shadow: true,\n    styleUrl: 'taglist.scss',\n})\nexport class Taglist {\n    /**\n     * List of tags to render\n     */\n    @Prop()\n    public tags: JsonDocsTag[];\n\n    /**\n     * Set to `true` if the list should be rendered in compact mode\n     */\n    @Prop()\n    public compact = false;\n\n    render(): HTMLElement[] {\n        return this.tags.map(this.renderTag);\n    }\n\n    private renderTag(tag: JsonDocsTag) {\n        const classList = {\n            'tag-list': true,\n        };\n\n        classList[`tag--${tag.name}`] = true;\n\n        return (\n            <div class={classList}>\n                <svg xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 24 24\">\n                    <path\n                        d=\"M5 2h14a1 1 0 0 1 1 1v19.143a.5.5 0 0 1-.766.424L12 18.03l-7.234 4.536A.5.5 0 0 1 4 22.143V3a1 1 0 0 1 1-1z\"\n                        fill=\"currentColor\"\n                    ></path>\n                </svg>\n                <code>@{tag.name}</code>\n                <kompendium-markdown text={tag.text} />\n            </div>\n        );\n    }\n}\n"]}

package/dist/collection/components/type/templates/alias.js

@@ -0,0 +1,11 @@
+import { h } from "@stencil/core";
+export function Alias({ type }) {
+    const alias = '`' + type.alias + '`';
+    return [
+        h("h1", { id: type.name }, type.name),
+        h("kompendium-markdown", { text: type.docs }),
+        h("kompendium-taglist", { tags: type.docsTags }),
+        h("kompendium-markdown", { text: alias }),
+    ];
+}
+//# sourceMappingURL=alias.js.map

package/dist/collection/components/type/templates/alias.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"alias.js","sourceRoot":"","sources":["../../../../src/components/type/templates/alias.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,eAAe,CAAC;AAGlC,MAAM,UAAU,KAAK,CAAC,EAAE,IAAI,EAA8B;IACtD,MAAM,KAAK,GAAG,GAAG,GAAG,IAAI,CAAC,KAAK,GAAG,GAAG,CAAC;IAErC,OAAO;QACH,UAAI,EAAE,EAAE,IAAI,CAAC,IAAI,IAAG,IAAI,CAAC,IAAI,CAAM;QACnC,2BAAqB,IAAI,EAAE,IAAI,CAAC,IAAI,GAAI;QACxC,0BAAoB,IAAI,EAAE,IAAI,CAAC,QAAQ,GAAI;QAC3C,2BAAqB,IAAI,EAAE,KAAK,GAAI;KACvC,CAAC;AACN,CAAC","sourcesContent":["import { h } from '@stencil/core';\nimport { AliasDescription } from '../../../types';\n\nexport function Alias({ type }: { type: AliasDescription }): HTMLElement[] {\n    const alias = '`' + type.alias + '`';\n\n    return [\n        <h1 id={type.name}>{type.name}</h1>,\n        <kompendium-markdown text={type.docs} />,\n        <kompendium-taglist tags={type.docsTags} />,\n        <kompendium-markdown text={alias} />,\n    ];\n}\n"]}

package/dist/collection/components/type/templates/enum.js

@@ -0,0 +1,25 @@
+import { h } from "@stencil/core";
+export function Enum({ type }) {
+    return [
+        h("h1", { id: type.name }, type.name),
+        h("kompendium-markdown", { text: type.docs }),
+        h("kompendium-taglist", { tags: type.docsTags }),
+        h(MemberList, { members: type.members }),
+    ];
+}
+function MemberList({ members }) {
+    if (!members.length) {
+        return;
+    }
+    return [h("h3", null, "Members"), ...members.map(renderMember)];
+}
+function renderMember(member) {
+    const items = [
+        {
+            key: 'Value',
+            value: member.value,
+        },
+    ];
+    return (h("div", null, h("h4", null, member.name), h("kompendium-markdown", { text: member.docs }), h("kompendium-taglist", { tags: member.docsTags }), h("kompendium-proplist", { items: items })));
+}
+//# sourceMappingURL=enum.js.map

package/dist/collection/components/type/templates/enum.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"enum.js","sourceRoot":"","sources":["../../../../src/components/type/templates/enum.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,eAAe,CAAC;AAIlC,MAAM,UAAU,IAAI,CAAC,EAAE,IAAI,EAA6B;IACpD,OAAO;QACH,UAAI,EAAE,EAAE,IAAI,CAAC,IAAI,IAAG,IAAI,CAAC,IAAI,CAAM;QACnC,2BAAqB,IAAI,EAAE,IAAI,CAAC,IAAI,GAAI;QACxC,0BAAoB,IAAI,EAAE,IAAI,CAAC,QAAQ,GAAI;QAC3C,EAAC,UAAU,IAAC,OAAO,EAAE,IAAI,CAAC,OAAO,GAAI;KACxC,CAAC;AACN,CAAC;AAED,SAAS,UAAU,CAAC,EAAE,OAAO,EAA6B;IACtD,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,CAAC;QAClB,OAAO;IACX,CAAC;IAED,OAAO,CAAC,wBAAgB,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,YAAY,CAAC,CAAC,CAAC;AAC5D,CAAC;AAED,SAAS,YAAY,CAAC,MAAkB;IACpC,MAAM,KAAK,GAAmB;QAC1B;YACI,GAAG,EAAE,OAAO;YACZ,KAAK,EAAE,MAAM,CAAC,KAAK;SACtB;KACJ,CAAC;IAEF,OAAO,CACH;QACI,cAAK,MAAM,CAAC,IAAI,CAAM;QACtB,2BAAqB,IAAI,EAAE,MAAM,CAAC,IAAI,GAAI;QAC1C,0BAAoB,IAAI,EAAE,MAAM,CAAC,QAAQ,GAAI;QAC7C,2BAAqB,KAAK,EAAE,KAAK,GAAI,CACnC,CACT,CAAC;AACN,CAAC","sourcesContent":["import { h } from '@stencil/core';\nimport { EnumDescription, EnumMember } from '../../../types';\nimport { ProplistItem } from '../../proplist/proplist';\n\nexport function Enum({ type }: { type: EnumDescription }): HTMLElement[] {\n    return [\n        <h1 id={type.name}>{type.name}</h1>,\n        <kompendium-markdown text={type.docs} />,\n        <kompendium-taglist tags={type.docsTags} />,\n        <MemberList members={type.members} />,\n    ];\n}\n\nfunction MemberList({ members }: { members: EnumMember[] }): HTMLElement[] {\n    if (!members.length) {\n        return;\n    }\n\n    return [<h3>Members</h3>, ...members.map(renderMember)];\n}\n\nfunction renderMember(member: EnumMember) {\n    const items: ProplistItem[] = [\n        {\n            key: 'Value',\n            value: member.value,\n        },\n    ];\n\n    return (\n        <div>\n            <h4>{member.name}</h4>\n            <kompendium-markdown text={member.docs} />\n            <kompendium-taglist tags={member.docsTags} />\n            <kompendium-proplist items={items} />\n        </div>\n    );\n}\n"]}

package/dist/collection/components/type/templates/interface.js

@@ -0,0 +1,13 @@
+import { h } from "@stencil/core";
+import { PropertyList } from "../../component/templates/props";
+import { MethodList } from "../../component/templates/methods";
+export function Interface({ type, }) {
+    return [
+        h("h1", { id: type.name }, type.name),
+        h("kompendium-markdown", { text: type.docs }),
+        h("kompendium-taglist", { tags: type.docsTags }),
+        h(PropertyList, { props: type.props }),
+        h(MethodList, { methods: type.methods }),
+    ];
+}
+//# sourceMappingURL=interface.js.map

package/dist/collection/components/type/templates/interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"interface.js","sourceRoot":"","sources":["../../../../src/components/type/templates/interface.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,eAAe,CAAC;AAElC,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAC/D,OAAO,EAAE,UAAU,EAAE,MAAM,mCAAmC,CAAC;AAE/D,MAAM,UAAU,SAAS,CAAC,EACtB,IAAI,GAGP;IACG,OAAO;QACH,UAAI,EAAE,EAAE,IAAI,CAAC,IAAI,IAAG,IAAI,CAAC,IAAI,CAAM;QACnC,2BAAqB,IAAI,EAAE,IAAI,CAAC,IAAI,GAAI;QACxC,0BAAoB,IAAI,EAAE,IAAI,CAAC,QAAQ,GAAI;QAC3C,EAAC,YAAY,IAAC,KAAK,EAAE,IAAI,CAAC,KAAK,GAAI;QACnC,EAAC,UAAU,IAAC,OAAO,EAAE,IAAI,CAAC,OAAO,GAAI;KACxC,CAAC;AACN,CAAC","sourcesContent":["import { h } from '@stencil/core';\nimport { InterfaceDescription } from '../../../types';\nimport { PropertyList } from '../../component/templates/props';\nimport { MethodList } from '../../component/templates/methods';\n\nexport function Interface({\n    type,\n}: {\n    type: InterfaceDescription;\n}): HTMLElement[] {\n    return [\n        <h1 id={type.name}>{type.name}</h1>,\n        <kompendium-markdown text={type.docs} />,\n        <kompendium-taglist tags={type.docsTags} />,\n        <PropertyList props={type.props} />,\n        <MethodList methods={type.methods} />,\n    ];\n}\n"]}

package/dist/collection/components/type/type.js

@@ -0,0 +1,97 @@
+import { h } from "@stencil/core";
+import { Interface } from "./templates/interface";
+import { Alias } from "./templates/alias";
+import { Enum } from "./templates/enum";
+export class Type {
+    componentWillRender() {
+        this.findType();
+    }
+    render() {
+        if (!this.type) {
+            return;
+        }
+        const type = this.type;
+        const componentMap = {
+            interface: Interface,
+            alias: Alias,
+            enum: Enum,
+            class: Interface,
+        };
+        const TypeComponent = componentMap[this.type.type];
+        return (h("article", { class: "type" }, h("section", { class: "docs" }, h(TypeComponent, { type: type }))));
+    }
+    findType() {
+        const type = this.types.find((type) => type.name === this.match.params.name);
+        if (type) {
+            this.type = type;
+        }
+    }
+    static get is() { return "kompendium-type"; }
+    static get encapsulation() { return "shadow"; }
+    static get originalStyleUrls() {
+        return {
+            "$": ["../component/component.scss"]
+        };
+    }
+    static get styleUrls() {
+        return {
+            "$": ["../component/component.css"]
+        };
+    }
+    static get properties() {
+        return {
+            "types": {
+                "type": "unknown",
+                "mutable": false,
+                "complexType": {
+                    "original": "TypeDescription[]",
+                    "resolved": "TypeDescription[]",
+                    "references": {
+                        "TypeDescription": {
+                            "location": "import",
+                            "path": "../../types",
+                            "id": "src/types.ts::TypeDescription"
+                        }
+                    }
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": ""
+                },
+                "getter": false,
+                "setter": false
+            },
+            "match": {
+                "type": "unknown",
+                "mutable": false,
+                "complexType": {
+                    "original": "MatchResults",
+                    "resolved": "MatchResults",
+                    "references": {
+                        "MatchResults": {
+                            "location": "import",
+                            "path": "@limetech/stencil-router",
+                            "id": "node_modules::MatchResults"
+                        }
+                    }
+                },
+                "required": false,
+                "optional": false,
+                "docs": {
+                    "tags": [],
+                    "text": "Matched route parameters"
+                },
+                "getter": false,
+                "setter": false
+            }
+        };
+    }
+    static get states() {
+        return {
+            "type": {}
+        };
+    }
+}
+//# sourceMappingURL=type.js.map

package/dist/collection/components/type/type.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"type.js","sourceRoot":"","sources":["../../../src/components/type/type.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,CAAC,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AAG1D,OAAO,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAClD,OAAO,EAAE,KAAK,EAAE,MAAM,mBAAmB,CAAC;AAC1C,OAAO,EAAE,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAOxC,MAAM,OAAO,IAAI;IAeN,mBAAmB;QACtB,IAAI,CAAC,QAAQ,EAAE,CAAC;IACpB,CAAC;IAED,MAAM;QACF,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YACb,OAAO;QACX,CAAC;QAED,MAAM,IAAI,GAAQ,IAAI,CAAC,IAAI,CAAC;QAC5B,MAAM,YAAY,GAAqC;YACnD,SAAS,EAAE,SAAS;YACpB,KAAK,EAAE,KAAK;YACZ,IAAI,EAAE,IAAI;YACV,KAAK,EAAE,SAAS;SACnB,CAAC;QACF,MAAM,aAAa,GAAG,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAEnD,OAAO,CACH,eAAS,KAAK,EAAC,MAAM;YACjB,eAAS,KAAK,EAAC,MAAM;gBACjB,EAAC,aAAa,IAAC,IAAI,EAAE,IAAI,GAAI,CACvB,CACJ,CACb,CAAC;IACN,CAAC;IAEO,QAAQ;QACZ,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CACxB,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CACjD,CAAC;QAEF,IAAI,IAAI,EAAE,CAAC;YACP,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACrB,CAAC;IACL,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CACJ","sourcesContent":["import { Component, h, Prop, State } from '@stencil/core';\nimport { TypeDescription, TypeDescriptionType } from '../../types';\nimport { MatchResults } from '@limetech/stencil-router';\nimport { Interface } from './templates/interface';\nimport { Alias } from './templates/alias';\nimport { Enum } from './templates/enum';\n\n@Component({\n    tag: 'kompendium-type',\n    shadow: true,\n    styleUrl: '../component/component.scss',\n})\nexport class Type {\n    /**\n     */\n    @Prop()\n    public types: TypeDescription[];\n\n    /**\n     * Matched route parameters\n     */\n    @Prop()\n    public match: MatchResults;\n\n    @State()\n    private type: TypeDescription;\n\n    public componentWillRender(): void {\n        this.findType();\n    }\n\n    render(): HTMLElement {\n        if (!this.type) {\n            return;\n        }\n\n        const type: any = this.type;\n        const componentMap: Record<TypeDescriptionType, any> = {\n            interface: Interface,\n            alias: Alias,\n            enum: Enum,\n            class: Interface,\n        };\n        const TypeComponent = componentMap[this.type.type];\n\n        return (\n            <article class=\"type\">\n                <section class=\"docs\">\n                    <TypeComponent type={type} />\n                </section>\n            </article>\n        );\n    }\n\n    private findType() {\n        const type = this.types.find(\n            (type) => type.name === this.match.params.name,\n        );\n\n        if (type) {\n            this.type = type;\n        }\n    }\n}\n"]}

package/dist/collection/index.js

@@ -0,0 +1,4 @@
+export * from './components';
+import "@limetech/stencil-router";
+export * from './types';
+//# sourceMappingURL=index.js.map

package/dist/collection/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,OAAO,0BAA0B,CAAC;AAClC,cAAc,SAAS,CAAC","sourcesContent":["export * from './components';\nimport '@limetech/stencil-router';\nexport * from './types';\nimport { KompendiumConfig } from './types';\nexport declare const kompendium: (\n    config?: Partial<KompendiumConfig>,\n) => ((docs: any) => Promise<void>) | (() => any);\n"]}

package/dist/collection/kompendium/config.js

@@ -0,0 +1,7 @@
+export const defaultConfig = {
+    path: '.kompendium',
+    publicPath: 'www',
+    typeRoot: './src/types.ts',
+    guides: [],
+};
+//# sourceMappingURL=config.js.map

package/dist/collection/kompendium/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/kompendium/config.ts"],"names":[],"mappings":"AAEA,MAAM,CAAC,MAAM,aAAa,GAAqB;IAC3C,IAAI,EAAE,aAAa;IACnB,UAAU,EAAE,KAAK;IACjB,QAAQ,EAAE,gBAAgB;IAC1B,MAAM,EAAE,EAAE;CACb,CAAC","sourcesContent":["import { KompendiumConfig } from '../types';\n\nexport const defaultConfig: KompendiumConfig = {\n    path: '.kompendium',\n    publicPath: 'www',\n    typeRoot: './src/types.ts',\n    guides: [],\n};\n"]}

package/dist/collection/kompendium/filesystem.js

@@ -0,0 +1,9 @@
+import { access, constants } from "fs";
+export function exists(path) {
+    return new Promise((resolve) => {
+        access(path, constants.F_OK, (error) => {
+            resolve(!error);
+        });
+    });
+}
+//# sourceMappingURL=filesystem.js.map

package/dist/collection/kompendium/filesystem.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"filesystem.js","sourceRoot":"","sources":["../../src/kompendium/filesystem.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,IAAI,CAAC;AAEvC,MAAM,UAAU,MAAM,CAAC,IAAY;IAC/B,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;QAC3B,MAAM,CAAC,IAAI,EAAE,SAAS,CAAC,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE;YACnC,OAAO,CAAC,CAAC,KAAK,CAAC,CAAC;QACpB,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACP,CAAC","sourcesContent":["import { access, constants } from 'fs';\n\nexport function exists(path: string): Promise<boolean> {\n    return new Promise((resolve) => {\n        access(path, constants.F_OK, (error) => {\n            resolve(!error);\n        });\n    });\n}\n"]}

package/dist/collection/kompendium/generator.js

@@ -0,0 +1,217 @@
+import { defaultConfig } from "./config";
+import { addSources } from "./source";
+import lnk from "lnk";
+import { createMenu } from "./menu";
+import { copyFile, mkdir, readFile, stat, writeFile } from "fs/promises";
+import { exists } from "./filesystem";
+import { createWatcher } from "./watch";
+import { findGuides } from "./guides";
+import { parseFile } from "./typedoc";
+import { createSchemas } from "./schema";
+import { createIndex } from "./search";
+export const kompendium = (config = {}) => {
+    if (!generateDocs()) {
+        return () => null;
+    }
+    return kompendiumGenerator(config);
+};
+let logger;
+export function kompendiumGenerator(config) {
+    config = {
+        ...defaultConfig,
+        ...config,
+    };
+    initialize(config);
+    return async (docs, stencilConfig) => {
+        logger = stencilConfig.logger;
+        const timeSpan = logger.createTimeSpan('kompendium started');
+        const [jsonDocs, title, readme, guides, types] = await Promise.all([
+            addSources(docs),
+            getProjectTitle(config),
+            getReadme(),
+            findGuides(config),
+            getTypes(config, stencilConfig.tsconfig),
+        ]);
+        const data = {
+            docs: jsonDocs,
+            title: title,
+            logo: config.logo,
+            menu: createMenu(docs, guides, types),
+            readme: readme,
+            guides: guides,
+            types: types,
+            schemas: createSchemas(docs.components, types),
+            index: null,
+        };
+        data.index = createIndex(data);
+        await writeData(config, data);
+        timeSpan.finish('kompendium finished');
+    };
+}
+async function initialize(config) {
+    const path = `${config.publicPath}/kompendium.json`;
+    if (isWatcher()) {
+        createWatcher(path, 'unlink', onUnlink(config));
+    }
+    await createOutputDirs(config);
+}
+const onUnlink = (config) => () => {
+    createSymlink(config);
+};
+async function createSymlink(config) {
+    const source = `${config.path}/kompendium.json`;
+    const target = `${config.publicPath}/kompendium.json`;
+    if (!(await exists(source))) {
+        return;
+    }
+    if (await exists(target)) {
+        return;
+    }
+    lnk([source], config.publicPath);
+}
+async function getProjectTitle(config) {
+    if (config.title) {
+        return config.title;
+    }
+    const json = await readFile('./package.json', 'utf8');
+    const data = JSON.parse(json);
+    return data.name
+        .replace(/^@[^/]+?\//, '')
+        .split('-')
+        .join(' ');
+}
+async function writeData(config, data) {
+    // Always write to the kompendium config folder (typically `.kompendium` in
+    // the root of the project) to avoid Stencil deleting the file during build.
+    const filePath = `${config.path}/kompendium.json`;
+    await writeFile(filePath, JSON.stringify(data), 'utf8');
+    if (isProd()) {
+        // In production, we used to write the kompendium.json file to the
+        // public path. We now copy the file to the public path for backwards
+        // compatibility with projects that do not have problems with Stencil
+        // deleting the file during build. For projects that do have this
+        // problem, they can always copy the file from the config folder.
+        const publicFilePath = `${config.publicPath}/kompendium.json`;
+        if (!(await exists(config.publicPath))) {
+            await mkdir(config.publicPath, { recursive: true });
+        }
+        await copyFile(filePath, publicFilePath);
+    }
+    if (isWatcher()) {
+        createSymlink(config);
+    }
+}
+async function createOutputDirs(config) {
+    let path = config.path;
+    if (!(await exists(path))) {
+        mkdir(path, { recursive: true });
+    }
+    path = config.publicPath;
+    if (!(await exists(path))) {
+        mkdir(path, { recursive: true });
+    }
+}
+async function getReadme() {
+    const files = ['readme.md', 'README.md', 'README', 'readme'];
+    let data = null;
+    for (const file of files) {
+        if (data) {
+            continue;
+        }
+        if (!(await exists(file))) {
+            continue;
+        }
+        data = await readFile(file, 'utf8');
+    }
+    if (!data) {
+        logger.warn('README did not exist');
+    }
+    return data;
+}
+function generateDocs() {
+    return !!process.argv.includes('--docs');
+}
+function isWatcher() {
+    return !!process.argv.includes('--watch');
+}
+function isProd() {
+    return !(process.argv.includes('--dev') ||
+        process.argv.includes('test') ||
+        process.argv.find((arg) => arg.includes('jest-worker')));
+}
+async function getTypes(config, tsconfig) {
+    logger.debug('Getting type information...');
+    let types = await readTypes(config);
+    const cache = await readCache(config);
+    if (types.length === 0 || (await isModified(types, cache))) {
+        logger.debug('Parsing types...');
+        const data = parseFile(config.typeRoot, tsconfig);
+        await saveData(config, data);
+        types = data;
+    }
+    return types;
+}
+async function isModified(types, cache) {
+    if (Object.keys(cache).length === 0) {
+        return true;
+    }
+    const filenames = getUniqueSourceFilenames(types);
+    const stats = await Promise.all(filenames.map(tryStatFile));
+    return stats.some((fileStat, index) => hasFileChangedSinceCached(filenames[index], fileStat, cache));
+}
+function getUniqueSourceFilenames(types) {
+    const filenames = types.map((t) => t.sources).flat();
+    return [...new Set(filenames)];
+}
+function tryStatFile(filename) {
+    return stat(filename).catch(() => null);
+}
+function hasFileChangedSinceCached(filename, fileStat, cache) {
+    if (!fileStat) {
+        logger.debug(`${filename} cannot be accessed, marking as modified`);
+        return true;
+    }
+    const result = cache[filename] !== fileStat.mtimeMs;
+    logger.debug(`${filename} was ${result ? '' : 'not'} modified!`);
+    return result;
+}
+async function saveData(config, types) {
+    const filenames = getUniqueSourceFilenames(types);
+    const stats = await Promise.all(filenames.map(tryStatFile));
+    const cache = buildCacheFromFileStats(filenames, stats);
+    await Promise.all([writeCache(config, cache), writeTypes(config, types)]);
+}
+function buildCacheFromFileStats(filenames, stats) {
+    const cache = {};
+    stats.forEach((fileStat, index) => {
+        if (fileStat) {
+            cache[filenames[index]] = fileStat.mtimeMs;
+        }
+    });
+    return cache;
+}
+async function readCache(config) {
+    try {
+        const data = await readFile(`${config.path}/cache.json`, 'utf8');
+        return JSON.parse(data);
+    }
+    catch (_a) {
+        return {};
+    }
+}
+async function writeCache(config, data) {
+    await writeFile(`${config.path}/cache.json`, JSON.stringify(data), 'utf8');
+}
+async function readTypes(config) {
+    try {
+        const data = await readFile(`${config.path}/types.json`, 'utf8');
+        return JSON.parse(data);
+    }
+    catch (_a) {
+        return [];
+    }
+}
+async function writeTypes(config, data) {
+    await writeFile(`${config.path}/types.json`, JSON.stringify(data), 'utf8');
+}
+//# sourceMappingURL=generator.js.map

package/dist/collection/kompendium/generator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generator.js","sourceRoot":"","sources":["../../src/kompendium/generator.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AACtC,OAAO,GAAG,MAAM,KAAK,CAAC;AACtB,OAAO,EAAE,UAAU,EAAE,MAAM,QAAQ,CAAC;AACpC,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AACzE,OAAO,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AACtC,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AACxC,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAEtC,OAAO,EAAE,SAAS,EAAE,MAAM,WAAW,CAAC;AACtC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAEvC,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,SAAoC,EAAE,EAAE,EAAE;IACjE,IAAI,CAAC,YAAY,EAAE,EAAE,CAAC;QAClB,OAAO,GAAG,EAAE,CAAC,IAAI,CAAC;IACtB,CAAC;IAED,OAAO,mBAAmB,CAAC,MAAM,CAAC,CAAC;AACvC,CAAC,CAAC;AAEF,IAAI,MAAc,CAAC;AAEnB,MAAM,UAAU,mBAAmB,CAC/B,MAAiC;IAEjC,MAAM,GAAG;QACL,GAAG,aAAa;QAChB,GAAG,MAAM;KACZ,CAAC;IACF,UAAU,CAAC,MAAM,CAAC,CAAC;IAEnB,OAAO,KAAK,EAAE,IAAc,EAAE,aAAqB,EAAE,EAAE;QACnD,MAAM,GAAG,aAAa,CAAC,MAAM,CAAC;QAC9B,MAAM,QAAQ,GAAG,MAAM,CAAC,cAAc,CAAC,oBAAoB,CAAC,CAAC;QAE7D,MAAM,CAAC,QAAQ,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,KAAK,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YAC/D,UAAU,CAAC,IAAI,CAAC;YAChB,eAAe,CAAC,MAAM,CAAC;YACvB,SAAS,EAAE;YACX,UAAU,CAAC,MAAM,CAAC;YAClB,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC,QAAQ,CAAC;SAC3C,CAAC,CAAC;QAEH,MAAM,IAAI,GAAmB;YACzB,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,KAAK;YACZ,IAAI,EAAE,MAAM,CAAC,IAAI;YACjB,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,CAAC;YACrC,MAAM,EAAE,MAAM;YACd,MAAM,EAAE,MAAM;YACd,KAAK,EAAE,KAAK;YACZ,OAAO,EAAE,aAAa,CAAC,IAAI,CAAC,UAAU,EAAE,KAAK,CAAC;YAC9C,KAAK,EAAE,IAAI;SACd,CAAC;QAEF,IAAI,CAAC,KAAK,GAAG,WAAW,CAAC,IAAI,CAAC,CAAC;QAE/B,MAAM,SAAS,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QAE9B,QAAQ,CAAC,MAAM,CAAC,qBAAqB,CAAC,CAAC;IAC3C,CAAC,CAAC;AACN,CAAC;AAED,KAAK,UAAU,UAAU,CAAC,MAAiC;IACvD,MAAM,IAAI,GAAG,GAAG,MAAM,CAAC,UAAU,kBAAkB,CAAC;IAEpD,IAAI,SAAS,EAAE,EAAE,CAAC;QACd,aAAa,CAAC,IAAI,EAAE,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;IACpD,CAAC;IAED,MAAM,gBAAgB,CAAC,MAAM,CAAC,CAAC;AACnC,CAAC;AAED,MAAM,QAAQ,GAAG,CAAC,MAAiC,EAAE,EAAE,CAAC,GAAG,EAAE;IACzD,aAAa,CAAC,MAAM,CAAC,CAAC;AAC1B,CAAC,CAAC;AAEF,KAAK,UAAU,aAAa,CAAC,MAAiC;IAC1D,MAAM,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,kBAAkB,CAAC;IAChD,MAAM,MAAM,GAAG,GAAG,MAAM,CAAC,UAAU,kBAAkB,CAAC;IAEtD,IAAI,CAAC,CAAC,MAAM,MAAM,CAAC,MAAM,CAAC,CAAC,EAAE,CAAC;QAC1B,OAAO;IACX,CAAC;IAED,IAAI,MAAM,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;QACvB,OAAO;IACX,CAAC;IAED,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,UAAU,CAAC,CAAC;AACrC,CAAC;AAED,KAAK,UAAU,eAAe,CAC1B,MAAiC;IAEjC,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;QACf,OAAO,MAAM,CAAC,KAAK,CAAC;IACxB,CAAC;IAED,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,gBAAgB,EAAE,MAAM,CAAC,CAAC;IACtD,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAE9B,OAAO,IAAI,CAAC,IAAI;SACX,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC;SACzB,KAAK,CAAC,GAAG,CAAC;SACV,IAAI,CAAC,GAAG,CAAC,CAAC;AACnB,CAAC;AAED,KAAK,UAAU,SAAS,CACpB,MAAiC,EACjC,IAAoB;IAEpB,2EAA2E;IAC3E,4EAA4E;IAC5E,MAAM,QAAQ,GAAG,GAAG,MAAM,CAAC,IAAI,kBAAkB,CAAC;IAElD,MAAM,SAAS,CAAC,QAAQ,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC;IAExD,IAAI,MAAM,EAAE,EAAE,CAAC;QACX,kEAAkE;QAClE,qEAAqE;QACrE,qEAAqE;QACrE,iEAAiE;QACjE,iEAAiE;QACjE,MAAM,cAAc,GAAG,GAAG,MAAM,CAAC,UAAU,kBAAkB,CAAC;QAC9D,IAAI,CAAC,CAAC,MAAM,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC;YACrC,MAAM,KAAK,CAAC,MAAM,CAAC,UAAU,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;QACxD,CAAC;QAED,MAAM,QAAQ,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;IAC7C,CAAC;IAED,IAAI,SAAS,EAAE,EAAE,CAAC;QACd,aAAa,CAAC,MAAM,CAAC,CAAC;IAC1B,CAAC;AACL,CAAC;AAED,KAAK,UAAU,gBAAgB,CAAC,MAAiC;IAC7D,IAAI,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;IACvB,IAAI,CAAC,CAAC,MAAM,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;QACxB,KAAK,CAAC,IAAI,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACrC,CAAC;IAED,IAAI,GAAG,MAAM,CAAC,UAAU,CAAC;IACzB,IAAI,CAAC,CAAC,MAAM,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;QACxB,KAAK,CAAC,IAAI,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC;IACrC,CAAC;AACL,CAAC;AAED,KAAK,UAAU,SAAS;IACpB,MAAM,KAAK,GAAG,CAAC,WAAW,EAAE,WAAW,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;IAC7D,IAAI,IAAI,GAAG,IAAI,CAAC;IAEhB,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;QACvB,IAAI,IAAI,EAAE,CAAC;YACP,SAAS;QACb,CAAC;QAED,IAAI,CAAC,CAAC,MAAM,MAAM,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;YACxB,SAAS;QACb,CAAC;QAED,IAAI,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACxC,CAAC;IAED,IAAI,CAAC,IAAI,EAAE,CAAC;QACR,MAAM,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC;IACxC,CAAC;IAED,OAAO,IAAI,CAAC;AAChB,CAAC;AAED,SAAS,YAAY;IACjB,OAAO,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;AAC7C,CAAC;AAED,SAAS,SAAS;IACd,OAAO,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;AAC9C,CAAC;AAED,SAAS,MAAM;IACX,OAAO,CAAC,CACJ,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC;QAC9B,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;QAC7B,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC,CAC1D,CAAC;AACN,CAAC;AAED,KAAK,UAAU,QAAQ,CACnB,MAAiC,EACjC,QAAiB;IAEjB,MAAM,CAAC,KAAK,CAAC,6BAA6B,CAAC,CAAC;IAC5C,IAAI,KAAK,GAAG,MAAM,SAAS,CAAC,MAAM,CAAC,CAAC;IACpC,MAAM,KAAK,GAAG,MAAM,SAAS,CAAC,MAAM,CAAC,CAAC;IAEtC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,IAAI,CAAC,MAAM,UAAU,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC,EAAE,CAAC;QACzD,MAAM,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;QACjC,MAAM,IAAI,GAAG,SAAS,CAAC,MAAM,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;QAClD,MAAM,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QAC7B,KAAK,GAAG,IAAI,CAAC;IACjB,CAAC;IAED,OAAO,KAAK,CAAC;AACjB,CAAC;AAED,KAAK,UAAU,UAAU,CAAC,KAAY,EAAE,KAA6B;IACjE,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAClC,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,MAAM,SAAS,GAAG,wBAAwB,CAAC,KAAK,CAAC,CAAC;IAClD,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC;IAE5D,OAAO,KAAK,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,KAAK,EAAE,EAAE,CAClC,yBAAyB,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,QAAQ,EAAE,KAAK,CAAC,CAC/D,CAAC;AACN,CAAC;AAED,SAAS,wBAAwB,CAAC,KAAY;IAC1C,MAAM,SAAS,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC;IAErD,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC;AACnC,CAAC;AAED,SAAS,WAAW,CAAC,QAAgB;IACjC,OAAO,IAAI,CAAC,QAAQ,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,CAAC;AAC5C,CAAC;AAED,SAAS,yBAAyB,CAC9B,QAAgB,EAChB,QAAiD,EACjD,KAA6B;IAE7B,IAAI,CAAC,QAAQ,EAAE,CAAC;QACZ,MAAM,CAAC,KAAK,CAAC,GAAG,QAAQ,0CAA0C,CAAC,CAAC;QAEpE,OAAO,IAAI,CAAC;IAChB,CAAC;IAED,MAAM,MAAM,GAAG,KAAK,CAAC,QAAQ,CAAC,KAAK,QAAQ,CAAC,OAAO,CAAC;IAEpD,MAAM,CAAC,KAAK,CAAC,GAAG,QAAQ,QAAQ,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,YAAY,CAAC,CAAC;IAEjE,OAAO,MAAM,CAAC;AAClB,CAAC;AAED,KAAK,UAAU,QAAQ,CACnB,MAAiC,EACjC,KAAwB;IAExB,MAAM,SAAS,GAAG,wBAAwB,CAAC,KAAK,CAAC,CAAC;IAClD,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC;IAC5D,MAAM,KAAK,GAAG,uBAAuB,CAAC,SAAS,EAAE,KAAK,CAAC,CAAC;IAExD,MAAM,OAAO,CAAC,GAAG,CAAC,CAAC,UAAU,CAAC,MAAM,EAAE,KAAK,CAAC,EAAE,UAAU,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC;AAC9E,CAAC;AAED,SAAS,uBAAuB,CAC5B,SAAmB,EACnB,KAAqD;IAErD,MAAM,KAAK,GAA2B,EAAE,CAAC;IAEzC,KAAK,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,KAAK,EAAE,EAAE;QAC9B,IAAI,QAAQ,EAAE,CAAC;YACX,KAAK,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,GAAG,QAAQ,CAAC,OAAO,CAAC;QAC/C,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,OAAO,KAAK,CAAC;AACjB,CAAC;AAED,KAAK,UAAU,SAAS,CAAC,MAAiC;IACtD,IAAI,CAAC;QACD,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,GAAG,MAAM,CAAC,IAAI,aAAa,EAAE,MAAM,CAAC,CAAC;QAEjE,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAAC,WAAM,CAAC;QACL,OAAO,EAAE,CAAC;IACd,CAAC;AACL,CAAC;AAED,KAAK,UAAU,UAAU,CAAC,MAAiC,EAAE,IAAS;IAClE,MAAM,SAAS,CAAC,GAAG,MAAM,CAAC,IAAI,aAAa,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC;AAC/E,CAAC;AAED,KAAK,UAAU,SAAS,CAAC,MAAiC;IACtD,IAAI,CAAC;QACD,MAAM,IAAI,GAAG,MAAM,QAAQ,CAAC,GAAG,MAAM,CAAC,IAAI,aAAa,EAAE,MAAM,CAAC,CAAC;QAEjE,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAC5B,CAAC;IAAC,WAAM,CAAC;QACL,OAAO,EAAE,CAAC;IACd,CAAC;AACL,CAAC;AAED,KAAK,UAAU,UAAU,CAAC,MAAiC,EAAE,IAAS;IAClE,MAAM,SAAS,CAAC,GAAG,MAAM,CAAC,IAAI,aAAa,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,CAAC;AAC/E,CAAC","sourcesContent":["import { JsonDocs, Config, Logger } from '@stencil/core/internal';\nimport { defaultConfig } from './config';\nimport { addSources } from './source';\nimport lnk from 'lnk';\nimport { createMenu } from './menu';\nimport { copyFile, mkdir, readFile, stat, writeFile } from 'fs/promises';\nimport { exists } from './filesystem';\nimport { createWatcher } from './watch';\nimport { findGuides } from './guides';\nimport { KompendiumConfig, KompendiumData, TypeDescription } from '../types';\nimport { parseFile } from './typedoc';\nimport { createSchemas } from './schema';\nimport { createIndex } from './search';\n\nexport const kompendium = (config: Partial<KompendiumConfig> = {}) => {\n    if (!generateDocs()) {\n        return () => null;\n    }\n\n    return kompendiumGenerator(config);\n};\n\nlet logger: Logger;\n\nexport function kompendiumGenerator(\n    config: Partial<KompendiumConfig>,\n): (docs: JsonDocs, stencilConfig: Config) => Promise<void> {\n    config = {\n        ...defaultConfig,\n        ...config,\n    };\n    initialize(config);\n\n    return async (docs: JsonDocs, stencilConfig: Config) => {\n        logger = stencilConfig.logger;\n        const timeSpan = logger.createTimeSpan('kompendium started');\n\n        const [jsonDocs, title, readme, guides, types] = await Promise.all([\n            addSources(docs),\n            getProjectTitle(config),\n            getReadme(),\n            findGuides(config),\n            getTypes(config, stencilConfig.tsconfig),\n        ]);\n\n        const data: KompendiumData = {\n            docs: jsonDocs,\n            title: title,\n            logo: config.logo,\n            menu: createMenu(docs, guides, types),\n            readme: readme,\n            guides: guides,\n            types: types,\n            schemas: createSchemas(docs.components, types),\n            index: null,\n        };\n\n        data.index = createIndex(data);\n\n        await writeData(config, data);\n\n        timeSpan.finish('kompendium finished');\n    };\n}\n\nasync function initialize(config: Partial<KompendiumConfig>) {\n    const path = `${config.publicPath}/kompendium.json`;\n\n    if (isWatcher()) {\n        createWatcher(path, 'unlink', onUnlink(config));\n    }\n\n    await createOutputDirs(config);\n}\n\nconst onUnlink = (config: Partial<KompendiumConfig>) => () => {\n    createSymlink(config);\n};\n\nasync function createSymlink(config: Partial<KompendiumConfig>) {\n    const source = `${config.path}/kompendium.json`;\n    const target = `${config.publicPath}/kompendium.json`;\n\n    if (!(await exists(source))) {\n        return;\n    }\n\n    if (await exists(target)) {\n        return;\n    }\n\n    lnk([source], config.publicPath);\n}\n\nasync function getProjectTitle(\n    config: Partial<KompendiumConfig>,\n): Promise<string> {\n    if (config.title) {\n        return config.title;\n    }\n\n    const json = await readFile('./package.json', 'utf8');\n    const data = JSON.parse(json);\n\n    return data.name\n        .replace(/^@[^/]+?\\//, '')\n        .split('-')\n        .join(' ');\n}\n\nasync function writeData(\n    config: Partial<KompendiumConfig>,\n    data: KompendiumData,\n) {\n    // Always write to the kompendium config folder (typically `.kompendium` in\n    // the root of the project) to avoid Stencil deleting the file during build.\n    const filePath = `${config.path}/kompendium.json`;\n\n    await writeFile(filePath, JSON.stringify(data), 'utf8');\n\n    if (isProd()) {\n        // In production, we used to write the kompendium.json file to the\n        // public path. We now copy the file to the public path for backwards\n        // compatibility with projects that do not have problems with Stencil\n        // deleting the file during build. For projects that do have this\n        // problem, they can always copy the file from the config folder.\n        const publicFilePath = `${config.publicPath}/kompendium.json`;\n        if (!(await exists(config.publicPath))) {\n            await mkdir(config.publicPath, { recursive: true });\n        }\n\n        await copyFile(filePath, publicFilePath);\n    }\n\n    if (isWatcher()) {\n        createSymlink(config);\n    }\n}\n\nasync function createOutputDirs(config: Partial<KompendiumConfig>) {\n    let path = config.path;\n    if (!(await exists(path))) {\n        mkdir(path, { recursive: true });\n    }\n\n    path = config.publicPath;\n    if (!(await exists(path))) {\n        mkdir(path, { recursive: true });\n    }\n}\n\nasync function getReadme(): Promise<string> {\n    const files = ['readme.md', 'README.md', 'README', 'readme'];\n    let data = null;\n\n    for (const file of files) {\n        if (data) {\n            continue;\n        }\n\n        if (!(await exists(file))) {\n            continue;\n        }\n\n        data = await readFile(file, 'utf8');\n    }\n\n    if (!data) {\n        logger.warn('README did not exist');\n    }\n\n    return data;\n}\n\nfunction generateDocs(): boolean {\n    return !!process.argv.includes('--docs');\n}\n\nfunction isWatcher(): boolean {\n    return !!process.argv.includes('--watch');\n}\n\nfunction isProd(): boolean {\n    return !(\n        process.argv.includes('--dev') ||\n        process.argv.includes('test') ||\n        process.argv.find((arg) => arg.includes('jest-worker'))\n    );\n}\n\nasync function getTypes(\n    config: Partial<KompendiumConfig>,\n    tsconfig?: string,\n): Promise<TypeDescription[]> {\n    logger.debug('Getting type information...');\n    let types = await readTypes(config);\n    const cache = await readCache(config);\n\n    if (types.length === 0 || (await isModified(types, cache))) {\n        logger.debug('Parsing types...');\n        const data = parseFile(config.typeRoot, tsconfig);\n        await saveData(config, data);\n        types = data;\n    }\n\n    return types;\n}\n\nasync function isModified(types: any[], cache: Record<string, number>) {\n    if (Object.keys(cache).length === 0) {\n        return true;\n    }\n\n    const filenames = getUniqueSourceFilenames(types);\n    const stats = await Promise.all(filenames.map(tryStatFile));\n\n    return stats.some((fileStat, index) =>\n        hasFileChangedSinceCached(filenames[index], fileStat, cache),\n    );\n}\n\nfunction getUniqueSourceFilenames(types: any[]): string[] {\n    const filenames = types.map((t) => t.sources).flat();\n\n    return [...new Set(filenames)];\n}\n\nfunction tryStatFile(filename: string) {\n    return stat(filename).catch(() => null);\n}\n\nfunction hasFileChangedSinceCached(\n    filename: string,\n    fileStat: Awaited<ReturnType<typeof stat>> | null,\n    cache: Record<string, number>,\n): boolean {\n    if (!fileStat) {\n        logger.debug(`${filename} cannot be accessed, marking as modified`);\n\n        return true;\n    }\n\n    const result = cache[filename] !== fileStat.mtimeMs;\n\n    logger.debug(`${filename} was ${result ? '' : 'not'} modified!`);\n\n    return result;\n}\n\nasync function saveData(\n    config: Partial<KompendiumConfig>,\n    types: TypeDescription[],\n) {\n    const filenames = getUniqueSourceFilenames(types);\n    const stats = await Promise.all(filenames.map(tryStatFile));\n    const cache = buildCacheFromFileStats(filenames, stats);\n\n    await Promise.all([writeCache(config, cache), writeTypes(config, types)]);\n}\n\nfunction buildCacheFromFileStats(\n    filenames: string[],\n    stats: Array<Awaited<ReturnType<typeof stat>> | null>,\n): Record<string, number> {\n    const cache: Record<string, number> = {};\n\n    stats.forEach((fileStat, index) => {\n        if (fileStat) {\n            cache[filenames[index]] = fileStat.mtimeMs;\n        }\n    });\n\n    return cache;\n}\n\nasync function readCache(config: Partial<KompendiumConfig>) {\n    try {\n        const data = await readFile(`${config.path}/cache.json`, 'utf8');\n\n        return JSON.parse(data);\n    } catch {\n        return {};\n    }\n}\n\nasync function writeCache(config: Partial<KompendiumConfig>, data: any) {\n    await writeFile(`${config.path}/cache.json`, JSON.stringify(data), 'utf8');\n}\n\nasync function readTypes(config: Partial<KompendiumConfig>) {\n    try {\n        const data = await readFile(`${config.path}/types.json`, 'utf8');\n\n        return JSON.parse(data);\n    } catch {\n        return [];\n    }\n}\n\nasync function writeTypes(config: Partial<KompendiumConfig>, data: any) {\n    await writeFile(`${config.path}/types.json`, JSON.stringify(data), 'utf8');\n}\n"]}

package/dist/collection/kompendium/guides.js

@@ -0,0 +1,30 @@
+import { basename, dirname, resolve } from "path";
+import { readFile } from "fs/promises";
+export async function findGuides(config) {
+    const nodes = config.guides.map(createMenuNode('/')).flat();
+    const promises = nodes.map(createGuide);
+    return Promise.all(promises);
+}
+export const createMenuNode = (path) => (guide) => {
+    if (typeof guide !== 'string') {
+        const newPath = path + guide.name + '/';
+        return guide.children.map(createMenuNode(newPath)).flat();
+    }
+    return {
+        menupath: path,
+        filepath: guide,
+    };
+};
+export const createGuide = async ({ menupath: path, filepath, }) => {
+    const content = await readFile(filepath, 'utf8');
+    return {
+        dirPath: dirname(filepath),
+        fileName: basename(filepath),
+        filePath: resolve(filepath),
+        data: {
+            path: path + basename(filepath),
+        },
+        content: content,
+    };
+};
+//# sourceMappingURL=guides.js.map

package/dist/collection/kompendium/guides.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"guides.js","sourceRoot":"","sources":["../../src/kompendium/guides.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAClD,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAGvC,MAAM,CAAC,KAAK,UAAU,UAAU,CAC5B,MAAiC;IAEjC,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IAC5D,MAAM,QAAQ,GAAG,KAAK,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;IAExC,OAAO,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC;AACjC,CAAC;AAOD,MAAM,CAAC,MAAM,cAAc,GACvB,CAAC,IAAY,EAAE,EAAE,CACjB,CAAC,KAAY,EAAyB,EAAE;IACpC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC5B,MAAM,OAAO,GAAG,IAAI,GAAG,KAAK,CAAC,IAAI,GAAG,GAAG,CAAC;QAExC,OAAO,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;IAC9D,CAAC;IAED,OAAO;QACH,QAAQ,EAAE,IAAI;QACd,QAAQ,EAAE,KAAK;KAClB,CAAC;AACN,CAAC,CAAC;AAEN,MAAM,CAAC,MAAM,WAAW,GAAG,KAAK,EAAE,EAC9B,QAAQ,EAAE,IAAI,EACd,QAAQ,GACD,EAA4B,EAAE;IACrC,MAAM,OAAO,GAAG,MAAM,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;IAEjD,OAAO;QACH,OAAO,EAAE,OAAO,CAAC,QAAQ,CAAC;QAC1B,QAAQ,EAAE,QAAQ,CAAC,QAAQ,CAAC;QAC5B,QAAQ,EAAE,OAAO,CAAC,QAAQ,CAAC;QAC3B,IAAI,EAAE;YACF,IAAI,EAAE,IAAI,GAAG,QAAQ,CAAC,QAAQ,CAAC;SAClC;QACD,OAAO,EAAE,OAAO;KACnB,CAAC;AACN,CAAC,CAAC","sourcesContent":["import { basename, dirname, resolve } from 'path';\nimport { readFile } from 'fs/promises';\nimport { KompendiumGuide, KompendiumConfig, Guide } from '../types';\n\nexport async function findGuides(\n    config: Partial<KompendiumConfig>,\n): Promise<KompendiumGuide[]> {\n    const nodes = config.guides.map(createMenuNode('/')).flat();\n    const promises = nodes.map(createGuide);\n\n    return Promise.all(promises);\n}\n\ninterface MenuNode {\n    menupath: string;\n    filepath: string;\n}\n\nexport const createMenuNode =\n    (path: string) =>\n    (guide: Guide): MenuNode | MenuNode[] => {\n        if (typeof guide !== 'string') {\n            const newPath = path + guide.name + '/';\n\n            return guide.children.map(createMenuNode(newPath)).flat();\n        }\n\n        return {\n            menupath: path,\n            filepath: guide,\n        };\n    };\n\nexport const createGuide = async ({\n    menupath: path,\n    filepath,\n}: MenuNode): Promise<KompendiumGuide> => {\n    const content = await readFile(filepath, 'utf8');\n\n    return {\n        dirPath: dirname(filepath),\n        fileName: basename(filepath),\n        filePath: resolve(filepath),\n        data: {\n            path: path + basename(filepath),\n        },\n        content: content,\n    };\n};\n"]}