@plattar/plattar-api - npm Package Compare versions

Comparing version 1.90.18 to 1.91.1

index.js

@@ -51,3 +51,9 @@ "use strict";
 const Tag = require("./types/misc/tag.js");
+const ApplicationBuild = require('./types/misc/application-build.js');
 
+// base types
+const SceneObject = require('./types/scene/scene-base.js');
+const CardObject = require('./types/page/card-base.js');
+const ProductObject = require('./types/product/product-base.js');
+
 // create a default server instance to be used globally
@@ -101,3 +107,8 @@ Server.create();
     ScriptEvent,
-    Tag
+    Tag,
+    ApplicationBuild,
+    // base types
+    SceneObject,
+    CardObject,
+    ProductObject
 }

package.json

 {
   "name": "@plattar/plattar-api",
-  "version": "1.90.18",
+  "version": "1.91.1",
   "description": "Module for interfacing with the Plattar API (https://www.plattar.com)",
   "main": "index.js",
   "module": "index.js",
-  "type": "module",
   "scripts": {
@@ -9,0 +8,0 @@ "test": "echo \"Error: no test specified\" && exit 1",

README.md

@@ -6,4 +6,4 @@ <h3 align="center">
 [![install size](https://packagephobia.com/badge?p=@plattar/plattar-api)](https://packagephobia.com/result?p=@plattar/plattar-api)
-[![Minified](https://img.shields.io/bundlephobia/min/@plattar/plattar-api)](https://www.npmjs.com/package/@plattar/plattar-api)
-[![MinZipped](https://img.shields.io/bundlephobia/minzip/@plattar/plattar-api)](https://www.npmjs.com/package/@plattar/plattar-api)
+[![Minified](https://badgen.net/bundlephobia/min/@plattar/plattar-api)](https://bundlephobia.com/result?p=@plattar/plattar-api)
+[![MinZipped](https://badgen.net/bundlephobia/minzip/@plattar/plattar-api)](https://bundlephobia.com/result?p=@plattar/plattar-api)
 [![NPM](https://img.shields.io/npm/v/@plattar/plattar-api)](https://www.npmjs.com/package/@plattar/plattar-api)
@@ -10,0 +10,0 @@ [![Codacy Badge](https://app.codacy.com/project/badge/Grade/fe92068bfbef4a1aae14ae55ecd297d1)](https://www.codacy.com/gh/Plattar/plattar-api?utm_source=github.com&utm_medium=referral&utm_content=Plattar/plattar-api&utm_campaign=Badge_Grade)

server/plattar-query.js

@@ -136,3 +136,10 @@ const fetch = require("node-fetch");
             else if (PlattarUtil.isPlattarObject(obj)) {
-                this._getIncludeQuery.push(obj.type());
+                const type = obj.type();
+
+                if (Array.isArray(type)) {
+                    this._include(type);
+                }
+                else {
+                    this._getIncludeQuery.push(type);
+                }
             }
@@ -183,3 +190,4 @@ else {
 PlattarQuery._SetGlobalCachedObject = (obj) => {
-    PlattarQuery._GlobalObjectCache[obj.id] = obj;
+    // enable after extensive testing - too many bugs
+    //PlattarQuery._GlobalObjectCache[obj.id] = obj;
 };
@@ -186,0 +194,0 @@

types/interfaces/plattar-object-relations.js

@@ -63,8 +63,25 @@ /**
 
+        const type = obj.type();
+
+        // for array objects, we do each individual object
+        if (Array.isArray(type)) {
+            var compiledList = [];
+
+            type.forEach((inObject) => {
+                const retArray = this.filter(inObject, id);
+
+                if (retArray.length > 0) {
+                    compiledList = compiledList.concat(retArray);
+                }
+            });
+
+            return compiledList;
+        }
+
         // check if the key actually exists in the relations
-        if (!this._relatedObjects.hasOwnProperty(obj.type())) {
+        if (!this._relatedObjects.hasOwnProperty(type)) {
             return [];
         }
 
-        const list = this._relatedObjects[obj.type()];
+        const list = this._relatedObjects[type];
 
@@ -71,0 +88,0 @@ // if no id is supplied, we just want everything of type

types/page/card-base.js

@@ -12,4 +12,20 @@ const PlattarBase = require("../interfaces/plattar-base.js");
     }
+
+    static type() {
+        const CardButton = require("./card-button.js");
+        const CardHTML = require("./card-html.js");
+        const CardIFrame = require("./card-iframe.js");
+        const CardImage = require("./card-image.js");
+        const CardMap = require("./card-map.js");
+        const CardParagraph = require("./card-paragraph.js");
+        const CardRow = require("./card-row.js");
+        const CardSlider = require("./card-slider.js");
+        const CardTitle = require("./card-title.js");
+        const CardVideo = require("./card-video.js");
+        const CardYoutube = require("./card-youtube.js");
+
+        return [CardButton, CardHTML, CardIFrame, CardImage, CardMap, CardParagraph, CardRow, CardSlider, CardTitle, CardVideo, CardYoutube];
+    }
 }
 
 module.exports = CardBase;

types/product/product-base.js

@@ -12,4 +12,11 @@ const PlattarBase = require("../interfaces/plattar-base.js");
     }
+
+    static type() {
+        const ProductVariation = require("./product-variation.js");
+        const ProductAnnotation = require("./product-annotation.js");
+
+        return [ProductAnnotation, ProductVariation];
+    }
 }
 
 module.exports = ProductBase;

types/scene/scene-base.js

@@ -12,4 +12,23 @@ const PlattarBase = require("../interfaces/plattar-base.js");
     }
+
+    static type() {
+        const SceneAnnotation = require("./scene-annotation.js");
+        const SceneAudio = require("./scene-audio.js");
+        const SceneButton = require("./scene-button.js");
+        const SceneCamera = require("./scene-camera.js");
+        const SceneCarousel = require("./scene-carousel.js");
+        const SceneImage = require("./scene-image.js");
+        const SceneModel = require("./scene-model.js");
+        const ScenePanorama = require("./scene-panorama.js");
+        const ScenePoller = require("./scene-poller.js");
+        const SceneProduct = require("./scene-product.js");
+        const SceneShadow = require("./scene-shadow.js");
+        const SceneVideo = require("./scene-video.js");
+        const SceneVolumetric = require("./scene-volumetric.js");
+        const SceneYoutube = require("./scene-youtube.js");
+
+        return [SceneAnnotation, SceneAudio, SceneButton, SceneCamera, SceneCarousel, SceneImage, SceneModel, ScenePanorama, ScenePoller, SceneProduct, SceneShadow, SceneVideo, SceneVolumetric, SceneYoutube];
+    }
 }
 
 module.exports = SceneBase;

util/plattar-util.js

@@ -48,2 +48,3 @@ const Application = require("../types/application.js");
 const Tag = require("../types/misc/tag.js");
+const ApplicationBuild = require("../types/misc/application-build.js");
 
@@ -188,2 +189,3 @@ class PlattarUtil { }
         case Tag.type(): return Tag;
+        case ApplicationBuild.type(): return ApplicationBuild;
         default: throw new Error("PlattarUtil.match(type) - provided type of \"" + type + "\" does not exist and cannot be created");
@@ -190,0 +192,0 @@ }

New alerts

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Minified code

Quality

This package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

47354

increased by10.15%

Number of package files

54

increased by5.88%

Lines of code

1067

increased by7.34%

Worsened metrics

Number of low quality alerts

3

increased by200%

Number of low supply chain risk alerts

4

increased byInfinity%

Is type module

No

No dependency changes