@difizen/libro-common 1.0.2 → 1.0.3

package/es/index.d.ts

@@ -10,4 +10,5 @@ export * from './display-wrapper.js';
 export * from './protocol/index.js';
 export * from './dom.js';
 export * from './mime.js';
+export * from './output-utils.js';
 //# sourceMappingURL=index.d.ts.map

package/es/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,qBAAqB,CAAC;AACpC,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAC3B,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC;AAC1B,cAAc,YAAY,CAAC;AAC3B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAC1B,cAAc,oBAAoB,CAAC;AACnC,cAAc,sBAAsB,CAAC;AACrC,cAAc,qBAAqB,CAAC;AACpC,cAAc,UAAU,CAAC;AACzB,cAAc,WAAW,CAAC;AAE1B,cAAc,mBAAmB,CAAC"}

package/es/index.js

@@ -10,4 +10,5 @@ export * from "./display-wrapper.js";
 export * from "./protocol/index.js";
 export * from "./dom.js";
 export * from "./mime.js";
-// export * from './common/index.js';
+// export * from './common/index.js';
+export * from "./output-utils.js";

package/es/output-utils.d.ts

@@ -0,0 +1,22 @@
+import type { PartialJSONObject, PartialJSONValue, ReadonlyPartialJSONObject } from './json.js';
+import type { IOutput } from './protocol/index.js';
+/**
+ * Get the data from a notebook output.
+ */
+export declare function getData(output: IOutput): PartialJSONObject;
+/**
+ * Get the metadata from an output message.
+ */
+export declare function getMetadata(output: IOutput): PartialJSONObject;
+/**
+ * Get the bundle options given output model options.
+ */
+export declare function getBundleOptions(options: IOutput): {
+    data: IOutput;
+    metadata: PartialJSONObject;
+};
+/**
+ * Extract a value from a JSONObject.
+ */
+export declare function extract(value: ReadonlyPartialJSONObject, key: string): PartialJSONValue | undefined;
+//# sourceMappingURL=output-utils.d.ts.map

package/es/output-utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"output-utils.d.ts","sourceRoot":"","sources":["../src/output-utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,iBAAiB,EACjB,gBAAgB,EAChB,yBAAyB,EAC1B,MAAM,WAAW,CAAC;AAEnB,OAAO,KAAK,EAGV,OAAO,EAER,MAAM,qBAAqB,CAAC;AAS7B;;GAEG;AACH,wBAAgB,OAAO,CAAC,MAAM,EAAE,OAAO,GAAG,iBAAiB,CA4B1D;AAED;;GAEG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,OAAO,GAAG,iBAAiB,CAQ9D;AACD;;GAEG;AACH,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,OAAO;;;EAIhD;AAED;;GAEG;AACH,wBAAgB,OAAO,CACrB,KAAK,EAAE,yBAAyB,EAChC,GAAG,EAAE,MAAM,GACV,gBAAgB,GAAG,SAAS,CAM9B"}

package/es/output-utils.js

@@ -0,0 +1,76 @@
+import { isPrimitive } from "./json.js";
+import { isDisplayData, isDisplayUpdate, isError, isExecuteResult, isStream } from "./utils.js";
+
+/**
+ * Get the data from a notebook output.
+ */
+export function getData(output) {
+  var bundle = {};
+  if (isExecuteResult(output) || isDisplayData(output) || isDisplayUpdate(output)) {
+    bundle = output.data;
+  } else if (isStream(output)) {
+    if (output.name === 'stderr') {
+      bundle['application/vnd.jupyter.stderr'] = output.text;
+    } else {
+      bundle['application/vnd.jupyter.stdout'] = output.text;
+    }
+    if (output['display_text']) {
+      if (output.name === 'stderr') {
+        bundle['application/vnd.libro.large.output.stderr'] = output['display_text'];
+      } else {
+        bundle['application/vnd.libro.large.output.stdout'] = output['display_text'];
+      }
+    }
+  } else if (isError(output)) {
+    bundle['application/vnd.jupyter.error'] = output;
+    var traceback = output.traceback.join('\n');
+    bundle['application/vnd.jupyter.stderr'] = traceback || "".concat(output.ename, ": ").concat(output.evalue);
+  }
+  return convertBundle(bundle);
+}
+
+/**
+ * Get the metadata from an output message.
+ */
+export function getMetadata(output) {
+  var value = Object.create(null);
+  if (isExecuteResult(output) || isDisplayData(output)) {
+    for (var key in output.metadata) {
+      value[key] = extract(output.metadata, key);
+    }
+  }
+  return value;
+}
+/**
+ * Get the bundle options given output model options.
+ */
+export function getBundleOptions(options) {
+  var data = getData(options);
+  var metadata = getMetadata(options);
+  return {
+    data: data,
+    metadata: metadata
+  };
+}
+
+/**
+ * Extract a value from a JSONObject.
+ */
+export function extract(value, key) {
+  var 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) {
+  var map = Object.create(null);
+  for (var mimeType in bundle) {
+    map[mimeType] = extract(bundle, mimeType);
+  }
+  return map;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@difizen/libro-common",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "",
   "keywords": [
     "libro",

package/src/index.ts

@@ -11,3 +11,4 @@ export * from './protocol/index.js';
 export * from './dom.js';
 export * from './mime.js';
 // export * from './common/index.js';
+export * from './output-utils.js';

package/src/output-utils.ts

@@ -0,0 +1,98 @@
+import type {
+  PartialJSONObject,
+  PartialJSONValue,
+  ReadonlyPartialJSONObject,
+} from './json.js';
+import { isPrimitive } from './json.js';
+import type {
+  IExecuteResult,
+  IMimeBundle,
+  IOutput,
+  MultilineString,
+} from './protocol/index.js';
+import {
+  isDisplayData,
+  isDisplayUpdate,
+  isError,
+  isExecuteResult,
+  isStream,
+} from './utils.js';
+
+/**
+ * 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;
+    }
+    if (output['display_text']) {
+      if (output.name === 'stderr') {
+        bundle['application/vnd.libro.large.output.stderr'] = output[
+          'display_text'
+        ] as MultilineString;
+      } else {
+        bundle['application/vnd.libro.large.output.stdout'] = output[
+          'display_text'
+        ] as MultilineString;
+      }
+    }
+  } 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;
+}