npm - @forsakringskassan/docs-generator - Versions diffs - 1.24.0 - Mend

@forsakringskassan/docs-generator 1.24.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (36) hide show

package/LICENSE.md +24 -0
package/README.md +311 -0
package/dist/compile-example.js +13406 -0
package/dist/generator.d.ts +512 -0
package/dist/generator.js +84168 -0
package/dist/markdown.d.ts +243 -0
package/dist/markdown.js +19369 -0
package/dist/runtime.d.ts +1 -0
package/dist/runtime.js +206572 -0
package/dist/style/core.css +840 -0
package/dist/style/index.css +927 -0
package/dist/style/site.css +86 -0
package/dist/tsdoc-metadata.json +11 -0
package/package.json +68 -0
package/templates/base.template.html +132 -0
package/templates/component.template.html +28 -0
package/templates/content-with-menu.template.html +15 -0
package/templates/content-without-menu.template.html +10 -0
package/templates/default.template.html +10 -0
package/templates/example.template.html +70 -0
package/templates/json.template.json +1 -0
package/templates/macro/menu.html +39 -0
package/templates/partials/footer.html +3 -0
package/templates/partials/header.html +14 -0
package/templates/partials/livereload.html +1 -0
package/templates/partials/matomo.html +29 -0
package/templates/partials/search-dialog.html +25 -0
package/templates/partials/search-toolbar.html +9 -0
package/templates/partials/selectable-version.html +28 -0
package/templates/partials/spritesheet.html +44 -0
package/templates/partials/theme-select.html +68 -0
package/templates/partials/topnav.html +22 -0
package/templates/partials/version-banner.html +14 -0
package/templates/partials/version.html +3 -0
package/templates/pattern.template.html +19 -0
package/tsconfig-examples.json +9 -0

package/dist/generator.d.ts ADDED Viewed

@@ -0,0 +1,512 @@
+import { Component } from 'vue';
+/** @public */
+export declare type AttributeTable = Record<string, AttributeValue>;
+/** @public */
+export declare type AttributeValue = string | number | boolean | null | {
+    [key: string]: AttributeValue;
+};
+/**
+ * @public
+ */
+export declare interface CompileOptions {
+    /**
+     * Automatically inject this asset in the html template.
+     *
+     * - `head` - the asset is injected in `<head>`
+     * - `body` - the asset is injected in `<body>`
+     * - `none` (default) - the asset is not injected.
+     */
+    appendTo: "none" | "head" | "body";
+    /**
+     * Extra attributes to include in the `<link>` or `<script>` tag.
+     */
+    attributes: AttributeTable;
+}
+/**
+ * @public
+ */
+declare interface Document_2 {
+    /** unique identifier for this document */
+    id: string;
+    /** human-readable pseudo-identifier for this document (consider it unique but there is no contraint enforcing this) */
+    name: string;
+    /** alternative names this document can be referenced by */
+    alias: string[];
+    /** true if document should be visible in menu and similar sources */
+    visible: boolean;
+    attributes: NormalizedDocumentAttributes;
+    body: string;
+    /** Document outline (i.e. the heading structure) */
+    outline: DocumentOutline;
+    /** format of body */
+    format: "markdown" | "html" | "json";
+    tags: string[];
+    template: string;
+    fileInfo: FileInfo;
+}
+export { Document_2 as Document }
+/**
+ * @public
+ */
+export declare type DocumentBadge = "success" | "error" | "info";
+/**
+ * Represents a document outline (i.e. the heading structure).
+ *
+ * @public
+ */
+export declare type DocumentOutline = DocumentOutlineEntry[];
+/**
+ * Represents a single heading (and its subheadings) in a document outline.
+ *
+ * @public
+ */
+export declare interface DocumentOutlineEntry {
+    /** Heading title */
+    title: string;
+    /** Heading rank, e.g. `##` (h2) is rank 2 */
+    rank: number;
+    /** Heading anchor (id or name attribute) */
+    anchor: string;
+    /** Subheadings */
+    subheadings: DocumentOutline;
+}
+/**
+ * @public
+ */
+export declare interface FileInfo {
+    /** path relative to configured base */
+    path: string;
+    /** filename without extension */
+    name: string;
+    /** path relative to project root */
+    fullPath: string;
+    /** output filename or `false` to disable writing result to a file */
+    outputName: string | false;
+}
+/**
+ * Read and parse a file from disk to a doc-generator document.
+ *
+ * @public
+ */
+declare type FileReader_2 = (filePath: string, basePath?: string) => Promise<Document_2[]>;
+export { FileReader_2 as FileReader }
+/**
+ * Read a Markdown file with Front Matter.
+ *
+ * @public
+ */
+export declare function frontMatterFileReader(filePath: string, basePath?: string): Promise<Document_2[]>;
+/**
+ * @public
+ */
+declare class Generator_2 {
+    private site;
+    private outputFolder;
+    private cacheFolder;
+    private assetFolder;
+    private exampleFolders;
+    private templateFolders;
+    private processors;
+    private vendor;
+    private setupPath;
+    private scripts;
+    private styles;
+    private resources;
+    private sourceFiles;
+    constructor(options: GeneratorOptions);
+    compileScript(name: string, src: string | string[], options?: Partial<CompileOptions>): void;
+    compileStyle(name: string, src: string, options?: Partial<CompileOptions>): void;
+    /**
+     * @param dst - Destination directory relative to asset folder.
+     * @param src - File or directory to copy.
+     */
+    copyResource(dst: string, src: string): void;
+    build(sourceFiles: SourceFiles[]): Promise<string[]>;
+    /**
+     * Start a development server hosting the generated documentation.
+     */
+    serve(): Promise<void>;
+    private _prepareFolders;
+}
+export { Generator_2 as Generator }
+/**
+ * @public
+ */
+export declare interface GeneratorOptions {
+    /** Site options */
+    site: GeneratorSiteOptions;
+    outputFolder: string;
+    cacheFolder: string;
+    /** List of folders to search when locating examples (searched recursively) */
+    exampleFolders: string[];
+    /** List of folders to search when locating templates. */
+    templateFolders?: string[];
+    /** List of extra processors to run */
+    processors?: Processor[];
+    /** List of vendor assets to compile */
+    vendor?: VendorDefinition[];
+    /** Path to file with exported `setup` function, responsible for mounting of component.
+     * `function setup(options: { rootComponent: string, selector: string }): void`
+     */
+    setupPath: string;
+}
+/**
+ * @public
+ */
+export declare interface GeneratorSiteOptions {
+    /** Site name */
+    name: string;
+    /** Site languange (BCP-47, e.g. `en` or `sv`), default `en` */
+    lang?: string;
+}
+/**
+ * @public
+ */
+export declare function livereloadProcessor(options: ProcessorOptions): Processor;
+/**
+ * @public
+ */
+export declare interface MatomoOptions {
+    /** Matomo Site ID */
+    siteId: string;
+    /** Matomo API URL */
+    apiUrl: string;
+    /** Matomo Tracker URL */
+    trackerUrl: string;
+    /** Site hostname (analytics will be disabled if the hostname of the running
+     * site does not match one of the configured hostnames) */
+    hostname?: string | string[];
+}
+/**
+ * @public
+ */
+export declare function matomoProcessor(options: MatomoOptions & ProcessorOptions): Processor;
+/**
+ * Read a JSON file with arbitrary navigation entries.
+ *
+ * @public
+ */
+export declare function navigationFileReader(filePath: string, basePath?: string): Promise<Document_2[]>;
+/**
+ * @public
+ */
+export declare interface NavigationLeaf {
+    readonly title: string;
+    readonly path: string;
+    readonly sortorder: number;
+    readonly id: string;
+    readonly external: boolean;
+}
+/**
+ * @public
+ */
+export declare type NavigationNode = NavigationLeaf | NavigationSection;
+/**
+ * @public
+ */
+export declare interface NavigationSection {
+    readonly key: string;
+    readonly title: string;
+    readonly path: string;
+    readonly sortorder: number;
+    readonly children: NavigationNode[];
+}
+/**
+ * @public
+ */
+export declare interface NormalizedDocumentAttributes {
+    title?: string;
+    layout?: string;
+    status?: string;
+    badge?: DocumentBadge;
+    component?: string[];
+    href?: string;
+    /** normalized sortorder (defaults to Infinity) */
+    sortorder: number;
+}
+/**
+ * @public
+ */
+export declare type Processor = ProcessorDescriptor<"before"> | ProcessorDescriptor<"stage"> | ProcessorDescriptor<"after">;
+/**
+ * @public
+ */
+export declare interface ProcessorContext {
+    readonly docs: Document_2[];
+    readonly vendors: VendorAsset[];
+    readonly topnav: NavigationSection;
+    readonly sidenav: NavigationSection;
+    readonly resources: ResourceTask[];
+    addDocument(document: Document_2 | Document_2[]): void;
+    addVendorAsset(asset: VendorAsset | VendorAsset[]): void;
+    /**
+     * Add a new resource asset to be copied.
+     *
+     * @param dst - Destination directory relative to asset folder.
+     * @param src - File or directory to copy.
+     */
+    addResource(dst: string, src: string): void;
+    /**
+     * Add a new block to be rendered in the template.
+     *
+     * @param container - The template container to add the block to. The
+     * container must exist in the template or nothing will be rendered.
+     * @param id - A unique identifier for this block.
+     * @param renderer - Describes how to render the block content.
+     */
+    addTemplateBlock(container: string, id: string, renderer: TemplateBlockRenderer): void;
+    /* Excluded from this release type: getAllTemplateBlocks */
+    setTopNavigation(root: NavigationSection): void;
+    setSideNavigation(root: NavigationSection): void;
+    getAllTemplateData(): Record<string, unknown>;
+    getTemplateData<K extends keyof TemplateData>(key: K): TemplateData[K] | undefined;
+    getTemplateData(key: string): unknown;
+    setTemplateData<K extends keyof TemplateData>(key: string, value: TemplateData[K]): void;
+    setTemplateData(key: string, value: unknown): void;
+    log<TArgs extends unknown[]>(...args: TArgs): void;
+}
+/**
+ * @public
+ */
+export declare type ProcessorDescriptor<K extends "before" | "stage" | "after"> = ProcessorHook<K> & ProcessorHandler;
+/**
+ * @public
+ */
+export declare interface ProcessorHandler {
+    before?: ProcessorStage;
+    stage?: ProcessorStage;
+    after?: ProcessorStage;
+    name: string;
+    enabled?: boolean;
+    handler(context: ProcessorContext): void | string[] | Promise<void> | Promise<string[]>;
+}
+/**
+ * @public
+ */
+export declare type ProcessorHook<K extends "before" | "stage" | "after"> = {
+    [k in K]: ProcessorStage;
+};
+/**
+ * @public
+ */
+export declare interface ProcessorOptions {
+    /** Enable/disable processor. Default: `true` */
+    enabled?: boolean;
+}
+/**
+ * @public
+ */
+export declare type ProcessorStage = "generate-docs" | "generate-nav" | "assets" | "render";
+/**
+ * Represents a resource to be copied from `from` to `to`.
+ *
+ * @public
+ */
+export declare interface ResourceTask {
+    from: string;
+    to: string;
+}
+/**
+ * @public
+ */
+export declare function searchProcessor(): Processor;
+/**
+ * Make it possible to change version.
+ *
+ * @public
+ */
+export declare function selectableVersionProcessor(pkg: {
+    name: string;
+    version: string;
+}, container: string): Processor;
+/**
+ * Options passed from the example compiler to the `setup` function.
+ *
+ * @public
+ */
+export declare interface SetupOptions {
+    /** The example component expected to be mounted by the application */
+    rootComponent: Component;
+    /** Where the example should be mounted */
+    selector: string;
+}
+/**
+ * @public
+ */
+export declare interface SourceFiles {
+    include: string | string[];
+    exclude?: string | string[];
+    basePath?: string;
+    fileReader: FileReader_2;
+    /**
+     * Transform document before further processing.
+     *
+     * Typical use-case is modifying attributes, name or aliases.
+     */
+    transform?(doc: Document_2): Document_2;
+}
+/* Excluded from this release type: TemplateBlockData */
+/**
+ * Template block renderer.
+ *
+ * - If you pass a filename the filename will be rendered with the templating engine.
+ * - If you pass a function the returned markup will be injected into the rendered template.
+ *
+ * @public
+ */
+export declare type TemplateBlockRenderer = {
+    filename: string;
+    data?: Record<string, unknown>;
+} | {
+    render(): string;
+};
+/**
+ * @public
+ */
+export declare interface TemplateData {
+}
+/**
+ * Injects a theme selector into the toolbar.
+ *
+ * @public
+ */
+export declare function themeSelectProcessor(): Processor;
+/**
+ * Represents a compiled vendor asset.
+ *
+ * @public
+ */
+export declare interface VendorAsset {
+    package: string;
+    /** Filename of the asset */
+    filename: string;
+    /** Public path to the asset (including filename) */
+    publicPath: string;
+    /** Subresource integrity */
+    integrity: string;
+    /** size of asset in bytes */
+    size: number;
+}
+/**
+ * @public
+ */
+export declare type VendorDefinition = string | VendorDefinitionDescriptor;
+/**
+ * Describes a vendor assets to be bundled and globally available on the site.
+ *
+ * @public
+ */
+export declare interface VendorDefinitionDescriptor {
+    /**
+     * Importabe package name or path.
+     */
+    package: string;
+    /**
+     * If set, the package will be available on `window` under the given
+     * name. Requires the `export` property to be set to have any effect.
+     */
+    global?: string;
+    /**
+     * If set this bundle will be exposed for usage with `require(..)` and if
+     * `global` is defined on the `window` object.
+     *
+     * When set to "named" the named exports will be exposed.
+     * When set to "default" the default export will be exposed.
+     */
+    expose?: "named" | "default";
+    /**
+     * Optional list of additional subpaths to export from the package.
+     *
+     * E.g.:
+     *
+     * ```json
+     * {
+     *   "package": "moment",
+     *   "expose": "default",
+     *   "subpaths": [
+     *     "moment/locale/sv"
+     *   ]
+     * }
+     * ```
+     */
+    subpaths?: string[];
+    /**
+     * Optional alias for package name or path.
+     * When an alias is given the package can be imported using the given alias as well as the original package name.
+     * For instance, when using the following configuration "vue" can be imported and resolved as "vue/dist/esm.bundle.js".
+     * ```json
+     * {
+     *   "package": "vue",
+     *   "alias": "vue/dist/esm.bundle.js",
+     * }
+     * ```
+     */
+    alias?: string;
+}
+/**
+ * Display a banner with message when path dosen't start with /latest.
+ * @param message - Message to display in banner, may contain html-template.
+ *
+ * @public
+ */
+export declare function versionBannerProcessor(message: string, container: string): Processor;
+/**
+ * Injects the package name and version into the document.
+ *
+ * @public
+ */
+export declare function versionProcessor(pkg: {
+    name: string;
+    version: string;
+}, container: string): Processor;
+/**
+ * Generate API documentation from a Vue SFC.
+ *
+ * @public
+ */
+export declare function vueFileReader(filePath: string): Promise<Document_2[]>;
+export { }