ipld-schema-describer 1.0.8 → 2.0.0

package/types/ipld-schema-describer.d.ts

@@ -1,8 +1,8 @@
 /**
  * @typedef {import('ipld-schema/schema-schema').Schema} Schema
- * @typedef {import('ipld-schema/schema-schema').TypeLink} TypeLink
- * @typedef {import('ipld-schema/schema-schema').TypeList} TypeList
- * @typedef {import('ipld-schema/schema-schema').TypeMap} TypeMap
+ * @typedef {import('ipld-schema/schema-schema').TypeDefnLink} TypeDefnLink
+ * @typedef {import('ipld-schema/schema-schema').TypeDefnList} TypeDefnList
+ * @typedef {import('ipld-schema/schema-schema').TypeDefnMap} TypeDefnMap
  */
 /**
  * @param {any} obj
@@ -13,7 +13,7 @@ export function describe(obj: any): {
     root: string;
 };
 export type Schema = import('ipld-schema/schema-schema').Schema;
-export type TypeLink = import('ipld-schema/schema-schema').TypeLink;
-export type TypeList = import('ipld-schema/schema-schema').TypeList;
-export type TypeMap = import('ipld-schema/schema-schema').TypeMap;
+export type TypeDefnLink = import('ipld-schema/schema-schema').TypeDefnLink;
+export type TypeDefnList = import('ipld-schema/schema-schema').TypeDefnList;
+export type TypeDefnMap = import('ipld-schema/schema-schema').TypeDefnMap;
 //# sourceMappingURL=ipld-schema-describer.d.ts.map

package/types/ipld-schema-describer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ipld-schema-describer.d.ts","sourceRoot":"","sources":["../ipld-schema-describer.js"],"names":[],"mappings":"AAEA;;;;;GAKG;AAEH;;;GAGG;AACH,8BAHW,GAAG,GACD;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CA4B5C;qBApCY,OAAO,2BAA2B,EAAE,MAAM;uBAC1C,OAAO,2BAA2B,EAAE,QAAQ;uBAC5C,OAAO,2BAA2B,EAAE,QAAQ;sBAC5C,OAAO,2BAA2B,EAAE,OAAO"}
+{"version":3,"file":"ipld-schema-describer.d.ts","sourceRoot":"","sources":["../ipld-schema-describer.js"],"names":[],"mappings":"AAEA;;;;;GAKG;AAEH;;;GAGG;AACH,8BAHW,GAAG,GACD;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAA;CAAE,CA4B5C;qBApCY,OAAO,2BAA2B,EAAE,MAAM;2BAC1C,OAAO,2BAA2B,EAAE,YAAY;2BAChD,OAAO,2BAA2B,EAAE,YAAY;0BAChD,OAAO,2BAA2B,EAAE,WAAW"}

package/cjs/browser-test/test-basics.js

@@ -1,297 +0,0 @@
-'use strict';
-
-var ipldSchemaDescriber = require('../ipld-schema-describer.js');
-var chai = require('chai');
-
-function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
-
-var chai__default = /*#__PURE__*/_interopDefaultLegacy(chai);
-
-const {assert} = chai__default["default"];
-const fauxCID = {};
-fauxCID.asCID = fauxCID;
-function verify(obj, expected) {
-  const description = ipldSchemaDescriber.describe(obj);
-  assert.deepEqual(description, expected);
-}
-describe('Basics', () => {
-  it('null', () => {
-    const expected = {
-      schema: { types: { Null: { kind: 'null' } } },
-      root: 'Null'
-    };
-    verify(null, expected);
-  });
-  it('bool', () => {
-    const expected = {
-      schema: { types: { Bool: { kind: 'bool' } } },
-      root: 'Bool'
-    };
-    verify(true, expected);
-    verify(false, expected);
-  });
-  it('int', () => {
-    const expected = {
-      schema: { types: { Int: { kind: 'int' } } },
-      root: 'Int'
-    };
-    verify(101, expected);
-    verify(-101, expected);
-    verify(0, expected);
-  });
-  it('float', () => {
-    const expected = {
-      schema: { types: { Float: { kind: 'float' } } },
-      root: 'Float'
-    };
-    verify(1.01, expected);
-    verify(-1.01, expected);
-  });
-  it('string', () => {
-    const expected = {
-      schema: { types: { String: { kind: 'string' } } },
-      root: 'String'
-    };
-    verify('a string', expected);
-    verify('', expected);
-  });
-  it('link', () => {
-    const expected = {
-      schema: { types: { Link: { kind: 'link' } } },
-      root: 'Link'
-    };
-    verify(fauxCID, expected);
-  });
-  it('bytes', () => {
-    const expected = {
-      schema: { types: { Bytes: { kind: 'bytes' } } },
-      root: 'Bytes'
-    };
-    verify(Uint8Array.from([
-      1,
-      3,
-      4,
-      5
-    ]), expected);
-    verify(Uint8Array.from([]), expected);
-  });
-  it('map', () => {
-    const obj = {
-      s1: 'a string',
-      s2: 'second string',
-      s3: 'third string'
-    };
-    const expected = {
-      schema: {
-        types: {
-          Map_1: {
-            kind: 'map',
-            keyType: 'String',
-            valueType: 'String'
-          }
-        }
-      },
-      root: 'Map_1'
-    };
-    verify(obj, expected);
-  });
-  it('empty map', () => {
-    const obj = {};
-    const expected = {
-      schema: {
-        types: {
-          Map_1: {
-            kind: 'map',
-            keyType: 'String',
-            valueType: 'Any'
-          }
-        }
-      },
-      root: 'Map_1'
-    };
-    verify(obj, expected);
-  });
-  it('struct (map repr)', () => {
-    const obj = {
-      s: 'a string',
-      i: 101,
-      l: fauxCID
-    };
-    const expected = {
-      schema: {
-        types: {
-          Struct_1: {
-            kind: 'struct',
-            fields: {
-              s: { type: 'String' },
-              i: { type: 'Int' },
-              l: { type: { kind: 'link' } }
-            }
-          }
-        }
-      },
-      root: 'Struct_1'
-    };
-    verify(obj, expected);
-  });
-  it('list', () => {
-    const obj = [
-      'a string',
-      'second string',
-      'third string'
-    ];
-    const expected = {
-      schema: {
-        types: {
-          List_1: {
-            kind: 'list',
-            valueType: 'String'
-          }
-        }
-      },
-      root: 'List_1'
-    };
-    verify(obj, expected);
-  });
-  it('empty list', () => {
-    const obj = [];
-    const expected = {
-      schema: {
-        types: {
-          List_1: {
-            kind: 'list',
-            valueType: 'Any'
-          }
-        }
-      },
-      root: 'List_1'
-    };
-    verify(obj, expected);
-  });
-  it('struct (list repr)', () => {
-    const obj = [
-      'a string',
-      101,
-      false,
-      null
-    ];
-    const expected = {
-      schema: {
-        types: {
-          Struct_1: {
-            kind: 'struct',
-            fields: {
-              f0: { type: 'String' },
-              f1: { type: 'Int' },
-              f2: { type: 'Bool' },
-              f3: { type: 'Null' }
-            },
-            representation: { tuple: {} }
-          }
-        }
-      },
-      root: 'Struct_1'
-    };
-    verify(obj, expected);
-  });
-});
-describe('Complex', () => {
-  it('list of lists', () => {
-    const sa = [
-      'a string',
-      'second string',
-      'third string'
-    ];
-    const obj = [
-      sa,
-      sa.slice(),
-      sa.slice()
-    ];
-    const expected = {
-      schema: {
-        types: {
-          List_1: {
-            kind: 'list',
-            valueType: 'String'
-          },
-          List_2: {
-            kind: 'list',
-            valueType: 'List_1'
-          }
-        }
-      },
-      root: 'List_2'
-    };
-    verify(obj, expected);
-  });
-  it('map of maps', () => {
-    const sm = {
-      s1: 'a string',
-      s2: 'second string',
-      s3: 'third string'
-    };
-    const obj = {
-      sm1: sm,
-      sm2: Object.assign({}, sm),
-      sm3: Object.assign({}, sm)
-    };
-    const expected = {
-      schema: {
-        types: {
-          Map_1: {
-            kind: 'map',
-            keyType: 'String',
-            valueType: 'String'
-          },
-          Map_2: {
-            kind: 'map',
-            keyType: 'String',
-            valueType: 'Map_1'
-          }
-        }
-      },
-      root: 'Map_2'
-    };
-    verify(obj, expected);
-  });
-  it('struct of structs', () => {
-    const obj = [
-      'a string',
-      101,
-      [
-        's',
-        false
-      ],
-      [
-        '',
-        true
-      ]
-    ];
-    const expected = {
-      schema: {
-        types: {
-          Struct_1: {
-            kind: 'struct',
-            fields: {
-              f0: { type: 'String' },
-              f1: { type: 'Bool' }
-            },
-            representation: { tuple: {} }
-          },
-          Struct_2: {
-            kind: 'struct',
-            fields: {
-              f0: { type: 'String' },
-              f1: { type: 'Int' },
-              f2: { type: 'Struct_1' },
-              f3: { type: 'Struct_1' }
-            },
-            representation: { tuple: {} }
-          }
-        }
-      },
-      root: 'Struct_2'
-    };
-    verify(obj, expected);
-  });
-});

package/cjs/browser-test/test-errors.js

@@ -1,15 +0,0 @@
-'use strict';
-
-var ipldSchemaDescriber = require('../ipld-schema-describer.js');
-var chai = require('chai');
-
-function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
-
-var chai__default = /*#__PURE__*/_interopDefaultLegacy(chai);
-
-const {assert} = chai__default["default"];
-describe('Errors', () => {
-  it('bad kind', () => {
-    assert.throws(() => ipldSchemaDescriber.describe(undefined), /Unknown IPLD kind for value: undefined/);
-  });
-});

package/cjs/ipld-schema-describer.js

@@ -1,130 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-var kind = require('./kind.js');
-
-function describe(obj) {
-  const description = describeObject(obj, { types: {} });
-  if (!Object.keys(description.schema.types).length) {
-    if (typeof description.root === 'object' && description.root.kind === 'link') {
-      const name = 'Link';
-      description.schema.types[name] = { kind: 'link' };
-      description.root = name;
-    } else if (typeof description.root === 'string') {
-      const name = `${ description.root }`;
-      description.schema.types[name] = { kind: description.root.toLowerCase() };
-      description.root = name;
-    } else {
-      throw new Error('internal error');
-    }
-  }
-  if (typeof description.root !== 'string') {
-    throw new Error('internal error');
-  }
-  return {
-    schema: description.schema,
-    root: description.root
-  };
-}
-function describeObject(obj, schema) {
-  const objKind = kind.kind(obj);
-  let name = `${ objKind.charAt(0).toUpperCase() }${ objKind.substring(1) }`;
-  if (objKind === 'null' || objKind === 'int' || objKind === 'bool' || objKind === 'float' || objKind === 'string' || objKind === 'bytes') {
-    return {
-      schema,
-      root: name
-    };
-  }
-  if (objKind === 'link') {
-    return {
-      schema,
-      root: { kind: 'link' }
-    };
-  }
-  const fieldNames = [];
-  const entries = objKind === 'map' ? Object.entries(obj) : obj.map((e, i) => [
-    `f${ i }`,
-    e
-  ]);
-  for (const [fieldName, value] of entries) {
-    fieldNames.push({
-      fieldName,
-      root: describeObject(value, schema).root
-    });
-  }
-  let unique = true;
-  for (let i = 1; i < fieldNames.length; i++) {
-    if (fieldNames[i].root !== fieldNames[i - 1].root) {
-      unique = false;
-      break;
-    }
-  }
-  name = `${ name }_1`;
-  let type;
-  if (unique) {
-    type = { kind: objKind };
-    if (type.kind === 'map') {
-      type.keyType = 'String';
-    }
-    if (type.kind === 'map' || type.kind === 'list') {
-      if (fieldNames.length) {
-        type.valueType = fieldNames[0].root;
-      } else {
-        type.valueType = 'Any';
-      }
-    }
-  } else {
-    name = 'Struct_1';
-    type = {
-      kind: 'struct',
-      fields: {}
-    };
-    for (const field of fieldNames) {
-      type.fields[field.fieldName] = { type: field.root };
-    }
-    if (objKind === 'list') {
-      type.representation = { tuple: {} };
-    }
-  }
-  while (schema.types[name]) {
-    if (deepEqual(schema.types[name], type)) {
-      break;
-    }
-    name = name.split('_').map((s, i) => i ? parseInt(s, 10) + 1 : s).join('_');
-  }
-  schema.types[name] = type;
-  return {
-    schema,
-    root: name
-  };
-}
-function deepEqual(o1, o2) {
-  const k1 = kind.kind(o1);
-  const k2 = kind.kind(o2);
-  if (k1 !== k2) {
-    return false;
-  }
-  switch (k1) {
-  case 'bool':
-  case 'string':
-  case 'int':
-  case 'float':
-  case 'null':
-    return o1 === o2;
-  case 'map':
-    return deepEqual(Object.entries(o1), Object.entries(o2));
-  case 'list':
-    if (o1.length !== o2.length) {
-      return false;
-    }
-    for (let i = 0; i < o1.length; i++) {
-      if (!deepEqual(o1[i], o2[i])) {
-        return false;
-      }
-    }
-  }
-  return true;
-}
-
-exports.describe = describe;

package/cjs/kind.js

@@ -1,36 +0,0 @@
-'use strict';
-
-Object.defineProperty(exports, '__esModule', { value: true });
-
-function kind(obj) {
-  if (typeof obj === 'number') {
-    if (Number.isInteger(obj)) {
-      return 'int';
-    }
-    return 'float';
-  }
-  if (typeof obj === 'string') {
-    return 'string';
-  }
-  if (obj === null) {
-    return 'null';
-  }
-  if (typeof obj === 'boolean') {
-    return 'bool';
-  }
-  if (typeof obj === 'object' && obj.asCID === obj) {
-    return 'link';
-  }
-  if (obj instanceof Uint8Array) {
-    return 'bytes';
-  }
-  if (Array.isArray(obj)) {
-    return 'list';
-  }
-  if (typeof obj === 'object') {
-    return 'map';
-  }
-  throw new TypeError(`Unknown IPLD kind for value: ${ JSON.stringify(obj) }`);
-}
-
-exports.kind = kind;