Merge pull request #8 from contentstack/feat/DX-533-branch-in-stack-config

feat: branch property in stack config

Author: nadeem-cs

src/lib/contentstack.ts

@@ -69,6 +69,10 @@ export function stack(config: StackConfig): StackClass {
     throw new Error('Environment for Stack is required');
   }
 
+  if (config.branch) {
+    defaultConfig.headers.branch = config.branch;
+  }
+
   if (config.early_access) {
     defaultConfig.headers['x-header-ea'] = config.early_access.join(',');
   }

src/lib/types.ts

@@ -14,6 +14,7 @@ export interface StackConfig extends HttpClientParams {
   apiKey: string;
   deliveryToken: string;
   environment: string;
+  branch?: string;
   early_access?: string[];
   region?: Region;
   locale?: string;

test/api/live-preview.spec.ts

@@ -7,17 +7,20 @@ dotenv.config();
 const apiKey = process.env.API_KEY as string
 const deliveryToken = process.env.DELIVERY_TOKEN as string
 const environment = process.env.ENVIRONMENT as string
+const branch = process.env.BRANCH as string
 
 describe('Live preview tests', () => {
     test('should check for values initialized', () => {
         const stack = contentstack.stack({
             apiKey: apiKey,
             deliveryToken: deliveryToken,
             environment: environment,
+            branch: branch,
         });
         const livePreviewObject = stack.config.live_preview;
         expect(livePreviewObject).toBeUndefined();
         expect(stack.config.host).toBe('cdn.contentstack.io');
+        expect(stack.config.branch).toBe(branch);
     });
 
     test('should check host when live preview is enabled and management token is provided', () => {

test/unit/contentstack.spec.ts

@@ -97,12 +97,14 @@ describe('Contentstack', () => {
       apiKey: 'apiKey',
       deliveryToken: 'delivery',
       environment: 'env',
+      branch: 'branch',
     };
     const stackInstance = createStackInstance(config);
     expect(stackInstance).toBeInstanceOf(Stack);
     expect(stackInstance.config.apiKey).toEqual(config.apiKey);
     expect(stackInstance.config.deliveryToken).toEqual(config.deliveryToken);
     expect(stackInstance.config.environment).toEqual(config.environment);
+    expect(stackInstance.config.branch).toEqual(config.branch);
     done();
   });