import { BaseEngine, UserInfo, IMetadataProvider } from "@memberjunction/core"; import { MJLibraryEntity, MJLibraryItemEntity } from "@memberjunction/core-entities"; /** * Represents a single item within a library/package that is used to provide documentation for the MemberJunction system. For example a library would be something like * @memberjunction/core and an item within that library might be the BaseEntity or BaseEngine class. */ export declare class MJLibraryItemEntityExtended extends MJLibraryItemEntity { URL: string; HTMLContent: string; get TypeURLSegment(): string; } export declare class MJLibraryEntityExtended extends MJLibraryEntity { private _items; get Items(): MJLibraryItemEntityExtended[]; } /** * Provides utility functionality for documentation of the MemberJunction system using external website content from the MemberJunction project. */ export declare class DocumentationEngine extends BaseEngine { static get Instance(): DocumentationEngine; private _Libraries; private _LibraryItems; /** * This method is called to configure the ActionEngine. It loads the metadata for the actions, filters, and result codes and caches them in the GlobalObjectStore. You must call this method before running any actions. * If this method was previously run on the instance of the ActionEngine, it will return immediately without re-loading the metadata. If you want to force a reload of the metadata, you can pass true for the forceReload parameter. * @param forceRefresh If true, the metadata will be loaded from the database even if it was previously loaded. * @param contextUser If you are running the action on the server side you must pass this in, but it is not required in an environment where a user is authenticated directly, e.g. a browser or other client. */ Config(forceRefresh?: boolean, contextUser?: UserInfo, provider?: IMetadataProvider): Promise; private _baseURL; protected AdditionalLoading(contextUser?: UserInfo): Promise; protected GetContent(url: string, rootSelector?: string): Promise; protected fetchDocumentation(url: string): Promise; protected parseDocumentation(html: string, rootSelector?: string): string; /** * List of all the Entity Action objects that are available for use in the system. Make sure you call Config() before any other methods on this class. */ get Libraries(): MJLibraryEntityExtended[]; /** * List of all the Entity Action objects that are available for use in the system. Make sure you call Config() before any other methods on this class. */ get LibraryItems(): MJLibraryItemEntityExtended[]; } //# sourceMappingURL=Engine.d.ts.map