u

src/automats/warehouseAutomat.js

@@ -1,3 +1,14 @@
+/**
+ * @file warehouseAutomat.js
+ * @description Manages cached warehouse locations (`GET /api/warehouse`) for the active company.
+ *
+ * Upstream Triggers:
+ * - `authAutomat`: Subscribes to auth state changes (`syncWithAuth`) — triggers
+ *   `actions.load()` on `'authed'` with a `selectedCompanyId`, and `actions.clear()` on `'anon'`.
+ * - `sseAutomat`: Calls `actions.reload()` upon receiving a `'warehouse'` SSE event.
+ * - UI / Routes: Calls to `actions.load()`, `actions.reload()`, or `actions.setWarehouses()`.
+ */
+
 import { Automat } from 'react-automat';
 import { warehouse as warehouseApi } from '../api';
 import { requireArray, requireDefined, requireObject } from '../utils/apiShape';