schematox 1.0.0 → 1.0.1

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## [1.0.1](https://github.com/incerta/schematox/compare/v1.0.0...v1.0.1)
+
+- [FIX: struct brand assignment second argument type restriction #44](https://github.com/incerta/schematox/pull/44)
+
 ## [1.0.0](https://github.com/incerta/schematox/compare/v0.4.0...v1.0.0)
 
 The module went through major refactoring so it could be ready for production usage:

package/README.md

@@ -1,4 +1,4 @@
-# schematox
+# Schematox
 
 Schematox is a lightweight typesafe schema defined parser. All schemas are JSON compatible.
 
@@ -142,10 +142,12 @@ const string = makeStruct(schema)
 
 We distinguish two main categories of schema units:
 
-- primitive: boolean, literal, number, boolean
-- compound: array, object, record, union
+- primitive: boolean, literal, number, string
+- compound: array, object, record, tuple, union
 
-Any schema share optional/nullable/description parameters. Any compound schema could have any other schema type as its member including itself. Any primitive schema can have "brand" parameter.
+Any schema share optional/nullable/description parameters.
+Any primitive schema can have "brand" parameter.
+Any compound schema could have any other schema type as its member including itself.
 
 ### Boolean
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "schematox",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "scripts": {
     "prepublishOnly": "bash release-check.sh",
     "test": "jest",

package/src/types/schema.ts

@@ -8,9 +8,7 @@ export type Schema =
    | { type: 'tuple'; of: Array<Schema> } & SchemaShared
    | { type: 'union'; of: Array<Schema> } & SchemaShared
 
-export type BrandSchema<T = string, U = unknown> = Readonly<
-  [category: T, subCategory: U]
->
+export type BrandSchema<T = string, U = unknown> = Readonly<[T, U]>
 
 export type SchemaShared = {
   /**

package/src/types/struct.ts

@@ -9,6 +9,8 @@ import type {
   TupleSchema,
   UnionSchema,
   //
+  BrandSchema,
+  //
   BooleanSchema,
   LiteralSchema,
   NumberSchema,
@@ -23,10 +25,18 @@ export type Struct<T extends Schema> = Omit<
       optional: () => Struct<T & { optional: true }>
       nullable: () => Struct<T & { nullable: true }>
 
-      brand: <V extends string, W extends string>(
-        key: V,
-        value: W
-      ) => Struct<T & { brand: Readonly<[V, W]> }>
+      brand: <
+        U extends string,
+        V extends
+          | boolean
+          | number
+          | string
+          | ReadonlyArray<unknown>
+          | Record<string, unknown>,
+      >(
+        key: U,
+        value: V
+      ) => Struct<T & { brand: BrandSchema<U, V> }>
 
       minLength: <U extends number>(
         minLength: U