Merge pull request #79 from advanced-rest-client/feat/W-16216524/show-original-data

Feat/w-16216524/show original data

Author: leandrogilcarrano

.gitignore

@@ -61,5 +61,7 @@ dist/
 # AMF models
 /demo/*.json
 !demo/apis.json
+!demo/avro.json
+!demo/avro2.json
 
 .idea/

demo/avro.json

@@ -28,7 +28,7 @@ class ApiDemo extends ApiDemoPage {
 
   _navChanged(e) {
     const { selected, type } = e.detail;
-    this.hasType = false;
+   this.hasType = false;
     this.mediaType = undefined;
     this.mediaTypes = undefined;
 
@@ -40,7 +40,7 @@ class ApiDemo extends ApiDemoPage {
   }
 
   setBodyData(id) {
-    const webApi = this._computeWebApi(this.amf);
+    const webApi = this._computeWebApi(this.amf) || this._computeApi(this.amf);
     const method = this._computeMethodModel(webApi, id);
     const expects = this._computeExpects(method);
     const payload = expects ? this._computePayload(expects)[0] : {};
@@ -100,6 +100,9 @@ class ApiDemo extends ApiDemoPage {
   _apiListTemplate() {
     return [
       ['demo-api', 'Demo API'],
+      ['avro', 'avro'],
+      ['avro2', 'avro2'],
+      ['jldAsync26', 'jldAsync26'],
       ['APIC-649', 'Deprecated properties'],
       ['APIC-429', 'APIC 429'],
       ['read-only-properties', 'Read Only Properties API'],

demo/avro2.json

@@ -560,9 +560,9 @@ export class ApiTypeDocument extends PropertyDocumentMixin(LitElement) {
     if (Array.isArray(item)) {
       return item;
     }
-
+    
     const propertyKey = this._getAmfKey(this.ns.w3.shacl.property);
-    const itemProperties = this._ensureArray(item[propertyKey])
+    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
@@ -571,9 +571,9 @@ export class ApiTypeDocument extends PropertyDocumentMixin(LitElement) {
     }
 
     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])
+    const additionalProperties = this._ensureArray(additionalPropertiesSchema[0][propertyKey] || additionalPropertiesSchema[0])
 
     // Combine the item's properties and additional properties
     const combinedProperties = [...itemProperties, ...additionalProperties]

demo/index.js

@@ -172,6 +172,7 @@ const mxFunction = (base) => {
           return 'String';
         case this._getAmfKey(sc.integer):
         case sc.integer:
+        case sc.int:
           return 'Integer';
         case this._getAmfKey(sc.long):
         case sc.long:
@@ -205,6 +206,10 @@ const mxFunction = (base) => {
         case this._getAmfKey(rs.password):
         case rs.password:
           return 'Password';
+        case sc.bytes:
+          return 'Bytes'
+        case sc.fixed:
+          return 'Fixed'
         default:
           return 'Unknown type';
       }

package-lock.json

@@ -34,6 +34,31 @@ export class PropertyShapeDocument extends PropertyDocumentMixin(LitElement) {
        * `displayName` was specified in the API spec for this property.
        */
       propertyName: { type: String },
+      /**
+       * A type size.
+       * Is only used for async / avro api
+       */
+      size: { type: String },
+      /**
+       * A type defaultValue.
+       * Is only used for async / avro api
+       */
+      defaultValue: { type: String },
+      /**
+       * A type namespace.
+       * Is only used for async / avro api
+       */
+      namespace: { type: String },
+      /**
+       * A type aliases.
+       * Is only used for async / avro api
+       */
+      aliases: { type: Array },
+      /**
+       * Avro original value type.
+       * Is only used for async / avro api
+       */
+      avroValue: { type: String },
       /**
        * Computed value, true if `displayName` has been defined for this
        * property.
@@ -211,6 +236,11 @@ export class PropertyShapeDocument extends PropertyDocumentMixin(LitElement) {
 
   constructor() {
     super();
+    this.avroValue = undefined
+    this.defaultValue = undefined
+    this.size = undefined
+    this.namespace = undefined
+    this.aliases = undefined
     this.hasDisplayName = false;
     this.hasParentTypeName = false;
     this.hasPropertyDescription = false;
@@ -290,6 +320,14 @@ export class PropertyShapeDocument extends PropertyDocumentMixin(LitElement) {
   _shapeRangeChanged(shape, range) {
     this.displayName = this._computeDisplayName(range, shape);
     this.propertyName = this._computePropertyName(range, shape);
+    this.avroValue = this._computeAvroShapeRangeSourceMap(range, shape)
+    const {size,namespace,aliases, defaultValue} = this._computeAvroProperties(range, shape)
+    this.size = size
+    this.namespace = namespace
+    this.aliases = aliases
+    this.defaultValue = defaultValue
+    
+    
     this.hasDisplayName = this._computeHasDisplayName(
       this.displayName,
       this.propertyName
@@ -369,6 +407,119 @@ export class PropertyShapeDocument extends PropertyDocumentMixin(LitElement) {
     return undefined;
   }
 
+  /**
+   * Computes avro property. Only for async / avro
+   *
+   * @param {Object} range Range object of current shape.
+   * @param {Object} shape The shape object
+   * @return {String|undefined} Size of the property
+   */
+  _computeAvroProperty(range, shape, prop) {
+    if (!shape && !range) {
+      return undefined;
+    }
+    let result
+    if (shape) {
+      shape = this._resolve(shape);
+      result = /** @type string */ (this._getValue(
+        shape,
+        this.ns.aml.vocabularies.shapes[prop]
+      ));
+
+    }
+    if (range && !result) {
+      range = this._resolve(range);
+      result = this._getValue(range, this.ns.aml.vocabularies.shapes[prop]);
+    }
+    return result ? String(result): undefined;
+  }
+
+  /**
+   * Computes avro defaultValue. Only for async / avro
+   *
+   * @param {Object} range Range object of current shape.
+   * @param {Object} shape The shape object
+   * @return {String|undefined} Size of the property
+   */
+  _computeAvroDefaultValue(range, shape) {
+    if (!shape && !range) {
+      return undefined;
+    }
+    const defaultValueKey = this.ns.w3.shacl.defaultValue
+    let result
+    if (shape) {
+      shape = this._resolve(shape);
+      if(shape[defaultValueKey]){
+        result = this._getValue(shape[defaultValueKey][0], this.ns.aml.vocabularies.data.value)
+      }
+    }
+    if (range && !result) {
+      range = this._resolve(range);
+      if(range[defaultValueKey]){
+        result = this._getValue(range[defaultValueKey], this.ns.aml.vocabularies.data.value)
+      }
+    }
+    return result ? String(result): undefined;
+  }
+
+  /**
+   * Computes size of the property. Only for async / avro
+   *
+   * @param {Object} range Range object of current shape.
+   * @param {Object} shape The shape object
+   * @return {Object|undefined} Size,namespace,aliases,defaultValue of the property (only when has avroValues)
+   */
+  _computeAvroProperties(range, shape) {
+    if(!this.avroValue){
+      return {size:undefined, namespace:undefined, aliases:undefined, defaultValue:undefined}
+    }
+   const size = this._computeAvroProperty(range,shape,"size")
+   const namespace = this._computeAvroProperty(range,shape,"namespace")
+   const aliases = this._computeAvroProperty(range,shape,"aliases")
+   const defaultValue = this._computeAvroDefaultValue(range,shape)
+   return {size, namespace, aliases, defaultValue}
+  }
+
+  /**
+   * Computes source values of the property. Only for async / avro
+   *
+   * @param {Object} data Range object of current shape.
+   */
+  _computeAvroSourceMap(data) {
+    try{
+      const sourcesKey = this._getAmfKey(this.ns.aml.vocabularies.docSourceMaps.sources)
+      const avroSchemaKey = this._getAmfKey(this.ns.aml.vocabularies.docSourceMaps.avroSchema)
+      const valueKey = this._getAmfKey(this.ns.aml.vocabularies.docSourceMaps.value)
+      if(data[sourcesKey] && data[sourcesKey][0][avroSchemaKey]){
+         const avroValues = this._ensureArray(data[sourcesKey][0][avroSchemaKey])
+         return avroValues[0][valueKey][0]['@value']
+      }
+      return undefined
+    }catch(_){
+      return undefined
+    }
+   
+  }
+
+  /**
+   * Computes source values of the property. Only for async / avro
+   *
+   * @param {Object} range Range object of current shape.
+   * @param {Object} shape The shape object
+   * @return {Object} Size of the property
+   */
+  _computeAvroShapeRangeSourceMap(range,shape) {
+   const shapeValue = this._computeAvroSourceMap(shape)
+   if(shapeValue){
+    return shapeValue
+   }
+   return this._computeAvroSourceMap(range)
+  }
+
+
+
+  
+
   /**
    * Computes value for `hasDisplayName` property.
    * Indicates that `displayName` has been defined in the API specification.
@@ -613,9 +764,64 @@ export class PropertyShapeDocument extends PropertyDocumentMixin(LitElement) {
       const itemType = this.arrayScalarTypeName;
       dataType = `${dataType} of ${itemType}`;
     }
-    return html`<span class="data-type">${dataType}</span>`;
+    return html`
+      <span class="data-type">${dataType}</span>`;
+
   }
 
+  /**
+   * @return {TemplateResult | String} Template size value (only for async / avro)
+   */
+  _getFixedTypeSizeAvroTemplate() {
+    const { size } = this;
+    if(!size){
+      return ''
+    }
+    return html`
+      <div class="fixed-type-size"><span>Size: ${size}</span></div>`;
+  }
+
+  /**
+   * @return {TemplateResult | String} Template size value (only for async / avro)
+   */
+  _getDefaultValueAvroTemplate() {
+    const { defaultValue } = this;
+    if(!defaultValue){
+      return ''
+    }
+    return html`
+      <div class="fixed-type-size"><span>Default Value: ${defaultValue}</span></div>`;
+  }
+
+  /**
+   * @return {TemplateResult | String} Template namespace value (only for async / avro)
+   */
+  _getTypeNamespaceAvroTemplate() {
+    const { namespace } = this;
+    if(!namespace){
+      return ''
+    }
+    return html`
+      <div class="fixed-type-size"><span>Namespace: ${namespace}</span></div>`;
+  }
+
+  /**
+   * @return {TemplateResult | String} Template namespace value (only for async / avro)
+   */
+  _getTypeAliasesAvroTemplate() {
+  const { aliases } = this;
+  if (!aliases) {
+    return '';
+  }
+  return html`
+    <div class="fixed-type-size">
+      Aliases: ${aliases.map(alias => html`<span>${alias}</span>`)}
+    </div>
+  `;
+}
+
+  
+
   /**
    * @return {TemplateResult|string} Template for the description
    */
@@ -716,6 +922,10 @@ export class PropertyShapeDocument extends PropertyDocumentMixin(LitElement) {
             >`
           : ''}
       </div>
+      ${this._getDefaultValueAvroTemplate()}
+      ${this._getFixedTypeSizeAvroTemplate()}
+      ${this._getTypeNamespaceAvroTemplate()}
+      ${this._getTypeAliasesAvroTemplate()}
       ${this._deprecatedWarningTemplate()}
       ${this._descriptionTemplate()}
       <property-range-document

src/ApiTypeDocument.js

@@ -134,6 +134,10 @@ export default css`
     font-weight: var(--api-type-document-trait-data-type-font-weight, normal);
   }
 
+  .property-traits > span.fixed-type-size {
+    padding: var(--api-type-document-trait-fixed-type-size-padding, 2px 1px);
+  }
+
   arc-marked {
     background-color: transparent;
     padding: 0;