@plattar/plattar-ar-adapter 1.123.5 → 1.123.6

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

@@ -0,0 +1,14 @@
+import { ProductAR } from "./product-ar";
+import { LauncherAR } from "./launcher-ar";
+/**
+ * Allows launching Product AR by providing a SceneProduct ID instead.
+ * SceneProducts are much more convenient to grab from the Plattar CMS
+ */
+export declare class SceneProductAR extends ProductAR {
+    private readonly _sceneProductID;
+    private _attachedProductID;
+    constructor(sceneProductID?: string | undefined | null, variationID?: string | undefined | null);
+    get sceneProductID(): string;
+    get productID(): string;
+    init(): Promise<LauncherAR>;
+}

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

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SceneProductAR = void 0;
+const product_ar_1 = require("./product-ar");
+const plattar_api_1 = require("@plattar/plattar-api");
+const util_1 = require("../util/util");
+/**
+ * Allows launching Product AR by providing a SceneProduct ID instead.
+ * 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);
+        // this is evaluated in the init() function
+        this._attachedProductID = null;
+        if (!sceneProductID) {
+            throw new Error("SceneProductAR.constructor(sceneProductID, variationID) - sceneProductID must be defined");
+        }
+        this._sceneProductID = sceneProductID;
+    }
+    get sceneProductID() {
+        return this._sceneProductID;
+    }
+    get productID() {
+        if (!this._attachedProductID) {
+            throw new Error("SceneProductAR.productID() - product id was not defined, did you call init()?");
+        }
+        return this._attachedProductID;
+    }
+    init() {
+        return new Promise((accept, reject) => {
+            if (!util_1.Util.canAugment()) {
+                return reject(new Error("SceneProductAR.init() - cannot proceed as AR not available in context"));
+            }
+            const sceneProduct = new plattar_api_1.SceneProduct(this.sceneProductID);
+            sceneProduct.get().then((sceneProduct) => {
+                const productID = sceneProduct.attributes.product_id;
+                if (!productID) {
+                    return reject("SceneProductAR.init() - Scene Product does not have an attached Product instance");
+                }
+                this._attachedProductID = productID;
+                // execute the standard Product AR functionality
+                return super.init().then(accept).catch(reject);
+            }).catch(reject);
+        });
+    }
+}
+exports.SceneProductAR = SceneProductAR;

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

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ViewerController = void 0;
 const plattar_api_1 = require("@plattar/plattar-api");
 const product_ar_1 = require("../../ar/product-ar");
+const scene_product_ar_1 = require("../../ar/scene-product-ar");
 const util_1 = require("../../util/util");
 const plattar_controller_1 = require("./plattar-controller");
 /**
@@ -26,7 +27,7 @@ class ViewerController extends plattar_controller_1.PlattarController {
         if (state === plattar_controller_1.ControllerState.Renderer) {
             const viewer = this._element;
             if (viewer) {
-                const productID = this.getAttribute("product-id");
+                const productID = (this.getAttribute("product-id") || this.getAttribute("scene-product-id"));
                 const variationID = this.getAttribute("variation-id");
                 if (productID && variationID && viewer.messenger) {
                     viewer.messenger.selectVariation(productID, variationID);
@@ -59,7 +60,7 @@ class ViewerController extends plattar_controller_1.PlattarController {
                 }
                 let dst = plattar_api_1.Server.location().base + "renderer/viewer.html?scene_id=" + sceneID;
                 // optional attributes
-                const productID = this.getAttribute("product-id");
+                const productID = (this.getAttribute("product-id") || this.getAttribute("scene-product-id"));
                 const variationID = this.getAttribute("variation-id");
                 if (productID) {
                     dst += "&productId=" + productID;
@@ -96,7 +97,7 @@ class ViewerController extends plattar_controller_1.PlattarController {
                 viewer.setAttribute("server", server);
                 viewer.setAttribute("scene-id", sceneID);
                 // optional attributes
-                const productID = this.getAttribute("product-id");
+                const productID = (this.getAttribute("product-id") || this.getAttribute("scene-product-id"));
                 const variationID = this.getAttribute("variation-id");
                 if (productID) {
                     viewer.setAttribute("product-id", productID);
@@ -121,17 +122,25 @@ class ViewerController extends plattar_controller_1.PlattarController {
                 return reject(new Error("ViewerController.initAR() - cannot proceed as AR not available in context"));
             }
             const productID = this.getAttribute("product-id");
+            // use product-id if available
             if (productID) {
                 const variationID = this.getAttribute("variation-id");
                 const product = new product_ar_1.ProductAR(productID, variationID);
                 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);
+                return product.init().then(accept).catch(reject);
+            }
             const sceneID = this.getAttribute("scene-id");
             // otherwise, scene was set so use SceneAR
             if (sceneID) {
-                return reject(new Error("ViewerController.initAR() - AR mode for scene-id not yet supported, use product-id"));
+                return reject(new Error("ViewerController.initAR() - AR mode for scene-id not yet supported, use product-id or scene-product-id"));
             }
-            return reject(new Error("ViewerController.initAR() - minimum required attributes not set, use scene-id or product-id as a minimum"));
+            return reject(new Error("ViewerController.initAR() - minimum required attributes not set, use product-id or scene-product-id as a minimum"));
         });
     }
     removeRenderer() {

package/dist/index.d.ts

@@ -2,6 +2,7 @@ export * as PlattarWeb from "@plattar/plattar-web";
 export * as PlattarQRCode from "@plattar/plattar-qrcode";
 export * as version from "./version";
 export { ProductAR } from "./ar/product-ar";
+export { SceneProductAR } from "./ar/scene-product-ar";
 export { SceneAR } from "./ar/scene-ar";
 export { ModelAR } from "./ar/model-ar";
 export { RawAR } from "./ar/raw-ar";

package/dist/index.js

@@ -22,12 +22,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConfiguratorState = exports.Util = exports.RawAR = exports.ModelAR = exports.SceneAR = exports.ProductAR = exports.version = exports.PlattarQRCode = exports.PlattarWeb = void 0;
+exports.ConfiguratorState = exports.Util = exports.RawAR = exports.ModelAR = exports.SceneAR = exports.SceneProductAR = exports.ProductAR = exports.version = exports.PlattarQRCode = exports.PlattarWeb = void 0;
 exports.PlattarWeb = __importStar(require("@plattar/plattar-web"));
 exports.PlattarQRCode = __importStar(require("@plattar/plattar-qrcode"));
 exports.version = __importStar(require("./version"));
 var product_ar_1 = require("./ar/product-ar");
 Object.defineProperty(exports, "ProductAR", { enumerable: true, get: function () { return product_ar_1.ProductAR; } });
+var scene_product_ar_1 = require("./ar/scene-product-ar");
+Object.defineProperty(exports, "SceneProductAR", { enumerable: true, get: function () { return scene_product_ar_1.SceneProductAR; } });
 var scene_ar_1 = require("./ar/scene-ar");
 Object.defineProperty(exports, "SceneAR", { enumerable: true, get: function () { return scene_ar_1.SceneAR; } });
 var model_ar_1 = require("./ar/model-ar");

package/dist/version.d.ts

@@ -1,2 +1,2 @@
-declare const _default: "1.123.5";
+declare const _default: "1.123.6";
 export default _default;

package/dist/version.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@plattar/plattar-ar-adapter",
-  "version": "1.123.5",
+  "version": "1.123.6",
   "description": "Plattar AR Adapter for interfacing with Google & Apple WebAR",
   "main": "dist/index.js",
   "module": "dist/index.js",