macro-parameters 0.0.6 → 0.0.7

package/index.js

@@ -1,3 +1,36 @@
+/******************************************************************************
+Copyright (c) Microsoft Corporation.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+***************************************************************************** */
+/* global Reflect, Promise, SuppressedError, Symbol, Iterator */
+
+
+var __assign = function() {
+    __assign = Object.assign || function __assign(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p)) t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+
+typeof SuppressedError === "function" ? SuppressedError : function (error, suppressed, message) {
+    var e = new Error(message);
+    return e.name = "SuppressedError", e.error = error, e.suppressed = suppressed, e;
+};
+
 function getCookie(name) {
     var reg = new RegExp("(^| )" + name + "=([^;]*)(;|$)");
     var arr;
@@ -56,20 +89,17 @@ function getLocationOrigin() {
     return (location.origin ||
         "".concat(location.protocol, "//").concat(location.host || location.hostname).concat(location.port));
 }
-
-function cleanPlaceholder(str, params) {
-    for (var k in PlaceHolders) {
-        var param = k.replace('[', '\\[').replace(']', '\\]');
-        var paramName = k.replace('[', '').replace(']', '');
-        str = str.replace(new RegExp(param, 'g'), params[paramName] || PlaceHolders[k]() || "");
+function getExternalMacroParam(name) {
+    var externalMacroParam = window.externalMacroParam;
+    if (externalMacroParam && typeof externalMacroParam === "object" && externalMacroParam.hasOwnProperty(name)) {
+        return externalMacroParam[name];
+    }
+    else {
+        return "";
     }
-    return replaceEmpty(str);
-}
-function replaceEmpty(content) {
-    var reg = /\[.*?\]/g;
-    return content.replace(reg, "");
 }
-var PlaceHolders = {
+
+var App = {
     "[tv_domain]": function () {
         return document.domain;
     },
@@ -91,32 +121,50 @@ var PlaceHolders = {
     "[player_width]": function () {
         return getExternalMacroParam("player_width");
     },
+    "[placement]": function () {
+        return getExternalMacroParam("placement");
+    }
+};
+
+var Content = {
+    "[provider_id]": function () {
+        return getExternalMacroParam("provider_id");
+    },
     "[channel_no]": function () {
         return getExternalMacroParam("channel_no");
     },
     "[channel_category]": function () {
         return getExternalMacroParam("channel_category");
     },
-    "[whale_ad_id]": function () {
-        // return WhaleADID;
+    "[channel_name]": function () {
+        return getExternalMacroParam("channel_category");
     },
-    "[relevant_ads]": function () {
-        // if (isWhaleOSGlobal) {
-        //     return "true"
-        // }
-        var reladvertStatus = "false";
-        var userAgent = navigator.userAgent.toUpperCase();
-        if (userAgent.indexOf("AOC") > -1) {
-            reladvertStatus = getCookie("relAdvert");
-        }
-        else {
-            reladvertStatus = getCookie("relAdvert");
-        }
-        reladvertStatus = reladvertStatus == null ? "false" : reladvertStatus;
-        return reladvertStatus;
+    "[iab_category]": function () {
+        return getExternalMacroParam("iab_category");
     },
-    "[device_dnt]": function () {
-        return getExternalMacroParam("device_dnt") || (getCookie("relAdvert") == 'true' ? 0 : 1);
+    "[avod_id]": function () {
+        return getExternalMacroParam("avod_id");
+    },
+    "[avod_genre]": function () {
+        return getExternalMacroParam("avod_genre");
+    },
+    "[avod_title]": function () {
+        return getExternalMacroParam("avod_title");
+    },
+    "[oriented_age]": function () {
+        return getExternalMacroParam("oriented_age");
+    },
+    "[oriented_gender]": function () {
+        return getExternalMacroParam("oriented_gender");
+    },
+    "[ssai_vendor]": function () {
+        return getExternalMacroParam("ssai_vendor");
+    }
+};
+
+var Device = {
+    "[whale_ad_id]": function () {
+        // return WhaleADID;
     },
     "[tv_brand]": function () {
         return getTvBrand();
@@ -146,24 +194,54 @@ var PlaceHolders = {
             return 'un';
         }
     },
-    "[privacy_policy]": function () {
-        return getExternalMacroParam("privacy_policy");
+    "[time_zone]": function () {
+        return new Date().getTimezoneOffset();
     },
+};
+
+var GDPR = {
     "[whale_gdpr]": function () {
         return getExternalMacroParam("whale_gdpr") || (getCookie("relAdvert") == 'true' ? 1 : 0);
     },
     "[whale_gdpr_consent]": function () {
         return getCookie("tcString") || getLocalStorage('default_tcString');
     },
+    "[relevant_ads]": function () {
+        // if (isWhaleOSGlobal) {
+        //     return "true"
+        // }
+        var reladvertStatus = "false";
+        var userAgent = navigator.userAgent.toUpperCase();
+        if (userAgent.indexOf("AOC") > -1) {
+            reladvertStatus = getCookie("relAdvert");
+        }
+        else {
+            reladvertStatus = getCookie("relAdvert");
+        }
+        reladvertStatus = reladvertStatus == null ? "false" : reladvertStatus;
+        return reladvertStatus;
+    },
+    "[device_dnt]": function () {
+        return getExternalMacroParam("device_dnt") || (getCookie("relAdvert") == 'true' ? 0 : 1);
+    },
+    "[device_lmt]": function () {
+        return getCookie("relAdvert") === 'true' ? 0 : 1;
+    },
+    "[privacy_policy]": function () {
+        return getExternalMacroParam("privacy_policy");
+    },
+};
+
+var Generic = {
     "[rnd]": function () {
         return new Date().getTime();
     },
+    "[timestamp]": function () {
+        return new Date().getTime();
+    },
     "[ad_sdk_ver]": function () {
         return "";
     },
-    "[time_zone]": function () {
-        return new Date().getTimezoneOffset();
-    },
     "[google_pal]": function () {
         if (!window.googleNonce && getCookie("googleNonce")) {
             return getCookie("googleNonce");
@@ -173,15 +251,10 @@ var PlaceHolders = {
         }
         return window.googleNonce || '';
     },
-    "[device_lmt]": function () {
-        return getCookie("relAdvert") === 'true' ? 0 : 1;
-    },
-    "[avod_id]": function () {
-        return "";
-    },
-    "[avod_title]": function () {
-        return "";
-    },
+};
+
+//非WhaleAdsMacros定义，但是实际需要用到的参数
+var Other = {
     "[device_id]": function () {
         return getCookie("deviceid") || getCookie("deviceId");
     },
@@ -192,15 +265,20 @@ var PlaceHolders = {
         return getCookie("usertag");
     }
 };
-function getExternalMacroParam(name) {
-    var externalMacroParam = window.externalMacroParam;
-    if (externalMacroParam && typeof externalMacroParam === "object" && externalMacroParam.hasOwnProperty(name)) {
-        return externalMacroParam[name];
-    }
-    else {
-        return "";
+
+function cleanPlaceholder(str, params) {
+    for (var k in PlaceHolders) {
+        var param = k.replace('[', '\\[').replace(']', '\\]');
+        var paramName = k.replace('[', '').replace(']', '');
+        str = str.replace(new RegExp(param, 'g'), params[paramName] || PlaceHolders[k]() || "");
     }
+    return replaceEmpty(str);
+}
+function replaceEmpty(content) {
+    var reg = /\[.*?\]/g;
+    return content.replace(reg, "");
 }
+var PlaceHolders = __assign(__assign(__assign(__assign(__assign(__assign({}, App), Content), Device), GDPR), Generic), Other);
 
 var MacroSubstitution = /** @class */ (function () {
     function MacroSubstitution() {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "macro-parameters",
-  "version": "0.0.6",
+  "version": "0.0.7",
   "description": "Provide unified macro parameter retrieval",
   "main": "index.js",
   "scripts": {

package/script/utils.ts

@@ -61,10 +61,19 @@ export function setCookie(
     document.cookie = cookieString;
 }
 
-  export function getLocationOrigin() {
+export function getLocationOrigin() {
     return (
         location.origin ||
         `${location.protocol}//${location.host || location.hostname}${location.port
         }`
     );
+}
+
+export function getExternalMacroParam(name: string): string {
+    const externalMacroParam = (window as any).externalMacroParam;
+    if (externalMacroParam && typeof externalMacroParam === "object" && externalMacroParam.hasOwnProperty(name)) {
+        return externalMacroParam[name];
+    } else {
+        return "";
+    }
 }

package/src/replace.ts

@@ -1,11 +1,11 @@
 import {
-    getCookie,
-    getLocalStorage,
-    getLocationOrigin,
-    getTvBrand,
-    getProfileId,
-    setCookie
-} from "../script/utils"
+    App,
+    Content,
+    Device,
+    GDPR,
+    Generic,
+    Other
+} from "../type";
 export function cleanPlaceholder(str: string, params: object) {
     for (let k in PlaceHolders) {
         let param = k.replace('[', '\\[').replace(']', '\\]');
@@ -21,133 +21,16 @@ function replaceEmpty(content: string) {
 }
 
 const PlaceHolders: any = {
-    "[tv_domain]"() {
-        return document.domain
-    },
-    "[app_name]"() {
-        return getExternalMacroParam("app_name");
-    },
-    "[bundle_id]"() {
-        return getExternalMacroParam("bundle_id");
-    },
-    "[app_store_url]"() {
-        return getExternalMacroParam("app_store_url");
-    },
-    "[src_page_url]"() {
-        return encodeURIComponent(getLocationOrigin());
-    },
-    "[player_height]"() {
-        return getExternalMacroParam("player_height");
-    },
-    "[player_width]"() {
-        return getExternalMacroParam("player_width");
-    },
-    "[channel_no]"() {
-        return getExternalMacroParam("channel_no");
-    },
-    "[channel_category]"() {
-        return getExternalMacroParam("channel_category");
-    },
-    "[whale_ad_id]"() {
-        // return WhaleADID;
-    },
-    "[relevant_ads]"() {
-        // if (isWhaleOSGlobal) {
-        //     return "true"
-        // }
-        let reladvertStatus = "false";
-        const userAgent = navigator.userAgent.toUpperCase();
-        if (userAgent.indexOf("AOC") > -1) {
-            reladvertStatus = getCookie("relAdvert");
-        } else {
-            reladvertStatus = getCookie("relAdvert");
-        }
-
-        reladvertStatus = reladvertStatus == null ? "false" : reladvertStatus;
-        return reladvertStatus;
-    },
-    "[device_dnt]"() {
-        return getExternalMacroParam("device_dnt") || (getCookie("relAdvert") == 'true' ? 0 : 1);
-    },
-    "[tv_brand]"() {
-        return getTvBrand();
-    },
-    "[cntry]"() {
-        //return countryGlobal;
-    },
-    "[geo_ip_country]"() {
-        //return geoIpCountryGlobal;
-    },
-    "[platform_id]"() {
-        return getProfileId();
-    },
-    "[device_user_agent]"() {
-        const UA = navigator.userAgent;
-        return encodeURIComponent(UA);
-    },
-    "[device_ip_address]"() {
-        return getExternalMacroParam("device_ip_address");
-    },
-    "[menu_language]"() {
-        const lang = navigator.language;
-        if (lang) {
-            return (lang.length > 2) ? lang.slice(0, 2) : lang;
-        } else {
-            return 'un';
-        }
-    },
-    "[privacy_policy]"() {
-        return getExternalMacroParam("privacy_policy");
-    },
-    "[whale_gdpr]"() {
-        return getExternalMacroParam("whale_gdpr") || (getCookie("relAdvert") == 'true' ? 1 : 0);
-    },
-    "[whale_gdpr_consent]"() {
-        return getCookie("tcString") || getLocalStorage('default_tcString');
-    },
-    "[rnd]"() {
-        return new Date().getTime();
-    },
-    "[ad_sdk_ver]"() {
-        return "";
-    },
-    "[time_zone]"() {
-        return new Date().getTimezoneOffset();
-    },
-    "[google_pal]"() {
-        if (!(window as any).googleNonce && getCookie("googleNonce")) {
-            return getCookie("googleNonce");
-        }
-        if ((window as any).googleNonce) {
-            setCookie("googleNonce", (window as any).googleNonce, new Date(new Date().getTime() + 6 * 60 * 60 * 1000));
-        }
-        return (window as any).googleNonce || '';
-    },
-    "[device_lmt]"() {
-        return getCookie("relAdvert") === 'true' ? 0 : 1
-    },
-    "[avod_id]"() {
-        return ""
-    },
-    "[avod_title]"() {
-        return ""
-    },
-    "[device_id]"() {
-        return getCookie("deviceid") || getCookie("deviceId")
-    },
-    "[session_id]"() {
-        return (window as any).session_id;
-    },
-    "[usertag]"() {
-        return getCookie("usertag")
-    }
-};
-
-function getExternalMacroParam(name: string): string {
-    const externalMacroParam = (window as any).externalMacroParam;
-    if (externalMacroParam && typeof externalMacroParam === "object" && externalMacroParam.hasOwnProperty(name)) {
-        return externalMacroParam[name];
-    } else {
-        return "";
-    }
-}
+    //Type: APP
+    ...App,
+    //Type: Content
+    ...Content,
+    //Type: Device
+    ...Device,
+    //Type: GDPR
+    ...GDPR,
+    //Type: Generic
+    ...Generic,
+    //Type: Other
+    ...Other
+};

package/type/app.ts

@@ -0,0 +1,31 @@
+import {
+    getExternalMacroParam,
+    getLocationOrigin
+} from "../script/utils"
+const App = {
+    "[tv_domain]"() {
+        return document.domain
+    },
+    "[app_name]"() {
+        return getExternalMacroParam("app_name");
+    },
+    "[bundle_id]"() {
+        return getExternalMacroParam("bundle_id");
+    },
+    "[app_store_url]"() {
+        return getExternalMacroParam("app_store_url");
+    },
+    "[src_page_url]"() {
+        return encodeURIComponent(getLocationOrigin());
+    },
+    "[player_height]"() {
+        return getExternalMacroParam("player_height");
+    },
+    "[player_width]"() {
+        return getExternalMacroParam("player_width");
+    },
+    "[placement]"() {
+        return getExternalMacroParam("placement");
+    }
+};
+export { App }

package/type/content.ts

@@ -0,0 +1,38 @@
+
+import { getExternalMacroParam } from "../script/utils"
+const Content = {
+    "[provider_id]"() {
+        return getExternalMacroParam("provider_id");
+    },
+    "[channel_no]"() {
+        return getExternalMacroParam("channel_no");
+    },
+    "[channel_category]"() {
+        return getExternalMacroParam("channel_category");
+    },
+    "[channel_name]"() {
+        return getExternalMacroParam("channel_category");
+    },
+    "[iab_category]"() {
+        return getExternalMacroParam("iab_category");
+    },
+    "[avod_id]"() {
+        return getExternalMacroParam("avod_id");
+    },
+    "[avod_genre]"() {
+        return getExternalMacroParam("avod_genre");
+    },
+    "[avod_title]"() {
+        return getExternalMacroParam("avod_title");
+    },
+    "[oriented_age]"() {
+        return getExternalMacroParam("oriented_age");
+    },
+    "[oriented_gender]"() {
+        return getExternalMacroParam("oriented_gender");
+    },
+    "[ssai_vendor]"() {
+        return getExternalMacroParam("ssai_vendor");
+    }
+}
+export { Content }

package/type/device.ts

@@ -0,0 +1,42 @@
+import {
+    getExternalMacroParam,
+    getTvBrand,
+    getProfileId
+} from "../script/utils"
+const Device = {
+    "[whale_ad_id]"() {
+        // return WhaleADID;
+    },
+    "[tv_brand]"() {
+        return getTvBrand();
+    },
+    "[cntry]"() {
+        //return countryGlobal;
+    },
+    "[geo_ip_country]"() {
+        //return geoIpCountryGlobal;
+    },
+    "[platform_id]"() {
+        return getProfileId();
+    },
+    "[device_user_agent]"() {
+        const UA = navigator.userAgent;
+        return encodeURIComponent(UA);
+    },
+    "[device_ip_address]"() {
+        return getExternalMacroParam("device_ip_address");
+    },
+    "[menu_language]"() {
+        const lang = navigator.language;
+        if (lang) {
+            return (lang.length > 2) ? lang.slice(0, 2) : lang;
+        } else {
+            return 'un';
+        }
+    },
+    "[time_zone]"() {
+        return new Date().getTimezoneOffset();
+    },
+}
+
+export { Device }

package/type/gdpr.ts

@@ -0,0 +1,40 @@
+
+import {
+    getCookie,
+    getExternalMacroParam,
+    getLocalStorage
+} from "../script/utils"
+const GDPR = {
+    "[whale_gdpr]"() {
+        return getExternalMacroParam("whale_gdpr") || (getCookie("relAdvert") == 'true' ? 1 : 0);
+    },
+    "[whale_gdpr_consent]"() {
+        return getCookie("tcString") || getLocalStorage('default_tcString');
+    },
+    "[relevant_ads]"() {
+        // if (isWhaleOSGlobal) {
+        //     return "true"
+        // }
+        let reladvertStatus = "false";
+        const userAgent = navigator.userAgent.toUpperCase();
+        if (userAgent.indexOf("AOC") > -1) {
+            reladvertStatus = getCookie("relAdvert");
+        } else {
+            reladvertStatus = getCookie("relAdvert");
+        }
+
+        reladvertStatus = reladvertStatus == null ? "false" : reladvertStatus;
+        return reladvertStatus;
+    },
+    "[device_dnt]"() {
+        return getExternalMacroParam("device_dnt") || (getCookie("relAdvert") == 'true' ? 0 : 1);
+    },
+    "[device_lmt]"() {
+        return getCookie("relAdvert") === 'true' ? 0 : 1
+    },
+    "[privacy_policy]"() {
+        return getExternalMacroParam("privacy_policy");
+    },
+}
+
+export { GDPR }

package/type/generic.ts

@@ -0,0 +1,26 @@
+import {
+    getCookie,
+    setCookie
+} from "../script/utils"
+const Generic = {
+    "[rnd]"() {
+        return new Date().getTime();
+    },
+    "[timestamp]"() {
+        return new Date().getTime();
+    },
+    "[ad_sdk_ver]"() {
+        return "";
+    },
+    "[google_pal]"() {
+        if (!(window as any).googleNonce && getCookie("googleNonce")) {
+            return getCookie("googleNonce");
+        }
+        if ((window as any).googleNonce) {
+            setCookie("googleNonce", (window as any).googleNonce, new Date(new Date().getTime() + 6 * 60 * 60 * 1000));
+        }
+        return (window as any).googleNonce || '';
+    },
+}
+
+export { Generic }

package/type/index.ts

@@ -0,0 +1,15 @@
+import { App } from "./app"
+import { Content } from "./content"
+import { Device } from "./device"
+import { GDPR } from "./gdpr"
+import { Generic } from "./generic"
+import { Other } from "./other"
+
+export {
+    App,
+    Content,
+    Device,
+    GDPR,
+    Generic,
+    Other
+}

package/type/other.ts

@@ -0,0 +1,15 @@
+//非WhaleAdsMacros定义，但是实际需要用到的参数
+import { getCookie } from "../script/utils"
+const Other = {
+    "[device_id]"() {
+        return getCookie("deviceid") || getCookie("deviceId")
+    },
+    "[session_id]"() {
+        return (window as any).session_id;
+    },
+    "[usertag]"() {
+        return getCookie("usertag")
+    }
+}
+
+export { Other }