@apolitical/gtm 1.0.0-rc.0

package/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.1] - 2021-02-22
+### Fixed
+- Initial setup
+
+## [0.1.0] - 2021-02-22
+### Added
+- Initial setup

package/README.md

@@ -0,0 +1,60 @@
+# Apolitical GTM
+
+Browser library to interact with Google Tag Manager (GTM)
+
+## Requirements
+
+Requires the following to run:
+
+- [node.js][node] 16.13.0+
+- [yarn][yarn]
+
+[node]: https://nodejs.org/en/download/
+[yarn]: https://classic.yarnpkg.com/en/docs/install
+
+## Installation
+
+Install with `yarn`:
+
+```sh
+yarn add @apolitical/gtm
+```
+
+## Available Scripts
+
+In the project directory, you can run:
+### `yarn run test`
+
+Runs the test (and the interactive mode can be enabled with `--watchAll`).
+
+### `yarn build`
+
+Builds the library for production to the `build` folder.
+It correctly bundles the code on production mode and optimizes the build for the best performance.
+
+### `yarn publish`
+
+Publishes the library to NPM.
+
+## Usage
+
+The recommended way to use `@apolitical/gtm` is to set the context with the appropriate parameters:
+
+```js
+const { setContext, runExample } = require('@apolitical/gtm');
+
+setContext({ origin: 'some-url' });
+```
+
+And then, you can query Contentful as you like:
+
+```js
+runExample();
+```
+
+## Troubleshooting
+
+### Usage of other libraries within your library
+
+- Add the library as a dependency in `package.json` (effectively requiring the calling project to provide this dependency)
+- Add the Contentful library as a dependency in `package.json`. By default, only the library code is published, meaning that the Contentful library needs to be installed separately

package/build/index.js

@@ -0,0 +1 @@
+!function(e,t){"object"==typeof exports&&"object"==typeof module?module.exports=t():"function"==typeof define&&define.amd?define([],t):"object"==typeof exports?exports.ApoliticalGTM=t():e.ApoliticalGTM=t()}(this,(function(){return function(){"use strict";var e={d:function(t,o){for(var n in o)e.o(o,n)&&!e.o(t,n)&&Object.defineProperty(t,n,{enumerable:!0,get:o[n]})},o:function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},r:function(e){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})}},t={};e.r(t),e.d(t,{runExample:function(){return a},setContext:function(){return i}});const{APOLITICAL:{WEBSITES:o,ENVIRONMENTS:n}}={APOLITICAL:{WEBSITES:{BETA:"https://beta.apolitical.co",BETA_2:"https://beta-2.apolitical.co",LIVE:"https://apolitical.co",RC:"https://rc.apolitical.co"},ENVIRONMENTS:{BETA:"beta",BETA_2:"beta",RC:"rc",LIVE:"master"}}};let r={environment:null};const i=({environment:e,origin:t=null})=>{r.environment=e||(e=>{let t,r=null;switch(r="undefined"!=typeof window?window.origin||window.location.origin:e,r){case o.BETA:t=n.BETA;break;case o.BETA_2:t=n.BETA_2;break;case o.LIVE:t=n.LIVE;break;case o.RC:t=n.RC;break;default:t=n.BETA}return t})(t)},c=()=>r,a=()=>{const e=c();return console.warn(e),!0};return t}()}));

package/package.json

@@ -0,0 +1,98 @@
+{
+  "name": "@apolitical/gtm",
+  "version": "1.0.0-rc.0",
+  "description": "Browser library to interact with Google Tag Manager (GTM)",
+  "author": "Apolitical Group Limited <engineering@apolitical.co>",
+  "license": "MIT",
+  "main": "build/index.js",
+  "files": [
+    "build/**"
+  ],
+  "scripts": {
+    "test": "jest --runInBand",
+    "unit-test": "jest test/unit/* --bail --runInBand --passWithNoTests",
+    "integration-test": "jest test/integration/* --bail --runInBand --passWithNoTests",
+    "build": "webpack --config webpack.config.js",
+    "lint": "eslint --ext .js ./lib",
+    "format": "prettier --write 'lib/**/*.+(js|json)'",
+    "lint-format": "lint-staged",
+    "prepare": "husky install",
+    "prepack": "yarn build"
+  },
+  "keywords": [
+    "JavaScript",
+    "Library",
+    "Template"
+  ],
+  "dependencies": {},
+  "peerDependencies": {},
+  "devDependencies": {
+    "@apolitical/eslint-config": "1.0.2",
+    "@babel/core": "7.16.12",
+    "@babel/eslint-parser": "7.16.5",
+    "@babel/plugin-transform-runtime": "7.16.10",
+    "@babel/preset-env": "7.16.11",
+    "husky": "7.0.4",
+    "jest": "27.4.7",
+    "jest-junit": "13.0.0",
+    "lint-staged": "12.3.2",
+    "webpack": "5.67.0",
+    "webpack-cli": "4.9.2"
+  },
+  "eslintConfig": {
+    "extends": [
+      "@apolitical/eslint-config/base.config"
+    ],
+    "env": {
+      "browser": true
+    },
+    "parser": "@babel/eslint-parser"
+  },
+  "prettier": "@apolitical/eslint-config/prettier.config",
+  "browserslist": {
+    "production": [
+      ">0.2%",
+      "not dead",
+      "not op_mini all",
+      "ie 11"
+    ]
+  },
+  "jest": {
+    "bail": true,
+    "clearMocks": true,
+    "collectCoverage": true,
+    "collectCoverageFrom": [
+      "<rootDir>/lib/**/*.js"
+    ],
+    "coveragePathIgnorePatterns": [
+      "<rootDir>/node_modules/"
+    ],
+    "setupFiles": [
+      "./test/setupTests.js"
+    ],
+    "reporters": [
+      "default",
+      "jest-junit"
+    ],
+    "testResultsProcessor": "jest-junit"
+  },
+  "babel": {
+    "presets": [
+      "@babel/preset-env"
+    ],
+    "env": {
+      "test": {
+        "plugins": [
+          "@babel/plugin-transform-runtime"
+        ]
+      }
+    }
+  },
+  "engines": {
+    "node": ">=16.13.0"
+  },
+  "lint-staged": {
+    "*.js": "eslint --cache --fix --ignore-path .gitignore",
+    "*.+(js|json)": "prettier --write --ignore-path .gitignore"
+  }
+}