@8ms/helpers 1.0.23 → 1.1.0

package/dist/eskimi/genders.d.ts

@@ -0,0 +1,4 @@
+export declare const genders: {
+    id: number;
+    name: string;
+}[];

package/dist/eskimi/genders.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.genders = void 0;
+exports.genders = [
+    {
+        "id": 1,
+        "name": "Male",
+    },
+    {
+        "id": 2,
+        "name": "Female",
+    },
+];

package/dist/eskimi/getAccessToken.d.ts

@@ -1,12 +1,4 @@
-import { AwsConfigType } from '../aws';
-declare type GetAccessTokenType = {
-    SsmLib: any;
-    awsConfig: AwsConfigType;
-    force: boolean;
-    ssmName: string;
-    ssmWithDecryption: boolean;
-    ssmIsJson: boolean;
-};
+import { GetAccessTokenType } from './accessToken';
 /**
  * Retrieve the access token from SSM Parameter Store.
  */

package/dist/eskimi/getAgeGroup.js

@@ -1,13 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getAgeGroup = void 0;
-var constants_1 = require("./constants");
+var ageGroups_1 = require("./ageGroups");
 /**
  * Map the Age Group and return the user-friendly string.
  */
 var getAgeGroup = function (_a) {
     var input = _a.input;
-    var matches = constants_1.AgeGroups.filter(function (group) { return group.id === input; });
+    var matches = ageGroups_1.ageGroups.filter(function (group) { return group.id === input; });
     if (1 === matches.length) {
         return matches[0].name;
     }

package/dist/eskimi/getDevice.js

@@ -1,12 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-var constants_1 = require("./constants");
+var devices_1 = require("./devices");
 /**
  * Map the Devices and return the user-friendly string.
  */
 var getDevice = function (_a) {
     var input = _a.input;
-    var matches = constants_1.Devices.filter(function (device) { return device.id === input; });
+    var matches = devices_1.devices.filter(function (device) { return device.id === input; });
     if (1 === matches.length) {
         return matches[0].name;
     }

package/dist/eskimi/getGender.js

@@ -1,12 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-var constants_1 = require("./constants");
+var genders_1 = require("./genders");
 /**
  * Map the Gender and return the user-friendly string.
  */
 var getGender = function (_a) {
     var input = _a.input;
-    var matches = constants_1.Genders.filter(function (gender) { return gender.id === input; });
+    var matches = genders_1.genders.filter(function (gender) { return gender.id === input; });
     if (1 === matches.length) {
         return matches[0].name;
     }

package/dist/eskimi/index.d.ts

@@ -1,10 +1,14 @@
-import { AgeGroups, Devices, Endpoints, Genders } from './constants';
+import { ageGroups } from './ageGroups';
+import { devices } from './devices';
+import { endpoints } from './endpoints';
+import { genders } from './genders';
 import getAccessToken from './getAccessToken';
 import getAgeGroup from './getAgeGroup';
 import getCampaignIds from './getCampaignIds';
 import getDevice from './getDevice';
 import getGender from './getGender';
 import request from './request';
-import { CampaignType } from './types';
-export type { CampaignType, };
-export { AgeGroups, Devices, Endpoints, Genders, getAccessToken, getAgeGroup, getCampaignIds, getDevice, getGender, request, };
+import { GetAccessTokenType } from './accessToken';
+import { CampaignType } from './campaign';
+export type { CampaignType, GetAccessTokenType, };
+export { ageGroups, devices, endpoints, genders, getAccessToken, getAgeGroup, getCampaignIds, getDevice, getGender, request, };

package/dist/eskimi/index.js

@@ -3,12 +3,15 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.request = exports.getGender = exports.getDevice = exports.getCampaignIds = exports.getAgeGroup = exports.getAccessToken = exports.Genders = exports.Endpoints = exports.Devices = exports.AgeGroups = void 0;
-var constants_1 = require("./constants");
-Object.defineProperty(exports, "AgeGroups", { enumerable: true, get: function () { return constants_1.AgeGroups; } });
-Object.defineProperty(exports, "Devices", { enumerable: true, get: function () { return constants_1.Devices; } });
-Object.defineProperty(exports, "Endpoints", { enumerable: true, get: function () { return constants_1.Endpoints; } });
-Object.defineProperty(exports, "Genders", { enumerable: true, get: function () { return constants_1.Genders; } });
+exports.request = exports.getGender = exports.getDevice = exports.getCampaignIds = exports.getAgeGroup = exports.getAccessToken = exports.genders = exports.endpoints = exports.devices = exports.ageGroups = void 0;
+var ageGroups_1 = require("./ageGroups");
+Object.defineProperty(exports, "ageGroups", { enumerable: true, get: function () { return ageGroups_1.ageGroups; } });
+var devices_1 = require("./devices");
+Object.defineProperty(exports, "devices", { enumerable: true, get: function () { return devices_1.devices; } });
+var endpoints_1 = require("./endpoints");
+Object.defineProperty(exports, "endpoints", { enumerable: true, get: function () { return endpoints_1.endpoints; } });
+var genders_1 = require("./genders");
+Object.defineProperty(exports, "genders", { enumerable: true, get: function () { return genders_1.genders; } });
 var getAccessToken_1 = __importDefault(require("./getAccessToken"));
 exports.getAccessToken = getAccessToken_1.default;
 var getAgeGroup_1 = __importDefault(require("./getAgeGroup"));

package/dist/google/getCredentials.d.ts

@@ -1,4 +1,21 @@
-import { CredentialsType, GetCredentialsType } from './types';
+import { ConfigType } from '../aws';
+export declare type GetCredentialsType = {
+    SsmLib: any;
+    awsConfig: ConfigType;
+    parameterName: string;
+};
+export declare type CredentialsType = {
+    type: string;
+    project_id: string;
+    private_key_id: string;
+    private_key: string;
+    client_email: string;
+    client_id: string;
+    auth_uri: string;
+    token_uri: string;
+    auth_provider_x509_cert_url: string;
+    client_x509_cert_url: string;
+};
 /**
  * Fetch the data from Parameter Store and return the data ready to be used with Google API.
  */

package/dist/google/index.d.ts

@@ -1,4 +1,3 @@
-import getCredentials from './getCredentials';
-import { CredentialsType } from './types';
-export type { CredentialsType, };
+import getCredentials, { CredentialsType, GetCredentialsType } from './getCredentials';
+export type { GetCredentialsType, CredentialsType, };
 export { getCredentials, };

package/dist/google/sheets/getAuth.d.ts

@@ -1,4 +1,4 @@
-import { GetCredentialsType } from '../types';
+import { GetCredentialsType } from '../getCredentials';
 /**
  * Initialise the Google Sheets instance using the separate service method.
  * https://github.com/googleapis/google-api-nodejs-client

package/dist/google/sheets/getAuth.js

@@ -35,8 +35,11 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
         if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
     }
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-var __1 = require("../");
+var getCredentials_1 = __importDefault(require("../getCredentials"));
 /**
  * Initialise the Google Sheets instance using the separate service method.
  * https://github.com/googleapis/google-api-nodejs-client
@@ -48,7 +51,7 @@ var getAuth = function (_a) {
         var credentials, auth;
         return __generator(this, function (_b) {
             switch (_b.label) {
-                case 0: return [4 /*yield*/, (0, __1.getCredentials)({ SsmLib: SsmLib, awsConfig: awsConfig, parameterName: parameterName })];
+                case 0: return [4 /*yield*/, (0, getCredentials_1.default)({ SsmLib: SsmLib, awsConfig: awsConfig, parameterName: parameterName })];
                 case 1:
                     credentials = _b.sent();
                     auth = new SheetsLib.auth.GoogleAuth({

package/dist/googleAds/getClient.d.ts

@@ -1,9 +1,9 @@
-import { AwsConfigType } from '../aws';
-import { ClientType } from './types';
+import { ConfigType } from '../aws';
+import { ClientType } from './client';
 declare type GetClientType = {
     GoogleAdsLib: any;
     SsmLib: any;
-    awsConfig: AwsConfigType;
+    awsConfig: ConfigType;
     parameterName: string;
 };
 /**

package/dist/googleAds/index.d.ts

@@ -1,4 +1,4 @@
-import { ClientType } from './types';
+import { ClientType } from './client';
 import getClient from './getClient';
 import getCustomer from './getCustomer';
 export type { ClientType };

package/dist/myTarget/getAccessToken.d.ts

@@ -1,7 +1,7 @@
-import { AwsConfigType } from '../aws';
+import { ConfigType } from '../aws';
 declare type GetAccessTokenType = {
     SsmLib: any;
-    awsConfig: AwsConfigType;
+    awsConfig: ConfigType;
     force: boolean;
     ssmName: string;
 };

package/dist/nextAuth/{constants.d.ts → authStates.d.ts}

@@ -1,4 +1,4 @@
-export declare const AuthState: {
+export declare const authStates: {
     AUTHENTICATED: string;
     PENDING: string;
     UNAUTHENTICATED: string;

package/dist/nextAuth/{constants.js → authStates.js}

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AuthState = void 0;
-exports.AuthState = {
+exports.authStates = void 0;
+exports.authStates = {
     AUTHENTICATED: 'authenticated',
     PENDING: 'loading',
     UNAUTHENTICATED: 'unauthenticated',

package/dist/nextAuth/index.d.ts

@@ -1,4 +1,4 @@
-import { AuthState } from './constants';
+import { authStates } from './authStates';
 import isSessionReady from './isSessionReady';
 export type {};
-export { AuthState, isSessionReady, };
+export { authStates, isSessionReady, };

package/dist/nextAuth/index.js

@@ -3,8 +3,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isSessionReady = exports.AuthState = void 0;
-var constants_1 = require("./constants");
-Object.defineProperty(exports, "AuthState", { enumerable: true, get: function () { return constants_1.AuthState; } });
+exports.isSessionReady = exports.authStates = void 0;
+var authStates_1 = require("./authStates");
+Object.defineProperty(exports, "authStates", { enumerable: true, get: function () { return authStates_1.authStates; } });
 var isSessionReady_1 = __importDefault(require("./isSessionReady"));
 exports.isSessionReady = isSessionReady_1.default;

package/dist/snapchat/getAccessToken.d.ts

@@ -1,7 +1,7 @@
-import { AwsConfigType } from '../aws';
+import { ConfigType } from '../aws';
 declare type GetAccessTokenType = {
     SsmLib: any;
-    awsConfig: AwsConfigType;
+    awsConfig: ConfigType;
     force: boolean;
     ssmName: string;
 };

package/dist/url/buildUrl.d.ts

@@ -1,8 +1,8 @@
-import { PlatformType } from '../environment/types';
-import { UrlType } from './types';
+import { PlatformsType } from '../environment/platforms';
+import { UrlType } from './url';
 declare type BuildUrlType = {
     path: string;
-    platform: PlatformType;
+    platform: PlatformsType;
     url: UrlType;
 };
 /**

package/dist/url/index.d.ts

@@ -3,6 +3,6 @@ import buildRelative from './buildRelative';
 import buildUrl from './buildUrl';
 import isAbsolute from './isAbsolute';
 import isRelative from './isRelative';
-import { UrlType } from './types';
+import { UrlType } from './url';
 export type { UrlType, };
 export { buildParameters, buildRelative, buildUrl, isAbsolute, isRelative, };

package/dist/webWorker/index.d.ts

@@ -1,4 +1,3 @@
-import { WebWorkerData } from './constant';
-import { WebWorkerDataType } from './types';
-export type { WebWorkerDataType, };
-export { WebWorkerData, };
+import { states, StatesType } from './states';
+export type { StatesType, };
+export { states, };

package/dist/webWorker/index.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.WebWorkerData = void 0;
-var constant_1 = require("./constant");
-Object.defineProperty(exports, "WebWorkerData", { enumerable: true, get: function () { return constant_1.WebWorkerData; } });
+exports.states = void 0;
+var states_1 = require("./states");
+Object.defineProperty(exports, "states", { enumerable: true, get: function () { return states_1.states; } });

package/dist/webWorker/states.d.ts

@@ -0,0 +1,6 @@
+export declare const states: {
+    ERROR: string;
+    SUCCESS: string;
+    PROGRESS: string;
+};
+export declare type StatesType = typeof states.SUCCESS | typeof states.ERROR | typeof states.PROGRESS;

package/dist/webWorker/{constant.js → states.js}

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.WebWorkerData = void 0;
-exports.WebWorkerData = {
+exports.states = void 0;
+exports.states = {
     ERROR: 'error',
     SUCCESS: 'success',
     PROGRESS: 'progress',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@8ms/helpers",
-  "version": "1.0.23",
+  "version": "1.1.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/8millionstories-organisation/8ms-helpers-ts.git"

package/dist/api/constants.d.ts

@@ -1,10 +0,0 @@
-import { ApiResponseType } from './types';
-export declare const ApiStatus: {
-    ERROR: string;
-    IDLE: string;
-    PENDING: string;
-    SUCCESS: string;
-    VALIDATION_ERROR: string;
-};
-export declare const ApiPlaceholder: ApiResponseType;
-export declare const UnexpectedError: string;

package/dist/api/constants.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.UnexpectedError = exports.ApiPlaceholder = exports.ApiStatus = void 0;
-exports.ApiStatus = {
-    ERROR: 'error',
-    IDLE: 'idle',
-    PENDING: 'pending',
-    SUCCESS: 'success',
-    VALIDATION_ERROR: 'validationError',
-};
-exports.ApiPlaceholder = {
-    body: null,
-    error: null,
-    status: exports.ApiStatus.IDLE,
-};
-exports.UnexpectedError = 'An unexpected error occurred, please try again.';

package/dist/api/types.d.ts

@@ -1,7 +0,0 @@
-import { ApiStatus } from './constants';
-export declare type ApiResponseType = {
-    body: any | null;
-    error: string | null;
-    status: ApiStatusType;
-};
-export declare type ApiStatusType = typeof ApiStatus.ERROR | typeof ApiStatus.IDLE | typeof ApiStatus.PENDING | typeof ApiStatus.SUCCESS | typeof ApiStatus.VALIDATION_ERROR;

package/dist/aws/s3cache/types.d.ts

@@ -1,6 +0,0 @@
-import { Duration, DurationComparison } from '../../date';
-export declare type CacheExpiresType = {
-    duration: number;
-    from: typeof DurationComparison.VS_MIDNIGHT | typeof DurationComparison.VS_NOW;
-    timeframe: typeof Duration.FOREVER | typeof Duration.MONTHS | typeof Duration.DAYS | typeof Duration.HOURS | typeof Duration.MINUTES;
-};

package/dist/axios/types.d.ts

@@ -1,13 +0,0 @@
-export declare type GetType = {
-    config?: object;
-    onError?: Function;
-    onSuccess?: Function;
-    url: string;
-};
-export declare type PostType = {
-    config?: object;
-    data?: object;
-    onError?: Function;
-    onSuccess?: Function;
-    url: string;
-};

package/dist/crud/constants.d.ts

@@ -1,6 +0,0 @@
-export declare const CrudStatus: {
-    CREATE: string;
-    READ: string;
-    UPDATE: string;
-    DELETE: string;
-};

package/dist/crud/types.d.ts

@@ -1,2 +0,0 @@
-import { CrudStatus } from './constants';
-export declare type CrudType = typeof CrudStatus.CREATE | typeof CrudStatus.READ | typeof CrudStatus.UPDATE | typeof CrudStatus.DELETE;

package/dist/date/constants.d.ts

@@ -1,21 +0,0 @@
-export declare const Duration: {
-    FOREVER: string;
-    MONTHS: string;
-    DAYS: string;
-    HOURS: string;
-    MINUTES: string;
-};
-export declare const DurationComparison: {
-    VS_NOW: string;
-    VS_MIDNIGHT: string;
-};
-export declare const Timeframe: {
-    CURRENT: string;
-    COMPARISON: string;
-};
-export declare const TimeframePredefined: {
-    NONE: string;
-    CUSTOM: string;
-    THIS_WEEK: string;
-    LAST_WEEK: string;
-};

package/dist/date/constants.js

@@ -1,24 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.TimeframePredefined = exports.Timeframe = exports.DurationComparison = exports.Duration = void 0;
-exports.Duration = {
-    FOREVER: 'forever',
-    MONTHS: 'months',
-    DAYS: 'days',
-    HOURS: 'hours',
-    MINUTES: 'minutes',
-};
-exports.DurationComparison = {
-    VS_NOW: 'vsNow',
-    VS_MIDNIGHT: 'vsMidnight',
-};
-exports.Timeframe = {
-    CURRENT: 'current',
-    COMPARISON: 'comparison',
-};
-exports.TimeframePredefined = {
-    NONE: 'none',
-    CUSTOM: 'custom',
-    THIS_WEEK: 'thisWeek',
-    LAST_WEEK: 'lastWeek',
-};

package/dist/date/types.d.ts

@@ -1,28 +0,0 @@
-import { TimeframePredefined } from './constants';
-/**
- * A date can be either a number (YYYYMMDD), string (YYYY-MM-DD) or Date instance.
- */
-export declare type DateType = number | string | Date;
-export declare type FinancialYearType = {
-    end: Date;
-    start: Date;
-};
-export declare type FinancialYearWeekType = {
-    end: Date;
-    financialWeek: number;
-    financialYear: number;
-    start: Date;
-};
-/**
- * A timeframe has a start and an end date.
- */
-export declare type TimeframeType = {
-    end: DateType;
-    start: DateType;
-};
-export declare type DurationType = {
-    hours: number;
-    minutes: number;
-    seconds: number;
-};
-export declare type TimeframePredefinedType = typeof TimeframePredefined.NONE | typeof TimeframePredefined.CUSTOM | typeof TimeframePredefined.LAST_WEEK | typeof TimeframePredefined.THIS_WEEK;

package/dist/environment/constants.d.ts

@@ -1,9 +0,0 @@
-export declare const Environment: {
-    DEVELOPMENT: string;
-    STAGING: string;
-    PRODUCTION: string;
-};
-export declare const Platform: {
-    AWS: string;
-    VERCEL: string;
-};

package/dist/environment/types.d.ts

@@ -1,3 +0,0 @@
-import { Environment, Platform } from './constants';
-export declare type EnvironmentType = typeof Environment.DEVELOPMENT | typeof Environment.STAGING | typeof Environment.PRODUCTION;
-export declare type PlatformType = typeof Platform.AWS | typeof Platform.VERCEL;

package/dist/eskimi/constants.js

@@ -1,76 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Genders = exports.Devices = exports.AgeGroups = exports.Endpoints = void 0;
-/**
- * https://dsp-api.eskimi.com/docs/api/v1/#api-Report-GetCampaignReportByAgeGroups
- */
-exports.Endpoints = {
-    campaign: {
-        age: 'https://dsp-api.eskimi.com/api/v1/report/ageGroups/get',
-        gender: 'https://dsp-api.eskimi.com/api/v1/report/genders/get',
-        list: 'https://dsp-api.eskimi.com/api/v1/campaign/get',
-        performance: 'https://dsp-api.eskimi.com/api/v1/report/campaigns/get',
-        video: 'https://dsp-api.eskimi.com/api/v1/report/videoCampaigns/get',
-    },
-    site: {
-        list: 'https://dsp-api.eskimi.com/api/v1/report/sites/get',
-    },
-};
-exports.AgeGroups = [
-    {
-        "id": 0,
-        "name": "0-17",
-    },
-    {
-        "id": 1,
-        "name": "18-24",
-    },
-    {
-        "id": 2,
-        "name": "25-29",
-    },
-    {
-        "id": 3,
-        "name": "30-34",
-    },
-    {
-        "id": 4,
-        "name": "35-39",
-    },
-    {
-        "id": 5,
-        "name": "40-44",
-    },
-    {
-        "id": 6,
-        "name": "45-54",
-    },
-    {
-        "id": 7,
-        "name": "55-64",
-    },
-    {
-        "id": 8,
-        "name": "65+",
-    },
-];
-exports.Devices = [
-    {
-        "id": 2,
-        "name": "Personal Computer",
-    },
-    {
-        "id": 3,
-        "name": "Connected TV",
-    },
-];
-exports.Genders = [
-    {
-        "id": 1,
-        "name": "Male",
-    },
-    {
-        "id": 2,
-        "name": "Female",
-    },
-];

package/dist/google/types.d.ts

@@ -1,18 +0,0 @@
-import { AwsConfigType } from '../aws';
-export declare type GetCredentialsType = {
-    SsmLib: any;
-    awsConfig: AwsConfigType;
-    parameterName: string;
-};
-export declare type CredentialsType = {
-    type: string;
-    project_id: string;
-    private_key_id: string;
-    private_key: string;
-    client_email: string;
-    client_id: string;
-    auth_uri: string;
-    token_uri: string;
-    auth_provider_x509_cert_url: string;
-    client_x509_cert_url: string;
-};

package/dist/webWorker/constant.d.ts

@@ -1,5 +0,0 @@
-export declare const WebWorkerData: {
-    ERROR: string;
-    SUCCESS: string;
-    PROGRESS: string;
-};

package/dist/webWorker/types.d.ts

@@ -1,2 +0,0 @@
-import { WebWorkerData } from './constant';
-export declare type WebWorkerDataType = typeof WebWorkerData.SUCCESS | typeof WebWorkerData.ERROR | typeof WebWorkerData.PROGRESS;

package/dist/webWorker/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });