Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Added function parameters definition in schema when using typeOf keyword #504

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Added function parameters definition in schema when using typeOf keyword #504

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5530873
Added parameters field to definition interface
Tiberiu02 Oct 10, 2022
e90789e
Added function type definition
Tiberiu02 Oct 10, 2022
deb118c
Removed old func type defs
Tiberiu02 Oct 10, 2022
056ae68
Added test for typeOfKeyword argument
Tiberiu02 Oct 10, 2022
8616b1c
fixed errors
Tiberiu02 Oct 10, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 23 additions & 22 deletions typescript-json-schema.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,7 @@ export interface Definition extends Omit<JSONSchema7, RedefinedFields> {
propertyOrder?: string[];
defaultProperties?: string[];
typeof?: "function";
parameters?: Definition[];

// Fields that must be redefined because they make use of this definition itself
items?: DefinitionOrBoolean | DefinitionOrBoolean[];
Expand Down Expand Up @@ -552,16 +553,16 @@ export class JsonSchemaGenerator {
if (comments.length) {
definition.description = comments
.map((comment) => {
const newlineNormalizedComment = comment.text.replace(/\r\n/g, "\n");
const newlineNormalizedComment = comment.text.replace(/\r\n/g, "\n");

// If a comment contains a "{@link XYZ}" inline tag that could not be
// resolved by the TS checker, then this comment will contain a trailing
// whitespace that we need to remove.
if (comment.kind === "linkText") {
return newlineNormalizedComment.trim();
}
// If a comment contains a "{@link XYZ}" inline tag that could not be
// resolved by the TS checker, then this comment will contain a trailing
// whitespace that we need to remove.
if (comment.kind === "linkText") {
return newlineNormalizedComment.trim();
}

return newlineNormalizedComment;
return newlineNormalizedComment;
})
.join("").trim();
}
Expand Down Expand Up @@ -1002,6 +1003,18 @@ export class JsonSchemaGenerator {
return definition;
}

private getFunctionDefinition(funcType: ts.Type, definition: Definition): Definition {
const node = funcType.getSymbol()!.getDeclarations()![0];

const parameters = (node as ts.FunctionLikeDeclaration).parameters;
definition.typeof = "function";
definition.parameters = parameters
.map((p) => this.tc.getTypeAtLocation(p.type!))
.map((type) => this.getTypeDefinition(type));

return definition;
}

private getClassDefinition(clazzType: ts.Type, definition: Definition): Definition {
const node = clazzType.getSymbol()!.getDeclarations()![0];

Expand All @@ -1011,11 +1024,6 @@ export class JsonSchemaGenerator {
return definition;
}

if (this.args.typeOfKeyword && node.kind === ts.SyntaxKind.FunctionType) {
definition.typeof = "function";
return definition;
}

const clazz = <ts.ClassDeclaration>node;
const props = this.tc.getPropertiesOfType(clazzType).filter((prop) => {
// filter never
Expand Down Expand Up @@ -1195,15 +1203,6 @@ export class JsonSchemaGenerator {
reffedType = undefined;
}

if (
this.args.typeOfKeyword &&
typ.flags & ts.TypeFlags.Object &&
(<ts.ObjectType>typ).objectFlags & ts.ObjectFlags.Anonymous
) {
definition.typeof = "function";
return definition;
}

let returnedDefinition = definition; // returned definition, may be a $ref

// Parse property comments now to skip recursive if ignore.
Expand Down Expand Up @@ -1374,6 +1373,8 @@ export class JsonSchemaGenerator {
// {} is TypeLiteral with no members. Need special case because it doesn't have declarations.
definition.type = "object";
definition.properties = {};
} else if (this.args.typeOfKeyword && node && ts.isFunctionLike(node)) {
this.getFunctionDefinition(typ, definition);
} else {
this.getClassDefinition(typ, definition);
}
Expand Down