express-mesh/lib/meshHandlerStore.d.ts

A Gentics Mesh frontend for Express.

import Q = require('q');
import { RenderData } from "./meshRenderer";
import { IMeshResponse } from "./mesh";
import { IMeshRequest } from "./mesh";
import { IMeshNode } from "./mesh";
/**
 * Interface for the schema handler. A schema handler can be registered for a schema. If registered, it will be executed
 * before a node with this schema is being rendered.
 */
export interface IMeshSchemaHandler<T> {
    (item: IMeshNode<T>, req: IMeshRequest, res: IMeshResponse): Q.Promise<IMeshNode<T>>;
}
/**
 * Interface for the view handler. A view handler can be registered. If registered, it will be executed becore a
 * view is being rendered.
 */
export interface IMeshViewHandler {
    (renderdata: RenderData, req: IMeshRequest, res: IMeshResponse): Q.Promise<RenderData>;
}
/**
 * Interface for the error handler. An error handler can be registered for an error status. If registered, it will be
 * executed if an error with this status code occurs.
 */
export interface IMeshErrorHandler {
    (error: any, status: number, req: IMeshRequest, res: IMeshResponse): void;
}
/**
 * Schema handler store. This store keeps the registered schema handlers.
 * Go through the Mesh API to register a schema handler.
 */
export declare class SchemaHandlerStore {
    /**
     * Register a schema handler.
     * @param schema The schema, the handler should be registered for.
     * @param handler The handler, that should be registered.
     */
    registerSchemaHandler<T>(schema: string, handler: IMeshSchemaHandler<T>): void;
    /**
     * Unregister a schema handler.
     * @param schema The schema, the handler should unregistered from.
     * @param handler The handler, that should be unregistered.
     */
    unregisterSchemaHandler<T>(schema: string, handler: IMeshSchemaHandler<T>): void;
    /**
     * Executes the schema handlers for a passed MeshNode.
     * @param schema The schema, for which the handlers should be executed.
     * @param item The MeshNode, that should be processed in the handlers.
     * @param req The MeshRequest.
     * @param res The MeshResponse
     * @returns {Promise<IMeshNode<T>>} A promise, that will be fulfilled, once all the handlers have been processed
     *          and will be rejected if executing a handler fails.
     */
    workSchemaHandlers<T>(schema: string, item: IMeshNode<T>, req?: IMeshRequest, res?: IMeshResponse): Q.Promise<IMeshNode<T>>;
}
/**
 * View handler store. This store keeps the registered view handlers.
 * Go through the Mesh API to register a view handler.
 */
export declare class ViewHandlerStore {
    private handlers;
    /**
     * Register a view handler.
     * @param handler The handler that should be registered.
     */
    registerViewHandler(handler: IMeshViewHandler): void;
    /**
     * Unregister a view handler.
     * @param handler The handler that should be unregistered.
     */
    unregisterSchemaHandler(handler: IMeshViewHandler): void;
    /**
     * Execute all view handlers.
     * @param renderdata Renderdata, that should be processed by the view handlers.
     * @param req The MeshRequest.
     * @param res The MeshResponse
     * @returns {Promise<RenderData>} A promise, that will be fulfilled, once all the view handlers have been executed
     *          and will be rejected if executing a view handler fails.
     */
    workViewHandlers(renderdata: RenderData, req?: IMeshRequest, res?: IMeshResponse): Q.Promise<RenderData>;
}
/**
 * Error handler store. This store keeps the registered error handlers.
 * Go through the Mesh API to register an error handler.
 */
export declare class ErrorHandlerStore {
    /**
     * Register an error handler for an error status.
     * There can only be one handler per status.
     * @param status The status the handler should be registered for.
     * @param handler The handler that should be registered.
     */
    registerErrorHandler(status: number, handler: IMeshErrorHandler): void;
    /**
     * Unregister an error handler for a status.
     * @param status The status the handler should be unregistered from.
     * @param handler The handler that should be unregistered.
     */
    unregisterErrorHandler(status: number, handler?: IMeshErrorHandler): void;
    /**
     * Execute the error handler for a status.
     * @param status The status for which the handler should be executed.
     * @param error An object describing the error.
     * @param req The MeshRequest.
     * @param res The MeshResponse
     * @returns {Promise<void>} A promise, that will be fulfilled once the error handler has been executed and will be
     *          rejected if executing the error handler fails.
     */
    workErrorHandler(status: number, error: any, req: IMeshRequest, res: IMeshResponse): Q.Promise<void>;
}