@difizen/libro-rendermime 0.0.0-snapshot-20241017072317

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023-present Difizen Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,43 @@
+# libro-rendermime
+
+该包提供了 `LibroRenderMimeModule` 模块用于识别不同数据格式的内容并且正确解析渲染。通过定义多个 MIME 类型和优先级，可以在不同的环境中提供灵活的输出展示选项，以适应各种类型的数据和前端环境的要求。内置了文本、图片、Markdown、HTML、SVG 等 MIME 渲染器，同时提供 MIME 渲染器扩展，支持扩展更多自定义的 MIME 类型渲染。
+
+## Token/API
+
+### RenderMimeRegistry
+
+RenderMimeRegistry 管理 MIME，提供获取当前输出最合适的 MIME 类型，基于输出和类型创建对应的渲染器，MIME 渲染监听等能力。
+
+```typescript
+// 组件内引入
+const renderMimeRegistry = useInject(RenderMimeRegistry);
+
+// 属性引入
+@inject(RenderMimeRegistry) renderMimeRegistry:RenderMimeRegistry;
+
+// 事件监听
+renderMimeRegistry.onMimeRender();
+
+//获取当前输出最合适的 MIME 类型
+const preferredMimeType = renderMimeRegistry.preferredMimeType(model)
+
+//基于输出和类型创建对应的渲染器
+const OutputRender = defaultRenderMime.createRenderer(
+  preferredMimeType,
+  model,
+);
+```
+
+## 扩展点
+
+### MIME 渲染器扩展
+
+```typescript
+export interface RenderMimeContribution {
+  canHandle: (model: BaseOutputView) => number;
+  safe: boolean;
+  renderType: string;
+  mimeTypes: string[];
+  render: React.FC<{ model: BaseOutputView; options?: Record<string, any> }>;
+}
+```

package/es/components/html-render.d.ts

@@ -0,0 +1,6 @@
+import type { BaseOutputView } from '@difizen/libro-core';
+import React from 'react';
+export declare const HTMLRender: React.FC<{
+    model: BaseOutputView;
+}>;
+//# sourceMappingURL=html-render.d.ts.map

package/es/components/html-render.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"html-render.d.ts","sourceRoot":"","sources":["../../src/components/html-render.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAE1D,OAAO,KAA4B,MAAM,OAAO,CAAC;AAMjD,eAAO,MAAM,UAAU,EAAE,KAAK,CAAC,EAAE,CAAC;IAAE,KAAK,EAAE,cAAc,CAAA;CAAE,CAgC1D,CAAC"}

package/es/components/html-render.js

@@ -0,0 +1,38 @@
+import { concatMultilineString } from '@difizen/libro-common';
+import { useInject } from '@difizen/mana-app';
+import React, { useEffect, useRef } from 'react';
+import { renderHTML } from "../renderers.js";
+import { RenderMimeRegistry } from "../rendermime-registry.js";
+import { jsx as _jsx } from "react/jsx-runtime";
+export var HTMLRender = function HTMLRender(props) {
+  var model = props.model;
+  var renderHTMLRef = useRef(null);
+  var defaultRenderMime = useInject(RenderMimeRegistry);
+  var mimeType = defaultRenderMime.defaultPreferredMimeType(model
+  // model.trusted ? 'any' : 'ensure'
+  );
+  useEffect(function () {
+    if (mimeType) {
+      renderHTML({
+        host: renderHTMLRef.current,
+        source: concatMultilineString(JSON.parse(JSON.stringify(model.data[mimeType]))),
+        trusted: model.trusted,
+        resolver: defaultRenderMime.resolver,
+        sanitizer: defaultRenderMime.sanitizer,
+        linkHandler: defaultRenderMime.linkHandler,
+        shouldTypeset: false
+      });
+    }
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, []);
+  return /*#__PURE__*/_jsx("div", {
+    className: "libro-html-render-container",
+    children: /*#__PURE__*/_jsx("div", {
+      className: "libro-html-common-render",
+      children: /*#__PURE__*/_jsx("div", {
+        className: "libro-html-render",
+        ref: renderHTMLRef
+      })
+    })
+  });
+};

package/es/components/image-render.d.ts

@@ -0,0 +1,6 @@
+import type { BaseOutputView } from '@difizen/libro-core';
+import React from 'react';
+export declare const ImageRender: React.FC<{
+    model: BaseOutputView;
+}>;
+//# sourceMappingURL=image-render.d.ts.map

package/es/components/image-render.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"image-render.d.ts","sourceRoot":"","sources":["../../src/components/image-render.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAE1D,OAAO,KAA4B,MAAM,OAAO,CAAC;AAMjD,eAAO,MAAM,WAAW,EAAE,KAAK,CAAC,EAAE,CAAC;IAAE,KAAK,EAAE,cAAc,CAAA;CAAE,CAmC3D,CAAC"}

package/es/components/image-render.js

@@ -0,0 +1,35 @@
+import { concatMultilineString } from '@difizen/libro-common';
+import { useInject } from '@difizen/mana-app';
+import React, { useEffect, useRef } from 'react';
+import { renderImage } from "../renderers.js";
+import { RenderMimeRegistry } from "../rendermime-registry.js";
+import { jsx as _jsx } from "react/jsx-runtime";
+export var ImageRender = function ImageRender(props) {
+  var model = props.model;
+  var renderImageRef = useRef(null);
+  var defaultRenderMime = useInject(RenderMimeRegistry);
+  var mimeType = defaultRenderMime.defaultPreferredMimeType(model
+  // model.trusted ? 'any' : 'ensure'
+  );
+  useEffect(function () {
+    if (mimeType) {
+      var _model$metadata$mimeT, _model$metadata$mimeT2;
+      renderImage({
+        host: renderImageRef.current,
+        source: concatMultilineString(JSON.parse(JSON.stringify(model.data[mimeType]))),
+        width: model.metadata['width'] || ((_model$metadata$mimeT = model.metadata[mimeType]) === null || _model$metadata$mimeT === void 0 ? void 0 : _model$metadata$mimeT['width']),
+        height: model.metadata['height'] || ((_model$metadata$mimeT2 = model.metadata[mimeType]) === null || _model$metadata$mimeT2 === void 0 ? void 0 : _model$metadata$mimeT2['height']),
+        needsBackground: model.metadata['needs_background'],
+        unconfined: model.metadata && model.metadata['unconfined'],
+        mimeType: mimeType
+      });
+    }
+  }, [mimeType, model.data, model.metadata, renderImageRef]);
+  return /*#__PURE__*/_jsx("div", {
+    className: "libro-image-render-container",
+    children: /*#__PURE__*/_jsx("div", {
+      className: "libro-image-render",
+      ref: renderImageRef
+    })
+  });
+};

package/es/components/index.d.ts

@@ -0,0 +1,7 @@
+export * from './html-render.js';
+export * from './image-render.js';
+export * from './markdown-render.js';
+export * from './svg-render.js';
+export * from './text-render.js';
+export * from './latex-render.js';
+//# sourceMappingURL=index.d.ts.map

package/es/components/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/components/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,iBAAiB,CAAC;AAChC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC"}

package/es/components/index.js

@@ -0,0 +1,6 @@
+export * from "./html-render.js";
+export * from "./image-render.js";
+export * from "./markdown-render.js";
+export * from "./svg-render.js";
+export * from "./text-render.js";
+export * from "./latex-render.js";

package/es/components/latex-render.d.ts

@@ -0,0 +1,6 @@
+import type { BaseOutputView } from '@difizen/libro-core';
+import React from 'react';
+export declare const LatexRender: React.FC<{
+    model: BaseOutputView;
+}>;
+//# sourceMappingURL=latex-render.d.ts.map

package/es/components/latex-render.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"latex-render.d.ts","sourceRoot":"","sources":["../../src/components/latex-render.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAE1D,OAAO,KAAK,MAAM,OAAO,CAAC;AAK1B,eAAO,MAAM,WAAW,EAAE,KAAK,CAAC,EAAE,CAAC;IAAE,KAAK,EAAE,cAAc,CAAA;CAAE,CAqB3D,CAAC"}

package/es/components/latex-render.js

@@ -0,0 +1,22 @@
+import { concatMultilineString } from '@difizen/libro-common';
+import { useInject } from '@difizen/mana-app';
+import React from 'react';
+import { RenderMimeRegistry } from "../rendermime-registry.js";
+import { jsx as _jsx } from "react/jsx-runtime";
+export var LatexRender = function LatexRender(props) {
+  var model = props.model;
+  var defaultRenderMime = useInject(RenderMimeRegistry);
+  var mimeType = defaultRenderMime.defaultPreferredMimeType(model
+  // model.trusted ? 'any' : 'ensure'
+  );
+  if (!mimeType) {
+    return null;
+  }
+  return /*#__PURE__*/_jsx("div", {
+    className: "libro-latex-render-container",
+    children: /*#__PURE__*/_jsx("div", {
+      className: "libro-latex-render",
+      children: concatMultilineString(JSON.parse(JSON.stringify(model.data[mimeType])))
+    })
+  });
+};

package/es/components/markdown-render.d.ts

@@ -0,0 +1,6 @@
+import type { BaseOutputView } from '@difizen/libro-core';
+import React from 'react';
+export declare const MarkdownRender: React.FC<{
+    model: BaseOutputView;
+}>;
+//# sourceMappingURL=markdown-render.d.ts.map

package/es/components/markdown-render.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"markdown-render.d.ts","sourceRoot":"","sources":["../../src/components/markdown-render.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAE1D,OAAO,KAA4B,MAAM,OAAO,CAAC;AAMjD,eAAO,MAAM,cAAc,EAAE,KAAK,CAAC,EAAE,CAAC;IAAE,KAAK,EAAE,cAAc,CAAA;CAAE,CAgC9D,CAAC"}

package/es/components/markdown-render.js

@@ -0,0 +1,37 @@
+import { concatMultilineString } from '@difizen/libro-common';
+import { useInject } from '@difizen/mana-app';
+import React, { useEffect, useRef } from 'react';
+import { renderMarkdown } from "../renderers.js";
+import { RenderMimeRegistry } from "../rendermime-registry.js";
+import { jsx as _jsx } from "react/jsx-runtime";
+export var MarkdownRender = function MarkdownRender(props) {
+  var model = props.model;
+  var renderMarkdownRef = useRef(null);
+  var defaultRenderMime = useInject(RenderMimeRegistry);
+  var mimeType = defaultRenderMime.defaultPreferredMimeType(model
+  // model.trusted ? 'any' : 'ensure'
+  );
+  useEffect(function () {
+    if (mimeType) {
+      renderMarkdown({
+        host: renderMarkdownRef.current,
+        source: concatMultilineString(JSON.parse(JSON.stringify(model.data[mimeType]))),
+        trusted: model.trusted,
+        resolver: defaultRenderMime.resolver,
+        sanitizer: defaultRenderMime.sanitizer,
+        linkHandler: defaultRenderMime.linkHandler,
+        // shouldTypeset: options.isAttached,
+        markdownParser: defaultRenderMime.markdownParser,
+        cellId: model.cell.model.id
+      });
+    }
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, []);
+  return /*#__PURE__*/_jsx("div", {
+    className: "libro-markdown-render-container",
+    children: /*#__PURE__*/_jsx("div", {
+      className: "libro-markdown-render",
+      ref: renderMarkdownRef
+    })
+  });
+};

package/es/components/svg-render.d.ts

@@ -0,0 +1,6 @@
+import type { BaseOutputView } from '@difizen/libro-core';
+import React from 'react';
+export declare const SVGRender: React.FC<{
+    model: BaseOutputView;
+}>;
+//# sourceMappingURL=svg-render.d.ts.map

package/es/components/svg-render.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"svg-render.d.ts","sourceRoot":"","sources":["../../src/components/svg-render.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAE1D,OAAO,KAA4B,MAAM,OAAO,CAAC;AAMjD,eAAO,MAAM,SAAS,EAAE,KAAK,CAAC,EAAE,CAAC;IAAE,KAAK,EAAE,cAAc,CAAA;CAAE,CA4BzD,CAAC"}

package/es/components/svg-render.js

@@ -0,0 +1,32 @@
+import { concatMultilineString } from '@difizen/libro-common';
+import { useInject } from '@difizen/mana-app';
+import React, { useEffect, useRef } from 'react';
+import { renderSVG } from "../renderers.js";
+import { RenderMimeRegistry } from "../rendermime-registry.js";
+import { jsx as _jsx } from "react/jsx-runtime";
+export var SVGRender = function SVGRender(props) {
+  var model = props.model;
+  var renderSVGRef = useRef(null);
+  var defaultRenderMime = useInject(RenderMimeRegistry);
+  var mimeType = defaultRenderMime.defaultPreferredMimeType(model
+  // model.trusted ? 'any' : 'ensure'
+  );
+  useEffect(function () {
+    if (mimeType) {
+      renderSVG({
+        host: renderSVGRef.current,
+        source: concatMultilineString(JSON.parse(JSON.stringify(model.data[mimeType]))),
+        trusted: model.trusted,
+        unconfined: model.metadata && model.metadata['unconfined']
+      });
+    }
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, []);
+  return /*#__PURE__*/_jsx("div", {
+    className: "libro-svg-render-container",
+    children: /*#__PURE__*/_jsx("div", {
+      className: "libro-svg-render",
+      ref: renderSVGRef
+    })
+  });
+};

package/es/components/text-render.d.ts

@@ -0,0 +1,9 @@
+import type { BaseOutputView } from '@difizen/libro-core';
+import React from 'react';
+export declare const RawTextRender: React.FC<{
+    model: BaseOutputView;
+}>;
+export declare const TextRender: React.NamedExoticComponent<{
+    model: BaseOutputView;
+}>;
+//# sourceMappingURL=text-render.d.ts.map

package/es/components/text-render.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"text-render.d.ts","sourceRoot":"","sources":["../../src/components/text-render.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAE1D,OAAO,KAA4B,MAAM,OAAO,CAAC;AAMjD,eAAO,MAAM,aAAa,EAAE,KAAK,CAAC,EAAE,CAAC;IAAE,KAAK,EAAE,cAAc,CAAA;CAAE,CAsC7D,CAAC;AAEF,eAAO,MAAM,UAAU;WAxCuB,cAAc;EAwCT,CAAC"}

package/es/components/text-render.js

@@ -0,0 +1,43 @@
+import { concatMultilineString } from '@difizen/libro-common';
+import { useInject } from '@difizen/mana-app';
+import React, { useEffect, useRef } from 'react';
+import { renderText } from "../renderers.js";
+import { RenderMimeRegistry } from "../rendermime-registry.js";
+import { jsx as _jsx } from "react/jsx-runtime";
+export var RawTextRender = function RawTextRender(props) {
+  var model = props.model;
+  var renderTextRef = useRef(null);
+  var renderTextContainerRef = useRef(null);
+  var defaultRenderMime = useInject(RenderMimeRegistry);
+  var mimeType = defaultRenderMime.defaultPreferredMimeType(model
+  // model.trusted ? 'any' : 'ensure'
+  );
+  var dataContent = null;
+  if (mimeType) {
+    dataContent = model.data[mimeType];
+  }
+  useEffect(function () {
+    if (dataContent && mimeType) {
+      renderText({
+        host: renderTextRef.current,
+        source: concatMultilineString(JSON.parse(JSON.stringify(dataContent))),
+        sanitizer: defaultRenderMime.sanitizer,
+        mimeType: mimeType
+      });
+      if (mimeType === 'application/vnd.jupyter.stderr') {
+        var _renderTextContainerR;
+        (_renderTextContainerR = renderTextContainerRef.current) === null || _renderTextContainerR === void 0 || _renderTextContainerR.setAttribute('data-mime-type', 'application/vnd.jupyter.stderr');
+      }
+    }
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, [mimeType, dataContent]);
+  return /*#__PURE__*/_jsx("div", {
+    className: "libro-text-render-container",
+    ref: renderTextContainerRef,
+    children: /*#__PURE__*/_jsx("div", {
+      className: "libro-text-render",
+      ref: renderTextRef
+    })
+  });
+};
+export var TextRender = /*#__PURE__*/React.memo(RawTextRender);

package/es/index.d.ts

@@ -0,0 +1,7 @@
+export * from './rendermime-utils.js';
+export * from './renderers.js';
+export * from './rendermime-registry.js';
+export * from './rendermime-protocol.js';
+export * from './rendermime-factory.js';
+export * from './rendermime-module.js';
+//# sourceMappingURL=index.d.ts.map

package/es/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC;AACtC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,0BAA0B,CAAC;AACzC,cAAc,0BAA0B,CAAC;AACzC,cAAc,yBAAyB,CAAC;AACxC,cAAc,wBAAwB,CAAC"}

package/es/index.js

@@ -0,0 +1,6 @@
+export * from "./rendermime-utils.js";
+export * from "./renderers.js";
+export * from "./rendermime-registry.js";
+export * from "./rendermime-protocol.js";
+export * from "./rendermime-factory.js";
+export * from "./rendermime-module.js";

package/es/renderers.d.ts

@@ -0,0 +1,42 @@
+import type { IRenderHTMLOptions, IRenderImageOptions, IRenderMarkdownOptions, IRenderSVGOptions, IRenderTextOptions } from './rendermime-protocol.js';
+/**
+ * Render text into a host node.
+ *
+ * @param options - The options for rendering.
+ *
+ * @returns A promise which resolves when rendering is complete.
+ */
+export declare function renderText(options: IRenderTextOptions): Promise<void>;
+/**
+ * Render an image into a host node.
+ *
+ * @param options - The options for rendering.
+ *
+ * @returns A promise which resolves when rendering is complete.
+ */
+export declare function renderImage(options: IRenderImageOptions): Promise<void>;
+/**
+ * Render HTML into a host node.
+ *
+ * @param options - The options for rendering.
+ *
+ * @returns A promise which resolves when rendering is complete.
+ */
+export declare function renderHTML(options: IRenderHTMLOptions): Promise<void>;
+/**
+ * Render SVG into a host node.
+ *
+ * @param options - The options for rendering.
+ *
+ * @returns A promise which resolves when rendering is complete.
+ */
+export declare function renderSVG(options: IRenderSVGOptions): Promise<void>;
+/**
+ * Render Markdown into a host node.
+ *
+ * @param options - The options for rendering.
+ *
+ * @returns A promise which resolves when rendering is complete.
+ */
+export declare function renderMarkdown(options: IRenderMarkdownOptions): Promise<void>;
+//# sourceMappingURL=renderers.d.ts.map

package/es/renderers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"renderers.d.ts","sourceRoot":"","sources":["../src/renderers.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EACV,kBAAkB,EAClB,mBAAmB,EACnB,sBAAsB,EACtB,iBAAiB,EACjB,kBAAkB,EACnB,MAAM,0BAA0B,CAAC;AAUlC;;;;;;GAMG;AACH,wBAAgB,UAAU,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC,CAmGrE;AAED;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,OAAO,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC,CAqCvE;AAED;;;;;;GAMG;AACH,wBAAgB,UAAU,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC,CAuErE;AAED;;;;;;GAMG;AACH,wBAAgB,SAAS,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC,CA+BnE;AAED;;;;;;GAMG;AACH,wBAAsB,cAAc,CAAC,OAAO,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC,CAyBnF"}