@guardian/commercial-core 0.32.0 → 0.33.0

package/dist/cjs/detectAdBlocker.js

@@ -16,8 +16,9 @@ function adElementBlocked(ad) {
         ad.offsetTop === 0 ||
         ad.offsetWidth === 0 ||
         ad.clientHeight === 0 ||
-        ad.clientWidth === 0)
+        ad.clientWidth === 0) {
         return true;
+    }
     const adStyles = window.getComputedStyle(ad);
     if (adStyles.getPropertyValue('display') === 'none')
         return true;

package/dist/cjs/targeting/pick-targeting-values.d.ts

@@ -0,0 +1,28 @@
+declare type ValidTargeting<T, K> = '' extends T ? never : [] extends T ? never : [''] extends T ? never : T extends boolean ? never : T extends NonNullable<T> ? K : never;
+declare type DefinedKeys<T> = {
+    [K in keyof T]-?: ValidTargeting<T[K], K>;
+}[keyof T];
+declare type ObjectWithDefinedValues<T> = Pick<T, DefinedKeys<T>>;
+/**
+ * Picks only keys with targeting values from an object.
+ * A targeting values is defined as either:
+ * - a non-empty string
+ * - an array of non-empty strings
+ *
+ * If you object is read-only, you can safely access properties on the result.
+ * For example:
+ *
+ * ```ts
+ * dirty = {
+ *   valid: 'real',
+ *   invalid: undefined,
+ * } as const;
+ *
+ * clean = pickDefinedValues(dirty);
+ *
+ * // @ts-expect-error -- you can’t access this property
+ * clean.invalid
+ * ```
+ */
+export declare const pickTargetingValues: <T extends Record<string, string | readonly string[] | undefined>>(obj: T) => ObjectWithDefinedValues<T>;
+export {};

package/dist/cjs/targeting/pick-targeting-values.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.pickTargetingValues = void 0;
+const libs_1 = require("@guardian/libs");
+const isTargetingString = (string) => (0, libs_1.isString)(string) && string !== '';
+const isTargetingArray = (array) => Array.isArray(array) && array.filter(isTargetingString).length > 0;
+const isValidTargeting = (value) => {
+    if (isTargetingString(value))
+        return true;
+    if (isTargetingArray(value))
+        return true;
+    return false;
+};
+/**
+ * Picks only keys with targeting values from an object.
+ * A targeting values is defined as either:
+ * - a non-empty string
+ * - an array of non-empty strings
+ *
+ * If you object is read-only, you can safely access properties on the result.
+ * For example:
+ *
+ * ```ts
+ * dirty = {
+ *   valid: 'real',
+ *   invalid: undefined,
+ * } as const;
+ *
+ * clean = pickDefinedValues(dirty);
+ *
+ * // @ts-expect-error -- you can’t access this property
+ * clean.invalid
+ * ```
+ */
+const pickTargetingValues = (obj) => {
+    const initialValue = {};
+    return Object.entries(obj).reduce((valid, [key, value]) => {
+        if (isValidTargeting(value)) {
+            // @ts-expect-error -- isValidTargeting checks this
+            valid[key] = value;
+        }
+        return valid;
+    }, initialValue);
+};
+exports.pickTargetingValues = pickTargetingValues;

package/dist/cjs/targeting/session.js

@@ -44,8 +44,9 @@ const experimentsTargeting = ({ clientSideParticipations, serverSideParticipatio
     const serverSideExperiments = Object.entries(serverSideParticipations)
         .map((test) => testToParams(...test))
         .filter(libs_1.isString);
-    if (clientSideExperiment.length + serverSideExperiments.length === 0)
+    if (clientSideExperiment.length + serverSideExperiments.length === 0) {
         return null;
+    }
     return [...clientSideExperiment, ...serverSideExperiments];
 };
 /* -- Targeting -- */

package/dist/esm/detectAdBlocker.js

@@ -13,8 +13,9 @@ function adElementBlocked(ad) {
         ad.offsetTop === 0 ||
         ad.offsetWidth === 0 ||
         ad.clientHeight === 0 ||
-        ad.clientWidth === 0)
+        ad.clientWidth === 0) {
         return true;
+    }
     const adStyles = window.getComputedStyle(ad);
     if (adStyles.getPropertyValue('display') === 'none')
         return true;

package/dist/esm/targeting/pick-targeting-values.d.ts

@@ -0,0 +1,28 @@
+declare type ValidTargeting<T, K> = '' extends T ? never : [] extends T ? never : [''] extends T ? never : T extends boolean ? never : T extends NonNullable<T> ? K : never;
+declare type DefinedKeys<T> = {
+    [K in keyof T]-?: ValidTargeting<T[K], K>;
+}[keyof T];
+declare type ObjectWithDefinedValues<T> = Pick<T, DefinedKeys<T>>;
+/**
+ * Picks only keys with targeting values from an object.
+ * A targeting values is defined as either:
+ * - a non-empty string
+ * - an array of non-empty strings
+ *
+ * If you object is read-only, you can safely access properties on the result.
+ * For example:
+ *
+ * ```ts
+ * dirty = {
+ *   valid: 'real',
+ *   invalid: undefined,
+ * } as const;
+ *
+ * clean = pickDefinedValues(dirty);
+ *
+ * // @ts-expect-error -- you can’t access this property
+ * clean.invalid
+ * ```
+ */
+export declare const pickTargetingValues: <T extends Record<string, string | readonly string[] | undefined>>(obj: T) => ObjectWithDefinedValues<T>;
+export {};

package/dist/esm/targeting/pick-targeting-values.js

@@ -0,0 +1,41 @@
+import { isString } from '@guardian/libs';
+const isTargetingString = (string) => isString(string) && string !== '';
+const isTargetingArray = (array) => Array.isArray(array) && array.filter(isTargetingString).length > 0;
+const isValidTargeting = (value) => {
+    if (isTargetingString(value))
+        return true;
+    if (isTargetingArray(value))
+        return true;
+    return false;
+};
+/**
+ * Picks only keys with targeting values from an object.
+ * A targeting values is defined as either:
+ * - a non-empty string
+ * - an array of non-empty strings
+ *
+ * If you object is read-only, you can safely access properties on the result.
+ * For example:
+ *
+ * ```ts
+ * dirty = {
+ *   valid: 'real',
+ *   invalid: undefined,
+ * } as const;
+ *
+ * clean = pickDefinedValues(dirty);
+ *
+ * // @ts-expect-error -- you can’t access this property
+ * clean.invalid
+ * ```
+ */
+export const pickTargetingValues = (obj) => {
+    const initialValue = {};
+    return Object.entries(obj).reduce((valid, [key, value]) => {
+        if (isValidTargeting(value)) {
+            // @ts-expect-error -- isValidTargeting checks this
+            valid[key] = value;
+        }
+        return valid;
+    }, initialValue);
+};

package/dist/esm/targeting/session.js

@@ -41,8 +41,9 @@ const experimentsTargeting = ({ clientSideParticipations, serverSideParticipatio
     const serverSideExperiments = Object.entries(serverSideParticipations)
         .map((test) => testToParams(...test))
         .filter(isString);
-    if (clientSideExperiment.length + serverSideExperiments.length === 0)
+    if (clientSideExperiment.length + serverSideExperiments.length === 0) {
         return null;
+    }
     return [...clientSideExperiment, ...serverSideExperiments];
 };
 /* -- Targeting -- */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@guardian/commercial-core",
-  "version": "0.32.0",
+  "version": "0.33.0",
   "description": "Guardian advertising business logic",
   "homepage": "https://github.com/guardian/commercial-core#readme",
   "bugs": {
@@ -57,7 +57,7 @@
     "@typescript-eslint/parser": "^5.5.0",
     "commitizen": "^4.2.4",
     "cz-conventional-changelog": "^3.3.0",
-    "eslint": "^8.3.0",
+    "eslint": "^8.4.1",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-eslint-comments": "^3.2.0",
     "eslint-plugin-import": "^2.25.3",