renaming env to match analytics repo (#17)

renaming env to match analytics repo #17
yext · Jun 28, 2023 · e894d49 · e894d49
1 parent da7021d
commit e894d49
Show file tree

Hide file tree

Showing 11 changed files with 24 additions and 21 deletions.
diff --git a/docs/chat-core.chatconfig.env.md b/docs/chat-core.chatconfig.env.md
@@ -14,5 +14,5 @@ env?: EnumOrLiteral<Environment>;
 
 ## Remarks
 
-Default to PROD.
+Default to PRODUCTION.
 
diff --git a/docs/chat-core.environment.md b/docs/chat-core.environment.md
@@ -16,6 +16,6 @@ export declare enum Environment
 
 |  Member | Value | Description |
 |  --- | --- | --- |
-|  PROD | <code>&quot;prod&quot;</code> |  |
-|  SANDBOX | <code>&quot;sbx&quot;</code> |  |
+|  PRODUCTION | <code>&quot;PRODUCTION&quot;</code> |  |
+|  SANDBOX | <code>&quot;SANDBOX&quot;</code> |  |
 
diff --git a/etc/chat-core.api.md b/etc/chat-core.api.md
@@ -42,9 +42,9 @@ export type EnumOrLiteral<T extends string> = T | `${T}`;
 // @public
 export enum Environment {
     // (undocumented)
-    PROD = "prod",
+    PRODUCTION = "PRODUCTION",
     // (undocumented)
-    SANDBOX = "sbx"
+    SANDBOX = "SANDBOX"
 }
 
 // @public

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@yext/chat-core",
-  "version": "0.5.0",
+  "version": "0.5.1",
   "description": "Typescript Networking Library for the Yext Chat API",
   "main": "./dist/commonjs/index.js",
   "module": "./dist/esm/index.js",

diff --git a/src/infra/EndpointsFactory.ts b/src/infra/EndpointsFactory.ts
@@ -10,14 +10,17 @@ import { Environment } from "../models/endpoints/Environment";
  */
 export class EndpointsFactory {
   private static getDomain(endpointConfig: EndpointConfig): string {
-    const { region = Region.US, env = Environment.PROD } = endpointConfig;
+    const { region = Region.US, env = Environment.PRODUCTION } = endpointConfig;
     switch (region) {
       case Region.US:
-        return env === Environment.PROD
-          ? "liveapi.yext.com"
-          : `liveapi-${env}.yext.com`;
+        switch (env) {
+          case Environment.SANDBOX:
+            return "liveapi-sbx.yext.com";
+          default:
+            return "liveapi.yext.com";
+        }
       case Region.EU:
-        if (env === Environment.PROD) {
+        if (env === Environment.PRODUCTION) {
           return "cdn.eu.yextapis.com";
         }
         throw new Error(

diff --git a/src/models/ChatConfig.ts b/src/models/ChatConfig.ts
@@ -30,7 +30,7 @@ export interface ChatConfig {
    * Defines the environment of the API domains.
    *
    * @remarks
-   * Default to PROD.
+   * Default to PRODUCTION.
    */
   env?: EnumOrLiteral<Environment>;
   /**

diff --git a/src/models/endpoints/Environment.ts b/src/models/endpoints/Environment.ts
@@ -4,6 +4,6 @@
  * @public
  */
 export enum Environment {
-  PROD = "prod",
-  SANDBOX = "sbx",
+  PRODUCTION = "PRODUCTION",
+  SANDBOX = "SANDBOX",
 }
diff --git a/test-browser-esm/package-lock.json b/test-browser-esm/package-lock.json
diff --git a/test-node-cjs/package-lock.json b/test-node-cjs/package-lock.json
diff --git a/tests/infra/EndPointFactory.test.ts b/tests/infra/EndPointFactory.test.ts
@@ -13,7 +13,7 @@ it("provides proper endpoint for default env, region, and businessId", () => {
 it("provides proper endpoint for custom env", () => {
   const endpoints = EndpointsFactory.getEndpoints({
     botId: "my-bot",
-    env: "sbx",
+    env: "SANDBOX",
   });
   expect(endpoints).toEqual({
     chat: `https://liveapi-sbx.yext.com/v2/accounts/me/chat/my-bot/message`,
@@ -48,7 +48,7 @@ it("throws error on invalid region + env", () => {
     EndpointsFactory.getEndpoints({
       botId: "my-bot",
       region: "eu",
-      env: "sbx",
+      env: "SANDBOX",
     })
-  ).toThrow('Unsupported domain: invalid environment "sbx" for region EU');
+  ).toThrow('Unsupported domain: invalid environment "SANDBOX" for region EU');
 });