videomail-client 13.6.11 → 13.6.13

package/README.md

@@ -42,7 +42,7 @@ That's it. Easy as apple pie.
 
 ## Demo
 
-A mirror of latest videomail-client can be seen on [videomail-client.netlify.com](https://videomail-client.netlify.com/)
+A mirror of latest videomail-client can be seen on [videomail-client.netlify.app](https://videomail-client.netlify.app)
 
 ### Real world usages
 
@@ -59,7 +59,7 @@ There are plenty if you just ask us. And way more will follow, we are rolling ..
 
 There are many options you can pass onto the VideomailClient constructor. Check out the annotated source code at [src/options.ts](https://github.com/binarykitchen/videomail-client/blob/master/src/options.ts)
 
-In most cases, these defaults are good enough. But `siteName` should be changed when you deploy your own site, see <a href="#whitelist">Whitelist</a>.
+In most cases, these defaults are good enough. Only one option, `whitelistKey` should be changed when you deploy your own site, see <a href="#whitelist">Whitelist</a>.
 
 Looking at the examples in the `/src/stories` folder should give you some ideas how to use these options.
 
@@ -92,7 +92,7 @@ Looking at the examples in the `/src/stories` folder should give you some ideas
 The constructor accepts a JSON with optional <a href="#options">options</a>. Example:
 
 ```ts
-const videomailClient = new VideomailClient({ siteName: "my site name" });
+const videomailClient = new VideomailClient({ whitelistKey: "my whitelist key" });
 ```
 
 <a name="on"></a>
@@ -233,14 +233,14 @@ It's emitted in the SUBMITTED event under the videomail object:
   "width": 320,
   "height": 240,
   "videomailClientVersion": "2.4.11",
-  "siteName": "videomail-client-demo",
+  "whitelistKey": "videomail-client-demo",
   "alias": "some-subject-183622500964",
   "dateCreated": 1541130589811,
   "url": "https://videomail.io/videomail/some-subject-150322500964",
   "key": "11e8-de52-55ac2630-b22b-71959562a989",
   "expirationPretty": "1 hour",
   "expiresAfter": 1541134189811,
-  "siteTitle": "Videomail Client Example",
+  "siteName": "Videomail Client Example",
   "webm": "https://videomail.io/videomail/some-subject-183622500964/type/webm/",
   "poster": "https://videomail.io/videomail/some-subject-183622500964/poster/",
   "dateCreatedPretty": "Nov 2, 2018, 4:49 PM",
@@ -280,7 +280,7 @@ Otherwise only the videomail alias is in the form body and will have to call `vi
 
 Examples will work right away on [https://localhost:8443](https://localhost:8443). This is because localhost is whitelisted on the remote Videomail server. `https://localhost` and `https://localhost:443` are whitelisted too for local development. Other IP addresses won't work. If this is a problem, contact me and I can whitelist more.
 
-In other words, if your web server is connected through a domain besides localhost, the Videomail-Client is restricted from sending the media packets to the remote Videomail server which is responsible for storing and sending videomails. To fix that, just lodge a whitelist request at [https://videomail.io/whitelist](https://videomail.io/whitelist). Then you should get a new site name and a list of whitelisted URLs for your own usage pretty fast (within less than 48 hours).
+In other words, if your web server is connected through a domain besides localhost, the Videomail-Client is restricted from sending the media packets to the remote Videomail server which is responsible for storing and sending videomails. To fix that, just lodge a whitelist request at [https://videomail.io/whitelist](https://videomail.io/whitelist). Then you should get a new whitelist key and a list of whitelisted URLs for your own usage.
 
 <a name="compatibility"></a>
 

package/dist/cjs/index.cjs

@@ -10571,7 +10571,7 @@ var __webpack_exports__ = {};
         MP4: "mp4"
     };
     const constants = {
-        SITE_NAME_LABEL: "x-videomail-site-name",
+        WHITELIST_KEY_LABEL: "x-videomail-whitelist-key",
         VERSION_LABEL: "videomailClientVersion",
         public: {
             ENC_TYPE_APP_JSON: "application/json",
@@ -10731,7 +10731,7 @@ var __webpack_exports__ = {};
     var client = __webpack_require__("./node_modules/superagent/lib/client.js");
     var client_default = /*#__PURE__*/ __webpack_require__.n(client);
     var package_namespaceObject = {
-        rE: "13.6.11"
+        rE: "13.6.13"
     };
     function isAudioEnabled(options) {
         return Boolean(options.audio.enabled);
@@ -14055,10 +14055,10 @@ var __webpack_exports__ = {};
         }
         constructor(message, options, classList, errData){
             var _ref;
-            super(message, errData), VideomailError_define_property(this, "title", "Error from videomail-client npm package"), VideomailError_define_property(this, "location", window.location.href), VideomailError_define_property(this, "logLines", void 0), VideomailError_define_property(this, "siteName", void 0), VideomailError_define_property(this, "cookie", void 0), VideomailError_define_property(this, "err", void 0), VideomailError_define_property(this, "promise", void 0), VideomailError_define_property(this, "reason", void 0), VideomailError_define_property(this, "browser", void 0), VideomailError_define_property(this, "cpu", void 0), VideomailError_define_property(this, "device", void 0), VideomailError_define_property(this, "engine", void 0), VideomailError_define_property(this, "os", void 0), VideomailError_define_property(this, "screen", void 0), VideomailError_define_property(this, "orientation", void 0), VideomailError_define_property(this, "classList", void 0);
+            super(message, errData), VideomailError_define_property(this, "title", "Error from videomail-client npm package"), VideomailError_define_property(this, "location", window.location.href), VideomailError_define_property(this, "logLines", void 0), VideomailError_define_property(this, "whitelistKey", void 0), VideomailError_define_property(this, "cookie", void 0), VideomailError_define_property(this, "err", void 0), VideomailError_define_property(this, "promise", void 0), VideomailError_define_property(this, "reason", void 0), VideomailError_define_property(this, "browser", void 0), VideomailError_define_property(this, "cpu", void 0), VideomailError_define_property(this, "device", void 0), VideomailError_define_property(this, "engine", void 0), VideomailError_define_property(this, "os", void 0), VideomailError_define_property(this, "screen", void 0), VideomailError_define_property(this, "orientation", void 0), VideomailError_define_property(this, "classList", void 0);
             this.explanation = null == errData ? void 0 : errData.explanation;
             this.logLines = null == errData ? void 0 : errData.logLines;
-            this.siteName = options.siteName;
+            this.whitelistKey = options.whitelistKey;
             this.classList = classList;
             const browser = util_getBrowser(options);
             const usefulClientData = browser.getUsefulData();
@@ -14804,7 +14804,7 @@ var __webpack_exports__ = {};
             return resource_async_to_generator(function*() {
                 const url = `${this.options.apiUrl}/videomail/${identifierName}/${identifierValue}/snapshot`;
                 try {
-                    const request = yield client_default()("get", url).type("json").set("Accept", "application/json").withCredentials().set("Timezone-Id", this.timezoneId).set(constants.SITE_NAME_LABEL, this.options.siteName).timeout(this.options.timeouts.connection);
+                    const request = yield client_default()("get", url).type("json").set("Accept", "application/json").withCredentials().set("Timezone-Id", this.timezoneId).set(constants.WHITELIST_KEY_LABEL, this.options.whitelistKey).timeout(this.options.timeouts.connection);
                     const videomail = request.body;
                     return videomail;
                 } catch (exc) {
@@ -14818,7 +14818,7 @@ var __webpack_exports__ = {};
         write(method, videomail) {
             return resource_async_to_generator(function*() {
                 const queryParams = {
-                    [constants.SITE_NAME_LABEL]: this.options.siteName
+                    [constants.WHITELIST_KEY_LABEL]: this.options.whitelistKey
                 };
                 let url = `${this.options.apiUrl}/videomail/`;
                 if (method === FormMethod.PUT && videomail.key) url += videomail.key;
@@ -14846,7 +14846,7 @@ var __webpack_exports__ = {};
         reportError(err) {
             return resource_async_to_generator(function*() {
                 const queryParams = {
-                    [constants.SITE_NAME_LABEL]: this.options.siteName
+                    [constants.WHITELIST_KEY_LABEL]: this.options.whitelistKey
                 };
                 const url = `${this.options.apiUrl}/client-error/`;
                 try {
@@ -14865,7 +14865,7 @@ var __webpack_exports__ = {};
                         orientation: err.orientation,
                         os: err.os,
                         screen: err.screen,
-                        siteName: err.siteName,
+                        whitelistKey: err.whitelistKey,
                         status: err.status,
                         title: err.title,
                         message: err.message,
@@ -14967,7 +14967,7 @@ var __webpack_exports__ = {};
         verbose: !PRODUCTION,
         apiUrl: "https://videomail.io/api",
         socketUrl: "wss://videomail.io",
-        siteName: "videomail-client-demo",
+        whitelistKey: "videomail-client-demo",
         enablePause: true,
         enableAutoPause: true,
         enableSpace: true,
@@ -17134,8 +17134,8 @@ var __webpack_exports__ = {};
             this.confirmedFrameNumber = this.confirmedSampleNumber = this.samplesCount = this.framesCount = 0;
             this.sampleProgress = this.frameProgress = void 0;
             this.key = args.key;
-            if (args.mp4) this.replay.setMp4Source(`${args.mp4 + constants.SITE_NAME_LABEL}/${this.options.siteName}/videomail.mp4`, true);
-            if (args.webm) this.replay.setWebMSource(`${args.webm + constants.SITE_NAME_LABEL}/${this.options.siteName}/videomail.webm`, true);
+            if (args.mp4) this.replay.setMp4Source(`${args.mp4 + constants.WHITELIST_KEY_LABEL}/${this.options.whitelistKey}/videomail.mp4`, true);
+            if (args.webm) this.replay.setWebMSource(`${args.webm + constants.WHITELIST_KEY_LABEL}/${this.options.whitelistKey}/videomail.webm`, true);
             this.hide();
             const widthDimension = this.getRecorderWidth(true);
             const heightDimension = this.getRecorderHeight(true);
@@ -17155,7 +17155,7 @@ var __webpack_exports__ = {};
             if (!this.connected) {
                 this.connecting = true;
                 this.emit("CONNECTING");
-                const url2Connect = `${this.options.socketUrl}?${encodeURIComponent(constants.SITE_NAME_LABEL)}=${encodeURIComponent(this.options.siteName)}`;
+                const url2Connect = `${this.options.socketUrl}?${encodeURIComponent(constants.WHITELIST_KEY_LABEL)}=${encodeURIComponent(this.options.whitelistKey)}`;
                 this.options.logger.debug(`Recorder: initializing web socket to ${url2Connect}`);
                 try {
                     this.stream = stream_default()(url2Connect, {

package/dist/esm/constants.d.ts

@@ -1,5 +1,5 @@
 declare const _default: {
-    SITE_NAME_LABEL: string;
+    WHITELIST_KEY_LABEL: string;
     VERSION_LABEL: string;
     public: {
         ENC_TYPE_APP_JSON: string;

package/dist/esm/index.js

@@ -3555,7 +3555,7 @@ const VideoType = {
     MP4: "mp4"
 };
 const constants = {
-    SITE_NAME_LABEL: "x-videomail-site-name",
+    WHITELIST_KEY_LABEL: "x-videomail-whitelist-key",
     VERSION_LABEL: "videomailClientVersion",
     public: {
         ENC_TYPE_APP_JSON: "application/json",
@@ -3563,7 +3563,7 @@ const constants = {
     }
 };
 var package_namespaceObject = {
-    rE: "13.6.11"
+    rE: "13.6.13"
 };
 function isAudioEnabled(options) {
     return Boolean(options.audio.enabled);
@@ -3693,7 +3693,7 @@ class VideomailError extends error_HTTPVideomailError {
     title = "Error from videomail-client npm package";
     location = window.location.href;
     logLines;
-    siteName;
+    whitelistKey;
     cookie;
     err;
     promise;
@@ -3722,7 +3722,7 @@ class VideomailError extends error_HTTPVideomailError {
         super(message, errData);
         this.explanation = errData?.explanation;
         this.logLines = errData?.logLines;
-        this.siteName = options.siteName;
+        this.whitelistKey = options.whitelistKey;
         this.classList = classList;
         const browser = util_getBrowser(options);
         const usefulClientData = browser.getUsefulData();
@@ -4262,7 +4262,7 @@ class Resource {
     async get(identifierName, identifierValue) {
         const url = `${this.options.apiUrl}/videomail/${identifierName}/${identifierValue}/snapshot`;
         try {
-            const request = await superagent("get", url).type("json").set("Accept", "application/json").withCredentials().set("Timezone-Id", this.timezoneId).set(constants.SITE_NAME_LABEL, this.options.siteName).timeout(this.options.timeouts.connection);
+            const request = await superagent("get", url).type("json").set("Accept", "application/json").withCredentials().set("Timezone-Id", this.timezoneId).set(constants.WHITELIST_KEY_LABEL, this.options.whitelistKey).timeout(this.options.timeouts.connection);
             const videomail = request.body;
             return videomail;
         } catch (exc) {
@@ -4274,7 +4274,7 @@ class Resource {
     }
     async write(method, videomail) {
         const queryParams = {
-            [constants.SITE_NAME_LABEL]: this.options.siteName
+            [constants.WHITELIST_KEY_LABEL]: this.options.whitelistKey
         };
         let url = `${this.options.apiUrl}/videomail/`;
         if (method === FormMethod.PUT && videomail.key) url += videomail.key;
@@ -4296,7 +4296,7 @@ class Resource {
     }
     async reportError(err) {
         const queryParams = {
-            [constants.SITE_NAME_LABEL]: this.options.siteName
+            [constants.WHITELIST_KEY_LABEL]: this.options.whitelistKey
         };
         const url = `${this.options.apiUrl}/client-error/`;
         try {
@@ -4314,7 +4314,7 @@ class Resource {
                 orientation: err.orientation,
                 os: err.os,
                 screen: err.screen,
-                siteName: err.siteName,
+                whitelistKey: err.whitelistKey,
                 status: err.status,
                 title: err.title,
                 message: err.message,
@@ -4401,7 +4401,7 @@ const options_options = {
     verbose: !PRODUCTION,
     apiUrl: "https://videomail.io/api",
     socketUrl: "wss://videomail.io",
-    siteName: "videomail-client-demo",
+    whitelistKey: "videomail-client-demo",
     enablePause: true,
     enableAutoPause: true,
     enableSpace: true,
@@ -6379,8 +6379,8 @@ class Recorder extends util_Despot {
         this.confirmedFrameNumber = this.confirmedSampleNumber = this.samplesCount = this.framesCount = 0;
         this.sampleProgress = this.frameProgress = void 0;
         this.key = args.key;
-        if (args.mp4) this.replay.setMp4Source(`${args.mp4 + constants.SITE_NAME_LABEL}/${this.options.siteName}/videomail.mp4`, true);
-        if (args.webm) this.replay.setWebMSource(`${args.webm + constants.SITE_NAME_LABEL}/${this.options.siteName}/videomail.webm`, true);
+        if (args.mp4) this.replay.setMp4Source(`${args.mp4 + constants.WHITELIST_KEY_LABEL}/${this.options.whitelistKey}/videomail.mp4`, true);
+        if (args.webm) this.replay.setWebMSource(`${args.webm + constants.WHITELIST_KEY_LABEL}/${this.options.whitelistKey}/videomail.webm`, true);
         this.hide();
         const widthDimension = this.getRecorderWidth(true);
         const heightDimension = this.getRecorderHeight(true);
@@ -6400,7 +6400,7 @@ class Recorder extends util_Despot {
         if (!this.connected) {
             this.connecting = true;
             this.emit("CONNECTING");
-            const url2Connect = `${this.options.socketUrl}?${encodeURIComponent(constants.SITE_NAME_LABEL)}=${encodeURIComponent(this.options.siteName)}`;
+            const url2Connect = `${this.options.socketUrl}?${encodeURIComponent(constants.WHITELIST_KEY_LABEL)}=${encodeURIComponent(this.options.whitelistKey)}`;
             this.options.logger.debug(`Recorder: initializing web socket to ${url2Connect}`);
             try {
                 this.stream = websocket_stream(url2Connect, {

package/dist/esm/types/Videomail.d.ts

@@ -39,8 +39,8 @@ export interface Videomail {
     sentDateIso?: string;
     sentDateServerPretty?: string;
     serverTimePretty?: string;
-    siteName: string;
-    siteTitle?: string;
+    whitelistKey: string;
+    siteName?: string;
     url: string;
     userKey?: string;
     versions: {

package/dist/esm/types/error.d.ts

@@ -8,7 +8,7 @@ export interface VideomailErrorData {
     explanation?: string | undefined;
     logLines?: string[] | undefined;
     message: string;
-    siteName?: string | undefined;
+    whitelistKey?: string | undefined;
     title: string;
     trace?: string | undefined;
     code?: string | undefined;

package/dist/esm/types/options.d.ts

@@ -12,7 +12,7 @@ export interface VideomailClientOptions {
     verbose: boolean;
     apiUrl: string;
     socketUrl: string;
-    siteName: string;
+    whitelistKey: string;
     enablePause: boolean;
     enableAutoPause: boolean;
     enableSpace: boolean;

package/dist/esm/util/error/VideomailError.d.ts

@@ -10,7 +10,7 @@ declare class VideomailError extends HTTPVideomailError {
     readonly title = "Error from videomail-client npm package";
     readonly location: string;
     logLines?: string[] | undefined;
-    siteName: string | undefined;
+    whitelistKey: string | undefined;
     cookie: string[] | undefined;
     err?: Error | undefined;
     promise?: Promise<any> | undefined;

package/dist/esm/wrappers/form.d.ts

@@ -112,8 +112,8 @@ declare class Form extends Despot {
         sentDateIso?: string;
         sentDateServerPretty?: string;
         serverTimePretty?: string;
+        whitelistKey?: string;
         siteName?: string;
-        siteTitle?: string;
         url?: string;
         userKey?: string;
         versions?: {
@@ -251,8 +251,8 @@ declare class Form extends Despot {
         sentDateIso?: string;
         sentDateServerPretty?: string;
         serverTimePretty?: string;
+        whitelistKey?: string;
         siteName?: string;
-        siteTitle?: string;
         url?: string;
         userKey?: string;
         versions?: {

package/dist/umd/index.js

@@ -10577,7 +10577,7 @@
                 MP4: "mp4"
             };
             const constants = {
-                SITE_NAME_LABEL: "x-videomail-site-name",
+                WHITELIST_KEY_LABEL: "x-videomail-whitelist-key",
                 VERSION_LABEL: "videomailClientVersion",
                 public: {
                     ENC_TYPE_APP_JSON: "application/json",
@@ -10737,7 +10737,7 @@
             var client = __webpack_require__("./node_modules/superagent/lib/client.js");
             var client_default = /*#__PURE__*/ __webpack_require__.n(client);
             var package_namespaceObject = {
-                rE: "13.6.11"
+                rE: "13.6.13"
             };
             function isAudioEnabled(options) {
                 return Boolean(options.audio.enabled);
@@ -14022,7 +14022,7 @@
                 title = "Error from videomail-client npm package";
                 location = window.location.href;
                 logLines;
-                siteName;
+                whitelistKey;
                 cookie;
                 err;
                 promise;
@@ -14051,7 +14051,7 @@
                     super(message, errData);
                     this.explanation = errData?.explanation;
                     this.logLines = errData?.logLines;
-                    this.siteName = options.siteName;
+                    this.whitelistKey = options.whitelistKey;
                     this.classList = classList;
                     const browser = util_getBrowser(options);
                     const usefulClientData = browser.getUsefulData();
@@ -14704,7 +14704,7 @@
                 async get(identifierName, identifierValue) {
                     const url = `${this.options.apiUrl}/videomail/${identifierName}/${identifierValue}/snapshot`;
                     try {
-                        const request = await client_default()("get", url).type("json").set("Accept", "application/json").withCredentials().set("Timezone-Id", this.timezoneId).set(constants.SITE_NAME_LABEL, this.options.siteName).timeout(this.options.timeouts.connection);
+                        const request = await client_default()("get", url).type("json").set("Accept", "application/json").withCredentials().set("Timezone-Id", this.timezoneId).set(constants.WHITELIST_KEY_LABEL, this.options.whitelistKey).timeout(this.options.timeouts.connection);
                         const videomail = request.body;
                         return videomail;
                     } catch (exc) {
@@ -14716,7 +14716,7 @@
                 }
                 async write(method, videomail) {
                     const queryParams = {
-                        [constants.SITE_NAME_LABEL]: this.options.siteName
+                        [constants.WHITELIST_KEY_LABEL]: this.options.whitelistKey
                     };
                     let url = `${this.options.apiUrl}/videomail/`;
                     if (method === FormMethod.PUT && videomail.key) url += videomail.key;
@@ -14738,7 +14738,7 @@
                 }
                 async reportError(err) {
                     const queryParams = {
-                        [constants.SITE_NAME_LABEL]: this.options.siteName
+                        [constants.WHITELIST_KEY_LABEL]: this.options.whitelistKey
                     };
                     const url = `${this.options.apiUrl}/client-error/`;
                     try {
@@ -14756,7 +14756,7 @@
                             orientation: err.orientation,
                             os: err.os,
                             screen: err.screen,
-                            siteName: err.siteName,
+                            whitelistKey: err.whitelistKey,
                             status: err.status,
                             title: err.title,
                             message: err.message,
@@ -14843,7 +14843,7 @@
                 verbose: !PRODUCTION,
                 apiUrl: "https://videomail.io/api",
                 socketUrl: "wss://videomail.io",
-                siteName: "videomail-client-demo",
+                whitelistKey: "videomail-client-demo",
                 enablePause: true,
                 enableAutoPause: true,
                 enableSpace: true,
@@ -16901,8 +16901,8 @@
                     this.confirmedFrameNumber = this.confirmedSampleNumber = this.samplesCount = this.framesCount = 0;
                     this.sampleProgress = this.frameProgress = void 0;
                     this.key = args.key;
-                    if (args.mp4) this.replay.setMp4Source(`${args.mp4 + constants.SITE_NAME_LABEL}/${this.options.siteName}/videomail.mp4`, true);
-                    if (args.webm) this.replay.setWebMSource(`${args.webm + constants.SITE_NAME_LABEL}/${this.options.siteName}/videomail.webm`, true);
+                    if (args.mp4) this.replay.setMp4Source(`${args.mp4 + constants.WHITELIST_KEY_LABEL}/${this.options.whitelistKey}/videomail.mp4`, true);
+                    if (args.webm) this.replay.setWebMSource(`${args.webm + constants.WHITELIST_KEY_LABEL}/${this.options.whitelistKey}/videomail.webm`, true);
                     this.hide();
                     const widthDimension = this.getRecorderWidth(true);
                     const heightDimension = this.getRecorderHeight(true);
@@ -16922,7 +16922,7 @@
                     if (!this.connected) {
                         this.connecting = true;
                         this.emit("CONNECTING");
-                        const url2Connect = `${this.options.socketUrl}?${encodeURIComponent(constants.SITE_NAME_LABEL)}=${encodeURIComponent(this.options.siteName)}`;
+                        const url2Connect = `${this.options.socketUrl}?${encodeURIComponent(constants.WHITELIST_KEY_LABEL)}=${encodeURIComponent(this.options.whitelistKey)}`;
                         this.options.logger.debug(`Recorder: initializing web socket to ${url2Connect}`);
                         try {
                             this.stream = stream_default()(url2Connect, {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "videomail-client",
-  "version": "13.6.11",
+  "version": "13.6.13",
   "description": "A wicked npm package to record videos directly in the browser, wohooo!",
   "keywords": [
     "webcam",