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

feat(map): Codegen for JsonSchema Target #63

Merged
merged 19 commits into from
Nov 16, 2023
Merged

feat(map): Codegen for JsonSchema Target #63

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
68642b4
feat(map): add map support for jsonschemavisitor
jonathan-casey Oct 12, 2023
aceec6e
test(map): test cases
jonathan-casey Oct 12, 2023
4646741
test(map): update snapshot
jonathan-casey Oct 12, 2023
b7a9f41
feat(map): add type defs
jonathan-casey Oct 12, 2023
9c54ae1
feat(map): remove redundant property from additionalProperties
jonathan-casey Oct 19, 2023
635ee29
feat(map): use getFieldOrScalarDeclarationValidatorsForSchema to get …
jonathan-casey Oct 19, 2023
5f2f7a6
feat(map): Codegen for GraphQL Target (#66)
jonathan-casey Oct 19, 2023
5116168
feat!(codegen): remove loopback src (#59)
jonathan-casey Oct 19, 2023
d93a3e0
chore(deps-dev): bump @babel/traverse from 7.22.11 to 7.23.2 (#67)
dependabot[bot] Oct 19, 2023
5e4707d
test(codegen) update HR model to use multiple namespaces (#68)
dselman Nov 2, 2023
d98f071
test(*): snapshot update
jonathan-casey Nov 6, 2023
7331418
feat(*): gets type from model file
jonathan-casey Nov 6, 2023
dff597b
Merge branch 'main' into jonathan/codegen_map_json_schema
jonathan-casey Nov 6, 2023
5f410ab
test(*): snapshot update
jonathan-casey Nov 6, 2023
a458152
feat(*): use scalar validator regex as pattern value
jonathan-casey Nov 6, 2023
1cf7c33
Merge branch 'main' into jonathan/codegen_map_json_schema
jonathan-casey Nov 6, 2023
d4e7b58
test(*): add regex to property
jonathan-casey Nov 10, 2023
2f5b920
test(*): update snapshot
jonathan-casey Nov 10, 2023
f184fe3
test(*): update jsdoc and typedef
jonathan-casey Nov 10, 2023
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
55 changes: 44 additions & 11 deletions lib/codegen/fromcto/jsonschema/jsonschemavisitor.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,16 +60,16 @@ class JSONSchemaVisitor {

/**
* Get the validators for a field or a scalar definition in JSON schema form.
* @param {Object} field - the scalar declaration being visited
* @param {String} type - the field type
* @param {bool} [isScalarUUID] - flag to indicate given field type is scalar uuid
* @param {bool} [validator] - the field validator
* @return {Object} the result of visiting or null
* @private
*/
getFieldOrScalarDeclarationValidatorsForSchema(field, isScalarUUID = false) {
const validator = field.getValidator();
getFieldOrScalarDeclarationValidatorsForSchema(type, isScalarUUID = false, validator) {
let jsonSchema = {};

switch (field.getType()) {
switch (type) {
jonathan-casey marked this conversation as resolved.
Show resolved Hide resolved
case 'String':
jsonSchema.type = 'string';
if (isScalarUUID) {
Expand Down Expand Up @@ -117,6 +117,8 @@ class JSONSchemaVisitor {
case 'Boolean':
jsonSchema.type = 'boolean';
break;
default:
jsonSchema.type = type;
}

return jsonSchema;
Expand Down Expand Up @@ -354,7 +356,7 @@ class JSONSchemaVisitor {
debug('entering visitScalarDeclaration', scalarDeclaration.getName());
return {
$id: scalarDeclaration.getFullyQualifiedName(),
schema: this.getFieldOrScalarDeclarationValidatorsForSchema(scalarDeclaration)
schema: this.getFieldOrScalarDeclarationValidatorsForSchema(scalarDeclaration.getType(), false, scalarDeclaration.getValidator())
};
}

Expand All @@ -381,11 +383,6 @@ class JSONSchemaVisitor {
visitField(field, parameters, isScalarUUID = false) {
debug('entering visitField', field.getName());


if (ModelUtil.isMap?.(field)) {
return;
}

// Is this a primitive typed property?
let jsonSchema;
if (field.isPrimitive()) {
Expand All @@ -398,7 +395,7 @@ class JSONSchemaVisitor {

jsonSchema = {
...jsonSchema,
...this.getFieldOrScalarDeclarationValidatorsForSchema(field, isScalarUUID)
...this.getFieldOrScalarDeclarationValidatorsForSchema(field.getType(), isScalarUUID, field.getValidator())
};

// If this field has a default value, add it.
Expand All @@ -411,6 +408,42 @@ class JSONSchemaVisitor {
jsonSchema.description = 'The instance identifier for this type';
}

} else if (ModelUtil.isMap?.(field)) {
const mapDeclaration = field.getParent().getModelFile().getModelManager().getType(field.getFullyQualifiedTypeName());

let mapKey = mapDeclaration.getModelFile().getType(mapDeclaration.getKey().getType());
let mapValue = mapDeclaration.getModelFile().getType(mapDeclaration.getValue().getType());

const jsonSchema = {
$id: field.getFullyQualifiedName(),
schema: {
title: mapDeclaration.getName(),
description : `An instance of ${field.getFullyQualifiedTypeName()}`,
type: 'object',
propertyNames: {
type: 'string'
},
additionalProperties: {
type: this.getFieldOrScalarDeclarationValidatorsForSchema(mapDeclaration.getValue().getType()).type
}
}
};

if (mapKey.isScalarDeclaration?.() && mapKey.getValidator()?.getRegex()) {
jsonSchema.schema.propertyNames.pattern = String(mapKey.getValidator().getRegex());
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If we add support for regex validators for scalars we should also support it for string properties.

Copy link
Member Author

@jonathan-casey jonathan-casey Nov 10, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That wasn't part of the original spec unfortunately. Supporting regex on Map elements of type string is a fundamental change at the parser level, and on through validation, etc. We should definitely add this as an enhancement at a later stage.

fyi @mttrbrts

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There may be a misunderstanding here?

We support regexs where they are defined in the Scalar type, we don't support them inline in the Map definition (for either Strings or Scalar types).


}

if (mapValue.isScalarDeclaration?.() && mapValue.getValidator()?.getRegex()) {
jsonSchema.schema.additionalProperties.pattern = String(mapValue.getValidator().getRegex());
}

// if its a ClassDeclaration, add reference to its schema.
if (mapValue?.isClassDeclaration?.()) {
jsonSchema.schema.additionalProperties = {$ref: `#/definitions/${field.getParent().getModelFile().getNamespace().concat(`.${mapDeclaration.getValue().getType()}`)}`};
}

return jsonSchema;
// Not primitive, so must be a class or enumeration!
} else {
// Look up the type of the property.
Expand Down
Loading
Loading