@curveball/browser/dist/types.d.ts

Automatic API browser generator. A middleware that turns your JSON responses into HTML if accessed by a browser.

import { Link, State } from 'ketting';
export type Theme = 'default' | 'spicy-oj' | 'lfo' | 'curveball' | 'xmas' | 'halloween' | null;
/**
 * Options after clean-up.
 *
 * Basically the same but nothing is optional.
 */
export type Options = {
    /**
     * Application title
     */
    title: string;
    /**
     * Theme
     *
     * Possible options: spicy-oj, lfo, curveball
     */
    theme: Theme;
    /**
     * List of custom stylesheets to embed.
     */
    stylesheets: string[];
    /**
     * List of links that should be lifted to navigation sections
     */
    navigationLinks: SureNavigationLinkMap;
    /**
     * Where the base assets are located
     */
    assetBaseUrl: string;
    /**
     * Should this plugin handle serving the assets.
     *
     * Disable if the assets are hosted elsewhere
     */
    serveAssets: boolean;
    /**
     * List of hardcoded links that should show up on every page.
     */
    defaultLinks: Link[];
    /**
     * List of uninteresting link relationships that should be hidden by default.
     */
    hiddenRels: string[];
    /**
     * If turned on, full JSON bodies are always rendered.
     *
     * This can also be turned on during runtime by adding a ?_browser-fullbody
     * query parameter
     */
    fullBody: boolean;
    /**
     * By default the Browser will hide links from the 'Links' table that will
     * be rendered as 'navigation buttons', forms (templated links), or are
     * considered special (the 'self' link).
     *
     * While this might be a nicer interface for an average user browsing the
     * hypermedia graph, as a developer you might just want to see all the links
     *
     * Turning 'allLinks' on ensures that everything always shows.
     */
    allLinks: boolean;
};
/**
 * An object containing a list of navigation links.
 */
export type NavigationLinkMap = {
    [rel: string]: NavigationLink | null | true;
};
/**
 * A normalized NavigationLinkMap.
 *
 * The nulls are removed, and 'true' is transformed to some default settings.
 */
export type SureNavigationLinkMap = {
    [rel: string]: NavigationLink;
};
/**
 * Where Navigation links should appear
 */
export type NavigationPosition = 'header' | 'header-right' | 'pager' | 'alternate';
/**
 * A "NavigationLink" specifies a link that will automatically get recognized
 * by the hal-browser and placed in the Navigation bar
 */
export type NavigationLink = {
    cssClass?: string;
    defaultTitle?: string;
    icon?: string;
    position?: NavigationPosition;
    priority?: number;
    showLabel?: boolean;
};
export type PageProps = {
    resourceState: State;
    originalBody: string;
    options: Options;
    csrfToken: string | null;
    jsonSchemas: Map<string, JsonSchema>;
};
/**
 * A very basic type for json schema. It's just barely enough.
 */
export type JsonSchema = {
    '$id'?: string;
    description?: string;
    properties?: Record<string, JsonSchema>;
    items?: JsonSchema | JsonSchema[];
};