Merge pull request #113 from contentstack/staging

Hotfix | 16-01-2025 | setLocale | Release

Author: cs-raj

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@contentstack/delivery-sdk",
-  "version": "4.4.4",
+  "version": "4.4.5",
   "type": "module",
   "license": "MIT",
   "main": "./dist/legacy/index.cjs",
@@ -33,7 +33,7 @@
     "build:types": "node tools/cleanup types && tsc -p config/tsconfig.types.json"
   },
   "dependencies": {
-    "@contentstack/core": "^1.1.3",
+    "@contentstack/core": "^1.1.4",
     "@contentstack/utils": "^1.3.15",
     "@types/humps": "^2.0.6",
     "axios": "^1.7.9",

package.json

@@ -17,9 +17,9 @@ export async function handleRequest(
       const apiResponse = await defaultAdapter(config);
 
       if (apiResponse.data) {
-        cacheStore.setItem(apiKey, apiResponse.data, config.contentTypeUid, cacheOptions.maxAge);
+        cacheStore.setItem(apiKey, JSON.parse(apiResponse.data), config.contentTypeUid, cacheOptions.maxAge);
 
-        return resolve(apiResponse.data);
+        return resolve({data: JSON.parse(apiResponse.data)});
       } else {
         const cacheResponse = cacheStore.getItem(apiKey, config.contentTypeUid);
         if (cacheResponse)
@@ -48,9 +48,9 @@ export async function handleRequest(
       const apiResponse = await defaultAdapter(config);
 
       if (apiResponse.data) {
-        cacheStore.setItem(apiKey, apiResponse.data, config.contentTypeUid, cacheOptions.maxAge);
+        cacheStore.setItem(apiKey, JSON.parse(apiResponse.data), config.contentTypeUid, cacheOptions.maxAge);
 
-        return resolve(apiResponse.data);
+        return resolve({data: JSON.parse(apiResponse.data)});
       } else {
         return reject(apiResponse);
       }
@@ -70,9 +70,9 @@ export async function handleRequest(
         const apiResponse = await defaultAdapter(config);
 
         if (apiResponse.data) {
-          cacheStore.setItem(apiKey, apiResponse.data, config.contentTypeUid, cacheOptions.maxAge);
+          cacheStore.setItem(apiKey, JSON.parse(apiResponse.data), config.contentTypeUid, cacheOptions.maxAge);
 
-          return resolve(apiResponse.data);
+          return resolve({data: JSON.parse(apiResponse.data)});
         } else {
           return reject(apiResponse);
         }

src/lib/cache.ts

@@ -59,6 +59,10 @@ export function stack(config: StackConfig): StackClass {
     throw new Error('Environment for Stack is required');
   }
 
+  if (config.locale) {
+    defaultConfig.params.locale = config.locale;
+  }
+
   if (config.live_preview) {
     if (Utility.isBrowser()) {
       const params = new URL(document.location.toString()).searchParams;

src/lib/contentstack.ts

@@ -114,6 +114,7 @@ export class Stack {
    */
   setLocale(locale: string) {
     this.config.locale = locale;
+    this._client.defaults.params.locale = locale;
   }
 
   /**
@@ -158,10 +159,11 @@ export class Stack {
         };
       } else {
         livePreviewParams = {
-          live_preview: null,
-          contentTypeUid: null,
-          entryUid: null,
-          preview_timestamp: null,
+          ...livePreviewParams,
+          live_preview: "",
+          contentTypeUid: "",
+          entryUid: "",
+          preview_timestamp: "",
           include_applied_variants: false,
         };
       }

src/lib/stack.ts

@@ -3,10 +3,10 @@ import { StorageType } from '../types/storage-type';
 
 export type PersistanceStoreConfig =
   | (Store & PersistanceStoreOptions)
-  | ({ storageType?: StorageType } & PersistanceStoreOptions);
+  | ({ storeType?: StorageType } & PersistanceStoreOptions);
 export interface Store {
   storage: Storage;
-  storageType: 'customStorage';
+  storeType: 'customStorage';
 }
 export interface PersistanceStoreOptions {
   maxAge?: number; // default 24 hrs

src/persistance/config/persistance-storage-config.ts

@@ -11,7 +11,7 @@ export class PersistanceStore {
 
   constructor(config?: PersistanceStoreConfig) {
     let defaultConfig: PersistanceStoreConfig = {
-      storageType: 'localStorage',
+      storeType: 'localStorage',
       maxAge: 1000 * 60 * 60 * 24,
       serializer: JSON.stringify,
       deserializer: JSON.parse,
@@ -20,7 +20,7 @@ export class PersistanceStore {
       ...defaultConfig,
       ...config,
     };
-    this.setStore(defaultConfig.storageType, (defaultConfig as unknown as Store).storage);
+    this.setStore(defaultConfig.storeType, (defaultConfig as unknown as Store).storage);
     this.config = defaultConfig;
     this.name = ''; // TODO add stack api key to name
   }

src/persistance/persistance-store.ts

@@ -28,13 +28,13 @@ describe('Cache handleRequest function', () => {
   describe('NETWORK_ELSE_CACHE policy', () => {
     it('should return network response when proper response is received', async () => {
       const cacheOptions = { policy: Policy.NETWORK_ELSE_CACHE, maxAge: 3600 };
-      const defaultAdapter = jest.fn((_config) => ({ data: 'foo' }));
+      const defaultAdapter = jest.fn((_config) => ({ data: JSON.stringify('foo') }));
       const cacheStore = new PersistanceStore(cacheOptions);
 
       await handleRequest(cacheOptions, apiKey, defaultAdapter, resolve, reject, config);
 
       expect(defaultAdapter).toHaveBeenCalledWith(config);
-      expect(resolve).toBeCalledWith('foo');
+      expect(resolve).toBeCalledWith({"data": "foo"});
       expect(reject).not.toBeCalled();
 
       cacheStore.removeItem(apiKey, config.contentTypeUid);
@@ -97,14 +97,14 @@ describe('Cache handleRequest function', () => {
     });
     it('should return api response when proper cache is not available', async () => {
       const cacheOptions = { policy: Policy.CACHE_THEN_NETWORK, maxAge: 3600 };
-      const defaultAdapter = jest.fn((_config) => ({ data: 'foo' }));
+      const defaultAdapter = jest.fn((_config) => ({ data: JSON.stringify('foo') }));
 
       const cacheStore = new PersistanceStore(cacheOptions);
 
       await handleRequest(cacheOptions, apiKey, defaultAdapter, resolve, reject, config);
 
       expect(defaultAdapter).toHaveBeenCalled();
-      expect(resolve).toBeCalledWith('foo');
+      expect(resolve).toBeCalledWith({"data": "foo"});
       expect(reject).not.toBeCalled();
 
       cacheStore.removeItem(apiKey, config.contentTypeUid);
@@ -150,13 +150,13 @@ describe('Cache handleRequest function', () => {
 
     it('should return network response data when cache is not available', async () => {
       const cacheOptions = { policy: Policy.CACHE_ELSE_NETWORK, maxAge: 3600 };
-      const defaultAdapter = jest.fn((_config) => ({ data: 'foo' }));
+      const defaultAdapter = jest.fn((_config) => ({ data: JSON.stringify('foo') }));
       const cacheStore = new PersistanceStore(cacheOptions);
 
       await handleRequest(cacheOptions, apiKey, defaultAdapter, resolve, reject, config);
 
       expect(defaultAdapter).toHaveBeenCalledWith(config);
-      expect(resolve).toBeCalledWith('foo');
+      expect(resolve).toBeCalledWith({"data": "foo"});
       expect(reject).not.toBeCalled();
 
       cacheStore.removeItem(apiKey, config.contentTypeUid);

test/unit/cache.spec.ts

@@ -7,35 +7,35 @@ describe('persistance store intiialization test', () => {
     expect(persistance).toBeDefined();
     expect(persistance.config).toBeDefined();
     expect(persistance.config.maxAge).toEqual(86400000);
-    expect(persistance.config.storageType).toEqual('localStorage');
+    expect(persistance.config.storeType).toEqual('localStorage');
   });
 
   it('should initialize persistance with name and local storage type ', () => {
-    const storageType = 'localStorage';
-    const persistance = makePersistance({ storageType });
+    const storeType = 'localStorage';
+    const persistance = makePersistance({ storeType });
     expect(persistance).toBeDefined();
     expect(persistance.config).toBeDefined();
     expect(persistance.config.maxAge).toEqual(86400000);
-    expect(persistance.config.storageType).toEqual(storageType);
+    expect(persistance.config.storeType).toEqual(storeType);
   });
   it('should initialize persistance with name and memory storage type ', () => {
-    const storageType = 'memoryStorage';
-    const persistance = makePersistance({ storageType });
+    const storeType = 'memoryStorage';
+    const persistance = makePersistance({ storeType });
     expect(persistance).toBeDefined();
     expect(persistance.config).toBeDefined();
     expect(persistance.config.maxAge).toEqual(86400000);
-    expect(persistance.config.storageType).toEqual(storageType);
+    expect(persistance.config.storeType).toEqual(storeType);
   });
   it('should initialize persistance with name and local storage type ', () => {
-    const storageType = 'customStorage';
-    const persistance = makePersistance({ storageType });
+    const storeType = 'customStorage';
+    const persistance = makePersistance({ storeType });
     expect(persistance).toBeDefined();
     expect(persistance.config).toBeDefined();
     expect(persistance.config.maxAge).toEqual(86400000);
-    expect(persistance.config.storageType).toEqual(storageType);
+    expect(persistance.config.storeType).toEqual(storeType);
   });
   it('should throw error on custom storage without storage', () => {
-    const config: any = { name: 'foobar', storageType: 'customStorage' };
+    const config: any = { name: 'foobar', storeType: 'customStorage' };
     config.storage = '';
     const persistance = () => {
       new PersistanceStore(config);
@@ -162,6 +162,6 @@ describe('persistance with 0 maxAge', () => {
   });
 });
 
-function makePersistance(config: { storageType: StorageType | 'customStorage' }) {
-  return new PersistanceStore({ storageType: config.storageType, storage: memoryStorage });
+function makePersistance(config: { storeType: StorageType | 'customStorage' }) {
+  return new PersistanceStore({ storeType: config.storeType, storage: memoryStorage });
 }

test/unit/persistance/preference-store.spec.ts

@@ -32,6 +32,7 @@ describe('Stack class tests', () => {
     });
 
     stack = new Stack(client, config() as StackConfig);
+    client.defaults.params = {};
   });
   it('should test import of class Stack', (done) => {
     expect(stack).toBeInstanceOf(Stack);
@@ -95,10 +96,11 @@ describe('Stack class tests', () => {
     stack.livePreviewQuery(query);
 
     expect(stack.getClient().stackConfig.live_preview).toEqual({
-      live_preview: null,
-      contentTypeUid: null,
-      entryUid: null,
-      preview_timestamp: null,
+      live_preview: '',
+      contentTypeUid: '',
+      entryUid: '',
+      enable: false,
+      preview_timestamp: '',
       include_applied_variants: false,
     });
   });