Merge pull request #51 from ngraveio/fix-types

Add registry support for items that has NaN as tag
Update readme
Fix error on commonjs types when importing cbor2

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ngraveio/bc-ur",
-  "version": "2.0.1-beta.1",
+  "version": "2.0.0-beta.4",
   "author": "Antonis Poulakis <[email protected]>, Irfan Bilaloğlu <[email protected]>, Pieter Uyttersprot <[email protected]>",
   "description": "A JS implementation of the Uniform Resources (UR) specification from Blockchain Commons",
   "license": "MIT",
@@ -17,10 +17,10 @@
   "scripts": {
     "clean": "rimraf dist && rimraf tsconfig.tsbuildinfo",
     "build": "yarn clean && yarn compile",
-    "compile": "tshy && rollup -c",
+    "compile": "tshy && rollup -c && \\cp -f ./src/wrappers/cbor2Wrapper.ts ./dist/commonjs/wrappers/cbor2Wrapper.d.ts",
     "test": "node --experimental-vm-modules node_modules/.bin/jest",
     "prepublishOnly": "yarn build",
-    "postinstall": "patch-package",
+    "prebuild": "patch-package",
     "lint": "eslint \"./src/**/*.{ts,tsx}\" --max-warnings=0",
     "start": "live-server --watch=src,dist --port=8080"
   },
@@ -49,6 +49,9 @@
     "tslib": "^2.8.1",
     "typescript": "5.6.2"
   },
+  "bundleDependencies": [
+    "@keystonehq/alias-sampling"
+  ],
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ngraveio/bc-ur.git"

patches/@keystonehq+alias-sampling+0.1.2.patch

@@ -1,37 +1,44 @@
 diff --git a/node_modules/@keystonehq/alias-sampling/dist/cjs/index.d.ts b/node_modules/@keystonehq/alias-sampling/dist/cjs/index.d.ts
-index a11c780..814932f 100644
+index a11c780..600c193 100644
 --- a/node_modules/@keystonehq/alias-sampling/dist/cjs/index.d.ts
 +++ b/node_modules/@keystonehq/alias-sampling/dist/cjs/index.d.ts
-@@ -8,3 +8,4 @@ declare const sample: (probabilities: number[], outcomes?: any[], rng?: RNGFunct
+@@ -7,4 +7,5 @@ declare const next: (aliasData: AliasData, outcomes: any[], rng: RNGFunction, nu
+ declare const sample: (probabilities: number[], outcomes?: any[], rng?: RNGFunction) => {
      next: (numOfSamples?: number) => any | any[];
  };
- export default sample;
+-export default sample;
++export default sample; // Next line patched
 +export { sample }
 diff --git a/node_modules/@keystonehq/alias-sampling/dist/cjs/index.js b/node_modules/@keystonehq/alias-sampling/dist/cjs/index.js
-index 48c7d33..5bc3815 100644
+index 48c7d33..8db5def 100644
 --- a/node_modules/@keystonehq/alias-sampling/dist/cjs/index.js
 +++ b/node_modules/@keystonehq/alias-sampling/dist/cjs/index.js
-@@ -77,3 +77,4 @@ var sample = function (probabilities, outcomes, rng) {
+@@ -76,4 +76,5 @@ var sample = function (probabilities, outcomes, rng) {
+         }
      };
  };
- exports.default = sample;
+-exports.default = sample;
++exports.default = sample; // Next line patched
 +exports.sample = sample;
 diff --git a/node_modules/@keystonehq/alias-sampling/dist/esm/index.d.ts b/node_modules/@keystonehq/alias-sampling/dist/esm/index.d.ts
-index a11c780..2ec4586 100644
+index a11c780..a50cde5 100644
 --- a/node_modules/@keystonehq/alias-sampling/dist/esm/index.d.ts
 +++ b/node_modules/@keystonehq/alias-sampling/dist/esm/index.d.ts
-@@ -8,3 +8,5 @@ declare const sample: (probabilities: number[], outcomes?: any[], rng?: RNGFunct
+@@ -7,4 +7,5 @@ declare const next: (aliasData: AliasData, outcomes: any[], rng: RNGFunction, nu
+ declare const sample: (probabilities: number[], outcomes?: any[], rng?: RNGFunction) => {
      next: (numOfSamples?: number) => any | any[];
  };
- export default sample;
+-export default sample;
++export default sample; // Next line patched
 +export { sample };
-+
 diff --git a/node_modules/@keystonehq/alias-sampling/dist/esm/index.js b/node_modules/@keystonehq/alias-sampling/dist/esm/index.js
-index 0761ba7..1d598ec 100644
+index 0761ba7..cfee806 100644
 --- a/node_modules/@keystonehq/alias-sampling/dist/esm/index.js
 +++ b/node_modules/@keystonehq/alias-sampling/dist/esm/index.js
-@@ -75,3 +75,4 @@ var sample = function (probabilities, outcomes, rng) {
+@@ -74,4 +74,5 @@ var sample = function (probabilities, outcomes, rng) {
+         }
      };
  };
- export default sample;
+-export default sample;
++export default sample; // Next line patched
 +export { sample };

src/classes/RegistryItem.ts

@@ -120,6 +120,9 @@ export abstract class RegistryItemBase {
   toUr() {
     return new Ur(this);
   }
+
+  public encodeKeys = encodeKeys;
+  public decodeKeys = decodeKeys;
 }
 
 /**
@@ -130,7 +133,7 @@ export abstract class RegistryItemBase {
  * @param input
  * @returns
  */
-export function registryItemFactory(input: IRegistryType): RegistryItemClass {
+export function registryItemFactory<T extends RegistryItemBase>(input: IRegistryType): RegistryItemClass<T> {
   const { tag, URType, CDDL, keyMap, allowKeysNotInMap = true } = input;
   const _keyMap = keyMap;
 
@@ -173,7 +176,7 @@ export function registryItemFactory(input: IRegistryType): RegistryItemClass {
       // Return an instance of the generated class
       return new this(data);
     }
-  };
+  } as RegistryItemClass<T>;
 }
 
 // Helper type to define the RegistryItem class with custom constructors and static properties

src/index.ts

@@ -1,20 +1,28 @@
 import { Ur } from "./classes/Ur.js"
 import { UrRegistry } from "./registry.js"
-import { registryItemFactory } from "./classes/RegistryItem.js"
+import { registryItemFactory, RegistryItemBase } from "./classes/RegistryItem.js"
 import { UrFountainEncoder } from "./classes/UrFountainEncoder.js"
 import { UrFountainDecoder } from "./classes/UrFountainDecoder.js"
 import { FountainEncoder } from "./classes/FountainEncoder.js"
 import { FountainDecoder } from "./classes/FountainDecoder.js"
 import { defaultEncoders, dataPipeline } from "./encodingMethods/index.js"
 
+import { CborEncoding } from "./encodingMethods/CborEncoding.js"
+import { BytewordEncoding } from "./encodingMethods/BytewordEncoding.js"
+import { HexEncoding } from "./encodingMethods/HexEncoding.js"
+
 export {
   UrRegistry,
   registryItemFactory,
+  RegistryItemBase,
   Ur,
   UrFountainDecoder,
   UrFountainEncoder,
   FountainDecoder,
   FountainEncoder,
+  CborEncoding,
+  BytewordEncoding,
+  HexEncoding,  
   defaultEncoders,
   dataPipeline,
 }

src/registry.ts

@@ -51,14 +51,18 @@ export class URRegistryClass {
       this.log(`Warning: Tag collision detected for tag: ${item.tag}`);
     }
     this.registry.set(item.URType, item);
-    this.tagMap.set(item.tag, item.URType);
-    Tag.registerDecoder(item.tag, (tag: Tag, opts: any) => {
-      return item.fromCBORData.bind(item)(
-        tag.contents,
-        item.allowKeysNotInMap,
-        opts
-      );
-    });
+
+    // Register to CBOR decoder only if it has a tag
+    if (!Number.isNaN(item.tag)) {
+      this.tagMap.set(item.tag, item.URType);
+      Tag.registerDecoder(item.tag, (tag: Tag, opts: any) => {
+        return item.fromCBORData.bind(item)(
+          tag.contents,
+          item.allowKeysNotInMap,
+          opts
+        );
+      });
+    }
   }
 
   public addItems(items: RegistryItemClass[]): void {

src/wrappers/cbor2-deno.mts

@@ -1,4 +1,6 @@
 // If you need a provide an ESM dialect that doesn't support CommonJS (eg, deno, browser, etc), then you can do this:
 // No dual package hazard here
+//@ts-ignore
 export { decode, encode, Tag, registerEncoder } from "./cbor2Wrapper.js";
+//@ts-ignore
 export type { DecodeOptions, EncodeOptions } from "./cbor2Wrapper.js";

src/wrappers/cbor2Wrapper.ts

@@ -1,6 +1,7 @@
 import type {
   DecodeOptions,
   EncodeOptions,
+//@ts-ignore
 } from 'cbor2' with { 'resolution-mode': 'import' };
 
 //@ts-ignore