redis-smq-web-ui 9.0.0-next.0

package/CHANGELOG.md

@@ -0,0 +1,24 @@
+# Change Log
+
+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.0](https://github.com/weyoss/redis-smq/compare/v8.3.1...v9.0.0-next.0) (2025-09-06)
+
+### ✨ Features
+
+- **redis-smq-web-ui:** implement comprehensive Vue.js web interface for RedisSMQ management ([cee3212](https://github.com/weyoss/redis-smq/commit/cee3212119c10c3fb08109d27f1ad89e7e033110))
+
+### 🐛 Bug Fixes
+
+- **redis-smq-web-ui:** add OpenAPI client generation to build process ([c726ea6](https://github.com/weyoss/redis-smq/commit/c726ea64895cd51d1e899b0dcf8b9d3c280b9608))
+- **redis-smq-web-ui:** clean up old files before OpenAPI client generation ([65372c7](https://github.com/weyoss/redis-smq/commit/65372c725eab412d645dfb6c0589f0519773d70b))
+- **redis-smq-web-ui:** correct import path for messages API module ([dc913f6](https://github.com/weyoss/redis-smq/commit/dc913f689618358e45058891273670eba9d4cc61))
+- **redis-smq-web-ui:** correct license statement in README ([7dfed65](https://github.com/weyoss/redis-smq/commit/7dfed65b2249a6cebfdb949858297622abdbe294))
+- **redis-smq-web-ui:** improve modal warning text and fix z-index ([7dcefe1](https://github.com/weyoss/redis-smq/commit/7dcefe18fecbcb386c0be688b9f2d791faabf0eb))
+- **redis-smq-web-ui:** reduce app initialization delay and improve comments ([d250209](https://github.com/weyoss/redis-smq/commit/d25020943ce08d015be0e24d135fe77f9772c32f))
+- **redis-smq-web-ui:** standardize import file extensions to .ts ([65974b9](https://github.com/weyoss/redis-smq/commit/65974b9eb7031bba8e83ead4107a1f8b450cafa5))
+
+### 🚀 Chore
+
+- add .npmignore files to web packages for proper publishing ([2179c30](https://github.com/weyoss/redis-smq/commit/2179c30785e4c0f7ab7d1b102a91a966b70ccf24))

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) Weyoss <weyoss@protonmail.com>, https://github.com/weyoss
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,115 @@
+# RedisSMQ Web UI
+
+A Single Page Application for monitoring and managing RedisSMQ: inspect queues, messages, consumers, and more — with an integrated 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
+
+## Features
+
+- Dashboard to overview queues, consumers, and message stats
+- Queue/message browsers with filters and actions (ack, retry, delete, etc.)
+- Support for FIFO/LIFO and multiple delivery models
+- Integrated documentation via Swagger UI (when served with the REST API)
+- Type-safe OpenAPI client (generated)
+
+## 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:
+- --port
+- --base-path
+- --api-proxy-target
+
+### Development
+
+Prerequisites:
+- Node.js >= 20
+- PNPM (recommended)
+
+From the monorepo root:
+
+```bash
+pnpm install
+pnpm -w -C packages/redis-smq-web-ui dev
+```
+
+#### OpenAPI client generation
+
+The UI uses a generated OpenAPI client. To regenerate:
+
+```shell
+pnpm -w -C packages/redis-smq-web-ui generate-openapi-client
+```
+
+Make sure redis-smq-rest-api (with OpenAPI endpoint) is reachable as configured by the generation script.
+
+#### Running the dev Server
+
+```bash
+pnpm -w -C packages/redis-smq-web-ui dev
+```
+
+The dev script typically runs:
+
+- Vite dev server for the UI
+- A local REST API dev server for convenience
+
+- Open the printed local URL to access the UI during development.
+  
+#### Building
+  
+From the monorepo root:
+
+```shell
+pnpm -w -C packages/redis-smq-web-ui build
+```
+
+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.
+
+#### Configuration and routing
+
+- 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.
+
+For standalone/static hosting, ensure your server:
+
+- 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)
+
+## 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-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.
+
+## License
+
+RedisSMQ Web UI is licensed under is released under the [MIT License](https://github.com/weyoss/redis-smq/blob/master/LICENSE).

package/dist/browser/assets/QueuesView-BOytmHBz.css

@@ -0,0 +1 @@
+.queues-list-container[data-v-f3ec936e]{background:#fff;border-radius:12px;box-shadow:0 4px 6px #0000000d;border:1px solid #e9ecef;overflow:hidden}.queues-list-header[data-v-f3ec936e]{padding:1.5rem 2rem 1rem;border-bottom:1px solid #e9ecef;background:#f8f9fa}.queues-count[data-v-f3ec936e]{margin:0;color:#495057;font-weight:600;font-size:1rem}.queues-list[data-v-f3ec936e]{max-height:calc(100vh - 260px);overflow-y:auto}.queues-list[data-v-f3ec936e]::-webkit-scrollbar{width:6px}.queues-list[data-v-f3ec936e]::-webkit-scrollbar-track{background:#f8f9fa}.queues-list[data-v-f3ec936e]::-webkit-scrollbar-thumb{background:#ced4da;border-radius:3px}.queues-list[data-v-f3ec936e]::-webkit-scrollbar-thumb:hover{background:#adb5bd}@media (max-width: 768px){.queues-list-header[data-v-f3ec936e]{padding:1rem 1.5rem .75rem}.queues-list[data-v-f3ec936e]{max-height:calc(100vh - 220px)}}

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

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