@evershop/evershop 2.1.1 → 2.1.2

package/src/types/db/index.ts

@@ -130,19 +130,19 @@ export interface CartRow {
   user_ip: string | null;
   status: boolean;
   coupon: string | null;
-  shipping_fee_excl_tax: number | null;
-  shipping_fee_incl_tax: number | null;
-  discount_amount: number | null;
-  sub_total: number;
-  sub_total_incl_tax: number;
-  sub_total_with_discount: number;
-  sub_total_with_discount_incl_tax: number;
+  shipping_fee_excl_tax: string | null;
+  shipping_fee_incl_tax: string | null;
+  discount_amount: string | null;
+  sub_total: string;
+  sub_total_incl_tax: string;
+  sub_total_with_discount: string;
+  sub_total_with_discount_incl_tax: string;
   total_qty: number;
-  total_weight: number | null;
-  tax_amount: number;
-  tax_amount_before_discount: number;
-  shipping_tax_amount: number;
-  grand_total: number;
+  total_weight: string | null;
+  tax_amount: string;
+  tax_amount_before_discount: string;
+  shipping_tax_amount: string;
+  grand_total: string;
   shipping_method: string | null;
   shipping_method_name: string | null;
   shipping_zone_id: number | null;
@@ -153,7 +153,7 @@ export interface CartRow {
   shipping_note: string | null;
   created_at: Date;
   updated_at: Date;
-  total_tax_amount: number | null;
+  total_tax_amount: string | null;
   no_shipping_required: boolean;
 }
 
@@ -200,20 +200,20 @@ export interface CartItemRow {
   product_sku: string;
   product_name: string;
   thumbnail: string | null;
-  product_weight: number | null;
-  product_price: number;
-  product_price_incl_tax: number;
+  product_weight: string | null;
+  product_price: string;
+  product_price_incl_tax: string;
   qty: number;
-  final_price: number;
-  final_price_incl_tax: number;
-  tax_percent: number;
-  tax_amount: number;
-  tax_amount_before_discount: number;
-  discount_amount: number;
-  line_total: number;
-  line_total_with_discount: number;
-  line_total_incl_tax: number;
-  line_total_with_discount_incl_tax: number;
+  final_price: string;
+  final_price_incl_tax: string;
+  tax_percent: string;
+  tax_amount: string;
+  tax_amount_before_discount: string;
+  discount_amount: string;
+  line_total: string;
+  line_total_with_discount: string;
+  line_total_incl_tax: string;
+  line_total_with_discount_incl_tax: string;
   variant_group_id: number | null;
   variant_options: string | null;
   product_custom_options: string | null;
@@ -345,7 +345,7 @@ export interface CouponRow {
   uuid: string;
   status: boolean;
   description: string;
-  discount_amount: number;
+  discount_amount: string;
   free_shipping: boolean;
   discount_type: string;
   coupon: string;
@@ -491,20 +491,20 @@ export interface OrderRow {
   user_ip: string | null;
   user_agent: string | null;
   coupon: string | null;
-  shipping_fee_excl_tax: number | null;
-  shipping_fee_incl_tax: number | null;
-  discount_amount: number | null;
-  sub_total: number;
-  sub_total_incl_tax: number;
-  sub_total_with_discount: number;
-  sub_total_with_discount_incl_tax: number;
+  shipping_fee_excl_tax: string | null;
+  shipping_fee_incl_tax: string | null;
+  discount_amount: string | null;
+  sub_total: string;
+  sub_total_incl_tax: string;
+  sub_total_with_discount: string;
+  sub_total_with_discount_incl_tax: string;
   total_qty: number;
-  total_weight: number | null;
-  tax_amount: number;
-  tax_amount_before_discount: number;
-  shipping_tax_amount: number;
+  total_weight: string | null;
+  tax_amount: string;
+  tax_amount_before_discount: string;
+  shipping_tax_amount: string;
   shipping_note: string | null;
-  grand_total: number;
+  grand_total: string;
   shipping_method: string | null;
   shipping_method_name: string | null;
   shipping_address_id: number | null;
@@ -515,7 +515,7 @@ export interface OrderRow {
   payment_status: string;
   created_at: Date;
   updated_at: Date;
-  total_tax_amount: number | null;
+  total_tax_amount: string | null;
   status: string | null;
   no_shipping_required: boolean;
 }
@@ -586,20 +586,20 @@ export interface OrderItemRow {
   product_sku: string;
   product_name: string;
   thumbnail: string | null;
-  product_weight: number | null;
-  product_price: number;
-  product_price_incl_tax: number;
+  product_weight: string | null;
+  product_price: string;
+  product_price_incl_tax: string;
   qty: number;
-  final_price: number;
-  final_price_incl_tax: number;
-  tax_percent: number;
-  tax_amount: number;
-  tax_amount_before_discount: number;
-  discount_amount: number;
-  line_total: number;
-  line_total_with_discount: number;
-  line_total_incl_tax: number;
-  line_total_with_discount_incl_tax: number;
+  final_price: string;
+  final_price_incl_tax: string;
+  tax_percent: string;
+  tax_amount: string;
+  tax_amount_before_discount: string;
+  discount_amount: string;
+  line_total: string;
+  line_total_with_discount: string;
+  line_total_incl_tax: string;
+  line_total_with_discount_incl_tax: string;
   variant_group_id: number | null;
   variant_options: string | null;
   product_custom_options: string | null;
@@ -620,7 +620,7 @@ export interface PaymentTransactionRow {
   payment_transaction_order_id: number;
   transaction_id: string | null;
   transaction_type: string;
-  amount: number;
+  amount: string;
   parent_transaction_id: string | null;
   payment_action: string | null;
   additional_information: string | null;
@@ -647,8 +647,8 @@ export interface ProductRow {
   visibility: boolean;
   group_id: number | null;
   sku: string;
-  price: number;
-  weight: number | null;
+  price: string;
+  weight: string | null;
   tax_class: number | null;
   status: boolean;
   created_at: Date;
@@ -749,7 +749,7 @@ export interface ProductCustomOptionValueRow {
   product_custom_option_value_id: number;
   uuid: string;
   option_id: number;
-  extra_price: number | null;
+  extra_price: string | null;
   sort_order: number | null;
   value: string;
 }
@@ -938,11 +938,11 @@ export interface ShippingZoneMethodRow {
   method_id: number;
   zone_id: number;
   is_enabled: boolean;
-  cost: number | null;
+  cost: string | null;
   calculate_api: string | null;
   condition_type: string | null;
-  max: number | null;
-  min: number | null;
+  max: string | null;
+  min: string | null;
   price_based_cost: Record<string, unknown> | null;
   weight_based_cost: Record<string, unknown> | null;
 }
@@ -999,7 +999,7 @@ export interface TaxRateRow {
   country: string;
   province: string;
   postcode: string;
-  rate: number;
+  rate: string;
   is_compound: boolean;
   priority: number;
 }

package/src/types/event.ts

@@ -82,40 +82,54 @@ export interface EventDataRegistry {
   };
 
   /**
-   * Fired when a new customer is registered
+   * Fired when a new customer is registered and status = 1 (account is active)
    * Data: Complete customer table row
    */
   customer_registered: CustomerRow;
 
   /**
-   * Fired when a new order is created
-   * Data: Complete order table row
+   * Fired when a new customer record is added to database, regardless of the status value
+   * Data: Complete customer table row
    */
-  order_created: OrderRow;
+  customer_created: CustomerRow;
 
   /**
-   * Fired when a new order is placed
-   * Data: Complete order table row
+   * Fired when a customer record in database is updated
+   * Data: Complete customer table row
    */
-  order_placed: OrderRow;
+  customer_updated: CustomerRow;
 
   /**
-   * Fired when a new customer is created by admin
+   * Fired when a customer record is deleted
    * Data: Complete customer table row
    */
-  customer_created: CustomerRow;
+  customer_deleted: CustomerRow;
 
   /**
-   * Fired when a customer is updated by admin
-   * Data: Complete customer table row
+   * Fired when a new order record is created in database, regardless of the payment method or order status
+   * Data: Complete order table row
    */
-  customer_updated: CustomerRow;
+  order_created: OrderRow;
 
   /**
-   * Fired when a customer is deleted by admin
-   * Data: Complete customer table row
+   * Fired when a new order is placed
+   * (This means the order is created and the payment is successful (decided by the payment method, for example, for cod, the order is created when the order is placed, but for online payment, the order is created when the payment is successful))
    */
-  customer_deleted: CustomerRow;
+  order_placed: OrderRow;
+
+  /**
+   * Fired when an order status is updated.
+   * Data: {
+   *   orderId: number;
+   *   before: string; // the previous order status
+   *   after: string; // the new order status
+   * }
+   */
+  order_status_updated: {
+    orderId: number;
+    before: string;
+    after: string;
+  };
 }
 
 /**

package/src/types/registry.ts

@@ -0,0 +1,160 @@
+import type { PurchaseUnit } from '@paypal/paypal-js';
+import type { AnySchemaObject } from 'ajv';
+import type { EmailData, SendEmailArguments } from '../lib/mail/emailHelper.js';
+import type { AttributeData as CreateAttributeData } from '../modules/catalog/services/attribute/createProductAttribute.js';
+import type { AttributeData as UpdateAttributeData } from '../modules/catalog/services/attribute/updateProductAttribute.js';
+import type { CategoryData } from '../modules/catalog/services/category/createCategory.js';
+import type { CollectionData } from '../modules/catalog/services/collection/createCollection.js';
+import type { ProductData } from '../modules/catalog/services/product/createProduct.js';
+import type { WidgetData } from '../modules/cms/services/widget/createWidget.js';
+import type { CustomerData } from '../modules/customer/services/customer/createCustomer.js';
+import type { CouponData } from '../modules/promotion/services/coupon/createCoupon.js';
+
+/**
+ * Registry that maps value names to their data types.
+ * Extend this interface in your module to register custom values.
+ *
+ * @example
+ * ```typescript
+ * // In your module's bootstrap or type declaration file
+ * declare module '@evershop/evershop/types/registry' {
+ *   interface ValueRegistry {
+ *     'myCustomValue': MyDataType;
+ *   }
+ * }
+ * ```
+ */
+export interface ValueRegistry {
+  // ── Catalog: Product ──────────────────────────────────────────────────────
+
+  /** Product input data before the create transaction runs */
+  productDataBeforeCreate: ProductData;
+  /** Product input data before the update transaction runs */
+  productDataBeforeUpdate: ProductData;
+  /** AJV JSON schema used to validate product data on create */
+  createProductDataJsonSchema: AnySchemaObject;
+  /** AJV JSON schema used to validate product data on update */
+  updateProductDataJsonSchema: AnySchemaObject;
+
+  // ── Catalog: Category ─────────────────────────────────────────────────────
+
+  /** Category input data before the create transaction runs */
+  categoryDataBeforeCreate: CategoryData;
+  /** Category input data before the update transaction runs */
+  categoryDataBeforeUpdate: CategoryData;
+  /** AJV JSON schema used to validate category data on create */
+  createCategoryDataJsonSchema: AnySchemaObject;
+  /** AJV JSON schema used to validate category data on update */
+  updateCategoryDataJsonSchema: AnySchemaObject;
+
+  // ── Catalog: Attribute ────────────────────────────────────────────────────
+
+  /** Product attribute input data before the create transaction runs */
+  attributeDataBeforeCreate: CreateAttributeData;
+  /** Product attribute input data before the update transaction runs */
+  attributeDataBeforeUpdate: UpdateAttributeData;
+  /** AJV JSON schema used to validate attribute data on create */
+  createAttributeDataJsonSchema: AnySchemaObject;
+  /** AJV JSON schema used to validate attribute data on update */
+  updateAttributeDataJsonSchema: AnySchemaObject;
+
+  // ── Catalog: Collection ───────────────────────────────────────────────────
+
+  /** Collection input data before the update transaction runs */
+  collectionDataBeforeUpdate: CollectionData;
+
+  // ── Promotion: Coupon ─────────────────────────────────────────────────────
+
+  /** Coupon input data before the create transaction runs */
+  couponDataBeforeCreate: CouponData;
+  /** Coupon input data before the update transaction runs */
+  couponDataBeforeUpdate: Partial<CouponData>;
+  /** AJV JSON schema used to validate coupon data on create */
+  createCouponDataJsonSchema: AnySchemaObject;
+  /** AJV JSON schema used to validate coupon data on update */
+  updateCouponDataJsonSchema: AnySchemaObject;
+
+  // ── Customer ──────────────────────────────────────────────────────────────
+
+  /** Customer input data before the update transaction runs */
+  customerDataBeforeUpdate: CustomerData;
+  /** AJV JSON schema used to validate customer data on create */
+  createCustomerDataJsonSchema: AnySchemaObject;
+  /** AJV JSON schema used to validate customer data on update */
+  updateCustomerDataJsonSchema: AnySchemaObject;
+
+  // ── CMS: Page ─────────────────────────────────────────────────────────────
+
+  /** CMS page input data before the create transaction runs */
+  pageDataBeforeCreate: Record<string, unknown>;
+  /** CMS page input data before the update transaction runs */
+  pageDataBeforeUpdate: Record<string, unknown>;
+  /** AJV JSON schema used to validate page data on create */
+  createPageDataJsonSchema: AnySchemaObject;
+  /** AJV JSON schema used to validate page data on update */
+  updatePageDataJsonSchema: AnySchemaObject;
+
+  // ── CMS: Widget ───────────────────────────────────────────────────────────
+
+  /** Widget input data before the create transaction runs */
+  widgetDataBeforeCreate: WidgetData;
+  /** Widget input data before the update transaction runs */
+  widgetDataBeforeUpdate: WidgetData;
+  /** AJV JSON schema used to validate widget data on create */
+  createWidgetDataJsonSchema: AnySchemaObject;
+  /** AJV JSON schema used to validate widget data on update */
+  updateWidgetDataJsonSchema: AnySchemaObject;
+
+  // ── OMS ───────────────────────────────────────────────────────────────────
+
+  /**
+   * Payment+shipment status → order status mapping.
+   * Keys are `"paymentStatus:shipmentStatus"` strings; values are order status strings.
+   */
+  psoMapping: Record<string, string>;
+
+  // ── Email ─────────────────────────────────────────────────────────────────
+
+  /** Arguments passed to the email service before every `sendEmail` call */
+  emailArguments: SendEmailArguments;
+  /** Template data passed to every email template renderer */
+  emailTemplateData: EmailData;
+
+  /** Dynamic data injected into the order confirmation email */
+  orderConfirmationEmailData: EmailData;
+  /** Send-email arguments for the order confirmation email */
+  orderConfirmationEmailArguments: SendEmailArguments;
+
+  /** Dynamic data injected into the reset-password email */
+  resetPasswordEmailData: EmailData;
+  /** Send-email arguments for the reset-password email */
+  resetPasswordEmailArguments: SendEmailArguments;
+
+  /** Dynamic data injected into the customer welcome email */
+  customerWelcomeEmailData: EmailData;
+  /** Send-email arguments for the customer welcome email */
+  customerWelcomeEmailArguments: SendEmailArguments;
+
+  // ── Checkout ──────────────────────────────────────────────────────────────
+
+  /**
+   * Cart `Item` instance before it is added to the cart.
+   * `Item` is implemented in JavaScript; cast to access specific members.
+   */
+  cartItemBeforeAdd: unknown;
+
+  // ── PayPal ────────────────────────────────────────────────────────────────
+
+  /** PayPal purchase-unit amount object before it is sent to the PayPal Orders API */
+  paypalFinalAmount: PurchaseUnit['amount'];
+}
+
+/**
+ * Extract value names from the registry.
+ */
+export type ValueName = keyof ValueRegistry;
+
+/**
+ * Get the data type for a specific registry value.
+ */
+export type ValueData<K extends ValueName> = ValueRegistry[K];

package/src/types/widget.ts

@@ -14,4 +14,7 @@ export interface WidgetInstance<T = any> extends Widget<T> {
   id: string;
   type: string;
   settings: Record<string, T>;
+  props: Record<string, any>;
+  areaId: string[];
+  sortOrder: number;
 }

package/src/lib/event/callSubscibers.js

@@ -1,19 +0,0 @@
-import { error } from '../../lib/log/logger.js';
-
-export async function callSubscribers(subscribers, eventData) {
-  const promises = subscribers.map(
-    (subscriber) =>
-      new Promise((resolve) => {
-        setTimeout(async () => {
-          try {
-            await subscriber(eventData);
-          } catch (e) {
-            error(e);
-          }
-          resolve();
-        }, 0);
-      })
-  );
-
-  await Promise.all(promises);
-}

package/src/lib/event/event-manager.js

@@ -1,134 +0,0 @@
-import { del, select } from '@evershop/postgres-query-builder';
-import { getEnabledExtensions } from '../../bin/extension/index.js';
-import { loadBootstrapScript } from '../../bin/lib/bootstrap/bootstrap.js';
-import { getCoreModules } from '../../bin/lib/loadModules.js';
-import { pool } from '../../lib/postgres/connection.js';
-import { debug, error } from '../log/logger.js';
-import { lockHooks } from '../util/hookable.js';
-import { lockRegistry } from '../util/registry.js';
-import { callSubscribers } from './callSubscibers.js';
-import { loadSubscribers } from './loadSubscribers.js';
-
-const loadEventInterval = 10000;
-const syncEventInterval = 2000;
-const maxEvents = 10;
-let events = [];
-// Get the modules from the arguments
-const modules = [...getCoreModules(), ...getEnabledExtensions()];
-const subscribers = await loadSubscribers(modules);
-
-const init = async () => {
-  /** Loading bootstrap script from modules */
-  try {
-    for (const module of modules) {
-      await loadBootstrapScript(module, {
-        ...JSON.parse(process.env.bootstrapContext || '{}'),
-        process: 'event'
-      });
-    }
-    lockHooks();
-    lockRegistry();
-  } catch (e) {
-    error(e);
-    process.exit(0);
-  }
-  process.env.ALLOW_CONFIG_MUTATIONS = false;
-  setInterval(async () => {
-    // Load events
-    const newEvents = await loadEvents(maxEvents);
-    // Append the new events to the existing events
-    events = [...events, ...newEvents];
-
-    // Keep only the last 20 events
-    events = events.slice(-maxEvents);
-
-    // Call subscribers for each event
-    events.forEach((event) => {
-      if (event.status !== 'done' && event.status !== 'processing') {
-        executeSubscribers(event);
-      }
-    });
-  }, loadEventInterval);
-};
-
-setInterval(async () => {
-  // Sync events
-  await syncEvents();
-}, syncEventInterval);
-
-async function loadEvents(count) {
-  // Only load events if the current events are less than the max events
-  if (events.length >= maxEvents) {
-    return [];
-  }
-  // Only load events that have subscribers
-  const eventNames = subscribers.map((subscriber) => subscriber.event);
-
-  const query = select().from('event');
-  if (eventNames.length > 0) {
-    query.where('name', 'IN', eventNames);
-  }
-
-  if (events.length > 0) {
-    query.andWhere(
-      'uuid',
-      'NOT IN',
-      events.map((event) => event.uuid)
-    );
-  }
-
-  query.orderBy('event_id', 'ASC');
-  query.limit(0, count);
-
-  const results = await query.execute(pool);
-  return results;
-}
-
-async function syncEvents() {
-  // Delete the events that have been executed
-  const completedEvents = events
-    .filter((event) => event.status === 'done')
-    .map((event) => event.uuid);
-  if (completedEvents.length > 0) {
-    await del('event').where('uuid', 'IN', completedEvents).execute(pool);
-    // Remove the events from the events array
-    events = events.filter((event) => event.status !== 'done');
-  }
-}
-
-async function executeSubscribers(event) {
-  event.status = 'processing';
-  const eventData = event.data;
-  // get subscribers for the event
-  const matchingSubscribers = subscribers
-    .filter((subscriber) => subscriber.event === event.name)
-    .map((subscriber) => subscriber.subscriber);
-  // Call subscribers
-  await callSubscribers(matchingSubscribers, eventData);
-
-  event.status = 'done';
-}
-
-process.on('SIGTERM', async () => {
-  debug('Event manager received SIGTERM, shutting down...');
-  try {
-    process.exit(0);
-  } catch (err) {
-    error('Error during shutdown:');
-    error(err);
-    process.exit(1); // Exit with an error code
-  }
-});
-
-process.on('SIGINT', async () => {
-  debug('Event manager received SIGINT, shutting down...');
-  try {
-    process.exit(0);
-  } catch (err) {
-    error('Error during shutdown:');
-    error(err);
-    process.exit(1); // Exit with an error code
-  }
-});
-
-init();

package/src/modules/auth/bootstrap.js

@@ -1,28 +0,0 @@
-import { request } from 'express';
-import { hookable } from '../../lib/util/hookable.js';
-import { loginUserWithEmail } from './services/loginUserWithEmail.js';
-import { logoutUser } from './services/logoutUser.js';
-
-export default () => {
-  request.loginUserWithEmail = async function login(email, password, callback) {
-    await hookable(loginUserWithEmail.bind(this))(email, password);
-    if (this.session) {
-      this.session.save(callback);
-    }
-  };
-
-  request.logoutUser = function logout(callback) {
-    hookable(logoutUser.bind(this))();
-    if (this.session) {
-      this.session.save(callback);
-    }
-  };
-
-  request.isUserLoggedIn = function isUserLoggedIn() {
-    return !!this.session.userID;
-  };
-
-  request.getCurrentUser = function getCurrentUser() {
-    return this.locals.user;
-  };
-};

package/src/modules/base/api/global/[payloadValidate]escapeHtml.js

@@ -1,12 +0,0 @@
-import escapePayload from '../../services/escapePayload.js';
-
-export default (request, response, next) => {
-  // return next();
-  if (request.method === 'GET') {
-    next();
-  } else {
-    // Escape the characters <, > from the payload
-    escapePayload(request.body);
-    next();
-  }
-};

package/src/modules/base/services/markSkipEscape.js

@@ -1,30 +0,0 @@
-import secret from './secret.js';
-
-export default function markSkipEscape(obj, path) {
-  const keys = path.split('/');
-  let result = obj;
-  const lastKeyIndex = keys.length - 1;
-  for (let i = 0; i < lastKeyIndex; i += 1) {
-    const key = keys[i];
-    if (key === '') {
-      continue;
-    }
-    const match = key.match(/(.+)\[(\d+)\]/);
-    if (match) {
-      const prop = match[1];
-      const index = parseInt(match[2], 10);
-      result = result[prop][index];
-    } else {
-      result = result[key];
-    }
-  }
-  const lastKey = keys[lastKeyIndex];
-  const lastMatch = lastKey.match(/(.+)\[(\d+)\]/);
-  if (lastMatch) {
-    const prop = lastMatch[1];
-    const index = parseInt(lastMatch[2], 10);
-    result[prop][index] += secret;
-  } else {
-    result[lastKey] += secret;
-  }
-}