multiformats - npm Package Compare versions

Comparing version 1.1.13 to 2.0.0

cid.js

 import * as bytes from 'multiformats/bytes.js'
-import withIs from 'class-is'
 
@@ -12,2 +11,32 @@ const readonly = (object, key, value) => {
 
+// ESM does not support importing package.json where this version info
+// should come from. To workaround it version is copied here.
+const version = '0.0.0-dev'
+// Start throwing exceptions on major version bump
+const deprecate = (range, message) => {
+  if (range.test(version)) {
+    console.warn(message)
+  /* c8 ignore next 3 */
+  } else {
+    throw new Error(message)
+  }
+}
+
+const IS_CID_DEPRECATION =
+`CID.isCID(v) is deprecated and will be removed in the next major release.
+Following code pattern:
+
+if (CID.isCID(value)) {
+  doSomethingWithCID(value)
+} 
+
+Is replaced with:
+
+const cid = CID.asCID(value)
+if (cid) {
+  // Make sure to use cid instead of value
+  doSomethingWithCID(cid)
+}
+`
+
 export default multiformats => {
@@ -26,2 +55,5 @@ const { multibase, varint, multihash } = multiformats
   }
+
+  const cidSymbol = Symbol.for('@ipld/js-cid/CID')
+
   class CID {
@@ -35,3 +67,3 @@ constructor (cid, ...args) {
       readonly(this, 'asCID', this)
-      if (_CID.isCID(cid)) {
+      if (cid != null && cid[cidSymbol] === true) {
         readonly(this, 'version', cid.version)
@@ -110,7 +142,7 @@ readonly(this, 'multihash', bytes.coerce(cid.multihash))
 
-      return new _CID(0, this.code, this.multihash)
+      return new CID(0, this.code, this.multihash)
     }
 
     toV1 () {
-      return new _CID(1, this.code, this.multihash)
+      return new CID(1, this.code, this.multihash)
     }
@@ -153,9 +185,54 @@
     }
+
+    get [Symbol.toStringTag] () {
+      return 'CID'
+    }
+
+    get [cidSymbol] () {
+      return true
+    }
+
+    /**
+     * Takes any input `value` and returns a `CID` instance if it was
+     * a `CID` otherwise returns `null`. If `value` is instanceof `CID`
+     * it will return value back. If `value` is not instance of this CID
+     * class, but is compatible CID it will return new instance of this
+     * `CID` class. Otherwise returs null.
+     *
+     * This allows two different incompatible versions of CID library to
+     * co-exist and interop as long as binary interface is compatible.
+     * @param {any} value
+     * @returns {CID|null}
+     */
+    static asCID (value) {
+      // If value is instance of CID then we're all set.
+      if (value instanceof CID) {
+        return value
+      // If value isn't instance of this CID class but `this.asCID === this` is
+      // true it is CID instance coming from a different implemnetation (diff
+      // version or duplicate). In that case we rebase it to this `CID`
+      // implemnetation so caller is guaranteed to get instance with expected
+      // API.
+      } else if (value != null && value.asCID === value) {
+        const { version, code, multihash } = value
+        return new CID(version, code, multihash)
+      // If value is a CID from older implementation that used to be tagged via
+      // symbol we still rebase it to the this `CID` implementation by
+      // delegating that to a constructor.
+      } else if (value != null && value[cidSymbol] === true) {
+        return new CID(value)
+      // Otherwise value is not a CID (or an incompatible version of it) in
+      // which case we return `null`.
+      } else {
+        return null
+      }
+    }
+
+    static isCID (value) {
+      deprecate(/^0\.0/, IS_CID_DEPRECATION)
+      return !!(value && value[cidSymbol])
+    }
   }
 
-  const _CID = withIs(CID, {
-    className: 'CID',
-    symbolName: '@ipld/js-cid/CID'
-  })
-  return _CID
+  return CID
 }

package.json

 {
   "name": "multiformats",
-  "version": "1.1.13",
+  "version": "2.0.0",
   "description": "Interface for multihash, multicodec, multibase and CID.",
@@ -103,3 +103,2 @@ "main": "index.js",
     "cids": "^0.8.3",
-    "class-is": "^1.1.0",
     "varint": "^5.0.0"
@@ -106,0 +105,0 @@ },

test/test-cid.js

@@ -335,2 +335,53 @@ /* globals before, describe, it */
   })
+
+  test('asCID', () => {
+    class IncompatibleCID {
+      constructor (version, code, multihash) {
+        this.version = version
+        this.code = code
+        this.multihash = multihash
+        this.asCID = this
+      }
+
+      get [Symbol.for('@ipld/js-cid/CID')] () {
+        return true
+      }
+    }
+
+    const version = 1
+    const code = 112
+    const multihash = hash
+
+    const incompatibleCID = new IncompatibleCID(version, code, multihash)
+    assert.ok(CID.isCID(incompatibleCID))
+    assert.strictEqual(incompatibleCID.toString(), '[object Object]')
+    assert.strictEqual(typeof incompatibleCID.toV0, 'undefined')
+
+    const cid1 = CID.asCID(incompatibleCID)
+    assert.ok(cid1 instanceof CID)
+    assert.strictEqual(cid1.code, code)
+    assert.strictEqual(cid1.version, version)
+    assert.strictEqual(cid1.multihash, multihash)
+
+    const cid2 = CID.asCID({ version, code, multihash })
+    assert.strictEqual(cid2, null)
+
+    const duckCID = { version, code, multihash }
+    duckCID.asCID = duckCID
+    const cid3 = CID.asCID(duckCID)
+    assert.ok(cid3 instanceof CID)
+    assert.strictEqual(cid3.code, code)
+    assert.strictEqual(cid3.version, version)
+    assert.strictEqual(cid3.multihash, multihash)
+
+    const cid4 = CID.asCID(cid3)
+    assert.strictEqual(cid3, cid4)
+
+    const cid5 = CID.asCID(new OLDCID(1, 'raw', Buffer.from(hash)))
+    assert.ok(cid5 instanceof CID)
+    assert.strictEqual(cid5.version, 1)
+    same(cid5.multihash, hash)
+    assert.strictEqual(cid5.code, 85)
+  })
+
   test('new CID from old CID', () => {
@@ -337,0 +388,0 @@ const cid = new CID(new OLDCID(1, 'raw', Buffer.from(hash)))

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

878384

increased by0.88%

Dependency count

5

decreased by-16.67%

Lines of code

2377

increased by7.8%

Dependency changes

• - Removedclass-is@^1.1.0