-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(ns-json-schema-draft-4): handle inheritance of $schema and id
Refs #1819
- Loading branch information
Showing
2 changed files
with
186 additions
and
13 deletions.
There are no files selected for viewing
67 changes: 65 additions & 2 deletions
67
packages/apidom-ns-json-schema-draft-4/src/refractor/visitors/json-schema/index.ts
This file contains 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,33 +1,96 @@ | ||
| import { Mixin } from 'ts-mixer'; | ||
| import { always } from 'ramda'; | ||
| import { always, defaultTo } from 'ramda'; | ||
| import { isNonEmptyString, isUndefined } from 'ramda-adjunct'; | ||
| import { | ||
| ObjectElement, | ||
| ArrayElement, | ||
| isStringElement, | ||
| cloneDeep, | ||
| toValue, | ||
| } from '@swagger-api/apidom-core'; | ||
|
|
||
| import FixedFieldsVisitor, { | ||
| FixedFieldsVisitorOptions, | ||
| SpecPath, | ||
| } from '../generics/FixedFieldsVisitor.ts'; | ||
| import ParentSchemaAwareVisitor, { | ||
| ParentSchemaAwareVisitorOptions, | ||
| } from './ParentSchemaAwareVisitor.ts'; | ||
| import FallbackVisitor, { FallbackVisitorOptions } from '../FallbackVisitor.ts'; | ||
| import JSONSchemaElement from '../../../elements/JSONSchema.ts'; | ||
| import { isJSONSchemaElement } from '../../../predicates.ts'; | ||
|
|
||
| /** | ||
| * @public | ||
| */ | ||
| export interface JSONSchemaVisitorOptions | ||
| extends FixedFieldsVisitorOptions, | ||
| ParentSchemaAwareVisitorOptions, | ||
| FallbackVisitorOptions {} | ||
|
|
||
| /** | ||
| * @public | ||
| */ | ||
| class JSONSchemaVisitor extends Mixin(FixedFieldsVisitor, FallbackVisitor) { | ||
| class JSONSchemaVisitor extends Mixin( | ||
| FixedFieldsVisitor, | ||
| ParentSchemaAwareVisitor, | ||
| FallbackVisitor, | ||
| ) { | ||
| declare public element: JSONSchemaElement; | ||
|
|
||
| declare protected readonly specPath: SpecPath<['document', 'objects', 'JSONSchema']>; | ||
|
|
||
| protected readonly default$schema = 'http://json-schema.org/draft-04/schema#'; | ||
|
|
||
| constructor(options: JSONSchemaVisitorOptions) { | ||
| super(options); | ||
| this.element = new JSONSchemaElement(); | ||
| this.specPath = always(['document', 'objects', 'JSONSchema']); | ||
| } | ||
|
|
||
| ObjectElement(objectElement: ObjectElement) { | ||
| this.handle$schema(objectElement); | ||
| this.handleId(objectElement); | ||
|
|
||
| // for further processing consider this Schema Element as parent for all embedded Schema Elements | ||
| this.parent = this.element; | ||
| const result = FixedFieldsVisitor.prototype.ObjectElement.call(this, objectElement); | ||
|
|
||
| return result; | ||
| } | ||
|
|
||
| handle$schema(objectElement: ObjectElement): void { | ||
| // handle $schema keyword in embedded resources | ||
| if (isUndefined(this.parent) && !isStringElement(objectElement.get('$schema'))) { | ||
| // no parent available and no $schema is defined, set default$schema | ||
| this.element.setMetaProperty('inherited$schema', this.default$schema); | ||
| } else if (isJSONSchemaElement(this.parent) && !isStringElement(objectElement.get('$schema'))) { | ||
| // parent is available and no $schema is defined, set parent $schema | ||
| const inherited$schema = defaultTo( | ||
| toValue(this.parent.meta.get('inherited$schema')), | ||
| toValue(this.parent.$schema), | ||
| ); | ||
| this.element.setMetaProperty('inherited$schema', inherited$schema); | ||
| } | ||
| } | ||
|
|
||
| handleId(objectElement: ObjectElement): void { | ||
| // handle id keyword in embedded resources | ||
| // fetch parent's inheritedId | ||
| const inheritedId = | ||
| this.parent !== undefined | ||
| ? cloneDeep(this.parent.getMetaProperty('inheritedId', [])) | ||
| : new ArrayElement(); | ||
| // get current id keyword | ||
| const id = toValue(objectElement.get('id')); | ||
|
|
||
| // remember id keyword if it's a non-empty strings | ||
| if (isNonEmptyString(id)) { | ||
| inheritedId.push(id); | ||
| } | ||
|
|
||
| this.element.setMetaProperty('inheritedId', inheritedId); | ||
| } | ||
| } | ||
|
|
||
| export default JSONSchemaVisitor; |
This file contains 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