fixup! fix: more generic BlockCodec, remove encoder & decoder props

Author: rvagg

src/codecs/codec.js

@@ -3,13 +3,15 @@
 /**
  * @template {number} Code
  * @template T
- * @typedef {import('./interface').BlockCodec<Code, T>} BlockCodec
+ * @typedef {import('./interface').CodecFeature<Code, T>} CodecFeature
  */
+
 /**
  * @template {number} Code
  * @template T
  * @typedef {import('./interface').BlockEncoder<Code, T>} BlockEncoder
  */
+
 /**
  * @template {number} Code
  * @template T
@@ -25,7 +27,7 @@
  * @param {Code} options.code
  * @param {(data:T) => Uint8Array} options.encode
  * @param {(bytes:Uint8Array) => T} options.decode
- * @returns {BlockCodec<Code, T> & { encoder: BlockEncoder<Code, T>, decoder: BlockDecoder<Code, T> }}
+ * @returns {CodecFeature<Code, T>}
  */
 export const codec = ({ name, code, decode, encode }) => {
   const decoder = new Decoder(name, code, decode)

src/codecs/interface.ts

@@ -22,6 +22,15 @@ export interface BlockDecoder<Code extends number, T> {
  */
 export interface BlockCodec<Code extends number, T> extends BlockEncoder<Code, T>, BlockDecoder<Code, T> {}
 
+/**
+ * A roll-up type from which you can derive any of `BlockCodec`,
+ * `BlockEncoder` or `BlockDecoder`. Intended as the interface exported
+ * by codec implementations.
+ */
+export interface CodecFeature<Code extends number, T> extends BlockCodec<Code, T> {
+  encoder: BlockEncoder<Code, T>,
+  decoder: BlockDecoder<Code, T>
+}
 
 // This just a hack to retain type information about the data that
 // is encoded `T`  Because it's a union `data` field is never going

src/codecs/json.js

@@ -2,6 +2,16 @@
 
 import { codec } from './codec.js'
 
+/**
+ * @template {number} Code
+ * @template T
+ * @typedef {import('./interface').CodecFeature<Code, T>} CodecFeature
+ */
+
+/**
+ * @template T
+ * @type {CodecFeature<0x0200, T>}
+ */
 export const { name, code, decode, encode, decoder, encoder } = codec({
   name: 'json',
   code: 0x0200,

src/codecs/raw.js

@@ -3,9 +3,25 @@
 import { coerce } from '../bytes.js'
 import { codec } from './codec.js'
 
+/**
+ * @template {number} Code
+ * @template T
+ * @typedef {import('./interface').CodecFeature<Code, T>} CodecFeature
+ */
+
+/**
+ * @param {Uint8Array} bytes
+ * @returns {Uint8Array}
+ */
+const raw = (bytes) => coerce(bytes)
+
+/**
+ * @template T
+ * @type {CodecFeature<0x55, Uint8Array>}
+ */
 export const { name, code, decode, encode, decoder, encoder } = codec({
   name: 'raw',
-  code: 85,
-  decode: coerce,
-  encode: coerce
+  code: 0x55,
+  decode: raw,
+  encode: raw
 })