add tag for order

migrations/20240714154524-add-order-tag.js

@@ -0,0 +1,32 @@
+'use strict';
+// sql template autogenerated by gen-db-migrates
+
+var async = require('async')
+var dbm;
+var type;
+var seed;
+
+/**
+* We receive the dbmigrate dependency from dbmigrate initially.
+* This enables us to not have to rely on NODE_PATH.
+*/
+exports.setup = function(options, seedLink) {
+  dbm = options.dbmigrate;
+  type = dbm.dataType;
+  seed = seedLink;
+};
+
+exports.up = function (db, callback) {
+  async.series([
+    (cb) => db.addColumn('order', 'tag', {"type":"text"}, cb),
+
+  ], callback);
+}
+
+exports.down = function(db) {
+  return null;
+};
+
+exports._meta = {
+  "version": 1
+};

models/Order.d.ts

@@ -157,6 +157,12 @@ declare let attributes: {
      */
     discountTotal: number;
     orderDate: string;
+    /**
+     * @experimental
+     * This field allows you to somehow mark the recycle bin, although this is not used in current versions of the kernel.
+     * Designed for creating some custom logic, through visual programming or through modules.
+     */
+    tag: string;
     deviceId: string;
     /**
      * A number that will change every time the order is changed
@@ -220,6 +226,14 @@ declare let Model: {
     order(criteria: CriteriaQuery<Order>): Promise<void>;
     payment(criteria: CriteriaQuery<Order>): Promise<PaymentResponse>;
     clear(criteria: CriteriaQuery<Order>): Promise<void>;
+    /**
+     * Method for quickly setting a Order tag
+     * @experimental
+     * @param criteria
+     * @param tag
+     * @returns
+     */
+    tag(criteria: CriteriaQuery<Order>, tag: string): Promise<Order>;
     setCustomData(criteria: CriteriaQuery<Order>, customData: any): Promise<void>;
     paymentMethodId(criteria: CriteriaQuery<Order>): Promise<string>;
     /**  given populated Order instance by criteria*/
@@ -280,6 +294,7 @@ declare let Model: {
         orderTotal?: number;
         discountTotal?: number;
         orderDate?: string;
+        tag?: string;
         deviceId?: string;
         nonce?: number;
         hash?: string;

models/Order.js

@@ -231,6 +231,12 @@ let attributes = {
     },
     orderDate: "string",
     // orderDateLimit: "string",
+    /**
+     * @experimental
+     * This field allows you to somehow mark the recycle bin, although this is not used in current versions of the kernel.
+     * Designed for creating some custom logic, through visual programming or through modules.
+     */
+    tag: "string",
     deviceId: "string",
     /**
      * A number that will change every time the order is changed
@@ -960,6 +966,26 @@ let Model = {
         await Order.countCart({ id: order.id });
         await emitter.emit.apply(emitter, ["core:order-was-cleared", ...arguments]);
     },
+    /**
+     * Method for quickly setting a Order tag
+     * @experimental
+     * @param criteria
+     * @param tag
+     * @returns
+     */
+    async tag(criteria, tag) {
+        emitter.emit.apply(emitter, ["core:order-set-tag", ...arguments]);
+        try {
+            let order = await Order.findOne(criteria);
+            if (order.state !== "CART") {
+                throw new Error(`Clear allowed only for CART state`);
+            }
+            return await Order.updateOne({ id: order.id }, { tag: tag }).fetch();
+        }
+        catch (error) {
+            sails.log.error('Error tagging order:', error);
+        }
+    },
     async setCustomData(criteria, customData) {
         await emitter.emit.apply(emitter, ["core:order-set-custom-data", ...arguments]);
         let order = await Order.findOne(criteria);

models/Order.ts

@@ -303,6 +303,13 @@ let attributes = {
   orderDate: "string",
   // orderDateLimit: "string",
 
+  /**
+   * @experimental
+   * This field allows you to somehow mark the recycle bin, although this is not used in current versions of the kernel.
+   * Designed for creating some custom logic, through visual programming or through modules.
+   */
+  tag: "string",
+
   deviceId: "string",
 
   /**
@@ -1178,6 +1185,28 @@ let Model = {
     await emitter.emit.apply(emitter, ["core:order-was-cleared", ...arguments]);
   },
 
+  /**
+   * Method for quickly setting a Order tag
+   * @experimental
+   * @param criteria 
+   * @param tag 
+   * @returns 
+   */
+  async tag(criteria: CriteriaQuery<Order>, tag: string): Promise<Order> {
+    emitter.emit.apply(emitter, ["core:order-set-tag", ...arguments]);
+    try {
+      let order = await Order.findOne(criteria);
+
+      if (order.state !== "CART") {
+        throw new Error(`Clear allowed only for CART state`);
+      }
+
+      return await Order.updateOne({ id: order.id }, { tag: tag }).fetch();
+    } catch (error) {
+      sails.log.error('Error tagging order:', error);
+    }
+  },
+
   async setCustomData(criteria: CriteriaQuery<Order>, customData: any): Promise<void> {
     await emitter.emit.apply(emitter, ["core:order-set-custom-data", ...arguments]);
     let order = await Order.findOne(criteria);