@saasquatch/component-environment 1.0.2 → 1.0.4-0

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2023 ReferralSaaSquatch.com, Inc.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2023 ReferralSaaSquatch.com, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,46 +1,46 @@
-Provides the environment for running SaaSquatch web components.
-
-SaaSquatch web components can run in a number of different environments, including:
-
-- in a widget via `squatch-js`
-- in a microsite (portal)
-- in a mobile SDK (i.e. `squatch-android`)
-- in the admin portal
-
-In each environment, a different set of context information about the tenant, user and program are provided, and the goal of this package is to normalize the differences in environments to provide a common API.
-
-The environment is provided in a set of contexts through `dom-context`, which provides vanilla global context providers. They can be accessed through a raw `ContextListener` or via `useDomContext` in `dom-context-hooks`.
-
-## General environment
-
-### `getEnvironment()`
-
-Get the environment type. The current possible values are: `SquatchJS2`, `SquatchAndroid`, `SquatchPortal`, `SquatchAdmin` or `None`.
-
-### `isDemo()`
-
-Returns whether components should run in demo/preview mode.
-
-### `getTenantAlias()`
-
-Get the current tenant alias.
-
-### `getAppDomain()`
-
-Get the SaaSquatch app domain.
-
-### `getEngagementMedium()`
-
-Get the current engagement medium. This is particularly important in widgets rendered by `squatch-js` for informing metadata about share link clicks.
-
-## User identity
-
-The user identity context name is exported in a constant `USER_CONTEXT_NAME`. The current value can be retrieved with `getUserIdentity()` and set with `setUserIdentity(identity)`.
-
-## Locale
-
-The locale context name is exported in a constnat `LOCALE_CONTEXT_NAME`. The current value can be retrieved with `getLocale()` and set with `setLocal(locale)`.
-
-## Program ID
-
-The program ID context name is exported in a constant `PROGRAM_CONTEXT_NAME`. The current value can be retrieved with `getProgramId()` and set with `setProgramId(programId)`.
+Provides the environment for running SaaSquatch web components.
+
+SaaSquatch web components can run in a number of different environments, including:
+
+- in a widget via `squatch-js`
+- in a microsite (portal)
+- in a mobile SDK (i.e. `squatch-android`)
+- in the admin portal
+
+In each environment, a different set of context information about the tenant, user and program are provided, and the goal of this package is to normalize the differences in environments to provide a common API.
+
+The environment is provided in a set of contexts through `dom-context`, which provides vanilla global context providers. They can be accessed through a raw `ContextListener` or via `useDomContext` in `dom-context-hooks`.
+
+## General environment
+
+### `getEnvironment()`
+
+Get the environment type. The current possible values are: `SquatchJS2`, `SquatchAndroid`, `SquatchPortal`, `SquatchAdmin` or `None`.
+
+### `isDemo()`
+
+Returns whether components should run in demo/preview mode.
+
+### `getTenantAlias()`
+
+Get the current tenant alias.
+
+### `getAppDomain()`
+
+Get the SaaSquatch app domain.
+
+### `getEngagementMedium()`
+
+Get the current engagement medium. This is particularly important in widgets rendered by `squatch-js` for informing metadata about share link clicks.
+
+## User identity
+
+The user identity context name is exported in a constant `USER_CONTEXT_NAME`. The current value can be retrieved with `getUserIdentity()` and set with `setUserIdentity(identity)`.
+
+## Locale
+
+The locale context name is exported in a constnat `LOCALE_CONTEXT_NAME`. The current value can be retrieved with `getLocale()` and set with `setLocal(locale)`.
+
+## Program ID
+
+The program ID context name is exported in a constant `PROGRAM_CONTEXT_NAME`. The current value can be retrieved with `getProgramId()` and set with `setProgramId(programId)`.

package/dist/index.d.ts

@@ -137,6 +137,9 @@ declare type EnvironmentSDK = {
     type: "SquatchAndroid";
     android: SquatchAndroid;
     widgetIdent: WidgetIdent;
+} | {
+    type: "SquatchIOS";
+    widgetIdent: WidgetIdent;
 } | {
     type: "SquatchPortal";
     env: PortalEnv;

package/dist/index.js

@@ -79,7 +79,7 @@ function getEnvironment() {
   return getEnvironmentSDK().type;
 }
 function getEnvironmentSDK() {
-  var _a, _b;
+  var _a, _b, _c;
   if (window["SquatchAndroid"]) {
     return {
       type: "SquatchAndroid",
@@ -87,6 +87,12 @@ function getEnvironmentSDK() {
       widgetIdent: window["widgetIdent"]
     };
   }
+  if (window["SquatchIOS"]) {
+    return {
+      type: "SquatchIOS",
+      widgetIdent: window["widgetIdent"]
+    };
+  }
   if (window["SquatchPortal"]) {
     return {
       type: "SquatchPortal",
@@ -99,10 +105,10 @@ function getEnvironmentSDK() {
       adminSDK: window["SquatchAdmin"]
     };
   }
-  if (window["widgetIdent"] && ((_a = window["widgetIdent"]) == null ? void 0 : _a.env) !== "demo") {
+  if (((_a = window.frameElement) == null ? void 0 : _a["squatchJsApi"]) && ((_b = window["widgetIdent"]) == null ? void 0 : _b.env) !== "demo") {
     return {
       type: "SquatchJS2",
-      api: (_b = window.frameElement) == null ? void 0 : _b["squatchJsApi"],
+      api: (_c = window.frameElement) == null ? void 0 : _c["squatchJsApi"],
       widgetIdent: window["widgetIdent"]
     };
   }
@@ -116,11 +122,13 @@ function isDemo() {
 }
 var FAKE_TENANT = "demo";
 function getTenantAlias() {
+  var _a;
   const sdk = getEnvironmentSDK();
   switch (sdk.type) {
     case "SquatchAndroid":
+    case "SquatchIOS":
     case "SquatchJS2":
-      return sdk.widgetIdent.tenantAlias;
+      return (_a = sdk.widgetIdent) == null ? void 0 : _a.tenantAlias;
     case "SquatchAdmin":
     case "None":
       return FAKE_TENANT;
@@ -130,25 +138,28 @@ function getTenantAlias() {
 }
 var DEFAULT_DOMAIN = "https://app.referralsaasquatch.com";
 function getAppDomain() {
-  var _a;
+  var _a, _b;
   const sdk = getEnvironmentSDK();
   switch (sdk.type) {
     case "SquatchAndroid":
+    case "SquatchIOS":
     case "SquatchJS2":
-      return sdk.widgetIdent.appDomain;
+      return ((_a = sdk.widgetIdent) == null ? void 0 : _a.appDomain) || DEFAULT_DOMAIN;
     case "SquatchPortal":
-      return ((_a = sdk.env) == null ? void 0 : _a.appDomain) || DEFAULT_DOMAIN;
+      return ((_b = sdk.env) == null ? void 0 : _b.appDomain) || DEFAULT_DOMAIN;
     case "SquatchAdmin":
     case "None":
       return DEFAULT_DOMAIN;
   }
 }
 function getEngagementMedium() {
+  var _a;
   const sdk = getEnvironmentSDK();
   switch (sdk.type) {
     case "SquatchJS2":
-      return sdk.widgetIdent.engagementMedium || DEFAULT_MEDIUM;
+      return ((_a = sdk.widgetIdent) == null ? void 0 : _a.engagementMedium) || DEFAULT_MEDIUM;
     case "SquatchAndroid":
+    case "SquatchIOS":
     case "SquatchPortal":
     case "SquatchAdmin":
     case "None":
@@ -511,9 +522,11 @@ function userIdentityFromJwt(jwt) {
       userId = decoded.user.id;
     }
     if (!userId || !accountId) {
+      debug6("No user information");
       return void 0;
     }
     if (exp && Date.now() >= exp * 1e3) {
+      debug6("JWT has expired");
       return void 0;
     }
     return {
@@ -522,14 +535,21 @@ function userIdentityFromJwt(jwt) {
       jwt
     };
   } catch (e) {
+    debug6("Invalid JWT");
     return void 0;
   }
 }
 function _getInitialValue() {
   const sdk = getEnvironmentSDK();
   switch (sdk.type) {
+    case "SquatchIOS":
     case "SquatchAndroid":
     case "SquatchJS2":
+      if (!sdk.widgetIdent)
+        return void 0;
+      const { userId, accountId, token } = sdk.widgetIdent;
+      if (!userId || !accountId || !token)
+        return void 0;
       return {
         id: sdk.widgetIdent.userId,
         accountId: sdk.widgetIdent.accountId,

package/dist/index.mjs

@@ -30,7 +30,7 @@ function getEnvironment() {
   return getEnvironmentSDK().type;
 }
 function getEnvironmentSDK() {
-  var _a, _b;
+  var _a, _b, _c;
   if (window["SquatchAndroid"]) {
     return {
       type: "SquatchAndroid",
@@ -38,6 +38,12 @@ function getEnvironmentSDK() {
       widgetIdent: window["widgetIdent"]
     };
   }
+  if (window["SquatchIOS"]) {
+    return {
+      type: "SquatchIOS",
+      widgetIdent: window["widgetIdent"]
+    };
+  }
   if (window["SquatchPortal"]) {
     return {
       type: "SquatchPortal",
@@ -50,10 +56,10 @@ function getEnvironmentSDK() {
       adminSDK: window["SquatchAdmin"]
     };
   }
-  if (window["widgetIdent"] && ((_a = window["widgetIdent"]) == null ? void 0 : _a.env) !== "demo") {
+  if (((_a = window.frameElement) == null ? void 0 : _a["squatchJsApi"]) && ((_b = window["widgetIdent"]) == null ? void 0 : _b.env) !== "demo") {
     return {
       type: "SquatchJS2",
-      api: (_b = window.frameElement) == null ? void 0 : _b["squatchJsApi"],
+      api: (_c = window.frameElement) == null ? void 0 : _c["squatchJsApi"],
       widgetIdent: window["widgetIdent"]
     };
   }
@@ -67,11 +73,13 @@ function isDemo() {
 }
 var FAKE_TENANT = "demo";
 function getTenantAlias() {
+  var _a;
   const sdk = getEnvironmentSDK();
   switch (sdk.type) {
     case "SquatchAndroid":
+    case "SquatchIOS":
     case "SquatchJS2":
-      return sdk.widgetIdent.tenantAlias;
+      return (_a = sdk.widgetIdent) == null ? void 0 : _a.tenantAlias;
     case "SquatchAdmin":
     case "None":
       return FAKE_TENANT;
@@ -81,25 +89,28 @@ function getTenantAlias() {
 }
 var DEFAULT_DOMAIN = "https://app.referralsaasquatch.com";
 function getAppDomain() {
-  var _a;
+  var _a, _b;
   const sdk = getEnvironmentSDK();
   switch (sdk.type) {
     case "SquatchAndroid":
+    case "SquatchIOS":
     case "SquatchJS2":
-      return sdk.widgetIdent.appDomain;
+      return ((_a = sdk.widgetIdent) == null ? void 0 : _a.appDomain) || DEFAULT_DOMAIN;
     case "SquatchPortal":
-      return ((_a = sdk.env) == null ? void 0 : _a.appDomain) || DEFAULT_DOMAIN;
+      return ((_b = sdk.env) == null ? void 0 : _b.appDomain) || DEFAULT_DOMAIN;
     case "SquatchAdmin":
     case "None":
       return DEFAULT_DOMAIN;
   }
 }
 function getEngagementMedium() {
+  var _a;
   const sdk = getEnvironmentSDK();
   switch (sdk.type) {
     case "SquatchJS2":
-      return sdk.widgetIdent.engagementMedium || DEFAULT_MEDIUM;
+      return ((_a = sdk.widgetIdent) == null ? void 0 : _a.engagementMedium) || DEFAULT_MEDIUM;
     case "SquatchAndroid":
+    case "SquatchIOS":
     case "SquatchPortal":
     case "SquatchAdmin":
     case "None":
@@ -462,9 +473,11 @@ function userIdentityFromJwt(jwt) {
       userId = decoded.user.id;
     }
     if (!userId || !accountId) {
+      debug6("No user information");
       return void 0;
     }
     if (exp && Date.now() >= exp * 1e3) {
+      debug6("JWT has expired");
       return void 0;
     }
     return {
@@ -473,14 +486,21 @@ function userIdentityFromJwt(jwt) {
       jwt
     };
   } catch (e) {
+    debug6("Invalid JWT");
     return void 0;
   }
 }
 function _getInitialValue() {
   const sdk = getEnvironmentSDK();
   switch (sdk.type) {
+    case "SquatchIOS":
     case "SquatchAndroid":
     case "SquatchJS2":
+      if (!sdk.widgetIdent)
+        return void 0;
+      const { userId, accountId, token } = sdk.widgetIdent;
+      if (!userId || !accountId || !token)
+        return void 0;
       return {
         id: sdk.widgetIdent.userId,
         accountId: sdk.widgetIdent.accountId,

package/package.json

@@ -1,38 +1,38 @@
-{
-  "name": "@saasquatch/component-environment",
-  "version": "1.0.2",
-  "description": "Environment and contexts for SaaSquatch components",
-  "main": "dist/index.js",
-  "module": "dist/index.mjs",
-  "files": [
-    "dist/"
-  ],
-  "scripts": {
-    "build": "tsup src/index.ts --format esm,cjs --dts",
-    "test": "jest"
-  },
-  "engines": {
-    "node": ">=16.15"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/saasquatch/program-tools",
-    "directory": "packages/component-environment"
-  },
-  "author": "ReferralSaaSquatch.com, Inc.",
-  "license": "MIT",
-  "devDependencies": {
-    "@types/jest": "^28.1.4",
-    "jest": "^28.1.2",
-    "jest-environment-jsdom": "^28.1.2",
-    "ts-jest": "^28.0.5",
-    "ts-node": "^10.8.2",
-    "tsup": "^6.1.2",
-    "typescript": "^4.7.3"
-  },
-  "dependencies": {
-    "@wry/equality": "^0.5.2",
-    "dom-context": "^1.2.0",
-    "jwt-decode": "^3.1.2"
-  }
-}
+{
+  "name": "@saasquatch/component-environment",
+  "version": "1.0.4-0",
+  "description": "Environment and contexts for SaaSquatch components",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "files": [
+    "dist/"
+  ],
+  "scripts": {
+    "build": "tsup src/index.ts --format esm,cjs --dts",
+    "test": "jest"
+  },
+  "engines": {
+    "node": ">=16.15"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/saasquatch/program-tools",
+    "directory": "packages/component-environment"
+  },
+  "author": "ReferralSaaSquatch.com, Inc.",
+  "license": "MIT",
+  "devDependencies": {
+    "@types/jest": "^28.1.4",
+    "jest": "^28.1.2",
+    "jest-environment-jsdom": "^28.1.2",
+    "ts-jest": "^28.0.5",
+    "ts-node": "^10.8.2",
+    "tsup": "^6.1.2",
+    "typescript": "^4.7.3"
+  },
+  "dependencies": {
+    "@wry/equality": "^0.5.2",
+    "dom-context": "^1.2.0",
+    "jwt-decode": "^3.1.2"
+  }
+}