@ng-doc/app 15.0.0-beta.10

package/helpers/is-playground-property/is-playground-property.d.ts

@@ -0,0 +1,6 @@
+import { NgDocPlaygroundProperty } from '@ng-doc/builder';
+/**
+ *
+ * @param obj
+ */
+export declare function isPlaygroundProperty(obj: Record<string, any>): obj is NgDocPlaygroundProperty;

package/helpers/provide-type-control/index.d.ts

@@ -0,0 +1 @@
+export * from './provide-type-control';

package/helpers/provide-type-control/provide-type-control.d.ts

@@ -0,0 +1,16 @@
+import { InjectionToken, Provider } from '@angular/core';
+import { NgDocProvidedTypeControl, NgDocTypeControl, NgDocTypeControlProviderOptions } from '@ng-doc/app/interfaces';
+import { Constructor } from '@ng-doc/core';
+/**
+ *
+ * @param type
+ * @param control
+ * @param options
+ */
+export declare function provideTypeControl(type: string, control: Constructor<NgDocTypeControl>, options?: NgDocTypeControlProviderOptions): Provider;
+/**
+ * Returns token for type control based on provided type
+ *
+ * @param type - type for searched control (e.g. `string`)
+ */
+export declare function getTokenForType(type: string): InjectionToken<NgDocProvidedTypeControl> | undefined;

package/index.d.ts

@@ -0,0 +1,12 @@
+export * from '@ng-doc/app/classes';
+export * from '@ng-doc/app/components';
+export * from '@ng-doc/app/constants';
+export * from '@ng-doc/app/directives';
+export * from '@ng-doc/app/helpers';
+export * from '@ng-doc/app/interfaces';
+export * from '@ng-doc/app/modules';
+export * from '@ng-doc/app/pipes';
+export * from '@ng-doc/app/processors';
+export * from '@ng-doc/app/services';
+export * from '@ng-doc/app/tokens';
+export * from '@ng-doc/app/types';

package/interfaces/application-config.d.ts

@@ -0,0 +1,5 @@
+import { NgDocTheme } from './theme';
+export interface NgDocApplicationConfig {
+    themes?: NgDocTheme[];
+    defaultThemeId?: string;
+}

package/interfaces/context.d.ts

@@ -0,0 +1,4 @@
+import { NgDocNavigation } from './navigation';
+export interface NgDocContext {
+    navigation: NgDocNavigation[];
+}

package/interfaces/demo-assets.d.ts

@@ -0,0 +1,9 @@
+import { NgDocCodeType } from '@ng-doc/builder';
+export interface NgDocDemoAssets {
+    [name: string]: NgDocDemoAsset[];
+}
+export interface NgDocDemoAsset {
+    codeType: NgDocCodeType;
+    code: string;
+    title: string;
+}

package/interfaces/index.d.ts

@@ -0,0 +1,11 @@
+export * from './application-config';
+export * from './context';
+export * from './demo-assets';
+export * from './navigation';
+export * from './page-map';
+export * from './playground-form';
+export * from './processor-options';
+export * from './provided-type-control';
+export * from './theme';
+export * from './type-control';
+export * from './type-control-provider-options';

package/interfaces/navigation.d.ts

@@ -0,0 +1,14 @@
+export interface NgDocNavigation {
+    /** Title of the navigation item */
+    title: string;
+    /** Route of the navigation item */
+    route?: string;
+    /** Determines whether the category is expandable */
+    expandable?: boolean;
+    /** Determines whether the category should be expanded by default */
+    expanded?: boolean;
+    /** Children of the navigation item */
+    children?: NgDocNavigation[];
+    /** Order is using for sorting pages and categories in sidebar */
+    order?: number;
+}

package/interfaces/page-map.d.ts

@@ -0,0 +1,6 @@
+export interface NgDocPageMapItem {
+    title: string;
+    path: string;
+    element: HTMLHeadingElement;
+    level: number;
+}

package/interfaces/playground-form.d.ts

@@ -0,0 +1,5 @@
+import { NgDocPlaygroundDynamicContent, NgDocPlaygroundProperties } from '@ng-doc/builder';
+export interface NgDocPlaygroundFormData<P extends NgDocPlaygroundProperties = NgDocPlaygroundProperties, C extends Record<string, NgDocPlaygroundDynamicContent> = Record<string, NgDocPlaygroundDynamicContent>> {
+    properties: Record<keyof P, unknown>;
+    content: Record<keyof C, boolean>;
+}

package/interfaces/processor-options.d.ts

@@ -0,0 +1,4 @@
+export interface NgDocProcessorOptions<T> {
+    content?: Node[][];
+    inputs: Partial<T>;
+}

package/interfaces/provided-type-control.d.ts

@@ -0,0 +1,7 @@
+import { Constructor } from '@ng-doc/core';
+import { NgDocTypeControl } from './type-control';
+import { NgDocTypeControlProviderOptions } from './type-control-provider-options';
+export interface NgDocProvidedTypeControl {
+    control: Constructor<NgDocTypeControl>;
+    options?: NgDocTypeControlProviderOptions;
+}

package/interfaces/theme.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Interface describing a custom theme for the application
+ */
+export interface NgDocTheme {
+    /**
+     * Theme ID that you can use to set theme (e.g. `CustomTheme`)
+     */
+    id: string;
+    /**
+     * Path that will be used to load theme dynamically (e.g. `/assets/themes/custom.css`)
+     */
+    path: string;
+}

package/interfaces/type-control-provider-options.d.ts

@@ -0,0 +1,3 @@
+export interface NgDocTypeControlProviderOptions {
+    hideLabel?: boolean;
+}

package/interfaces/type-control.d.ts

@@ -0,0 +1,22 @@
+import { ControlValueAccessor } from '@angular/forms';
+/**
+ * Interface describing Type Control
+ */
+export interface NgDocTypeControl extends ControlValueAccessor {
+    /**
+     * The name of the input for which it is created
+     */
+    name?: string;
+    /**
+     * The description of the input (based on the comment)
+     */
+    description?: string;
+    /**
+     * The default value of the input
+     */
+    default?: string;
+    /**
+     * The list of possible values, it usually works only for Type Aliases which has several values
+     */
+    options?: string[];
+}

package/modules/index.d.ts

@@ -0,0 +1 @@
+export * from '@ng-doc/app/modules/root';

package/modules/root/index.d.ts

@@ -0,0 +1 @@
+export * from './ng-doc.module';

package/modules/root/ng-doc.module.d.ts

@@ -0,0 +1,15 @@
+import { ModuleWithProviders } from '@angular/core';
+import { NgDocApplicationConfig } from '@ng-doc/app/interfaces';
+import * as i0 from "@angular/core";
+import * as i1 from "@angular/common/http";
+import * as i2 from "@angular/cdk/overlay";
+import * as i3 from "@ng-doc/ui-kit";
+import * as i4 from "@ng-doc/app/components/root";
+import * as i5 from "@ng-doc/app/components/navbar";
+import * as i6 from "@ng-doc/app/components/sidebar";
+export declare class NgDocModule {
+    static forRoot(config?: NgDocApplicationConfig): ModuleWithProviders<NgDocModule>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<NgDocModule, never>;
+    static ɵmod: i0.ɵɵNgModuleDeclaration<NgDocModule, never, [typeof i1.HttpClientModule, typeof i2.OverlayModule, typeof i3.NgDocUiKitRootModule], [typeof i4.NgDocRootModule, typeof i3.NgDocUiKitRootModule, typeof i5.NgDocNavbarModule, typeof i6.NgDocSidebarModule]>;
+    static ɵinj: i0.ɵɵInjectorDeclaration<NgDocModule>;
+}