fix: fixing examples serialization

Signed-off-by: Pawel Psztyc <[email protected]>

Author: jarrodek

apis/demo-api/demo-api.raml

@@ -945,6 +945,12 @@ types:
       application/xml:
         type: !include schemas/person.xsd
         example: !include examples/person.xml
+/json:
+  post:
+    body: 
+      application/json:
+        type: !include schemas/person.json
+        example: !include examples/person.json
 /examples:
   get:
     displayName: Included example
@@ -954,3 +960,65 @@ types:
           application/json:
             type: object
             example: !include examples/person.raml
+/body-tracking:
+  get:
+    displayName: Common RAML example
+    description: |
+      The payload has the same example for both mime types coming from RAML 
+      declaration.
+    body: 
+      application/json:
+        type: AppPerson
+        example: !include examples/person.raml
+      application/xml:
+        type: AppPerson
+        example: !include examples/person.raml
+  put:
+    displayName: Different examples
+    description: |
+      The payload has different examples for both mime types. Both comming for the corresponding 
+      schema.
+    body: 
+      application/json:
+        type: AppPerson
+        example: !include examples/person.json
+      application/xml:
+        type: AppPerson
+        example: !include examples/person.xml
+  post:
+    displayName: Reused examples
+    description: |
+      This payload is exactly the same as `put` payload.
+      This should render how the examples behave when reused.
+    body: 
+      application/json:
+        type: AppPerson
+        example: !include examples/person.json
+      application/xml:
+        type: AppPerson
+        example: !include examples/person.xml
+  delete:
+    description: |
+      This payload has only one mime.
+    body: 
+      application/json:
+        type: AppPerson
+        example: !include examples/person.json
+  patch:
+    displayName: No example
+    description: |
+      This payload has no example at all.
+    body: 
+      application/json:
+        type: AppPerson
+/not-shared:
+  post:
+    body: 
+      application/json:
+        type: object
+        properties: 
+          id: number
+          name: string
+        example:
+          id: 1234567890
+          name: Pawel Uchida-Psztyc

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "@api-components/amf-helper-mixin",
   "description": "A mixin with common functions user by most AMF components to compute AMF values",
-  "version": "4.5.10",
+  "version": "4.5.11",
   "license": "Apache-2.0",
   "main": "index.js",
   "module": "index.js",
@@ -52,7 +52,7 @@
     "lint": "npm run lint:eslint",
     "format": "npm run format:eslint",
     "test": "web-test-runner test/**/*.test.js --coverage --node-resolve --playwright --browsers chromium firefox webkit",
-    "test:watch": "web-test-runner test/**/*.test.js --node-resolve --watch",
+    "test:watch": "web-test-runner --node-resolve --watch",
     "prepare": "node apis/model.js"
   },
   "eslintConfig": {

package.json

@@ -26,6 +26,18 @@ export declare class AmfSerializer extends AmfHelperMixin(Object) {
   isLink(object: DomainElement): boolean;
   shape(object: Shape): ApiShape;
   anyShape(object: AnyShape): ApiAnyShape;
+  /**
+   * Filters examples that should be rendered for a payload identified by `payloadId`.
+   * 
+   * This function is copied from old `api-example-generator/ExampleGenerator`.
+   */
+  filterTrackedExamples(examples: Example[], payloadId: string): Example[];
+  /**
+   * Kind of the opposite of the `filterTrackedExamples`. It gathers examples that only have been 
+   * defined for the parent Shape (ed in the type declaration). It filters out all examples
+   * defined in a payload.
+   */
+  filterNonTrackedExamples(examples: Example[]): Example[];
   scalarShape(object: ScalarShape): ApiScalarShape;
   /**
    * @param object The NodeShape to serialize