feat!: full type checks, generation and publishing

also publishes with "main"

index.js

@@ -1,17 +1,21 @@
 import * as cborg from 'cborg'
-import CID from 'multiformats/cid'
-import { Decoder, Encoder } from 'multiformats/codecs/codec'
+import { CID } from 'multiformats/cid'
+import { codec } from 'multiformats/codecs/codec'
+
+/**
+ * @template {number} Code
+ * @template T
+ * @typedef {import('multiformats/codecs/codec').CodecFeature<Code, T>} CodecFeature
+ */
 
 // https://github.com/ipfs/go-ipfs/issues/3570#issuecomment-273931692
 const CID_CBOR_TAG = 42
-/** @type {number} */
-const code = 0x71
-/** @type {string} */
-const name = 'dag-cbor'
 
-// this will receive all Objects, we need to filter out anything that's not
-// a CID and return `null` for that so it's encoded as normal
 /**
+ * cidEncoder will receive all Objects during encode, it needs to filter out
+ * anything that's not a CID and return `null` for that so it's encoded as
+ * normal.
+ *
  * @param {any} obj
  * @returns {cborg.Token[]|null}
  */
@@ -34,13 +38,20 @@ function cidEncoder (obj) {
 }
 
 /**
+ * Intercept all `undefined` values from an object walk and reject the entire
+ * object if we find one.
+ *
  * @returns {null}
  */
 function undefinedEncoder () {
   throw new Error('`undefined` is not supported by the IPLD Data Model and cannot be encoded')
 }
 
 /**
+ * Intercept all `number` values from an object walk and reject the entire
+ * object if we find something that doesn't fit the IPLD data model (NaN &
+ * Infinity).
+ *
  * @param {number} num
  * @returns {null}
  */
@@ -63,15 +74,6 @@ const encodeOptions = {
   }
 }
 
-/**
- * @template T
- * @param {T} node
- * @returns {Uint8Array}
- */
-function encode (node) {
-  return cborg.encode(node, encodeOptions)
-}
-
 /**
  * @param {Uint8Array} bytes
  * @returns {CID}
@@ -99,14 +101,21 @@ decodeOptions.tags[CID_CBOR_TAG] = cidDecoder
 
 /**
  * @template T
- * @param {Uint8Array} data
- * @returns {T}
+ * @type {CodecFeature<0x71, T>}
  */
-function decode (data) {
-  return cborg.decode(data, decodeOptions)
-}
-
-const decoder = new Decoder(name, code, decode)
-const encoder = new Encoder(name, code, encode)
-
-export { name, code, decode, encode, decoder, encoder }
+export const { name, code, decode, encode, decoder, encoder } = codec({
+  name: 'dag-cbor',
+  code: 0x71,
+  /**
+   * @template T
+   * @param {T} node
+   * @returns {Uint8Array}
+   */
+  encode: (node) => cborg.encode(node, encodeOptions),
+  /**
+   * @template T
+   * @param {Uint8Array} data
+   * @returns {T}
+   */
+  decode: (data) => cborg.decode(data, decodeOptions)
+})

package.json

@@ -2,15 +2,17 @@
   "name": "@ipld/dag-cbor",
   "version": "0.0.0-dev",
   "description": "JS implementation of dag-cbor",
+  "main": "index.js",
+  "types": "./types/index.d.ts",
   "type": "module",
-  "types": "index.d.ts",
   "scripts": {
     "lint": "standard",
     "build": "npm run build:js && npm run build:types",
-    "build:js": "npm_config_yes=true npx ipjs@latest build --tests",
-    "build:types": "tsc --build",
-    "check": "tsc --build --noEmit --noErrorTruncation",
-    "publish": "npm_config_yes=true npx ipjs@latest publish",
+    "build:js": "npm_config_yes=true ipjs build --tests --main && npm run build:copy",
+    "build:copy": "cp -a tsconfig.json index.js test/ dist/",
+    "build:types": "npm run build:copy && cd dist && tsc --build",
+    "check": "tsc --build --noErrorTruncation",
+    "publish": "npm_config_yes=true ipjs publish",
     "test:cjs": "npm run build && mocha dist/cjs/node-test/test-*.js",
     "test:node": "hundreds mocha test/test-*.js",
     "test:browser": "polendina --cleanup dist/cjs/node-test/test-*.js",
@@ -33,13 +35,14 @@
   },
   "homepage": "https://github.com/ipld/js-dag-cbor",
   "dependencies": {
-    "cborg": "^1.1.2",
-    "multiformats": "^4.6.1"
+    "cborg": "^1.2.1",
+    "multiformats": "https://gitpkg.now.sh/multiformats/js-multiformats/dist?rvagg/moar-generic-blockcodec"
   },
   "devDependencies": {
     "chai": "^4.3.3",
     "hundreds": "^0.0.9",
-    "ipld-garbage": "^2.0.0",
+    "ipjs": "^5.0.0",
+    "ipld-garbage": "^3.0.0",
     "mocha": "^8.3.1",
     "polendina": "^1.1.0",
     "standard": "^16.0.3",
@@ -48,5 +51,15 @@
   "directories": {
     "test": "test"
   },
+  "typesVersions": {
+    "*": {
+      "*": [
+        "types/*"
+      ],
+      "types/*": [
+        "types/*"
+      ]
+    }
+  },
   "author": "Mikeal Rogers <mikeal.rogers@gmail.com> (https://www.mikealrogers.com/)"
 }

test/test-basics.js

@@ -1,6 +1,6 @@
 /* eslint-env mocha */
 'use strict'
-import garbage from 'ipld-garbage'
+import { garbage } from 'ipld-garbage'
 import chai from 'chai'
 import * as dagcbor from '../index.js'
 import { bytes, CID } from 'multiformats'

tsconfig.json

@@ -1,66 +1,31 @@
 {
   "compilerOptions": {
-    /* Visit https://aka.ms/tsconfig.json to read more about this file */
-    /* Basic Options */
-    "incremental": true, /* Enable incremental compilation */
-    "target": "ES2020", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
-    "module": "ES2020", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
-    // "lib": [],                                   /* Specify library files to be included in the compilation. */
-    "allowJs": true, /* Allow javascript files to be compiled. */
-    "checkJs": true, /* Report errors in .js files. */
-    // "jsx": "preserve",                           /* Specify JSX code generation: 'preserve', 'react-native', 'react', 'react-jsx' or 'react-jsxdev'. */
-    "declaration": true, /* Generates corresponding '.d.ts' file. */
-    "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */
+    "allowJs": true,
+    "checkJs": true,
+    "forceConsistentCasingInFileNames": true,
+    "noImplicitReturns": false,
+    "noImplicitAny": true,
+    "noImplicitThis": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "strictFunctionTypes": false,
+    "strictNullChecks": true,
+    "strictPropertyInitialization": true,
+    "strictBindCallApply": true,
+    "strict": true,
+    "alwaysStrict": true,
+    "esModuleInterop": true,
+    "target": "ES2018",
+    "moduleResolution": "node",
+    "declaration": true,
+    "declarationMap": true,
     "emitDeclarationOnly": true,
-    // "sourceMap": true,                           /* Generates corresponding '.map' file. */
-    // "outFile": "./",                             /* Concatenate and emit output to single file. */
-    "outDir": "./dist", /* Redirect output structure to the directory. */
-    // "rootDir": "./",                             /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
-    "composite": true, /* Enable project compilation */
-    // "tsBuildInfoFile": "./",                     /* Specify file to store incremental compilation information */
-    // "removeComments": true,                      /* Do not emit comments to output. */
-    // "noEmit": true,                              /* Do not emit outputs. */
-    // "importHelpers": true,                       /* Import emit helpers from 'tslib'. */
-    // "downlevelIteration": true,                  /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
-    "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
-    /* Strict Type-Checking Options */
-    "strict": true, /* Enable all strict type-checking options. */
-    "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */
-    "strictNullChecks": true, /* Enable strict null checks. */
-    "strictFunctionTypes": true, /* Enable strict checking of function types. */
-    "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
-    "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */
-    "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */
-    "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */
-    /* Additional Checks */
-    "noUnusedLocals": true, /* Report errors on unused locals. */
-    "noUnusedParameters": true, /* Report errors on unused parameters. */
-    "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */
-    "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */
-    "noUncheckedIndexedAccess": true, /* Include 'undefined' in index signature results */
-    "noPropertyAccessFromIndexSignature": true, /* Require undeclared properties from index signatures to use element accesses. */
-    /* Module Resolution Options */
-    "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
-    // "baseUrl": "./",                             /* Base directory to resolve non-absolute module names. */
-    // "paths": {},                                 /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
-    // "rootDirs": [],                              /* List of root folders whose combined content represents the structure of the project at runtime. */
-    // "typeRoots": [],                             /* List of folders to include type definitions from. */
-    // "types": [],                                 /* Type declaration files to be included in compilation. */
-    // "allowSyntheticDefaultImports": true,        /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
-    "esModuleInterop": true, /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
-    // "preserveSymlinks": true,                    /* Do not resolve the real path of symlinks. */
-    // "allowUmdGlobalAccess": true,                /* Allow accessing UMD globals from modules. */
-    /* Source Map Options */
-    // "sourceRoot": "",                            /* Specify the location where debugger should locate TypeScript files instead of source locations. */
-    // "mapRoot": "",                               /* Specify the location where debugger should locate map files instead of generated locations. */
-    // "inlineSourceMap": true,                     /* Emit a single file with source maps instead of having a separate file. */
-    // "inlineSources": true,                       /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
-    /* Experimental Options */
-    // "experimentalDecorators": true,              /* Enables experimental support for ES7 decorators. */
-    // "emitDecoratorMetadata": true,               /* Enables experimental support for emitting type metadata for decorators. */
-    /* Advanced Options */
-    "skipLibCheck": true, /* Skip type checking of declaration files. */
-    "forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */
+    "outDir": "types",
+    "skipLibCheck": true,
+    "stripInternal": true,
+    "resolveJsonModule": true,
+    "baseUrl": "."
   },
   "include": [
     "index.js"