@intelligentgraphics/openconfiguration - npm Package Compare versions

Comparing version 1.1.0 to 1.2.0

dist/index.d.ts

@@ -808,5 +808,48 @@ declare namespace Cns {
 }
-type ERepresentation = "PreviewImage" // Perspective image, PNG or JPEG, approx. 1K x 1K
- | "TopViewGraphics"; // Top-view 2D SVG, according to IDM Polster
 /**
+ * Top-view representation of a Product.
+ * Implemented by an image that is put into a rectangular region.
+ * The origin of the region is aligned with the origin of the Product
+ * but may be moved by an offset.
+ */
+interface TopView {
+    /**
+     * Width, in m, of the rectangular region.
+     */
+    width: number;
+    /**
+     * Depth, in m, of the rectangular region.
+     */
+    depth: number;
+    /**
+     * Optional X offset, in m, of the rectangular region.
+     */
+    x?: number;
+    /**
+     * Optional Z offset, in m, of the rectangular region.
+     */
+    z?: number;
+    /**
+     * The mandatory format of the image.
+     */
+    imageFormat: "PNG" | "JPEG" | "SVG";
+    /**
+     * The manadatory image reference.
+     */
+    image: string;
+}
+/**
+ * Product preview image, preferably a perspective image with 1k size.
+ */
+interface Preview {
+    /**
+     * The mandatory format of the image.
+     */
+    imageFormat: "PNG" | "JPEG" | "SVG";
+    /**
+     * The manadatory image reference.
+     */
+    image: string;
+}
+/**
  * An initial or incremental product representation.
@@ -861,2 +904,10 @@ */
     /**
+     * An optional product representation from top-view perspective.
+     */
+    topView?: TopView;
+    /**
+     * An optional product preview image.
+     */
+    preview?: Preview;
+    /**
      * Attachment points for the client-side creation of neighbor and
@@ -879,6 +930,2 @@ * parent-child relationships.
     status: Status;
-    /**
-     * Product-related representations.
-     */
-    representations?: Record<ERepresentation, string>;
 }
@@ -945,3 +992,3 @@ /**
      * "OpenConfiguration_<Major/>.<Minor/> [PRE]"
-     * Legal combinations of <Major/>.<Minor/> are: 1.0
+     * Legal combinations of <Major/>.<Minor/> are: 1.0, 1.1 and 1.2
      * The optional postfix " PRE" marks a preliminary format.
@@ -956,2 +1003,7 @@ */
     /**
+     * This optional attribute contains a link to the source of this OC data set.
+     * Normally, a link that recovers the configuration.
+     */
+    source?: string;
+    /**
      * This attribute contains general status information about the Scene contents.
@@ -958,0 +1010,0 @@ */

dist/OC.ts

@@ -808,5 +808,48 @@ declare namespace Cns {
 }
-type ERepresentation = "PreviewImage" // Perspective image, PNG or JPEG, approx. 1K x 1K
- | "TopViewGraphics"; // Top-view 2D SVG, according to IDM Polster
 /**
+ * Top-view representation of a Product.
+ * Implemented by an image that is put into a rectangular region.
+ * The origin of the region is aligned with the origin of the Product
+ * but may be moved by an offset.
+ */
+interface TopView {
+    /**
+     * Width, in m, of the rectangular region.
+     */
+    width: number;
+    /**
+     * Depth, in m, of the rectangular region.
+     */
+    depth: number;
+    /**
+     * Optional X offset, in m, of the rectangular region.
+     */
+    x?: number;
+    /**
+     * Optional Z offset, in m, of the rectangular region.
+     */
+    z?: number;
+    /**
+     * The mandatory format of the image.
+     */
+    imageFormat: "PNG" | "JPEG" | "SVG";
+    /**
+     * The manadatory image reference.
+     */
+    image: string;
+}
+/**
+ * Product preview image, preferably a perspective image with 1k size.
+ */
+interface Preview {
+    /**
+     * The mandatory format of the image.
+     */
+    imageFormat: "PNG" | "JPEG" | "SVG";
+    /**
+     * The manadatory image reference.
+     */
+    image: string;
+}
+/**
  * An initial or incremental product representation.
@@ -861,2 +904,10 @@ */
     /**
+     * An optional product representation from top-view perspective.
+     */
+    topView?: TopView;
+    /**
+     * An optional product preview image.
+     */
+    preview?: Preview;
+    /**
      * Attachment points for the client-side creation of neighbor and
@@ -879,6 +930,2 @@ * parent-child relationships.
     status: Status;
-    /**
-     * Product-related representations.
-     */
-    representations?: Record<ERepresentation, string>;
 }
@@ -945,3 +992,3 @@ /**
      * "OpenConfiguration_<Major/>.<Minor/> [PRE]"
-     * Legal combinations of <Major/>.<Minor/> are: 1.0
+     * Legal combinations of <Major/>.<Minor/> are: 1.0, 1.1 and 1.2
      * The optional postfix " PRE" marks a preliminary format.
@@ -956,2 +1003,7 @@ */
     /**
+     * This optional attribute contains a link to the source of this OC data set.
+     * Normally, a link that recovers the configuration.
+     */
+    source?: string;
+    /**
      * This attribute contains general status information about the Scene contents.
@@ -958,0 +1010,0 @@ */

package.json

 {
   "name": "@intelligentgraphics/openconfiguration",
-  "version": "1.1.0",
-  "description": "OpenConfiguration 1.1 (1.1.100)",
+  "version": "1.2.0",
+  "description": "OpenConfiguration 1.2 (1.2.100)",
   "publishConfig": {
@@ -6,0 +6,0 @@ "access": "public"

No alert changes

Improved metrics

Total package byte prevSize

73823

increased by3.2%

Lines of code

2287

increased by4.76%

No dependency changes