nimiq-supply-calculator 0.0.1-security → 1.0.0

package/src/utils/getTrackerInfo.ts

@@ -0,0 +1,10 @@
+import { Config } from '../types';
+import getTrackerCategory from './getTrackerCategory';
+import trackerMatches from './trackerMatches';
+
+const getTrackerInfo = (trackerId: string, config: Config) => {
+  const trackingCategory = getTrackerCategory(trackerId, config);
+  return trackingCategory?.trackers.find((tracker) => trackerMatches(tracker, trackerId));
+};
+
+export default getTrackerInfo;

package/src/utils/hasConsent.test.ts

@@ -0,0 +1,64 @@
+import { REQUIRED_COOKIE_MANAGER_COOKIES } from '../constants';
+import config from '../examples/config';
+import { Region, TrackingCategory, TrackingPreference } from '../types';
+import hasConsent from './hasConsent';
+
+describe('hasConsent', () => {
+  let preference: TrackingPreference;
+  beforeEach(() => {
+    preference = {
+      region: Region.DEFAULT,
+      consent: [
+        TrackingCategory.NECESSARY,
+        TrackingCategory.PERFORMANCE,
+        TrackingCategory.FUNCTIONAL,
+        TrackingCategory.TARGETING,
+      ],
+    };
+  });
+
+  it('defaults to false if cookie is uncategorized', () => {
+    expect(hasConsent('random_cookie', config, preference)).toEqual(false);
+  });
+
+  it('returns true for required cookie', () => {
+    preference = {
+      region: Region.DEFAULT,
+      consent: [TrackingCategory.PERFORMANCE],
+    };
+
+    expect(hasConsent('logged_in', config, preference)).toEqual(true);
+  });
+
+  it('returns true for cookies that are required to function', () => {
+    preference = {
+      region: Region.DEFAULT,
+      consent: [TrackingCategory.PERFORMANCE],
+    };
+    REQUIRED_COOKIE_MANAGER_COOKIES.map((c) => {
+      expect(hasConsent(c, config, preference)).toEqual(true);
+    });
+  });
+
+  it('returns the correct consent', () => {
+    preference = {
+      region: Region.DEFAULT,
+      consent: [TrackingCategory.PERFORMANCE],
+    };
+    // Default
+    expect(hasConsent('device_id', config, preference)).toEqual(true);
+    expect(hasConsent('locale', config, preference)).toEqual(true);
+
+    // EU
+    preference = {
+      region: Region.EU,
+      consent: [TrackingCategory.PERFORMANCE],
+    };
+    expect(hasConsent('device_id', config, preference)).toEqual(true);
+    preference = {
+      region: Region.EU,
+      consent: [TrackingCategory.FUNCTIONAL],
+    };
+    expect(hasConsent('g_clid', config, preference)).toEqual(false);
+  });
+});

package/src/utils/hasConsent.ts

@@ -0,0 +1,32 @@
+import { REQUIRED_COOKIE_MANAGER_COOKIES } from '../constants';
+import { Config, TrackingPreference } from '../types';
+import getTrackerCategory from './getTrackerCategory';
+
+/**
+ * Used for determining if a specific tracker has user consent.
+ * It follows the following logic in order:
+ * 1) If we don't have a tracker category in the config then dont allow
+ * 2) If cookie is in a required category then allow
+ * 3) If cookie is required for cookie manager to function then allow
+ * 4) Determine consent from user consent preferences
+ */
+const hasConsent = (
+  tracker: string,
+  config: Config,
+  trackingPreference: TrackingPreference
+): boolean => {
+  const trackingCategory = getTrackerCategory(tracker, config);
+
+  if (REQUIRED_COOKIE_MANAGER_COOKIES.includes(tracker)) {
+    return true;
+  }
+  if (!trackingCategory) {
+    return false;
+  }
+  if (trackingCategory.required) {
+    return true;
+  }
+  return trackingPreference.consent.includes(trackingCategory.id);
+};
+
+export default hasConsent;

package/src/utils/isMaxKBSize.test.ts

@@ -0,0 +1,10 @@
+import isMaxKBSize from './isMaxKBSize';
+
+describe('isMaxKBSize', () => {
+  it('returns true when string exceeds max kb size', () => {
+    expect(isMaxKBSize('helloooooooo', 0.01)).toEqual(true);
+  });
+  it('returns false when string does not max kb size', () => {
+    expect(isMaxKBSize('hello', 0.01)).toEqual(false);
+  });
+});

package/src/utils/isMaxKBSize.ts

@@ -0,0 +1,7 @@
+import { KB } from '../constants';
+
+const isMaxKBSize = (str: string, max: number) => {
+  return Buffer.from(str).length / KB > max;
+};
+
+export default isMaxKBSize;

package/src/utils/isOptOut.test.ts

@@ -0,0 +1,14 @@
+import { Region } from '../types';
+import isOptOut from './isOptOut';
+
+describe('isOptOut', () => {
+  it('uses default rule if there is no rule for a region', () => {
+    // @ts-expect-error we are deliberately passing a wrong value
+    expect(isOptOut('US')).toEqual(true);
+  });
+
+  it('returns the correct value', () => {
+    expect(isOptOut(Region.EU)).toEqual(false);
+    expect(isOptOut(Region.DEFAULT)).toEqual(true);
+  });
+});

package/src/utils/isOptOut.ts

@@ -0,0 +1,28 @@
+import { GEOLOCATION_RULES } from '../constants';
+import { Framework, Region } from '../types';
+
+/**
+ * Used for determining the if current region is using the optOut framework
+ * It follows the following logic in order:
+ * 1) If there's no geolocation rule for the specified region
+ *  then use the rule for DEFAULT region
+ *  - Otherwise use the DEFAULT_FRAMEWORK
+ * 2) Use geolocation rule
+ */
+
+/**
+ * optIn: Users must opt in to tracking (EU)
+ * optOut: Users must opt out of tracking (non-EU)
+ * We use the most restrictive framework (optIn) if we don't know the framework
+ */
+
+const isOptOut = (region: Region) => {
+  const rule = GEOLOCATION_RULES.find((r) => r.region === region);
+
+  if (!rule) {
+    return true;
+  }
+  return rule.framework === Framework.OPT_OUT;
+};
+
+export default isOptOut;

package/src/utils/persistMobileAppPreferences.ts

@@ -0,0 +1,32 @@
+/*
+ * The purpose here is to allow the iOS/Android app to send a is_mobile_app=true
+ * parameter that should indicate to the web surfaces not to show the
+ * cookie banner
+ *
+ */
+
+import { IS_MOBILE_APP } from '../constants';
+import { getDomainWithoutSubdomain } from './getDomain';
+
+export function persistMobileAppPreferences() {
+  try {
+    const isMobileApp = getIsMobileAppFromQueryParams();
+    if (isMobileApp) {
+      document.cookie = `${IS_MOBILE_APP}=true; domain=${getDomainWithoutSubdomain()}`;
+    }
+  } catch (e) {
+    // Ignore, we are not in a browser.
+  }
+}
+
+export function getIsMobileAppFromQueryParams() {
+  try {
+    const params = new URLSearchParams(window.location.search);
+    const isWebView = params.get('webview') === 'true';
+    const isMobileApp = params.get(IS_MOBILE_APP) === 'true';
+    return Boolean(isWebView || isMobileApp);
+  } catch (e) {
+    // Ignore, we are not in a browser.
+  }
+  return false;
+}

package/src/utils/setGTMVariables.test.ts

@@ -0,0 +1,20 @@
+import { AdTrackingPreference, Region, TrackingCategory, TrackingPreference } from '../types';
+import setGTMVariables from './setGTMVariables';
+
+describe('SetGTMVariables', () => {
+  it('is able to set GTM Variables', () => {
+    const preference: TrackingPreference = {
+      consent: [TrackingCategory.NECESSARY],
+      region: Region.EU,
+    };
+    const adTrackingPreference: AdTrackingPreference = {
+      value: true,
+      updated_at: 1,
+    };
+    setGTMVariables(preference, adTrackingPreference);
+    expect(window.dataLayer).toEqual([
+      { consent: [TrackingCategory.NECESSARY] },
+      { adConsent: 'true' },
+    ]);
+  });
+});

package/src/utils/setGTMVariables.ts

@@ -0,0 +1,17 @@
+import { AdTrackingPreference, TrackingPreference } from '../types';
+
+const setGTMVariables = (
+  preference: TrackingPreference,
+  adTrackingPreference: AdTrackingPreference
+) => {
+  if (typeof window !== 'undefined') {
+    if (!window.dataLayer) window.dataLayer = [];
+    const gtmData = [
+      { consent: preference.consent },
+      { adConsent: adTrackingPreference.value.toString() },
+    ];
+    window.dataLayer.push(...gtmData);
+  }
+};
+
+export default setGTMVariables;

package/src/utils/setTrackingPreference.ts

@@ -0,0 +1,36 @@
+import { CookieAttributes } from 'js-cookie';
+
+import {
+  DEFAULT_CONSENT_PREFERENCES_COOKIE,
+  EU_CONSENT_PREFERENCES_COOKIE,
+  PREFERENCE_EXPIRATION_YEAR,
+} from '../constants';
+import { Region, TrackingPreference } from '../types';
+import { getDomainWithoutSubdomain } from './getDomain';
+
+const setTrackingPreference = (
+  setCookie: (name: string, value: any, options?: CookieAttributes) => void,
+  newConsentPreference: TrackingPreference,
+  region: Region,
+  onPreferenceChange?: (preference: TrackingPreference) => void
+) => {
+  const expiration = PREFERENCE_EXPIRATION_YEAR * 365;
+
+  const cookieOptions = {
+    expires: expiration,
+    domain: getDomainWithoutSubdomain(),
+    path: '/',
+  };
+
+  if (region === 'EU') {
+    setCookie(EU_CONSENT_PREFERENCES_COOKIE, newConsentPreference, cookieOptions);
+  } else {
+    setCookie(DEFAULT_CONSENT_PREFERENCES_COOKIE, newConsentPreference, cookieOptions);
+  }
+
+  if (onPreferenceChange) {
+    onPreferenceChange(newConsentPreference);
+  }
+};
+
+export default setTrackingPreference;

package/src/utils/trackerMatches.test.ts

@@ -0,0 +1,13 @@
+import { Tracker, TrackerType } from '../types';
+import trackerMatches from './trackerMatches';
+
+describe('TrackerMatches', () => {
+  it('it is able to detect the cookie matches the tracker', () => {
+    const tracker: Tracker = {
+      id: 'id-regex',
+      type: TrackerType.COOKIE,
+      regex: 'id(?:_[a-f0-9]{32}|undefined)(?:.*)',
+    };
+    expect(trackerMatches(tracker, 'id_ac7a5c3da45e3612b44543a702e42b01')).toEqual(true);
+  });
+});

package/src/utils/trackerMatches.ts

@@ -0,0 +1,12 @@
+import { Tracker } from '../types';
+
+const trackerMatches = (tracker: Tracker, id: string) => {
+  if (tracker.regex) {
+    const re = new RegExp(tracker.regex);
+    return re.test(id);
+  } else {
+    return tracker.id === id;
+  }
+};
+
+export default trackerMatches;

package/tsconfig.json

@@ -0,0 +1,112 @@
+{
+  "compilerOptions": {
+    "jsx": "react",
+    /* Visit https://aka.ms/tsconfig to read more about this file */
+
+    /* Projects */
+    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+    /* Language and Environment */
+    "target": "es2016",                                  /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
+    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    // "jsx": "preserve",                                /* Specify what JSX code is generated. */
+    // "experimentalDecorators": true,                   /* Enable experimental support for legacy experimental decorators. */
+    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
+    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
+    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
+
+    /* Modules */
+    "module": "commonjs",                                /* Specify what module code is generated. */
+    "rootDir": "./src",                                  /* Specify the root folder within your source files. */
+    // "moduleResolution": "node10",                     /* Specify how TypeScript looks up a file from a given module specifier. */
+    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+    // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
+    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
+    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
+    // "allowImportingTsExtensions": true,               /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
+    // "resolvePackageJsonExports": true,                /* Use the package.json 'exports' field when resolving package imports. */
+    // "resolvePackageJsonImports": true,                /* Use the package.json 'imports' field when resolving imports. */
+    // "customConditions": [],                           /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
+    // "resolveJsonModule": true,                        /* Enable importing .json files. */
+    // "allowArbitraryExtensions": true,                 /* Enable importing files with any extension, provided a declaration file is present. */
+    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
+
+    /* JavaScript Support */
+    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
+    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
+
+    /* Emit */
+    "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+    // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
+    "outDir": "./dist",                                   /* Specify an output folder for all emitted files. */
+    // "removeComments": true,                           /* Disable emitting comments. */
+    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types. */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
+    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
+    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+    // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
+
+    /* Interop Constraints */
+    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "verbatimModuleSyntax": true,                     /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
+    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+    "esModuleInterop": true,                             /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true,            /* Ensure that casing is correct in imports. */
+
+    /* Type Checking */
+    "strict": true,                                      /* Enable all strict type-checking options. */
+    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
+    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
+    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
+    // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    // "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
+    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
+    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
+    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true                                 /* Skip type checking all .d.ts files. */
+  },
+  "include": ["./src/**/*.ts", "./src/**/*.tsx"],
+  "exclude": ["./src/**/*.test.ts", "./src/**/*.test.tsx"]
+}