@intelligentgraphics/openconfiguration - npm Package Compare versions

Comparing version 1.2.6 to 1.3.0

dist/index.d.ts

@@ -412,7 +412,7 @@ declare namespace Cns {
      */
-    article: string;
+    article?: string;
     /**
      * Additional article code that describes the specific variant.
      */
-    variant: string;
+    variant?: string;
     /**
@@ -422,11 +422,11 @@ * The native id. In case of IDM, this is <series/>|<product/>.
      */
-    nativeId: string;
+    nativeId?: string;
     /**
      * Short (one-line), localized article text. Key is ISO 639-1 language code.
      */
-    shortText: Record<string, string>;
+    shortText?: Record<string, string>;
     /**
      * Long, localized article text. Key is ISO 639-1 language code.
      */
-    longText: Record<string, string[]>;
+    longText?: Record<string, string[]>;
     /**
@@ -436,3 +436,3 @@ * Long, localized article text that describes the variant. Used as an addition
      */
-    variantText: Record<string, string[]>;
+    variantText?: Record<string, string[]>;
     /**
@@ -496,3 +496,3 @@ *  The price unit, for all prices of this article. Possible values:
      */
-    values: Value[];
+    values?: Value[];
 }
@@ -781,2 +781,21 @@ /**
 /**
+ * Basic master data, used OC master-data scenarios.
+ */
+interface MasterData {
+    /**
+     * The commercial product Id.
+     * ASCII. 45 chars max.
+     */
+    productId: string;
+    /**
+     * The instance id of an associated master product, e.g. a set.
+     */
+    nativeId?: string;
+    /**
+     * Informal description.
+     * UTF-8. 100 chars max.
+     */
+    description?: string;
+}
+/**
  * Defines status codes on product and scene level.
@@ -904,5 +923,5 @@ * 200 is default. All other codes than 200 are errors.
      *
-     * IGXC Compatiblity: In IGXC this attribute was named Categories.
+     * IGXC Compatibility: In IGXC this attribute was named Categories.
      */
-    materialCategories: Record<string, string>;
+    materialCategories?: Record<string, string>;
     /**
@@ -947,4 +966,9 @@ * Product categories for the client-side implementation of planning
      */
-    commercial: Commercial;
+    commercial?: Commercial;
     /**
+     * Master data related to this product
+     * Version: OC 1.3
+     */
+    masterData?: MasterData;
+    /**
      * Contains product related status information.
@@ -1057,2 +1081,7 @@ */
      * rator character of the operating system.
+     * "Relative" basePath is always relative to the scene.json path,
+     * not to an application/deployment specific one!
+     * example.configurator.com/assets/oc/scene.json containing "tex.jpg"
+     * basepathes "gfx", "./gfx", "/gfx" are all resolved to the same
+     * example.configurator.com/assets/oc/gfx/tex.jpg
      */
@@ -1068,3 +1097,3 @@ basePath?: string;
      *
-     * Any asset should have an entry here as downloaders may iterate thru
+     * All assets should have an entry here as downloaders may iterate through
      * this record rather than exploring the other data entities.
@@ -1071,0 +1100,0 @@ */

dist/index.js

@@ -5,7 +5,7 @@ 'use strict';
 
-var index = /*#__PURE__*/Object.freeze({
+var index$1 = /*#__PURE__*/Object.freeze({
 	__proto__: null
 });
 
-var index$1 = /*#__PURE__*/Object.freeze({
+var index = /*#__PURE__*/Object.freeze({
 	__proto__: null
@@ -34,5 +34,5 @@ });
 
-exports.Cns = index;
-exports.Ig = index$1;
+exports.Cns = index$1;
+exports.Ig = index;
 exports.cnsPrefix = cnsPrefix;
 exports.getScriptTechnicalVersion = getScriptTechnicalVersion;

dist/OC.ts

@@ -17,5 +17,5 @@ declare namespace Cns {
          * The mandatory format of the optional preview mesh.
-         * Allowed formats are "OpenCTM", "OBJ", "FBX".
+         * Allowed formats are "OpenCTM", "OBJ", "OGRE Binary".
          */
-        previewFormat?: "OpenCTM" | "OBJ" | "FBX";
+        previewFormat?: "OpenCTM" | "OBJ" | "FBX" | "OGRE Binary";
         /**
@@ -26,17 +26,6 @@ * An optional mesh to be displayed until the main mesh is loaded.
         /**
-         * The mandatory format of the optional preview mesh.
-         * Allowed formats are "OpenCTM", "OBJ", "FBX".
-         * Version: OC 1.1
-         */
-        colliderFormat?: "OpenCTM" | "OBJ" | "FBX";
-        /**
-         * An optional mesh to be used for collision detection.
-         * Version: OC 1.1
-         */
-        collider?: string;
-        /**
          * The mandatory format of the optional main mesh.
-         * Allowed formats are "OpenCTM", "OBJ", "FBX", "DWG".
+         * Allowed formats are "OpenCTM", "OBJ", "FBX", "OGRE Binary".
          */
-        meshFormat?: "OpenCTM" | "OBJ" | "FBX" | "DWG";
+        meshFormat?: "OpenCTM" | "OBJ" | "FBX" | "OGRE Binary";
         /**
@@ -83,29 +72,4 @@ * An optional mesh to be displayed as main mesh. Note, in some case a
          *
-         * "NormalMapTiling":
-         * The Geometry Normal Map should be repeated instead of clamped outside 0..1 UV range
-         * Some 3D libraries call this "wrapping mode" if true set to "repeat", default is "clamp"
-         * Target type: Boolean
-         * Version: OC 1.1
-         *
-         * "NormalMapStrength":
-         * Changes the influence of the Geometry Normal Map in light calculation, default: 1,
-         * by multiplying the strength of the geometry normal map with this factor.
-         * Target type: number
-         * Version: OC 1.1
-         *
-         * "RenderOrder"
-         * FRender order for 3D libraries that render transparent objects in a separate, second pass, back to front.
-         * Negative values are rendered earlier in the process, positive values later, 0 is default and keeps library ordering.
-         * Raytracers and renderers with advanced transparency handling must ignore this!
-         * This is NOT intended for effects different from a natural/physical correct scene, i.e. it can not be used for
-         * artistic effects!
-         * Target type: number
-         * Version: OC 1.1
          */
-        parameters?: {
-            SuperDeformation?: boolean;
-            NormalMapTiling?: boolean;
-            NormalMapStrength?: number;
-            RenderOrder?: number;
-        };
+        parameters?: Record<"SuperDeformation", object>;
     }
@@ -457,12 +421,2 @@ /**
     properties: Property[];
-    /**
-     * Quantity of the product. For the main product, always expected to be 1.
-     * Version: OC 1.3
-     */
-    quantity?: number;
-    /**
-     * Commercial sub-products, visually represented by the main product.
-     * Version: OC 1.3
-     */
-    products?: Commercial[];
 }
@@ -665,8 +619,2 @@ /**
     /**
-     * One or more symbolic id to identify a component at run-time. Unlike Path, a
-     * Tag is more robust and not biunique.
-     * Version: OC 1.1
-     */
-    tags?: string[];
-    /**
      * The optional attribute defines property ids that are linked to this
@@ -830,47 +778,2 @@ * object (and it's children). This information may be used for context-
 /**
- * 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.
@@ -925,12 +828,2 @@ */
     /**
-     * An optional product representation from top-view perspective.
-     * Version: OC 1.2
-     */
-    topView?: TopView;
-    /**
-     * An optional product preview image.
-     * Version: OC 1.2
-     */
-    preview?: Preview;
-    /**
      * Attachment points for the client-side creation of neighbor and
@@ -1001,3 +894,2 @@ * parent-child relationships.
 }
-declare const getScriptTechnicalVersion: (script: Script) => number;
 type Representation = "Standard" | "CAD_BIM" | "Photo";
@@ -1016,3 +908,3 @@ /**
      * "OpenConfiguration_<Major/>.<Minor/> [PRE]"
-     * Legal combinations of <Major/>.<Minor/> are: 1.0, 1.1 and 1.2
+     * Legal combinations of <Major/>.<Minor/> are: 1.0
      * The optional postfix " PRE" marks a preliminary format.
@@ -1044,6 +936,2 @@ */
     configurationId?: string;
-    /**
-     * This optional attribute may contain the link of the original configuration.
-     */
-    configurationLink?: string;
     //#endregion General
@@ -1069,15 +957,5 @@ /**
      * legal for hash, is to compare them with an optionally existing one.
-     *
-     * Any asset should have an entry here as downloaders may iterate thru
-     * this record rather than exploring the other data entities.
      */
     hashes: Record<string, string>;
     /**
-     * Redirections maybe needed to convert absolute asset urls into file
-     * names, especially when compiling a self-contained OC zip.
-     * The attribute is optional.
-     * Version: OC 1.3
-     */
-    redirections?: Record<string, string>;
-    /**
      * The optional attribute contains all client-side JavaScript packages.
@@ -1136,7 +1014,2 @@ */
     products: Product[];
-    /**
-     * Commercial products without an own visual representation.
-     * Version: OC 1.3
-     */
-    comProducts?: Commercial[];
 }
@@ -1178,2 +1051,2 @@ /**
 }
-export { Cns, Ig, AttachPointType, AttachPoint, CatalogEntry, Color, Commercial, Property, Value, cnsPrefix, Component, Geometry, GeometryIndex, GeometryMapping, Material, MaterialIndex, Product, Quaternion, Representation, Scene, Script, getScriptTechnicalVersion, State, TextureMapping, Transform, Vector };
+export { Cns, Ig, AttachPointType, AttachPoint, CatalogEntry, Color, Commercial, Property, Value, cnsPrefix, Component, Geometry, GeometryIndex, GeometryMapping, Material, MaterialIndex, Product, Quaternion, Representation, Scene, Script, State, TextureMapping, Transform, Vector };

package.json

 {
   "name": "@intelligentgraphics/openconfiguration",
-  "version": "1.2.6",
-  "description": "OpenConfiguration 1.2.6 (1.2.6.100)",
+  "version": "1.3.0",
+  "description": "OpenConfiguration 1.3.0 (1.3.0.100)",
   "license": "./LICENSE",
@@ -10,7 +10,7 @@ "publishConfig": {
   "devDependencies": {
-    "@wessberg/rollup-plugin-ts": "^1.3.4",
     "rimraf": "^3.0.2",
-    "rollup": "^2.18.0",
+    "rollup": "^2.63.0",
+    "rollup-plugin-ts": "^2.0.4",
     "typedoc": "^0.18.0",
-    "typescript": "^4.0.2"
+    "typescript": "^4.5.4"
   },
@@ -17,0 +17,0 @@ "types": "dist/index.d.ts",

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

111941

increased by30.42%

Number of package files

32

increased by433.33%

Lines of code

3171

increased by34.25%

Number of lines in readme file

210

increased by2.44%

No dependency changes