decoders 1.26.0-beta2 → 2.0.0-beta11

package/annotate.js.flow

@@ -0,0 +1,218 @@
+// @flow strict
+
+type cast = $FlowFixMe;
+
+const _register: WeakSet<{ ... }> = new WeakSet();
+
+export type ObjectAnnotation = {|
+    +type: 'object',
+    +fields: { +[key: string]: Annotation },
+    +text?: string,
+|};
+
+export type ArrayAnnotation = {|
+    +type: 'array',
+    +items: $ReadOnlyArray<Annotation>,
+    +text?: string,
+|};
+
+export type ScalarAnnotation = {|
+    +type: 'scalar',
+    +value: mixed,
+    +text?: string,
+|};
+
+export type FunctionAnnotation = {|
+    +type: 'function',
+    +text?: string,
+|};
+
+export type CircularRefAnnotation = {|
+    +type: 'circular-ref',
+    +text?: string,
+|};
+
+export type UnknownAnnotation = {|
+    +type: 'unknown',
+    +value: mixed,
+    +text?: string,
+|};
+
+export type Annotation =
+    | ObjectAnnotation
+    | ArrayAnnotation
+    | ScalarAnnotation
+    | FunctionAnnotation
+    | CircularRefAnnotation
+    | UnknownAnnotation;
+
+function brand<A: Annotation>(ann: A): A {
+    _register.add(ann);
+    return ann;
+}
+
+export function object(
+    fields: { +[key: string]: Annotation },
+    text?: string,
+): ObjectAnnotation {
+    return brand({ type: 'object', fields, text });
+}
+
+export function array(items: $ReadOnlyArray<Annotation>, text?: string): ArrayAnnotation {
+    return brand({
+        type: 'array',
+        items,
+        text,
+    });
+}
+
+export function func(text?: string): FunctionAnnotation {
+    return brand({
+        type: 'function',
+        text,
+    });
+}
+
+export function unknown(value: mixed, text?: string): UnknownAnnotation {
+    return brand({
+        type: 'unknown',
+        value,
+        text,
+    });
+}
+
+export function scalar(value: mixed, text?: string): ScalarAnnotation {
+    return brand({
+        type: 'scalar',
+        value,
+        text,
+    });
+}
+
+export function circularRef(text?: string): CircularRefAnnotation {
+    return brand({
+        type: 'circular-ref',
+        text,
+    });
+}
+
+/**
+ * Given an existing Annotation, set the annotation's text to a new value.
+ */
+export function updateText<A: Annotation>(annotation: A, text?: string): A {
+    if (text !== undefined) {
+        return brand({ ...annotation, text });
+    } else {
+        return annotation;
+    }
+}
+
+/**
+ * Given an existing ObjectAnnotation, merges new Annotations in there.
+ */
+export function merge(
+    objAnnotation: ObjectAnnotation,
+    fields: { +[key: string]: Annotation },
+): ObjectAnnotation {
+    const newFields = { ...objAnnotation.fields, ...fields };
+    return object(newFields, objAnnotation.text);
+}
+
+export function asAnnotation(thing: mixed): Annotation | void {
+    return typeof thing === 'object' && thing !== null && _register.has(thing)
+        ? ((thing: cast): Annotation)
+        : undefined;
+}
+
+type RefSet = WeakSet<{ ... } | $ReadOnlyArray<mixed>>;
+
+function annotateArray(
+    value: $ReadOnlyArray<mixed>,
+    text?: string,
+    seen: RefSet,
+): ArrayAnnotation | CircularRefAnnotation {
+    seen.add(value);
+
+    const items = value.map((v) => annotate(v, undefined, seen));
+    return array(items, text);
+}
+
+function annotateObject(
+    obj: { +[string]: mixed },
+    text?: string,
+    seen: RefSet,
+): ObjectAnnotation {
+    seen.add(obj);
+
+    const fields = {};
+    Object.keys(obj).forEach((key) => {
+        const value = obj[key];
+        fields[key] = annotate(value, undefined, seen);
+    });
+    return object(fields, text);
+}
+
+function annotate(value: mixed, text?: string, seen: RefSet): Annotation {
+    if (
+        value === null ||
+        value === undefined ||
+        typeof value === 'string' ||
+        typeof value === 'number' ||
+        typeof value === 'boolean' ||
+        typeof value === 'symbol' ||
+        typeof value.getMonth === 'function'
+    ) {
+        return scalar(value, text);
+    }
+
+    const ann = asAnnotation(value);
+    if (ann) {
+        return updateText(ann, text);
+    }
+
+    if (Array.isArray(value)) {
+        // "Circular references" can only exist in objects or arrays
+        if (seen.has(value)) {
+            return circularRef(text);
+        } else {
+            return annotateArray(value, text, seen);
+        }
+    }
+
+    if (typeof value === 'object') {
+        // "Circular references" can only exist in objects or arrays
+        if (seen.has(value)) {
+            return circularRef(text);
+        } else {
+            return annotateObject(value, text, seen);
+        }
+    }
+
+    if (typeof value === 'function') {
+        return func(text);
+    }
+
+    return unknown(value, text);
+}
+
+function public_annotate(value: mixed, text?: string): Annotation {
+    return annotate(value, text, new WeakSet());
+}
+
+function public_annotateObject(
+    obj: { +[string]: mixed },
+    text?: string,
+): ObjectAnnotation {
+    return annotateObject(obj, text, new WeakSet());
+}
+
+export {
+    // This construct just ensures the "seen" weakmap (used for circular
+    // reference detection) isn't made part of the public API.
+    public_annotate as annotate,
+    public_annotateObject as annotateObject,
+    //
+    // NOTE: Don't acces theses private APIs directly. They are only exported here
+    // to better enable unit testing.
+    annotate as __private_annotate,
+};

package/annotate.mjs

@@ -0,0 +1,144 @@
+function _extends() { _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
+
+var _register = new WeakSet();
+
+function brand(ann) {
+  _register.add(ann);
+
+  return ann;
+}
+
+export function object(fields, text) {
+  return brand({
+    type: 'object',
+    fields: fields,
+    text: text
+  });
+}
+export function array(items, text) {
+  return brand({
+    type: 'array',
+    items: items,
+    text: text
+  });
+}
+export function func(text) {
+  return brand({
+    type: 'function',
+    text: text
+  });
+}
+export function unknown(value, text) {
+  return brand({
+    type: 'unknown',
+    value: value,
+    text: text
+  });
+}
+export function scalar(value, text) {
+  return brand({
+    type: 'scalar',
+    value: value,
+    text: text
+  });
+}
+export function circularRef(text) {
+  return brand({
+    type: 'circular-ref',
+    text: text
+  });
+}
+/**
+ * Given an existing Annotation, set the annotation's text to a new value.
+ */
+
+export function updateText(annotation, text) {
+  if (text !== undefined) {
+    return brand(_extends({}, annotation, {
+      text: text
+    }));
+  } else {
+    return annotation;
+  }
+}
+/**
+ * Given an existing ObjectAnnotation, merges new Annotations in there.
+ */
+
+export function merge(objAnnotation, fields) {
+  var newFields = _extends({}, objAnnotation.fields, fields);
+
+  return object(newFields, objAnnotation.text);
+}
+export function asAnnotation(thing) {
+  return typeof thing === 'object' && thing !== null && _register.has(thing) ? thing : undefined;
+}
+
+function annotateArray(value, text, seen) {
+  seen.add(value);
+  var items = value.map(function (v) {
+    return annotate(v, undefined, seen);
+  });
+  return array(items, text);
+}
+
+function annotateObject(obj, text, seen) {
+  seen.add(obj);
+  var fields = {};
+  Object.keys(obj).forEach(function (key) {
+    var value = obj[key];
+    fields[key] = annotate(value, undefined, seen);
+  });
+  return object(fields, text);
+}
+
+function annotate(value, text, seen) {
+  if (value === null || value === undefined || typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean' || typeof value === 'symbol' || typeof value.getMonth === 'function') {
+    return scalar(value, text);
+  }
+
+  var ann = asAnnotation(value);
+
+  if (ann) {
+    return updateText(ann, text);
+  }
+
+  if (Array.isArray(value)) {
+    // "Circular references" can only exist in objects or arrays
+    if (seen.has(value)) {
+      return circularRef(text);
+    } else {
+      return annotateArray(value, text, seen);
+    }
+  }
+
+  if (typeof value === 'object') {
+    // "Circular references" can only exist in objects or arrays
+    if (seen.has(value)) {
+      return circularRef(text);
+    } else {
+      return annotateObject(value, text, seen);
+    }
+  }
+
+  if (typeof value === 'function') {
+    return func(text);
+  }
+
+  return unknown(value, text);
+}
+
+function public_annotate(value, text) {
+  return annotate(value, text, new WeakSet());
+}
+
+function public_annotateObject(obj, text) {
+  return annotateObject(obj, text, new WeakSet());
+}
+
+export { // This construct just ensures the "seen" weakmap (used for circular
+// reference detection) isn't made part of the public API.
+public_annotate as annotate, public_annotateObject as annotateObject, //
+// NOTE: Don't acces theses private APIs directly. They are only exported here
+// to better enable unit testing.
+annotate as __private_annotate };

package/format.d.ts

@@ -0,0 +1,4 @@
+import { Annotation } from './annotate';
+
+export function formatInline(ann: Annotation): string;
+export function formatShort(ann: Annotation): string;

package/format.js

@@ -0,0 +1,151 @@
+"use strict";
+
+exports.__esModule = true;
+exports.formatInline = formatInline;
+exports.formatShort = formatShort;
+exports.serializeAnnotation = serializeAnnotation;
+exports.serializeValue = serializeValue;
+
+var _utils = require("./_utils");
+
+function serializeString(s, width) {
+  if (width === void 0) {
+    width = 80;
+  }
+
+  // Full string
+  // Abbreviated to $maxlen i.e. "Vincent Driess..." [truncated]
+  var ser = JSON.stringify(s);
+
+  if (ser.length <= width) {
+    return ser;
+  } // Cut off a bit
+
+
+  var truncated = s.substring(0, width - 15) + '...';
+  ser = JSON.stringify(truncated) + ' [truncated]';
+  return ser;
+}
+
+function serializeArray(annotation, prefix) {
+  var items = annotation.items;
+
+  if (items.length === 0) {
+    return '[]';
+  }
+
+  var result = [];
+  items.forEach(function (item) {
+    var _serializeAnnotation = serializeAnnotation(item, prefix + _utils.INDENT),
+        ser = _serializeAnnotation[0],
+        ann = _serializeAnnotation[1];
+
+    result.push(prefix + _utils.INDENT + ser + ',');
+
+    if (ann !== undefined) {
+      result.push((0, _utils.indent)(ann, prefix + _utils.INDENT));
+    }
+  });
+  return ['['].concat(result, [prefix + ']']).join('\n');
+}
+
+function serializeObject(annotation, prefix) {
+  var fields = annotation.fields;
+  var fieldNames = Object.keys(fields);
+
+  if (fieldNames.length === 0) {
+    return '{}';
+  }
+
+  var result = [];
+  fieldNames.forEach(function (key) {
+    var valueAnnotation = fields[key];
+    var kser = serializeValue(key);
+    var valPrefix = prefix + _utils.INDENT + ' '.repeat(kser.length + 2);
+
+    var _serializeAnnotation2 = serializeAnnotation(valueAnnotation, prefix + _utils.INDENT),
+        vser = _serializeAnnotation2[0],
+        vann = _serializeAnnotation2[1];
+
+    result.push(prefix + _utils.INDENT + kser + ': ' + vser + ',');
+
+    if (vann !== undefined) {
+      result.push((0, _utils.indent)(vann, valPrefix));
+    }
+  });
+  return ['{'].concat(result, [prefix + '}']).join('\n');
+}
+
+function serializeValue(value) {
+  // istanbul ignore else
+  if (typeof value === 'string') {
+    return serializeString(value);
+  } else if (typeof value === 'number' || typeof value === 'boolean') {
+    return value.toString();
+  } else if (value === null) {
+    return 'null';
+  } else if (value === undefined) {
+    return 'undefined';
+  } else {
+    var valueAsDate = (0, _utils.asDate)(value);
+
+    if (valueAsDate !== null) {
+      return "new Date(" + JSON.stringify(valueAsDate.toISOString()) + ")";
+    } else if (value instanceof Date) {
+      // NOTE: Using `instanceof Date` is unreliable way of checking dates.
+      // If this case occurs (and it didn't pass the prior asDate())
+      // check, then this must be the case where it's an invalid date.
+      return '(Invalid Date)';
+    } else {
+      return '(unserializable)';
+    }
+  }
+}
+
+function serializeAnnotation(ann, prefix) {
+  if (prefix === void 0) {
+    prefix = '';
+  }
+
+  // The serialized data (the input object echoed back)
+  var serialized;
+
+  if (ann.type === 'array') {
+    serialized = serializeArray(ann, prefix);
+  } else if (ann.type === 'object') {
+    serialized = serializeObject(ann, prefix);
+  } else if (ann.type === 'function') {
+    serialized = '<function>';
+  } else if (ann.type === 'circular-ref') {
+    serialized = '<circular ref>';
+  } else if (ann.type === 'unknown') {
+    serialized = '???';
+  } else {
+    serialized = serializeValue(ann.value);
+  }
+
+  var text = ann.text;
+
+  if (text !== undefined) {
+    var sep = '^'.repeat((0, _utils.isMultiline)(serialized) ? 1 : serialized.length);
+    return [serialized, [sep, text].join((0, _utils.isMultiline)(text) ? '\n' : ' ')];
+  } else {
+    return [serialized, undefined];
+  }
+}
+
+function formatInline(ann) {
+  var _serializeAnnotation3 = serializeAnnotation(ann),
+      serialized = _serializeAnnotation3[0],
+      annotation = _serializeAnnotation3[1];
+
+  if (annotation !== undefined) {
+    return serialized + '\n' + annotation;
+  } else {
+    return serialized;
+  }
+}
+
+function formatShort(ann) {
+  return (0, _utils.summarize)(ann, []).join('\n');
+}

package/format.js.flow

@@ -0,0 +1,126 @@
+// @flow strict
+
+import { summarize as _summarize, asDate, INDENT, indent, isMultiline } from './_utils';
+import type { Annotation, ArrayAnnotation, ObjectAnnotation } from './annotate';
+
+function serializeString(s: string, width: number = 80): string {
+    // Full string
+    // Abbreviated to $maxlen i.e. "Vincent Driess..." [truncated]
+    let ser = JSON.stringify(s);
+    if (ser.length <= width) {
+        return ser;
+    }
+
+    // Cut off a bit
+    const truncated = s.substring(0, width - 15) + '...';
+    ser = JSON.stringify(truncated) + ' [truncated]';
+    return ser;
+}
+
+function serializeArray(annotation: ArrayAnnotation, prefix: string): string {
+    const { items } = annotation;
+    if (items.length === 0) {
+        return '[]';
+    }
+
+    const result = [];
+    items.forEach((item) => {
+        const [ser, ann] = serializeAnnotation(item, prefix + INDENT);
+        result.push(prefix + INDENT + ser + ',');
+        if (ann !== undefined) {
+            result.push(indent(ann, prefix + INDENT));
+        }
+    });
+    return ['[', ...result, prefix + ']'].join('\n');
+}
+
+function serializeObject(annotation: ObjectAnnotation, prefix: string): string {
+    const { fields } = annotation;
+
+    const fieldNames = Object.keys(fields);
+    if (fieldNames.length === 0) {
+        return '{}';
+    }
+
+    const result = [];
+    fieldNames.forEach((key) => {
+        const valueAnnotation = fields[key];
+        const kser = serializeValue(key);
+
+        const valPrefix = prefix + INDENT + ' '.repeat(kser.length + 2);
+        const [vser, vann] = serializeAnnotation(valueAnnotation, prefix + INDENT);
+
+        result.push(prefix + INDENT + kser + ': ' + vser + ',');
+        if (vann !== undefined) {
+            result.push(indent(vann, valPrefix));
+        }
+    });
+    return ['{', ...result, prefix + '}'].join('\n');
+}
+
+export function serializeValue(value: mixed): string {
+    // istanbul ignore else
+    if (typeof value === 'string') {
+        return serializeString(value);
+    } else if (typeof value === 'number' || typeof value === 'boolean') {
+        return value.toString();
+    } else if (value === null) {
+        return 'null';
+    } else if (value === undefined) {
+        return 'undefined';
+    } else {
+        const valueAsDate = asDate(value);
+        if (valueAsDate !== null) {
+            return `new Date(${JSON.stringify(valueAsDate.toISOString())})`;
+        } else if (value instanceof Date) {
+            // NOTE: Using `instanceof Date` is unreliable way of checking dates.
+            // If this case occurs (and it didn't pass the prior asDate())
+            // check, then this must be the case where it's an invalid date.
+            return '(Invalid Date)';
+        } else {
+            return '(unserializable)';
+        }
+    }
+}
+
+export function serializeAnnotation(
+    ann: Annotation,
+    prefix: string = '',
+): [string, string | void] {
+    // The serialized data (the input object echoed back)
+    let serialized;
+    if (ann.type === 'array') {
+        serialized = serializeArray(ann, prefix);
+    } else if (ann.type === 'object') {
+        serialized = serializeObject(ann, prefix);
+    } else if (ann.type === 'function') {
+        serialized = '<function>';
+    } else if (ann.type === 'circular-ref') {
+        serialized = '<circular ref>';
+    } else if (ann.type === 'unknown') {
+        serialized = '???';
+    } else {
+        serialized = serializeValue(ann.value);
+    }
+
+    const text = ann.text;
+    if (text !== undefined) {
+        const sep = '^'.repeat(isMultiline(serialized) ? 1 : serialized.length);
+        return [serialized, [sep, text].join(isMultiline(text) ? '\n' : ' ')];
+    } else {
+        return [serialized, undefined];
+    }
+}
+
+export function formatInline(ann: Annotation): string {
+    const [serialized, annotation] = serializeAnnotation(ann);
+    if (annotation !== undefined) {
+        return serialized + '\n' + annotation;
+    } else {
+        return serialized;
+    }
+}
+
+export function formatShort(ann: Annotation): string {
+    return _summarize(ann, []).join('\n');
+}