feat: add Schema.bytes (#300)

storacha · May 2, 2023 · 2bbdd1c · 2bbdd1c
1 parent 400d8e9
commit 2bbdd1c
Show file tree

Hide file tree

Showing 2 changed files with 50 additions and 1 deletion.
diff --git a/packages/core/src/schema/schema.js b/packages/core/src/schema/schema.js
@@ -920,6 +920,28 @@ class AnyString extends UnknownString {
 const anyString = new AnyString()
 export const string = () => anyString
 
+/**
+ * @template [I=unknown]
+ * @extends {API<Uint8Array, I, void>}
+ */
+class BytesSchema extends API {
+  /**
+   * @param {I} input
+   * @returns {Schema.ReadResult<Uint8Array>}
+   */
+  readWith(input) {
+    if (input instanceof Uint8Array) {
+      return { ok: input }
+    } else {
+      return typeError({ expect: 'Uint8Array', actual: input })
+    }
+  }
+}
+
+/** @type {Schema.Schema<Uint8Array, unknown>} */
+export const Bytes = new BytesSchema()
+export const bytes = () => Bytes
+
 /**
  * @template {string} Prefix
  * @template {string} Body
@@ -1380,7 +1402,13 @@ const displayTypeName = value => {
     case 'undefined':
       return String(value)
     case 'object':
-      return value === null ? 'null' : Array.isArray(value) ? 'array' : 'object'
+      return value === null
+        ? 'null'
+        : Array.isArray(value)
+        ? 'array'
+        : Symbol.toStringTag in /** @type {object} */ (value)
+        ? value[Symbol.toStringTag]
+        : 'object'
     default:
       return type
   }

diff --git a/packages/core/test/schema.spec.js b/packages/core/test/schema.spec.js
@@ -657,3 +657,24 @@ test('record defaults', () => {
     end: { x: 1, y: 3 },
   })
 })
+
+test('bytes schema', () => {
+  const schema = Schema.bytes()
+  matchError(schema.read(undefined), /expect.* Uint8Array .* got undefined/is)
+
+  const bytes = new Uint8Array([1, 2, 3])
+
+  assert.equal(schema.read(bytes).ok, bytes, 'returns same bytes back')
+
+  matchError(
+    schema.read(bytes.buffer),
+    /expect.* Uint8Array .* got ArrayBuffer/is
+  )
+
+  matchError(
+    schema.read(new Int8Array(bytes.buffer)),
+    /expect.* Uint8Array .* got Int8Array/is
+  )
+
+  matchError(schema.read([...bytes]), /expect.* Uint8Array .* got array/is)
+})