@plattar/plattar-ar-adapter 1.130.2 → 1.132.1

package/dist/ar/product-ar.d.ts

@@ -6,10 +6,12 @@ export declare class ProductAR extends LauncherAR {
     private _analytics;
     private readonly _productID;
     private readonly _variationID;
+    private readonly _variationSKU;
     private _ar;
-    constructor(productID?: string | undefined | null, variationID?: string | undefined | null);
+    constructor(productID?: string | undefined | null, variationID?: string | undefined | null, variationSKU?: string | undefined | null);
     get productID(): string;
-    get variationID(): string;
+    get variationID(): string | null;
+    get variationSKU(): string | null;
     private _SetupAnalytics;
     /**
      * Initialise the ProductAR instance. This returns a Promise that resolves

package/dist/ar/product-ar.js

@@ -15,7 +15,7 @@ const launcher_ar_1 = require("./launcher-ar");
  * Performs AR functionality related to Plattar Products and Variation types
  */
 class ProductAR extends launcher_ar_1.LauncherAR {
-    constructor(productID = null, variationID = null) {
+    constructor(productID = null, variationID = null, variationSKU = null) {
         super();
         // analytics instance
         this._analytics = null;
@@ -23,7 +23,8 @@ class ProductAR extends launcher_ar_1.LauncherAR {
             throw new Error("ProductAR.constructor(productID, variationID) - productID must be defined");
         }
         this._productID = productID;
-        this._variationID = variationID ? variationID : "default";
+        this._variationSKU = variationSKU;
+        this._variationID = variationID ? variationID : (variationSKU ? null : "default");
         this._ar = null;
     }
     get productID() {
@@ -32,6 +33,9 @@ class ProductAR extends launcher_ar_1.LauncherAR {
     get variationID() {
         return this._variationID;
     }
+    get variationSKU() {
+        return this._variationSKU;
+    }
     _SetupAnalytics(product, variation) {
         let analytics = null;
         const scene = product.relationships.find(plattar_api_1.Scene);
@@ -80,14 +84,27 @@ class ProductAR extends launcher_ar_1.LauncherAR {
             product.include(plattar_api_1.Scene.include(plattar_api_1.Project));
             product.get().then((product) => {
                 // find the required variation from our product
-                const variationID = this.variationID ? (this.variationID === "default" ? product.attributes.product_variation_id : this.variationID) : product.attributes.product_variation_id;
-                if (!variationID) {
-                    return reject(new Error("ProductAR.init() - cannot proceed as variation was not defined correctly"));
+                const variationID = this.variationID ? (this.variationID === "default" ? product.attributes.product_variation_id : this.variationID) : null;
+                const variationSKU = this.variationSKU;
+                if (!variationID && !variationSKU) {
+                    return reject(new Error("ProductAR.init() - cannot proceed as variation-id or variation-sku was not set correctly"));
+                }
+                let variation = undefined;
+                if (variationID) {
+                    variation = product.relationships.find(plattar_api_1.ProductVariation, variationID);
+                }
+                // if no variation was found with variationID - try searching variation sku
+                if (!variation && variationSKU) {
+                    const variations = product.relationships.filter(plattar_api_1.ProductVariation);
+                    if (variations) {
+                        variation = variations.find((element) => {
+                            return element.attributes.sku === variationSKU;
+                        });
+                    }
                 }
-                const variation = product.relationships.find(plattar_api_1.ProductVariation, variationID);
                 // make sure our variation is actually available before moving forward
                 if (!variation) {
-                    return reject(new Error("ProductAR.init() - cannot proceed as variation with id " + variationID + " cannot be found"));
+                    return reject(new Error("ProductAR.init() - cannot proceed as variation with id " + variationID + " or sku " + variationSKU + " cannot be found"));
                 }
                 // otherwise both the product and variation are available
                 // we need to figure out if we can actually do AR though

package/dist/ar/scene-product-ar.d.ts

@@ -7,7 +7,7 @@ import { LauncherAR } from "./launcher-ar";
 export declare class SceneProductAR extends ProductAR {
     private readonly _sceneProductID;
     private _attachedProductID;
-    constructor(sceneProductID?: string | undefined | null, variationID?: string | undefined | null);
+    constructor(sceneProductID?: string | undefined | null, variationID?: string | undefined | null, variationSKU?: string | undefined | null);
     get sceneProductID(): string;
     get productID(): string;
     init(): Promise<LauncherAR>;

package/dist/ar/scene-product-ar.js

@@ -9,8 +9,8 @@ const util_1 = require("../util/util");
  * SceneProducts are much more convenient to grab from the Plattar CMS
  */
 class SceneProductAR extends product_ar_1.ProductAR {
-    constructor(sceneProductID = null, variationID = null) {
-        super(sceneProductID, variationID);
+    constructor(sceneProductID = null, variationID = null, variationSKU = null) {
+        super(sceneProductID, variationID, variationSKU);
         // this is evaluated in the init() function
         this._attachedProductID = null;
         if (!sceneProductID) {

package/dist/embed/controllers/configurator-controller.js

@@ -30,7 +30,7 @@ class ConfiguratorController extends plattar_controller_1.PlattarController {
             this.removeRenderer();
             const sceneID = this.getAttribute("scene-id");
             if (sceneID) {
-                const opt = options || plattar_controller_1.PlattarController.DEFAULT_QR_OPTIONS;
+                const opt = options || this._GetDefaultQROptions();
                 const viewer = document.createElement("plattar-qrcode");
                 // required attributes with defaults for plattar-viewer node
                 const width = this.getAttribute("width") || "500px";
@@ -46,10 +46,15 @@ class ConfiguratorController extends plattar_controller_1.PlattarController {
                 if (opt.qrType) {
                     viewer.setAttribute("qr-type", opt.qrType);
                 }
+                viewer.setAttribute("shorten", (opt.shorten && (opt.shorten === true || opt.shorten === "true")) ? "true" : "false");
                 let dst = plattar_api_1.Server.location().base + "renderer/configurator.html?scene_id=" + sceneID;
                 // optional attributes
                 const configState = this.getAttribute("config-state");
                 const showAR = this.getAttribute("show-ar");
+                const showUI = this.getAttribute("show-ui");
+                if (showUI && showUI === "true") {
+                    dst = plattar_api_1.Server.location().base + "configurator/dist/index.html?scene_id=" + sceneID;
+                }
                 if (configState) {
                     dst += "&config_state=" + configState;
                 }
@@ -87,12 +92,16 @@ class ConfiguratorController extends plattar_controller_1.PlattarController {
                 // optional attributes
                 const configState = this.getAttribute("config-state");
                 const showAR = this.getAttribute("show-ar");
+                const showUI = this.getAttribute("show-ui");
                 if (configState) {
                     viewer.setAttribute("config-state", configState);
                 }
                 if (showAR) {
                     viewer.setAttribute("show-ar", showAR);
                 }
+                if (showUI) {
+                    viewer.setAttribute("show-ui", showUI);
+                }
                 viewer.onload = () => {
                     return accept(viewer);
                 };

package/dist/embed/controllers/plattar-controller.d.ts

@@ -11,7 +11,7 @@ export declare abstract class PlattarController {
     /**
      * Default QR Code rendering options
      */
-    static get DEFAULT_QR_OPTIONS(): any;
+    protected _GetDefaultQROptions(): any;
     private readonly _parent;
     protected _state: ControllerState;
     protected _element: HTMLElement | null;

package/dist/embed/controllers/plattar-controller.js

@@ -21,10 +21,11 @@ class PlattarController {
     /**
      * Default QR Code rendering options
      */
-    static get DEFAULT_QR_OPTIONS() {
+    _GetDefaultQROptions() {
         return {
-            color: "#101721",
-            qrType: "default",
+            color: this.getAttribute("qr-color") || "#101721",
+            qrType: this.getAttribute("qr-style") || "default",
+            shorten: this.getAttribute("qr-shorten") || false,
             margin: 0
         };
     }
@@ -64,7 +65,7 @@ class PlattarController {
         return new Promise((accept, reject) => {
             // remove the old renderer instance if any
             this.removeRenderer();
-            const opt = options || PlattarController.DEFAULT_QR_OPTIONS;
+            const opt = options || this._GetDefaultQROptions();
             const viewer = document.createElement("plattar-qrcode");
             // required attributes with defaults for plattar-viewer node
             const width = this.getAttribute("width") || "500px";
@@ -80,6 +81,7 @@ class PlattarController {
             if (opt.qrType) {
                 viewer.setAttribute("qr-type", opt.qrType);
             }
+            viewer.setAttribute("shorten", (opt.shorten && (opt.shorten === true || opt.shorten === "true")) ? "true" : "false");
             const qrOptions = btoa(JSON.stringify(opt));
             let dst = plattar_api_1.Server.location().base + "renderer/launcher.html?qr_options=" + qrOptions;
             const sceneID = this.getAttribute("scene-id");
@@ -88,6 +90,7 @@ class PlattarController {
             const productID = this.getAttribute("product-id");
             const sceneProductID = this.getAttribute("scene-product-id");
             const variationID = this.getAttribute("variation-id");
+            const variationSKU = this.getAttribute("variation-sku");
             const arMode = this.getAttribute("ar-mode");
             if (configState) {
                 dst += "&config_state=" + configState;
@@ -104,6 +107,9 @@ class PlattarController {
             if (variationID) {
                 dst += "&variation_id=" + variationID;
             }
+            if (variationSKU) {
+                dst += "&variation_sku=" + variationSKU;
+            }
             if (arMode) {
                 dst += "&ar_mode=" + arMode;
             }

package/dist/embed/controllers/product-controller.js

@@ -37,7 +37,7 @@ class ProductController extends plattar_controller_1.PlattarController {
             this.removeRenderer();
             const productID = this.getAttribute("product-id");
             if (productID) {
-                const opt = options || plattar_controller_1.PlattarController.DEFAULT_QR_OPTIONS;
+                const opt = options || this._GetDefaultQROptions();
                 const viewer = document.createElement("plattar-qrcode");
                 // required attributes with defaults for plattar-viewer node
                 const width = this.getAttribute("width") || "500px";
@@ -53,12 +53,17 @@ class ProductController extends plattar_controller_1.PlattarController {
                 if (opt.qrType) {
                     viewer.setAttribute("qr-type", opt.qrType);
                 }
+                viewer.setAttribute("shorten", (opt.shorten && (opt.shorten === true || opt.shorten === "true")) ? "true" : "false");
                 // optional attributes
                 const variationID = this.getAttribute("variation-id");
+                const variationSKU = this.getAttribute("variation-sku");
                 const showAR = this.getAttribute("show-ar");
                 let dst = plattar_api_1.Server.location().base + "renderer/product.html?product_id=" + productID;
                 if (variationID) {
-                    dst += "&variation_id=" + variationID;
+                    dst += "&variationId=" + variationID;
+                }
+                if (variationSKU) {
+                    dst += "&variationSku=" + variationSKU;
                 }
                 if (showAR) {
                     dst += "&show_ar=" + showAR;
@@ -93,10 +98,14 @@ class ProductController extends plattar_controller_1.PlattarController {
                 viewer.setAttribute("product-id", productID);
                 // optional attributes
                 const variationID = this.getAttribute("variation-id");
+                const variationSKU = this.getAttribute("variation-sku");
                 const showAR = this.getAttribute("show-ar");
                 if (variationID) {
                     viewer.setAttribute("variation-id", variationID);
                 }
+                if (variationSKU) {
+                    viewer.setAttribute("variation-sku", variationSKU);
+                }
                 if (showAR) {
                     viewer.setAttribute("show-ar", showAR);
                 }
@@ -119,7 +128,8 @@ class ProductController extends plattar_controller_1.PlattarController {
             const productID = this.getAttribute("product-id");
             if (productID) {
                 const variationID = this.getAttribute("variation-id");
-                const product = new product_ar_1.ProductAR(productID, variationID);
+                const variationSKU = this.getAttribute("variation-sku");
+                const product = new product_ar_1.ProductAR(productID, variationID, variationSKU);
                 return product.init().then(accept).catch(reject);
             }
             return reject(new Error("ProductController.initAR() - minimum required attributes not set, use product-id as a minimum"));

package/dist/embed/controllers/viewer-controller.js

@@ -5,6 +5,7 @@ const plattar_api_1 = require("@plattar/plattar-api");
 const product_ar_1 = require("../../ar/product-ar");
 const scene_ar_1 = require("../../ar/scene-ar");
 const scene_product_ar_1 = require("../../ar/scene-product-ar");
+const configurator_state_1 = require("../../util/configurator-state");
 const util_1 = require("../../util/util");
 const plattar_controller_1 = require("./plattar-controller");
 /**
@@ -40,7 +41,7 @@ class ViewerController extends plattar_controller_1.PlattarController {
             this.removeRenderer();
             const sceneID = this.getAttribute("scene-id");
             if (sceneID) {
-                const opt = options || plattar_controller_1.PlattarController.DEFAULT_QR_OPTIONS;
+                const opt = options || this._GetDefaultQROptions();
                 const viewer = document.createElement("plattar-qrcode");
                 // required attributes with defaults for plattar-viewer node
                 const width = this.getAttribute("width") || "500px";
@@ -56,10 +57,12 @@ class ViewerController extends plattar_controller_1.PlattarController {
                 if (opt.qrType) {
                     viewer.setAttribute("qr-type", opt.qrType);
                 }
+                viewer.setAttribute("shorten", (opt.shorten && (opt.shorten === true || opt.shorten === "true")) ? "true" : "false");
                 let dst = plattar_api_1.Server.location().base + "renderer/viewer.html?scene_id=" + sceneID;
                 // optional attributes
                 const productID = (this.getAttribute("product-id") || this.getAttribute("scene-product-id"));
                 const variationID = this.getAttribute("variation-id");
+                const variationSKU = this.getAttribute("variation-sku");
                 const showAR = this.getAttribute("show-ar");
                 if (productID) {
                     dst += "&productId=" + productID;
@@ -67,6 +70,9 @@ class ViewerController extends plattar_controller_1.PlattarController {
                 if (variationID) {
                     dst += "&variationId=" + variationID;
                 }
+                if (variationSKU) {
+                    dst += "&variationSku=" + variationSKU;
+                }
                 if (showAR) {
                     dst += "&show_ar=" + showAR;
                 }
@@ -101,6 +107,7 @@ class ViewerController extends plattar_controller_1.PlattarController {
                 // optional attributes
                 const productID = (this.getAttribute("product-id") || this.getAttribute("scene-product-id"));
                 const variationID = this.getAttribute("variation-id");
+                const variationSKU = this.getAttribute("variation-sku");
                 const showAR = this.getAttribute("show-ar");
                 if (productID) {
                     viewer.setAttribute("product-id", productID);
@@ -108,6 +115,9 @@ class ViewerController extends plattar_controller_1.PlattarController {
                 if (variationID) {
                     viewer.setAttribute("variation-id", variationID);
                 }
+                if (variationSKU) {
+                    viewer.setAttribute("variation-sku", variationSKU);
+                }
                 if (showAR) {
                     viewer.setAttribute("show-ar", showAR);
                 }
@@ -131,22 +141,39 @@ class ViewerController extends plattar_controller_1.PlattarController {
             // use product-id if available
             if (productID) {
                 const variationID = this.getAttribute("variation-id");
-                const product = new product_ar_1.ProductAR(productID, variationID);
+                const variationSKU = this.getAttribute("variation-sku");
+                const product = new product_ar_1.ProductAR(productID, variationID, variationSKU);
                 return product.init().then(accept).catch(reject);
             }
             const sceneProductID = this.getAttribute("scene-product-id");
             // use scene-product-id if available
             if (sceneProductID) {
                 const variationID = this.getAttribute("variation-id");
-                const product = new scene_product_ar_1.SceneProductAR(sceneProductID, variationID);
+                const variationSKU = this.getAttribute("variation-sku");
+                const product = new scene_product_ar_1.SceneProductAR(sceneProductID, variationID, variationSKU);
                 return product.init().then(accept).catch(reject);
             }
             const sceneID = this.getAttribute("scene-id");
             // fallback to using default SceneAR implementation
             if (sceneID) {
-                const sceneAR = new scene_ar_1.SceneAR(sceneID);
-                sceneAR.init().then(accept).catch(reject);
-                return;
+                // special case - check if scene only has a single product, if so
+                // we need to use provided variation-id or variation-sku to override
+                const variationID = this.getAttribute("variation-id");
+                const variationSKU = this.getAttribute("variation-sku");
+                // just do scene-ar if variation ID and variation SKU is not set
+                if (!variationID && !variationSKU) {
+                    const sceneAR = new scene_ar_1.SceneAR(sceneID);
+                    return sceneAR.init().then(accept).catch(reject);
+                }
+                // otherwise decode scene
+                return configurator_state_1.ConfiguratorState.decodeScene(sceneID).then((state) => {
+                    const firstProduct = state.first();
+                    if (state.length > 1 || !firstProduct) {
+                        return reject(new Error("ViewerController.initAR() - single product required to override variation-id or variation-sku"));
+                    }
+                    const product = new scene_product_ar_1.SceneProductAR(firstProduct.scene_product_id, variationID, variationSKU);
+                    return product.init().then(accept).catch(reject);
+                }).catch(reject);
             }
             return reject(new Error("ViewerController.initAR() - minimum required attributes not set, use scene-id as a minimum"));
         });

package/dist/embed/controllers/vto-controller.js

@@ -28,7 +28,7 @@ class VTOController extends plattar_controller_1.PlattarController {
             this.removeRenderer();
             const sceneID = this.getAttribute("scene-id");
             if (sceneID) {
-                const opt = options || plattar_controller_1.PlattarController.DEFAULT_QR_OPTIONS;
+                const opt = options || this._GetDefaultQROptions();
                 const viewer = document.createElement("plattar-qrcode");
                 // required attributes with defaults for plattar-viewer node
                 const width = this.getAttribute("width") || "500px";
@@ -44,6 +44,7 @@ class VTOController extends plattar_controller_1.PlattarController {
                 if (opt.qrType) {
                     viewer.setAttribute("qr-type", opt.qrType);
                 }
+                viewer.setAttribute("shorten", (opt.shorten && (opt.shorten === true || opt.shorten === "true")) ? "true" : "false");
                 let dst = plattar_api_1.Server.location().base + "renderer/facear.html?scene_id=" + sceneID;
                 // optional attributes
                 const configState = this.getAttribute("config-state");

package/dist/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "1.130.2";
+declare const _default: "1.132.1";
 export default _default;

package/dist/version.js

@@ -1,3 +1,3 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = "1.130.2";
+exports.default = "1.132.1";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plattar/plattar-ar-adapter",
-  "version": "1.130.2",
+  "version": "1.132.1",
   "description": "Plattar AR Adapter for interfacing with Google & Apple WebAR",
   "main": "dist/index.js",
   "module": "dist/index.js",
@@ -41,15 +41,15 @@
     "@plattar/plattar-api": "^1.120.1",
     "@plattar/plattar-qrcode": "1.122.1",
     "@plattar/plattar-services": "^1.120.1",
-    "@plattar/plattar-web": "^1.129.1"
+    "@plattar/plattar-web": "^1.131.1"
   },
   "devDependencies": {
     "@babel/cli": "^7.17.10",
-    "@babel/core": "^7.17.10",
-    "@babel/preset-env": "^7.17.10",
+    "@babel/core": "^7.18.5",
+    "@babel/preset-env": "^7.18.2",
     "browserify": "^17.0.0",
-    "typescript": "^4.6.4",
-    "uglify-js": "^3.15.5"
+    "typescript": "^4.7.3",
+    "uglify-js": "^3.16.0"
   },
   "publishConfig": {
     "access": "public"