@akinon/next 1.23.0 → 1.24.0-rc.1

package/CHANGELOG.md

@@ -1,5 +1,29 @@
 # @akinon/next
 
+## 1.24.0-rc.1
+
+### Patch Changes
+
+- 9b10323: ZERO-2440: Add type declarations for @akinon/pz-otp modules
+
+## 1.24.0-rc.0
+
+### Minor Changes
+
+- 8bc6085: ZERO-2472: RTK Query Invalidate
+- 02a3c58: ZERO-2460: Breadcrumb checks for undefined values
+- 0181251: ZERO-2440: move otp popup state to redux
+- 07cc81a: Add infinite and more types to pagination
+- 8d6caba: ZERO-2434: enhance error handling and logging in appFetch function
+- b4452e9: ZERO-2463: Refactor Sentry initialization and add Sentry DSN option to settings
+- b2da5e4: Revert ZERO-2435
+
+### Patch Changes
+
+- da1e501: ZERO-2296: Fix ROUTES import
+- 2e44646: ZERO-2434: Fix category URL in getCategoryDataHandler function
+- 2e9476c: ZERO-2434: remove error throwing in appFetch
+
 ## 1.23.0
 
 ### Minor Changes

package/api/auth.ts

@@ -220,6 +220,17 @@ const nextAuthOptions = (req: NextApiRequest, res: NextApiResponse) => {
     pages: {
       signIn: ROUTES.AUTH,
       error: ROUTES.AUTH
+    },
+    cookies: {
+      sessionToken: {
+        name: `__Secure-next-auth.session-token`,
+        options: {
+          httpOnly: true,
+          sameSite: 'none',
+          path: '/',
+          secure: true
+        }
+      }
     }
   };
 };

package/data/client/address.ts

@@ -32,10 +32,12 @@ const addressApi = api.injectEndpoints({
       query: () => buildClientRequestUrl(address.getRetailStore)
     }),
     getRetailStoreCities: builder.query<GetResponse<any>, string>({
-      query: (country) => buildClientRequestUrl(address.getRetailStoreCities(country))
+      query: (country) =>
+        buildClientRequestUrl(address.getRetailStoreCities(country))
     }),
     getRetailStoreTownships: builder.query<GetResponse<any>, string>({
-      query: (city) => buildClientRequestUrl(address.getRetailStoreTownships(city))
+      query: (city) =>
+        buildClientRequestUrl(address.getRetailStoreTownships(city))
     }),
     addAddress: builder.mutation<Address, Partial<Address>>({
       query: (body) => ({
@@ -48,7 +50,7 @@ const addressApi = api.injectEndpoints({
           type: body.is_corporate === 'true' ? 'corporate' : 'personal'
         }
       }),
-      invalidatesTags: ['Addresses', 'Checkout'] // TODO: Invalidate one of these tags when necessary (e.g. Address page invalidates Addresses tag, Checkout page invalidates Checkout tag)
+      invalidatesTags: (_, error) => (error ? [] : ['Addresses', 'Checkout'])
     }),
     editAddress: builder.mutation<Address, Partial<Address>>({
       query: ({ pk, ...body }) => ({
@@ -62,14 +64,14 @@ const addressApi = api.injectEndpoints({
           type: body.is_corporate === 'true' ? 'corporate' : 'personal'
         }
       }),
-      invalidatesTags: ['Addresses', 'Checkout'] // TODO: Invalidate one of these tags when necessary (e.g. Address page invalidates Addresses tag, Checkout page invalidates Checkout tag)
+      invalidatesTags: (_, error) => (error ? [] : ['Addresses', 'Checkout']) // TODO: Invalidate one of these tags when necessary (e.g. Address page invalidates Addresses tag, Checkout page invalidates Checkout tag)
     }),
     removeAddress: builder.mutation<void, number>({
       query: (id) => ({
         url: buildClientRequestUrl(address.removeAddress(id)),
         method: 'DELETE'
       }),
-      invalidatesTags: ['Addresses', 'Checkout'] // TODO: Invalidate one of these tags when necessary (e.g. Address page invalidates Addresses tag, Checkout page invalidates Checkout tag)
+      invalidatesTags: (_, error) => (error ? [] : ['Addresses', 'Checkout']) // TODO: Invalidate one of these tags when necessary (e.g. Address page invalidates Addresses tag, Checkout page invalidates Checkout tag)
     }),
     setDefaultAddress: builder.mutation<Address, Partial<Address>>({
       query: ({ pk, primary }) => ({
@@ -79,7 +81,7 @@ const addressApi = api.injectEndpoints({
         method: 'PATCH',
         body: { primary }
       }),
-      invalidatesTags: ['Addresses']
+      invalidatesTags: (_, error) => (error ? [] : ['Addresses'])
     }),
     getStores: builder.query<GetResponse<Address>, void>({
       query: () => ({

package/data/client/wishlist.ts

@@ -20,6 +20,8 @@ interface GetStockParams {
 }
 
 interface GetFavoritesResponse {
+  next?: string | null;
+  previous?: string | null;
   count: number;
   results: FavoriteItem[];
 }
@@ -71,14 +73,14 @@ export const wishlistApi = api.injectEndpoints({
           product: productPk
         }
       }),
-      invalidatesTags: ['Favorite']
+      invalidatesTags: (_, error) => (error ? [] : ['Favorite'])
     }),
     removeFavorite: build.mutation<RemoteFavoriteResponse, number>({
       query: (favPk: number) => ({
         url: buildClientRequestUrl(wishlist.removeFavorite(favPk)),
         method: 'DELETE'
       }),
-      invalidatesTags: ['Favorite']
+      invalidatesTags: (_, error) => (error ? [] : ['Favorite'])
     }),
     addStockAlert: build.mutation<AddStockAlertResponse, AddStockAlertRequest>({
       query: ({ productPk, email }) => ({

package/data/server/category.ts

@@ -39,7 +39,7 @@ function getCategoryDataHandler(
         numberValueParser
       ) as GetCategoryResponse;
     } catch (error) {
-      logger.error('Error while parsing category data', {
+      logger.fatal('Error while parsing category data', {
         handler: 'getCategoryDataHandler',
         error,
         rawData: rawData.startsWith('<!DOCTYPE html>')
@@ -50,6 +50,14 @@ function getCategoryDataHandler(
 
     const menuItemModel = data?.category?.menuitemmodel;
 
+    if (!menuItemModel) {
+      logger.warn('menuItemModel is undefined, skipping breadcrumbData fetch', {
+        handler: 'getCategoryDataHandler',
+        pk
+      });
+      return { data, breadcrumbData: undefined };
+    }
+
     const breadcrumbData = await appFetch<any>(
       product.breadcrumbUrl(menuItemModel),
       {
@@ -108,7 +116,7 @@ function getCategoryBySlugDataHandler(slug: string) {
         numberValueParser
       ) as GetCategoryResponse;
     } catch (error) {
-      logger.error('Error while parsing category data', {
+      logger.fatal('Error while parsing category data', {
         handler: 'getCategoryBySlugDataHandler',
         error,
         rawData: rawData.startsWith('<!DOCTYPE html>')

package/data/server/list.ts

@@ -38,7 +38,7 @@ const getListDataHandler = (
         numberValueParser
       ) as GetCategoryResponse;
     } catch (error) {
-      logger.error('Error while parsing list data', {
+      logger.fatal('Error while parsing list data', {
         error,
         rawData: rawData.startsWith('<!DOCTYPE html>')
           ? `${rawData.substring(0, 50)}...`

package/hooks/use-pagination.ts

@@ -70,10 +70,6 @@ export default function usePagination(
     dispatch({ type: 'setLimit', payload: limit });
   }, [limit]);
 
-  useEffect(() => {
-    window.scrollTo(0, 0);
-  }, [state.page, state.limit]);
-
   const setTotal = useCallback(
     (total: number) => {
       dispatch({ type: 'setTotal', payload: total });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@akinon/next",
   "description": "Core package for Project Zero Next",
-  "version": "1.23.0",
+  "version": "1.24.0-rc.1",
   "private": false,
   "license": "MIT",
   "bin": {
@@ -32,7 +32,7 @@
     "@typescript-eslint/eslint-plugin": "6.7.4",
     "@typescript-eslint/parser": "6.7.4",
     "eslint": "^8.14.0",
-    "@akinon/eslint-plugin-projectzero": "1.23.0",
+    "@akinon/eslint-plugin-projectzero": "1.24.0-rc.1",
     "eslint-config-prettier": "8.5.0"
   }
 }

package/plugins.d.ts

@@ -13,3 +13,11 @@ declare module '@akinon/pz-masterpass/src/redux/reducer' {
   export const setError: any;
   export const setOtpModalVisible: any;
 }
+
+declare module '@akinon/pz-otp' {
+  export const otpReducer: any;
+}
+
+declare module '@akinon/pz-otp/src/redux/reducer' {
+  export const showPopup: any;
+}

package/redux/reducers/index.ts

@@ -6,6 +6,7 @@ import { api } from '../../data/client/api';
 
 // Plugin reducers
 import { masterpassReducer } from '@akinon/pz-masterpass';
+import { otpReducer } from '@akinon/pz-otp';
 
 const reducers = {
   [api.reducerPath]: api.reducer,
@@ -13,7 +14,8 @@ const reducers = {
   checkout: checkoutReducer,
   config: configReducer,
   header: headerReducer,
-  masterpass: masterpassReducer
+  masterpass: masterpassReducer,
+  otp: otpReducer
 };
 
 export default reducers;

package/sentry/index.ts

@@ -1,27 +1,33 @@
 import * as Sentry from '@sentry/nextjs';
+import settings from 'settings';
 
 const SENTRY_DSN: string =
-  process.env.SENTRY_DSN || process.env.NEXT_PUBLIC_SENTRY_DSN;
+  settings.sentryDsn ||
+  process.env.SENTRY_DSN ||
+  process.env.NEXT_PUBLIC_SENTRY_DSN;
 
 export const initSentry = (
   type: 'Server' | 'Client' | 'Edge',
-  options: Sentry.BrowserOptions | Sentry.NodeOptions | Sentry.EdgeOptions = {}
+  options: Sentry.BrowserOptions | Sentry.NodeOptions | Sentry.EdgeOptions = {
+    dsn: SENTRY_DSN,
+    integrations: [],
+    tracesSampleRate: 1.0
+  }
 ) => {
-  // TODO: Handle options with ESLint rules
-
-  // TODO: Remove Zero Project DSN
-
-  Sentry.init({
-    dsn:
-      SENTRY_DSN ||
-      'https://d8558ef8997543deacf376c7d8d7cf4b@o64293.ingest.sentry.io/4504338423742464',
+  const initOptions = {
+    ...options,
     initialScope: {
       tags: {
+        ...((
+          options.initialScope as {
+            tags?: Record<string, string>;
+          }
+        )?.tags ?? {}),
         APP_TYPE: 'ProjectZeroNext',
         TYPE: type
       }
-    },
-    tracesSampleRate: 1.0,
-    integrations: []
-  });
+    }
+  };
+
+  Sentry.init(initOptions);
 };

package/types/index.ts

@@ -71,6 +71,12 @@ export interface Currency {
 
 export interface Settings {
   commerceUrl: string;
+  /**
+   * This option allows you to track Sentry events on the client side, in addition to server and edge environments.
+   *
+   * It overrides process.env.NEXT_PUBLIC_SENTRY_DSN and process.env.SENTRY_DSN.
+   */
+  sentryDsn?: string;
   redis: {
     defaultExpirationTime: number;
   };

package/utils/app-fetch.ts

@@ -12,7 +12,7 @@ const appFetch = async <T>(
   url: RequestInfo,
   init: RequestInit = {},
   responseType = FetchResponseType.JSON
-) => {
+): Promise<T> => {
   let response: T;
   let status: number;
   let ip = '';
@@ -48,18 +48,18 @@ const appFetch = async <T>(
     status = req.status;
     logger.debug(`FETCH END ${url}`, { status: req.status, ip });
 
-    const rawData = await req.text();
-
     if (responseType === FetchResponseType.JSON) {
-      response = JSON.parse(rawData);
+      response = (await req.json()) as T;
     } else {
-      response = rawData as unknown as T;
+      response = (await req.text()) as unknown as T;
     }
 
     logger.trace(`FETCH RESPONSE`, { url, response, ip });
   } catch (error) {
+    const logType = status === 500 ? 'fatal' : 'error';
+
     if (!url.toString().includes('/cms/seo/')) {
-      logger.error(`FETCH FAILED`, { url, status, error, ip });
+      logger[logType](`FETCH FAILED`, { url, status, error, ip });
     }
   }