@difizen/libro-common 0.0.2-alpha.0

package/es/iter.d.ts

@@ -0,0 +1,147 @@
+/**
+ * An object which can produce an iterator over its values.
+ */
+export interface IIterable<T> {
+    /**
+     * Get an iterator over the object's values.
+     *
+     * @returns An iterator which yields the object's values.
+     *
+     * #### Notes
+     * Depending on the iterable, the returned iterator may or may not be
+     * a new object. A collection or other container-like object should
+     * typically return a new iterator, while an iterator itself should
+     * normally return `this`.
+     */
+    iter: () => IIterator<T>;
+}
+/**
+ * An object which traverses a collection of values.
+ *
+ * #### Notes
+ * An `IIterator` is itself an `IIterable`. Most implementations of
+ * `IIterator` should simply return `this` from the `iter()` method.
+ */
+export interface IIterator<T> extends IIterable<T> {
+    /**
+     * Create an independent clone of the iterator.
+     *
+     * @returns A new independent clone of the iterator.
+     *
+     * #### Notes
+     * The cloned iterator can be consumed independently of the current
+     * iterator. In essence, it is a copy of the iterator value stream
+     * which starts at the current location.
+     *
+     * This can be useful for lookahead and stream duplication.
+     */
+    clone: () => IIterator<T>;
+    /**
+     * Get the next value from the iterator.
+     *
+     * @returns The next value from the iterator, or `undefined`.
+     *
+     * #### Notes
+     * The `undefined` value is used to signal the end of iteration and
+     * should therefore not be used as a value in a collection.
+     *
+     * The use of the `undefined` sentinel is an explicit design choice
+     * which favors performance over purity. The ES6 iterator design of
+     * returning a `{ value, done }` pair is suboptimal, as it requires
+     * an object allocation on each iteration; and an `isDone()` method
+     * would increase implementation and runtime complexity.
+     */
+    next: () => T | undefined;
+}
+/**
+ * A type alias for an iterable or builtin array-like object.
+ */
+export type IterableOrArrayLike<T> = IIterable<T> | ArrayLike<T>;
+/**
+ * An iterator for an array-like object.
+ *
+ * #### Notes
+ * This iterator can be used for any builtin JS array-like object.
+ */
+export declare class ArrayIterator<T> implements IIterator<T> {
+    /**
+     * Construct a new array iterator.
+     *
+     * @param source - The array-like object of interest.
+     */
+    constructor(source: ArrayLike<T>);
+    /**
+     * Get an iterator over the object's values.
+     *
+     * @returns An iterator which yields the object's values.
+     */
+    iter(): IIterator<T>;
+    /**
+     * Create an independent clone of the iterator.
+     *
+     * @returns A new independent clone of the iterator.
+     */
+    clone(): IIterator<T>;
+    /**
+     * Get the next value from the iterator.
+     *
+     * @returns The next value from the iterator, or `undefined`.
+     */
+    next(): T | undefined;
+    private _index;
+    private _source;
+}
+/**
+ * Create an iterator for an iterable object.
+ *
+ * @param object - The iterable or array-like object of interest.
+ *
+ * @returns A new iterator for the given object.
+ *
+ * #### Notes
+ * This function allows iteration algorithms to operate on user-defined
+ * iterable types and builtin array-like objects in a uniform fashion.
+ */
+export declare function iter<T>(object: IterableOrArrayLike<T>): IIterator<T>;
+/**
+ * Invoke a function for each value in an iterable.
+ *
+ * @param object - The iterable or array-like object of interest.
+ *
+ * @param fn - The callback function to invoke for each value.
+ *
+ * #### Notes
+ * Iteration can be terminated early by returning `false` from the
+ * callback function.
+ *
+ * #### Complexity
+ * Linear.
+ *
+ * #### Example
+ * ```typescript
+ *
+ * let data = [5, 7, 0, -2, 9];
+ *
+ * each(data, value => { console.log(value); });
+ * ```
+ */
+export declare function each<T>(object: IterableOrArrayLike<T>, fn: (value: T, index: number) => boolean | void): void;
+/**
+ * Create an array from an iterable of values.
+ *
+ * @param object - The iterable or array-like object of interest.
+ *
+ * @returns A new array of values from the given object.
+ *
+ * #### Example
+ * ```typescript
+ *
+ * let data = [1, 2, 3, 4, 5, 6];
+ *
+ * let stream = iter(data);
+ *
+ * toArray(stream);  // [1, 2, 3, 4, 5, 6];
+ * ```
+ */
+export declare function toArray<T>(object: IterableOrArrayLike<T>): T[];
+//# sourceMappingURL=iter.d.ts.map

package/es/iter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"iter.d.ts","sourceRoot":"","sources":["../src/iter.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,SAAS,CAAC,CAAC;IAC1B;;;;;;;;;;OAUG;IACH,IAAI,EAAE,MAAM,SAAS,CAAC,CAAC,CAAC,CAAC;CAC1B;AAED;;;;;;GAMG;AACH,MAAM,WAAW,SAAS,CAAC,CAAC,CAAE,SAAQ,SAAS,CAAC,CAAC,CAAC;IAChD;;;;;;;;;;;OAWG;IACH,KAAK,EAAE,MAAM,SAAS,CAAC,CAAC,CAAC,CAAC;IAE1B;;;;;;;;;;;;;;OAcG;IACH,IAAI,EAAE,MAAM,CAAC,GAAG,SAAS,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,MAAM,mBAAmB,CAAC,CAAC,IAAI,SAAS,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;AAEjE;;;;;GAKG;AACH,qBAAa,aAAa,CAAC,CAAC,CAAE,YAAW,SAAS,CAAC,CAAC,CAAC;IACnD;;;;OAIG;gBACS,MAAM,EAAE,SAAS,CAAC,CAAC,CAAC;IAIhC;;;;OAIG;IACH,IAAI,IAAI,SAAS,CAAC,CAAC,CAAC;IAIpB;;;;OAIG;IACH,KAAK,IAAI,SAAS,CAAC,CAAC,CAAC;IAMrB;;;;OAIG;IACH,IAAI,IAAI,CAAC,GAAG,SAAS;IAOrB,OAAO,CAAC,MAAM,CAAK;IACnB,OAAO,CAAC,OAAO,CAAe;CAC/B;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,IAAI,CAAC,CAAC,EAAE,MAAM,EAAE,mBAAmB,CAAC,CAAC,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC,CAQpE;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,IAAI,CAAC,CAAC,EACpB,MAAM,EAAE,mBAAmB,CAAC,CAAC,CAAC,EAC9B,EAAE,EAAE,CAAC,KAAK,EAAE,CAAC,EAAE,KAAK,EAAE,MAAM,KAAK,OAAO,GAAG,IAAI,GAC9C,IAAI,CASN;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,MAAM,EAAE,mBAAmB,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAS9D"}

package/es/iter.js

@@ -0,0 +1,162 @@
+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 _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); }
+/**
+ * An object which can produce an iterator over its values.
+ */
+
+/**
+ * An object which traverses a collection of values.
+ *
+ * #### Notes
+ * An `IIterator` is itself an `IIterable`. Most implementations of
+ * `IIterator` should simply return `this` from the `iter()` method.
+ */
+
+/**
+ * A type alias for an iterable or builtin array-like object.
+ */
+
+/**
+ * An iterator for an array-like object.
+ *
+ * #### Notes
+ * This iterator can be used for any builtin JS array-like object.
+ */
+export var ArrayIterator = /*#__PURE__*/function () {
+  /**
+   * Construct a new array iterator.
+   *
+   * @param source - The array-like object of interest.
+   */
+  function ArrayIterator(source) {
+    _classCallCheck(this, ArrayIterator);
+    this._index = 0;
+    this._source = source;
+  }
+
+  /**
+   * Get an iterator over the object's values.
+   *
+   * @returns An iterator which yields the object's values.
+   */
+  _createClass(ArrayIterator, [{
+    key: "iter",
+    value: function iter() {
+      return this;
+    }
+
+    /**
+     * Create an independent clone of the iterator.
+     *
+     * @returns A new independent clone of the iterator.
+     */
+  }, {
+    key: "clone",
+    value: function clone() {
+      var result = new ArrayIterator(this._source);
+      result._index = this._index;
+      return result;
+    }
+
+    /**
+     * Get the next value from the iterator.
+     *
+     * @returns The next value from the iterator, or `undefined`.
+     */
+  }, {
+    key: "next",
+    value: function next() {
+      if (this._index >= this._source.length) {
+        return undefined;
+      }
+      return this._source[this._index++];
+    }
+  }]);
+  return ArrayIterator;
+}();
+
+/**
+ * Create an iterator for an iterable object.
+ *
+ * @param object - The iterable or array-like object of interest.
+ *
+ * @returns A new iterator for the given object.
+ *
+ * #### Notes
+ * This function allows iteration algorithms to operate on user-defined
+ * iterable types and builtin array-like objects in a uniform fashion.
+ */
+export function iter(object) {
+  var it;
+  if (typeof object.iter === 'function') {
+    it = object.iter();
+  } else {
+    it = new ArrayIterator(object);
+  }
+  return it;
+}
+
+/**
+ * Invoke a function for each value in an iterable.
+ *
+ * @param object - The iterable or array-like object of interest.
+ *
+ * @param fn - The callback function to invoke for each value.
+ *
+ * #### Notes
+ * Iteration can be terminated early by returning `false` from the
+ * callback function.
+ *
+ * #### Complexity
+ * Linear.
+ *
+ * #### Example
+ * ```typescript
+ *
+ * let data = [5, 7, 0, -2, 9];
+ *
+ * each(data, value => { console.log(value); });
+ * ```
+ */
+export function each(object, fn) {
+  var index = 0;
+  var it = iter(object);
+  var value;
+  while ((value = it.next()) !== undefined) {
+    if (fn(value, index++) === false) {
+      return;
+    }
+  }
+}
+
+/**
+ * Create an array from an iterable of values.
+ *
+ * @param object - The iterable or array-like object of interest.
+ *
+ * @returns A new array of values from the given object.
+ *
+ * #### Example
+ * ```typescript
+ *
+ * let data = [1, 2, 3, 4, 5, 6];
+ *
+ * let stream = iter(data);
+ *
+ * toArray(stream);  // [1, 2, 3, 4, 5, 6];
+ * ```
+ */
+export function toArray(object) {
+  var index = 0;
+  var result = [];
+  var it = iter(object);
+  var value;
+  while ((value = it.next()) !== undefined) {
+    result[index++] = value;
+  }
+  return result;
+}

package/es/json.d.ts

@@ -0,0 +1,126 @@
+/**
+ * A type alias for a JSON primitive.
+ */
+export type JSONPrimitive = boolean | number | string | null;
+/**
+ * A type alias for a JSON value.
+ */
+export type JSONValue = JSONPrimitive | {
+    [key: string]: JSONValue;
+} | JSONValue[];
+/**
+ * A type definition for a JSON object.
+ */
+export type JSONObject = Record<string, JSONValue>;
+/**
+ * A type definition for a JSON array.
+ */
+export type JSONArray = JSONValue[];
+/**
+ * A type definition for a readonly JSON object.
+ */
+export type ReadonlyJSONObject = Readonly<Record<string, ReadonlyJSONValue>>;
+/**
+ * A type definition for a readonly JSON array.
+ */
+export type ReadonlyJSONArray = readonly ReadonlyJSONValue[];
+/**
+ * A type alias for a readonly JSON value.
+ */
+export type ReadonlyJSONValue = JSONPrimitive | Readonly<{
+    [key: string]: ReadonlyJSONValue;
+}> | readonly ReadonlyJSONValue[];
+/**
+ * A type alias for a partial JSON value.
+ *
+ * Note: Partial here means that JSON object attributes can be `undefined`.
+ */
+export type PartialJSONValue = JSONPrimitive | Partial<{
+    [key: string]: PartialJSONValue;
+}> | PartialJSONValue[];
+/**
+ * A type definition for a partial JSON array.
+ *
+ * Note: Partial here means that JSON object attributes can be `undefined`.
+ */
+export type PartialJSONArray = PartialJSONValue[];
+/**
+ * A type definition for a partial JSON object.
+ *
+ * Note: Partial here means that the JSON object attributes can be `undefined`.
+ */
+export type PartialJSONObject = Record<string, PartialJSONValue | undefined>;
+/**
+ * A type definition for a readonly partial JSON object.
+ *
+ * Note: Partial here means that JSON object attributes can be `undefined`.
+ */
+export type ReadonlyPartialJSONObject = Readonly<Record<string, ReadonlyPartialJSONValue | undefined>>;
+/**
+ * A type definition for a readonly partial JSON array.
+ *
+ * Note: Partial here means that JSON object attributes can be `undefined`.
+ */
+export type ReadonlyPartialJSONArray = readonly ReadonlyPartialJSONValue[];
+/**
+ * A type alias for a readonly partial JSON value.
+ *
+ * Note: Partial here means that JSON object attributes can be `undefined`.
+ */
+export type ReadonlyPartialJSONValue = JSONPrimitive | {
+    readonly [key: string]: ReadonlyPartialJSONValue | undefined;
+} | readonly ReadonlyPartialJSONValue[];
+/**
+ * A shared frozen empty JSONObject
+ */
+export declare const emptyObject: Readonly<Record<string, ReadonlyJSONValue>>;
+/**
+ * A shared frozen empty JSONArray
+ */
+export declare const emptyArray: ReadonlyJSONArray;
+/**
+ * Test whether a JSON value is a primitive.
+ *
+ * @param value - The JSON value of interest.
+ *
+ * @returns `true` if the value is a primitive,`false` otherwise.
+ */
+export declare function isPrimitive(value: ReadonlyPartialJSONValue): value is JSONPrimitive;
+/**
+ * Test whether a JSON value is an array.
+ *
+ * @param value - The JSON value of interest.
+ *
+ * @returns `true` if the value is a an array, `false` otherwise.
+ */
+export declare function isArray(value: JSONValue): value is JSONArray;
+export declare function isArray(value: PartialJSONValue): value is PartialJSONArray;
+export declare function isArray(value: ReadonlyPartialJSONValue): value is ReadonlyPartialJSONArray;
+/**
+ * Test whether a JSON value is an object.
+ *
+ * @param value - The JSON value of interest.
+ *
+ * @returns `true` if the value is a an object, `false` otherwise.
+ */
+export declare function isObject(value: JSONValue): value is JSONObject;
+export declare function isObject(value: PartialJSONValue): value is PartialJSONObject;
+/**
+ * Compare two JSON values for deep equality.
+ *
+ * @param first - The first JSON value of interest.
+ *
+ * @param second - The second JSON value of interest.
+ *
+ * @returns `true` if the values are equivalent, `false` otherwise.
+ */
+export declare function deepEqual(first: ReadonlyPartialJSONValue, second: ReadonlyPartialJSONValue): boolean;
+/**
+ * Create a deep copy of a JSON value.
+ *
+ * @param value - The JSON value to copy.
+ *
+ * @returns A deep copy of the given JSON value.
+ */
+export declare function deepCopy<T extends ReadonlyPartialJSONValue>(value: T): T;
+//# sourceMappingURL=json.d.ts.map

package/es/json.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"json.d.ts","sourceRoot":"","sources":["../src/json.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,aAAa,GAAG,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,IAAI,CAAC;AAE7D;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,aAAa,GAAG;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,SAAS,CAAA;CAAE,GAAG,SAAS,EAAE,CAAC;AAEnF;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;AAEnD;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,SAAS,EAAE,CAAC;AAEpC;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,QAAQ,CAAC,MAAM,CAAC,MAAM,EAAE,iBAAiB,CAAC,CAAC,CAAC;AAE7E;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,SAAS,iBAAiB,EAAE,CAAC;AAE7D;;GAEG;AACH,MAAM,MAAM,iBAAiB,GACzB,aAAa,GACb,QAAQ,CAAC;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,iBAAiB,CAAA;CAAE,CAAC,GAC9C,SAAS,iBAAiB,EAAE,CAAC;AAEjC;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GACxB,aAAa,GACb,OAAO,CAAC;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,gBAAgB,CAAA;CAAE,CAAC,GAC5C,gBAAgB,EAAE,CAAC;AAEvB;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,GAAG,gBAAgB,EAAE,CAAC;AAElD;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG,MAAM,CAAC,MAAM,EAAE,gBAAgB,GAAG,SAAS,CAAC,CAAC;AAE7E;;;;GAIG;AACH,MAAM,MAAM,yBAAyB,GAAG,QAAQ,CAC9C,MAAM,CAAC,MAAM,EAAE,wBAAwB,GAAG,SAAS,CAAC,CACrD,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,wBAAwB,GAAG,SAAS,wBAAwB,EAAE,CAAC;AAE3E;;;;GAIG;AACH,MAAM,MAAM,wBAAwB,GAChC,aAAa,GACb;IAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,GAAG,wBAAwB,GAAG,SAAS,CAAA;CAAE,GAChE,SAAS,wBAAwB,EAAE,CAAC;AAExC;;GAEG;AACH,eAAO,MAAM,WAAW,6CAA0C,CAAC;AAEnE;;GAEG;AACH,eAAO,MAAM,UAAU,mBAAyC,CAAC;AAEjE;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,KAAK,EAAE,wBAAwB,GAAG,KAAK,IAAI,aAAa,CAOnF;AAED;;;;;;GAMG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,SAAS,GAAG,KAAK,IAAI,SAAS,CAAC;AAE9D,wBAAgB,OAAO,CAAC,KAAK,EAAE,gBAAgB,GAAG,KAAK,IAAI,gBAAgB,CAAC;AAC5E,wBAAgB,OAAO,CACrB,KAAK,EAAE,wBAAwB,GAC9B,KAAK,IAAI,wBAAwB,CAAC;AAKrC;;;;;;GAMG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,SAAS,GAAG,KAAK,IAAI,UAAU,CAAC;AAEhE,wBAAgB,QAAQ,CAAC,KAAK,EAAE,gBAAgB,GAAG,KAAK,IAAI,iBAAiB,CAAC;AAM9E;;;;;;;;GAQG;AACH,wBAAgB,SAAS,CACvB,KAAK,EAAE,wBAAwB,EAC/B,MAAM,EAAE,wBAAwB,GAC/B,OAAO,CAiCT;AAED;;;;;;GAMG;AACH,wBAAgB,QAAQ,CAAC,CAAC,SAAS,wBAAwB,EAAE,KAAK,EAAE,CAAC,GAAG,CAAC,CAaxE"}