@akinon/next 1.12.0 → 1.13.0

package/.eslintrc.js

@@ -0,0 +1,40 @@
+module.exports = {
+  env: {
+    browser: true,
+    node: true,
+    es2021: true
+  },
+  extends: [
+    'eslint:recommended',
+    'next/core-web-vitals',
+    'eslint:recommended',
+    'plugin:@typescript-eslint/recommended',
+    'prettier',
+    'plugin:@akinon/projectzero/core', // DO NOT remove this config for stability
+    'plugin:@akinon/projectzero/recommended'
+  ],
+  overrides: [
+    {
+      env: {
+        node: true
+      },
+      files: ['.eslintrc.{js,cjs}', 'middlewares/default.ts'],
+      rules: {
+        '@akinon/projectzero/check-middleware-order': 'error'
+      },
+      parserOptions: {
+        sourceType: 'script'
+      }
+    }
+  ],
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    ecmaVersion: '2021',
+    sourceType: 'module'
+  },
+  plugins: ['@typescript-eslint', '@akinon/projectzero'],
+  rules: {
+    '@typescript-eslint/no-unused-vars': 'warn',
+    '@typescript-eslint/no-explicit-any': 'warn'
+  }
+};

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @akinon/next
 
+## 1.13.0
+
+### Minor Changes
+
+- ZERO-2368: Add ESLint rule to check middleware orders
+- ZERO-2350: Add usePaymentOptions hook
+
 ## 1.12.0
 
 ### Minor Changes

package/hooks/index.ts

@@ -7,3 +7,4 @@ export * from './use-debounce';
 export * from './use-media-query';
 export * from './use-on-click-outside';
 export * from './use-mobile-iframe-handler';
+export * from './use-payment-options';

package/hooks/use-payment-options.ts

@@ -0,0 +1,53 @@
+import plugins from '@theme/plugins';
+import settings from '@theme/settings';
+import { useAppSelector } from '@akinon/next/redux/hooks';
+import { RootState } from '@theme/redux/store';
+
+export const usePaymentOptions = () => {
+  const { paymentOptions } = useAppSelector(
+    (state: RootState) => state.checkout
+  );
+
+  const initialTypes = new Set([
+    'credit_card',
+    'funds_transfer',
+    'redirection'
+  ]);
+
+  const paymentTypeToPluginMap = {
+    pay_on_delivery: 'pz-pay-on-delivery',
+    bkm_express: 'pz-bkm'
+  };
+
+  const isInitialTypeIncluded = (type: string) => initialTypes.has(type);
+
+  const isPluginMapIncluded = (type: string) => {
+    if (paymentTypeToPluginMap.hasOwnProperty(type)) {
+      const pluginName = paymentTypeToPluginMap[type];
+      return plugins.includes(pluginName);
+    }
+    return false;
+  };
+
+  const isExtraTypeIncluded = (type: string) => {
+    const extraPaymentTypes = settings?.checkout?.extraPaymentTypes || [];
+
+    return (
+      extraPaymentTypes.includes(type) &&
+      !initialTypes.has(type) &&
+      !paymentTypeToPluginMap.hasOwnProperty(type)
+    );
+  };
+
+  const filteredPaymentOptions = paymentOptions.filter((option) => {
+    const { payment_type } = option;
+
+    return (
+      isInitialTypeIncluded(payment_type) ||
+      isPluginMapIncluded(payment_type) ||
+      isExtraTypeIncluded(payment_type)
+    );
+  });
+
+  return { filteredPaymentOptions };
+};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@akinon/next",
   "description": "Core package for Project Zero Next",
-  "version": "1.12.0",
+  "version": "1.13.0",
   "private": false,
   "license": "MIT",
   "bin": {
@@ -22,6 +22,11 @@
     "semver": "7.5.4"
   },
   "devDependencies": {
-    "@types/react-redux": "7.1.30"
+    "@types/react-redux": "7.1.30",
+    "@typescript-eslint/eslint-plugin": "6.7.4",
+    "@typescript-eslint/parser": "6.7.4",
+    "eslint": "^8.14.0",
+    "@akinon/eslint-plugin-projectzero": "1.13.0",
+    "eslint-config-prettier": "8.5.0"
   }
 }

package/plugins.js

@@ -5,5 +5,6 @@ module.exports = [
   'pz-pay-on-delivery',
   'pz-checkout-gift-pack',
   'pz-gpay',
-  'pz-otp'
+  'pz-otp',
+  'pz-bkm'
 ];

package/types/commerce/checkout.ts

@@ -43,6 +43,7 @@ export interface CheckoutAddressType {
 export interface CheckoutPaymentOption {
   pk?: number;
   slug?: string;
+  payment_type?: string;
   view?: (...args) => JSX.Element;
   viewProps?: any;
 }

package/types/index.ts

@@ -173,6 +173,7 @@ export interface Settings {
      * If there is a need to exclude certain payment options from the iframe, for instance, due to CORS issues, this option can be utilized by passing the slugs associated with the desired payment options.
      */
     iframeExcludedPaymentOptions?: string[];
+    extraPaymentTypes?: string[];
   };
 }