Merge pull request #38 from contentstack/fix/DX-1894

[DX-1894], added support for custom region
contentstack · Dec 18, 2024 · e3c76c8 · e3c76c8
2 parents 3e294b8 + aef8a9d
commit e3c76c8
Show file tree

Hide file tree

Showing 8 changed files with 231 additions and 151 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@contentstack/types-generator",
-  "version": "2.0.2",
+  "version": "2.0.3",
   "description": "Contentstack type definition generation library",
   "private": false,
   "author": "Contentstack",
@@ -42,9 +42,9 @@
     "typescript": "^5.4.5"
   },
   "dependencies": {
-    "@contentstack/delivery-sdk": "^4.2.0",
+    "@contentstack/delivery-sdk": "^4.4.3",
     "@gql2ts/from-schema": "^2.0.0-4",
-    "axios": "^1.7.5",
+    "axios": "^1.7.8",
     "lodash": "^4.17.21",
     "prettier": "^3.3.3"
   },

diff --git a/src/constants/index.ts b/src/constants/index.ts
@@ -1,3 +1,11 @@
 export const TOKEN_TYPE = {
   DELIVERY: "delivery",
 };
+
+export const REGIONS = {
+  US: "US",
+  EU: "EU",
+  AZURE_NA: "AZURE_NA",
+  AZURE_EU: "AZURE_EU",
+  GCP_NA: "GCP_NA",
+};
diff --git a/src/generateTS/index.ts b/src/generateTS/index.ts
@@ -9,8 +9,6 @@ import { defaultInterfaces } from "./stack/builtins";
 import { format } from "../format/index";
 import { ContentType } from "../types/schema";
 
-const validRegions = ["US", "EU", "AZURE_NA", "AZURE_EU", "GCP_NA"];
-
 export const generateTS = async ({
   token,
   tokenType,
@@ -21,6 +19,7 @@ export const generateTS = async ({
   prefix,
   includeDocumentation,
   systemFields,
+  host,
 }: GenerateTS) => {
   try {
     if (!token || !tokenType || !apiKey || !environment || !region) {
@@ -31,20 +30,14 @@ export const generateTS = async ({
       };
     }
 
-    if (!validRegions.includes(region)) {
-      throw {
-        type: "validation",
-        error_message:
-          "Please provide a valid region, supported regions are :  (US, EU, AZURE_NA, AZURE_EU, GCP_NA)",
-      };
-    }
     if (tokenType === TOKEN_TYPE.DELIVERY) {
       const Stack = initializeContentstackSdk({
         apiKey,
         token,
         environment,
         region,
         branch,
+        host,
       });
 
       const contentTypeQuery = Stack.contentType();

diff --git a/src/sdk/utils.ts b/src/sdk/utils.ts
@@ -1,38 +1,53 @@
 import Contentstack, { Region } from "@contentstack/delivery-sdk";
 import { StackConnectionConfig } from "../types";
+import { REGIONS } from "../constants";
 
 export const initializeContentstackSdk = ({
   apiKey,
   token,
   environment,
   region,
   branch,
+  host,
 }: StackConnectionConfig) => {
   try {
+    let isCustomRegion = false;
     const regionVal: Region | undefined = (function (regionValue: string) {
       switch (regionValue) {
-        case "US":
+        case REGIONS.US:
           return Region.US;
-        case "EU":
+        case REGIONS.EU:
           return Region.EU;
-        case "AZURE_NA":
+        case REGIONS.AZURE_NA:
           return Region.AZURE_NA;
-        case "AZURE_EU":
+        case REGIONS.AZURE_EU:
           return Region.AZURE_EU;
-        case "GCP_NA":
+        case REGIONS.GCP_NA:
           return Region.GCP_NA;
         default:
-          return undefined;
+          isCustomRegion = true;
+          break;
       }
     })(region as string);
 
-    const Stack = Contentstack.stack({
-      apiKey: apiKey,
-      deliveryToken: token,
-      environment,
-      region: regionVal,
-      branch: branch,
-    });
+    let Stack;
+    if (isCustomRegion && host) {
+      Stack = Contentstack.stack({
+        apiKey: apiKey,
+        deliveryToken: token,
+        environment,
+        host: host,
+        branch: branch,
+      });
+    } else {
+      Stack = Contentstack.stack({
+        apiKey: apiKey,
+        deliveryToken: token,
+        environment,
+        region: regionVal,
+        branch: branch,
+      });
+    }
 
     return Stack;
   } catch (err: any) {

diff --git a/src/types/index.ts b/src/types/index.ts
@@ -4,6 +4,7 @@ export interface StackConnectionConfig {
   region: "US" | "EU" | "AZURE_NA" | "AZURE_EU" | "GCP_NA";
   environment: string;
   branch?: string;
+  host?: string;
 }
 
 export interface GenerateTSBase extends StackConnectionConfig {

diff --git a/tests/integration/generateTS/generateTS.test.ts b/tests/integration/generateTS/generateTS.test.ts
@@ -137,9 +137,7 @@ describe("generateTS function with errors", () => {
         branch,
       });
     } catch (err: any) {
-      expect(err.error_message).toEqual(
-        "Please provide a valid region, supported regions are :  (US, EU, AZURE_NA, AZURE_EU, GCP_NA)"
-      );
+      expect(err.error_message).toEqual("Something went wrong");
     }
   });
 

diff --git a/tests/unit/generateTS/generateTS.test.ts b/tests/unit/generateTS/generateTS.test.ts
@@ -191,9 +191,7 @@ describe("generateTS function with errors", () => {
         branch,
       });
     } catch (err: any) {
-      expect(err.error_message).toEqual(
-        "Please provide a valid region, supported regions are :  (US, EU, AZURE_NA, AZURE_EU, GCP_NA)"
-      );
+      expect(err.error_message).toEqual("Something went wrong");
     }
   });