@difizen/libro-rendermime 0.0.2-alpha.0

package/es/rendermime-protocol.d.ts

@@ -0,0 +1,405 @@
+/// <reference types="react" resolution-mode="require"/>
+import type { ISanitizer } from '@difizen/libro-common';
+import type { BaseOutputView } from '@difizen/libro-core';
+import type { MarkdownParser } from '@difizen/libro-markdown';
+import { Syringe } from '@difizen/mana-app';
+export declare const DefaultRenderMimeRegistry: unique symbol;
+export declare const IRenderMimeRegistryOptions: unique symbol;
+export declare const RenderMimeContribution: Syringe.DefinedToken;
+export interface RenderMimeContribution {
+    canHandle: (model: BaseOutputView) => number;
+    safe: boolean;
+    renderType: string;
+    mimeTypes: string[];
+    render: React.FC<{
+        model: BaseOutputView;
+        options?: Record<string, any>;
+    }>;
+}
+/**
+ * The interface for a renderer factory.
+ */
+export interface IRendererFactory {
+    /**
+     * Whether the factory is a "safe" factory.
+     *
+     * #### Notes
+     * A "safe" factory produces renderer widgets which can render
+     * untrusted model data in a usable way. *All* renderers must
+     * handle untrusted data safely, but some may simply failover
+     * with a "Run cell to view output" message. A "safe" renderer
+     * is an indication that its sanitized output will be useful.
+     */
+    readonly safe: boolean;
+    readonly renderType: string;
+    /**
+     * The mime types handled by this factory.
+     */
+    readonly mimeTypes: readonly string[];
+    /**
+     * The default rank of the factory.  If not given, defaults to 100.
+     */
+    readonly defaultRank?: number;
+    /**
+     * Create a renderer which displays the mime data.
+     *
+     * @param options - The options used to render the data.
+     */
+    render: React.FC<{
+        model: BaseOutputView;
+        props?: Record<string, any>;
+    }>;
+}
+/**
+ * An object that resolves relative URLs.
+ */
+export interface IResolver {
+    /**
+     * Resolve a relative url to an absolute url path.
+     */
+    resolveUrl: (url: string) => Promise<string>;
+    /**
+     * Get the download url for a given absolute url path.
+     *
+     * #### Notes
+     * This URL may include a query parameter.
+     */
+    getDownloadUrl: (url: string) => Promise<string>;
+    /**
+     * Whether the URL should be handled by the resolver
+     * or not.
+     *
+     * #### Notes
+     * This is similar to the `isLocal` check in `URL`,
+     * but can also perform additional checks on whether the
+     * resolver should handle a given URL.
+     */
+    isLocal?: (url: string) => boolean;
+}
+/**
+ * An object that handles links on a node.
+ */
+export interface ILinkHandler {
+    /**
+     * Add the link handler to the node.
+     *
+     * @param node: the anchor node for which to handle the link.
+     *
+     * @param path: the path to open when the link is clicked.
+     *
+     * @param id: an optional element id to scroll to when the path is opened.
+     */
+    handleLink: (node: HTMLElement, path: string, id?: string) => void;
+}
+/**
+ * Interface for generic renderer.
+ */
+export interface IRenderer {
+    readonly render: (container: HTMLElement, options?: any) => void;
+    readonly unrender?: (container: HTMLElement, options?: any) => void;
+}
+/**
+ * The options used to clone a rendermime instance.
+ */
+export interface ICloneOptions {
+    /**
+     * The new sanitizer used to sanitize untrusted html inputs.
+     */
+    sanitizer?: ISanitizer;
+    /**
+     * The new resolver object.
+     */
+    resolver?: IResolver;
+    /**
+     * The new path handler.
+     */
+    linkHandler?: ILinkHandler;
+    /**
+     * The new Markdown parser.
+     */
+    markdownParser?: MarkdownParser;
+}
+export interface IRenderMimeRegistry {
+    /**
+     * The sanitizer used by the rendermime instance.
+     */
+    readonly sanitizer: ISanitizer;
+    /**
+     * The object used to resolve relative urls for the rendermime instance.
+     */
+    readonly resolver: IResolver | null;
+    /**
+     * The object used to handle path opening links.
+     */
+    readonly linkHandler: ILinkHandler | null;
+    /**
+     * The Markdown parser for the rendermime.
+     */
+    readonly markdownParser: MarkdownParser | null;
+    /**
+     * The ordered list of mimeTypes.
+     */
+    readonly mimeTypes: readonly string[];
+    /**
+     * Find the preferred mime type for a mime bundle.
+     *
+     * @param bundle - The bundle of mime data.
+     *
+     * @param safe - How to consider safe/unsafe factories. If 'ensure',
+     *   it will only consider safe factories. If 'any', any factory will be
+     *   considered. If 'prefer', unsafe factories will be considered, but
+     *   only after the safe options have been exhausted.
+     *
+     * @returns The preferred mime type from the available factories,
+     *   or `undefined` if the mime type cannot be rendered.
+     */
+    preferredMimeType: (model: BaseOutputView, safe?: 'ensure' | 'prefer' | 'any') => string | undefined;
+    defaultPreferredMimeType: (model: BaseOutputView, safe?: 'ensure' | 'prefer' | 'any') => string | undefined;
+    /**
+     * Create a renderer for a mime type.
+     *
+     * @param mimeType - The mime type of interest.
+     *
+     * @returns A new renderer for the given mime type.
+     *
+     * @throws An error if no factory exists for the mime type.
+     */
+    createRenderer: (mimeType: string, model: BaseOutputView) => React.FC<{
+        model: BaseOutputView;
+    }>;
+    /**
+     * Get the renderer factory registered for a mime type.
+     *
+     * @param mimeType - The mime type of interest.
+     *
+     * @returns The factory for the mime type, or `undefined`.
+     */
+    getFactory: (mimeType: string) => IRendererFactory | undefined;
+    /**
+     * Add a renderer factory to the rendermime.
+     *
+     * @param factory - The renderer factory of interest.
+     *
+     * @param rank - The rank of the renderer. A lower rank indicates
+     *   a higher priority for rendering. If not given, the rank will
+     *   defer to the `defaultRank` of the factory.  If no `defaultRank`
+     *   is given, it will default to 100.
+     *
+     * #### Notes
+     * The renderer will replace an existing renderer for the given
+     * mimeType.
+     */
+    addFactory: (factory: IRendererFactory, rank?: number) => void;
+    /**
+     * Remove a mime type.
+     *
+     * @param mimeType - The mime type of interest.
+     */
+    removeMimeType: (mimeType: string) => void;
+    /**
+     * Get the rank for a given mime type.
+     *
+     * @param mimeType - The mime type of interest.
+     *
+     * @returns The rank of the mime type or undefined.
+     */
+    getRank: (mimeType: string) => number | undefined;
+    /**
+     * Set the rank of a given mime type.
+     *
+     * @param mimeType - The mime type of interest.
+     *
+     * @param rank - The new rank to assign.
+     *
+     * #### Notes
+     * This is a no-op if the mime type is not registered.
+     */
+    setRank: (mimeType: string, rank: number) => void;
+}
+/**
+ * The options for the `renderText` function.
+ */
+export interface IRenderTextOptions {
+    /**
+     * The host node for the text content.
+     */
+    host: HTMLElement;
+    /**
+     * The html sanitizer for untrusted source.
+     */
+    sanitizer: ISanitizer;
+    /**
+     * The source text to render.
+     */
+    source: string;
+    mimeType: string;
+}
+/**
+ * The options for the `renderImage` function.
+ */
+export interface IRenderImageOptions {
+    /**
+     * The image node to update with the content.
+     */
+    host: HTMLElement;
+    /**
+     * The mime type for the image.
+     */
+    mimeType: string;
+    /**
+     * The base64 encoded source for the image.
+     */
+    source: string;
+    /**
+     * The optional width for the image.
+     */
+    width?: number;
+    /**
+     * The optional height for the image.
+     */
+    height?: number;
+    /**
+     * Whether an image requires a background for legibility.
+     */
+    needsBackground?: string;
+    /**
+     * Whether the image should be unconfined.
+     */
+    unconfined?: boolean;
+}
+/**
+ * The options for the `renderHTML` function.
+ */
+export interface IRenderHTMLOptions {
+    /**
+     * The host node for the rendered HTML.
+     */
+    host: HTMLElement;
+    /**
+     * The HTML source to render.
+     */
+    source: string;
+    /**
+     * Whether the source is trusted.
+     */
+    trusted: boolean;
+    /**
+     * The html sanitizer for untrusted source.
+     */
+    sanitizer: ISanitizer;
+    /**
+     * An optional url resolver.
+     */
+    resolver: IResolver | null;
+    /**
+     * An optional link handler.
+     */
+    linkHandler: ILinkHandler | null;
+    /**
+     * Whether the node should be typeset.
+     */
+    shouldTypeset: boolean;
+}
+/**
+ * The options for the `renderMarkdown` function.
+ */
+export interface IRenderMarkdownOptions {
+    /**
+     * The host node for the rendered Markdown.
+     */
+    host: HTMLElement;
+    /**
+     * The Markdown source to render.
+     */
+    source: string;
+    /**
+     * Whether the source is trusted.
+     */
+    trusted: boolean;
+    /**
+     * The html sanitizer for untrusted source.
+     */
+    sanitizer: ISanitizer;
+    /**
+     * An optional url resolver.
+     */
+    resolver: IResolver | null;
+    /**
+     * An optional link handler.
+     */
+    linkHandler: ILinkHandler | null;
+    /**
+     * Whether the node should be typeset.
+     */
+    /**
+     * The Markdown parser.
+     */
+    markdownParser: MarkdownParser | null;
+    cellId?: string;
+}
+/**
+ * The options for the `renderSVG` function.
+ */
+export interface IRenderSVGOptions {
+    /**
+     * The host node for the rendered SVG.
+     */
+    host: HTMLElement;
+    /**
+     * The SVG source.
+     */
+    source: string;
+    /**
+     * Whether the source is trusted.
+     */
+    trusted: boolean;
+    /**
+     * Whether the svg should be unconfined.
+     */
+    unconfined?: boolean;
+}
+/**
+ * The options used to initialize a rendermime instance.
+ */
+export interface IRenderMimeRegistryOptions {
+    /**
+     * Initial factories to add to the rendermime instance.
+     */
+    initialFactories?: readonly IRendererFactory[];
+    /**
+     * The sanitizer used to sanitize untrusted html inputs.
+     *
+     * If not given, a default sanitizer will be used.
+     */
+    sanitizer?: ISanitizer;
+    /**
+     * The initial resolver object.
+     *
+     * The default is `null`.
+     */
+    resolver?: IResolver;
+    /**
+     * An optional path handler.
+     */
+    linkHandler?: ILinkHandler;
+    /**
+     * An optional Markdown parser.
+     */
+    markdownParser?: MarkdownParser;
+}
+/**
+ * A type alias for a mime rank and tie-breaking id.
+ */
+export type RankPair = {
+    readonly id: number;
+    readonly rank: number;
+};
+/**
+ * A type alias for a mapping of mime type -> rank pair.
+ */
+export type RankMap = Record<string, RankPair>;
+/**
+ * A type alias for a mapping of mime type -> ordered factories.
+ */
+export type FactoryMap = Record<string, IRendererFactory>;
+//# sourceMappingURL=rendermime-protocol.d.ts.map

package/es/rendermime-protocol.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rendermime-protocol.d.ts","sourceRoot":"","sources":["../src/rendermime-protocol.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAC1D,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AAC9D,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAE5C,eAAO,MAAM,yBAAyB,eAA+B,CAAC;AACtE,eAAO,MAAM,0BAA0B,eAAuC,CAAC;AAC/E,eAAO,MAAM,sBAAsB,sBAAoD,CAAC;AACxF,MAAM,WAAW,sBAAsB;IACrC,SAAS,EAAE,CAAC,KAAK,EAAE,cAAc,KAAK,MAAM,CAAC;IAC7C,IAAI,EAAE,OAAO,CAAC;IACd,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,EAAE,CAAC;IACpB,MAAM,EAAE,KAAK,CAAC,EAAE,CAAC;QAAE,KAAK,EAAE,cAAc,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;KAAE,CAAC,CAAC;CAC5E;AACD;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;;;;;;;;OASG;IACH,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC;IAEvB,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,SAAS,MAAM,EAAE,CAAC;IAEtC;;OAEG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAE9B;;;;OAIG;IACH,MAAM,EAAE,KAAK,CAAC,EAAE,CAAC;QAAE,KAAK,EAAE,cAAc,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;KAAE,CAAC,CAAC;CAC1E;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,UAAU,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;IAE7C;;;;;OAKG;IACH,cAAc,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,MAAM,CAAC,CAAC;IAEjD;;;;;;;;OAQG;IACH,OAAO,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC;CACpC;AACD;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;;;;;;;OAQG;IACH,UAAU,EAAE,CAAC,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;CACpE;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB,QAAQ,CAAC,MAAM,EAAE,CAAC,SAAS,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,GAAG,KAAK,IAAI,CAAC;IACjE,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,SAAS,EAAE,WAAW,EAAE,OAAO,CAAC,EAAE,GAAG,KAAK,IAAI,CAAC;CACrE;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,SAAS,CAAC,EAAE,UAAU,CAAC;IAEvB;;OAEG;IACH,QAAQ,CAAC,EAAE,SAAS,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,YAAY,CAAC;IAE3B;;OAEG;IACH,cAAc,CAAC,EAAE,cAAc,CAAC;CAMjC;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,UAAU,CAAC;IAE/B;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,SAAS,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,YAAY,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,QAAQ,CAAC,cAAc,EAAE,cAAc,GAAG,IAAI,CAAC;IAE/C;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,SAAS,MAAM,EAAE,CAAC;IAEtC;;;;;;;;;;;;OAYG;IACH,iBAAiB,EAAE,CACjB,KAAK,EAAE,cAAc,EACrB,IAAI,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,KAAK,KAC/B,MAAM,GAAG,SAAS,CAAC;IAExB,wBAAwB,EAAE,CACxB,KAAK,EAAE,cAAc,EACrB,IAAI,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,KAAK,KAC/B,MAAM,GAAG,SAAS,CAAC;IAMxB;;;;;;;;OAQG;IAEH,cAAc,EAAE,CACd,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,cAAc,KAElB,KAAK,CAAC,EAAE,CAAC;QAAE,KAAK,EAAE,cAAc,CAAA;KAAE,CAAC,CAAC;IAmBzC;;;;;;OAMG;IACH,UAAU,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,gBAAgB,GAAG,SAAS,CAAC;IAE/D;;;;;;;;;;;;;OAaG;IACH,UAAU,EAAE,CAAC,OAAO,EAAE,gBAAgB,EAAE,IAAI,CAAC,EAAE,MAAM,KAAK,IAAI,CAAC;IAE/D;;;;OAIG;IACH,cAAc,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,IAAI,CAAC;IAE3C;;;;;;OAMG;IACH,OAAO,EAAE,CAAC,QAAQ,EAAE,MAAM,KAAK,MAAM,GAAG,SAAS,CAAC;IAElD;;;;;;;;;OASG;IACH,OAAO,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,KAAK,IAAI,CAAC;CACnD;AACD;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC;IAEtB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,MAAM,CAAC;CAKlB;AACD;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC;IAElB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC;IAElB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC;IAEtB;;OAEG;IACH,QAAQ,EAAE,SAAS,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,WAAW,EAAE,YAAY,GAAG,IAAI,CAAC;IAEjC;;OAEG;IACH,aAAa,EAAE,OAAO,CAAC;CAMxB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC;IAElB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC;IAEtB;;OAEG;IACH,QAAQ,EAAE,SAAS,GAAG,IAAI,CAAC;IAE3B;;OAEG;IACH,WAAW,EAAE,YAAY,GAAG,IAAI,CAAC;IAEjC;;OAEG;IAGH;;OAEG;IACH,cAAc,EAAE,cAAc,GAAG,IAAI,CAAC;IAOtC,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,IAAI,EAAE,WAAW,CAAC;IAElB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;CAMtB;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,gBAAgB,CAAC,EAAE,SAAS,gBAAgB,EAAE,CAAC;IAE/C;;;;OAIG;IACH,SAAS,CAAC,EAAE,UAAU,CAAC;IAEvB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,SAAS,CAAC;IAErB;;OAEG;IACH,WAAW,CAAC,EAAE,YAAY,CAAC;IAE3B;;OAEG;IACH,cAAc,CAAC,EAAE,cAAc,CAAC;CAMjC;AAED;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG;IAAE,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC;AAEtE;;GAEG;AACH,MAAM,MAAM,OAAO,GAAG,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;AAE/C;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC,CAAC"}

package/es/rendermime-protocol.js

@@ -0,0 +1,60 @@
+import { Syringe } from '@difizen/mana-app';
+export var DefaultRenderMimeRegistry = Symbol('RenderMimeRegistry');
+export var IRenderMimeRegistryOptions = Symbol('IRenderMimeRegistryOptions');
+export var RenderMimeContribution = Syringe.defineToken('RenderMimeTypeContribution');
+
+/**
+ * The interface for a renderer factory.
+ */
+
+/**
+ * An object that resolves relative URLs.
+ */
+
+/**
+ * An object that handles links on a node.
+ */
+
+/**
+ * Interface for generic renderer.
+ */
+
+/**
+ * The options used to clone a rendermime instance.
+ */
+
+/**
+ * The options for the `renderText` function.
+ */
+
+/**
+ * The options for the `renderImage` function.
+ */
+
+/**
+ * The options for the `renderHTML` function.
+ */
+
+/**
+ * The options for the `renderMarkdown` function.
+ */
+
+/**
+ * The options for the `renderSVG` function.
+ */
+
+/**
+ * The options used to initialize a rendermime instance.
+ */
+
+/**
+ * A type alias for a mime rank and tie-breaking id.
+ */
+
+/**
+ * A type alias for a mapping of mime type -> rank pair.
+ */
+
+/**
+ * A type alias for a mapping of mime type -> ordered factories.
+ */

package/es/rendermime-registry.d.ts

@@ -0,0 +1,135 @@
+/// <reference types="react" resolution-mode="require"/>
+import type { BaseOutputView } from '@difizen/libro-core';
+import { MarkdownParser } from '@difizen/libro-markdown';
+import type { Contribution } from '@difizen/mana-app';
+import { Emitter } from '@difizen/mana-app';
+import { RenderMimeContribution, IRenderMimeRegistryOptions } from './rendermime-protocol.js';
+import type { ILinkHandler, IRendererFactory, IRenderMimeRegistry, IResolver } from './rendermime-protocol.js';
+/**
+ * An object which manages mime renderer factories.
+ *
+ * This object is used to render mime models using registered mime
+ * renderers, selecting the preferred mime renderer to render the
+ * model into a widget.
+ *
+ * #### Notes
+ * This class is not intended to be subclassed.
+ */
+export declare class RenderMimeRegistry implements IRenderMimeRegistry {
+    renderMimeEmitter: Emitter<{
+        renderType: string;
+        mimeType: string;
+    }>;
+    get onMimeRender(): import("@difizen/mana-app").Event<{
+        renderType: string;
+        mimeType: string;
+    }>;
+    /**
+     * Construct a new rendermime.
+     *
+     * @param options - The options for initializing the instance.
+     */
+    constructor(options: IRenderMimeRegistryOptions, markdownParser: MarkdownParser);
+    renderMimeProvider: Contribution.Provider<RenderMimeContribution>;
+    /**
+     * The sanitizer used by the rendermime instance.
+     */
+    readonly sanitizer: import("@difizen/libro-common").ISanitizer;
+    /**
+     * The object used to resolve relative urls for the rendermime instance.
+     */
+    readonly resolver: IResolver | null;
+    /**
+     * The object used to handle path opening links.
+     */
+    readonly linkHandler: ILinkHandler | null;
+    /**
+     * The Markdown parser for the rendermime.
+     */
+    readonly markdownParser: MarkdownParser | null;
+    /**
+     * The ordered list of mimeTypes.
+     */
+    get mimeTypes(): readonly string[];
+    protected getSortedRenderMimes(model: BaseOutputView): RenderMimeContribution[];
+    defaultPreferredMimeType(model: BaseOutputView): string | undefined;
+    /**
+     * Find the preferred mime type for a mime bundle.
+     *
+     * @param bundle - The bundle of mime data.
+     *
+     * @param safe - How to consider safe/unsafe factories. If 'ensure',
+     *   it will only consider safe factories. If 'any', any factory will be
+     *   considered. If 'prefer', unsafe factories will be considered, but
+     *   only after the safe options have been exhausted.
+     *
+     * @returns The preferred mime type from the available factories,
+     *   or `undefined` if the mime type cannot be rendered.
+     */
+    preferredMimeType(model: BaseOutputView): string | undefined;
+    /**
+     * Create a renderer for a mime type.
+     *
+     * @param mimeType - The mime type of interest.
+     *
+     * @returns A new renderer for the given mime type.
+     *
+     * @throws An error if no factory exists for the mime type.
+     */
+    createRenderer(mimeType: string, model: BaseOutputView): React.FC<{
+        model: BaseOutputView;
+    }>;
+    /**
+     * Get the renderer factory registered for a mime type.
+     *
+     * @param mimeType - The mime type of interest.
+     *
+     * @returns The factory for the mime type, or `undefined`.
+     */
+    getFactory(mimeType: string): IRendererFactory | undefined;
+    /**
+     * Add a renderer factory to the rendermime.
+     *
+     * @param factory - The renderer factory of interest.
+     *
+     * @param _rank - The rank of the renderer. A lower rank indicates
+     *   a higher priority for rendering. If not given, the rank will
+     *   defer to the `defaultRank` of the factory.  If no `defaultRank`
+     *   is given, it will default to 100.
+     *
+     * #### Notes
+     * The renderer will replace an existing renderer for the given
+     * mimeType.
+     */
+    addFactory(factory: IRendererFactory, _rank?: number): void;
+    /**
+     * Remove a mime type.
+     *
+     * @param mimeType - The mime type of interest.
+     */
+    removeMimeType(mimeType: string): void;
+    /**
+     * Get the rank for a given mime type.
+     *
+     * @param mimeType - The mime type of interest.
+     *
+     * @returns The rank of the mime type or undefined.
+     */
+    getRank(mimeType: string): number | undefined;
+    /**
+     * Set the rank of a given mime type.
+     *
+     * @param mimeType - The mime type of interest.
+     *
+     * @param rank - The new rank to assign.
+     *
+     * #### Notes
+     * This is a no-op if the mime type is not registered.
+     */
+    setRank(mimeType: string, rank: number): void;
+    private _id;
+    private _ranks;
+    private _types;
+    private _factories;
+}
+//# sourceMappingURL=rendermime-registry.d.ts.map

package/es/rendermime-registry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rendermime-registry.d.ts","sourceRoot":"","sources":["../src/rendermime-registry.ts"],"names":[],"mappings":";AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAC1D,OAAO,EAAE,cAAc,EAAE,MAAM,yBAAyB,CAAC;AACzD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AAEtD,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAE5C,OAAO,EACL,sBAAsB,EACtB,0BAA0B,EAC3B,MAAM,0BAA0B,CAAC;AAClC,OAAO,KAAK,EAEV,YAAY,EACZ,gBAAgB,EAChB,mBAAmB,EACnB,SAAS,EAEV,MAAM,0BAA0B,CAAC;AAGlC;;;;;;;;;GASG;AACH,qBACa,kBAAmB,YAAW,mBAAmB;IAC5D,iBAAiB,EAAE,OAAO,CAAC;QAAE,UAAU,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,CAAC,CAAiB;IACrF,IAAI,YAAY;;;OAEf;IACD;;;;OAIG;gBAEmC,OAAO,EAAE,0BAA0B,EAC/C,cAAc,EAAE,cAAc;IAkBxD,kBAAkB,EAAE,YAAY,CAAC,QAAQ,CAAC,sBAAsB,CAAC,CAAC;IAElE;;OAEG;IACH,QAAQ,CAAC,SAAS,6CAAoB;IAEtC;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,SAAS,GAAG,IAAI,CAAC;IAEpC;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,YAAY,GAAG,IAAI,CAAC;IAE1C;;OAEG;IACH,QAAQ,CAAC,cAAc,EAAE,cAAc,GAAG,IAAI,CAAC;IAO/C;;OAEG;IACH,IAAI,SAAS,IAAI,SAAS,MAAM,EAAE,CAEjC;IAED,SAAS,CAAC,oBAAoB,CAAC,KAAK,EAAE,cAAc,GAAG,sBAAsB,EAAE;IAS/E,wBAAwB,CACtB,KAAK,EAAE,cAAc,GAEpB,MAAM,GAAG,SAAS;IAWrB;;;;;;;;;;;;OAYG;IACH,iBAAiB,CACf,KAAK,EAAE,cAAc,GAEpB,MAAM,GAAG,SAAS;IAsCrB;;;;;;;;OAQG;IACH,cAAc,CACZ,QAAQ,EAAE,MAAM,EAChB,KAAK,EAAE,cAAc,GAEpB,KAAK,CAAC,EAAE,CAAC;QAAE,KAAK,EAAE,cAAc,CAAA;KAAE,CAAC;IA4BtC;;;;;;OAMG;IACH,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,gBAAgB,GAAG,SAAS;IAI1D;;;;;;;;;;;;;OAaG;IACH,UAAU,CAAC,OAAO,EAAE,gBAAgB,EAAE,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI;IAe3D;;;;OAIG;IACH,cAAc,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAMtC;;;;;;OAMG;IACH,OAAO,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS;IAK7C;;;;;;;;;OASG;IACH,OAAO,CAAC,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI;IAS7C,OAAO,CAAC,GAAG,CAAK;IAChB,OAAO,CAAC,MAAM,CAAe;IAC7B,OAAO,CAAC,MAAM,CAAyB;IACvC,OAAO,CAAC,UAAU,CAAkB;CACrC"}