tango-api-schema 2.2.25 → 2.2.27

package/index.js

@@ -74,6 +74,12 @@ import nobBillingModel from "./schema/nobBilling.model.js";
 import storeLayoutModel from "./schema/storeLayout.model.js";
 import planogramModel from "./schema/planogram.model.js";
 import emailersModel from "./schema/emailers.model.js";
+import planoMappingModel from './schema/planoMapping.model.js';
+import planoProductModel from  './schema/planoProductDetail.model.js';
+import planoComplianceModel from './schema/planoCompliance.model.js';
+import storeFixtureModel from './schema/storeFixture.model.js';
+import fixtureConfigModel from './schema/fixtureConfig.model.js';
+import fixtureShelfModel from './schema/fixtureShelf.model.js';
 
 export default {
   leadModel,
@@ -152,4 +158,10 @@ export default {
   storeLayoutModel,
   planogramModel,
   emailersModel,
+  planoMappingModel,
+  planoProductModel,
+  planoComplianceModel,
+  storeFixtureModel,
+  fixtureConfigModel,
+  fixtureShelfModel,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tango-api-schema",
-  "version": "2.2.25",
+  "version": "2.2.27",
   "description": "tangoEye model schema",
   "main": "index.js",
   "type": "module",

package/schema/emailers.model.js

@@ -15,7 +15,7 @@ const emailersSchema = new mongoose.Schema({
             type: String,
         },   
         storeIds: {
-            type: array,
+            type: Array,
             default: [],
         },   
         status: {

package/schema/fixtureConfig.model.js

@@ -0,0 +1,57 @@
+import mongoose from 'mongoose';
+
+const fixtureConfigSchema = new mongoose.Schema(
+    {
+      clientId: {
+        type: String,
+        required: true,
+      },
+      fixtureCategory: {
+        type: String,
+        required: true,
+      },
+      fixtureType: {
+        type: String,
+        enum: [ 'wall', 'floor' ],
+        required: true,
+      },
+      fixtureHeight: {
+        value: {
+          type: Number,
+          required: true,
+        },
+        unit: {
+          type: String,
+          default: 'mm',
+        },
+      },
+      fixtureLength: {
+        value: {
+          type: Number,
+          required: true,
+        },
+        unit: {
+          type: String,
+          default: 'mm',
+        },
+      },
+      fixtureWidth: {
+        value: {
+          type: Number,
+          default: 914,
+        },
+        unit: {
+          type: String,
+          default: 'mm',
+        },
+      },
+
+    },
+    {
+      strict: true,
+      versionKey: false,
+      timestamps: true,
+    },
+);
+
+export default mongoose.model( 'fixtureConfig', fixtureConfigSchema );

package/schema/fixtureShelf.model.js

@@ -0,0 +1,57 @@
+import mongoose from 'mongoose';
+
+const fixtureShelfSchema = new mongoose.Schema(
+    {
+      clientId: {
+        type: String,
+        required: true,
+      },
+      storeName: {
+        type: String,
+        required: true,
+      },
+      storeId: {
+        type: String,
+        required: true,
+      },
+      planoId: {
+        type: mongoose.Types.ObjectId,
+        required: true,
+      },
+      floorId: {
+        type: mongoose.Types.ObjectId,
+        required: true,
+      },
+      fixtureId: {
+        type: mongoose.Types.ObjectId,
+        required: true,
+      },
+      shelfNumber: {
+        type: Number,
+        required: true,
+      },
+
+      shelfOrder: {
+        type: String,
+        enum: [ 'LTR', 'RTL' ],
+        // LTR - Left to Right, RTL - Right to Left
+        required: true,
+      },
+      shelfCapacity: {
+        type: Number,
+        required: true,
+      },
+      shelfType:{
+        type: String,
+        enum: [ 'header', 'footer', 'middle' ],
+        default:'middle'
+      }
+    },
+    {
+      strict: true,
+      versionKey: false,
+      timestamps: true,
+    },
+);
+
+export default mongoose.model( 'fixtureShelf', fixtureShelfSchema );

package/schema/planoCompliance.model.js

@@ -0,0 +1,55 @@
+import mongoose from 'mongoose';
+
+const planoComplianceSchema = new mongoose.Schema(
+    {
+      clientId: {
+        type: String,
+        required: true,
+      },
+      storeName: {
+        type: String,
+        required: true,
+      },
+      storeId: {
+        type: String,
+        required: true,
+      },
+      type: {
+        type: String,
+        enum: [ 'product', 'vm' ],
+        default:'product'
+      },
+      planoId: {
+        type: mongoose.Types.ObjectId,
+      },
+      floorId: {
+        type: mongoose.Types.ObjectId,
+      },
+      fixtureId: {
+        type: mongoose.Types.ObjectId,
+      },
+      shelfId: {
+        type: mongoose.Types.ObjectId,
+      },
+      shelfPosition: {
+        type: Number,
+      },
+      productId: {
+        type: mongoose.Types.ObjectId,
+      },
+      rfId: {
+        type: String,
+      },
+      compliance: {
+        type: String,
+        enum: [ 'misplaced', 'proper' ],
+      },
+    },
+    {
+      strict: true,
+      versionKey: false,
+      timestamps: true,
+    },
+);
+
+export default mongoose.model( 'planoCompliance', planoComplianceSchema );

package/schema/planoMapping.model.js

@@ -0,0 +1,55 @@
+import mongoose from 'mongoose';
+
+const planoMappingSchema = new mongoose.Schema(
+    {
+      clientId: {
+        type: String,
+        required: true,
+      },
+      storeName: {
+        type: String,
+        required: true,
+      },
+      storeId: {
+        type: String,
+        required: true,
+      },
+      type: {
+        type: String,
+        enum: [ 'product', 'vm' ],
+        required: true,
+      },
+      planoId: {
+        type: mongoose.Types.ObjectId,
+        required: true,
+      },
+      floorId: {
+        type: mongoose.Types.ObjectId,
+        required: true,
+      },
+      fixtureId: {
+        type: mongoose.Types.ObjectId,
+      },
+      shelfId: {
+        type: mongoose.Types.ObjectId,
+      },
+      shelfPosition: {
+        type: Number,
+      },
+      productId: {
+        type: mongoose.Types.ObjectId,
+        required: true,
+      },
+      rfId: {
+        type: String,
+        required: true,
+      },
+    },
+    {
+      strict: true,
+      versionKey: false,
+      timestamps: true,
+    },
+);
+
+export default mongoose.model( 'planoMapping', planoMappingSchema );

package/schema/planoProductDetail.model.js

@@ -0,0 +1,66 @@
+import mongoose from 'mongoose';
+
+const planoProductDetailSchema = new mongoose.Schema(
+    {
+      clientId: {
+        type: String,
+        required: true,
+      },
+      productId: {
+        type: String,
+        required: true,
+      },
+      productName: {
+        type: String,
+      },
+      productSku: {
+        type: String,
+      },
+      productBrand: {
+        type: String,
+      },
+      productType: {
+        type: String,
+      },
+      productHeight: {
+        value: {
+          type: Number,
+        },
+        unit: {
+          type: String,
+          default: 'mm',
+        },
+      },
+      productWidth: {
+        value: {
+          type: Number,
+        },
+        unit: {
+          type: String,
+          default: 'mm',
+        },
+      },
+      productWeight: {
+        value: {
+          type: Number,
+        },
+        unit: {
+          type: String,
+          default: 'g',
+        },
+      },
+      productSize: {
+        type: String,
+      },
+      productImageUrl: {
+        type: String,
+      },
+    },
+    {
+      strict: false,
+      versionKey: false,
+      timestamps: true,
+    },
+);
+
+export default mongoose.model( 'planoProductDetail', planoProductDetailSchema );

package/schema/planogram.model.js

@@ -1,53 +1,59 @@
 import mongoose from 'mongoose';
- 
-const planogramSchema = new mongoose.Schema({
-    storeName:{
-        type:String,
-        required:true
-    },
-    storeId:{
-        type:String,
-        required:true
-    },
-    layoutName:{
-        type:String,
-        required:true
-    },
-    clientId:{
-        type:String,
-        required:true
-    },
-    attachments:{
-        type:Array,
-        default:[]
-    },
-    createdBy:{
-        type:mongoose.Types.ObjectId,
-        required:true
-    },
-    createdByName:{
-        type:String,
-        required:true
-    },
-    createdByEmail:{
-        type:String,
-        required:true
-    },
-    status:{
-        type:String,
-        enum:['draft','completed'],
-        default:'draft'
-    },
-    floorNumber:{
-        type:Number,
-        default:1
-    }
+
+const planogramSchema = new mongoose.Schema( {
+  storeName: {
+    type: String,
+    required: true,
+  },
+  storeId: {
+    type: String,
+    required: true,
+  },
+  layoutName: {
+    type: String,
+    required: true,
+  },
+  clientId: {
+    type: String,
+    required: true,
+  },
+  attachments: {
+    type: Array,
+    default: [],
+  },
+  createdBy: {
+    type: mongoose.Types.ObjectId,
+    required: true,
+  },
+  createdByName: {
+    type: String,
+    required: true,
+  },
+  createdByEmail: {
+    type: String,
+    required: true,
+  },
+  status: {
+    type: String,
+    enum: [ 'draft', 'completed' ],
+    default: 'draft',
+  },
+  floorNumber: {
+    type: Number,
+    default: 1,
+  },
+  productResolutionLevel: {
+    type: String,
+    enum: [ 'L1', 'L2', 'L3', 'L4' ],
+    // L1- floor level, L2- fixture level, L3- fixture-shelf level, L4- fixture-shelf-product level
+    default: 'L3',
+  }
 },
 {
-    strict: true,
-    versionKey: false,
-    timestamps: true,
+  strict: true,
+  versionKey: false,
+  timestamps: true,
 },
 );
- 
-export default mongoose.model( 'planogram', planogramSchema);
+
+export default mongoose.model( 'planogram', planogramSchema );

package/schema/storeFixture.model.js

@@ -0,0 +1,122 @@
+import mongoose from 'mongoose';
+
+const storeFixtureSchema = new mongoose.Schema(
+    {
+      clientId: {
+        type: String,
+        required: true,
+      },
+      storeName: {
+        type: String,
+        required: true,
+      },
+      storeId: {
+        type: String,
+        required: true,
+      },
+      planoId: {
+        type: mongoose.Types.ObjectId,
+        required: true,
+      },
+      floorId: {
+        type: mongoose.Types.ObjectId,
+        required: true,
+      },
+      fixtureName: {
+        type: String,
+        required: true,
+      },
+      fixtureCategory: {
+        type: String,
+        required: true,
+      },
+      fixtureType: {
+        type: String,
+        enum: [ 'wall', 'floor' ],
+        required: true,
+      },
+      fixtureHeight: {
+        value: {
+          type: Number,
+          required: true,
+        },
+        unit: {
+          type: String,
+          default: 'mm',
+        },
+      },
+      fixtureLength: {
+        value: {
+          type: Number,
+          required: true,
+        },
+        unit: {
+          type: String,
+          default: 'mm',
+        },
+      },
+      fixtureWidth: {
+        value: {
+          type: Number,
+          default: 914,
+        },
+        unit: {
+          type: String,
+          default: 'mm',
+        },
+      },
+      productPerShelf: {
+        type: Number,
+        required: true,
+      },
+      mbq: {
+        type: Number,
+      },
+      fixtureCapacity: {
+        type: Number,
+      },
+      shelfcount: {
+        type: Number,
+        required: true,
+      },
+      associatedElementType: {
+        type: String,
+        enum: [ 'wall', 'facade' ],
+      },
+      associatedElementNumber: {
+        type: Number,
+      },
+      fixtureId: {
+        type: mongoose.Types.ObjectId,
+        required: true,
+      },
+      relativePosition: {
+        x: {
+          type: Number,
+          default: 0,
+        },
+        y: {
+          type: Number,
+          default: 0,
+        },
+        unit: {
+          type: String,
+          default: 'mm',
+        },
+      },
+      fixtureOrder: {
+        type: String,
+        enum: [ 'TTB', 'BTT' ],
+        // TTB - Top to Bottom, BTT - Bottom to Top
+        required: true,
+      },
+    },
+
+    {
+      strict: true,
+      versionKey: false,
+      timestamps: true,
+    },
+);
+
+export default mongoose.model( 'storeFixture', storeFixtureSchema );

package/schema/storeLayout.model.js

@@ -1,61 +1,67 @@
 import mongoose from 'mongoose';
- 
-const storeLayoutSchema = new mongoose.Schema({
-        storeName:{
-            type:String,
-            required:true
-        },
-        storeId:{
-            type:String,
-            required:true
-        },
-        layoutName:{
-            type:String,
-            required:true
-        },
-        clientId:{
-            type:String,
-            required:true
-        },
-        floorNumber:{
-            type:Number,
-            default:1,
-        },
-        floorName:{
-            type:String,
-            required:true
-        },
-        layoutPolygon:{
-            type:Array,
-            default:[]
-        },
-        createdBy:{
-            type:mongoose.Types.ObjectId,
-            required:true
-        },
-        createdByName:{
-            type:String,
-            required:true
-        },
-        createdByEmail:{
-            type:String,
-            required:true
-        },
-        status:{
-            type:String,
-            enum:['draft','completed'],
-            default:'draft'
-        },
-        planoId:{
-            type:mongoose.Types.ObjectId,
-            required:true
-        }
-    },
-    {
-        strict: true,
-        versionKey: false,
-        timestamps: true,
-    },
+
+const storeLayoutSchema = new mongoose.Schema( {
+  storeName: {
+    type: String,
+    required: true,
+  },
+  storeId: {
+    type: String,
+    required: true,
+  },
+  layoutName: {
+    type: String,
+    required: true,
+  },
+  clientId: {
+    type: String,
+    required: true,
+  },
+  floorNumber: {
+    type: Number,
+    default: 1,
+  },
+  floorName: {
+    type: String,
+    required: true,
+  },
+  layoutPolygon: {
+    type: Array,
+    default: [],
+  },
+  createdBy: {
+    type: mongoose.Types.ObjectId,
+    required: true,
+  },
+  createdByName: {
+    type: String,
+    required: true,
+  },
+  createdByEmail: {
+    type: String,
+    required: true,
+  },
+  status: {
+    type: String,
+    enum: [ 'draft', 'completed' ],
+    default: 'draft',
+  },
+  planoId: {
+    type: mongoose.Types.ObjectId,
+    required: true,
+  },
+  storeOrder: {
+    type: String,
+    enum: [ 'LTR', 'RTL' ],
+    // LTR - Left to Right, RTL - Right to Left
+    required: true,
+  },
+},
+{
+  strict: true,
+  versionKey: false,
+  timestamps: true,
+},
 );
- 
-export default mongoose.model( 'storeLayout', storeLayoutSchema);
+
+export default mongoose.model( 'storeLayout', storeLayoutSchema );