@mathstack/app-kit 0.0.1-beta.0 → 0.0.1-beta.1

package/lib/documentation-display/documentation-config-parser.d.ts

@@ -1,41 +0,0 @@
-import * as i0 from "@angular/core";
-export interface AdkNestedObject {
-    [key: string]: string | AdkNestedObject;
-}
-export interface AdkDocumentationNavigationSiblings {
-    previous: string | undefined;
-    next: string | undefined;
-}
-export declare class AdkDocumentationConfigParser {
-    basePath: string;
-    /**
-     * This method takes a path from the application and a configuration object, and returns a path to a file that will be fetched.
-     *
-     * This assumes that the pathFromApp matches a path through the keys of the Nested Object.
-     *
-     * If the path is 'viz/content/items/bars', the config object might look like this:
-     * viz: {
-     *   content: {
-     *     items: {
-     *       bars: 'bars.md'
-     *     }
-     *   }
-     * }
-     *
-     * @param pathFromApp a string representing the path from the application, for example 'viz/content/items/bars'
-     * @param config a nested object representing the configuration
-     * @returns a string representing the file path
-     */
-    getPathToFile(pathFromApp: string, config: AdkNestedObject, basePath: string): string;
-    /**
-     *
-     * @param pathParts a string array of path parts, for example ['viz', 'content', 'items', 'bars]
-     * @param config a nested object representing the configuration
-     * @returns a string representing the file name
-     */
-    private getFileNameFromPath;
-    findPreviousAndNextByPath(obj: AdkNestedObject, targetPath: string): AdkDocumentationNavigationSiblings;
-    flattenObjectWithPath(obj: AdkNestedObject, prefix?: string): string[];
-    static ɵfac: i0.ɵɵFactoryDeclaration<AdkDocumentationConfigParser, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<AdkDocumentationConfigParser>;
-}

package/lib/documentation-display/documentation-content-service.d.ts

@@ -1,50 +0,0 @@
-import { Observable } from 'rxjs';
-import { AdkAssetsService } from '../assets/assets-service';
-import { AdkMarkdownParser, AdkMarkdownParsingOptions, AdkParsedContentSection } from '../content-parsing';
-import { AdkDocumentationConfigParser, AdkDocumentationNavigationSiblings, AdkNestedObject } from './documentation-config-parser';
-import * as i0 from "@angular/core";
-export interface AdkDocsConfig {
-    title: string;
-    items: AdkFilesConfig;
-}
-export interface AdkFilesConfig {
-    [key: string]: AdkFilesItem;
-}
-export type AdkFilesItem = string | null | AdkFilesConfig;
-export interface AdkParsedMarkdownFile<Content = string> {
-    sections: AdkParsedContentSection<Content>[];
-    headings: AdkHtmlHeader[];
-}
-export interface AdkParsedDocumentation<Content = string> extends AdkParsedMarkdownFile<Content> {
-    siblings: AdkDocumentationNavigationSiblings;
-}
-export interface AdkHtmlHeader {
-    id: string;
-    level: number;
-    text: string;
-}
-export interface AdkDocumentationContentOptions {
-    fileConfig: AdkNestedObject;
-    basePath: string;
-    parsingOptions?: AdkMarkdownParsingOptions;
-}
-export declare class AdkDocumentationContentService {
-    private assetsService;
-    private docsConfigParser;
-    private markdownParser;
-    private files;
-    constructor(assetsService: AdkAssetsService, docsConfigParser: AdkDocumentationConfigParser, markdownParser: AdkMarkdownParser);
-    /**
-     * This service requires the consuming app to provide the AdkDocumentationDisplayService, the AdkAssetsService, and the AdkDocumentationConfigParser at the level at which this service is configured.
-     *
-     * OPTIONAL: If the consuming app wants to use a different assets directory, they can pass it in here.
-     */
-    initialize(assetsDirectory?: string): void;
-    /**
-     * Assumes that the content path matches
-     */
-    getContentForCurrentContentPath(contentPath$: Observable<string>, options: AdkDocumentationContentOptions): Observable<AdkParsedDocumentation>;
-    private getParsedMarkdownFile;
-    static ɵfac: i0.ɵɵFactoryDeclaration<AdkDocumentationContentService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<AdkDocumentationContentService>;
-}

package/lib/documentation-display/documentation-display.component.d.ts

@@ -1,39 +0,0 @@
-import { AfterViewInit, DestroyRef, ElementRef, EventEmitter, NgZone, OnInit, TemplateRef } from '@angular/core';
-import { Observable } from 'rxjs';
-import { ShikiTheme } from '../content-parsing';
-import { AdkActiveHeadingTracker } from './active-heading-tracker';
-import { AdkNestedObject } from './documentation-config-parser';
-import { AdkDocumentationContentService, AdkHtmlHeader, AdkParsedDocumentation } from './documentation-content-service';
-import * as i0 from "@angular/core";
-export declare class AdkDocumentationDisplayComponent implements OnInit, AfterViewInit {
-    private content;
-    private activeHeading;
-    private destroyRef;
-    private zone;
-    private document;
-    /**
-     * Observable that emits the current content path
-     */
-    contentPath$: Observable<string>;
-    fileConfig: AdkNestedObject;
-    highlightTheme: ShikiTheme;
-    pathFromAssetsToFile: string;
-    showPrevNextNavigation: boolean;
-    nextDoc: EventEmitter<string>;
-    file: ElementRef<HTMLDivElement>;
-    content$: Observable<AdkParsedDocumentation>;
-    escapedContentTemplateRef: TemplateRef<unknown>;
-    constructor(content: AdkDocumentationContentService, activeHeading: AdkActiveHeadingTracker, destroyRef: DestroyRef, zone: NgZone, document: Document);
-    ngOnInit(): void;
-    ngAfterViewInit(): void;
-    setContent(): void;
-    scrollToHeading(update: {
-        heading: AdkHtmlHeader;
-        event: KeyboardEvent | PointerEvent | MouseEvent | Event;
-    }): void;
-    scrollToItemById(item: HTMLHeadingElement, needsChangeDetection?: boolean): void;
-    scrollToItem(top: number): void;
-    navigateToDoc(sibling: string): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<AdkDocumentationDisplayComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<AdkDocumentationDisplayComponent, "hsi-adk-documentation-display", never, { "contentPath$": { "alias": "contentPath$"; "required": false; }; "fileConfig": { "alias": "fileConfig"; "required": false; }; "highlightTheme": { "alias": "highlightTheme"; "required": false; }; "pathFromAssetsToFile": { "alias": "pathFromAssetsToFile"; "required": false; }; "showPrevNextNavigation": { "alias": "showPrevNextNavigation"; "required": false; }; }, { "nextDoc": "nextDoc"; }, ["escapedContentTemplateRef"], never, true, never>;
-}

package/lib/documentation-display/index.d.ts

@@ -1,6 +0,0 @@
-export * from './active-heading-tracker';
-export * from './document-index/document-index.component';
-export * from './documentation-config-parser';
-export * from './documentation-content-service';
-export * from './documentation-display.component';
-export * from './navigation-siblings/navigation-siblings.component';

package/lib/documentation-display/navigation-siblings/navigation-siblings.component.d.ts

@@ -1,18 +0,0 @@
-import { TitleCasePipe } from '@angular/common';
-import { EventEmitter, OnChanges } from '@angular/core';
-import { AdkDocumentationNavigationSiblings } from '../documentation-config-parser';
-import * as i0 from "@angular/core";
-export declare class NavigationSiblingsComponent implements OnChanges {
-    private titleCase;
-    siblings: AdkDocumentationNavigationSiblings;
-    nextDoc: EventEmitter<string>;
-    previous: string;
-    next: string;
-    constructor(titleCase: TitleCasePipe);
-    ngOnChanges(): void;
-    setDisplayNames(): void;
-    getDisplayName(path: string): string;
-    navigateToDoc(sibling: string): void;
-    static ɵfac: i0.ɵɵFactoryDeclaration<NavigationSiblingsComponent, never>;
-    static ɵcmp: i0.ɵɵComponentDeclaration<NavigationSiblingsComponent, "hsi-adk-navigation-siblings", never, { "siblings": { "alias": "siblings"; "required": false; }; }, { "nextDoc": "nextDoc"; }, never, never, true, never>;
-}

package/lib/ng-utilities/index.d.ts

@@ -1,2 +0,0 @@
-export * from './ng-on-changes';
-export * from './run-ng-change-detection-then';

package/lib/ng-utilities/ng-on-changes.d.ts

@@ -1,22 +0,0 @@
-import { SimpleChanges } from '@angular/core';
-/**
- * A utility class for detecting changes to objects in Angular's ngOnChanges lifecycle hook.
- */
-export declare class NgOnChangesUtilities {
-    /**
-     * Checks if an input object has changed since the first change.
-     * @param changes - The SimpleChanges object containing the changes.
-     * @param inputName - The name of the input property to check.
-     * @param property - Optional specific property to check within the input object.
-     * @returns True if the input object has changed since the first change, otherwise false.
-     */
-    static inputObjectChangedNotFirstTime(changes: SimpleChanges, inputName: string, property?: string): boolean;
-    /**
-     * Checks if an input object has changed.
-     * @param changes - The SimpleChanges object containing the changes.
-     * @param inputName - The name of the input property to check.
-     * @param property - Optional specific property to check within the input object.
-     * @returns True if the input object has changed, otherwise false.
-     */
-    static inputObjectChanged(changes: SimpleChanges, inputName: string, property?: string): boolean;
-}

package/lib/ng-utilities/run-ng-change-detection-then.d.ts

@@ -1,22 +0,0 @@
-import { NgZone } from '@angular/core';
-import { Observable } from 'rxjs';
-/**
- *
- * @param zone: NgZone
- * @returns (source: Observable<T>) => Observable<void>
- *
- * A custom RxJS operator that runs an Angular change detection cycle after the source observable emits, and waits until the change detection cycle is complete before emitting the next value.
- *
- * Note that this is not intended to be used frequently. It is a workaround for cases where you need to ensure that Angular has completed change detection before continuing with the next operation, for example when you need to access a DOM element that is being created through multiple levels of content projection.
- *
- * @example
- * ```ts
- * this.myObservable.pipe(
- *   runNgChangeDetectionThen(this.zone),
- *   subscribe(() => {
- *    console.log('a change detection cycle has completed');
- *   })
- * );
- * ```
- */
-export declare function runNgChangeDetectionThen<T>(zone: NgZone): (source: Observable<T>) => Observable<void>;

package/public-api.d.ts

@@ -1,6 +0,0 @@
-export * from './lib/assets';
-export * from './lib/content-parsing';
-export * from './lib/core/utilities/index';
-export * from './lib/documentation-display';
-export * from './lib/ng-utilities';
-export declare const STYLES_PATH = "./lib/styles/_index.scss";