schematox 1.2.0 → 1.2.2-alpha

package/src/tests/utils.test.ts

@@ -0,0 +1,191 @@
+import * as x from '../'
+
+describe('Type equivalence check by `tCh` utility', () => {
+  describe('Union of literals', () => {
+    it('valid', () => {
+      type Expected = 'x' | 'y'
+      type Actual = 'x' | 'y'
+
+      x.tCh<Expected, Actual>()
+      x.tCh<Actual, Expected>()
+    })
+
+    it('union has extra member', () => {
+      type Expected = 'x' | 'y'
+      type Actual = 'x' | 'y' | 'z'
+
+      // @ts-expect-error: '"z"' is not assignable to type 'Expected'
+      x.tCh<Expected, Actual>()
+      x.tCh<Actual, Expected>()
+    })
+
+    it('union has `never` instead of expected member', () => {
+      type Expected = 'x' | 'y'
+      type Actual = 'x' | never
+
+      x.tCh<Expected, Actual>()
+      // @ts-expect-error: 'Expected' does not satisfy the constraint '"x"'
+      x.tCh<Actual, Expected>()
+    })
+
+    it('union is `never`', () => {
+      type Expected = 'x' | 'y'
+      type Actual = never
+
+      x.tCh<Expected, Actual>()
+      // @ts-expect-error: Type 'string' does not satisfy the constraint 'never'.
+      x.tCh<Actual, Expected>()
+    })
+  })
+
+  describe('Array of primitives', () => {
+    it('valid', () => {
+      type Expected = Array<string | number>
+      type Actual = Array<string | number>
+
+      x.tCh<Expected, Actual>()
+      x.tCh<Actual, Expected>()
+    })
+
+    it('array union has one extra member', () => {
+      type Expected = Array<string | number>
+      type Actual = Array<string | number | boolean>
+
+      // @ts-expect-error: 'string | number | boolean' is not assignable to type 'string | number'
+      x.tCh<Expected, Actual>()
+      x.tCh<Actual, Expected>()
+    })
+
+    it('array union has `never` instead of expected memeber', () => {
+      type Expected = Array<string | number>
+      type Actual = Array<string | never>
+
+      x.tCh<Expected, Actual>()
+      // @ts-expect-error: 'Expected' does not satisfy the constraint 'string[]'
+      x.tCh<Actual, Expected>()
+    })
+
+    it('array of `never`', () => {
+      type Expected = Array<string | number>
+      type Actual = Array<never>
+
+      x.tCh<Expected, Actual>()
+      // @ts-expect-error: 'Expected' does not satisfy the constraint 'never[]'
+      x.tCh<Actual, Expected>()
+    })
+
+    it('array is `never`', () => {
+      type Expected = Array<string | number>
+      type Actual = never
+
+      x.tCh<Expected, Actual>()
+      // @ts-expect-error: Type 'Expected' does not satisfy the constraint 'never'
+      x.tCh<Actual, Expected>()
+    })
+  })
+
+  describe('Object of primitives', () => {
+    it('valid', () => {
+      type Expected = { x: string; y: number }
+      type Actual = { x: string; y: number }
+
+      x.tCh<Expected, Actual>()
+      x.tCh<Actual, Expected>()
+    })
+
+    it('has extra property', () => {
+      type Expected = { x: string; y: number }
+      type Actual = { x: string; y: number; z: boolean }
+
+      x.tCh<Expected, Actual>()
+      // @ts-expect-error: Property 'z' is missing in type 'Expected' but required in type 'Actual'
+      x.tCh<Actual, Expected>()
+    })
+
+    it('one property has `never` value', () => {
+      type Expected = { x: string; y: number }
+      type Actual = { x: string; y: never }
+
+      x.tCh<Expected, Actual>()
+      // @ts-expect-error Types of property 'y' are incompatible.    Type 'number' is not assignable to type 'never'.
+      x.tCh<Actual, Expected>()
+    })
+
+    it('all properties have `never` value', () => {
+      type Expected = { x: string; y: number }
+      type Actual = { x: never; y: never }
+
+      x.tCh<Expected, Actual>()
+      // @ts-expect-error 'Expected' does not satisfy the constraint 'Actual'
+      x.tCh<Actual, Expected>()
+    })
+  })
+})
+
+describe('Check ParseResult utilities', () => {
+  it('ParseResult typguards are functional', () => {
+    const parsed = x.boolean().parse(undefined)
+
+    if (parsed.success) {
+      x.tCh<typeof parsed.data, boolean>()
+      x.tCh<boolean, typeof parsed.data>()
+
+      x.tCh<typeof parsed.error, undefined>()
+      x.tCh<undefined, typeof parsed.error>()
+    }
+
+    if (parsed.data !== undefined) {
+      x.tCh<typeof parsed.data, boolean>()
+      x.tCh<boolean, typeof parsed.data>()
+
+      x.tCh<typeof parsed.error, undefined>()
+      x.tCh<undefined, typeof parsed.error>()
+    }
+
+    if (parsed.success === false) {
+      x.tCh<typeof parsed.error, x.InvalidSubject[]>()
+      x.tCh<x.InvalidSubject[], typeof parsed.error>()
+
+      x.tCh<typeof parsed.data, undefined>()
+      x.tCh<undefined, typeof parsed.data>()
+    }
+
+    if (parsed.error) {
+      x.tCh<typeof parsed.error, x.InvalidSubject[]>()
+      x.tCh<x.InvalidSubject[], typeof parsed.error>()
+
+      x.tCh<typeof parsed.data, undefined>()
+      x.tCh<undefined, typeof parsed.data>()
+    }
+  })
+
+  it('ParseError result', () => {
+    const invalidSubjects: x.InvalidSubject[] = [
+      {
+        code: x.ERROR_CODE.invalidType,
+        path: [],
+        schema: { type: 'string' },
+        subject: undefined,
+      },
+    ]
+
+    const parseError = x.error(invalidSubjects)
+
+    expect('data' in parseError).toBe(false)
+    expect(parseError.success).toBe(false)
+    expect(parseError.error === invalidSubjects).toBe(true)
+  })
+
+  it('ParseSuccess result', () => {
+    const validSubj = 'sample'
+    const parsedSuccess = x.success(validSubj)
+
+    expect('error' in parsedSuccess).toBe(false)
+    expect(parsedSuccess.success).toBe(true)
+    expect(parsedSuccess.data).toBe(validSubj)
+  })
+})
+
+it('PARAMS_BY_SCHEMA_TYPE is exported', () => {
+  expect(x.PARAMS_BY_SCHEMA_TYPE).toStrictEqual(x.PARAMS_BY_SCHEMA_TYPE)
+})

package/CHANGELOG.md

@@ -1,48 +0,0 @@
-# Changelog
-
-## [1.2.0](https://github.com/incerta/schematox/compare/v1.1.0...v1.2.0)
-
-- [Record schema range limiters support #48](https://github.com/incerta/schematox/pull/48)
-
-## [1.1.0](https://github.com/incerta/schematox/compare/v1.0.1...v1.1.0)
-
-- [Standard schema support #46](https://github.com/incerta/schematox/pull/46)
-
-## [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:
-
-- [RecordSchema support #34](https://github.com/incerta/schematox/pull/34)
-- [Drop validate/guard feature support #36](https://github.com/incerta/schematox/pull/36)
-- [Pre major release testing architecture and file structure refactoring #38](https://github.com/incerta/schematox/pull/38)
-- [Break down parse logic into smaller functions #39](https://github.com/incerta/schematox/pull/39)
-- [Support unrestricted object schema depth #42](https://github.com/incerta/schematox/pull/42)
-- [Support tuple schema #43](https://github.com/incerta/schematox/pull/43)
-
-## [0.4.0](https://github.com/incerta/schematox/compare/v0.3.1...v0.4.0)
-
-- [`aa0d95e`](https://github.com/incerta/schematox/commit/aa0d95e30b7784c0ce29317ae808e4ba7950abab) Extend compound structure nesting limit to 12 layers of depth
-
-## [0.3.1](https://github.com/incerta/schematox/compare/v0.3.0...v0.3.1)
-
-### Bugfix
-
-- [`e3527df`](https://github.com/incerta/schematox/commit/e3527dfb46b73a4b6579e3d2aea58f3301aded9a) [#24](https://github.com/incerta/schematox/pull/25) Parser should preserve object optional key only if it is specified in source
-
-### Chore
-
-- [`7d98a81`](https://github.com/incerta/schematox/commit/7d98a81c2bc18280299365da32f8346d5b145560) Use "es2015" tsconfig target instead of outdated "es5"
-
-### Features
-
-- [`8bc2082`](https://github.com/incerta/schematox/commit/8bc208211457901f4f7246f00694f112d56f8d56) [#22](https://github.com/incerta/schematox/issues/22) Ensure optional properties in schemas reflect as optional in object context (@incerta)
-
-## [0.3.0](https://github.com/incerta/schematox/compare/v0.2.0...v0.3.0)
-
-### Features
-
-- [`8bc2082`](https://github.com/incerta/schematox/commit/8bc208211457901f4f7246f00694f112d56f8d56) [#22](https://github.com/incerta/schematox/issues/22) Ensure optional properties in schemas reflect as optional in object context (@incerta)