@evershop/evershop 2.1.0 → 2.1.1

package/src/modules/graphql/pages/global/{[bodyParser]buildQuery[graphql].js → [bodyParser,notFound]buildQuery[graphql].js}

@@ -2,6 +2,7 @@ import { readFileSync } from 'fs';
 import path from 'path';
 import JSON5 from 'json5';
 import uniqid from 'uniqid';
+import { getDevMiddleware } from '../../../../bin/lib/devEnvHelper.js';
 import { CONSTANTS } from '../../../../lib/helpers.js';
 import { error } from '../../../../lib/log/logger.js';
 import { getRoutes } from '../../../../lib/router/Router.js';
@@ -14,70 +15,61 @@ import { loadWidgetInstances } from '../../../cms/services/widget/loadWidgetInst
 import { getContextValue } from '../../services/contextHelper.js';
 
 export default async (request, response, next) => {
-  let query;
-  getContextValue(request, 'dummy', null);
-  if (isDevelopmentMode()) {
-    let route;
-    if (response.statusCode === 404) {
-      if (request.currentRoute?.isAdmin) {
-        route = getRoutes().find((r) => r.id === 'adminNotFound');
-      } else {
-        route = getRoutes().find((r) => r.id === 'notFound');
-      }
-    } else {
-      // Get the 'query.graphql' from webpack compiler
-      route = request.locals.webpackMatchedRoute;
-    }
-    const devMiddleware = route.webpackMiddleware;
-    const { outputFileSystem } = devMiddleware.context;
-    const { jsonWebpackStats } = response.locals;
-    const { outputPath } = jsonWebpackStats;
+  try {
+    let query;
+    getContextValue(request, 'dummy', null);
+    if (isDevelopmentMode()) {
+      const route = request.currentRoute;
+      const devMiddleware = getDevMiddleware(route.isAdmin);
+      const { outputFileSystem } = devMiddleware.context;
 
-    query = outputFileSystem.readFileSync(
-      path.join(outputPath, 'query.graphql'),
-      'utf8'
-    );
-  } else if (isProductionMode()) {
-    const routes = getRoutes();
-    let route;
-    if (response.statusCode === 404) {
-      if (request.currentRoute?.isAdmin) {
-        route = routes.find((r) => r.id === 'adminNotFound');
-      } else {
-        route = routes.find((r) => r.id === 'notFound');
+      // Wait for webpack to be ready
+      await new Promise((resolve) => {
+        devMiddleware.waitUntilValid(() => resolve());
+      });
+
+      const { stats } = devMiddleware.context;
+      if (!stats) {
+        throw new Error('Webpack stats not available');
       }
-    } else {
-      route = request.currentRoute;
-    }
 
-    const subPath = getRouteBuildPath(route);
-    query = readFileSync(
-      path.resolve(CONSTANTS.BUILDPATH, subPath, 'server/query.graphql'),
-      'utf8'
-    );
-  }
-  const widgetInstances = await loadWidgetInstances(request);
-  const enabledWidgets = getEnabledWidgets();
-  if (query) {
-    // Parse the query
-    // Use regex to replace "getContextValue_'base64 encoded string'"
-    // from the query to the actual function
-    const regex = /\\"getContextValue_([a-zA-Z0-9+/=]+)\\"/g;
-    query = query.replace(regex, (match, p1) => {
-      const base64 = p1;
-      const decoded = Buffer.from(base64, 'base64').toString('ascii');
+      const jsonWebpackStats = stats.toJson();
+      const { outputPath } = jsonWebpackStats;
 
-      let value = eval(`getContextValue(request, ${decoded})`);
+      const queryPath = path.resolve(outputPath, `query-${route.id}.graphql`);
+      query = outputFileSystem.readFileSync(queryPath, 'utf8');
+    } else if (isProductionMode()) {
+      const routes = getRoutes();
+      const route = request.currentRoute;
+      const subPath = getRouteBuildPath(route);
+      const queryPath = path.resolve(
+        CONSTANTS.BUILDPATH,
+        subPath,
+        'server',
+        'query.graphql'
+      );
+      query = readFileSync(queryPath, 'utf8');
+    }
+    const widgetInstances = await loadWidgetInstances(request);
+    const enabledWidgets = getEnabledWidgets();
+    if (query) {
+      // Parse the query
+      // Use regex to replace "getContextValue_'base64 encoded string'"
+      // from the query to the actual function
+      const regex = /\\"getContextValue_([a-zA-Z0-9+/=]+)\\"/g;
+      query = query.replace(regex, (match, p1) => {
+        const base64 = p1;
+        const decoded = Buffer.from(base64, 'base64').toString('ascii');
+        let value = eval(`getContextValue(request, ${decoded})`);
 
-      // JSON sringify without adding double quotes to the property name
-      value = JSON5.stringify(value, { quote: '"' });
-      // Escape the value so we can insert it into the query
-      if (value) {
-        value = value.replace(/"/g, '\\"');
-      }
-      return value;
-    });
-    try {
+        // JSON sringify without adding double quotes to the property name
+        value = JSON5.stringify(value, { quote: '"' });
+        // Escape the value so we can insert it into the query
+        if (value) {
+          value = value.replace(/"/g, '\\"');
+        }
+        return value;
+      });
       const json = JSON5.parse(query);
       // We need to get the list of applicable widgets and remove all the queries and variable that are not used
       let applicableWidgets = [];
@@ -334,9 +326,9 @@ export default async (request, response, next) => {
       request.body.graphqlVariables = variables.values;
       request.body.propsMap = propsMap;
       next();
-    } catch (e) {
-      error(e);
-      throw error;
     }
+  } catch (e) {
+    error(e);
+    throw error;
   }
 };

package/src/modules/oms/api/createShipment/createShipment.ts

@@ -0,0 +1,38 @@
+import { rollback, startTransaction } from '@evershop/postgres-query-builder';
+import { debug } from '../../../../lib/log/logger.js';
+import { getConnection } from '../../../../lib/postgres/connection.js';
+import { INTERNAL_SERVER_ERROR, OK } from '../../../../lib/util/httpStatus.js';
+import { EvershopRequest } from '../../../../types/request.js';
+import { EvershopResponse } from '../../../../types/response.js';
+import createShipment from '../../services/createShipment.js';
+
+export default async (
+  request: EvershopRequest,
+  response: EvershopResponse,
+  next
+) => {
+  const connection = await getConnection();
+  await startTransaction(connection);
+  const { id } = Array.isArray(request.params.id)
+    ? { id: request.params.id[0] }
+    : { id: request.params.id };
+  const { carrier, tracking_number } = request.body;
+  try {
+    const shipment = await createShipment(id, carrier, tracking_number);
+    response.status(OK);
+    response.$body = {
+      data: shipment
+    };
+    next();
+  } catch (e) {
+    debug(e);
+    await rollback(connection);
+    response.status(INTERNAL_SERVER_ERROR);
+    response.json({
+      error: {
+        status: INTERNAL_SERVER_ERROR,
+        message: e.message
+      }
+    });
+  }
+};

package/src/modules/oms/api/markDelivered/{markDelivered.js → markDelivered.ts}

@@ -1,6 +1,5 @@
 import {
   commit,
-  insert,
   rollback,
   select,
   startTransaction
@@ -11,9 +10,16 @@ import {
   INVALID_PAYLOAD,
   OK
 } from '../../../../lib/util/httpStatus.js';
+import { EvershopRequest } from '../../../../types/request.js';
+import { EvershopResponse } from '../../../../types/response.js';
+import addOrderActivityLog from '../../services/addOrderActivityLog.js';
 import { updateShipmentStatus } from '../../services/updateShipmentStatus.js';
 
-export default async (request, response, next) => {
+export default async (
+  request: EvershopRequest,
+  response: EvershopResponse,
+  next
+) => {
   const connection = await getConnection();
   await startTransaction(connection);
   const { order_id } = request.body;
@@ -51,14 +57,12 @@ export default async (request, response, next) => {
 
     await updateShipmentStatus(order_id, 'delivered', connection);
     /* Add an activity log message */
-    await insert('order_activity')
-      .given({
-        order_activity_order_id: order.order_id,
-        comment: 'Order delivered',
-        customer_notified: 0 // TODO: Add customer notification
-      })
-      .execute(connection);
-
+    await addOrderActivityLog(
+      order.order_id,
+      'Order delivered',
+      false,
+      connection
+    );
     await commit(connection);
     response.status(OK);
     response.$body = {

package/src/modules/oms/api/updateShipment/{updateShipment.js → updateShipment.ts}

@@ -1,6 +1,5 @@
 import {
   commit,
-  insert,
   rollback,
   select,
   startTransaction,
@@ -12,8 +11,15 @@ import {
   INVALID_PAYLOAD,
   OK
 } from '../../../../lib/util/httpStatus.js';
+import { EvershopRequest } from '../../../../types/request.js';
+import { EvershopResponse } from '../../../../types/response.js';
+import addOrderActivityLog from '../../services/addOrderActivityLog.js';
 
-export default async (request, response, next) => {
+export default async (
+  request: EvershopRequest,
+  response: EvershopResponse,
+  next
+) => {
   const connection = await getConnection();
   await startTransaction(connection);
   const { order_id, shipment_id } = request.params;
@@ -57,13 +63,12 @@ export default async (request, response, next) => {
       .where('uuid', '=', shipment_id)
       .execute(connection);
     /* Add an activity log message */
-    await insert('order_activity')
-      .given({
-        order_activity_order_id: order.order_id,
-        comment: 'Shipment information updated',
-        customer_notified: 0
-      })
-      .execute(connection);
+    await addOrderActivityLog(
+      order.order_id,
+      'Shipment information updated',
+      false,
+      connection
+    );
 
     await commit(connection);
 

package/src/modules/oms/{bootstrap.js → bootstrap.ts}

@@ -3,11 +3,18 @@ import { defaultPaginationFilters } from '../../lib/util/defaultPaginationFilter
 import { hookAfter } from '../../lib/util/hookable.js';
 import { merge } from '../../lib/util/merge.js';
 import { addProcessor } from '../../lib/util/registry.js';
+import {
+  CreateOrderResult,
+  SaveOrderArgs,
+  SaveOrderContext
+} from '../checkout/services/orderCreator.js';
+import createShipment from './services/createShipment.js';
 import registerDefaultOrderCollectionFilters from './services/registerDefaultOrderCollectionFilters.js';
 import {
   changeOrderStatus,
   resolveOrderStatus
 } from './services/updateOrderStatus.js';
+import { updateShipmentStatus } from './services/updateShipmentStatus.js';
 
 export default () => {
   addProcessor('configurationSchema', (schema) => {
@@ -31,9 +38,6 @@ export default () => {
                         badge: {
                           type: 'string'
                         },
-                        progress: {
-                          type: 'string'
-                        },
                         isDefault: {
                           type: 'boolean'
                         },
@@ -41,7 +45,7 @@ export default () => {
                           type: 'boolean'
                         }
                       },
-                      required: ['name', 'badge', 'progress']
+                      required: ['name', 'badge']
                     }
                   },
                   additionalProperties: false
@@ -58,9 +62,6 @@ export default () => {
                         badge: {
                           type: 'string'
                         },
-                        progress: {
-                          type: 'string'
-                        },
                         isDefault: {
                           type: 'boolean'
                         },
@@ -68,7 +69,7 @@ export default () => {
                           type: 'boolean'
                         }
                       },
-                      required: ['name', 'badge', 'progress']
+                      required: ['name', 'badge']
                     }
                   },
                   additionalProperties: false
@@ -85,9 +86,6 @@ export default () => {
                         badge: {
                           type: 'string'
                         },
-                        progress: {
-                          type: 'string'
-                        },
                         isDefault: {
                           type: 'boolean'
                         },
@@ -98,7 +96,7 @@ export default () => {
                           }
                         }
                       },
-                      required: ['name', 'badge', 'progress']
+                      required: ['name', 'badge']
                     },
                     processing: {
                       type: 'object',
@@ -109,9 +107,6 @@ export default () => {
                         badge: {
                           type: 'string'
                         },
-                        progress: {
-                          type: 'string'
-                        },
                         next: {
                           type: 'array',
                           items: {
@@ -119,7 +114,7 @@ export default () => {
                           }
                         }
                       },
-                      required: ['name', 'badge', 'progress']
+                      required: ['name', 'badge']
                     },
                     completed: {
                       type: 'object',
@@ -130,9 +125,6 @@ export default () => {
                         badge: {
                           type: 'string'
                         },
-                        progress: {
-                          type: 'string'
-                        },
                         next: {
                           type: 'array',
                           items: {
@@ -140,7 +132,7 @@ export default () => {
                           }
                         }
                       },
-                      required: ['name', 'badge', 'progress']
+                      required: ['name', 'badge']
                     },
                     canceled: {
                       type: 'object',
@@ -151,9 +143,6 @@ export default () => {
                         badge: {
                           type: 'string'
                         },
-                        progress: {
-                          type: 'string'
-                        },
                         next: {
                           type: 'array',
                           items: {
@@ -161,7 +150,7 @@ export default () => {
                           }
                         }
                       },
-                      required: ['name', 'badge', 'progress']
+                      required: ['name', 'badge']
                     },
                     closed: {
                       type: 'object',
@@ -172,9 +161,6 @@ export default () => {
                         badge: {
                           type: 'string'
                         },
-                        progress: {
-                          type: 'string'
-                        },
                         next: {
                           type: 'array',
                           items: {
@@ -182,7 +168,7 @@ export default () => {
                           }
                         }
                       },
-                      required: ['name', 'badge', 'progress']
+                      required: ['name', 'badge']
                     }
                   },
                   additionalProperties: true
@@ -232,30 +218,25 @@ export default () => {
         pending: {
           name: 'Pending',
           badge: 'default',
-          progress: 'incomplete',
           isDefault: true
         },
         processing: {
           name: 'Processing',
           badge: 'default',
-          progress: 'incomplete',
           isDefault: false
         },
         shipped: {
           name: 'Shipped',
-          badge: 'attention',
-          progress: 'complete'
+          badge: 'warning'
         },
         delivered: {
           name: 'Delivered',
           badge: 'success',
-          progress: 'complete',
           isCancelable: false
         },
         canceled: {
           name: 'Canceled',
-          badge: 'critical',
-          progress: 'complete',
+          badge: 'destructive',
           isCancelable: false
         }
       },
@@ -263,20 +244,17 @@ export default () => {
         pending: {
           name: 'Pending',
           badge: 'default',
-          progress: 'incomplete',
           isDefault: true,
           isCancelable: true
         },
         paid: {
           name: 'Paid',
           badge: 'success',
-          progress: 'complete',
           isCancelable: false
         },
         canceled: {
           name: 'Canceled',
-          badge: 'critical',
-          progress: 'complete',
+          badge: 'destructive',
           isCancelable: true
         }
       },
@@ -284,32 +262,27 @@ export default () => {
         new: {
           name: 'New',
           badge: 'default',
-          progress: 'incomplete',
           isDefault: true,
           next: ['processing', 'canceled']
         },
         processing: {
           name: 'Processing',
           badge: 'default',
-          progress: 'incomplete',
           next: ['completed', 'canceled']
         },
         completed: {
           name: 'Completed',
           badge: 'success',
-          progress: 'complete',
           next: ['closed']
         },
         canceled: {
           name: 'Canceled',
-          badge: 'critical',
-          progress: 'complete',
+          badge: 'destructive',
           next: []
         },
         closed: {
           name: 'Closed',
-          badge: 'default',
-          progress: 'complete',
+          badge: 'outline',
           next: []
         }
       },
@@ -351,7 +324,7 @@ export default () => {
     registerDefaultOrderCollectionFilters,
     1
   );
-  addProcessor(
+  addProcessor<Array<any>>(
     'orderCollectionFilters',
     (filters) => [...filters, ...defaultPaginationFilters],
     2
@@ -384,4 +357,21 @@ export default () => {
       await changeOrderStatus(orderId, orderStatus, connection);
     }
   );
+
+  hookAfter<SaveOrderContext, CreateOrderResult, SaveOrderArgs>(
+    'saveOrder',
+    async function createShipmentForVirtualProductsOrder(
+      order,
+      cart,
+      connection
+    ) {
+      if (order.no_shipping_required) {
+        // Create a shipment for this order
+        await createShipment(order.uuid, null, null, connection);
+
+        // And update shipment status to delivered
+        await updateShipmentStatus(order.order_id, 'delivered', connection);
+      }
+    }
+  );
 };

package/src/modules/oms/graphql/types/Order/Order.graphql

@@ -25,6 +25,7 @@ type OrderItem implements ShoppingCartItem {
   productSku: String!
   productName: String
   thumbnail: String
+  noShippingRequired: Boolean!
   productWeight: Weight!
   productPrice: Price!
   productPriceInclTax: Price!
@@ -56,6 +57,7 @@ type Order implements ShoppingCart {
   orderNumber: String!
   status: Status
   items: [OrderItem]
+  noShippingRequired: Boolean!
   shippingAddress: OrderAddress
   billingAddress: OrderAddress
   currency: String!

package/src/modules/oms/graphql/types/Order/Order.resolvers.js

@@ -60,8 +60,7 @@ export default {
       const status = statusList[shipmentStatus] || {
         name: 'Unknown',
         code: shipmentStatus,
-        badge: 'default',
-        progress: 'incomplete'
+        badge: 'default'
       };
 
       return {
@@ -74,8 +73,7 @@ export default {
       const status = statusList[paymentStatus] || {
         name: 'Unknown',
         code: paymentStatus,
-        badge: 'default',
-        progress: 'incomplete'
+        badge: 'default'
       };
 
       return {
@@ -88,8 +86,7 @@ export default {
       const statusObj = statusList[status] || {
         name: 'Unknown',
         code: status,
-        badge: 'default',
-        progress: 'incomplete'
+        badge: 'default'
       };
 
       return {

package/src/modules/oms/graphql/types/Status/Status.graphql

@@ -5,7 +5,6 @@ type Status {
   name: String
   code: String
   badge: String
-  progress: String
 }
 
 """
@@ -15,7 +14,6 @@ type PaymentStatus {
   name: String
   code: String
   badge: String
-  progress: String
   isDefault: Boolean
   isCancelable: Boolean
 }
@@ -27,7 +25,6 @@ type ShipmentStatus {
   name: String
   code: String
   badge: String
-  progress: String
   isDefault: Boolean
   isCancelable: Boolean
 }

package/src/modules/oms/migration/Version-1.0.2.ts

@@ -0,0 +1,13 @@
+import { execute } from '@evershop/postgres-query-builder';
+
+export default async (connection) => {
+  await execute(
+    connection,
+    `ALTER TABLE "order_item" ADD COLUMN IF NOT EXISTS no_shipping_required boolean DEFAULT FALSE`
+  );
+
+  await execute(
+    connection,
+    `ALTER TABLE "order" ADD COLUMN IF NOT EXISTS no_shipping_required boolean DEFAULT FALSE`
+  );
+};

package/src/modules/oms/pages/admin/all/OmsMenuGroup.jsx

@@ -1,5 +1,5 @@
 import { NavigationItemGroup } from '@components/admin/NavigationItemGroup.js';
-import { CubeIcon } from '@heroicons/react/24/solid';
+import { Package } from 'lucide-react';
 import PropTypes from 'prop-types';
 import React from 'react';
 
@@ -10,7 +10,7 @@ export default function OmsMenuGroup({ orderGrid }) {
       name="Sale"
       items={[
         {
-          Icon: CubeIcon,
+          Icon: Package,
           url: orderGrid,
           title: 'Orders'
         }