imposium-js-sdk 2.4.0 → 3.0.0

package/.eslintrc.js

@@ -0,0 +1,168 @@
+/*
+👋 Hi! This file was autogenerated by tslint-to-eslint-config.
+https://github.com/typescript-eslint/tslint-to-eslint-config
+
+It represents the closest reasonable ESLint configuration to this
+project's original TSLint configuration.
+
+We recommend eventually switching this configuration to extend from
+the recommended rulesets in typescript-eslint. 
+https://github.com/typescript-eslint/tslint-to-eslint-config/blob/master/docs/FAQs.md
+
+Happy linting! 💖
+*/
+module.exports = {
+    "env": {
+        "browser": true,
+        "node": true
+    },
+    "extends": [
+        "plugin:@typescript-eslint/recommended",
+        "plugin:@typescript-eslint/recommended-requiring-type-checking"
+    ],
+    "parser": "@typescript-eslint/parser",
+    "parserOptions": {
+        "project": "tsconfig.json",
+        "sourceType": "module"
+    },
+    "plugins": [
+        "eslint-plugin-import",
+        "eslint-plugin-jsdoc",
+        "eslint-plugin-prefer-arrow",
+        "@typescript-eslint"
+    ],
+    "rules": {
+        "@typescript-eslint/adjacent-overload-signatures": "error",
+        "@typescript-eslint/array-type": [
+            "error",
+            {
+                "default": "array"
+            }
+        ],
+        "@typescript-eslint/ban-types": [
+            "error",
+            {
+                "types": {
+                    "Object": {
+                        "message": "Avoid using the `Object` type. Did you mean `object`?"
+                    },
+                    "Function": {
+                        "message": "Avoid using the `Function` type. Prefer a specific function type, like `() => void`."
+                    },
+                    "Boolean": {
+                        "message": "Avoid using the `Boolean` type. Did you mean `boolean`?"
+                    },
+                    "Number": {
+                        "message": "Avoid using the `Number` type. Did you mean `number`?"
+                    },
+                    "String": {
+                        "message": "Avoid using the `String` type. Did you mean `string`?"
+                    },
+                    "Symbol": {
+                        "message": "Avoid using the `Symbol` type. Did you mean `symbol`?"
+                    }
+                }
+            }
+        ],
+        "@typescript-eslint/consistent-type-assertions": "error",
+        "@typescript-eslint/dot-notation": "off",
+        "@typescript-eslint/no-unsafe-argument": "off",
+        "@typescript-eslint/no-unsafe-call": "off",
+        "@typescript-eslint/no-unsafe-assignment": "off",
+        "@typescript-eslint/no-empty-function": "error",
+        "@typescript-eslint/no-inferrable-types":"off",
+        "@typescript-eslint/restrict-template-expressions":"off",
+        "@typescript-eslint/no-unsafe-member-access":"off",
+        "@typescript-eslint/no-unsafe-return":"off",
+        "@typescript-eslint/no-empty-interface": "error",
+        "@typescript-eslint/no-explicit-any": "off",
+        "@typescript-eslint/no-misused-new": "error",
+        "@typescript-eslint/no-namespace": "error",
+        "@typescript-eslint/no-parameter-properties": "off",
+        "@typescript-eslint/no-shadow": [
+            "error",
+            {
+                "hoist": "all"
+            }
+        ],
+        "@typescript-eslint/no-unused-expressions": "error",
+        "@typescript-eslint/no-use-before-define": "off",
+        "@typescript-eslint/no-var-requires": "off",
+        "@typescript-eslint/prefer-for-of": "error",
+        "@typescript-eslint/prefer-function-type": "error",
+        "@typescript-eslint/prefer-namespace-keyword": "error",
+        "@typescript-eslint/quotes": [
+            "error",
+            "single",
+            {
+              "allowTemplateLiterals": true
+            }
+        ],
+        "@typescript-eslint/triple-slash-reference": [
+            "error",
+            {
+                "path": "always",
+                "types": "prefer-import",
+                "lib": "always"
+            }
+        ],
+        "@typescript-eslint/unified-signatures": "error",
+        "comma-dangle": "off",
+        "complexity": "off",
+        "constructor-super": "error",
+        "dot-notation": "off",
+        "eqeqeq": [
+            "error",
+            "smart"
+        ],
+        "guard-for-in": "error",
+        "id-denylist": "error",
+        "id-match": "error",
+        "import/order": "off",
+        "jsdoc/check-alignment": "error",
+        "jsdoc/check-indentation": "error",
+        "jsdoc/newline-after-description": "error",
+        "max-classes-per-file": "off",
+        "new-parens": "error",
+        "no-bitwise": "off",
+        "no-caller": "error",
+        "no-cond-assign": "error",
+        "no-console": "off",
+        "no-debugger": "error",
+        "no-empty": "error",
+        "no-empty-function": "error",
+        "no-eval": "error",
+        "no-fallthrough": "off",
+        "no-invalid-this": "off",
+        "no-new-wrappers": "error",
+        "no-shadow": "error",
+        "no-throw-literal": "error",
+        "no-trailing-spaces": "error",
+        "no-undef-init": "error",
+        "no-underscore-dangle": "error",
+        "no-unsafe-finally": "error",
+        "no-unused-expressions": "error",
+        "no-unused-labels": "error",
+        "no-use-before-define": "off",
+        "no-var": "error",
+        "object-shorthand": "error",
+        "one-var": [
+            "error",
+            "never"
+        ],
+        "prefer-arrow/prefer-arrow-functions": "error",
+        "prefer-const": "error",
+        "radix": "error",
+        "spaced-comment": [
+            "error",
+            "always",
+            {
+                "markers": [
+                    "/"
+                ]
+            }
+        ],
+        "use-isnan": "error",
+        "valid-typeof": "off"
+    }
+};

package/examples/web/barebones.html

@@ -52,7 +52,8 @@
 			//Create an instance of the Client and Player
 			var client = new Imposium.Client({
 				accessToken:'zooch5ja8fiejoojoo6AeQuahmex1wes',
-				storyId:'295a80d0-871c-4def-a579-8a375d6942fc'
+				storyId:'75e3ed80-7008-480e-ca39-6a3dab807fe9',
+				compositionId:'473df1b4-d9f5-4648-b08b-e0af03abb86e'
 			});
 			var player = new Imposium.Player(videoNode, client);
 
@@ -64,7 +65,7 @@
 				e.preventDefault();
 
 				//Create the Imposium Experience
-				client.createExperience({
+				client.renderExperience({
 					text:captionInput.value,
 				});
 			}

package/examples/web/basic-deeplink.html

@@ -50,7 +50,6 @@
         </div>
 
         <section id="player-wrapper">
-            <p id = "status"></p>
             <video id="dynamic-video" />
         </section>
 
@@ -61,22 +60,19 @@
             var btnSubmit = document.getElementById('btn-submit'),
                 videoNode = document.getElementById('dynamic-video'),
                 captionInput = document.getElementById('caption'),
-                statusField = document.getElementById('status'),
                 imageInput = document.getElementById('image');
 
             //Create an instance of the Client and Player
             var client = new Imposium.Client({
-                accessToken:'zooch5ja8fiejoojoo6AeQuahmex1wes',
-                storyId:'295a80d0-871c-4def-a579-8a375d6942fc'
-            });
+				accessToken:'zooch5ja8fiejoojoo6AeQuahmex1wes',
+				storyId:'75e3ed80-7008-480e-ca39-6a3dab807fe9',
+				compositionId:'473df1b4-d9f5-4648-b08b-e0af03abb86e'
+			});
 
             var player = new Imposium.Player(videoNode, client);
 
-            //Listen to the client STATUS_UPDATE event to populate the status field
-            client.on(Imposium.Events.STATUS_UPDATE, setStatus);
-
             //Listen for the EXPERIENCE_CREATED event to pull the experience ID and write it to the URL
-            client.on(Imposium.Events.EXPERIENCE_CREATED, gotExperience);
+            client.on(Imposium.Events.EXPERIENCE_CREATED, expCreated);
 
             //Listen for input event to trigger input validation
             captionInput.addEventListener('change', validateForm);
@@ -103,13 +99,9 @@
             }
 
             //Writes the experience ID to the URL
-            function gotExperience(e){
+            function expCreated(e){
                 window.location.hash = '#' + e.id;
-            }
-
-            //Set the content of the status update field
-            function setStatus(e){
-                statusField.innerHTML = e.status;
+                client.getExperience(e.id);
             }
 
             //Validate the two inputs in the inputs field, enable the submit button if they are filled out

package/examples/web/basic.html

@@ -50,7 +50,6 @@
 		</div>
 
 		<section id="player-wrapper">
-			<p id = "status"></p>
 			<video id="dynamic-video" />
 		</section>
 
@@ -61,19 +60,16 @@
 			var btnSubmit = document.getElementById('btn-submit'),
 				videoNode = document.getElementById('dynamic-video'),
 				captionInput = document.getElementById('caption'),
-				statusField = document.getElementById('status'),
 				imageInput = document.getElementById('image');
 
 			//Create an instance of the Client and Player
 			var client = new Imposium.Client({
 				accessToken:'zooch5ja8fiejoojoo6AeQuahmex1wes',
-				storyId:'295a80d0-871c-4def-a579-8a375d6942fc'
+				storyId:'75e3ed80-7008-480e-ca39-6a3dab807fe9',
+				compositionId:'473df1b4-d9f5-4648-b08b-e0af03abb86e'
 			});
 			var player = new Imposium.Player(videoNode, client);
 
-			//Listen to the client STATUS_UPDATE event to populate the status field
-			client.on(Imposium.Events.STATUS_UPDATE, setStatus);
-
 			//Listen for input event to trigger input validation
 			captionInput.addEventListener('change', validateForm);
 			imageInput.addEventListener('change', validateForm);
@@ -90,13 +86,7 @@
 				}
 
 				//Create the Imposium Experience
-				client.createExperience(inventory);
-			}
-
-			//Set the content of the status update field
-			function setStatus(e){
-
-				statusField.innerHTML = e.status;
+				client.renderExperience(inventory);
 			}
 
 			//Validate the two inputs in the inputs field, enable the submit button if they are filled out

package/examples/web/custom-player.html

@@ -51,7 +51,6 @@
         </div>
 
         <section id="player-wrapper">
-            <p id = "status"></p>
             <video id="dynamic-video" />
         </section>
 
@@ -62,21 +61,18 @@
             var btnSubmit = document.getElementById('btn-submit'),
                 videoNode = document.getElementById('dynamic-video'),
                 captionInput = document.getElementById('caption'),
-                statusField = document.getElementById('status'),
                 imageInput = document.getElementById('image');
 
             //Create an instance of the Client
             var client = new Imposium.Client({
                 accessToken:'zooch5ja8fiejoojoo6AeQuahmex1wes',
-                storyId:'295a80d0-871c-4def-a579-8a375d6942fc'
+                storyId:'75e3ed80-7008-480e-ca39-6a3dab807fe9',
+				compositionId:'473df1b4-d9f5-4648-b08b-e0af03abb86e'
             });
 
             //Enables imposium to capture playback metrics without our default video player
             client.captureAnalytics(videoNode);
 
-            //Listen to the client STATUS_UPDATE event to populate the status field
-            client.on(Imposium.Events.STATUS_UPDATE, setStatus);
-
             //Listen to the client GOT_EXPERIENE event to get the video URLs
             client.on(Imposium.Events.GOT_EXPERIENCE, gotExperience);
 
@@ -96,18 +92,13 @@
                 }
 
                 // Create the Imposium Experience
-                client.createExperience(inventory);
+                client.renderExperience(inventory);
             }
 
             function gotExperience(data) {
                 videoNode.src = data.output.videos['mp4_720'].url;
             }
 
-            //Set the content of the status update field
-            function setStatus(e){
-                statusField.innerHTML = e.status;
-            }
-
             //Validate the two inputs in the inputs field, enable the submit button if they are filled out
             function validateForm(){
 

package/examples/web/landing-page.html

@@ -17,7 +17,6 @@
         </header>
 
         <section id="player-wrapper">
-            <p id = "status"></p>
             <video id="dynamic-video" />
         </section>
 
@@ -33,7 +32,8 @@
             //Create an instance of the Client and Player
             var client = new Imposium.Client({
                 accessToken:'zooch5ja8fiejoojoo6AeQuahmex1wes',
-                storyId:'295a80d0-871c-4def-a579-8a375d6942fc'
+                storyId:'75e3ed80-7008-480e-ca39-6a3dab807fe9',
+				compositionId:'473df1b4-d9f5-4648-b08b-e0af03abb86e'
             });
             var player = new Imposium.Player(videoNode, client);
 

package/examples/web/player-controls.html

@@ -18,7 +18,6 @@
         </header>
 
         <section id="player-wrapper">
-            <p id = "status"></p>
             <video id="dynamic-video" />
         </section>
 
@@ -65,7 +64,8 @@
             //Create an instance of the Client
             var client = new Imposium.Client({
                 accessToken:'zooch5ja8fiejoojoo6AeQuahmex1wes',
-                storyId:'295a80d0-871c-4def-a579-8a375d6942fc'
+                storyId:'75e3ed80-7008-480e-ca39-6a3dab807fe9',
+				compositionId:'473df1b4-d9f5-4648-b08b-e0af03abb86e'
             });
 
             //Turns off default media controls

package/examples/web/two-stage-rendering.html

@@ -50,7 +50,6 @@
         </div>
 
         <section id="player-wrapper">
-            <p id = "status"></p>
             <video id="dynamic-video" />
         </section>
 
@@ -61,19 +60,16 @@
             var btnSubmit = document.getElementById('btn-submit'),
                 videoNode = document.getElementById('dynamic-video'),
                 captionInput = document.getElementById('caption'),
-                statusField = document.getElementById('status'),
                 imageInput = document.getElementById('image');
 
             //Create an instance of the Client and Player
             var client = new Imposium.Client({
                 accessToken:'zooch5ja8fiejoojoo6AeQuahmex1wes',
-                storyId:'295a80d0-871c-4def-a579-8a375d6942fc'
+                storyId:'75e3ed80-7008-480e-ca39-6a3dab807fe9',
+				compositionId:'473df1b4-d9f5-4648-b08b-e0af03abb86e'
             });
             var player = new Imposium.Player(videoNode, client);
 
-            //Listen to the client STATUS_UPDATE event to populate the status field
-            client.on(Imposium.Events.STATUS_UPDATE, setStatus);
-
             //Listen to the client EXPERIENCE_CREATED event to get the experience ID
             client.on(Imposium.Events.EXPERIENCE_CREATED, experienceCreated);
 
@@ -102,7 +98,7 @@
                 }
 
                 //Create the Imposium Experience. The false parameter will prevent the video render from beginning
-                client.createExperience(inventory, false);
+                client.createExperience(inventory);
             }
 
             function experienceCreated(e){
@@ -111,12 +107,6 @@
                 client.getExperience(e.id);
             }
 
-            //Set the content of the status update field
-            function setStatus(e){
-
-                statusField.innerHTML = e.status;
-            }
-
             //Validate the two inputs in the inputs field, enable the submit button if they are filled out
             function validateForm(){
 

package/examples/web/uploaded-image-blob.html

@@ -63,7 +63,6 @@
         </button>   
 
         <section id="player-wrapper">
-            <p id = "status"></p>
             <video id="dynamic-video" />
         </section>
 
@@ -74,7 +73,6 @@
             var btnSubmit = document.getElementById('btn-submit'),
                 videoNode = document.getElementById('dynamic-video'),
                 captionInput = document.getElementById('caption'),
-                statusField = document.getElementById('status'),
                 imageInput = document.getElementById('image'),
                 imgCanvas = document.getElementById('img-canvas'),
                 ctx = imgCanvas.getContext('2d'),
@@ -88,7 +86,8 @@
             //Create an instance of the Client and Player
             var client = new Imposium.Client({
                 accessToken:'zooch5ja8fiejoojoo6AeQuahmex1wes',
-                storyId:'295a80d0-871c-4def-a579-8a375d6942fc'
+                storyId:'75e3ed80-7008-480e-ca39-6a3dab807fe9',
+				compositionId:'473df1b4-d9f5-4648-b08b-e0af03abb86e'
             });
             var player = new Imposium.Player(videoNode, client);
 
@@ -103,9 +102,6 @@
                 offset = 10,
                 imgScale = 1;
 
-            //Listen to the client STATUS_UPDATE event to populate the status field
-            client.on(Imposium.Events.STATUS_UPDATE, setStatus);
-
             //Listen for input event to trigger input validation
             captionInput.addEventListener('change', validateForm);
             imageInput.addEventListener('change', imageUploaded);
@@ -134,7 +130,7 @@
                     }
 
                     //Create the Imposium Experience
-                    client.createExperience(inventory);
+                    client.renderExperience(inventory);
                 });
             }
 
@@ -229,12 +225,6 @@
                 }
             }
 
-            //Set the content of the status update field
-            function setStatus(e){
-
-                statusField.innerHTML = e.status;
-            }
-
             //Validate the two inputs in the inputs field, enable the submit button if they are filled out
             function validateForm(){
 

package/examples/web/webcam-image-blob.html

@@ -54,7 +54,6 @@
         </button>
 
         <section id="player-wrapper">
-            <p id = "status"></p>
             <video id="dynamic-video" />
         </section>
 
@@ -66,14 +65,14 @@
                 btnCapture = document.getElementById('btn-capture'),
                 videoNode = document.getElementById('dynamic-video'),
                 captionInput = document.getElementById('caption'),
-                statusField = document.getElementById('status'),
                 captureNode = document.getElementById('capture-video'),
                 captureCanvas = document.getElementById('capture-canvas');
 
             //Create an instance of the Client and Player
             var client = new Imposium.Client({
                 accessToken:'zooch5ja8fiejoojoo6AeQuahmex1wes',
-                storyId:'295a80d0-871c-4def-a579-8a375d6942fc'
+                storyId:'75e3ed80-7008-480e-ca39-6a3dab807fe9',
+				compositionId:'473df1b4-d9f5-4648-b08b-e0af03abb86e'
             });
             var player = new Imposium.Player(videoNode, client);
 
@@ -90,9 +89,6 @@
                 }
             };
 
-            //Listen to the client STATUS_UPDATE event to populate the status field
-            client.on(Imposium.Events.STATUS_UPDATE, setStatus);
-
             //Listen for input event to trigger input validation
             captionInput.addEventListener('input', validateForm);
             btnSubmit.addEventListener('click', submit);
@@ -115,7 +111,7 @@
                     }
 
                     //Create the Imposium Experience
-                    client.createExperience(inventory);
+                    client.renderExperience(inventory);
                 });
             }
 
@@ -130,12 +126,6 @@
                 validateForm();
             }
 
-            //Set the content of the status update field
-            function setStatus(e){
-
-                statusField.innerHTML = e.status;
-            }
-
             //Validate the two inputs in the inputs field, enable the submit button if they are filled out.
             function validateForm(){