@difizen/libro-output 0.0.2-alpha.0

package/src/index.ts

@@ -0,0 +1,3 @@
+export * from './stream-output/index.js';
+export * from './error-output/index.js';
+export * from './display-data-output/index.js';

package/src/output-utils.ts

@@ -0,0 +1,84 @@
+import type {
+  IExecuteResult,
+  IMimeBundle,
+  IOutput,
+  PartialJSONObject,
+  PartialJSONValue,
+  ReadonlyPartialJSONObject,
+} from '@difizen/libro-common';
+import {
+  isDisplayData,
+  isDisplayUpdate,
+  isError,
+  isExecuteResult,
+  isPrimitive,
+  isStream,
+} from '@difizen/libro-common';
+
+/**
+ * Get the data from a notebook output.
+ */
+export function getData(output: IOutput): PartialJSONObject {
+  let bundle: IMimeBundle = {};
+  if (isExecuteResult(output) || isDisplayData(output) || isDisplayUpdate(output)) {
+    bundle = (output as IExecuteResult).data;
+  } else if (isStream(output)) {
+    if (output.name === 'stderr') {
+      bundle['application/vnd.jupyter.stderr'] = output.text;
+    } else {
+      bundle['application/vnd.jupyter.stdout'] = output.text;
+    }
+  } else if (isError(output)) {
+    bundle['application/vnd.jupyter.error'] = output;
+    const traceback = output.traceback.join('\n');
+    bundle['application/vnd.jupyter.stderr'] =
+      traceback || `${output.ename}: ${output.evalue}`;
+  }
+  return convertBundle(bundle);
+}
+
+/**
+ * Get the metadata from an output message.
+ */
+export function getMetadata(output: IOutput): PartialJSONObject {
+  const value: PartialJSONObject = Object.create(null);
+  if (isExecuteResult(output) || isDisplayData(output)) {
+    for (const key in output.metadata) {
+      value[key] = extract(output.metadata, key);
+    }
+  }
+  return value;
+}
+/**
+ * Get the bundle options given output model options.
+ */
+export function getBundleOptions(options: IOutput) {
+  const data = getData(options) as IOutput;
+  const metadata = getMetadata(options);
+  return { data, metadata };
+}
+
+/**
+ * Extract a value from a JSONObject.
+ */
+export function extract(
+  value: ReadonlyPartialJSONObject,
+  key: string,
+): PartialJSONValue | undefined {
+  const item = value[key];
+  if (item === undefined || isPrimitive(item)) {
+    return item;
+  }
+  return JSON.parse(JSON.stringify(item));
+}
+
+/**
+ * Convert a mime bundle to mime data.
+ */
+function convertBundle(bundle: IMimeBundle): PartialJSONObject {
+  const map: PartialJSONObject = Object.create(null);
+  for (const mimeType in bundle) {
+    map[mimeType] = extract(bundle, mimeType);
+  }
+  return map;
+}

package/src/stream-output/index.ts

@@ -0,0 +1,3 @@
+export * from './stream-output-contribution.js';
+export * from './stream-output-model.js';
+export * from './stream-output-module.js';

package/src/stream-output/stream-output-contribution.ts

@@ -0,0 +1,21 @@
+import type { IOutput } from '@difizen/libro-common';
+import type { IOutputOptions } from '@difizen/libro-core';
+import { OutputContribution } from '@difizen/libro-core';
+import { inject, singleton } from '@difizen/mana-app';
+import { ViewManager } from '@difizen/mana-app';
+
+import { StreamOutputModel } from './stream-output-model.js';
+
+@singleton({ contrib: OutputContribution })
+export class StreamOutputContribution implements OutputContribution {
+  @inject(ViewManager) viewManager: ViewManager;
+  canHandle = (output: IOutput) => {
+    if (output.output_type === 'stream') {
+      return 100;
+    }
+    return 1;
+  };
+  factory(output: IOutputOptions) {
+    return this.viewManager.getOrCreateView(StreamOutputModel, output);
+  }
+}

package/src/stream-output/stream-output-model.tsx

@@ -0,0 +1,60 @@
+import type { JSONObject } from '@difizen/libro-common';
+import { LibroOutputView } from '@difizen/libro-core';
+import type { BaseOutputView, IOutputOptions } from '@difizen/libro-core';
+import { RenderMimeRegistry } from '@difizen/libro-rendermime';
+import type { IRenderMimeRegistry } from '@difizen/libro-rendermime';
+import { inject, transient } from '@difizen/mana-app';
+import {
+  getOrigin,
+  useInject,
+  view,
+  ViewInstance,
+  ViewOption,
+} from '@difizen/mana-app';
+import { forwardRef } from 'react';
+
+import '../index.less';
+
+import { getBundleOptions } from '../output-utils.js';
+
+const StreamOutputModelRender = forwardRef<HTMLDivElement>(
+  function StreamOutputModelRender(_props, ref) {
+    const output = useInject<StreamOutputModel>(ViewInstance);
+    const model = getOrigin(output);
+    const defaultRenderMime = useInject<IRenderMimeRegistry>(RenderMimeRegistry);
+    const defaultRenderMimeType = defaultRenderMime.preferredMimeType(model);
+    if (defaultRenderMimeType) {
+      const OutputRender = defaultRenderMime.createRenderer(
+        defaultRenderMimeType,
+        model,
+      );
+      const children = <OutputRender model={model} />;
+      return (
+        <div ref={ref} className={'libro-stream-container'}>
+          {children}
+        </div>
+      );
+    } else {
+      return null;
+    }
+  },
+);
+@transient()
+@view('libro-stream-output-model')
+export class StreamOutputModel extends LibroOutputView implements BaseOutputView {
+  constructor(@inject(ViewOption) options: IOutputOptions) {
+    super(options);
+    const { data, metadata } = getBundleOptions(options.output);
+    this.type = options.output.output_type;
+    this.data = data as JSONObject;
+    this.metadata = metadata;
+  }
+  override view = StreamOutputModelRender;
+  override toJSON() {
+    return {
+      output_type: this.raw.output_type,
+      name: this.raw.name,
+      text: this.raw.text,
+    };
+  }
+}

package/src/stream-output/stream-output-module.ts

@@ -0,0 +1,10 @@
+import { OutputModule } from '@difizen/libro-core';
+import { LibroRenderMimeModule } from '@difizen/libro-rendermime';
+import { ManaModule } from '@difizen/mana-app';
+
+import { StreamOutputContribution } from './stream-output-contribution.js';
+import { StreamOutputModel } from './stream-output-model.js';
+
+export const StreamOutputModule = ManaModule.create()
+  .register(StreamOutputModel, StreamOutputContribution)
+  .dependOn(OutputModule, LibroRenderMimeModule);