zoriya/typebox
1
0
Fork 0
mirror of https://github.com/zoriya/typebox.git synced 2025-12-06 06:46:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

Revision 0.33.2 (#947)

Browse Source 
* Retain Interior Properties on Pick, Omit and Mapped Types

* Version
This commit is contained in:
sinclairzx81
2024-08-09 17:59:50 +09:00
committed by GitHub
parent b00293ee1c
commit c4894642d2
7 changed files with 81 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
package-lock.json generated
View File

@@ -1,12 +1,12 @@
{
"name": "@sinclair/typebox",
"version": "0.33.1",
"version": "0.33.2",
"lockfileVersion": 2,
"requires": true,
"packages": {
"": {
"name": "@sinclair/typebox",
"version": "0.33.1",
"version": "0.33.2",
"license": "MIT",
"devDependencies": {
"@arethetypeswrong/cli": "^0.13.2",

2
package.json
View File

@@ -1,6 +1,6 @@
{
"name": "@sinclair/typebox",
"version": "0.33.1",
"version": "0.33.2",
"description": "Json Schema Type Builder with Static Type Resolution for TypeScript",
"keywords": [
"typescript",

22
src/type/mapped/mapped.ts
View File

@@ -205,6 +205,8 @@ type FromSchemaType<K extends PropertyKey, T extends TSchema> = (
)
// prettier-ignore
function FromSchemaType<K extends PropertyKey, T extends TSchema>(K: K, T: T): FromSchemaType<K, T> {
// required to retain user defined options for mapped type
const options = { ...T }
return (
// unevaluated modifier types
IsOptional(T) ? Optional(FromSchemaType(K, Discard(T, [OptionalKind]) as TSchema)) :
@@ -213,16 +215,16 @@ function FromSchemaType<K extends PropertyKey, T extends TSchema>(K: K, T: T): F
IsMappedResult(T) ? FromMappedResult(K, T.properties) :
IsMappedKey(T) ? FromMappedKey(K, T.keys) :
// unevaluated types
IsConstructor(T) ? Constructor(FromRest(K, T.parameters), FromSchemaType(K, T.returns)) :
IsFunction(T) ? FunctionType(FromRest(K, T.parameters), FromSchemaType(K, T.returns)) :
IsAsyncIterator(T) ? AsyncIterator(FromSchemaType(K, T.items)) :
IsIterator(T) ? Iterator(FromSchemaType(K, T.items)) :
IsIntersect(T) ? Intersect(FromRest(K, T.allOf)) :
IsUnion(T) ? Union(FromRest(K, T.anyOf)) :
IsTuple(T) ? Tuple(FromRest(K, T.items ?? [])) :
IsObject(T) ? Object(FromProperties(K, T.properties)) :
IsArray(T) ? Array(FromSchemaType(K, T.items)) :
IsPromise(T) ? Promise(FromSchemaType(K, T.item)) :
IsConstructor(T) ? Constructor(FromRest(K, T.parameters), FromSchemaType(K, T.returns), options) :
IsFunction(T) ? FunctionType(FromRest(K, T.parameters), FromSchemaType(K, T.returns), options) :
IsAsyncIterator(T) ? AsyncIterator(FromSchemaType(K, T.items), options) :
IsIterator(T) ? Iterator(FromSchemaType(K, T.items), options) :
IsIntersect(T) ? Intersect(FromRest(K, T.allOf), options) :
IsUnion(T) ? Union(FromRest(K, T.anyOf), options) :
IsTuple(T) ? Tuple(FromRest(K, T.items ?? []), options) :
IsObject(T) ? Object(FromProperties(K, T.properties), options) :
IsArray(T) ? Array(FromSchemaType(K, T.items), options) :
IsPromise(T) ? Promise(FromSchemaType(K, T.item), options) :
T
) as never
}

6
src/type/omit/omit.ts
View File

@@ -93,7 +93,7 @@ function OmitResolve<T extends TSchema, K extends PropertyKey[]>(T: T, K: [...K]
return (
IsIntersect(T) ? Intersect(FromIntersect(T.allOf, K)) :
IsUnion(T) ? Union(FromUnion(T.anyOf, K)) :
IsObject(T) ? Object(FromProperties(T.properties, K)) :
IsObject(T) ? Object(FromProperties(T.properties, K), Discard(T, [TransformKind, '$id', 'required'])) :
Object({})
) as never
}
@@ -121,7 +121,5 @@ export function Omit(T: TSchema, K: any, options?: SchemaOptions): any {
if (IsMappedResult(T)) return OmitFromMappedResult(T, K, options)
// non-mapped
const I = IsSchema(K) ? IndexPropertyKeys(K) : (K as string[])
const D = Discard(T, [TransformKind, '$id', 'required']) as TSchema
const R = OmitResolve(T, I)
return CreateType({ ...D, ...R }, options)
return CreateType(OmitResolve(T, I), options)
}

6
src/type/pick/pick.ts
View File

@@ -86,7 +86,7 @@ function PickResolve<T extends TSchema, K extends PropertyKey[]>(T: T, K: [...K]
return (
IsIntersect(T) ? Intersect(FromIntersect(T.allOf, K)) :
IsUnion(T) ? Union(FromUnion(T.anyOf, K)) :
IsObject(T) ? Object(FromProperties(T.properties, K)) :
IsObject(T) ? Object(FromProperties(T.properties, K), Discard(T, [TransformKind, '$id', 'required'])) :
Object({})
) as never
}
@@ -112,7 +112,5 @@ export function Pick(T: TSchema, K: any, options?: SchemaOptions): any {
if (IsMappedResult(T)) return PickFromMappedResult(T, K, options)
// non-mapped
const I = IsSchema(K) ? IndexPropertyKeys(K) : (K as string[])
const D = Discard(T, [TransformKind, '$id', 'required']) as TSchema
const R = PickResolve(T, I)
return CreateType({ ...D, ...R }, options)
return CreateType(PickResolve(T, I), options)
}

31
test/runtime/type/guard/type/omit.ts
View File

@@ -126,4 +126,35 @@ describe('guard/type/TOmit', () => {
const R = Type.Omit(S, ['x'])
Assert.IsFalse(TransformKind in R)
})
// ----------------------------------------------------------------
// https://github.com/sinclairzx81/typebox/issues/944
// ----------------------------------------------------------------
it('Should retain interior properties 1', () => {
const A = Type.Object({ x: Type.Number() }, { additionalProperties: false })
const T = Type.Omit(A, ['x'])
Assert.IsFalse(T.additionalProperties as boolean)
})
it('Should retain interior properties 2', () => {
const A = Type.Object({ x: Type.Number() }, { additionalProperties: false })
const B = Type.Object({ y: Type.Number() }, { additionalProperties: false })
const U = Type.Union([A, B])
const T = Type.Omit(U, ['x'])
Assert.IsFalse(T.anyOf[0].additionalProperties as boolean)
Assert.IsFalse(T.anyOf[1].additionalProperties as boolean)
})
it('Should retain interior properties 3', () => {
const A = Type.Object({ x: Type.Number() }, { additionalProperties: false })
const B = Type.Object({ y: Type.Number() }, { additionalProperties: false })
const U = Type.Intersect([A, B])
const T = Type.Omit(U, ['x'])
Assert.IsFalse(T.allOf[0].additionalProperties as boolean)
Assert.IsFalse(T.allOf[1].additionalProperties as boolean)
})
it('Should retain interior properties 4', () => {
const A = Type.Object({ x: Type.Number(), y: Type.Number() }, { additionalProperties: false })
const T = Type.Mapped(Type.TemplateLiteral('${x|y|z}'), (_) => Type.Omit(A, ['x']))
Assert.IsFalse(T.properties.x.additionalProperties as boolean)
Assert.IsFalse(T.properties.y.additionalProperties as boolean)
Assert.IsFalse(T.properties.z.additionalProperties as boolean)
})
})

31
test/runtime/type/guard/type/pick.ts
View File

@@ -128,4 +128,35 @@ describe('guard/type/TPick', () => {
const R = Type.Pick(S, ['x'])
Assert.IsFalse(TransformKind in R)
})
// ----------------------------------------------------------------
// https://github.com/sinclairzx81/typebox/issues/944
// ----------------------------------------------------------------
it('Should retain interior properties 1', () => {
const A = Type.Object({ x: Type.Number() }, { additionalProperties: false })
const T = Type.Pick(A, ['x'])
Assert.IsFalse(T.additionalProperties as boolean)
})
it('Should retain interior properties 2', () => {
const A = Type.Object({ x: Type.Number() }, { additionalProperties: false })
const B = Type.Object({ y: Type.Number() }, { additionalProperties: false })
const U = Type.Union([A, B])
const T = Type.Pick(U, ['x'])
Assert.IsFalse(T.anyOf[0].additionalProperties as boolean)
Assert.IsFalse(T.anyOf[1].additionalProperties as boolean)
})
it('Should retain interior properties 3', () => {
const A = Type.Object({ x: Type.Number() }, { additionalProperties: false })
const B = Type.Object({ y: Type.Number() }, { additionalProperties: false })
const U = Type.Intersect([A, B])
const T = Type.Pick(U, ['x'])
Assert.IsFalse(T.allOf[0].additionalProperties as boolean)
Assert.IsFalse(T.allOf[1].additionalProperties as boolean)
})
it('Should retain interior properties 4', () => {
const A = Type.Object({ x: Type.Number(), y: Type.Number() }, { additionalProperties: false })
const T = Type.Mapped(Type.TemplateLiteral('${x|y|z}'), (_) => Type.Pick(A, ['x']))
Assert.IsFalse(T.properties.x.additionalProperties as boolean)
Assert.IsFalse(T.properties.y.additionalProperties as boolean)
Assert.IsFalse(T.properties.z.additionalProperties as boolean)
})
})