fix: brandedSchema signature

Signed-off-by: Andres Correa Casablanca <[email protected]>

Author: castarco

.github/workflows/tests.yml

@@ -56,4 +56,4 @@ jobs:
       run: "pnpm turbo test"
     - name: "(All) Run All Tasks"
       if: ${{ matrix.os != 'windows-latest' }}
-      run: "pnpm turbo all"
+      run: "pnpm turbo all:cov"

.hooks/pre-push

@@ -3,4 +3,4 @@
 set -eu
 set -o pipefail
 
-pnpm turbo all
+pnpm turbo all:cov

@coderspirit/lambda-ioc/package.json

@@ -36,6 +36,7 @@
 	"devDependencies": {
 		"@arethetypeswrong/cli": "^0.15.4",
 		"@biomejs/biome": "1.8.3",
+		"@vitest/coverage-v8": "^2.0.5",
 		"get-tsconfig": "^4.7.6",
 		"publint": "^0.2.9",
 		"rollup": "^4.20.0",

@coderspirit/lambda-ioc/src/tests/main.test.ts renamed to @coderspirit/lambda-ioc/src/tests/main.test.mts

@@ -1,5 +1,19 @@
 import { defineConfig } from 'vitest/config'
 
 export default defineConfig({
-	test: {},
+	test: {
+		coverage: {
+			provider: 'v8',
+			include: ['src/**/*.mjs', 'src/**/*.mts'],
+			exclude: ['src/**/tests/**/*', 'coverage/**/*'],
+			thresholds: {
+				statements: 92.0,
+				branches: 90.0,
+				functions: 100.0,
+				lines: 92.0,
+			},
+			reportsDirectory: 'coverage',
+		},
+		include: ['src/**/tests/**/*.test.mts'],
+	},
 })

@coderspirit/lambda-ioc/vitest.config.mts

@@ -148,3 +148,45 @@ const unionSchema = brandedUnion(
 	[Literal('on'), Literal('off')]
 )
 ```
+
+### Fallback alternative
+
+In case this library does not provide a specific schema factory for your type,
+you can rely on `brandedSchema`. Notice that if you are using it for complex
+schemas, it can loose some branding information from inner/nested properties.
+
+```typescript
+import type { FastBrand } from '@coderspirit/nominal'
+import {
+	brandedInteger,
+	brandedSchema,
+	brandedString,
+} from '@coderspirit/nominal-typebox'
+import { Record as TBRecord } from '@sinclair/typebox'
+
+const personNameSchema = brandedString<'PersonName'>()
+const personAgeSchema = brandedInteger<'PersonAge'>()
+const recordSchema = brandedSchema('PeopleAges', TBRecord(
+	personNameSchema,
+	personAgeSchema,
+))
+const recordValidator = TypeCompiler.Compile(recordSchema)
+
+const requestRecord = getRequestFromSomewhere() // unknown
+if (!requestValidator.Check(requestRecord)) {
+	throw new Error('Invalid request!')
+}
+
+// OK
+const recordSink: FastBrand<Record<string, number>, 'PeopleAges'> =
+	requestRecord
+
+// @ts-expect-error Type Error!
+const corruptedRecordSink: FastBrand<
+	Record<string, number>, 'PeopleAges'
+> = { Alice: 20, Bob: 30 }
+
+// IMPORTANT!: Notice that `brandedSchema` is unable to preserve the
+//             brands of keys & values in the record. This limitation
+//             is due to the fact that `brandedSchema` is too generic.
+```

@coderspirit/nominal-typebox/README.md

@@ -30,6 +30,7 @@ export type BrandedSchema<B extends string, T extends TSchema> = Pick<
 }
 
 export const brandedSchema = <const B extends string, S extends TSchema>(
+	_b: B,
 	schema: S,
 ): BrandedSchema<B, S> => {
 	return schema as BrandedSchema<B, S>

@coderspirit/nominal-typebox/src/schema.mts

@@ -5,8 +5,7 @@ import type { TaggedInteger } from '@coderspirit/nominal-inputs'
 import { TypeCompiler } from '@sinclair/typebox/compiler'
 import { describe, expect, it } from 'vitest'
 
-import { brandedArray } from '../array.mts'
-import { brandedInteger } from '../number.mts'
+import { brandedArray, brandedInteger } from '../main.mts'
 
 describe('brandedArray', () => {
 	it('lets typebox to annotate arrays with a brand', () => {

@coderspirit/nominal-typebox/src/tests/array.test.mts

@@ -5,7 +5,7 @@ import type { TaggedInteger } from '@coderspirit/nominal-inputs'
 import { TypeCompiler } from '@sinclair/typebox/compiler'
 import { describe, expect, it } from 'vitest'
 
-import { brandedInteger, brandedNumber } from '../number.mts'
+import { brandedInteger, brandedNumber } from '../main.mts'
 
 describe('brandedInteger', () => {
 	it('lets typebox to annotate a number as an integer', () => {

@coderspirit/nominal-typebox/src/tests/number.test.mts

@@ -5,9 +5,7 @@ import type { TaggedInteger } from '@coderspirit/nominal-inputs'
 import { TypeCompiler } from '@sinclair/typebox/compiler'
 import { describe, expect, it } from 'vitest'
 
-import { brandedInteger } from '../number.mts'
-import { brandedObject } from '../object.mts'
-import { brandedString } from '../string.mts'
+import { brandedInteger, brandedObject, brandedString } from '../main.mts'
 
 describe('brandedObject', () => {
 	it('lets typebox to annotate objects with a brand', () => {