@ozdao/martyrs 0.2.486 → 0.2.488

package/src/modules/inventory/components/pages/InventoryEdit.vue

@@ -0,0 +1,405 @@
+<template>
+  <div class="pd-medium mobile:pd-thin">
+    <header class="mn-b-medium gap-small flex-v-center flex-nowrap flex">
+      <h2 class="">Create Inventory Audit</h2>
+    </header>
+    
+    <Popup 
+      title="Add position" 
+      @close-popup="closeProductsPopup" 
+      :isPopupOpen="isOpenProductsPopup"
+      class="bg-white w-100 w-max-30r  radius-medium pd-medium"
+    >
+      <Feed
+        :search="{
+          class: 'bg-light radius-small'
+        }"
+        :states="{
+          empty: {
+            title: 'No Products Found',
+            description: 'Currently, there are no such products available.'
+          }
+        }"
+        :store="{
+          read: (options) => products.actions.read(options),
+          state: null
+        }"
+        :options="{
+          owner: route.params._id,
+        }"
+        v-slot="{ 
+          items 
+        }"
+        class="flex-column flex gap-thin h-max-20r o-scroll"
+      >
+        <CardOrderItem
+          v-for="(product, index) in items" 
+          :key="`${product._id}_${product.variant || 'no-variant'}_${index}`"
+          :editable="false" 
+          :productId="product._id"
+          :variantId="product.variant"
+          :images="product.images"
+          :name="product.name"
+          :quantity="product.quantity || 1"
+          :unit="product.unit"
+          :dates="product.date"
+          :listing="product.listing"
+          :price="product.price"
+          @click="() => selectProduct(product)"
+          class="bg-light pd-small radius-small w-100"
+        />
+      </Feed>
+    </Popup>
+    
+    <!-- Popup for selecting variant of the product -->
+    <Popup 
+      title="Select variant" 
+      @close-popup="closeVariantsPopup" 
+      :isPopupOpen="isVariantsPopupOpen"
+      class="bg-white w-100 w-max-30r  radius-medium pd-medium"
+    >
+      <Feed
+        :store="variants"
+        :options="{
+          product: selectedProduct._id,
+        }"
+        :skeleton="{
+          structure: [
+            { block: 'text', size: 'small' },
+            { block: 'text', size: 'medium' },
+            { block: 'text', size: 'small' }
+          ]
+        }"
+        :states="{
+          empty: {
+            title: 'No variants',
+            description: 'Create your first variant'
+          }
+        }"
+         v-slot="{ items }"
+      >
+        <div class="gap-thin flex flex-column">
+          <div 
+            v-for="(variant, index) in items" 
+            :key="index"
+            @click="addVariantToInventory(variant)"
+            class="w-100 cursor-pointer hover-scale-1 bg-light pd-small radius-small flex-v-center flex-nowrap flex gap-thin"
+          >
+            <div v-if="variant.images && variant.images.length" class="aspect-1x1 h-3r radius-small o-hidden">
+              <img 
+                :src="(FILE_SERVER_URL || '') + variant.images[0]" 
+                class="w-100 h-100 object-fit-cover"
+              />
+            </div>
+            <div>
+              <p class="t-medium">{{ variant.name || 'Default variant' }}</p>
+              <p v-if="variant.attributes && variant.attributes.length" class="t-small t-transp">
+                {{ variant.attributes.map(attr => `${attr.name}: ${attr.value}`).join(', ') }}
+              </p>
+            </div>
+            <p class="mn-l-auto">{{ formatPrice(variant.cost) }}</p>
+          </div>
+        </div>
+      </Feed>
+    </Popup>
+
+    <Block
+      class="mn-b-thin"
+    >
+       <Field
+        v-model:field="inventory.state.current.comment"
+        placeholder="Describe details of the inventory audit"
+        type="textarea"
+        class="w-100 bg-white radius-small pd-medium"
+      />  
+      <div class="t-medium mn-t-small mn-b-thin">Select Storage:</div>
+      <Feed
+        :states="{
+          empty: {
+            title: 'No Spots Found',
+            description: 'Currently, there are no spots available.'
+          }
+        }"
+        :store="{
+          read: (options) => spots.actions.read(options),
+          state: null
+        }"
+        :options="{
+          user: auth.state.user._id,
+          organization: route.params._id,
+          limit: 3
+        }"
+        v-slot="{ 
+          items 
+        }"
+        class="flex-nowrap flex-column gap-thin flex"
+      >
+        <CardSpot
+          v-for="(spot, index) in items"
+          :key="index"
+          :spot="spot"
+          :organization="route.params._id"
+          :selected="inventory.state.current.storage === spot._id"
+          @click="() => inventory.state.current.storage = inventory.state.current.storage === spot._id ? null : spot._id"
+          class="radius-small h-min-big clickable bg-white"
+        />
+      </Feed>
+
+
+    </Block>
+
+    <Block
+      title="Positions"
+      :actions="[{
+        label: '+',
+        function: () => openProductsPopup()
+      }]"
+      placeholder="No positions added yet"
+      class="h-100 flex-column flex gap-thin mn-b-thin"
+    >
+      <CardPosition
+        v-for="(position, index) in inventory.state.current.positions" 
+        :key="position._id || index" 
+        :image="position.image"
+        :name="position.name"
+        :title="formatPrice(position.cost * position.quantity)"
+        :title_class="[position.cost * position.quantity < 0 ? 't-red' : 't-second']"
+        :subtitle="`${formatPrice(position.cost)} × ${Math.abs(position.quantity)}${position.unit} `"
+      >
+        <template v-slot:actions>
+          <QuantitySelector v-model="position.quantity"/>
+         
+          <!-- <Dropdown
+            :label="{ component: IconEllipsis, class: 't-transp i-medium' }"
+            class="cursor-pointer aspect-1x1 pd-nano radius-small hover-bg-light"
+            align="right"
+          >
+            <div class="bg-white radius-small">
+              <button @click="leftovers.state.current.positions.splice(index, 1)" class="cursor-pointer t-left t-nowrap w-100 pd-small">
+                Delete
+              </button>
+            </div>
+          </Dropdown> -->
+
+        </template>
+      </CardPosition>
+  
+    </Block>
+
+     <!--  :actions="[{
+          component: IconEdit,
+          handler: () => globals.actions.add(leftovers.state.current.positions, position),
+          class: 'bg-light'
+        },{
+          component: IconDelete,
+          handler: () => leftovers.state.current.positions.splice(index, 1),
+          class: 'bg-red'
+        }]" -->
+
+    <Block class="">
+      <section class="gap-thin flex-v-center flex-nojustify flex">
+        <span class="h3 mn-r-auto">
+          In total: {{formatPrice(totalPrice)}}
+        </span>
+
+         <!-- Save Draft -->
+        <Button
+          :submit="onSaveDraft"
+          class="bg-second w-min-5r button"
+        >
+          <span>Save Draft</span>
+        </Button>
+
+         <!-- Publish -->
+        <Button
+          :submit="onPublish"
+          class="bg-main w-min-5r button"
+        >
+          <span>Publish</span>
+        </Button>
+
+        <!-- Reset -->
+        <Button
+          :submit="onReset"
+          class="t-white w-min-5r bg-second button"
+        >
+          <span>Reset</span>
+        </Button>
+
+        <!-- Delete button removed - only create mode supported -->
+      </section>
+    </Block>
+  </div>
+</template>
+
+
+<script setup>
+  import Block from '@martyrs/src/components/Block/Block.vue';
+  import Button from "@martyrs/src/components/Button/Button.vue";
+  import Field from '@martyrs/src/components/Field/Field.vue';
+  import Feed from '@martyrs/src/components/Feed/Feed.vue';
+  import Select from '@martyrs/src/components/Select/Select.vue';
+  import Dropdown from '@martyrs/src/components/Dropdown/Dropdown.vue'
+  import Popup from '@martyrs/src/components/Popup/Popup.vue';
+
+  import CardOrderItem from '@martyrs/src/modules/orders/components/blocks/CardOrderItem.vue';
+  import CardSpot from '@martyrs/src/modules/spots/components/blocks/CardSpot.vue'; 
+
+  import CardPosition from '@martyrs/src/modules/products/components/blocks/CardPosition.vue';
+  import QuantitySelector from '@martyrs/src/modules/products/components/elements/QuantitySelector.vue';
+
+  import { computed, onMounted, ref, reactive } from 'vue';
+  import { useRoute, useRouter } from 'vue-router';
+  import { useGlobalMixins } from '@martyrs/src/modules/globals/views/mixins/mixins.js';
+ 
+  import * as globals from '@martyrs/src/modules/globals/views/store/globals.js';
+  import * as auth from '@martyrs/src/modules/auth/views/store/auth.js';
+  import * as inventory from '@martyrs/src/modules/inventory/store/ inventory.store.js';
+  import * as products from '@martyrs/src/modules/products/store/products.js';
+  import * as spots from '@martyrs/src/modules/spots/store/spots.js';
+  import variants from '@martyrs/src/modules/products/store/variants.store.js';
+
+  import IconEdit from '@martyrs/src/modules/icons/navigation/IconEdit.vue';
+  import IconDelete from '@martyrs/src/modules/icons/navigation/IconDelete.vue';
+  import IconEllipsis from '@martyrs/src/modules/icons/navigation/IconEllipsis.vue'
+
+  const route = useRoute();
+  const router = useRouter();
+  const { formatPrice } = useGlobalMixins();
+  
+  const isOpenProductsPopup = ref(false);
+  const isVariantsPopupOpen = ref(false);
+  const selectedProduct = ref(null);
+
+  const totalPrice = computed(() => {
+    return inventory.state.current.positions.reduce((sum, position) => {
+      return Number(sum) + Number(position.cost || 0) * Number(position.quantity || 1);
+    }, 0);
+  });
+
+  function openProductsPopup() {
+    isOpenProductsPopup.value = true;
+  }
+
+  function closeProductsPopup() {
+    isOpenProductsPopup.value = false;
+  }
+  
+  function closeVariantsPopup() {
+    isVariantsPopupOpen.value = false;
+    selectedProduct.value = null;
+  }
+  
+  function selectProduct(product) {
+    selectedProduct.value = product;
+    closeProductsPopup();
+    
+    // If product has only one variant, add it directly without showing popup
+    if (product.variants && product.variants.length === 1) {
+      addVariantToInventory(product.variants[0]);
+      return;
+    }
+    
+    // If product has multiple variants or no variants defined, show popup
+    isVariantsPopupOpen.value = true;
+  }
+
+  function formatProductName(product, variant) {
+    if (!variant || product.variants?.length === 1 && !(variant.attributes?.length))
+      return product.name;
+
+    const attrs = variant.attributes?.map(a => a.value).filter(Boolean);
+    return attrs?.length
+      ? `${product.name} / ${attrs.join(' / ')}`
+      : `${product.name} / ${variant.name}`;
+  }
+
+  
+  function addVariantToInventory(variant) {
+    // Create a position object that includes variant information
+    console.log('variant',variant)
+    const position = {
+      _id: variant._id,
+      product: selectedProduct.value._id, 
+      name: formatProductName(selectedProduct.value, variant),
+      image: variant.images?.[0] || selectedProduct.value?.images?.[0] || null,
+      cost: variant.cost || variant.price || 0,
+      unit: variant.unit || 'pcs',
+      quantity: 1,
+      variant: {
+        _id: variant._id,
+        name: variant.name,
+        attributes: variant.attributes || []
+      }
+    };
+    // Add position to inventory state
+    globals.actions.add(inventory.state.current.positions, position);
+    closeVariantsPopup();
+  }
+
+  onMounted(async () => {
+    // Reset inventory state for new audit
+    inventory.mutations.resetCurrent();
+  });
+
+  async function onReset() {
+    inventory.mutations.resetCurrent();
+    return true;
+  }
+
+
+  function prepareInventoryData(status = 'draft') {
+    return {
+      storage: inventory.state.current.storage,
+      comment: inventory.state.current.comment,
+      status: status,
+      positions: inventory.state.current.positions.map(pos => ({
+        product: pos.product,
+        variant: pos.variant?._id,
+        storage: inventory.state.current.storage,
+        quantity: pos.quantity,
+        reason: 'custom',
+        comment: `Inventory audit: ${pos.name}`,
+        cost: pos.cost
+      })),
+      owner: {
+        type: 'organization',
+        target: route.params._id
+      },
+      creator: {
+        type: 'user',
+        target: auth.state.user._id
+      }
+    };
+  }
+
+  function navigateBack() {
+    if (route.meta.context === 'backoffice') {
+      router.push({ name: 'BackofficeInventoryList' });
+    } else if (route.meta.context === 'organization') {
+      router.push({ name: 'OrganizationInventoryList', params: { _id: route.params._id } });
+    }
+  }
+
+  async function onSaveDraft() {
+    try {
+      const inventoryData = prepareInventoryData('draft');
+      await inventory.actions.createInventory(inventoryData);
+      navigateBack();
+    } catch (error) {
+      console.error('Error creating draft inventory:', error);
+    }
+  }
+
+  async function onPublish() {
+    try {
+      const inventoryData = prepareInventoryData('published');
+      await inventory.actions.createInventory(inventoryData);
+      navigateBack();
+    } catch (error) {
+      console.error('Error publishing inventory:', error);
+    }
+  }
+
+  // Remove delete function as we only support creation mode
+</script>

package/src/modules/inventory/docs/README.md

@@ -0,0 +1,291 @@
+# Inventory Module Documentation
+
+## Overview
+Inventory module provides comprehensive stock management functionality including inventory audits, stock adjustments, balance tracking, and availability calculations.
+
+## Architecture
+
+### Models
+
+#### 1. StockInventory
+**Purpose**: Mass inventory audit/stocktake sessions
+**Schema**:
+```javascript
+{
+  storage: ObjectId(Spot),     // Storage location
+  status: 'draft' | 'completed' | 'cancelled',
+  positions: [ObjectId(StockAdjustment)],  // Related adjustments
+  comment: String,             // Audit notes
+  owner: OwnershipSchema,      // Organization/User
+  creator: OwnershipSchema,    // Who created
+  createdAt: Date,
+  updatedAt: Date
+}
+```
+
+#### 2. StockAdjustment
+**Purpose**: Individual stock movements/corrections
+**Schema**:
+```javascript
+{
+  product: ObjectId(Product),   // Product reference
+  variant: ObjectId(Variant),   // Variant reference
+  storage: ObjectId(Spot),      // Storage location
+  source: {                     // Movement source
+    type: 'User' | 'Order' | 'Inventory',
+    target: ObjectId
+  },
+  reason: 'restock' | 'sale' | 'return' | 'damage' | 'transfer' | 'custom',
+  comment: String,              // Adjustment notes
+  quantity: Number,             // Can be positive or negative
+  cost: Number,                 // Cost per unit
+  owner: OwnershipSchema,
+  creator: OwnershipSchema,
+  createdAt: Date,
+  updatedAt: Date
+}
+```
+
+#### 3. StockBalance
+**Purpose**: Current stock levels per product/variant/storage
+**Schema**:
+```javascript
+{
+  product: ObjectId(Product),
+  variant: ObjectId(Variant),
+  storage: ObjectId(Spot),
+  quantity: Number,             // Current stock level
+  owner: OwnershipSchema,
+  creator: OwnershipSchema,
+  createdAt: Date,
+  updatedAt: Date
+}
+```
+
+#### 4. StockAvailability
+**Purpose**: Calculated availability including ingredient constraints
+**Schema**:
+```javascript
+{
+  product: ObjectId(Product),
+  variant: ObjectId(Variant),
+  storage: ObjectId(Spot),
+  quantity: Number,             // Direct stock
+  available: Number,            // Available considering ingredients
+  constraints: [{               // Ingredient limitations
+    ingredient: ObjectId,
+    stock: Number,
+    required: Number,
+    available: Number
+  }],
+  calculatedAt: Date,
+  owner: OwnershipSchema,
+  creator: OwnershipSchema
+}
+```
+
+#### 5. StockAlert
+**Purpose**: Stock level alerts and notifications
+**Schema**:
+```javascript
+{
+  product: ObjectId(Product),   // Product to monitor
+  variant: ObjectId(Variant),   // Specific variant (null = all variants)
+  storage: ObjectId(Spot),      // Specific storage (null = all storages)
+  threshold: Number,            // Alert threshold quantity
+  enabled: Boolean,             // Alert active status
+  owner: OwnershipSchema,       // Organization
+  creator: OwnershipSchema,     // User who created alert
+  createdAt: Date,
+  updatedAt: Date
+}
+```
+
+### API Endpoints
+
+#### StockAdjustment
+- `GET /api/inventory/adjustments` - List adjustments with filters
+- `POST /api/inventory/adjustments/create` - Create single adjustment
+
+#### StockBalance
+- `GET /api/inventory/balance` - Get current stock balances
+
+#### StockAvailability
+- `GET /api/inventory/availability` - Get availability with ingredient constraints
+
+#### StockAudit (renamed from StockInventory)
+- `GET /api/inventory/audits` - List inventory audits
+- `POST /api/inventory/audits/create` - Create inventory audit (draft/published)
+- `POST /api/inventory/audits/complete` - Complete inventory audit
+
+#### StockAlert
+- `GET /api/inventory/alerts` - List stock alerts with filters
+- `POST /api/inventory/alerts` - Create stock alert
+- `PUT /api/inventory/alerts` - Update stock alert
+- `DELETE /api/inventory/alerts` - Delete stock alert
+
+### Business Logic
+
+#### Availability Calculation
+The system automatically calculates availability based on:
+1. **Direct stock** - quantity in StockBalance
+2. **Ingredient constraints** - for variants with ingredients
+3. **On-demand support** - unlimited if no required ingredients
+
+#### Inventory Audit Workflow
+1. **Create Draft** - StockAudit in 'draft' status with positions as data
+2. **Publish** - Either publish directly or complete draft to apply changes
+3. **Auto-processing** - Creates StockAdjustments, updates balances, recalculates availability
+
+#### Stock Alert System
+1. **Create Alert** - Define product/variant/storage scope and threshold
+2. **Automatic Monitoring** - Alerts checked during availability recalculation
+3. **Notification Delivery** - Notifications sent via API when threshold breached
+4. **Flexible Scope** - Monitor entire product, specific variants, or storage locations
+
+#### Automatic Recalculation
+- Triggered on every StockAdjustment creation
+- Updates StockBalance via $inc operations
+- Recalculates StockAvailability for affected variants
+- Handles ingredient dependencies
+- Checks stock alerts and sends notifications when thresholds breached
+
+### Data Types
+
+#### Reason Types
+- `restock` - Incoming stock
+- `sale` - Stock sold
+- `return` - Returned items
+- `damage` - Damaged goods
+- `transfer` - Location transfer
+- `custom` - Custom reason
+
+#### Status Types
+- `draft` - Audit in progress
+- `published` - Audit completed and applied
+- `cancelled` - Audit cancelled
+
+### Frontend Integration
+
+#### Components Structure
+```
+inventory/
+├── components/
+│   ├── forms/
+│   │   ├── AdjustmentForm.vue     # Single adjustment creation
+│   │   ├── HistoryView.vue        # Adjustment history
+│   │   ├── ColumnSettingsMenu.vue # Table settings
+│   │   └── StockAlertsForm.vue    # Stock alert configuration
+│   ├── pages/
+│   │   ├── InventoryEdit.vue      # Mass inventory audit
+│   │   └── Inventory.vue          # Main inventory view
+│   └── blocks/
+│       └── ... (shared components)
+├── store/
+│   ├── inventory.store.js         # Legacy inventory store
+│   └── stock.alerts.store.js      # Stock alerts store
+├── services/
+│   ├── inventory.crud.js          # CRUD operations
+│   └── inventory.verifier.js      # Request validation
+└── routes/
+    ├── inventory.routes.js         # Main API routes
+    └── stock.alerts.routes.js      # Stock alerts routes
+```
+
+#### API Integration
+- **Mass Inventory**: Use StockInventory endpoints
+- **Point Adjustments**: Use StockAdjustment endpoints directly
+- **Display Data**: Use StockAvailability for current state
+
+#### Module Initialization
+The inventory module is initialized through `inventory.client.js`:
+```javascript
+export default {
+  initialize: initializeInventory
+};
+```
+
+#### Routing Configuration
+The module uses dynamic route registration with context-aware routing:
+- **Backoffice Context**: `/inventory` - Global inventory management
+- **Organization Context**: `/organizations/:_id/inventory` - Org-specific inventory
+
+#### Navigation Integration
+- Replaces legacy "Leftovers" navigation with "Inventory"
+- Supports both backoffice and organization contexts
+- Properly handles route parameters and authentication
+
+### Performance Considerations
+
+#### Caching
+- 5-minute TTL for read operations
+- Tag-based invalidation
+- Fire-and-forget cache clearing
+
+#### Bulk Operations
+- Bulk balance updates during inventory completion
+- Batch availability recalculation
+- Optimized aggregation pipelines
+
+#### Change Streams
+- Real-time ingredient recipe updates
+- Automatic availability recalculation
+- Observer pattern for notifications
+
+### Migration from Leftovers
+
+#### Architecture Changes
+- **From**: Simple leftovers model with basic tracking
+- **To**: Comprehensive inventory system with:
+  - Structured stock adjustments
+  - Automated balance tracking
+  - Availability calculations with ingredient constraints
+  - Audit trail capabilities
+
+#### Component Migration
+- `products/components/pages/LeftoverEdit.vue` → `inventory/components/pages/InventoryEdit.vue`
+- `products/components/pages/Leftovers.vue` → `inventory/components/pages/Inventory.vue`
+- Updated to use inventory API endpoints and models
+- Enhanced with context-aware routing
+
+#### API Migration
+- Legacy leftovers endpoints deprecated
+- New inventory endpoints provide enhanced functionality
+- Proper request validation through verifiers
+- ABAC integration for access control
+
+#### Data Format Changes
+- **Quantity**: Remains as `number` (not integer) for decimal support
+- **Structure**: Enhanced with source tracking, reason categorization
+- **Relationships**: Proper references to products, variants, and storage locations
+
+### Request Validation
+
+#### Verifier Implementation
+The inventory module uses comprehensive request validation:
+- **Type Conversion**: Automatic string-to-number conversion for skip/limit parameters
+- **Validation Rules**: Joi-based schema validation with custom rules
+- **Error Handling**: Proper error responses with validation details
+
+#### Common Validation Patterns
+- ObjectId validation for references
+- Numeric range validation for quantities and pagination
+- Enum validation for reason types and statuses
+- Required field validation with custom error messages
+
+### Testing Strategy
+
+#### Unit Tests
+- Model validation
+- Business logic functions
+- API endpoint responses
+
+#### Integration Tests
+- Full inventory workflow
+- Availability calculation accuracy
+- Balance consistency
+
+#### Performance Tests
+- Bulk operations
+- Large dataset handling
+- Concurrent access patterns