@difizen/libro-common 0.0.2-alpha.0

package/src/posix.ts

@@ -0,0 +1,75 @@
+const isString = function (x: any) {
+  return typeof x === 'string';
+};
+
+// resolves . and .. elements in a path array with directory names there
+// must be no slashes or device names (c:\) in the array
+// (so also no leading and trailing slashes - it does not distinguish
+// relative and absolute paths)
+function normalizeArray(parts: string[], allowAboveRoot: boolean) {
+  const res = [];
+  for (let i = 0; i < parts.length; i++) {
+    const p = parts[i];
+
+    // ignore empty parts
+    if (!p || p === '.') {
+      continue;
+    }
+
+    if (p === '..') {
+      if (res.length && res[res.length - 1] !== '..') {
+        res.pop();
+      } else if (allowAboveRoot) {
+        res.push('..');
+      }
+    } else {
+      res.push(p);
+    }
+  }
+
+  return res;
+}
+
+// posix version
+const isAbsolute = function (path: string) {
+  return path.charAt(0) === '/';
+};
+
+// path.normalize(path)
+// posix version
+const normalize = function (source: string) {
+  let path = source;
+  const isAbs = isAbsolute(path),
+    trailingSlash = path.substr(-1) === '/';
+
+  // Normalize the path
+  path = normalizeArray(path.split('/'), !isAbs).join('/');
+
+  if (!path && !isAbs) {
+    path = '.';
+  }
+  if (path && trailingSlash) {
+    path += '/';
+  }
+
+  return (isAbs ? '/' : '') + path;
+};
+
+// posix version
+export const join = function (...args: string[]) {
+  let path = '';
+  for (let i = 0; i < args.length; i++) {
+    const segment = args[i];
+    if (!isString(segment)) {
+      throw new TypeError('Arguments to path.join must be strings');
+    }
+    if (segment) {
+      if (!path) {
+        path += segment;
+      } else {
+        path += '/' + segment;
+      }
+    }
+  }
+  return normalize(path);
+};

package/src/protocol/cell-protocol.ts

@@ -0,0 +1,215 @@
+import type { PartialJSONObject } from '../json.js';
+
+import type {
+  ExecutionCount,
+  IAttachments,
+  MultilineString,
+} from './notebook-protocol.js';
+import type { IOutput } from './output-protocol.js';
+
+/**
+ * A type which describes the type of cell.
+ */
+export type CellType = 'code' | 'markdown' | 'raw' | string;
+
+/**
+ * The Jupyter metadata namespace.
+ */
+export interface IBaseCellJupyterMetadata extends PartialJSONObject {
+  /**
+   * Whether the source is hidden.
+   */
+  source_hidden: boolean;
+}
+
+/**
+ * Cell-level metadata.
+ */
+export interface IBaseCellMetadata extends PartialJSONObject {
+  /**
+   * Whether the cell is trusted.
+   *
+   * #### Notes
+   * This is not strictly part of the nbformat spec, but it is added by
+   * the contents manager.
+   *
+   * See https://jupyter-server.readthedocs.io/en/latest/operators/security.html.
+   */
+  trusted: boolean;
+
+  /**
+   * The cell's name. If present, must be a non-empty string.
+   */
+  name: string;
+
+  /**
+   * The Jupyter metadata namespace
+   */
+  jupyter: Partial<IBaseCellJupyterMetadata>;
+
+  /**
+   * The cell's tags. Tags must be unique, and must not contain commas.
+   */
+  tags: string[];
+}
+
+/**
+ * The base cell interface.
+ */
+export interface IBaseCell extends PartialJSONObject {
+  /**
+   * String identifying the type of cell.
+   */
+  cell_type: string;
+
+  /**
+   * Contents of the cell, represented as an array of lines.
+   */
+  source: MultilineString;
+
+  /**
+   * Cell-level metadata.
+   */
+  metadata: Partial<ICellMetadata>;
+}
+
+/**
+ * Metadata for the raw cell.
+ */
+export interface IRawCellMetadata extends IBaseCellMetadata {
+  /**
+   * Raw cell metadata format for nbconvert.
+   */
+  format: string;
+}
+
+/**
+ * A raw cell.
+ */
+export interface IRawCell extends IBaseCell {
+  /**
+   * A string field representing the identifier of this particular cell.
+   *
+   * Notebook format 4.4 requires no id field, but format 4.5 requires an id
+   * field. We need to handle both cases, so we make id optional here.
+   */
+  id?: string | undefined;
+
+  /**
+   * String identifying the type of cell.
+   */
+  cell_type: 'raw';
+
+  /**
+   * Cell-level metadata.
+   */
+  metadata: Partial<IRawCellMetadata>;
+
+  /**
+   * Cell attachments.
+   */
+  attachments?: IAttachments | undefined;
+}
+
+/**
+ * A markdown cell.
+ */
+export interface IMarkdownCell extends IBaseCell {
+  /**
+   * A string field representing the identifier of this particular cell.
+   *
+   * Notebook format 4.4 requires no id field, but format 4.5 requires an id
+   * field. We need to handle both cases, so we make id optional here.
+   */
+  id?: string | undefined;
+
+  /**
+   * String identifying the type of cell.
+   */
+  cell_type: 'markdown';
+
+  /**
+   * Cell attachments.
+   */
+  attachments?: IAttachments | undefined;
+}
+
+/**
+ * The Jupyter metadata namespace for code cells.
+ */
+export interface ICodeCellJupyterMetadata extends IBaseCellJupyterMetadata {
+  /**
+   * Whether the outputs are hidden. See https://github.com/jupyter/nbformat/issues/137.
+   */
+  outputs_hidden: boolean;
+}
+
+/**
+ * Metadata for a code cell.
+ */
+export interface ICodeCellMetadata extends IBaseCellMetadata {
+  /**
+   * Whether the cell is collapsed/expanded.
+   */
+  collapsed: boolean;
+
+  /**
+   * The Jupyter metadata namespace
+   */
+  jupyter: Partial<ICodeCellJupyterMetadata>;
+
+  /**
+   * Whether the cell's output is scrolled, unscrolled, or autoscrolled.
+   */
+  scrolled: boolean | 'auto';
+}
+
+/**
+ * A code cell.
+ */
+export interface ICodeCell extends IBaseCell {
+  /**
+   * A string field representing the identifier of this particular cell.
+   *
+   * Notebook format 4.4 requires no id field, but format 4.5 requires an id
+   * field. We need to handle both cases, so we make id optional here.
+   */
+  id?: string | undefined;
+
+  /**
+   * String identifying the type of cell.
+   * Changed in Libro: cell_type 不再限制只能是code，以便支持多种语言的cell
+   */
+  cell_type: string;
+  // cell_type: 'code';
+
+  /**
+   * Cell-level metadata.
+   */
+  metadata: Partial<ICodeCellMetadata>;
+
+  /**
+   * Execution, display, or stream outputs.
+   */
+  outputs: IOutput[];
+
+  /**
+   * The code cell's prompt number. Will be null if the cell has not been run.
+   */
+  execution_count: ExecutionCount;
+}
+
+/**
+ * An unrecognized cell.
+ */
+export type IUnrecognizedCell = IBaseCell;
+
+/**
+ * A cell union type.
+ */
+export type ICell = IRawCell | IMarkdownCell | ICodeCell | IUnrecognizedCell;
+
+/**
+ * A union metadata type.
+ */
+export type ICellMetadata = IBaseCellMetadata | IRawCellMetadata | ICodeCellMetadata;

package/src/protocol/index.ts

@@ -0,0 +1,3 @@
+export * from './cell-protocol.js';
+export * from './notebook-protocol.js';
+export * from './output-protocol.js';

package/src/protocol/notebook-protocol.ts

@@ -0,0 +1,73 @@
+import type { PartialJSONObject } from '../json.js';
+
+import type { ICell } from './cell-protocol.js';
+
+/**
+ * The earliest major version of the notebook format we support.
+ */
+export const MAJOR_VERSION = 4;
+
+/**
+ * The earliest minor version of the notebook format we support.
+ */
+export const MINOR_VERSION = 4;
+
+/**
+ * The kernelspec metadata.
+ */
+export interface IKernelspecMetadata extends PartialJSONObject {
+  name: string;
+  display_name: string;
+}
+
+/**
+ * The language info metadata
+ */
+export interface ILanguageInfoMetadata extends PartialJSONObject {
+  name: string;
+  codemirror_mode?: string | PartialJSONObject;
+  file_extension?: string;
+  mimetype?: string;
+  pygments_lexer?: string;
+}
+
+/**
+ * The default metadata for the notebook.
+ */
+export interface INotebookMetadata extends PartialJSONObject {
+  kernelspec?: IKernelspecMetadata;
+  language_info?: ILanguageInfoMetadata;
+  orig_nbformat?: number;
+}
+
+/**
+ * The notebook content.
+ */
+export interface INotebookContent extends PartialJSONObject {
+  metadata: INotebookMetadata;
+  nbformat_minor: number;
+  nbformat: number;
+  cells: ICell[];
+}
+
+/**
+ * A multiline string.
+ */
+export type MultilineString = string | string[];
+
+/**
+ * A mime-type keyed dictionary of data.
+ */
+export interface IMimeBundle extends PartialJSONObject {
+  [key: string]: MultilineString | PartialJSONObject;
+}
+
+/**
+ * Media attachments (e.g. inline images).
+ */
+export type IAttachments = Record<string, IMimeBundle | undefined>;
+
+/**
+ * The code cell's prompt number. Will be null if the cell has not been run.
+ */
+export type ExecutionCount = number | null;

package/src/protocol/output-protocol.ts

@@ -0,0 +1,162 @@
+import type { PartialJSONObject } from '../json.js';
+
+import type {
+  ExecutionCount,
+  IMimeBundle,
+  MultilineString,
+} from './notebook-protocol.js';
+
+/**
+ * Cell output metadata.
+ */
+export type OutputMetadata = PartialJSONObject;
+
+/**
+ * The valid output types.
+ */
+export type OutputType =
+  | 'execute_result'
+  | 'display_data'
+  | 'stream'
+  | 'error'
+  | 'update_display_data';
+
+/**
+ * The base output type.
+ */
+export interface IBaseOutput extends PartialJSONObject {
+  /**
+   * Type of cell output.
+   */
+  output_type: string;
+}
+
+/**
+ * Result of executing a code cell.
+ */
+export interface IExecuteResult extends IBaseOutput {
+  /**
+   * Type of cell output.
+   */
+  output_type: 'execute_result';
+
+  /**
+   * A result's prompt number.
+   */
+  execution_count: ExecutionCount;
+
+  /**
+   * A mime-type keyed dictionary of data.
+   */
+  data: IMimeBundle;
+
+  /**
+   * Cell output metadata.
+   */
+  metadata: OutputMetadata;
+}
+
+/**
+ * Data displayed as a result of code cell execution.
+ */
+export interface IDisplayData extends IBaseOutput {
+  /**
+   * Type of cell output.
+   */
+  output_type: 'display_data';
+
+  /**
+   * A mime-type keyed dictionary of data.
+   */
+  data: IMimeBundle;
+
+  /**
+   * Cell output metadata.
+   */
+  metadata: OutputMetadata;
+}
+
+/**
+ * Data displayed as an update to existing display data.
+ */
+export interface IDisplayUpdate extends IBaseOutput {
+  /**
+   * Type of cell output.
+   */
+  output_type: 'update_display_data';
+
+  /**
+   * A mime-type keyed dictionary of data.
+   */
+  data: IMimeBundle;
+
+  /**
+   * Cell output metadata.
+   */
+  metadata: OutputMetadata;
+}
+
+/**
+ * Stream output from a code cell.
+ */
+export interface IStream extends IBaseOutput {
+  /**
+   * Type of cell output.
+   */
+  output_type: 'stream';
+
+  /**
+   * The name of the stream.
+   */
+  name: StreamType;
+
+  /**
+   * The stream's text output.
+   */
+  text: MultilineString;
+}
+
+/**
+ * An alias for a stream type.
+ */
+export type StreamType = 'stdout' | 'stderr';
+
+/**
+ * Output of an error that occurred during code cell execution.
+ */
+export interface IError extends IBaseOutput {
+  /**
+   * Type of cell output.
+   */
+  output_type: 'error';
+
+  /**
+   * The name of the error.
+   */
+  ename: string;
+
+  /**
+   * The value, or message, of the error.
+   */
+  evalue: string;
+
+  /**
+   * The error's traceback.
+   */
+  traceback: string[];
+}
+
+/**
+ * Unrecognized output.
+ */
+export type IUnrecognizedOutput = IBaseOutput;
+
+/**
+ * An output union type.
+ */
+export type IOutput =
+  | IUnrecognizedOutput
+  | IExecuteResult
+  | IDisplayData
+  | IStream
+  | IError;