@akinon/next 1.21.0-rc.5 → 1.21.0-rc.7

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @akinon/next
 
+## 1.21.0-rc.7
+
+### Minor Changes
+
+- 5ace3508: ZERO-2439: Add anonymous tracking page
+- be04d041: ZERO-2452: UA events converted to be compatible with GA4 and types are declared
+- c75e1e45: ZERO-2452: GA4 support for gtm events
+
+## 1.21.0-rc.6
+
+### Minor Changes
+
+- b4452e9d: ZERO-2463: Refactor Sentry initialization and add Sentry DSN option to settings
+
 ## 1.21.0-rc.5
 
 ### Patch Changes

package/bin/pz-install-plugins.js

@@ -1,39 +1,71 @@
-#!/usr/bin/env node
-
 const fs = require('fs');
 const path = require('path');
-const rootDir = path.resolve(process.cwd());
-const spawn = require('cross-spawn');
-const availablePlugins = require('../plugins');
+const { execSync } = require('child_process');
+
+function findBaseDir() {
+  const insideNodeModules = __dirname.includes('node_modules');
+  return insideNodeModules
+    ? process.cwd()
+    : path.resolve(__dirname, '../../../apps/projectzeronext');
+}
 
-let plugins;
+const BASE_DIR = findBaseDir();
+const getFullPath = (relativePath) => path.join(BASE_DIR, relativePath);
+
+const packageJsonPath = getFullPath('package.json');
+let packageJson;
 
 try {
-  plugins = require(path.resolve(rootDir, './src/plugins.js'));
+  packageJson = JSON.parse(fs.readFileSync(packageJsonPath, 'utf8'));
 } catch (error) {
-  console.error('No plugins.js file found, skipping plugin installation.');
-  process.exit(0);
+  console.error('Error reading package.json:', error);
+  process.exit(1);
 }
 
-let installCmd = [];
+const pluginsJsPath = getFullPath('src/plugins.js');
+let installedPlugins;
+
+try {
+  installedPlugins = require(pluginsJsPath);
+} catch (error) {
+  console.error('Error loading installed plugins:', error);
+  process.exit(1);
+}
 
-availablePlugins
-  .filter((p) => plugins?.includes(p))
-  .forEach((name) => {
-    installCmd.push(`@akinon/${name}`);
-  });
+const protectedPackages = ['@akinon/next', 'next'];
 
-spawn.sync('yarn', ['cache clean']);
+const pluginsToRemove = Object.keys(packageJson.dependencies || {}).filter(
+  (dep) =>
+    dep.startsWith('@akinon/') &&
+    !installedPlugins.includes(dep.replace('@akinon/', '')) &&
+    !protectedPackages.includes(dep)
+);
 
-for (const plugin of availablePlugins) {
-  spawn.sync('yarn', ['remove', `@akinon/${plugin}`]);
-}
+pluginsToRemove.forEach((plugin) => {
+  try {
+    execSync(`yarn remove ${plugin}`, { stdio: 'inherit', cwd: BASE_DIR });
+  } catch (error) {
+    console.warn(
+      `Warning: Could not remove ${plugin}. It may not have been installed.`
+    );
+  }
+});
 
-if (
-  installCmd.length > 0 &&
-  !fs.existsSync(path.resolve(rootDir, '../../turbo.json'))
-) {
-  spawn.sync('yarn', ['add', ...installCmd, '--ignore-scripts'], {
-    stdio: 'inherit'
-  });
-}
+installedPlugins.forEach((plugin) => {
+  const packageName = `@akinon/${plugin}`;
+  if (
+    !Object.keys(packageJson.dependencies || {}).includes(packageName) &&
+    !protectedPackages.includes(packageName)
+  ) {
+    try {
+      const version = packageJson.dependencies['@akinon/next'].replace('^', '');
+      const command = `yarn add ${packageName}@${version} --exact --ignore-scripts`;
+      execSync(command, { stdio: 'inherit', cwd: BASE_DIR });
+    } catch (error) {
+      console.warn(
+        '\n\x1b[33m%s\x1b[0m',
+        `Error adding ${packageName}: ${error}`
+      );
+    }
+  }
+});

package/data/client/user.ts

@@ -1,6 +1,6 @@
 import { api } from './api';
 import { user } from '../urls';
-import { ForgotPasswordFormType } from '../../types';
+import { ForgotPasswordFormType, Order } from '../../types';
 import { buildClientRequestUrl } from '../../utils';
 
 interface GetCaptchaResponse {
@@ -84,6 +84,21 @@ const userApi = api.injectEndpoints({
           contentType: 'application/json'
         })
       })
+    }),
+    getAnonymousTracking: build.mutation<
+      Order,
+      { email: string; number: string }
+    >({
+      query: ({ email, number }) => ({
+        url: buildClientRequestUrl(user.anonymousOrderTracking, {
+          useFormData: true
+        }),
+        method: 'POST',
+        body: {
+          email,
+          number
+        }
+      })
     })
   }),
   overrideExisting: false
@@ -95,5 +110,6 @@ export const {
   useConfirmEmailVerificationQuery,
   useValidateCaptchaMutation,
   useLogoutMutation,
-  useForgotPasswordMutation
+  useForgotPasswordMutation,
+  useGetAnonymousTrackingMutation
 } = userApi;

package/data/urls.ts

@@ -172,7 +172,8 @@ export const user = {
     `/users/email-set-primary/${token}/`,
   confirmEmailVerification: (token: string) =>
     `/users/registration/account-confirm-email/${token}/`,
-  csrfToken: '/csrf_token/'
+  csrfToken: '/csrf_token/',
+  anonymousOrderTracking: '/users/orders/anonymous'
 };
 
 export const b2b = {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@akinon/next",
   "description": "Core package for Project Zero Next",
-  "version": "1.21.0-rc.5",
+  "version": "1.21.0-rc.7",
   "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.21.0-rc.5",
+    "@akinon/eslint-plugin-projectzero": "1.21.0-rc.7",
     "eslint-config-prettier": "8.5.0"
   }
 }

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/gtm.ts

@@ -14,3 +14,51 @@ export interface GTMUserType {
   gender: string;
   emailAllowed: boolean;
 }
+
+export interface GA4EventItem {
+  item_id: string | number;
+  item_name: string | number;
+  coupon?: string | number;
+  discount?: string | null;
+  index?: number;
+  item_brand?: string;
+  item_category?: string;
+  item_category2?: string;
+  item_category3?: string;
+  item_category4?: string;
+  item_category5?: string;
+  item_list_id?: string;
+  item_list_name?: string;
+  item_variant?: string;
+  price?: string | number;
+  quantity?: number;
+  sale_status?: string;
+  stock_status?: string;
+  discount_percent?: number;
+  discount_price?: string;
+  product_gender?: string;
+  product_size?: string;
+  [key: string]: any;
+}
+
+export interface GA4EventParams {
+  item_list_id?: string;
+  item_list_name?: string;
+  value?: number;
+  currency?: string;
+  shipping_tier?: string;
+  coupon?: string;
+  selected_shipping_option?: string;
+  creative_name?: string;
+  creative_slot?: string;
+  promotion_id?: string;
+  promotion_name?: string;
+  items?: GA4EventItem[];
+  transaction_id?: string;
+  tax?: number;
+  shipping?: number;
+  shipping_country?: string;
+  shipping_city?: string;
+  payment_method?: string;
+  [key: string]: any;
+}

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;
   };