tango-api-schema 2.6.67 → 2.6.68

package/index.js

@@ -133,6 +133,7 @@ import audioStaticValueModel from "./schema/audioStaticValue.model.js";
 import recurringFlagTrackerModel from "./schema/recurringFlagTracker.model.js";
 import regionKeyModel from "./schema/regionKey.model.js";
 import lookPlanoCollectionModel from "./schema/lookPlanoCollection.model.js";
+import lookLibraryModel from "./schema/lookLibrary.model.js";
 
 
 export default {
@@ -267,5 +268,6 @@ export default {
   audioStaticValueModel,
   recurringFlagTrackerModel,
   regionKeyModel,
-  lookPlanoCollectionModel
+  lookPlanoCollectionModel,
+  lookLibraryModel
 };

package/package.json

@@ -1,28 +1,28 @@
-{
-  "name": "tango-api-schema",
-  "version": "2.6.67",
-  "description": "tangoEye model schema",
-  "main": "index.js",
-  "type": "module",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "start": "node index.js",
-    "build:patch": "node build.js patch && npm publish",
-    "build:minor": "node build.js minor && npm publish",
-    "build:major": "node build.js major && npm publish"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://praveen22raj@bitbucket.org/tangoeye-retail/tango-api-schema.git"
-  },
-  "author": "praveenraj",
-  "license": "ISC",
-  "bugs": {
-    "url": "https://bitbucket.org/tangoeye-retail/tango-api-schema/issues"
-  },
-  "homepage": "https://bitbucket.org/tangoeye-retail/tango-api-schema#readme",
-  "dependencies": {
-    "express": "^4.21.1",
-    "mongoose": "^7.5.3"
-  }
+{
+  "name": "tango-api-schema",
+  "version": "2.6.68",
+  "description": "tangoEye model schema",
+  "main": "index.js",
+  "type": "module",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "start": "node index.js",
+    "build:patch": "node build.js patch && npm publish",
+    "build:minor": "node build.js minor && npm publish",
+    "build:major": "node build.js major && npm publish"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://praveen22raj@bitbucket.org/tangoeye-retail/tango-api-schema.git"
+  },
+  "author": "praveenraj",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://bitbucket.org/tangoeye-retail/tango-api-schema/issues"
+  },
+  "homepage": "https://bitbucket.org/tangoeye-retail/tango-api-schema#readme",
+  "dependencies": {
+    "express": "^4.21.1",
+    "mongoose": "^7.5.3"
+  }
 }

package/schema/cctvPlacement.model.js

@@ -1,105 +1,105 @@
-import mongoose from 'mongoose';
-
-// CCTV camera placement tracking — one row per floor (v1).
-// Backs the internal "CCTV" table in Manage Planogram (tango-store-builder).
-// The floor's storeLayout.cctv sub-doc is the approval-team-facing mirror of
-// this row's status; both are written together by the store-builder API
-// transitions. Full design: tango-store-builder docs/CCTV_PLACEMENT_PLAN.md.
-// Added Aug 2026 — new collection, safe to drop to revert (see
-// tango-store-builder docs/CCTV_DB_CHANGES.md).
-const cctvPlacementSchema = new mongoose.Schema( {
-  clientId: {
-    type: String,
-    required: true,
-  },
-  storeId: {
-    type: String,
-    required: true,
-  },
-  storeName: {
-    type: String,
-    required: true,
-  },
-  planoId: {
-    type: mongoose.Types.ObjectId,
-    required: true,
-  },
-  floorId: {
-    type: mongoose.Types.ObjectId,
-    required: true,
-  },
-  floorNumber: {
-    type: Number,
-    default: 1,
-  },
-  // Auto-placement job id (also the OpenSearch job-doc _id): `${floorId}-${ts}`
-  jobId: {
-    type: String,
-  },
-  // autoPlacement:   queued / engine processing (row not openable)
-  // failed:          kickoff push or engine failed (Retry re-runs)
-  // open:            engine done — waiting for internal-team correction
-  // approvalPending: internal team submitted — waiting for approval team
-  // approved:        terminal, locked
-  status: {
-    type: String,
-    enum: [ 'autoPlacement', 'failed', 'open', 'approvalPending', 'approved' ],
-    default: 'autoPlacement',
-  },
-  // The floor.cadFiles entry (S3 key) this placement run descends from.
-  sourceKey: {
-    type: String,
-  },
-  errorMsg: {
-    type: String,
-  },
-  // CCTV DXF version timeline (loose Array — matches storeLayout.cadFiles
-  // style). Entry: { key, fileName, version, kind: 'auto'|'manual'|'approver',
-  // sourceKey, cameraCount, uploadedBy, uploadedByName, uploadedAt }
-  files: {
-    type: Array,
-    default: [],
-  },
-  isRework: {
-    type: Boolean,
-    default: false,
-  },
-  reworkCount: {
-    type: Number,
-    default: 0,
-  },
-  // Status transition audit trail. Entry: { from, to, by, byName, at, comment }
-  history: {
-    type: Array,
-    default: [],
-  },
-  createdBy: {
-    type: mongoose.Types.ObjectId,
-  },
-  createdByName: {
-    type: String,
-  },
-  createdByEmail: {
-    type: String,
-  },
-  updatedBy: {
-    type: mongoose.Types.ObjectId,
-  },
-  updatedByName: {
-    type: String,
-  },
-},
-{
-  strict: true,
-  versionKey: false,
-  timestamps: true,
-},
-);
-
-// One placement row per floor (v1 — the future override flow resets/reuses the
-// same row rather than creating a second one).
-cctvPlacementSchema.index( { floorId: 1 }, { unique: true } );
-// Internal CCTV table: list/filter by client + status.
-cctvPlacementSchema.index( { clientId: 1, status: 1 } );
-
-export default mongoose.model( 'cctvPlacement', cctvPlacementSchema );
+import mongoose from 'mongoose';
+
+// CCTV camera placement tracking — one row per floor (v1).
+// Backs the internal "CCTV" table in Manage Planogram (tango-store-builder).
+// The floor's storeLayout.cctv sub-doc is the approval-team-facing mirror of
+// this row's status; both are written together by the store-builder API
+// transitions. Full design: tango-store-builder docs/CCTV_PLACEMENT_PLAN.md.
+// Added Aug 2026 — new collection, safe to drop to revert (see
+// tango-store-builder docs/CCTV_DB_CHANGES.md).
+const cctvPlacementSchema = new mongoose.Schema( {
+  clientId: {
+    type: String,
+    required: true,
+  },
+  storeId: {
+    type: String,
+    required: true,
+  },
+  storeName: {
+    type: String,
+    required: true,
+  },
+  planoId: {
+    type: mongoose.Types.ObjectId,
+    required: true,
+  },
+  floorId: {
+    type: mongoose.Types.ObjectId,
+    required: true,
+  },
+  floorNumber: {
+    type: Number,
+    default: 1,
+  },
+  // Auto-placement job id (also the OpenSearch job-doc _id): `${floorId}-${ts}`
+  jobId: {
+    type: String,
+  },
+  // autoPlacement:   queued / engine processing (row not openable)
+  // failed:          kickoff push or engine failed (Retry re-runs)
+  // open:            engine done — waiting for internal-team correction
+  // approvalPending: internal team submitted — waiting for approval team
+  // approved:        terminal, locked
+  status: {
+    type: String,
+    enum: [ 'autoPlacement', 'failed', 'open', 'approvalPending', 'approved' ],
+    default: 'autoPlacement',
+  },
+  // The floor.cadFiles entry (S3 key) this placement run descends from.
+  sourceKey: {
+    type: String,
+  },
+  errorMsg: {
+    type: String,
+  },
+  // CCTV DXF version timeline (loose Array — matches storeLayout.cadFiles
+  // style). Entry: { key, fileName, version, kind: 'auto'|'manual'|'approver',
+  // sourceKey, cameraCount, uploadedBy, uploadedByName, uploadedAt }
+  files: {
+    type: Array,
+    default: [],
+  },
+  isRework: {
+    type: Boolean,
+    default: false,
+  },
+  reworkCount: {
+    type: Number,
+    default: 0,
+  },
+  // Status transition audit trail. Entry: { from, to, by, byName, at, comment }
+  history: {
+    type: Array,
+    default: [],
+  },
+  createdBy: {
+    type: mongoose.Types.ObjectId,
+  },
+  createdByName: {
+    type: String,
+  },
+  createdByEmail: {
+    type: String,
+  },
+  updatedBy: {
+    type: mongoose.Types.ObjectId,
+  },
+  updatedByName: {
+    type: String,
+  },
+},
+{
+  strict: true,
+  versionKey: false,
+  timestamps: true,
+},
+);
+
+// One placement row per floor (v1 — the future override flow resets/reuses the
+// same row rather than creating a second one).
+cctvPlacementSchema.index( { floorId: 1 }, { unique: true } );
+// Internal CCTV table: list/filter by client + status.
+cctvPlacementSchema.index( { clientId: 1, status: 1 } );
+
+export default mongoose.model( 'cctvPlacement', cctvPlacementSchema );

package/schema/lookLibrary.model.js

@@ -0,0 +1,112 @@
+import mongoose from 'mongoose';
+
+const lookLibrarySchema = new mongoose.Schema(
+    {
+      clientId: {
+        type: String,
+        required: true,
+      },
+      // "Looks" column — canonical look name, e.g. 'JJ Icons Slim Non Metal (Eye)'.
+      // The '(Eye)' / '(Sun)' suffix is load-bearing: MBQ splits combined look cells on '&'
+      // and every part is required to carry it, so never store a look name without it.
+      lookName: {
+        type: String,
+        required: true,
+        trim: true,
+      },
+      // Case/whitespace-normalised lookName ( lowercase, single-spaced ) — the actual join key.
+      // PID and header text coming off client sheets varies in case and spacing, so every
+      // lookup resolves on this, not on lookName. Controller writes it; see normaliseLookKey.
+      lookKey: {
+        type: String,
+        required: true,
+        trim: true,
+        lowercase: true,
+      },
+      // Older / renamed spellings that must still resolve to this look ( PID renames,
+      // 'Icon' vs 'Icons' class of typo ). Raw text in aliases, normalised in aliasKeys —
+      // query aliasKeys, display aliases.
+      aliases: [ String ],
+      aliasKeys: [ String ],
+      // "Category" column. Always agrees with the name suffix: (Eye) -> eyeframe, (Sun) -> sunglasses.
+      category: {
+        type: String,
+        enum: [ 'eyeframe', 'sunglasses' ],
+      },
+      // "Brand" column — lineup brand ( Vincent Chase, John Jacobs, Lenskart Air, Hooper... ).
+      // Free text, deliberately not an enum: the brand list grows with every lineup drop.
+      brand: {
+        type: String,
+        trim: true,
+      },
+      // "Band" column — MBQ band. Every look in the first master lands on 'Others'.
+      band: {
+        type: String,
+        trim: true,
+        default: 'Others',
+      },
+      // "Definition" column verbatim, so the master can be re-exported unchanged.
+      definition: {
+        type: String,
+      },
+      // Sections parsed out of definition:
+      // 'Style & Design: <...> Materials: <...> Fits & Variations: <...>'
+      styleAndDesign: {
+        type: String,
+      },
+      materials: {
+        type: String,
+      },
+      fitsAndVariations: {
+        type: String,
+      },
+      summary: {
+        type: String,
+      },
+      // Library presentation / lifecycle — mirrors planoVmDetail.
+      imageUrl: {
+        type: String,
+      },
+      sortOrder: {
+        type: Number,
+        default: 0,
+      },
+      // Retire a look without deleting it — historical revisions still reference the name.
+      isActive: {
+        type: Boolean,
+        default: true,
+      },
+      status: {
+        type: String,
+        enum: [ 'draft', 'complete' ],
+        default: 'draft',
+      },
+      createdBy: {
+        type: String,
+      },
+      createdByName: {
+        type: String,
+      },
+      updatedBy: {
+        type: String,
+      },
+      updatedByName: {
+        type: String,
+      },
+    },
+    {
+      strict: false,
+      versionKey: false,
+      timestamps: true,
+    },
+);
+
+// Indexes — {clientId,lookKey} is the resolve-a-look-by-name path and doubles as the dedupe
+// guard, so it is unique: dedupe the seed before creating it or index build fails.
+// {clientId,aliasKeys} covers the renamed-PID fallback lookup; {clientId,brand,category}
+// covers the library grid's brand/category filters and its default sort.
+lookLibrarySchema.index( { clientId: 1, lookKey: 1 }, { unique: true } );
+lookLibrarySchema.index( { clientId: 1, aliasKeys: 1 } );
+lookLibrarySchema.index( { clientId: 1, brand: 1, category: 1 } );
+
+export default mongoose.model( 'lookLibrary', lookLibrarySchema );

package/schema/recurringFlagTracker.model.js

@@ -1,92 +1,92 @@
-import mongoose from 'mongoose';
-
-const recurringFlagTrackerSchema = new mongoose.Schema({
-    client_id: {
-        type: String,
-        required: true,
-    },
-    sourceCheckList_id: {
-        type: mongoose.SchemaTypes.ObjectId,
-        ref: 'checklistconfig',
-        required: true,
-    },
-    checkListName: {
-        type: String,
-    },
-    coverage: {
-        type: String,
-        enum: ['store', 'user'],
-        default: 'store',
-    },
-    store_id: {
-        type: String,
-        default: '',
-    },
-    storeName: {
-        type: String,
-    },
-    user_id: {
-        type: String,
-        default: '',
-    },
-    userName: {
-        type: String,
-    },
-    userEmail: {
-        type: String,
-    },
-    section_id: {
-        type: String,
-    },
-    sectionName: {
-        type: String,
-    },
-    qno: {
-        type: String,
-    },
-    qname: {
-        type: String,
-    },
-    consecutiveCount: {
-        type: Number,
-        default: 0,
-    },
-    lastFlaggedDate: {
-        type: String,
-    },
-    lastEmailDate: {
-        type: String,
-    },
-    runAICount: {
-        type: Number,
-        default: 0,
-    },
-    lastRunAIFlaggedDate: {
-        type: String,
-    },
-    emailHistory: {
-        type: [ String ],
-        default: [],
-    },
-    lastSubmittedBy: {
-        type: String,
-    },
-    lastSubmissionDate: {
-        type: String,
-    },
-}, {
-    strict: true,
-    versionKey: false,
-    timestamps: true,
-});
-
-recurringFlagTrackerSchema.index({
-    client_id: 1,
-    sourceCheckList_id: 1,
-    store_id: 1,
-    user_id: 1,
-    section_id: 1,
-    qno: 1,
-}, { unique: true });
-
-export default mongoose.model('recurringFlagTracker', recurringFlagTrackerSchema);
+import mongoose from 'mongoose';
+
+const recurringFlagTrackerSchema = new mongoose.Schema({
+    client_id: {
+        type: String,
+        required: true,
+    },
+    sourceCheckList_id: {
+        type: mongoose.SchemaTypes.ObjectId,
+        ref: 'checklistconfig',
+        required: true,
+    },
+    checkListName: {
+        type: String,
+    },
+    coverage: {
+        type: String,
+        enum: ['store', 'user'],
+        default: 'store',
+    },
+    store_id: {
+        type: String,
+        default: '',
+    },
+    storeName: {
+        type: String,
+    },
+    user_id: {
+        type: String,
+        default: '',
+    },
+    userName: {
+        type: String,
+    },
+    userEmail: {
+        type: String,
+    },
+    section_id: {
+        type: String,
+    },
+    sectionName: {
+        type: String,
+    },
+    qno: {
+        type: String,
+    },
+    qname: {
+        type: String,
+    },
+    consecutiveCount: {
+        type: Number,
+        default: 0,
+    },
+    lastFlaggedDate: {
+        type: String,
+    },
+    lastEmailDate: {
+        type: String,
+    },
+    runAICount: {
+        type: Number,
+        default: 0,
+    },
+    lastRunAIFlaggedDate: {
+        type: String,
+    },
+    emailHistory: {
+        type: [ String ],
+        default: [],
+    },
+    lastSubmittedBy: {
+        type: String,
+    },
+    lastSubmissionDate: {
+        type: String,
+    },
+}, {
+    strict: true,
+    versionKey: false,
+    timestamps: true,
+});
+
+recurringFlagTrackerSchema.index({
+    client_id: 1,
+    sourceCheckList_id: 1,
+    store_id: 1,
+    user_id: 1,
+    section_id: 1,
+    qno: 1,
+}, { unique: true });
+
+export default mongoose.model('recurringFlagTracker', recurringFlagTrackerSchema);