@shyntech-proximity/inventories 1.0.3 → 1.0.4

package/docs/QA.md

@@ -0,0 +1,215 @@
+# 🧪 QA Test Matrix
+
+## Proximity Inventory Backend Service (Inventory Domain)
+
+---
+
+## 1. Test Coverage Overview
+
+| Area                          | Covered |
+| ----------------------------- | ------- |
+| Proximity inventory discovery | ✅       |
+| Inventory lookup              | ✅       |
+| Inventory search              | ✅       |
+| Vendor inventory retrieval    | ✅       |
+| Inventory CRUD                | ✅       |
+| Bulk inventory operations     | ✅       |
+| Error handling                | ✅       |
+| Non-functional constraints    | ✅       |
+
+---
+
+## 2. Proximity Inventory Discovery Tests
+
+### Endpoint: `GET /inventory`
+
+| Test ID | Scenario                   | Preconditions                | Input                | Expected Result                      |
+| ------- | -------------------------- | ---------------------------- | -------------------- | ------------------------------------ |
+| P-01    | Valid proximity match      | DeviceScan exists with SSIDs | Valid device headers | 200, list of vendors                 |
+| P-02    | No proximity data          | No DeviceScan for device     | Valid headers        | 404, error message                   |
+| P-03    | Multiple SSID matches      | Scan overlaps >1 vendor      | Valid headers        | 200, multiple vendors                |
+| P-04    | Header priority resolution | All headers present          | All headers          | Device resolved using priority order |
+| P-05    | Fallback to socket IP      | No headers present           | None                 | Uses socket IP                       |
+| P-06    | Empty SSID list            | Scan exists but no SSIDs     | Valid headers        | 200, empty vendor list               |
+| P-07    | Server failure             | DB unavailable               | Valid headers        | 500                                  |
+
+---
+
+## 3. Inventory Item Lookup Tests
+
+### Endpoint: `GET /inventory/:itemId`
+
+| Test ID | Scenario           | Preconditions              | Input          | Expected Result               |
+| ------- | ------------------ | -------------------------- | -------------- | ----------------------------- |
+| I-01    | Valid item lookup  | Item exists                | Valid itemId   | 200, vendor + item            |
+| I-02    | Item not found     | Item absent                | Invalid itemId | 404                           |
+| I-03    | Duplicate item IDs | Same itemId across vendors | Valid itemId   | First matched vendor returned |
+| I-04    | Malformed itemId   | Invalid format             | Malformed ID   | 404                           |
+| I-05    | DB error           | DB failure                 | Valid itemId   | 500                           |
+
+---
+
+## 4. Inventory Search Tests
+
+### Endpoint: `GET /search?query=...`
+
+| Test ID | Scenario             | Preconditions        | Input            | Expected Result    |
+| ------- | -------------------- | -------------------- | ---------------- | ------------------ |
+| S-01    | Match inventory name | Matching item exists | `query=name`     | 200, matched items |
+| S-02    | Match category       | Category exists      | `query=category` | 200                |
+| S-03    | Match tags           | Tag exists           | `query=tag`      | 200                |
+| S-04    | Match vendor name    | Vendor matches       | `query=vendor`   | Vendor returned    |
+| S-05    | Match vendor address | Address matches      | `query=address`  | Vendor returned    |
+| S-06    | Case-insensitive     | Mixed case           | `query=MiXeD`    | Match returned     |
+| S-07    | No matches           | No matching fields   | `query=zzz`      | 200, empty results |
+| S-08    | Empty query          | —                    | `query=`         | 400                |
+| S-09    | Missing query        | —                    | No query param   | 400                |
+| S-10    | Special characters   | Regex-safe input     | `query=@#$`      | 200 or empty       |
+
+---
+
+## 5. Vendor Inventory Retrieval Tests
+
+### Endpoint: `GET /vendor/:vendorId/inventory`
+
+| Test ID | Scenario                 | Preconditions   | Input            | Expected Result      |
+| ------- | ------------------------ | --------------- | ---------------- | -------------------- |
+| V-01    | Valid vendor inventory   | Vendor exists   | Valid vendorId   | 200, inventory array |
+| V-02    | Vendor with no inventory | Empty inventory | Valid vendorId   | 200, empty array     |
+| V-03    | Vendor not found         | Vendor missing  | Invalid vendorId | 404                  |
+| V-04    | Malformed vendorId       | Invalid format  | Malformed ID     | 404                  |
+| V-05    | DB failure               | DB unavailable  | Valid vendorId   | 500                  |
+
+---
+
+## 6. Single Inventory CRUD Tests
+
+### 6.1 Add Inventory Item
+
+**POST `/vendor/:vendorId/inventory`**
+
+| Test ID | Scenario          | Preconditions    | Input           | Expected Result      |
+| ------- | ----------------- | ---------------- | --------------- | -------------------- |
+| C-01    | Add valid item    | Vendor exists    | Valid item body | 200, item added      |
+| C-02    | Vendor not found  | Vendor absent    | Valid body      | 404                  |
+| C-03    | Duplicate item_id | Same item exists | Same item_id    | 200 (no enforcement) |
+| C-04    | Missing item_id   | —                | Invalid body    | 200 or schema error  |
+| C-05    | DB failure        | DB unavailable   | Valid body      | 500                  |
+
+---
+
+### 6.2 Update Inventory Item
+
+**PUT `/inventory/:itemId`**
+
+| Test ID | Scenario          | Preconditions  | Input                 | Expected Result             |
+| ------- | ----------------- | -------------- | --------------------- | --------------------------- |
+| C-06    | Partial update    | Item exists    | `{ price }`           | 200, price updated          |
+| C-07    | Multiple fields   | Item exists    | `{ price, quantity }` | 200                         |
+| C-08    | Item not found    | Item absent    | Valid body            | 404                         |
+| C-09    | Empty update body | Item exists    | `{}`                  | 200, no change              |
+| C-10    | Invalid field     | Item exists    | `{ foo: 1 }`          | Field added (no validation) |
+| C-11    | DB failure        | DB unavailable | Valid body            | 500                         |
+
+---
+
+### 6.3 Delete Inventory Item
+
+**DELETE `/inventory/:itemId`**
+
+| Test ID | Scenario          | Preconditions   | Input          | Expected Result     |
+| ------- | ----------------- | --------------- | -------------- | ------------------- |
+| C-12    | Delete valid item | Item exists     | Valid itemId   | 200                 |
+| C-13    | Item not found    | Item missing    | Invalid itemId | 404                 |
+| C-14    | Multiple vendors  | Item duplicated | Valid itemId   | First match deleted |
+| C-15    | DB failure        | DB unavailable  | Valid itemId   | 500                 |
+
+---
+
+## 7. Bulk Inventory Operations Tests
+
+### 7.1 Bulk Add
+
+**POST `/vendor/:vendorId/inventory/bulk`**
+
+| Test ID | Scenario           | Preconditions  | Input         | Expected Result |
+| ------- | ------------------ | -------------- | ------------- | --------------- |
+| B-01    | Add multiple items | Vendor exists  | Valid items[] | 200             |
+| B-02    | Empty items array  | —              | `items: []`   | 400             |
+| B-03    | Invalid items type | —              | `items: {}`   | 400             |
+| B-04    | Vendor not found   | Vendor missing | Valid items   | 404             |
+| B-05    | DB failure         | DB unavailable | Valid items   | 500             |
+
+---
+
+### 7.2 Bulk Update
+
+**PUT `/inventory/:vendorId/bulk`**
+
+| Test ID | Scenario          | Preconditions    | Input          | Expected Result      |
+| ------- | ----------------- | ---------------- | -------------- | -------------------- |
+| B-06    | All items updated | Items exist      | Valid updates  | 200                  |
+| B-07    | Partial match     | Some items exist | Mixed item_ids | 200, partial success |
+| B-08    | No items array    | —                | `{}`           | 400                  |
+| B-09    | Empty array       | —                | `[]`           | 400                  |
+| B-10    | Vendor not found  | Vendor absent    | Valid array    | 404                  |
+| B-11    | Invalid fields    | Item exists      | `{ foo }`      | Field added          |
+| B-12    | DB failure        | DB unavailable   | Valid array    | 500                  |
+
+---
+
+### 7.3 Bulk Delete
+
+**DELETE `/inventory`**
+
+| Test ID | Scenario              | Preconditions    | Input           | Expected Result |
+| ------- | --------------------- | ---------------- | --------------- | --------------- |
+| B-13    | Delete multiple items | Items exist      | Valid itemIds[] | 200             |
+| B-14    | Partial delete        | Some items exist | Mixed itemIds   | 200             |
+| B-15    | Empty array           | —                | `itemIds: []`   | 400             |
+| B-16    | Invalid type          | —                | `itemIds: {}`   | 400             |
+| B-17    | DB failure            | DB unavailable   | Valid itemIds   | 500             |
+
+---
+
+## 8. Non-Functional Test Matrix
+
+### Performance
+
+| Test ID | Scenario                 | Metric        | Expected |
+| ------- | ------------------------ | ------------- | -------- |
+| N-01    | Inventory lookup         | Response time | < 500ms  |
+| N-02    | Search with many vendors | Response time | < 500ms  |
+| N-03    | Bulk update (100 items)  | Completion    | < 2s     |
+
+---
+
+### Scalability & Integrity
+
+| Test ID | Scenario             | Expected Result          |
+| ------- | -------------------- | ------------------------ |
+| N-04    | Concurrent updates   | No document corruption   |
+| N-05    | Partial bulk failure | Successful items persist |
+| N-06    | Large inventory      | No DB write errors       |
+
+---
+
+## 9. Known Risk Areas for QA
+
+| Risk                      | Why It Matters                     |
+| ------------------------- | ---------------------------------- |
+| No uniqueness enforcement | Duplicate item IDs possible        |
+| Regex search              | Performance degradation            |
+| Embedded inventory        | MongoDB document size limits       |
+| No auth                   | Cross-vendor modification possible |
+
+---
+
+## 10. QA Execution Guide
+
+| Role         | Focus Areas                    |
+| ------------ | ------------------------------ |
+| Manual QA    | Search, proximity, error flows |
+| Automation   | CRUD, bulk ops, regression     |
+| Load Testing | Search & bulk updates          |
+

package/docs/SRS.md

@@ -0,0 +1,311 @@
+# Software Requirements Specification (SRS)
+
+## Proximity Inventory Backend Service
+
+### **Inventory Domain Only**
+
+---
+
+## 1. Introduction
+
+### 1.1 Purpose
+
+This document specifies the functional and non-functional requirements for the **Inventory domain** of the Proximity Inventory Backend Service.
+
+The Inventory module enables:
+
+* Vendor-linked inventory storage
+* Proximity-based inventory discovery
+* Text-based inventory search
+* Single and bulk inventory management operations
+
+---
+
+### 1.2 Intended Audience
+
+| Audience                    | Usage                                    |
+| --------------------------- | ---------------------------------------- |
+| Product & Business          | Understand inventory capabilities        |
+| Backend Engineers           | Implement & maintain inventory APIs      |
+| Frontend / Mobile Engineers | Integrate inventory views & flows        |
+| QA / Test Engineers         | Validate inventory behavior & edge cases |
+
+---
+
+### 1.3 Scope
+
+| In Scope                            | Out of Scope                   |
+| ----------------------------------- | ------------------------------ |
+| Inventory CRUD (single & bulk)      | Payments & orders              |
+| Inventory search                    | Analytics & reporting          |
+| Proximity-based inventory discovery | Device scan collection         |
+| Vendor-scoped inventory retrieval   | Authentication & authorization |
+
+---
+
+### 1.4 Definitions
+
+| Term           | Description                                           |
+| -------------- | ----------------------------------------------------- |
+| Inventory Item | A product or service offered by a vendor              |
+| Vendor         | A business entity owning inventory                    |
+| Proximity      | Physical closeness inferred from detected Wi-Fi SSIDs |
+| Bulk Operation | An API request affecting multiple inventory items     |
+
+---
+
+## 2. System Overview
+
+### 2.1 Inventory Architecture Context
+
+| Component           | Responsibility                           |
+| ------------------- | ---------------------------------------- |
+| Client (Web/Mobile) | Requests inventory data                  |
+| Inventory API       | Inventory CRUD, search, proximity logic  |
+| MongoDB             | Vendor documents with embedded inventory |
+| DeviceScan Service  | Supplies proximity data (read-only)      |
+
+---
+
+### 2.2 Inventory Business Flow (Proximity)
+
+| Step | Description                           |
+| ---- | ------------------------------------- |
+| 1    | Device performs Wi-Fi scan            |
+| 2    | Latest scan stored in `DeviceScan`    |
+| 3    | Client requests `/inventory`          |
+| 4    | Device identity resolved from headers |
+| 5    | SSIDs matched against vendor SSIDs    |
+| 6    | Vendors with inventories returned     |
+
+---
+
+## 3. Inventory Data Model Requirements
+
+### 3.1 Inventory Item Schema (Embedded)
+
+| Field              | Type     | Required | Description                 |
+| ------------------ | -------- | -------- | --------------------------- |
+| item_id            | string   | Yes      | Unique inventory identifier |
+| name               | string   | Yes      | Item display name           |
+| category           | string   | No       | Item category               |
+| tags               | string[] | No       | Searchable keywords         |
+| price              | number   | No       | Item price                  |
+| quantity_available | number   | No       | Available stock count       |
+
+---
+
+### 3.2 Inventory Storage Model
+
+| Aspect          | Design Choice                     |
+| --------------- | --------------------------------- |
+| Storage         | Embedded inside Vendor document   |
+| Cardinality     | One vendor → many inventory items |
+| Lookup method   | Positional `$` operator           |
+| Deletion method | `$pull` on inventory array        |
+
+---
+
+## 4. Proximity Resolution (Inventory Context)
+
+### 4.1 Device Identification Priority
+
+| Priority | Source                |
+| -------- | --------------------- |
+| 1        | `x-device-sig` header |
+| 2        | `public_ip` header    |
+| 3        | `x-ws-token` header   |
+| 4        | Socket remote address |
+
+---
+
+### 4.2 Inventory Proximity Matching Rule
+
+| Rule               | Description                            |
+| ------------------ | -------------------------------------- |
+| Matching condition | Vendor SSID ∩ detected Wi-Fi SSIDs ≠ ∅ |
+| Data source        | Latest `DeviceScan` per device         |
+| Result             | Vendor inventory considered nearby     |
+
+---
+
+## 5. Functional Requirements (Inventory APIs)
+
+---
+
+### 5.1 Proximity Inventory Discovery
+
+| Attribute | Value                              |
+| --------- | ---------------------------------- |
+| Endpoint  | `GET /inventory`                   |
+| Purpose   | Retrieve nearby vendor inventories |
+| Input     | Device-identifying headers         |
+| Output    | List of vendor objects             |
+
+**Responses**
+
+| Code | Condition                    |
+| ---- | ---------------------------- |
+| 200  | Vendors with inventory found |
+| 404  | No proximity data available  |
+| 500  | Internal server error        |
+
+---
+
+### 5.2 Inventory Item Lookup
+
+| Attribute | Value                     |
+| --------- | ------------------------- |
+| Endpoint  | `GET /inventory/:itemId`  |
+| Purpose   | Retrieve item with vendor |
+| Input     | `itemId`                  |
+| Output    | Vendor info + item        |
+
+---
+
+### 5.3 Inventory Search
+
+| Attribute    | Value                     |
+| ------------ | ------------------------- |
+| Endpoint     | `GET /search`             |
+| Query Param  | `query`                   |
+| Search Scope | Vendor + inventory fields |
+| Matching     | Case-insensitive regex    |
+
+**Searchable Fields**
+
+| Entity    | Fields               |
+| --------- | -------------------- |
+| Vendor    | name, address        |
+| Inventory | name, category, tags |
+
+---
+
+### 5.4 Inventory Retrieval by Vendor
+
+| Attribute | Value                             |
+| --------- | --------------------------------- |
+| Endpoint  | `GET /vendor/:vendorId/inventory` |
+| Purpose   | Retrieve inventory for a vendor   |
+| Output    | Inventory array only              |
+
+---
+
+## 6. Inventory Management Operations
+
+---
+
+### 6.1 Single Inventory Item Operations
+
+| Action | Method | Endpoint                      |
+| -----: | ------ | ----------------------------- |
+|    Add | POST   | `/vendor/:vendorId/inventory` |
+| Update | PUT    | `/inventory/:itemId`          |
+| Delete | DELETE | `/inventory/:itemId`          |
+
+**Update Rules**
+
+| Rule           | Description                       |
+| -------------- | --------------------------------- |
+| Partial update | Only supplied fields updated      |
+| Targeting      | First matched `inventory.item_id` |
+
+---
+
+### 6.2 Bulk Inventory Operations
+
+| Action      | Method | Endpoint                           |
+| ----------- | ------ | ---------------------------------- |
+| Bulk add    | POST   | `/vendor/:vendorId/inventory/bulk` |
+| Bulk update | PUT    | `/inventory/:vendorId/bulk`        |
+| Bulk delete | DELETE | `/inventory`                       |
+
+**Bulk Behavior Guarantees**
+
+| Guarantee       | Description                          |
+| --------------- | ------------------------------------ |
+| Execution       | Best-effort                          |
+| Partial success | Allowed                              |
+| Isolation       | Per-item atomic updates              |
+| Feedback        | Per-item match & modification counts |
+
+---
+
+## 7. Error Handling
+
+| HTTP Code | Meaning                     |
+| --------- | --------------------------- |
+| 400       | Invalid input               |
+| 404       | Inventory or vendor missing |
+| 500       | Internal server error       |
+
+---
+
+## 8. Non-Functional Requirements
+
+### 8.1 Performance
+
+| Metric           | Requirement |
+| ---------------- | ----------- |
+| Typical response | < 500 ms    |
+| Bulk update size | ≥ 100 items |
+
+---
+
+### 8.2 Scalability
+
+| Aspect           | Requirement                                          |
+| ---------------- | ---------------------------------------------------- |
+| API              | Stateless                                            |
+| Scaling          | Horizontal                                           |
+| Required Indexes | `inventory.item_id`, `vendor_info.vendor_id`, `ssid` |
+
+---
+
+### 8.3 Reliability & Data Integrity
+
+| Requirement | Description                                 |
+| ----------- | ------------------------------------------- |
+| Atomicity   | Per-item inventory update                   |
+| Consistency | Inventory updates do not overwrite siblings |
+
+---
+
+### 8.4 Security Assumptions
+
+| Area           | Assumption                          |
+| -------------- | ----------------------------------- |
+| Authentication | Handled upstream                    |
+| Authorization  | Vendor ownership validated upstream |
+| Validation     | Required for all inventory inputs   |
+
+---
+
+## 9. Known Limitations
+
+| Limitation         | Impact                    |
+| ------------------ | ------------------------- |
+| Embedded inventory | Document size growth risk |
+| Regex search       | Not index-optimized       |
+| No pagination      | Large payload responses   |
+| No inventory locks | Concurrent edits possible |
+
+---
+
+## 10. Future Enhancements
+
+| Feature              | Description                    |
+| -------------------- | ------------------------------ |
+| Pagination           | Inventory & search results     |
+| Soft deletes         | Inventory lifecycle management |
+| Stock thresholds     | Low-stock alerts               |
+| Inventory versioning | Audit & rollback support       |
+
+---
+
+## 11. Reading Guide
+
+| Role              | Sections  |
+| ----------------- | --------- |
+| Stakeholders      | 1–4, 8–10 |
+| Backend Engineers | 3–10      |

package/docs/openapi.yaml

@@ -0,0 +1,344 @@
+openapi: 3.0.3
+info:
+  title: Proximity Inventory Backend API
+  description: |
+    Inventory domain APIs for the Proximity platform.
+    Supports proximity-based discovery, inventory search,
+    and single/bulk inventory management.
+  version: 1.0.0
+
+servers:
+  - url: https://www.proximityapp.ai
+    description: Production
+  - url: http://localhost:5000
+    description: Local development
+
+tags:
+  - name: Inventory
+    description: Inventory discovery and management
+  - name: Search
+    description: Text-based inventory search
+  - name: Proximity
+    description: Proximity-based inventory discovery
+
+paths:
+
+  /inventory:
+    get:
+      tags: [Proximity, Inventory]
+      summary: Get nearby vendor inventories
+      description: |
+        Returns vendors whose SSIDs match the latest
+        DeviceScan associated with the requesting device.
+      parameters:
+        - name: x-device-sig
+          in: header
+          schema: { type: string }
+        - name: public_ip
+          in: header
+          schema: { type: string }
+        - name: x-ws-token
+          in: header
+          schema: { type: string }
+      responses:
+        "200":
+          description: Vendors found
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "#/components/schemas/Vendor"
+        "404":
+          description: No proximity data found
+        "500":
+          description: Internal server error
+
+    delete:
+      tags: [Inventory]
+      summary: Bulk delete inventory items
+      description: Deletes multiple inventory items across vendors.
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required: [itemIds]
+              properties:
+                itemIds:
+                  type: array
+                  items:
+                    type: string
+      responses:
+        "200":
+          description: Inventory items deleted
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  deletedCount:
+                    type: number
+        "400":
+          description: Invalid request
+        "500":
+          description: Internal server error
+
+  /inventory/{itemId}:
+    get:
+      tags: [Inventory]
+      summary: Get inventory item by ID
+      parameters:
+        - name: itemId
+          in: path
+          required: true
+          schema: { type: string }
+      responses:
+        "200":
+          description: Inventory item found
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  vendor:
+                    $ref: "#/components/schemas/VendorInfo"
+                  item:
+                    $ref: "#/components/schemas/InventoryItem"
+        "404":
+          description: Inventory item not found
+        "500":
+          description: Internal server error
+
+    put:
+      tags: [Inventory]
+      summary: Update inventory item
+      parameters:
+        - name: itemId
+          in: path
+          required: true
+          schema: { type: string }
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/InventoryItemUpdate"
+      responses:
+        "200":
+          description: Inventory item updated
+        "404":
+          description: Inventory item not found
+        "500":
+          description: Internal server error
+
+    delete:
+      tags: [Inventory]
+      summary: Delete inventory item
+      parameters:
+        - name: itemId
+          in: path
+          required: true
+          schema: { type: string }
+      responses:
+        "200":
+          description: Inventory item deleted
+        "404":
+          description: Inventory item not found
+        "500":
+          description: Internal server error
+
+  /inventory/{vendorId}/bulk:
+    put:
+      tags: [Inventory]
+      summary: Bulk update inventory items for a vendor
+      parameters:
+        - name: vendorId
+          in: path
+          required: true
+          schema: { type: string }
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: array
+              items:
+                allOf:
+                  - $ref: "#/components/schemas/InventoryItemUpdate"
+                  - type: object
+                    required: [item_id]
+                    properties:
+                      item_id:
+                        type: string
+      responses:
+        "200":
+          description: Bulk update completed
+        "400":
+          description: Invalid request
+        "404":
+          description: Vendor not found
+        "500":
+          description: Internal server error
+
+  /vendor/{vendorId}/inventory:
+    get:
+      tags: [Inventory]
+      summary: Get inventory for a vendor
+      parameters:
+        - name: vendorId
+          in: path
+          required: true
+          schema: { type: string }
+      responses:
+        "200":
+          description: Inventory list
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: "#/components/schemas/InventoryItem"
+        "404":
+          description: Vendor not found
+        "500":
+          description: Internal server error
+
+    post:
+      tags: [Inventory]
+      summary: Add inventory item to vendor
+      parameters:
+        - name: vendorId
+          in: path
+          required: true
+          schema: { type: string }
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/InventoryItem"
+      responses:
+        "200":
+          description: Inventory item added
+        "404":
+          description: Vendor not found
+        "500":
+          description: Internal server error
+
+  /vendor/{vendorId}/inventory/bulk:
+    post:
+      tags: [Inventory]
+      summary: Bulk add inventory items to vendor
+      parameters:
+        - name: vendorId
+          in: path
+          required: true
+          schema: { type: string }
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              type: object
+              required: [items]
+              properties:
+                items:
+                  type: array
+                  items:
+                    $ref: "#/components/schemas/InventoryItem"
+      responses:
+        "200":
+          description: Inventory items added
+        "400":
+          description: Invalid request
+        "404":
+          description: Vendor not found
+        "500":
+          description: Internal server error
+
+  /search:
+    get:
+      tags: [Search]
+      summary: Search vendors and inventory
+      parameters:
+        - name: query
+          in: query
+          required: true
+          schema: { type: string }
+      responses:
+        "200":
+          description: Search results
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  query:
+                    type: string
+                  results:
+                    type: array
+                    items:
+                      type: object
+                      properties:
+                        vendor_id:
+                          type: string
+                        vendor_name:
+                          type: string
+                        address:
+                          type: string
+                        inventory:
+                          type: array
+                          items:
+                            $ref: "#/components/schemas/InventoryItem"
+        "400":
+          description: Query missing
+        "500":
+          description: Internal server error
+
+components:
+  schemas:
+
+    Vendor:
+      type: object
+      properties:
+        vendor_info:
+          $ref: "#/components/schemas/VendorInfo"
+        inventory:
+          type: array
+          items:
+            $ref: "#/components/schemas/InventoryItem"
+
+    VendorInfo:
+      type: object
+      properties:
+        vendor_id:
+          type: string
+        name:
+          type: string
+        address:
+          type: string
+
+    InventoryItem:
+      type: object
+      required: [item_id, name]
+      properties:
+        item_id:
+          type: string
+        name:
+          type: string
+        category:
+          type: string
+        tags:
+          type: array
+          items:
+            type: string
+        price:
+          type: number
+        quantity_available:
+          type: number
+
+    InventoryItemUpdate:
+      type: object
+      additionalProperties: true

package/package.json

@@ -1,10 +1,14 @@
 {
   "name": "@shyntech-proximity/inventories",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "main": "index.js",
   "files": [
     "dist",
-    "src"
+    "src",
+    "index.js",
+    "models/",
+    "docs/",
+    "README.md"
   ],
   "scripts": {
     "build": "echo 'no build'",