refactor: extract string keys utility and optimize omit type handler #10
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,17 +1,12 @@ | ||
| import { TypeOperatorBaseHandler } from '@daxserver/validation-schema-codegen/handlers/typebox/type-operator-base-handler' | ||
| import { makeTypeCall } from '@daxserver/validation-schema-codegen/utils/typebox-codegen-utils' | ||
| import { SyntaxKind, ts } from 'ts-morph' | ||
|
|
||
| export class KeyOfTypeHandler extends TypeOperatorBaseHandler { | ||
| protected readonly operatorKind = SyntaxKind.KeyOfKeyword | ||
| protected readonly typeBoxMethod = 'KeyOf' | ||
|
|
||
| protected createTypeBoxCall(innerType: ts.Expression): ts.Expression { | ||
| return makeTypeCall('KeyOf', [innerType]) | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,18 +1,12 @@ | ||
| import { TypeOperatorBaseHandler } from '@daxserver/validation-schema-codegen/handlers/typebox/type-operator-base-handler' | ||
| import { makeTypeCall } from '@daxserver/validation-schema-codegen/utils/typebox-codegen-utils' | ||
| import { SyntaxKind, ts } from 'ts-morph' | ||
|
|
||
| export class ReadonlyTypeHandler extends TypeOperatorBaseHandler { | ||
| protected readonly operatorKind = SyntaxKind.ReadonlyKeyword | ||
| protected readonly typeBoxMethod = 'Readonly' | ||
|
|
||
| protected createTypeBoxCall(innerType: ts.Expression): ts.Expression { | ||
| return makeTypeCall('Readonly', [innerType]) | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,20 +1,23 @@ | ||
| import { BaseTypeHandler } from '@daxserver/validation-schema-codegen/handlers/typebox/base-type-handler' | ||
| import { isAnySyntaxKind } from '@daxserver/validation-schema-codegen/utils/node-type-utils' | ||
| import { makeTypeCall } from '@daxserver/validation-schema-codegen/utils/typebox-codegen-utils' | ||
| import { Node, SyntaxKind, ts } from 'ts-morph' | ||
|
|
||
| export const TypeBoxType = 'Type' | ||
|
|
||
| const SimpleKinds = [ | ||
| SyntaxKind.AnyKeyword, | ||
| SyntaxKind.BooleanKeyword, | ||
| SyntaxKind.NeverKeyword, | ||
| SyntaxKind.NullKeyword, | ||
| SyntaxKind.NumberKeyword, | ||
| SyntaxKind.StringKeyword, | ||
| SyntaxKind.UnknownKeyword, | ||
| SyntaxKind.VoidKeyword, | ||
| ] as const | ||
| type SimpleKind = (typeof SimpleKinds)[number] | ||
|
|
||
| const kindToTypeBox: Record<SimpleKind, string> = { | ||
| [SyntaxKind.AnyKeyword]: 'Any', | ||
| [SyntaxKind.BooleanKeyword]: 'Boolean', | ||
| [SyntaxKind.NeverKeyword]: 'Never', | ||
|
|
@@ -27,10 +30,10 @@ const kindToTypeBox: Record<SimpleKinds, string> = { | |
|
|
||
| export class SimpleTypeHandler extends BaseTypeHandler { | ||
| canHandle(node: Node): boolean { | ||
| return isAnySyntaxKind(node, SimpleKinds) | ||
| } | ||
|
|
||
| handle(node: Node): ts.Expression { | ||
| return makeTypeCall(kindToTypeBox[node.getKind() as SimpleKind]) | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| import { BaseTypeHandler } from '@daxserver/validation-schema-codegen/handlers/typebox/base-type-handler' | ||
| import { isTypeOperatorWithOperator } from '@daxserver/validation-schema-codegen/utils/node-type-utils' | ||
| import { getTypeBoxType } from '@daxserver/validation-schema-codegen/utils/typebox-call' | ||
| import { Node, SyntaxKind, ts, TypeOperatorTypeNode } from 'ts-morph' | ||
|
|
||
| /** | ||
| * Base class for TypeOperator handlers (KeyOf, Readonly, etc.) | ||
| * Provides common functionality for handling TypeOperatorTypeNode | ||
| */ | ||
| export abstract class TypeOperatorBaseHandler extends BaseTypeHandler { | ||
| protected abstract readonly operatorKind: SyntaxKind | ||
| protected abstract readonly typeBoxMethod: string | ||
|
|
||
| canHandle(node: Node): boolean { | ||
| return isTypeOperatorWithOperator(node, this.operatorKind) | ||
| } | ||
|
|
||
| handle(node: TypeOperatorTypeNode): ts.Expression { | ||
| const innerType = node.getTypeNode() | ||
| const typeboxInnerType = getTypeBoxType(innerType) | ||
| return this.createTypeBoxCall(typeboxInnerType) | ||
| } | ||
|
Comment on lines
+18
to
+22
There was a problem hiding this comment. 💡 Verification agent 🧩 Analysis chainConfirm override compatibility of handle(...) with BaseTypeHandler. This class overrides handle(node: TypeOperatorTypeNode), which is narrower than a common BaseTypeHandler signature of handle(node: Node). If BaseTypeHandler indeed declares handle(node: Node), this override will not be type-compatible in TS. If so, change the signature to Node and narrow inside. Run: If BaseTypeHandler expects Node, consider: - handle(node: TypeOperatorTypeNode): ts.Expression {
- const innerType = node.getTypeNode()
+ handle(node: Node): ts.Expression {
+ // canHandle() guarantees TypeOperatorTypeNode; assert to satisfy typing
+ const opNode = node as TypeOperatorTypeNode
+ const innerType = opNode.getTypeNode()
const typeboxInnerType = getTypeBoxType(innerType)
return this.createTypeBoxCall(typeboxInnerType)
}🏁 Script executed: #!/usr/bin/env bash
# Inspect BaseTypeHandler.handle signature and all overrides.
rg -nP --type=ts -C3 'class\s+BaseTypeHandler\b'
rg -nP --type=ts -C2 'abstract\s+handle\s*\(\s*node\s*:\s*Node'
rg -nP --type=ts -C2 'handle\s*\(\s*node\s*:\s*TypeOperatorTypeNode'Length of output: 1772 Ensure The base class declares abstract handle(node: Node): ts.Expressionbut here you’ve overridden it with a narrower parameter type ( - handle(node: TypeOperatorTypeNode): ts.Expression {
- const innerType = node.getTypeNode()
+ handle(node: Node): ts.Expression {
+ // `canHandle` already ensures this is a TypeOperatorTypeNode
+ const opNode = node as TypeOperatorTypeNode
+ const innerType = opNode.getTypeNode()
const typeboxInnerType = getTypeBoxType(innerType)
return this.createTypeBoxCall(typeboxInnerType)
}• File needing update: 🤖 Prompt for AI Agents |
||
|
|
||
| protected abstract createTypeBoxCall(innerType: ts.Expression): ts.Expression | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| import { makeTypeCall } from '@daxserver/validation-schema-codegen/utils/typebox-codegen-utils' | ||
| import { Node, ts } from 'ts-morph' | ||
|
|
||
| /** | ||
| * Extracts string keys from a TypeScript type node (typically used for Pick/Omit key types) | ||
| * Handles both single literal types and union types containing string literals | ||
| */ | ||
| export const extractStringKeys = (keysType: Node): string[] => { | ||
| const keys: string[] = [] | ||
|
|
||
| if (Node.isUnionTypeNode(keysType)) { | ||
| for (const unionType of keysType.getTypeNodes()) { | ||
| if (Node.isLiteralTypeNode(unionType)) { | ||
| const literalExpression = unionType.getLiteral() | ||
| if (Node.isStringLiteral(literalExpression)) { | ||
| keys.push(literalExpression.getLiteralText()) | ||
| } | ||
| } | ||
| } | ||
| } else if (Node.isLiteralTypeNode(keysType)) { | ||
| const literalExpression = keysType.getLiteral() | ||
| if (Node.isStringLiteral(literalExpression)) { | ||
| keys.push(literalExpression.getLiteralText()) | ||
| } | ||
| } | ||
|
|
||
| return keys | ||
| } | ||
|
|
||
| /** | ||
| * Converts an array of string keys into a TypeBox expression | ||
| * Returns a single Literal for one key, or a Union of Literals for multiple keys | ||
| */ | ||
| export const createTypeBoxKeys = (keys: string[]): ts.Expression => { | ||
| if (keys.length === 1) { | ||
| return makeTypeCall('Literal', [ts.factory.createStringLiteral(keys[0]!)]) | ||
| } | ||
|
|
||
| return makeTypeCall('Union', [ | ||
| ts.factory.createArrayLiteralExpression( | ||
| keys.map((k) => makeTypeCall('Literal', [ts.factory.createStringLiteral(k)])), | ||
| false, | ||
| ), | ||
| ]) | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| import { Node, SyntaxKind, TypeReferenceNode } from 'ts-morph' | ||
|
|
||
| /** | ||
| * Utility functions for common Node type checks used in canHandle methods | ||
| */ | ||
|
|
||
| /** | ||
| * Checks if a node is a specific SyntaxKind | ||
| */ | ||
| export const isSyntaxKind = (node: Node, kind: SyntaxKind): boolean => { | ||
| return node.getKind() === kind | ||
| } | ||
|
|
||
| /** | ||
| * Checks if a node is any of the specified SyntaxKinds | ||
| */ | ||
| export const isAnySyntaxKind = (node: Node, kinds: readonly SyntaxKind[]): boolean => { | ||
| return kinds.includes(node.getKind()) | ||
| } | ||
|
|
||
| /** | ||
| * Checks if a node is a TypeOperatorTypeNode with a specific operator | ||
| */ | ||
| export const isTypeOperatorWithOperator = (node: Node, operator: SyntaxKind): boolean => { | ||
| return Node.isTypeOperatorTypeNode(node) && node.getOperator() === operator | ||
| } | ||
|
|
||
| /** | ||
| * Checks if a node is a TypeReference with a specific type name | ||
| */ | ||
| export const isTypeReferenceWithName = (node: Node, typeName: string): boolean => { | ||
| if (!Node.isTypeReference(node)) { | ||
| return false | ||
| } | ||
|
|
||
| const typeRefNode = node as TypeReferenceNode | ||
| const typeNameNode = typeRefNode.getTypeName() | ||
|
|
||
| return Node.isIdentifier(typeNameNode) && typeNameNode.getText() === typeName | ||
| } | ||
|
|
||
| /** | ||
| * Checks if a node is a TypeReference with any of the specified type names | ||
| */ | ||
| export const isTypeReferenceWithAnyName = (node: Node, typeNames: string[]): boolean => { | ||
| if (!Node.isTypeReference(node)) { | ||
| return false | ||
| } | ||
|
|
||
| const typeRefNode = node as TypeReferenceNode | ||
| const typeNameNode = typeRefNode.getTypeName() | ||
|
|
||
| return Node.isIdentifier(typeNameNode) && typeNames.includes(typeNameNode.getText()) | ||
| } | ||
|
|
||
| /** | ||
| * Utility type operators | ||
| */ | ||
| export const UTILITY_TYPE_NAMES = [ | ||
| 'Partial', | ||
| 'Required', | ||
| 'Readonly', | ||
| 'Pick', | ||
| 'Omit', | ||
| 'Exclude', | ||
| 'Extract', | ||
| 'NonNullable', | ||
| 'ReturnType', | ||
| 'InstanceType', | ||
| ] as const |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
💡 Verification agent
🧩 Analysis chain
Fix empty/partial key extraction: avoid Type.Union([]) and lossy omission.
If keysType isn’t a pure union of string literals (e.g., keyof T, or a mixed union), extractStringKeys returns [] or a partial list. Passing that to createTypeBoxKeys builds an invalid union and/or drops members, changing semantics.
Apply a safe fallback to getTypeBoxType(keysType) unless the union is fully string-literal:
Please mirror the same logic in PickTypeHandler for consistency. I can submit the corresponding change if helpful.
🏁 Script executed:
Length of output: 27174
🏁 Script executed:
Length of output: 1546
🏁 Script executed:
Length of output: 1147
🏁 Script executed:
Length of output: 1147
Prevent invalid key unions in Omit & Pick handlers
Both OmitTypeHandler and PickTypeHandler always call
but extractStringKeys only returns the full set of string literals when keysType is literally a union of string literals or a single literal. For any other expression—
keyof T,T extends U ? …, mixed unions—extractStringKeysreturns[](or a subset), leading toType.Union([])or dropped members and a semantic mismatch.You should guard against this by falling back to the raw keysType via getTypeBoxType(keysType) unless:
keysTypeis a literal or a union of only string-literal type nodes, andextractStringKeysreturned at least one key.Please apply the same fix in both handlers:
• src/handlers/typebox/reference/omit-type-handler.ts (in handle):
• src/handlers/typebox/reference/pick-type-handler.ts (in handle):
This ensures that whenever we can’t reliably extract every literal key, we let TypeBox handle the original keysType expression instead of generating an empty or lossy union.
🤖 Prompt for AI Agents