@api-components/amf-helper-mixin - npm Package Compare versions

Comparing version 4.5.10 to 4.5.11

package.json

 {
   "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",
@@ -55,3 +55,3 @@ "main": "index.js",
     "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"
@@ -58,0 +58,0 @@ },

src/AmfSerializer.d.ts

@@ -29,2 +29,14 @@ /* eslint-disable class-methods-use-this */
   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;
@@ -31,0 +43,0 @@ /**

src/types.d.ts

@@ -485,2 +485,3 @@ import { Server } from "./amf";
 export interface ApiSynthesizedField {
+  id: string;
   element: string;
@@ -510,1 +511,14 @@ value: string;
 }
+
+export interface ShapeProcessingOptions {
+  /**
+   * This is set when serializing a payload.
+   * It is used to determine which example of the schema to include.
+   * 
+   * When an example has the `tracked-element` in the source maps then this
+   * is used to determine the only examples included to the schema.
+   * 
+   * Note, the value of the tracked-element can be a list of IDs separated by coma.
+   */
+  payloadId?: string;
+}

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

223837

increased by1.97%

Lines of code

5664

increased by2.18%

No dependency changes