redis-smq-web-ui 9.0.0-next.4 → 9.0.0-next.5

package/CHANGELOG.md

@@ -3,6 +3,35 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [9.0.0-next.5](https://github.com/weyoss/redis-smq/compare/v9.0.0-next.4...v9.0.0-next.5) (2025-10-12)
+
+### ✨ Features
+
+- **redis-smq-web-ui:** improve mobile experience ([1230bfe](https://github.com/weyoss/redis-smq/commit/1230bfee88f2d6ed2dea4c56bd4b7e4c7dd216df))
+- **redis-smq-web-ui:** notify about disabled message storage for ack/dl messages ([b3ecc52](https://github.com/weyoss/redis-smq/commit/b3ecc527548c770c37829cc69f716c27b8df5f14))
+
+### 🐛 Bug Fixes
+
+- **redis-smq-web-ui:** fix sudden CreateExchangeModal closure ([b6b2b0e](https://github.com/weyoss/redis-smq/commit/b6b2b0edb6d4d1c4fc022d2cbaf2f21101a61c4a))
+
+### 🚀 Chore
+
+- **redis-smq-web-ui:** update dependencies to latest versions ([f48c578](https://github.com/weyoss/redis-smq/commit/f48c578eaf84b04bdb700d808b5acc60396fc9e5))
+
+### 📝 Documentation
+
+- add GitHub note callouts in README files ([86e855a](https://github.com/weyoss/redis-smq/commit/86e855ae7aea91e3295301671b8da3249164ea40))
+- **redis-smq-web-ui:** fix license statement ([0e37a16](https://github.com/weyoss/redis-smq/commit/0e37a16143bc458de9b33e78e2be9f1757897f33))
+- **redis-smq-web-ui:** improve README clarity and structure ([d85bffe](https://github.com/weyoss/redis-smq/commit/d85bffede56fcc17651af1ac7d0fb0a03cb331ce))
+- standardize "next" branch reference ([15f3e4f](https://github.com/weyoss/redis-smq/commit/15f3e4f4347fd4f76f9dc167dd72f174f178ab8e))
+- update README files for next branch with pre-release badges and doc links ([463250b](https://github.com/weyoss/redis-smq/commit/463250bbd754d44ae6741abcf4e2d62995aef620))
+
+### ♻️ Code Refactoring
+
+- **redis-smq-web-ui:** migrate scripts utils to use RedisSMQ class ([30797f8](https://github.com/weyoss/redis-smq/commit/30797f855272f5c2f3456224c0a91a2301d2eb39))
+- **redis-smq-web-ui:** remove unused CreateFanoutExchangeModal ([79f3fda](https://github.com/weyoss/redis-smq/commit/79f3fdae50c2f1cc21592e7a8759daf98be09fe8))
+- **redis-smq-web-ui:** reorder navigation menu items ([235e81c](https://github.com/weyoss/redis-smq/commit/235e81c98a4df75b229b89227e06c2d7aaded068))
+
 ## [9.0.0-next.4](https://github.com/weyoss/redis-smq/compare/v9.0.0-next.3...v9.0.0-next.4) (2025-10-09)
 
 ### ✨ Features

package/README.md

@@ -1,120 +1,122 @@
 # RedisSMQ Web UI
 
+> [!NOTE]
+> You are viewing the documentation for the "next" branch. These docs describe unreleased changes published under the npm "next" dist-tag.  
+> For the latest stable documentation, see:
+>
+> - Master (stable) README: https://github.com/weyoss/redis-smq/tree/master/packages/redis-smq-web-ui
+> - Latest release notes/tags: https://github.com/weyoss/redis-smq/releases/latest
+> - Install stable packages with @latest; pre-release with @next.
+
 ![RedisSMQ Web UI - Pending Messages](docs/screenshots/img01.png)
 
-A Single Page Application for monitoring and managing RedisSMQ: inspect queues, messages, consumers, and more — with an integrated OpenAPI client.
+A Single Page Application for monitoring and managing RedisSMQ. Inspect queues and messages, review consumers, and perform common actions — with an integrated, type-safe OpenAPI client.
 
 - Works seamlessly with the RedisSMQ REST API
-- Best served via the RedisSMQ Web Server (serves static UI and hosts or proxies the API)
-- Ships with developer-friendly tooling, types, and test setup
+- Best served via the RedisSMQ Web Server (serves the static UI and hosts or proxies the API)
+- Ships with developer-friendly types and OpenAPI client generation
 
 ## Features
 
-- Dashboard to overview queues, consumers, and message stats
+- Dashboard for queues, consumers, and message stats
 - Queue/message browsers with filters and actions (ack, retry, delete, etc.)
-- Support for FIFO/LIFO/Priority Queues and multiple delivery models
-- Integrated documentation via Swagger UI (when served with the REST API)
-- Type-safe OpenAPI client (generated)
+- Supports multiple queue and delivery models
+- Exchange types: Direct, Topic, Fanout
+- Type-safe OpenAPI client (generated from the REST API schema)
+- History-fallback friendly routing (works correctly under a sub-path when configured)
 
 ## Version compatibility
 
-Always install matching versions of RedisSMQ packages. See the root docs for Version Compatibility. Use the same major/minor across:
-
-- redis-smq
-- redis-smq-common
-- redis-smq-rest-api
-- redis-smq-web-server
-- redis-smq-web-ui
-
-## Getting started
-
-### Recommended: run via the Web Server
-
-Use redis-smq-web-server to host the UI and API in one place, or proxy the API to an external service.
-
-- In-process API:
-  - UI at http://localhost:8080/
-  - API at http://localhost:8080/api
-- Proxy to an external REST API:
-  - UI is still served locally
-  - API/docs/assets are forwarded to the upstream API
-
-See [RedisSMQ Web Server](../redis-smq-web-server/README.md) for CLI options such as:
+Always install matching versions of RedisSMQ packages (same major/minor) to avoid runtime/API mismatches. See
+[version-compatibility.md](/packages/redis-smq/docs/version-compatibility.md).
 
-- --port
-- --base-path
-- --api-proxy-target
+## Requirements
 
-### Development
+See [requirements of RedisSMQ](/README.md).
 
-Prerequisites:
+## Installation
 
-- Node.js >= 20
-- PNPM (recommended)
-
-From the monorepo root:
+Typically consumed via the [RedisSMQ Web Server](/packages/redis-smq-web-server/README.md). To set up everything with pre-release builds:
 
 ```bash
-pnpm install
-pnpm -F redis-smq-web-ui dev
+npm install redis-smq@next redis-smq-common@next redis-smq-rest-api@next redis-smq-web-ui@next redis-smq-web-server@next
+# Choose a Redis client:
+npm install ioredis
+# or
+npm install @redis/client
 ```
 
-#### OpenAPI client generation
-
-The UI uses a generated OpenAPI client. To regenerate:
+## Quick start
 
-```shell
-pnpm -F redis-smq-web-ui generate-openapi-client
-```
+Use the [RedisSMQ Web Server](/packages/redis-smq-web-server/README.md) to serve the UI and either mount the REST API in-process or proxy to an external instance.
 
-Make sure redis-smq-rest-api (with OpenAPI endpoint) is reachable as configured by the generation script.
+- In-process API (default):
+  - UI at http://localhost:8080/
+  - API at http://localhost:8080/api
+- Proxy to an external REST API:
+  - UI is served locally
+  - API/docs/assets are forwarded to the upstream API
 
-#### Running the dev Server
+Examples:
 
 ```bash
-pnpm -F redis-smq-web-ui dev
-```
-
-The dev script typically runs:
+# Default (UI at /, API at /api)
+npx redis-smq-web-server
 
-- Vite dev server for the UI
-- A local REST API dev server for convenience
+# Serve under a sub-path (e.g., behind a reverse proxy)
+npx redis-smq-web-server --base-path /redis-smq
 
-- Open the printed local URL to access the UI during development.
+# Proxy API/docs/assets to an external REST API
+npx redis-smq-web-server --api-proxy-target http://127.0.0.1:7210
+```
 
-#### Building
+See [RedisSMQ Web Server](/packages/redis-smq-web-server/README.md) for CLI options such as:
 
-From the monorepo root:
+- `--port`
+- `--base-path`
+- `--api-proxy-target`
+- Redis connection and logging options (used only when hosting the API in-process)
 
-```shell
-pnpm -F redis-smq-web-ui build
-```
+## Configuration and routing
 
-Artifacts are output to the package’s dist directory.
-Serve the built assets with [RedisSMQ Web Server](../redis-smq-web-server/README.md) for correct routing and API integration.
+- Base path
+  - When served by [RedisSMQ Web Server](/packages/redis-smq-web-server/README.md), basePath controls where the UI and local API/docs are mounted.
+  - Examples:
+    - basePath = / → UI at /, API at /api, Swagger UI at /docs
+    - basePath = /redis-smq → UI at /redis-smq, API at /redis-smq/api, Swagger UI at /redis-smq/docs
 
-#### Configuration and routing
+- API endpoint
+  - With an embedded API (no proxy): the server mounts the REST API alongside the UI under <basePath>/api.
+  - With a proxy target: the server forwards <basePath>/api, <basePath>/docs, and <basePath>/assets to the configured upstream URL.
 
-- Base path: When served by redis-smq-web-server, the basePath is handled by the server and the UI will work under either / or a sub-path (e.g., /redis-smq).
-- API endpoint: When using redis-smq-web-server, the UI automatically talks to the in-process API or the configured proxy target.
-- Swagger UI and static docs are available when the REST API is hosted or proxied alongside the UI.
+- Standalone/static hosting (advanced)
+  - If hosting the UI assets yourself:
+    - Serve the SPA with history fallback (so client-side routes work on refresh).
+    - Ensure the public base path matches where you host the app.
+    - Proxy API requests to the REST API under the same public base path (e.g., <basePath>/api).
+    - Expose <basePath>/docs and <basePath>/assets if you want Swagger UI and API schema accessible.
+  - Note: [RedisSMQ Web Server](/packages/redis-smq-web-server/README.md) already handles these concerns and is the simplest path.
 
-For standalone/static hosting, ensure your server:
+## Deploying behind a reverse proxy
 
-- Serves the built assets under the desired public base path
-- Proxies API requests to the REST API under the same base path (e.g., /api)
+- Set a public sub-path using the web server’s --base-path (e.g., /redis-smq).
+- Forward both the UI and API prefixes through your proxy:
+  - /redis-smq → web server
+- If proxying the API to an external service, combine with --api-proxy-target:
+  - Client → reverse proxy → web server (/redis-smq)
+  - Web server proxies /redis-smq/api, /redis-smq/docs, /redis-smq/assets → external API
 
 ## Related packages
 
 - [redis-smq](../redis-smq/README.md): Core message queue
 - [redis-smq-common](../redis-smq-common/README.md): Shared components/utilities
-- [redis-smq-rest-api](../redis-smq-rest-api/README.md): REST API with OpenAPI 3 schema and Swagger UI
+- [redis-smq-rest-api](../redis-smq-rest-api/README.md): REST API with OpenAPI v3 and Swagger UI
 - [redis-smq-web-server](../redis-smq-web-server/README.md): Static hosting + in-process or proxied API
 
 ## Contributing
 
-Contributions are welcome. Please see the repository’s CONTRIBUTING.md in the project root.
+Contributions are welcome. Please see the repository’s [CONTRIBUTING.md](/CONTRIBUTING.md) in the project root.
 
 ## License
 
-RedisSMQ Web UI is licensed under is released under the [MIT License](https://github.com/weyoss/redis-smq/blob/master/LICENSE).
+RedisSMQ Web UI is released under the [MIT License](/LICENSE).

package/dist/browser/assets/QueuesView-gKXkgwTk.js

@@ -0,0 +1 @@
+import{d as H,u as I,a as R,b as j,c as G,e as K,f as h,r as p,w,o as Y,g as z,h as f,i as S,j as E,k as y,l as J,P as O,m as t,n as g,C as U,D as W,p as i,q as n,s as _,t as m,F as X,v as Z,Q as ee,x as te,_ as ae}from"./index-C2KJn_-I.js";const se={key:0,class:"alert alert-warning alert-dismissible fade show mb-4",role:"alert"},ue={key:1,class:"alert alert-warning alert-dismissible fade show mb-4",role:"alert"},le={class:"queues-list-container"},ne={class:"queues-list-header"},re={class:"queues-count"},ie={class:"queues-list"},oe="Queues",ce="Manage all available message queues",de=H({__name:"QueuesView",setup(ve){const D=te(),s=I(),k=R(),{sortedQueues:c,isLoadingQueues:d,queuesError:C,refetchQueues:v}=j(),{createQueue:M,isCreatingQueue:Q,createQueueError:b,createQueueMutation:x}=G(async()=>{await v()}),{deleteQueue:$,isDeletingQueue:F,deleteQueueError:q,deleteQueueMutation:L}=K(async()=>{await v()}),N=h(()=>c.value.length>0),u=p(!1),l=p(!1),o=p(null),P=h(()=>[{id:"refresh-queues",label:"Refresh",icon:"bi bi-arrow-clockwise",variant:"secondary",disabled:d.value,loading:d.value,handler:()=>v()},{id:"create-queue",label:"Create Queue",icon:"bi bi-plus-circle",variant:"primary",disabled:Q.value,loading:Q.value,handler:()=>u.value=!0}]);function T(a,e){D.push({name:"Queue",params:{ns:a,queue:e}})}async function V(a){try{const e={queue:{ns:a.ns,name:a.name},queueType:a.type,queueDeliveryModel:a.deliveryModel};await M({data:e}),u.value=!1}catch(e){console.error("Failed to create queue:",e)}}function B(a,e){o.value={ns:a,name:e},l.value=!0}async function A(){if(o.value)try{await $(o.value),l.value=!1}catch(a){console.error("Failed to delete queue:",a)}}return w(()=>{s.setPageHeader({title:oe,subtitle:ce,icon:"bi bi-card-list"}),s.setPageActions(P.value),s.setLoadingState(d.value),C.value?(s.setErrorState(g(C.value)),s.setEmptyState(!1)):!d.value&&!N.value?(s.setErrorState(null),s.setEmptyState(!0,{icon:"bi bi-plus-square-dotted",title:"No Queues Found",message:"Get started by creating your first message queue.",actionLabel:"Create Your First Queue",actionHandler:()=>u.value=!0})):(s.setErrorState(null),s.setEmptyState(!1))}),w(()=>{k.clearSelectedQueue()}),Y(()=>{v()}),z([{isVisible:u,onEscape:()=>u.value=!1},{isVisible:l,onEscape:()=>l.value=!1}]),(a,e)=>(i(),f("div",null,[S(O,null,{default:J(()=>[t(b)&&!u.value?(i(),f("div",se,[e[4]||(e[4]=n("i",{class:"bi bi-exclamation-triangle-fill me-2"},null,-1)),_(" "+m(t(g)(t(b)))+" ",1),n("button",{type:"button",class:"btn-close","aria-label":"Close",onClick:e[0]||(e[0]=r=>t(x).reset())})])):y("",!0),t(q)&&!l.value?(i(),f("div",ue,[e[5]||(e[5]=n("i",{class:"bi bi-exclamation-triangle-fill me-2"},null,-1)),_(" "+m(t(g)(t(q)))+" ",1),n("button",{type:"button",class:"btn-close","aria-label":"Close",onClick:e[1]||(e[1]=r=>t(L).reset())})])):y("",!0),n("div",le,[n("div",ne,[n("h5",re,m(t(c).length)+" Queue"+m(t(c).length!==1?"s":""),1)]),n("div",ie,[(i(!0),f(X,null,Z(t(c),r=>(i(),E(ee,{key:`${r.ns}-${r.name}`,queue:r,onSelect:T,onDelete:B},null,8,["queue"]))),128))])])]),_:1}),S(U,{"is-visible":u.value,"is-creating":t(Q),"create-error":t(b)?`${t(g)(t(b))?.message}`:"",onClose:e[2]||(e[2]=r=>u.value=!1),onCreate:V},null,8,["is-visible","is-creating","create-error"]),l.value&&o.value?(i(),E(W,{key:0,"is-visible":l.value,"is-deleting":t(F),queue:o.value,onCancel:e[3]||(e[3]=r=>l.value=!1),onConfirm:A},null,8,["is-visible","is-deleting","queue"])):y("",!0)]))}}),fe=ae(de,[["__scopeId","data-v-f3ec936e"]]);export{fe as default};