ipld-schema-describer 1.0.10 → 2.0.0

package/.github/dependabot.yml

@@ -0,0 +1,25 @@
+version: 2
+updates:
+  - package-ecosystem: 'github-actions'
+    directory: '/'
+    schedule:
+      interval: 'daily'
+    commit-message:
+      prefix: 'chore'
+      include: 'scope'
+  - package-ecosystem: 'npm'
+    directory: '/'
+    schedule:
+      interval: 'daily'
+    commit-message:
+      prefix: 'chore'
+      include: 'scope'
+  - package-ecosystem: 'npm'
+    directory: '/examples/'
+    schedule:
+      interval: 'daily'
+    ignore:
+      - dependency-name: "@ipld/car"
+    commit-message:
+      prefix: 'chore'
+      include: 'scope'

package/.github/workflows/test-and-release.yml

@@ -0,0 +1,60 @@
+name: Test & Maybe Release
+on: [push, pull_request]
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        node: [14.x, 16.x, lts/*]
+        os: [macos-latest, ubuntu-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v3
+      - name: Use Node.js ${{ matrix.node }}
+        uses: actions/setup-node@v3.4.1
+        with:
+          node-version: ${{ matrix.node }}
+      - name: Install Dependencies
+        run: |
+          npm install --no-progress --no-package-lock
+      - name: Run tests
+        run: |
+          npm test
+  release:
+    name: Release
+    needs: test
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push' && github.ref == 'refs/heads/master'
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - name: Setup Node.js
+        uses: actions/setup-node@v3.4.1
+        with:
+          node-version: 16
+      - name: Install dependencies
+        run: |
+          npm install --no-progress --no-package-lock --no-save
+      - name: Build
+        run: |
+          npm run build
+      - name: Install plugins
+        run: |
+          npm install \
+            @semantic-release/commit-analyzer \
+            conventional-changelog-conventionalcommits \
+            @semantic-release/release-notes-generator \
+            @semantic-release/npm \
+            @semantic-release/github \
+            @semantic-release/git \
+            @semantic-release/changelog \
+            --no-progress --no-package-lock --no-save
+      - name: Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+        run: npx semantic-release
+

package/CHANGELOG.md

@@ -0,0 +1,127 @@
+## [2.0.0](https://github.com/rvagg/js-ipld-schema-describer/compare/v1.0.10...v2.0.0) (2022-08-16)
+
+
+### ⚠ BREAKING CHANGES
+
+* publish as ESM-only
+* update dependencies, upgrade schema DMT & library usage
+
+### Features
+
+* publish as ESM-only ([ea4a423](https://github.com/rvagg/js-ipld-schema-describer/commit/ea4a4235a8f0373d8403a4b5a54c74327ffdf1e9))
+* update dependencies, upgrade schema DMT & library usage ([c236af1](https://github.com/rvagg/js-ipld-schema-describer/commit/c236af1793f627f30a89d69c9eaf29f0cab82f2c))
+
+
+### Bug Fixes
+
+* update action ([418ce94](https://github.com/rvagg/js-ipld-schema-describer/commit/418ce945da4b49cc5270a790760d44f2f7bee767))
+
+
+### Trivial Changes
+
+* **no-release:** bump actions/setup-node from 3.1.1 to 3.2.0 ([#24](https://github.com/rvagg/js-ipld-schema-describer/issues/24)) ([81caebc](https://github.com/rvagg/js-ipld-schema-describer/commit/81caebc7af4b901a97f4712831cf985b36a1cd39))
+* **no-release:** bump actions/setup-node from 3.2.0 to 3.3.0 ([#25](https://github.com/rvagg/js-ipld-schema-describer/issues/25)) ([4da7e2c](https://github.com/rvagg/js-ipld-schema-describer/commit/4da7e2c9e85997603a58d2ff26615be2d6e549b6))
+* **no-release:** bump actions/setup-node from 3.3.0 to 3.4.0 ([#27](https://github.com/rvagg/js-ipld-schema-describer/issues/27)) ([a6d1ecb](https://github.com/rvagg/js-ipld-schema-describer/commit/a6d1ecbe2ed18388f40455a9485251bc6c358b70))
+* **no-release:** bump actions/setup-node from 3.4.0 to 3.4.1 ([#28](https://github.com/rvagg/js-ipld-schema-describer/issues/28)) ([18bd605](https://github.com/rvagg/js-ipld-schema-describer/commit/18bd605284572fd18345021a240a92246df357d9))
+
+### [1.0.10](https://github.com/rvagg/js-ipld-schema-describer/compare/v1.0.9...v1.0.10) (2022-05-03)
+
+
+### Trivial Changes
+
+* **deps-dev:** bump mocha from 9.2.2 to 10.0.0 ([821e3e7](https://github.com/rvagg/js-ipld-schema-describer/commit/821e3e741b3c1cb4e09a113f1ef371054ee9f635))
+* **deps:** bump ipld-schema from 1.1.6 to 2.0.1 ([129962f](https://github.com/rvagg/js-ipld-schema-describer/commit/129962f675c5d3f6e5b20bd8d0913eef3bb60715))
+* **no-release:** bump actions/checkout from 2.4.0 to 3 ([#18](https://github.com/rvagg/js-ipld-schema-describer/issues/18)) ([745c567](https://github.com/rvagg/js-ipld-schema-describer/commit/745c5677750506af5af7def747a3e5a2df94b608))
+* **no-release:** bump actions/setup-node from 2.5.0 to 2.5.1 ([#16](https://github.com/rvagg/js-ipld-schema-describer/issues/16)) ([2df4709](https://github.com/rvagg/js-ipld-schema-describer/commit/2df470989f326cacc10bfe3209251e844864d986))
+* **no-release:** bump actions/setup-node from 2.5.1 to 3.0.0 ([#17](https://github.com/rvagg/js-ipld-schema-describer/issues/17)) ([34aaaf8](https://github.com/rvagg/js-ipld-schema-describer/commit/34aaaf85cb915fbbac7298e7380fcb6b14a479cd))
+* **no-release:** bump actions/setup-node from 3.0.0 to 3.1.0 ([#19](https://github.com/rvagg/js-ipld-schema-describer/issues/19)) ([a6965ba](https://github.com/rvagg/js-ipld-schema-describer/commit/a6965ba4c2891f41a086f3db2094978c21c66aac))
+* **no-release:** bump actions/setup-node from 3.1.0 to 3.1.1 ([#20](https://github.com/rvagg/js-ipld-schema-describer/issues/20)) ([6851b6c](https://github.com/rvagg/js-ipld-schema-describer/commit/6851b6c1cda45150171ce4dfc7700b9970c32b3e))
+* **no-release:** bump polendina from 2.0.15 to 3.0.0 ([#23](https://github.com/rvagg/js-ipld-schema-describer/issues/23)) ([44570a3](https://github.com/rvagg/js-ipld-schema-describer/commit/44570a32e66c3ade1b5567a1019326c2af9f3e93))
+* **no-release:** bump standard from 16.0.4 to 17.0.0 ([#21](https://github.com/rvagg/js-ipld-schema-describer/issues/21)) ([baf8f6c](https://github.com/rvagg/js-ipld-schema-describer/commit/baf8f6ca17f74af5ed16811381d0d84c3fdc6f7f))
+
+### [1.0.9](https://github.com/rvagg/js-ipld-schema-describer/compare/v1.0.8...v1.0.9) (2021-12-08)
+
+
+### Trivial Changes
+
+* **deps-dev:** bump polendina from 1.1.1 to 2.0.0 ([#15](https://github.com/rvagg/js-ipld-schema-describer/issues/15)) ([8cd6797](https://github.com/rvagg/js-ipld-schema-describer/commit/8cd679789a72da057d2a199437bb4c00f4db22d9))
+* **no-release:** bump actions/checkout from 2.3.4 to 2.4.0 ([#13](https://github.com/rvagg/js-ipld-schema-describer/issues/13)) ([e13e0ba](https://github.com/rvagg/js-ipld-schema-describer/commit/e13e0baeb5e968645405536e36637c3e4774ca37))
+* **no-release:** bump actions/setup-node from 2.4.1 to 2.5.0 ([#14](https://github.com/rvagg/js-ipld-schema-describer/issues/14)) ([7ed1d18](https://github.com/rvagg/js-ipld-schema-describer/commit/7ed1d1828be472f6d2ba776455574ef69369b1d3))
+
+### [1.0.8](https://github.com/rvagg/js-ipld-schema-describer/compare/v1.0.7...v1.0.8) (2021-09-28)
+
+
+### Trivial Changes
+
+* **deps:** bump actions/setup-node from 2.4.0 to 2.4.1 ([084039f](https://github.com/rvagg/js-ipld-schema-describer/commit/084039f58353295647bf983b381825903a380f5c))
+
+### [1.0.7](https://github.com/rvagg/js-ipld-schema-describer/compare/v1.0.6...v1.0.7) (2021-08-06)
+
+
+### Trivial Changes
+
+* **deps:** bump actions/setup-node from 2.3.2 to 2.4.0 ([330e408](https://github.com/rvagg/js-ipld-schema-describer/commit/330e4086ffd73ef7c3d42ae95457d1c530ad4edd))
+
+### [1.0.6](https://github.com/rvagg/js-ipld-schema-describer/compare/v1.0.5...v1.0.6) (2021-08-05)
+
+
+### Trivial Changes
+
+* **deps:** bump actions/setup-node from 2.3.1 to 2.3.2 ([5753f6f](https://github.com/rvagg/js-ipld-schema-describer/commit/5753f6f0490f29c23029b1a1e843f983d453d255))
+
+### [1.0.5](https://github.com/rvagg/js-ipld-schema-describer/compare/v1.0.4...v1.0.5) (2021-08-04)
+
+
+### Trivial Changes
+
+* **deps:** bump actions/setup-node from 2.3.0 to 2.3.1 ([15bd94b](https://github.com/rvagg/js-ipld-schema-describer/commit/15bd94b2c7a34772db02cabbc3515789b2197ac8))
+
+### [1.0.4](https://github.com/rvagg/js-ipld-schema-describer/compare/v1.0.3...v1.0.4) (2021-07-28)
+
+
+### Trivial Changes
+
+* **deps:** bump actions/setup-node from 2.2.0 to 2.3.0 ([49cdefb](https://github.com/rvagg/js-ipld-schema-describer/commit/49cdefbfdcaef6e32b49bbaf45a71eeca7a798ab))
+* update deps, fix build for latest ipjs ([8bef720](https://github.com/rvagg/js-ipld-schema-describer/commit/8bef72014021f91012beed570d6bc17fbc5179b1))
+
+### [1.0.3](https://github.com/rvagg/js-ipld-schema-describer/compare/v1.0.2...v1.0.3) (2021-07-01)
+
+
+### Trivial Changes
+
+* **deps:** bump actions/setup-node from 2.1.5 to 2.2.0 ([c892d3a](https://github.com/rvagg/js-ipld-schema-describer/commit/c892d3a620b6a17fabedf1a0b4a28622af583ec6))
+
+### [1.0.2](https://github.com/rvagg/js-ipld-schema-describer/compare/v1.0.1...v1.0.2) (2021-06-25)
+
+
+### Bug Fixes
+
+* export types properly ([908506a](https://github.com/rvagg/js-ipld-schema-describer/commit/908506a4aa750aca1f424d79ce48cf01c3724d3a))
+
+### [1.0.1](https://github.com/rvagg/js-ipld-schema-describer/compare/v1.0.0...v1.0.1) (2021-06-25)
+
+
+### Bug Fixes
+
+* release from /dist ([8858183](https://github.com/rvagg/js-ipld-schema-describer/commit/8858183f2d02873845216f403927a87cf5b00f62))
+
+## [1.0.0](https://github.com/rvagg/js-ipld-schema-describer/compare/v0.0.0...v1.0.0) (2021-06-25)
+
+
+### ⚠ BREAKING CHANGES
+
+* add typing, remove default exports
+
+### Features
+
+* add typing, remove default exports ([d972251](https://github.com/rvagg/js-ipld-schema-describer/commit/d9722514c1d6266e19c6022c97b02e62109cdd49))
+
+
+### Bug Fixes
+
+* separate, minimal windows test run ([31e8d18](https://github.com/rvagg/js-ipld-schema-describer/commit/31e8d18e839321aee37c8ce4f30feea6d49957b5))
+
+
+### Trivial Changes
+
+* add semantic release & dependabot ([8550947](https://github.com/rvagg/js-ipld-schema-describer/commit/85509479408b2cfbc0f3b2353ed617844c23add9))

package/example.js

@@ -1,6 +1,6 @@
 import { describe } from 'ipld-schema-describer'
 // @ts-ignore
-import schemaPrint from 'ipld-schema/print.js'
+import { print as schemaPrint } from 'ipld-schema/print.js'
 
 const obj = {
   foo: [1, 'one', true],

package/ipld-schema-describer.js

@@ -2,9 +2,9 @@ import { kind } from './kind.js'
 
 /**
  * @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
  */
 
 /**
@@ -18,14 +18,14 @@ export function describe (obj) {
     // something to point to for our root rather than the plain typed kind
 
     // special case for links
-    if (typeof description.root === 'object' && description.root.kind === 'link') {
+    if (typeof description.root === 'object' && typeof description.root.link === 'object') {
       const name = 'Link'
-      description.schema.types[name] = { kind: 'link' }
+      description.schema.types[name] = { link: {} }
       description.root = name
     } else if (typeof description.root === 'string') {
       const name = `${description.root}`
       // @ts-ignore
-      description.schema.types[name] = { kind: description.root.toLowerCase() }
+      description.schema.types[name] = { [description.root.toLowerCase()]: {} }
       description.root = name
       /* c8 ignore next 3 */
     } else {
@@ -42,7 +42,7 @@ export function describe (obj) {
 /**
  * @param {any} obj
  * @param {Schema} schema
- * @returns {{ schema: Schema, root: string|TypeLink }}
+ * @returns {{ schema: Schema, root: string|{ link: TypeDefnLink } }}
  */
 function describeObject (obj, schema) {
   const objKind = kind(obj)
@@ -59,12 +59,12 @@ function describeObject (obj, schema) {
   }
 
   if (objKind === 'link') {
-    return { schema, root: { kind: 'link' } }
+    return { schema, root: { link: {} } }
   }
 
   // 'map' || 'list'
 
-  /** @type {{ fieldName: string, root: string|TypeLink }[]} */
+  /** @type {{ fieldName: string, root: string|{ link: TypeDefnLink }}[]} */
   const fieldNames = []
   const entries = objKind === 'map'
     ? Object.entries(obj)
@@ -83,32 +83,29 @@ function describeObject (obj, schema) {
   }
 
   name = `${name}_1`
-  /** @type {{ kind: 'map', keyType?: string, valueType?: string|TypeLink }|{ kind: 'list', valueType?: string|TypeLink}|{ kind: 'struct', fields: { [ k in string]: { type: string | TypeLink } }, representation?: { tuple: {} } }} */
+  /** @type {{ map: { keyType?: string, valueType?: string|{ link: TypeDefnLink } } }|{ list: { valueType?: string|{ link: TypeDefnLink } } }|{ struct: { fields: { [ k in string]: { type: string | { link: TypeDefnLink } } }, representation?: { tuple: {} } } } } */
   let type
 
   if (unique) { // a pure map or list
-    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'
-      }
+    const valueType = fieldNames.length ? fieldNames[0].root : 'Any'
+    if (objKind === 'map') {
+      type = { map: { keyType: 'String', valueType } }
+    } else if (objKind === 'list') {
+      type = { list: { valueType } }
+      /* c8 ignore next 4 */
+    } else {
+      throw new Error(`Unexpected object kind: ${objKind}`)
     }
   } else { // a struct with varying types
     name = 'Struct_1'
     type = {
-      kind: 'struct',
-      fields: {}
+      struct: { fields: {} }
     }
     for (const field of fieldNames) {
-      type.fields[field.fieldName] = { type: field.root }
+      type.struct.fields[field.fieldName] = { type: field.root }
     }
     if (objKind === 'list') {
-      type.representation = { tuple: {} }
+      type.struct.representation = { tuple: {} }
     }
   }
 

package/package.json

@@ -1,26 +1,22 @@
 {
   "name": "ipld-schema-describer",
-  "version": "1.0.10",
+  "version": "2.0.0",
   "description": "IPLD Schema Describer",
-  "main": "./cjs/ipld-schema-describer.js",
+  "main": "ipld-schema-describer.js",
+  "type": "module",
   "types": "./types/ipld-schema-describer.d.ts",
   "scripts": {
     "lint": "standard",
-    "build": "npm run build:js && npm run build:types",
-    "build:js": "ipjs build --tests --main && npm run build:copy",
-    "build:copy": "cp -a tsconfig.json *.js dist/",
-    "build:types": "tsc --build && mv types dist",
-    "test:cjs": "npm run build && mocha dist/cjs/node-test/test-*.js",
+    "build": "npm run build:types",
+    "build:types": "tsc --build",
     "test:node": "c8 --check-coverage --branches 100 --functions 100 --lines 100  mocha test/test-*.js",
-    "test:browser": "polendina --cleanup dist/cjs/node-test/test-*.js",
-    "test": "npm run lint && npm run test:node && npm run test:cjs && npm run test:browser",
+    "test:browser": "polendina --cleanup test/test-*.js",
+    "test": "npm run lint && npm run build && npm run test:node && npm run test:browser",
     "coverage": "c8 --reporter=html mocha test/test-*.js && npx st -d coverage -p 8080"
   },
   "exports": {
     ".": {
-      "browser": "./esm/ipld-schema-describer.js",
-      "require": "./cjs/ipld-schema-describer.js",
-      "import": "./esm/ipld-schema-describer.js"
+      "import": "./ipld-schema-describer.js"
     }
   },
   "repository": {
@@ -38,16 +34,15 @@
   },
   "homepage": "https://github.com/rvagg/js-ipld-schema-describer#readme",
   "devDependencies": {
-    "c8": "^7.7.3",
-    "chai": "^4.3.4",
-    "ipjs": "^5.0.4",
+    "c8": "^7.12.0",
+    "chai": "^4.3.6",
     "mocha": "^10.0.0",
-    "polendina": "^3.0.0",
+    "polendina": "^3.1.0",
     "standard": "^17.0.0",
-    "typescript": "^4.3.5"
+    "typescript": "^4.7.4"
   },
   "dependencies": {
-    "ipld-schema": "^2.0.1"
+    "ipld-schema": "^3.0.2"
   },
   "typesVersions": {
     "*": {
@@ -135,17 +130,9 @@
         }
       ],
       "@semantic-release/changelog",
-      [
-        "@semantic-release/npm",
-        {
-          "pkgRoot": "dist"
-        }
-      ],
+      "@semantic-release/npm",
       "@semantic-release/github",
       "@semantic-release/git"
     ]
-  },
-  "browser": {
-    ".": "./cjs/ipld-schema-describer.js"
   }
 }

package/test/test-basics.js

@@ -0,0 +1,253 @@
+/* eslint-env mocha */
+
+import { describe as describeSchema } from 'ipld-schema-describer'
+import chai from 'chai'
+
+const { assert } = chai
+
+const fauxCID = {}
+fauxCID.asCID = fauxCID
+
+function verify (obj, expected) {
+  const description = describeSchema(obj)
+  assert.deepEqual(description, expected)
+}
+
+describe('Basics', () => {
+  it('null', () => {
+    const expected = { schema: { types: { Null: { null: {} } } }, root: 'Null' }
+    verify(null, expected)
+  })
+
+  it('bool', () => {
+    const expected = { schema: { types: { Bool: { bool: {} } } }, root: 'Bool' }
+    verify(true, expected)
+    verify(false, expected)
+  })
+
+  it('int', () => {
+    const expected = { schema: { types: { Int: { int: {} } } }, root: 'Int' }
+    verify(101, expected)
+    verify(-101, expected)
+    verify(0, expected)
+  })
+
+  it('float', () => {
+    const expected = { schema: { types: { Float: { float: {} } } }, root: 'Float' }
+    verify(1.01, expected)
+    verify(-1.01, expected)
+  })
+
+  it('string', () => {
+    const expected = { schema: { types: { String: { string: {} } } }, root: 'String' }
+    verify('a string', expected)
+    verify('', expected)
+  })
+
+  it('link', () => {
+    const expected = { schema: { types: { Link: { link: {} } } }, root: 'Link' }
+    verify(fauxCID, expected)
+  })
+
+  it('bytes', () => {
+    const expected = { schema: { types: { Bytes: { 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: {
+            map: {
+              keyType: 'String',
+              valueType: 'String'
+            }
+          }
+        }
+      },
+      root: 'Map_1'
+    }
+    verify(obj, expected)
+  })
+
+  it('empty map', () => {
+    const obj = {}
+    const expected = {
+      schema: {
+        types: {
+          Map_1: {
+            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: {
+            struct: {
+              fields: {
+                s: { type: 'String' },
+                i: { type: 'Int' },
+                l: { type: { link: {} } }
+              }
+            }
+          }
+        }
+      },
+      root: 'Struct_1'
+    }
+    verify(obj, expected)
+  })
+
+  it('list', () => {
+    const obj = ['a string', 'second string', 'third string']
+    const expected = {
+      schema: {
+        types: {
+          List_1: {
+            list: {
+              valueType: 'String'
+            }
+          }
+        }
+      },
+      root: 'List_1'
+    }
+    verify(obj, expected)
+  })
+
+  it('empty list', () => {
+    const obj = []
+    const expected = {
+      schema: {
+        types: {
+          List_1: {
+            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: {
+            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: {
+            list: {
+              valueType: 'String'
+            }
+          },
+          List_2: {
+            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: {
+            map: {
+              keyType: 'String',
+              valueType: 'String'
+            }
+          },
+          Map_2: {
+            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: {
+            struct: {
+              fields: {
+                f0: { type: 'String' },
+                f1: { type: 'Bool' }
+              },
+              representation: { tuple: {} }
+            }
+          },
+          Struct_2: {
+            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/test/test-errors.js

@@ -0,0 +1,12 @@
+/* eslint-env mocha */
+
+import { describe as describeSchema } from 'ipld-schema-describer'
+import chai from 'chai'
+
+const { assert } = chai
+
+describe('Errors', () => {
+  it('bad kind', () => {
+    assert.throws(() => describeSchema(undefined), /Unknown IPLD kind for value: undefined/)
+  })
+})

package/tsconfig.json

@@ -33,7 +33,7 @@
   },
   "exclude": [
     "node_modules",
-    "dist",
+    "types",
     "test"
   ],
   "compileOnSave": false