@limetech/kompendium 1.1.1

package/dist/types/types.d.ts

@@ -0,0 +1,119 @@
+import { JsonDocs, JsonDocsTag, JsonDocsProp, JsonDocsMethod, JsonDocMethodParameter } from './stencil-public-runtime';
+export interface KompendiumConfig {
+    /**
+     * Output path
+     */
+    path: string;
+    /**
+     * www
+     */
+    publicPath: string;
+    /**
+     * Title to display in the header
+     */
+    title?: string;
+    /**
+     * Logo to display of the title in the header
+     */
+    logo?: string;
+    typeRoot: string;
+    guides: Guide[];
+}
+export type Guide = string | {
+    name: string;
+    children: Guide[];
+};
+export interface MenuItem {
+    title?: string;
+    path: string;
+    icon?: string;
+    children?: MenuItem[];
+}
+export interface KompendiumData {
+    title: string;
+    logo?: string;
+    docs: JsonDocs;
+    menu: MenuItem[];
+    readme?: string;
+    guides: KompendiumGuide[];
+    types: TypeDescription[];
+    schemas: Array<Record<string, any>>;
+    index: {
+        documents: KompendiumDocument[];
+        data: any;
+    };
+}
+export interface KompendiumDocument {
+    tags?: string[];
+    title: string;
+    path: string;
+    text: string | string[];
+    props?: Array<{
+        name: string;
+        text: string;
+        tags: string[];
+        type: string;
+    }>;
+    events?: Array<{
+        name: string;
+        text: string;
+        tags: string[];
+        type: string;
+    }>;
+}
+export interface KompendiumGuide {
+    dirPath?: string;
+    fileName?: string;
+    filePath?: string;
+    data: Record<string, any>;
+    content: string;
+}
+export type TypeDescriptionType = 'interface' | 'alias' | 'enum' | 'class';
+export interface TypeDescription {
+    type: TypeDescriptionType;
+    name: string;
+    docs: string;
+    docsTags: JsonDocsTag[];
+    sources: string[];
+}
+export interface InterfaceDescription extends TypeDescription {
+    type: 'interface';
+    typeParams: TypeParam[];
+    props: Array<Partial<JsonDocsProp>>;
+    methods: MethodDescription[];
+}
+export interface ClassDescription extends TypeDescription {
+    type: 'class';
+    typeParams: TypeParam[];
+    props: Array<Partial<JsonDocsProp>>;
+    methods: MethodDescription[];
+    decorators: DecoratorDescription[];
+}
+export interface TypeParam {
+    name: string;
+}
+export interface AliasDescription extends TypeDescription {
+    type: 'alias';
+    alias: string;
+}
+export interface EnumDescription extends TypeDescription {
+    type: 'enum';
+    members: EnumMember[];
+}
+export interface EnumMember {
+    name: string;
+    docs: string;
+    docsTags: JsonDocsTag[];
+    value: string;
+}
+export interface MethodDescription extends Partial<JsonDocsMethod> {
+    parameters: ParameterDescription[];
+}
+export interface ParameterDescription extends JsonDocMethodParameter {
+    default: string;
+    optional: boolean;
+}
+export interface DecoratorDescription {
+    name: string;
+    arguments: any;
+}

package/dist/watch.ts

@@ -0,0 +1,14 @@
+import chokidar from 'chokidar';
+import nodeCleanup from 'node-cleanup';
+
+export function createWatcher(
+    path: string,
+    type: string,
+    callback: (...args: any[]) => void,
+): void {
+    const watcher = chokidar.watch(path).on(type, callback);
+
+    nodeCleanup(async () => {
+        await watcher.close();
+    });
+}

package/loader/cdn.js

@@ -0,0 +1 @@
+module.exports = require('../dist/cjs/loader.cjs.js');

package/loader/index.cjs.js

@@ -0,0 +1 @@
+module.exports = require('../dist/cjs/loader.cjs.js');

package/loader/index.d.ts

@@ -0,0 +1,24 @@
+export * from '../dist/types/components';
+export interface CustomElementsDefineOptions {
+  exclude?: string[];
+  resourcesUrl?: string;
+  syncQueue?: boolean;
+  jmp?: (c: Function) => any;
+  raf?: (c: FrameRequestCallback) => number;
+  ael?: (el: EventTarget, eventName: string, listener: EventListenerOrEventListenerObject, options: boolean | AddEventListenerOptions) => void;
+  rel?: (el: EventTarget, eventName: string, listener: EventListenerOrEventListenerObject, options: boolean | AddEventListenerOptions) => void;
+}
+export declare function defineCustomElements(win?: Window, opts?: CustomElementsDefineOptions): void;
+/**
+ * @deprecated
+ */
+export declare function applyPolyfills(): Promise<void>;
+
+/**
+ * Used to specify a nonce value that corresponds with an application's CSP.
+ * When set, the nonce will be added to all dynamically created script and style tags at runtime.
+ * Alternatively, the nonce value can be set on a meta tag in the DOM head
+ * (<meta name="csp-nonce" content="{ nonce value here }" />) which
+ * will result in the same behavior.
+ */
+export declare function setNonce(nonce: string): void;

package/loader/index.es2017.js

@@ -0,0 +1 @@
+export * from '../dist/esm/loader.js';

package/loader/index.js

@@ -0,0 +1,2 @@
+(function(){if("undefined"!==typeof window&&void 0!==window.Reflect&&void 0!==window.customElements){var a=HTMLElement;window.HTMLElement=function(){return Reflect.construct(a,[],this.constructor)};HTMLElement.prototype=a.prototype;HTMLElement.prototype.constructor=HTMLElement;Object.setPrototypeOf(HTMLElement,a)}})();
+export * from '../dist/esm/loader.js';

package/package.json

@@ -0,0 +1,116 @@
+{
+  "name": "@limetech/kompendium",
+  "version": "1.1.1",
+  "description": "Documentation generator for Stencil components",
+  "keywords": [
+    "stencil",
+    "documentation",
+    "webcomponents",
+    "kompendium",
+    "typescript"
+  ],
+  "homepage": "https://github.com/Lundalogik/kompendium",
+  "bugs": {
+    "url": "https://github.com/Lundalogik/kompendium/issues"
+  },
+  "license": "MIT",
+  "author": {
+    "name": "Johan Groth",
+    "email": "hello@kompendium.dev",
+    "url": "https://kompendium.dev"
+  },
+  "contributors": [
+    {
+      "name": "Kiarokh Moattar"
+    }
+  ],
+  "main": "dist/index.ts",
+  "module": "dist/index.mjs",
+  "es2015": "dist/esm/index.mjs",
+  "es2017": "dist/esm/index.mjs",
+  "types": "dist/types/index.d.ts",
+  "collection": "dist/collection/collection-manifest.json",
+  "collection:main": "dist/collection/index.js",
+  "unpkg": "dist/kompendium/kompendium.js",
+  "files": [
+    "dist/",
+    "loader/"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "stencil build --docs",
+    "postbuild": "copyfiles -f src/kompendium/*.ts dist",
+    "start": "stencil build --dev --watch --serve --docs",
+    "dev": "stencil build --dev --docs",
+    "test": "stencil test --spec",
+    "test:watch": "stencil test --spec --watchAll",
+    "generate": "stencil generate",
+    "semantic-release": "semantic-release",
+    "update-changelog": "node scripts/update-changelog",
+    "lint": "npm run lint:src && npm run lint:scss",
+    "lint:fix": "npm run lint:src:fix && npm run lint:scss:fix",
+    "lint:prod": "npm run lint:src:prod && npm run lint:scss:prod",
+    "lint:src": "eslint \"**/*.{ts,tsx,js,mjs}\" --max-warnings=0 && prettier -l \"{!(package*).json,.prettierrc}\"",
+    "lint:src:fix": "eslint \"**/*.{ts,tsx,j,mjs}\" --fix --max-warnings=0 && prettier --write \"{!(package*).json,.prettierrc}\"",
+    "lint:src:prod": "eslint \"**/*.{ts,tsx,js,mjs}\" --rule \"linebreak-style: [error, unix]\" --max-warnings=0 && prettier -l \"{!(package*).json,.prettierrc}\"",
+    "lint:scss": "prettier -c --ignore-path ./.gitignore **/*.scss",
+    "lint:scss:fix": "prettier --write --ignore-path ./.gitignore **/*.scss",
+    "lint:scss:prod": "prettier -c --end-of-line lf --ignore-path ./.gitignore **/*.scss"
+  },
+  "devDependencies": {
+    "@eslint/eslintrc": "^3.1.0",
+    "@eslint/js": "^9.8.0",
+    "@limetech/stencil-router": "^1.0.1",
+    "@stencil/core": "4.38.0",
+    "@stencil/sass": "3.2.2",
+    "@types/jest": "^25.2.3",
+    "@types/prismjs": "^1.16.5",
+    "@typescript-eslint/eslint-plugin": "^8.0.0",
+    "@typescript-eslint/parser": "^8.0.0",
+    "copyfiles": "^2.3.0",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "^9.1.0",
+    "eslint-plugin-jsdoc": "^48.11.0",
+    "eslint-plugin-prefer-arrow": "^1.2.3",
+    "eslint-plugin-prettier": "^5.2.1",
+    "eslint-plugin-react": "^7.35.0",
+    "eslint-plugin-sonarjs": "^0.25.1",
+    "globals": "^15.9.0",
+    "jest": "^29.7.0",
+    "jest-cli": "^29.7.0",
+    "prettier": "^3.3.3",
+    "prismjs": "^1.30.0",
+    "puppeteer": "^22.15.0",
+    "rollup-plugin-polyfill-node": "^0.13.0",
+    "tmp": "^0.2.5",
+    "typescript": "^4.9.5",
+    "yargs": "^15.4.0"
+  },
+  "dependencies": {
+    "chokidar": "^3.3.1",
+    "fuse.js": "^6.4.6",
+    "glob": "^7.1.6",
+    "lnk": "^1.1.0",
+    "lodash": "^4.17.23",
+    "node-cleanup": "^2.1.2",
+    "rehype-raw": "^7.0.0",
+    "rehype-slug": "^6.0.0",
+    "rehype-stringify": "^10.0.1",
+    "remark-directive": "^3.0.1",
+    "remark-frontmatter": "^5.0.0",
+    "remark-gfm": "^4.0.1",
+    "remark-parse": "^11.0.0",
+    "remark-rehype": "^11.1.2",
+    "typedoc": "^0.23.28",
+    "unified": "^11.0.5",
+    "unist-util-map": "^4.0.0",
+    "unist-util-visit": "^5.1.0",
+    "yaml": "^2.8.3"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Lundalogik/kompendium.git"
+  }
+}