EventsSDK: Remove Enums (#125)

We learned that using enums in TypeScript is bad practice in favor of
types. This updates `Environment`, `Region`, and `VersionLabel` files to
use types instead of enums. In addition, we delete the EnumOrString type
and update `setupRequestUrl` and relevant tests.

[J=FUS-6202 ](https://yexttest.atlassian.net/browse/FUS-6202)
R=abenno, mtian
TEST=auto

---------

Co-authored-by: Ethan Jaffee <ejaffee@yext.com>

docs/analytics.environment.md

@@ -9,9 +9,8 @@ The Yext Environments
 **Signature:**
 
 ```typescript
-export type Environment = EnumOrString<EnvironmentEnum>;
+export type Environment = 'PRODUCTION' | 'SANDBOX' | 'production' | 'sandbox';
 ```
-**References:** [EnumOrString](./analytics.enumorstring.md)<!-- -->, [EnvironmentEnum](./analytics.environmentenum.md)
 
 ## Remarks
 

docs/analytics.md

@@ -4,14 +4,6 @@
 
 ## analytics package
 
-## Enumerations
-
-|  Enumeration | Description |
-|  --- | --- |
-|  [EnvironmentEnum](./analytics.environmentenum.md) | An enum for the Yext Environments |
-|  [RegionEnum](./analytics.regionenum.md) | An enum of the physical region the Yext account |
-|  [VersionLabelEnum](./analytics.versionlabelenum.md) | An enum for the Search Version Labels |
-
 ## Functions
 
 |  Function | Description |
@@ -32,8 +24,7 @@
 |  Type Alias | Description |
 |  --- | --- |
 |  [Action](./analytics.action.md) | The action types accepted by the Analytics Events API. |
-|  [EnumOrString](./analytics.enumorstring.md) | A TypeScript utility type which creates a union of an enum member and its string representation. |
 |  [Environment](./analytics.environment.md) | The Yext Environments |
 |  [Region](./analytics.region.md) | The physical region of the Yext account |
-|  [VersionLabel](./analytics.versionlabel.md) | The Search Version Label |
+|  [VersionLabel](./analytics.versionlabel.md) | An enum for the Search Version Labels |
 

docs/analytics.region.md

@@ -9,9 +9,8 @@ The physical region of the Yext account
 **Signature:**
 
 ```typescript
-export type Region = EnumOrString<RegionEnum>;
+export type Region = 'US' | 'EU' | 'us' | 'eu';
 ```
-**References:** [EnumOrString](./analytics.enumorstring.md)<!-- -->, [RegionEnum](./analytics.regionenum.md)
 
 ## Remarks
 

docs/analytics.versionlabel.md

@@ -4,14 +4,13 @@
 
 ## VersionLabel type
 
-The Search Version Label
+An enum for the Search Version Labels
 
 **Signature:**
 
 ```typescript
-export type VersionLabel = EnumOrString<VersionLabelEnum>;
+export type VersionLabel = 'PRODUCTION' | 'STAGING';
 ```
-**References:** [EnumOrString](./analytics.enumorstring.md)<!-- -->, [VersionLabelEnum](./analytics.versionlabelenum.md)
 
 ## Remarks
 

etc/analytics.api.md

@@ -27,17 +27,7 @@ export interface AnalyticsEventService {
 }
 
 // @public
-export type EnumOrString<T extends string> = T | `${T}`;
-
-// @public
-export type Environment = EnumOrString<EnvironmentEnum>;
-
-// @public
-export enum EnvironmentEnum {
-    // (undocumented)
-    Production = "PRODUCTION",
-    Sandbox = "SANDBOX"
-}
+export type Environment = 'PRODUCTION' | 'SANDBOX' | 'production' | 'sandbox';
 
 // @public
 export interface EventPayload {
@@ -100,29 +90,13 @@ export interface EventPayload {
 }
 
 // @public
-export type Region = EnumOrString<RegionEnum>;
-
-// @public
-export enum RegionEnum {
-    // (undocumented)
-    EU = "eu",
-    // (undocumented)
-    US = "us"
-}
+export type Region = 'US' | 'EU' | 'us' | 'eu';
 
 // @public
 export function reportBrowserAnalytics(): Promise<string>;
 
 // @public
-export type VersionLabel = EnumOrString<VersionLabelEnum>;
-
-// @public
-export enum VersionLabelEnum {
-    // (undocumented)
-    Production = "PRODUCTION",
-    // (undocumented)
-    Staging = "STAGING"
-}
+export type VersionLabel = 'PRODUCTION' | 'STAGING';
 
 // (No @packageDocumentation comment for this package)
 

src/Environment.ts

@@ -1,18 +1,3 @@
-import { EnumOrString } from './EnumOrString';
-/**
- * An enum for the Yext Environments
- *
- * @remarks
- * Affects the domain the requests are sent to.
- *
- * @public
- */
-export enum EnvironmentEnum {
-  Production = 'PRODUCTION',
-  /** unsupported in the EU region */
-  Sandbox = 'SANDBOX'
-}
-
 /**
  * The Yext Environments
  *
@@ -21,4 +6,4 @@ export enum EnvironmentEnum {
  *
  * @public
  */
-export type Environment = EnumOrString<EnvironmentEnum>;
+export type Environment = 'PRODUCTION' | 'SANDBOX' | 'production' | 'sandbox';

src/Region.ts

@@ -1,17 +1,3 @@
-import { EnumOrString } from './EnumOrString';
-/**
- * An enum of the physical region the Yext account
- *
- * @remarks
- * Affects the domain the requests are sent to.
- *
- * @public
- */
-export enum RegionEnum {
-  US = 'us',
-  EU = 'eu'
-}
-
 /**
  * The physical region of the Yext account
  *
@@ -20,4 +6,5 @@ export enum RegionEnum {
  *
  * @public
  */
-export type Region = EnumOrString<RegionEnum>;
+
+export type Region = 'US' | 'EU' | 'us' | 'eu';

src/VersionLabel.ts

@@ -1,5 +1,3 @@
-import { EnumOrString } from './EnumOrString';
-
 /**
  * An enum for the Search Version Labels
  *
@@ -8,17 +6,4 @@ import { EnumOrString } from './EnumOrString';
  *
  * @public
  */
-export enum VersionLabelEnum {
-  Production = 'PRODUCTION',
-  Staging = 'STAGING'
-}
-
-/**
- * The Search Version Label
- *
- * @remarks
- * Affects the contents of the versionLabel field in the search object field in the event payload.
- *
- * @public
- */
-export type VersionLabel = EnumOrString<VersionLabelEnum>;
+export type VersionLabel = 'PRODUCTION' | 'STAGING';

src/index.ts

@@ -50,7 +50,6 @@ export * from './AnalyticsEventService';
 export * from './Environment';
 export * from './Region';
 export * from './EventPayload';
-export * from './EnumOrString';
 export * from './Action';
 export * from './VersionLabel';
 

src/setupRequestUrl.ts

@@ -1,16 +1,18 @@
-import { Environment, EnvironmentEnum } from './Environment';
-import { Region, RegionEnum } from './Region';
+import { Environment } from './Environment';
+import { Region } from './Region';
 
 const urlBase = 'yextevents.com/accounts/me/events';
 
 export function setupRequestUrl(env?: Environment, region?: Region): string {
-  if (env === EnvironmentEnum.Sandbox && region === RegionEnum.EU) {
+  const isSandbox = env === 'SANDBOX';
+  const lowerRegion = region?.toLowerCase();
+  if (isSandbox && lowerRegion === 'eu') {
     throw new Error('Sandbox environment is not available in the EU region.');
   }
   return (
     'https://' +
-    (env === EnvironmentEnum.Sandbox ? 'sbx.' : '') +
-    (region ?? 'us') +
+    (isSandbox ? 'sbx.' : '') +
+    (lowerRegion ?? 'us') +
     '.' +
     urlBase
   );

test-cdn/index.html

@@ -13,7 +13,7 @@
       const analyticsProvider = window.AnalyticsSDK.analytics({
         key: '<INSERT YEXT API KEY HERE>',
         sessionTrackingEnabled: false,
-        region: 'eu'
+        region: 'EU'
       }).with({
         action: 'CHAT_LINK_CLICK',
         pageUrl: 'http://www.yext-test-pageurl.com',