@api-components/api-type-document 4.2.27 → 4.2.29

package/package.json

@@ -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.27",
+  "version": "4.2.29",
   "license": "Apache-2.0",
   "main": "index.js",
   "module": "index.js",
@@ -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.6",
+    "@api-components/amf-helper-mixin": "^4.5.24",
     "@api-components/api-annotation-document": "^4.1.0",
     "@api-components/api-resource-example-document": "^4.3.3",
     "@open-wc/dedupe-mixin": "^1.3.0",
@@ -99,4 +99,4 @@
       "eslint --fix"
     ]
   }
-}
+}

package/src/ApiTypeDocument.d.ts

@@ -174,6 +174,8 @@ export class ApiTypeDocument extends PropertyDocumentMixin(LitElement) {
    */
   noMediaSelector: boolean;
 
+  noArrayInfo: boolean;
+
   get shouldRenderMediaSelector(): boolean;
 
   constructor();

package/src/ApiTypeDocument.js

@@ -167,6 +167,8 @@ export class ApiTypeDocument extends PropertyDocumentMixin(LitElement) {
        * applicable.
        */
       noMediaSelector: { type: Boolean },
+
+      noArrayInfo: { type: Boolean },
     };
   }
 
@@ -558,8 +560,26 @@ export class ApiTypeDocument extends PropertyDocumentMixin(LitElement) {
     if (Array.isArray(item)) {
       return item;
     }
-    const key = this._getAmfKey(this.ns.w3.shacl.property);
-    return this._filterReadOnlyProperties(this._ensureArray(item[key]));
+
+    const propertyKey = this._getAmfKey(this.ns.w3.shacl.property);
+    const itemProperties = this._ensureArray(item[propertyKey])
+    const additionalPropertiesKey = this._getAmfKey(this.ns.w3.shacl.additionalPropertiesSchema);
+
+    // If the item doesn't have additional properties, filter the read-only properties and return
+    if (!item[additionalPropertiesKey]) {
+      return this._filterReadOnlyProperties(itemProperties)
+    }
+
+    const additionalPropertiesSchema = this._ensureArray(item[additionalPropertiesKey])
+
+    // If the item does have additional properties, ensure they are in an array
+    const additionalProperties = this._ensureArray(additionalPropertiesSchema[0][propertyKey])
+
+    // Combine the item's properties and additional properties
+    const combinedProperties = [...itemProperties, ...additionalProperties]
+
+    // Filter the read-only properties and return
+    return this._filterReadOnlyProperties(combinedProperties);
   }
 
   /**
@@ -685,19 +705,22 @@ export class ApiTypeDocument extends PropertyDocumentMixin(LitElement) {
   }
 
   _arrayPropertiesTemplate() {
-    const minCount = this._getValue(this._resolvedType, this.ns.w3.shacl.minCount)
-    const maxCount = this._getValue(this._resolvedType, this.ns.w3.shacl.maxCount)
+    if (!this.noArrayInfo) {
+      const minCount = this._getValue(this._resolvedType, this.ns.w3.shacl.minCount)
+      const maxCount = this._getValue(this._resolvedType, this.ns.w3.shacl.maxCount)
 
-    return html`
-      ${minCount !== undefined ? this._arrayPropertyTemplate('Minimum array length:', minCount, 'Minimum amount of items in array') : ''}
-      ${maxCount !== undefined ? this._arrayPropertyTemplate('Maximum array length:', maxCount, 'Maximum amount of items in array') : ''}
-    `
+      return html`
+          ${minCount !== undefined ? this._arrayPropertyTemplate('Minimum array length:', minCount, 'Minimum amount of items in array') : ''}
+          ${maxCount !== undefined ? this._arrayPropertyTemplate('Maximum array length:', maxCount, 'Maximum amount of items in array') : ''}
+      `
+    }
+    return html``
   }
 
   /**
    * @return {TemplateResult} Templates for object properties
    */
-   _arrayTemplate() {
+  _arrayTemplate() {
     const items = this._computeArrayProperties(this._resolvedType) || [];
     const documents = items.map(
       (item) => html`
@@ -737,9 +760,9 @@ export class ApiTypeDocument extends PropertyDocumentMixin(LitElement) {
         <span>Array of:</span>
         <div class="array-children">
           ${documents}
-        </div>` 
+        </div>`
         : html`${documents}`
-        }
+      }
     
       ${this._arrayPropertiesTemplate()}
     `;
@@ -753,7 +776,7 @@ export class ApiTypeDocument extends PropertyDocumentMixin(LitElement) {
     const selected = this.selectedUnion;
     const selectTypeCallback = this._selectType.bind(this, 'selectedUnion');
     const key = this._getAmfKey(this.ns.aml.vocabularies.shapes.anyOf);
-    const type = this._computeProperty(this._resolvedType, key,selected);
+    const type = this._computeProperty(this._resolvedType, key, selected);
     const typeName = 'union'
     const label = 'Any of'
     return this._multiTypeTemplate({ label, items, typeName, selected, selectTypeCallback, type });
@@ -850,10 +873,10 @@ export class ApiTypeDocument extends PropertyDocumentMixin(LitElement) {
     }
     return html` ${items.map(
       (item) => html` ${item.label
-          ? html`<p class="inheritance-label">
+        ? html`<p class="inheritance-label">
               Properties inherited from <b>${item.label}</b>.
             </p>`
-          : html`<p class="inheritance-label">Properties defined inline.</p>`}
+        : html`<p class="inheritance-label">Properties defined inline.</p>`}
         <api-type-document
           class="and-document"
           .amf="${this.amf}"
@@ -882,12 +905,12 @@ export class ApiTypeDocument extends PropertyDocumentMixin(LitElement) {
     return html`<style>${this.styles}</style>
       <section class="examples" ?hidden="${!this._renderMainExample}">
         ${this.shouldRenderMediaSelector
-          ? html`<div class="media-type-selector">
+        ? html`<div class="media-type-selector">
               <span>Media type:</span>
               ${mediaTypes.map((item, index) => {
-                const selected = this.selectedMediaType === index;
-                const pressed = selected ? 'true' : 'false';
-                return html`<anypoint-button
+          const selected = this.selectedMediaType === index;
+          const pressed = selected ? 'true' : 'false';
+          return html`<anypoint-button
                   part="content-action-button"
                   class="media-toggle"
                   data-index="${index}"
@@ -898,9 +921,9 @@ export class ApiTypeDocument extends PropertyDocumentMixin(LitElement) {
                   title="Select ${item} media type"
                   >${item}</anypoint-button
                 >`;
-              })}
+        })}
             </div>`
-          : ''}
+        : ''}
 
         <api-resource-example-document
           .amf="${this.amf}"

package/src/PropertyShapeDocument.js

@@ -582,6 +582,7 @@ export class PropertyShapeDocument extends PropertyDocumentMixin(LitElement) {
       ?compatibility="${this.compatibility}"
       ?noExamplesActions="${this.noExamplesActions}"
       noMainExample
+      noArrayInfo
       .mediaType="${this.mediaType}"
       ?graph="${this.graph}"
     ></api-type-document>`;