@8ms/helpers 1.33.2 → 1.35.0

package/date/getSunday.d.ts

@@ -1,4 +1,4 @@
-import { DateType } from "./date";
+import { DateType } from "./";
 import { GetMidnight } from "./getMidnight";
 import { GetTimeZoned } from "./getTimeZoned";
 type GetSunday = GetTimeZoned & GetMidnight & {

package/date/getThisWeek.d.ts

@@ -1,6 +1,6 @@
 import { GetMidnight } from "./getMidnight";
 import { GetTimeZoned } from "./getTimeZoned";
-import { Timeframe } from "./timeframe";
+import { Timeframe } from "./";
 type GetThisWeek = GetTimeZoned & GetMidnight;
 /**
  * Return an object of start/end predefined date of This Week.

package/date/getTwoWeeksAgo.d.ts

@@ -1,6 +1,6 @@
 import { GetMidnight } from "./getMidnight";
 import { GetTimeZoned } from "./getTimeZoned";
-import { Timeframe } from "./timeframe";
+import { Timeframe } from "./";
 type GetTwoWeeksAgo = GetTimeZoned & GetMidnight;
 /**
  * Return an object of start/end predefined date of Two Weeks Ago.

package/date/getWeeksAgo.d.ts

@@ -1,4 +1,4 @@
-import { DateType } from './date';
+import { DateType } from './';
 import { GetTimeZoned } from './getTimeZoned';
 type GetWeeksAgo = GetTimeZoned & {
     input: DateType;

package/date/index.d.ts

@@ -0,0 +1,55 @@
+/**
+ * A date can be either a number (YYYYMMDD), string (YYYY-MM-DD) or Date instance.
+ */
+export type DateType = number | string | Date;
+/**
+ * When a date isn't specified and we need a value.
+ */
+export declare const defaultDate = "1901-01-01";
+/**
+ * When a date time isn't specified and we need a value.
+ */
+export declare const defaultDateTime = "1901-01-01 00:00:00";
+export type Duration = {
+    hours: number;
+    minutes: number;
+    seconds: number;
+};
+export declare enum DurationComparison {
+    VS_NOW = "VS_NOW",
+    VS_MIDNIGHT = "VS_MIDNIGHT"
+}
+export declare enum Interval {
+    FOREVER = "FOREVER",
+    MONTHS = "MONTHS",
+    DAYS = "DAYS",
+    HOURS = "HOURS",
+    MINUTES = "MINUTES"
+}
+export type FinancialYear = {
+    end: Date;
+    start: Date;
+};
+export type FinancialYearWeekType = {
+    end: Date;
+    financialWeek: number;
+    financialYear: number;
+    start: Date;
+};
+/**
+ * A timeframe has a start and an end date.
+ */
+export type Timeframe = {
+    end: DateType;
+    start: DateType;
+};
+export declare enum Timeframes {
+    CURRENT = "CURRENT",
+    COMPARISON = "COMPARISON"
+}
+export declare enum PredefinedTimeframe {
+    NONE = "NONE",
+    CUSTOM = "CUSTOM",
+    THIS_WEEK = "THIS_WEEK",
+    LAST_WEEK = "LAST_WEEK"
+}

package/date/index.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PredefinedTimeframe = exports.Timeframes = exports.Interval = exports.DurationComparison = exports.defaultDateTime = exports.defaultDate = void 0;
+/**
+ * When a date isn't specified and we need a value.
+ */
+exports.defaultDate = "1901-01-01";
+/**
+ * When a date time isn't specified and we need a value.
+ */
+exports.defaultDateTime = "1901-01-01 00:00:00";
+var DurationComparison;
+(function (DurationComparison) {
+    DurationComparison["VS_NOW"] = "VS_NOW";
+    DurationComparison["VS_MIDNIGHT"] = "VS_MIDNIGHT";
+})(DurationComparison || (exports.DurationComparison = DurationComparison = {}));
+var Interval;
+(function (Interval) {
+    Interval["FOREVER"] = "FOREVER";
+    Interval["MONTHS"] = "MONTHS";
+    Interval["DAYS"] = "DAYS";
+    Interval["HOURS"] = "HOURS";
+    Interval["MINUTES"] = "MINUTES";
+})(Interval || (exports.Interval = Interval = {}));
+var Timeframes;
+(function (Timeframes) {
+    Timeframes["CURRENT"] = "CURRENT";
+    Timeframes["COMPARISON"] = "COMPARISON";
+})(Timeframes || (exports.Timeframes = Timeframes = {}));
+var PredefinedTimeframe;
+(function (PredefinedTimeframe) {
+    PredefinedTimeframe["NONE"] = "NONE";
+    PredefinedTimeframe["CUSTOM"] = "CUSTOM";
+    PredefinedTimeframe["THIS_WEEK"] = "THIS_WEEK";
+    PredefinedTimeframe["LAST_WEEK"] = "LAST_WEEK";
+})(PredefinedTimeframe || (exports.PredefinedTimeframe = PredefinedTimeframe = {}));

package/date/isLastWeek.d.ts

@@ -1,4 +1,4 @@
-import { Timeframe } from './timeframe';
+import { Timeframe } from './';
 /**
  * Check to see if a given timeframe is Last Week.
  */

package/date/isThisWeek.d.ts

@@ -1,6 +1,6 @@
-import { Timeframe } from './timeframe';
+import { Timeframe } from './';
 /**
- * Check to see if a given timeframe is Last Week.
+ * Check to see if a given timeframe is This Week.
  */
 declare const isThisWeek: ({ end, start }: Timeframe) => boolean;
 export default isThisWeek;

package/date/isThisWeek.js

@@ -5,7 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const getThisWeek_1 = __importDefault(require("./getThisWeek"));
 /**
- * Check to see if a given timeframe is Last Week.
+ * Check to see if a given timeframe is This Week.
  */
 const isThisWeek = ({ end, start }) => {
     const thisWeek = (0, getThisWeek_1.default)();

package/environment/getEnvironment.d.ts

@@ -1,4 +1,4 @@
-import { Environment } from './environments';
+import { Environment } from './';
 /**
  * Determine the environment we're using.
  */

package/environment/getEnvironment.js

@@ -1,9 +1,6 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-const environments_1 = __importDefault(require("./environments"));
+const _1 = require("./");
 /**
  * Determine the environment we're using.
  */
@@ -26,17 +23,20 @@ const getEnvironment = () => {
     else if (process.env.VERCEL_GIT_COMMIT_REF) {
         platformEnvironment = process.env.VERCEL_GIT_COMMIT_REF;
     }
-    switch (platformEnvironment) {
+    const platformEnvironmentClean = platformEnvironment
+        .toLowerCase()
+        .trim();
+    switch (platformEnvironmentClean) {
         case 'development':
-            response = environments_1.default.DEVELOPMENT;
+            response = _1.Environment.DEVELOPMENT;
             break;
         case 'demo':
         case 'preview':
         case 'staging':
-            response = environments_1.default.STAGING;
+            response = _1.Environment.STAGING;
             break;
         default:
-            response = environments_1.default.PRODUCTION;
+            response = _1.Environment.PRODUCTION;
     }
     return response;
 };

package/environment/index.d.ts

@@ -0,0 +1,9 @@
+export declare enum Environment {
+    DEVELOPMENT = "DEVELOPMENT",
+    STAGING = "STAGING",
+    PRODUCTION = "PRODUCTION"
+}
+export declare enum Platform {
+    AWS = "AWS",
+    VERCEL = "VERCEL"
+}

package/environment/index.js

@@ -0,0 +1,14 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Platform = exports.Environment = void 0;
+var Environment;
+(function (Environment) {
+    Environment["DEVELOPMENT"] = "DEVELOPMENT";
+    Environment["STAGING"] = "STAGING";
+    Environment["PRODUCTION"] = "PRODUCTION";
+})(Environment || (exports.Environment = Environment = {}));
+var Platform;
+(function (Platform) {
+    Platform["AWS"] = "AWS";
+    Platform["VERCEL"] = "VERCEL";
+})(Platform || (exports.Platform = Platform = {}));

package/environment/isAws.js

@@ -1,11 +1,8 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-const platforms_1 = __importDefault(require("./platforms"));
+const _1 = require("./");
 /**
  * Check to see if we are working on AWS Lambda.
  */
-const isAws = () => platforms_1.default.AWS === process.env['EMS_PLATFORM'];
+const isAws = () => _1.Platform.AWS === process.env["EMS_PLATFORM"];
 exports.default = isAws;

package/environment/isDevelopment.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const environments_1 = __importDefault(require("./environments"));
+const _1 = require("./");
 const getEnvironment_1 = __importDefault(require("./getEnvironment"));
-const isDevelopment = () => environments_1.default.DEVELOPMENT === (0, getEnvironment_1.default)();
+const isDevelopment = () => _1.Environment.DEVELOPMENT === (0, getEnvironment_1.default)();
 exports.default = isDevelopment;

package/environment/isProduction.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const environments_1 = __importDefault(require("./environments"));
+const _1 = require("./");
 const getEnvironment_1 = __importDefault(require("./getEnvironment"));
-const isProduction = () => environments_1.default.PRODUCTION === (0, getEnvironment_1.default)();
+const isProduction = () => _1.Environment.PRODUCTION === (0, getEnvironment_1.default)();
 exports.default = isProduction;

package/environment/isStaging.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-const environments_1 = __importDefault(require("./environments"));
+const _1 = require("./");
 const getEnvironment_1 = __importDefault(require("./getEnvironment"));
-const isStaging = () => environments_1.default.STAGING === (0, getEnvironment_1.default)();
+const isStaging = () => _1.Environment.STAGING === (0, getEnvironment_1.default)();
 exports.default = isStaging;

package/googleAds/keywordPlanner/index.d.ts

@@ -0,0 +1,238 @@
+/**
+ * As defined in=
+ * https=//docs.google.com/spreadsheets/d/1T2ObmYoo6BNzrqYKb2ts75A6IKfnXmnndr2wujgNpak/edit#gid=2146701026
+ */
+export declare enum Country {
+    AFGHANISTAN = 2004,
+    ALBANIA = 2008,
+    ANTARCTICA = 2010,
+    ALGERIA = 2012,
+    AMERICAN_SAMOA = 2016,
+    ANDORRA = 2020,
+    ANGOLA = 2024,
+    ANTIGUA_AND_BARBUDA = 2028,
+    AZERBAIJAN = 2031,
+    ARGENTINA = 2032,
+    AUSTRALIA = 2036,
+    AUSTRIA = 2040,
+    THE_BAHAMAS = 2044,
+    BAHRAIN = 2048,
+    BANGLADESH = 2050,
+    ARMENIA = 2051,
+    BARBADOS = 2052,
+    BELGIUM = 2056,
+    BHUTAN = 2064,
+    BOLIVIA = 2068,
+    BOSNIA_AND_HERZEGOVINA = 2070,
+    BOTSWANA = 2072,
+    BRAZIL = 2076,
+    BELIZE = 2084,
+    SOLOMON_ISLANDS = 2090,
+    BRUNEI = 2096,
+    BULGARIA = 2100,
+    MYANMAR_BURMA = 2104,
+    BURUNDI = 2108,
+    BELARUS = 2112,
+    CAMBODIA = 2116,
+    CAMEROON = 2120,
+    CANADA = 2124,
+    CAPE_VERDE = 2132,
+    CENTRAL_AFRICAN_REPUBLIC = 2140,
+    SRI_LANKA = 2144,
+    CHAD = 2148,
+    CHILE = 2152,
+    CHINA = 2156,
+    CHRISTMAS_ISLAND = 2162,
+    COCOS_KEELING_ISLANDS = 2166,
+    COLOMBIA = 2170,
+    COMOROS = 2174,
+    REPUBLIC_OF_THE_CONGO = 2178,
+    DEMOCRATIC_REPUBLIC_OF_THE_CONGO = 2180,
+    COOK_ISLANDS = 2184,
+    COSTA_RICA = 2188,
+    CROATIA = 2191,
+    CYPRUS = 2196,
+    CZECHIA = 2203,
+    BENIN = 2204,
+    DENMARK = 2208,
+    DOMINICA = 2212,
+    DOMINICAN_REPUBLIC = 2214,
+    ECUADOR = 2218,
+    EL_SALVADOR = 2222,
+    EQUATORIAL_GUINEA = 2226,
+    ETHIOPIA = 2231,
+    ERITREA = 2232,
+    ESTONIA = 2233,
+    SOUTH_GEORGIA_AND_THE_SOUTH_SANDWICH_ISLANDS = 2239,
+    FIJI = 2242,
+    FINLAND = 2246,
+    FRANCE = 2250,
+    FRENCH_POLYNESIA = 2258,
+    FRENCH_SOUTHERN_AND_ANTARCTIC_LANDS = 2260,
+    DJIBOUTI = 2262,
+    GABON = 2266,
+    GEORGIA = 2268,
+    THE_GAMBIA = 2270,
+    GERMANY = 2276,
+    GHANA = 2288,
+    KIRIBATI = 2296,
+    GREECE = 2300,
+    GRENADA = 2308,
+    GUAM = 2316,
+    GUATEMALA = 2320,
+    GUINEA = 2324,
+    GUYANA = 2328,
+    HAITI = 2332,
+    HEARD_ISLAND_AND_MCDONALD_ISLANDS = 2334,
+    VATICAN_CITY = 2336,
+    HONDURAS = 2340,
+    HUNGARY = 2348,
+    ICELAND = 2352,
+    INDIA = 2356,
+    INDONESIA = 2360,
+    IRAQ = 2368,
+    IRELAND = 2372,
+    ISRAEL = 2376,
+    ITALY = 2380,
+    COTE_DIVOIRE = 2384,
+    JAMAICA = 2388,
+    JAPAN = 2392,
+    KAZAKHSTAN = 2398,
+    JORDAN = 2400,
+    KENYA = 2404,
+    SOUTH_KOREA = 2410,
+    KUWAIT = 2414,
+    KYRGYZSTAN = 2417,
+    LAOS = 2418,
+    LEBANON = 2422,
+    LESOTHO = 2426,
+    LATVIA = 2428,
+    LIBERIA = 2430,
+    LIBYA = 2434,
+    LIECHTENSTEIN = 2438,
+    LITHUANIA = 2440,
+    LUXEMBOURG = 2442,
+    MADAGASCAR = 2450,
+    MALAWI = 2454,
+    MALAYSIA = 2458,
+    MALDIVES = 2462,
+    MALI = 2466,
+    MALTA = 2470,
+    MAURITANIA = 2478,
+    MAURITIUS = 2480,
+    MEXICO = 2484,
+    MONACO = 2492,
+    MONGOLIA = 2496,
+    MOLDOVA = 2498,
+    MONTENEGRO = 2499,
+    MOROCCO = 2504,
+    MOZAMBIQUE = 2508,
+    OMAN = 2512,
+    NAMIBIA = 2516,
+    NAURU = 2520,
+    NEPAL = 2524,
+    NETHERLANDS = 2528,
+    CURACAO = 2531,
+    SINT_MAARTEN = 2534,
+    CARIBBEAN_NETHERLANDS = 2535,
+    NEW_CALEDONIA = 2540,
+    VANUATU = 2548,
+    NEW_ZEALAND = 2554,
+    NICARAGUA = 2558,
+    NIGER = 2562,
+    NIGERIA = 2566,
+    NIUE = 2570,
+    NORFOLK_ISLAND = 2574,
+    NORWAY = 2578,
+    NORTHERN_MARIANA_ISLANDS = 2580,
+    UNITED_STATES_MINOR_OUTLYING_ISLANDS = 2581,
+    FEDERATED_STATES_OF_MICRONESIA = 2583,
+    MARSHALL_ISLANDS = 2584,
+    PALAU = 2585,
+    PAKISTAN = 2586,
+    PANAMA = 2591,
+    PAPUA_NEW_GUINEA = 2598,
+    PARAGUAY = 2600,
+    PERU = 2604,
+    PHILIPPINES = 2608,
+    PITCAIRN_ISLANDS = 2612,
+    POLAND = 2616,
+    PORTUGAL = 2620,
+    GUINEA_BISSAU = 2624,
+    TIMOR_LESTE = 2626,
+    QATAR = 2634,
+    ROMANIA = 2642,
+    RUSSIA = 2643,
+    RWANDA = 2646,
+    SAINT_HELENA__ASCENSION_AND_TRISTAN_DA_CUNHA = 2654,
+    SAINT_KITTS_AND_NEVIS = 2659,
+    SAINT_LUCIA = 2662,
+    SAINT_PIERRE_AND_MIQUELON = 2666,
+    SAINT_VINCENT_AND_THE_GRENADINES = 2670,
+    SAN_MARINO = 2674,
+    SAO_TOME_AND_PRINCIPE = 2678,
+    SAUDI_ARABIA = 2682,
+    SENEGAL = 2686,
+    SERBIA = 2688,
+    SEYCHELLES = 2690,
+    SIERRA_LEONE = 2694,
+    SINGAPORE = 2702,
+    SLOVAKIA = 2703,
+    VIETNAM = 2704,
+    SLOVENIA = 2705,
+    SOMALIA = 2706,
+    SOUTH_AFRICA = 2710,
+    ZIMBABWE = 2716,
+    SPAIN = 2724,
+    SUDAN = 2736,
+    SURINAME = 2740,
+    ESWATINI = 2748,
+    SWEDEN = 2752,
+    SWITZERLAND = 2756,
+    TAJIKISTAN = 2762,
+    THAILAND = 2764,
+    TOGO = 2768,
+    TOKELAU = 2772,
+    TONGA = 2776,
+    TRINIDAD_AND_TOBAGO = 2780,
+    UNITED_ARAB_EMIRATES = 2784,
+    TUNISIA = 2788,
+    TURKEY = 2792,
+    TURKMENISTAN = 2795,
+    TUVALU = 2798,
+    UGANDA = 2800,
+    UKRAINE = 2804,
+    NORTH_MACEDONIA = 2807,
+    EGYPT = 2818,
+    UNITED_KINGDOM = 2826,
+    GUERNSEY = 2831,
+    JERSEY = 2832,
+    TANZANIA = 2834,
+    UNITED_STATES = 2840,
+    BURKINA_FASO = 2854,
+    URUGUAY = 2858,
+    UZBEKISTAN = 2860,
+    VENEZUELA = 2862,
+    WALLIS_AND_FUTUNA = 2876,
+    SAMOA = 2882,
+    YEMEN = 2887,
+    ZAMBIA = 2894
+}
+export declare enum Month {
+    JANUARY = "JANUARY",
+    FEBRUARY = "FEBRUARY",
+    MARCH = "MARCH",
+    APRIL = "APRIL",
+    MAY = "MAY",
+    JUNE = "JUNE",
+    JULY = "JULY",
+    AUGUST = "AUGUST",
+    SEPTEMBER = "SEPTEMBER",
+    OCTOBER = "OCTOBER",
+    NOVEMBER = "NOVEMBER",
+    DECEMBER = "DECEMBER"
+}
+export declare enum Network {
+    GOOGLE_SEARCH_ONLY = 2,
+    GOOGLE_SEARCH_AND_PARTNERS = 3
+}