@difizen/libro-common 0.0.2-alpha.0

package/es/url.d.ts

@@ -0,0 +1,98 @@
+/**
+ * The namespace for URL-related functions.
+ */
+export declare class URL {
+    /**
+     * Parse URL and retrieve hostname
+     *
+     * @param url - The URL string to parse
+     *
+     * @returns a hostname string value
+     */
+    static getHostName(url: string): string;
+    /**
+     * Normalize a url.
+     */
+    static normalize(url: string): string;
+    static normalize(url: undefined): undefined;
+    static normalize(url: string | undefined): string | undefined;
+    /**
+     * Join a sequence of url components and normalizes as in node `path.join`.
+     *
+     * @param parts - The url components.
+     *
+     * @returns the joined url.
+     */
+    static join(...parts: string[]): string;
+    /**
+     * Encode the components of a multi-segment url.
+     *
+     * @param url - The url to encode.
+     *
+     * @returns the encoded url.
+     *
+     * #### Notes
+     * Preserves the `'/'` separators.
+     * Should not include the base url, since all parts are escaped.
+     */
+    static encodeParts(url: string): string;
+    /**
+     * Parse a url into a URL object.
+     *
+     * @param urlString - The URL string to parse.
+     *
+     * @returns A URL object.
+     */
+    static parse(url: string): IUrl;
+    /**
+     * Test whether the url is a local url.
+     *
+     * #### Notes
+     * This function returns `false` for any fully qualified url, including
+     * `data:`, `file:`, and `//` protocol URLs.
+     */
+    static isLocal(url: string): boolean;
+}
+/**
+ * The interface for a URL object
+ */
+export interface IUrl {
+    /**
+     * The full URL string that was parsed with both the protocol and host
+     * components converted to lower-case.
+     */
+    href: string;
+    /**
+     * Identifies the URL's lower-cased protocol scheme.
+     */
+    protocol: string;
+    /**
+     * The full lower-cased host portion of the URL, including the port if
+     * specified.
+     */
+    host: string;
+    /**
+     * The lower-cased host name portion of the host component without the
+     * port included.
+     */
+    hostname: string;
+    /**
+     * The numeric port portion of the host component.
+     */
+    port: string;
+    /**
+     * The entire path section of the URL.
+     */
+    pathname: string;
+    /**
+     * The "fragment" portion of the URL including the leading ASCII hash
+     * `(#)` character
+     */
+    hash: string;
+    /**
+     * The search element, including leading question mark (`'?'`), if any,
+     * of the URL.
+     */
+    search?: string;
+}
+//# sourceMappingURL=url.d.ts.map

package/es/url.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"url.d.ts","sourceRoot":"","sources":["../src/url.ts"],"names":[],"mappings":"AAIA;;GAEG;AAEH,qBAAa,GAAG;IACd;;;;;;OAMG;IACH,MAAM,CAAC,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;IAGvC;;OAEG;IACH,MAAM,CAAC,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;IACrC,MAAM,CAAC,SAAS,CAAC,GAAG,EAAE,SAAS,GAAG,SAAS;IAC3C,MAAM,CAAC,SAAS,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS;IAa7D;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,EAAE,MAAM,EAAE,GAAG,MAAM;IAmBvC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM;IAGvC;;;;;;OAMG;IACH,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAQ/B;;;;;;OAMG;IACH,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;CAOrC;AAED;;GAEG;AACH,MAAM,WAAW,IAAI;IACnB;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB"}

package/es/url.js

@@ -0,0 +1,134 @@
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
+function _toConsumableArray(arr) { return _arrayWithoutHoles(arr) || _iterableToArray(arr) || _unsupportedIterableToArray(arr) || _nonIterableSpread(); }
+function _nonIterableSpread() { throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+function _iterableToArray(iter) { if (typeof Symbol !== "undefined" && iter[Symbol.iterator] != null || iter["@@iterator"] != null) return Array.from(iter); }
+function _arrayWithoutHoles(arr) { if (Array.isArray(arr)) return _arrayLikeToArray(arr); }
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
+function _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError("Cannot call a class as a function"); } }
+function _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if ("value" in descriptor) descriptor.writable = true; Object.defineProperty(target, _toPropertyKey(descriptor.key), descriptor); } }
+function _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); Object.defineProperty(Constructor, "prototype", { writable: false }); return Constructor; }
+function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
+function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
+import { isWeb } from '@difizen/mana-common';
+import { posix } from 'path-browserify';
+import urlparse from 'url-parse';
+
+/**
+ * The namespace for URL-related functions.
+ */
+// eslint-disable-next-line @typescript-eslint/no-namespace
+export var URL = /*#__PURE__*/function () {
+  function URL() {
+    _classCallCheck(this, URL);
+  }
+  _createClass(URL, null, [{
+    key: "getHostName",
+    value:
+    /**
+     * Parse URL and retrieve hostname
+     *
+     * @param url - The URL string to parse
+     *
+     * @returns a hostname string value
+     */
+    function getHostName(url) {
+      return urlparse(url).hostname;
+    }
+    /**
+     * Normalize a url.
+     */
+  }, {
+    key: "normalize",
+    value: function normalize(url) {
+      if (!url) {
+        return undefined;
+      }
+      if (isWeb) {
+        var a = document.createElement('a');
+        a.href = url;
+        return a.toString();
+      }
+      return urlparse(url).toString();
+    }
+
+    /**
+     * Join a sequence of url components and normalizes as in node `path.join`.
+     *
+     * @param parts - The url components.
+     *
+     * @returns the joined url.
+     */
+  }, {
+    key: "join",
+    value: function join() {
+      for (var _len = arguments.length, parts = new Array(_len), _key = 0; _key < _len; _key++) {
+        parts[_key] = arguments[_key];
+      }
+      var u = urlparse(parts[0], {});
+      // Schema-less URL can be only parsed as relative to a base URL
+      // see https://github.com/unshiftio/url-parse/issues/219#issuecomment-1002219326
+      var isSchemaLess = u.protocol === '' && u.slashes;
+      if (isSchemaLess) {
+        u = urlparse(parts[0], 'https:' + parts[0]);
+      }
+      var prefix = "".concat(isSchemaLess ? '' : u.protocol).concat(u.slashes ? '//' : '').concat(u.auth).concat(u.auth ? '@' : '').concat(u.host);
+      // If there was a prefix, then the first path must start at the root.
+      var path = posix.join.apply(posix, ["".concat(!!prefix && u.pathname[0] !== '/' ? '/' : '').concat(u.pathname)].concat(_toConsumableArray(parts.slice(1))));
+      return "".concat(prefix).concat(path === '.' ? '' : path);
+    }
+
+    /**
+     * Encode the components of a multi-segment url.
+     *
+     * @param url - The url to encode.
+     *
+     * @returns the encoded url.
+     *
+     * #### Notes
+     * Preserves the `'/'` separators.
+     * Should not include the base url, since all parts are escaped.
+     */
+  }, {
+    key: "encodeParts",
+    value: function encodeParts(url) {
+      return URL.join.apply(URL, _toConsumableArray(url.split('/').map(encodeURIComponent)));
+    }
+    /**
+     * Parse a url into a URL object.
+     *
+     * @param urlString - The URL string to parse.
+     *
+     * @returns A URL object.
+     */
+  }, {
+    key: "parse",
+    value: function parse(url) {
+      if (typeof document !== 'undefined' && document) {
+        var a = document.createElement('a');
+        a.href = url;
+        return a;
+      }
+      return urlparse(url);
+    }
+    /**
+     * Test whether the url is a local url.
+     *
+     * #### Notes
+     * This function returns `false` for any fully qualified url, including
+     * `data:`, `file:`, and `//` protocol URLs.
+     */
+  }, {
+    key: "isLocal",
+    value: function isLocal(url) {
+      var _URL$parse = URL.parse(url),
+        protocol = _URL$parse.protocol;
+      return (!protocol || url.toLowerCase().indexOf(protocol) !== 0) && url.indexOf('/') !== 0;
+    }
+  }]);
+  return URL;
+}();
+
+/**
+ * The interface for a URL object
+ */

package/es/utils.d.ts

@@ -0,0 +1,57 @@
+import type { PartialJSONObject, PartialJSONValue } from './json.js';
+import type { ICell, ICodeCell, IMarkdownCell, IRawCell } from './protocol/cell-protocol.js';
+import type { MultilineString } from './protocol/notebook-protocol.js';
+import type { IDisplayData, IDisplayUpdate, IError, IExecuteResult, IOutput, IStream } from './protocol/output-protocol.js';
+/**
+ * Validate a mime type/value pair.
+ *
+ * @param type - The mimetype name.
+ *
+ * @param value - The value associated with the type.
+ *
+ * @returns Whether the type/value pair are valid.
+ */
+export declare function validateMimeValue(type: string, value: MultilineString | PartialJSONObject): boolean;
+/**
+ * join multiline string, normalizing line endings to \n
+ * @param value
+ * @returns
+ */
+export declare function concatMultilineString(value: MultilineString): string;
+/**
+ * Test whether a cell is a raw cell.
+ */
+export declare function isRaw(cell: ICell): cell is IRawCell;
+/**
+ * Test whether a cell is a markdown cell.
+ */
+export declare function isMarkdown(cell: ICell): cell is IMarkdownCell;
+/**
+ * Test whether a cell is a code cell.
+ */
+export declare function isCode(cell: ICell): cell is ICodeCell;
+/**
+ * Test whether a cell is a code cell.
+ */
+export declare function isOutput(output: PartialJSONValue | IOutput[] | undefined): output is IOutput[];
+/**
+ * Test whether an output is an execute result.
+ */
+export declare function isExecuteResult(output: IOutput): output is IExecuteResult;
+/**
+ * Test whether an output is from display data.
+ */
+export declare function isDisplayData(output: IOutput): output is IDisplayData;
+/**
+ * Test whether an output is from updated display data.
+ */
+export declare function isDisplayUpdate(output: IOutput): output is IDisplayUpdate;
+/**
+ * Test whether an output is from a stream.
+ */
+export declare function isStream(output: IOutput): output is IStream;
+/**
+ * Test whether an output is an error.
+ */
+export declare function isError(output: IOutput): output is IError;
+//# sourceMappingURL=utils.d.ts.map

package/es/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAErE,OAAO,KAAK,EACV,KAAK,EACL,SAAS,EACT,aAAa,EACb,QAAQ,EACT,MAAM,6BAA6B,CAAC;AACrC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AACvE,OAAO,KAAK,EACV,YAAY,EACZ,cAAc,EACd,MAAM,EACN,cAAc,EACd,OAAO,EACP,OAAO,EACR,MAAM,+BAA+B,CAAC;AAEvC;;;;;;;;GAQG;AACH,wBAAgB,iBAAiB,CAC/B,IAAI,EAAE,MAAM,EACZ,KAAK,EAAE,eAAe,GAAG,iBAAiB,GACzC,OAAO,CAoCT;AAED;;;;GAIG;AACH,wBAAgB,qBAAqB,CAAC,KAAK,EAAE,eAAe,GAAG,MAAM,CAMpE;AAED;;GAEG;AACH,wBAAgB,KAAK,CAAC,IAAI,EAAE,KAAK,GAAG,IAAI,IAAI,QAAQ,CAEnD;AAED;;GAEG;AACH,wBAAgB,UAAU,CAAC,IAAI,EAAE,KAAK,GAAG,IAAI,IAAI,aAAa,CAE7D;AAED;;GAEG;AACH,wBAAgB,MAAM,CAAC,IAAI,EAAE,KAAK,GAAG,IAAI,IAAI,SAAS,CAErD;AAED;;GAEG;AACH,wBAAgB,QAAQ,CACtB,MAAM,EAAE,gBAAgB,GAAG,OAAO,EAAE,GAAG,SAAS,GAC/C,MAAM,IAAI,OAAO,EAAE,CAErB;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,cAAc,CAEzE;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,YAAY,CAErE;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,cAAc,CAEzE;AAED;;GAEG;AACH,wBAAgB,QAAQ,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,OAAO,CAE3D;AAED;;GAEG;AACH,wBAAgB,OAAO,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,IAAI,MAAM,CAEzD"}

package/es/utils.js

@@ -0,0 +1,124 @@
+import { isObject } from "./json.js";
+/**
+ * Validate a mime type/value pair.
+ *
+ * @param type - The mimetype name.
+ *
+ * @param value - The value associated with the type.
+ *
+ * @returns Whether the type/value pair are valid.
+ */
+export function validateMimeValue(type, value) {
+  // Check if "application/json" or "application/foo+json"
+  var jsonTest = /^application\/.+\+json$/;
+  var isJSONType = type === 'application/json' || jsonTest.test(type);
+  var isString = function isString(x) {
+    return Object.prototype.toString.call(x) === '[object String]';
+  };
+
+  // If it is an array, make sure if is not a JSON type and it is an
+  // array of strings.
+  if (Array.isArray(value)) {
+    if (isJSONType) {
+      return false;
+    }
+    var valid = true;
+    value.forEach(function (v) {
+      if (!isString(v)) {
+        valid = false;
+      }
+    });
+    return valid;
+  }
+
+  // If it is a string, make sure we are not a JSON type.
+  if (isString(value)) {
+    return !isJSONType;
+  }
+
+  // It is not a string, make sure it is a JSON type.
+  if (!isJSONType) {
+    return false;
+  }
+
+  // It is a JSON type, make sure it is a valid JSON object.
+  return isObject(value);
+}
+
+/**
+ * join multiline string, normalizing line endings to \n
+ * @param value
+ * @returns
+ */
+export function concatMultilineString(value) {
+  if (Array.isArray(value)) {
+    return value.map(function (s) {
+      return s.replace(/\r\n/g, '\n').replace(/\r/g, '\n');
+    }).join('');
+  } else {
+    return value.replace(/\r\n/g, '\n').replace(/\r/g, '\n');
+  }
+}
+
+/**
+ * Test whether a cell is a raw cell.
+ */
+export function isRaw(cell) {
+  return cell.cell_type === 'raw';
+}
+
+/**
+ * Test whether a cell is a markdown cell.
+ */
+export function isMarkdown(cell) {
+  return cell.cell_type === 'markdown';
+}
+
+/**
+ * Test whether a cell is a code cell.
+ */
+export function isCode(cell) {
+  return cell.cell_type === 'code';
+}
+
+/**
+ * Test whether a cell is a code cell.
+ */
+export function isOutput(output) {
+  return !!(output && output instanceof Array);
+}
+
+/**
+ * Test whether an output is an execute result.
+ */
+export function isExecuteResult(output) {
+  return output.output_type === 'execute_result';
+}
+
+/**
+ * Test whether an output is from display data.
+ */
+export function isDisplayData(output) {
+  return output.output_type === 'display_data';
+}
+
+/**
+ * Test whether an output is from updated display data.
+ */
+export function isDisplayUpdate(output) {
+  return output.output_type === 'update_display_data';
+}
+
+/**
+ * Test whether an output is from a stream.
+ */
+export function isStream(output) {
+  return output.output_type === 'stream';
+}
+
+/**
+ * Test whether an output is an error.
+ */
+export function isError(output) {
+  return output.output_type === 'error';
+}

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "@difizen/libro-common",
+  "version": "0.0.2-alpha.0",
+  "description": "",
+  "keywords": [
+    "libro",
+    "notebook"
+  ],
+  "repository": "git@github.com:difizen/libro.git",
+  "license": "MIT",
+  "type": "module",
+  "exports": {
+    ".": {
+      "typings": "./es/index.d.ts",
+      "default": "./es/index.js"
+    },
+    "./mock": {
+      "typings": "./es/mock/index.d.ts",
+      "default": "./es/mock/index.js"
+    },
+    "./es/mock": {
+      "typings": "./es/mock/index.d.ts",
+      "default": "./es/mock/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "es/index.js",
+  "module": "es/index.js",
+  "typings": "es/index.d.ts",
+  "files": [
+    "es",
+    "src"
+  ],
+  "dependencies": {
+    "@difizen/mana-common": "alpha",
+    "path-browserify": "^1.0.0",
+    "sanitize-html": "^2.7.2",
+    "url-parse": "^1.5.10"
+  },
+  "devDependencies": {
+    "@types/react": "^18.2.25",
+    "@types/path-browserify": "^1.0.0",
+    "@types/sanitize-html": "^2.6.2",
+    "@types/url-parse": "^1.4.8"
+  },
+  "peerDependencies": {
+    "react": "^18.2.0"
+  },
+  "scripts": {
+    "setup": "father build",
+    "build": "father build",
+    "test": ": Note: lint task is delegated to test:* scripts",
+    "test:vitest": "vitest run",
+    "test:jest": "jest",
+    "coverage": ": Note: lint task is delegated to coverage:* scripts",
+    "coverage:vitest": "vitest run --coverage",
+    "coverage:jest": "jest --coverage",
+    "lint": ": Note: lint task is delegated to lint:* scripts",
+    "lint:eslint": "eslint src",
+    "lint:tsc": "tsc --noEmit"
+  }
+}