@saasquatch/squatch-js 2.4.0 → 2.4.1-0

package/README.md

@@ -1,144 +1,144 @@
-# Referral SaaSquatch Javascript SDK
-
-## Install the library
-
-To integrate any SaaSquatch program to your website or web app, copy/paste this snippet of JavaScript above the `</head>` tag of your page:
-
-```html
-<script type="text/javascript">
-!function(a,b){a("squatch","https://fast.ssqt.io/squatch-js@2",b)}(function(a,b,c){var d,e,f;c["_"+a]={},c[a]={},c[a].ready=function(b){c["_" + a].ready =  c["_" + a].ready || [];c["_" + a].ready.push(b);},e=document.createElement("script"),e.async=1,e.src=b,f=document.getElementsByTagName("script")[0],f.parentNode.insertBefore(e,f)},this);
-</script>
-```
-
-Or load the library synchronously from our CDN:
-
-```html
-<script src="https://fast.ssqt.io/squatch-js@2" type="text/javascript"></script>
-```
-
-
-## Getting Started
-The `init` function lets you configure your global squatch instance.
-
-Note: `engagementMedium` is required in the `squatch.widgets()` functions if you want to load the widget. Otherwise, Squatch.js will look for your portal settings and render the widget that's mapped to the URL where this snippet is included.
-
-```html
-<script type="text/javascript">
-  squatch.ready(function() {
-
-    // Always call init
-    squatch.init({
-      tenantAlias: "YOUR_TENANT_ALIAS",     // String (required)
-    });
-  
-    squatch.widgets().upsertUser({
-      user: {                               // Object (required)
-        id: 'USER_ID',                      // String (required)
-        accountId: 'USER_ACCOUNT_ID',       // String (required)
-        email: 'USER_EMAIL',                // String (optional)
-        firstName: 'USER_FIRST_NAME',       // String (optional)
-        lastName: 'USER_LAST_NAME',         // String (optional)
-  
-        ...
-      },
-      engagementMedium: 'EMBED',                    // String (optional: POPUP, EMBED)
-      widgetType: 'p/PROGRAM-ID/w/referrerWidget',  // Update PROGRAM-ID
-      jwt: 'TOKEN'                                  // String (required by default, or disable Security in the portal)
-
-  });
-</script>
-```
-
-## Data Only Operations
-You can create/upsert users without loading a widget.
-
-```html
-<script type="text/javascript">
-  squatch.ready(function() {
-
-    // Always call init
-    squatch.init({
-      tenantAlias: "YOUR_TENANT_ALIAS"      // String (required)
-    });
-
-    var user;
-
-    squatch.api().upsertUser({
-      user: {                               // Object (required)
-        id: 'USER_ID',                      // String (required)
-        accountId: 'USER_ACCOUNT_ID',       // String (required)
-        email: 'USER_EMAIL',                // String (optional)
-        firstName: 'USER_FIRST_NAME',       // String (optional)
-        lastName: 'USER_LAST_NAME',         // String (optional)
-        ...
-      },
-      engagementMedium: 'EMBED',                    // String (optional: POPUP, EMBED)
-      widgetType: 'p/PROGRAM-ID/w/referrerWidget',  // Update PROGRAM-ID
-      jwt: 'TOKEN'                                  // String (required)
-    }).then(function(response) {
-      user = response.user;
-    }).catch(function(err){
-      console.log(err);
-    });
-
-    // autofill
-    var element = document.getElementById('my_coupon');
-    element.value = user.referredBy.code;
-
-  });
-</script>
-```
-
-## Get Referral Cookie Code
-You can also use the `api()` function to call the WidgetApi methods directly.
-
-```html
-<script type="text/javascript">
-  squatch.ready(function(){
-
-    // Always call init
-    squatch.init({tenantAlias: 'YOUR_TENANT_ALIAS'});
-
-
-    var element = document.getElementById('my_coupon');
-
-    squatch.api().squatchReferralCookie().then(function(response) {
-      /* `response.codes` looks like `{"program_id":"NEWCO", "friend_program":"BOB"}` */
-      
-      element.value = response.codes["program-id"];
-    });
-
-  });
-</script>
-```
-
-Want more control? Visit our [guide](https://github.com/saasquatch/squatch-js/blob/master/docs/docs.md).
-
-
-## Install via NPM and Webpack (advanced)
-
-Squatch.js can also be installed via NPM and bundled into your application with Webpack.
-
-```ssh
-# via npm
-$ npm install @saasquatch/squatch-js
-```
-
-```js
-import * as squatch from "@saasquatch/squatch-js";
-
-// Always call init
-squatch.init({
-  tenantAlias: "YOUR_TENANT_ALIAS"      // String (required)
-});
-
-// Don't need to wait for .ready when importing via NPM/Webpack
-squatch.api().upsertUser({...});
-
-```
-
-## Contributing
-This is an open source project! If you are interested in contributing please look at [contributing guidelines](CONTRIBUTING.md) first.
-
-## Support
-Shoot us an email at [support@saasqt.ch](mailto:support@saasqt.ch) if you need help!
+# Referral SaaSquatch Javascript SDK
+
+## Install the library
+
+To integrate any SaaSquatch program to your website or web app, copy/paste this snippet of JavaScript above the `</head>` tag of your page:
+
+```html
+<script type="text/javascript">
+!function(a,b){a("squatch","https://fast.ssqt.io/squatch-js@2",b)}(function(a,b,c){var d,e,f;c["_"+a]={},c[a]={},c[a].ready=function(b){c["_" + a].ready =  c["_" + a].ready || [];c["_" + a].ready.push(b);},e=document.createElement("script"),e.async=1,e.src=b,f=document.getElementsByTagName("script")[0],f.parentNode.insertBefore(e,f)},this);
+</script>
+```
+
+Or load the library synchronously from our CDN:
+
+```html
+<script src="https://fast.ssqt.io/squatch-js@2" type="text/javascript"></script>
+```
+
+
+## Getting Started
+The `init` function lets you configure your global squatch instance.
+
+Note: `engagementMedium` is required in the `squatch.widgets()` functions if you want to load the widget. Otherwise, Squatch.js will look for your portal settings and render the widget that's mapped to the URL where this snippet is included.
+
+```html
+<script type="text/javascript">
+  squatch.ready(function() {
+
+    // Always call init
+    squatch.init({
+      tenantAlias: "YOUR_TENANT_ALIAS",     // String (required)
+    });
+  
+    squatch.widgets().upsertUser({
+      user: {                               // Object (required)
+        id: 'USER_ID',                      // String (required)
+        accountId: 'USER_ACCOUNT_ID',       // String (required)
+        email: 'USER_EMAIL',                // String (optional)
+        firstName: 'USER_FIRST_NAME',       // String (optional)
+        lastName: 'USER_LAST_NAME',         // String (optional)
+  
+        ...
+      },
+      engagementMedium: 'EMBED',                    // String (optional: POPUP, EMBED)
+      widgetType: 'p/PROGRAM-ID/w/referrerWidget',  // Update PROGRAM-ID
+      jwt: 'TOKEN'                                  // String (required by default, or disable Security in the portal)
+
+  });
+</script>
+```
+
+## Data Only Operations
+You can create/upsert users without loading a widget.
+
+```html
+<script type="text/javascript">
+  squatch.ready(function() {
+
+    // Always call init
+    squatch.init({
+      tenantAlias: "YOUR_TENANT_ALIAS"      // String (required)
+    });
+
+    var user;
+
+    squatch.api().upsertUser({
+      user: {                               // Object (required)
+        id: 'USER_ID',                      // String (required)
+        accountId: 'USER_ACCOUNT_ID',       // String (required)
+        email: 'USER_EMAIL',                // String (optional)
+        firstName: 'USER_FIRST_NAME',       // String (optional)
+        lastName: 'USER_LAST_NAME',         // String (optional)
+        ...
+      },
+      engagementMedium: 'EMBED',                    // String (optional: POPUP, EMBED)
+      widgetType: 'p/PROGRAM-ID/w/referrerWidget',  // Update PROGRAM-ID
+      jwt: 'TOKEN'                                  // String (required)
+    }).then(function(response) {
+      user = response.user;
+    }).catch(function(err){
+      console.log(err);
+    });
+
+    // autofill
+    var element = document.getElementById('my_coupon');
+    element.value = user.referredBy.code;
+
+  });
+</script>
+```
+
+## Get Referral Cookie Code
+You can also use the `api()` function to call the WidgetApi methods directly.
+
+```html
+<script type="text/javascript">
+  squatch.ready(function(){
+
+    // Always call init
+    squatch.init({tenantAlias: 'YOUR_TENANT_ALIAS'});
+
+
+    var element = document.getElementById('my_coupon');
+
+    squatch.api().squatchReferralCookie().then(function(response) {
+      /* `response.codes` looks like `{"program_id":"NEWCO", "friend_program":"BOB"}` */
+      
+      element.value = response.codes["program-id"];
+    });
+
+  });
+</script>
+```
+
+Want more control? Visit our [guide](https://github.com/saasquatch/squatch-js/blob/master/docs/docs.md).
+
+
+## Install via NPM and Webpack (advanced)
+
+Squatch.js can also be installed via NPM and bundled into your application with Webpack.
+
+```ssh
+# via npm
+$ npm install @saasquatch/squatch-js
+```
+
+```js
+import * as squatch from "@saasquatch/squatch-js";
+
+// Always call init
+squatch.init({
+  tenantAlias: "YOUR_TENANT_ALIAS"      // String (required)
+});
+
+// Don't need to wait for .ready when importing via NPM/Webpack
+squatch.api().upsertUser({...});
+
+```
+
+## Contributing
+This is an open source project! If you are interested in contributing please look at [contributing guidelines](CONTRIBUTING.md) first.
+
+## Support
+Shoot us an email at [support@saasqt.ch](mailto:support@saasqt.ch) if you need help!

package/SECURITY.md

@@ -1,10 +1,10 @@
-# Reporting Security Issues
-The SaaSquatch team takes security bugs seriously. We appreciate your efforts to responsibly disclose your findings.
-
-To report a security issue, email security@referralsaasquatch.com and provide as much information as you can about the discovered issue.
-
-The SaaSquatch team will send a response indicating the next steps in handling your report. After the initial reply to your report, the security team will keep you informed of the progress towards a fix, and may ask for additional information or guidance.
-
-Report security bugs in third-party modules to the person or team maintaining the module.
-
-For more information, please see SaaSquatch's Responsible Disclosure Policy at https://www.saasquatch.com/disclosure/.
+# Reporting Security Issues
+The SaaSquatch team takes security bugs seriously. We appreciate your efforts to responsibly disclose your findings.
+
+To report a security issue, email security@referralsaasquatch.com and provide as much information as you can about the discovered issue.
+
+The SaaSquatch team will send a response indicating the next steps in handling your report. After the initial reply to your report, the security team will keep you informed of the progress towards a fix, and may ask for additional information or guidance.
+
+Report security bugs in third-party modules to the person or team maintaining the module.
+
+For more information, please see SaaSquatch's Responsible Disclosure Policy at https://www.saasquatch.com/disclosure/.

package/babelregister.js

@@ -1,16 +1,16 @@
-// Cucumber babel config file
-// overrides node's require and runs through babel/typescript
-// based on https://github.com/microsoft/TypeScript-Babel-Starter/blob/master/.babelrc
-require("@babel/register")({
-  extensions: [".js", ".jsx", ".ts", ".tsx"],
-  presets: ["@babel/preset-env", "@babel/preset-typescript"],
-  plugins: [
-    [
-      "@babel/plugin-transform-runtime",
-      {
-        corejs: 2,
-      },
-    ],
-    "@babel/plugin-proposal-class-properties",
-  ],
-});
+// Cucumber babel config file
+// overrides node's require and runs through babel/typescript
+// based on https://github.com/microsoft/TypeScript-Babel-Starter/blob/master/.babelrc
+require("@babel/register")({
+  extensions: [".js", ".jsx", ".ts", ".tsx"],
+  presets: ["@babel/preset-env", "@babel/preset-typescript"],
+  plugins: [
+    [
+      "@babel/plugin-transform-runtime",
+      {
+        corejs: 2,
+      },
+    ],
+    "@babel/plugin-proposal-class-properties",
+  ],
+});

package/cucumber.js

@@ -1,45 +1,45 @@
-// cucumber.js
-// const dotenv = require('dotenv');
-const os = require("os");
-// dotenv.config();
-
-/**
- *
- * Configures Cucumber
- *
- * Sets up the required stuff to make React code operate nicely in a Node environment
- *
- * Source: https://medium.com/@Charles_Stover/behavior-driven-react-development-with-cucumber-faf596d9d71b
- *
- */
-const CPU_COUNT = os.cpus().length;
-const IS_DEV = process.env.NODE_ENV === "development";
-const FAIL_FAST = IS_DEV ? ["--fail-fast"] : [];
-const FORMAT =
-  process.env.CI || !process.stdout.isTTY ? "progress" : "progress-bar";
-
-exports.default = [
-  ...FAIL_FAST,
-  `--format ${FORMAT}`,
-  `--parallel ${CPU_COUNT}`,
-
-  // "test/**/*.feature",
-  "../blackbox-testing/features/**/*.feature",
-
-  `--tags "@testsuite:squatch-js and not @skip"`,
-
-  // Babel and jsDom make our code work as if it's in the browser
-  //   "--require-module jsdom-global/register",
-  //   "--require-module ts-node/register",
-  "--require-module " + __dirname + "/babelregister.js",
-  // '--require-module source-map-support/register',
-
-  // Order matters -- these setups need to happen first
-  //   "--require tests/cucumber-setup/loaders.ts",
-
-  // Step definitions go last
-  "--require test/step_definitions/**/*.ts",
-  "--require test/step_definitions/**/*.tsx",
-
-  // '--format usage',
-].join(" ");
+// cucumber.js
+// const dotenv = require('dotenv');
+const os = require("os");
+// dotenv.config();
+
+/**
+ *
+ * Configures Cucumber
+ *
+ * Sets up the required stuff to make React code operate nicely in a Node environment
+ *
+ * Source: https://medium.com/@Charles_Stover/behavior-driven-react-development-with-cucumber-faf596d9d71b
+ *
+ */
+const CPU_COUNT = os.cpus().length;
+const IS_DEV = process.env.NODE_ENV === "development";
+const FAIL_FAST = IS_DEV ? ["--fail-fast"] : [];
+const FORMAT =
+  process.env.CI || !process.stdout.isTTY ? "progress" : "progress-bar";
+
+exports.default = [
+  ...FAIL_FAST,
+  `--format ${FORMAT}`,
+  `--parallel ${CPU_COUNT}`,
+
+  // "test/**/*.feature",
+  "../blackbox-testing/features/**/*.feature",
+
+  `--tags "@testsuite:squatch-js and not @skip"`,
+
+  // Babel and jsDom make our code work as if it's in the browser
+  //   "--require-module jsdom-global/register",
+  //   "--require-module ts-node/register",
+  "--require-module " + __dirname + "/babelregister.js",
+  // '--require-module source-map-support/register',
+
+  // Order matters -- these setups need to happen first
+  //   "--require tests/cucumber-setup/loaders.ts",
+
+  // Step definitions go last
+  "--require test/step_definitions/**/*.ts",
+  "--require test/step_definitions/**/*.tsx",
+
+  // '--format usage',
+].join(" ");

package/demo/generate.tsx

@@ -1,39 +1,39 @@
-import { fromURL, popup } from "./sandbox";
-import { rest, setupWorker } from "msw";
-import classic from "./templates/classic";
-import MintGA from "./templates/MintGA";
-import VanillaGA from "./templates/VanillaGA";
-import { getQueryStringParams } from "./util";
-import QuirksVanillaGA from "./templates/QuirksVanillaGA";
-import QuirksMintGA from "./templates/QuirksMintGA";
-import MintGAContainer from "./templates/MintGAContainer";
-import VanillaGANoContainer from "./templates/VanillaGANoContainer";
-import MintGAContainerDisplayBlock from "./templates/MintGAContainerDisplayBlock";
-import QuirksMintGAContainerDisplayBlock from "./templates/QuirksMintGAContainerDisplayBlock";
-import QuirksMintGAContainer from "./templates/QuirksMintGAContainer";
-
-export const widgets = {
-  classic,
-  MintGA,
-  VanillaGA,
-  QuirksVanillaGA,
-  QuirksMintGA,
-  MintGAContainer,
-  MintGAContainerDisplayBlock,
-  QuirksMintGAContainerDisplayBlock,
-  QuirksMintGAContainer,
-  VanillaGANoContainer,
-};
-
-export const handlers = window["mockWidget"] && [
-  rest.put("https://staging.referralsaasquatch.com/api/*", (req, res, ctx) => {
-    return res(
-      ctx.status(202, "Mocked status"),
-      ctx.json(widgets[window["mockWidget"]])
-    );
-  }),
-];
-// Setup requests interception using the given handlers.
-
-export const worker = setupWorker(...handlers);
-window["sandbox"] = fromURL();
+import { fromURL, popup } from "./sandbox";
+import { rest, setupWorker } from "msw";
+import classic from "./templates/classic";
+import MintGA from "./templates/MintGA";
+import VanillaGA from "./templates/VanillaGA";
+import { getQueryStringParams } from "./util";
+import QuirksVanillaGA from "./templates/QuirksVanillaGA";
+import QuirksMintGA from "./templates/QuirksMintGA";
+import MintGAContainer from "./templates/MintGAContainer";
+import VanillaGANoContainer from "./templates/VanillaGANoContainer";
+import MintGAContainerDisplayBlock from "./templates/MintGAContainerDisplayBlock";
+import QuirksMintGAContainerDisplayBlock from "./templates/QuirksMintGAContainerDisplayBlock";
+import QuirksMintGAContainer from "./templates/QuirksMintGAContainer";
+
+export const widgets = {
+  classic,
+  MintGA,
+  VanillaGA,
+  QuirksVanillaGA,
+  QuirksMintGA,
+  MintGAContainer,
+  MintGAContainerDisplayBlock,
+  QuirksMintGAContainerDisplayBlock,
+  QuirksMintGAContainer,
+  VanillaGANoContainer,
+};
+
+export const handlers = window["mockWidget"] && [
+  rest.put("https://staging.referralsaasquatch.com/api/*", (req, res, ctx) => {
+    return res(
+      ctx.status(202, "Mocked status"),
+      ctx.json(widgets[window["mockWidget"]])
+    );
+  }),
+];
+// Setup requests interception using the given handlers.
+
+export const worker = setupWorker(...handlers);
+window["sandbox"] = fromURL();

package/demo/index.d.ts

@@ -1,15 +1,15 @@
-declare interface Sandbox {
-  script: string;
-  version?: string;
-  domain: string;
-  tenantAlias: string;
-  debug?: boolean;
-  initObj: {
-    widgetType: string;
-    engagementMedium: string;
-    user: {
-      [key: string]: any;
-    };
-    jwt: string;
-  };
-}
+declare interface Sandbox {
+  script: string;
+  version?: string;
+  domain: string;
+  tenantAlias: string;
+  debug?: boolean;
+  initObj: {
+    widgetType: string;
+    engagementMedium: string;
+    user: {
+      [key: string]: any;
+    };
+    jwt: string;
+  };
+}