Skip to content

Feat/w 17482615/list mapping types #85

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.

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

Merged
merged 3 commits into from
Jan 6, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -64,4 +64,5 @@ dist/
!demo/avro.json
!demo/avro2.json

.idea/
.idea/
.codegenie/
18 changes: 9 additions & 9 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@api-components/api-type-document",
"description": "A documentation table for type (resource) properties. Works with AMF data model",
"version": "4.2.31",
"version": "4.2.33",
"license": "Apache-2.0",
"main": "index.js",
"module": "index.js",
Expand All @@ -28,7 +28,7 @@
"@advanced-rest-client/arc-marked": "^1.1.0",
"@advanced-rest-client/markdown-styles": "^3.1.4",
"@anypoint-web-components/anypoint-button": "^1.2.3",
"@api-components/amf-helper-mixin": "^4.5.24",
"@api-components/amf-helper-mixin": "^4.5.29",
"@api-components/api-annotation-document": "^4.1.0",
"@api-components/api-resource-example-document": "^4.3.3",
"@open-wc/dedupe-mixin": "^1.3.0",
Expand Down
14 changes: 14 additions & 0 deletions src/ApiTypeDocument.js
Original file line number Diff line number Diff line change
Expand Up @@ -671,6 +671,19 @@ export class ApiTypeDocument extends PropertyDocumentMixin(LitElement) {
this._hasExamples = value;
}

/**
* Return the type mappings
*/
_typesMappings(item) {
const itemName = this._getValue(item, this._getAmfKey(this.ns.w3.shacl.name));
const typeTarget = this._getValue(this.type, this._getAmfKey(this.ns.aml.vocabularies.shapes.discriminator));
let type;
if (itemName && typeTarget && itemName === typeTarget) {
type = this.type;
}
return type;
}

/**
* @return {TemplateResult[]|string} Templates for object properties
*/
Expand All @@ -691,6 +704,7 @@ export class ApiTypeDocument extends PropertyDocumentMixin(LitElement) {
?graph="${this.graph}"
.mediaType="${this.mediaType}"
?renderReadOnly="${this.renderReadOnly}"
.discriminatorMapping="${this._typesMappings(item)}"
></property-shape-document>`
);
}
Expand Down
5 changes: 5 additions & 0 deletions src/PropertyShapeDocument.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,11 @@ export class PropertyShapeDocument extends PropertyDocumentMixin(LitElement) {
* @attribute
*/
deprecated: boolean
/**
* List type mappings
* @attribute
*/
discriminatorMapping: any;

get complexToggleLabel(): string;

Expand Down
42 changes: 42 additions & 0 deletions src/PropertyShapeDocument.js
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,10 @@ export class PropertyShapeDocument extends PropertyDocumentMixin(LitElement) {
* Determines if shape's range is deprecated
*/
deprecated: { type: Boolean, reflect: true },
/**
* Used for discriminator types mappings
*/
discriminatorMapping: { type: Object },
};
}

Expand Down Expand Up @@ -247,6 +251,7 @@ export class PropertyShapeDocument extends PropertyDocumentMixin(LitElement) {
this.narrow = false;
this.renderReadOnly = false;
this.deprecated = false;
this.discriminatorMapping = undefined;
}

connectedCallback() {
Expand Down Expand Up @@ -936,6 +941,42 @@ export class PropertyShapeDocument extends PropertyDocumentMixin(LitElement) {
return ''
}

_navigateItem(e) {
e.preventDefault();
const data = e.composedPath()[0].dataset;
if (!data.id || !data.shapeType) {
return;
}
const ev = new CustomEvent("api-navigation-selection-changed", {
bubbles: true,
composed: true,
detail: {
selected: data.id,
type: data.shapeType,
},
});
this.dispatchEvent(ev);
}

_keydownNavigateItem(e) {
if (e.key === "Enter") {
this._navigateItem(e);
}
}

_typesMappingsTemplate() {
const mappings = this._getValueArray(this.discriminatorMapping, this._getAmfKey(this.ns.aml.vocabularies.shapes.discriminatorValueMapping));
if (!mappings) return html``;

return html`<ul class="types-mappings-container">
${mappings.map((mapping) => {
const name = this._getValue(mapping, this._getAmfKey(this.ns.aml.vocabularies.shapes.discriminatorValue));
const target = this._getLinkValue(mapping, this._getAmfKey(this.ns.aml.vocabularies.shapes.discriminatorValueTarget));
return html`<li class="types-mappings-item" data-id="${target}" data-shape-type="type" @click="${this._navigateItem}" @keydown="${this._keydownNavigateItem}">${name}</li>`;
})}
</ul>`;
}

/**
* @return {TemplateResult} Main render function.
*/
Expand Down Expand Up @@ -975,6 +1016,7 @@ export class PropertyShapeDocument extends PropertyDocumentMixin(LitElement) {
${this._getTypeAliasesAvroTemplate()}
${this._deprecatedWarningTemplate()}
${this._descriptionTemplate()}
${this._typesMappingsTemplate()}
<property-range-document
.amf="${this.amf}"
.shape="${this.shape}"
Expand Down
10 changes: 10 additions & 0 deletions src/ShapeStyles.js
Original file line number Diff line number Diff line change
Expand Up @@ -163,4 +163,14 @@ export default css`
border-radius: var(--api-type-document-deprecated-warning-border-radius, 3px);
display: inline-flex;
}
.types-mappings-container {
margin-top: -10px;
}
.types-mappings-item {
cursor: pointer;
color: var(--link-color, #0277bd);
}
.types-mappings-item:hover {
text-decoration: underline;
}
`;
Loading