Merge branch 'main' into parent-location-sync

.github/scripts/update_currencies.py

@@ -4,11 +4,8 @@
 
 def fetch_currencies():
     try:
-        response = requests.get('https://restcountries.com/v3.1/all')
+        response = requests.get('https://restcountries.com/v3.1/all?fields=name,common,currencies')
         response.raise_for_status()
-    except requests.exceptions.Timeout:
-        print("Request to the API timed out.")
-        return []
     except requests.exceptions.RequestException as e:
         print(f"An error occurred while making the request: {e}")
         return []
@@ -35,10 +32,12 @@ def fetch_currencies():
     return currencies_list
 
 def save_currencies(currencies, file_path):
+    # Sort the list by the "local" field
+    sorted_currencies = sorted(currencies, key=lambda x: x['local'].lower() if x['local'] else "")
     try:
         os.makedirs(os.path.dirname(file_path), exist_ok=True)
         with open(file_path, 'w', encoding='utf-8') as f:
-            json.dump(currencies, f, ensure_ascii=False, indent=4)
+            json.dump(sorted_currencies, f, ensure_ascii=False, indent=4)
     except IOError as e:
         print(f"An error occurred while writing to the file: {e}")
 
@@ -62,4 +61,4 @@ def main():
         print("Currencies updated and saved.")
 
 if __name__ == "__main__":
-    main()
+    main()

.github/workflows/partial-backend.yaml

@@ -34,3 +34,8 @@ jobs:
 
       - name: Test
         run: task go:coverage
+
+      - name: Validate OpenAPI definition
+        uses: swaggerexpert/swagger-editor-validate@v1
+        with:
+          definition-file: backend/app/api/static/docs/swagger.json

.gitignore

@@ -56,4 +56,5 @@ backend/app/api/static/public/*
 !backend/app/api/static/public/.gitkeep
 backend/api
 
-docs/.vitepress/cache/
+docs/.vitepress/cache/
+/.data/

CONTRIBUTING.md

@@ -44,7 +44,7 @@ start command `task go:run`
 
 ### Frontend Development Notes
 
-start command `task: ui:dev`
+start command `task ui:dev`
 
 1. The frontend is a Vue 3 app with Nuxt.js that uses Tailwind and DaisyUI for styling.
 2. We're using Vitest for our automated testing. You can run these with `task ui:watch`.
@@ -54,4 +54,4 @@ start command `task: ui:dev`
 
 Create a new tag in GitHub with the version number vX.X.X. This will trigger a new release to be created.
 
-Test -> Goreleaser -> Publish Release -> Trigger Docker Builds -> Deploy Docs + Fly.io Demo
+Test -> Goreleaser -> Publish Release -> Trigger Docker Builds -> Deploy Docs + Fly.io Demo

README.md

@@ -21,6 +21,10 @@ Homebox is the inventory and organization system built for the Home User! With a
 
 # Screenshots
 Check out screenshots of the project [here](https://imgur.com/a/5gLWt2j).
+You can also try the demo instances of Homebox:
+- [Demo](https://demo.homebox.software)
+- [Nightly](https://nightly.homebox.software)
+- [VNext](https://vnext.homebox.software/)
 
 ## Quick Start
 

Taskfile.yml

@@ -28,7 +28,6 @@ tasks:
       - "./backend/internal/data/**"
       - "./backend/internal/core/services/**/*"
       - "./backend/app/tools/typegen/main.go"
-
   typescript-types:
     desc: Generates typescript types from swagger definition
     cmds:
@@ -52,6 +51,8 @@ tasks:
       - cp ./backend/app/api/static/docs/swagger.json docs/docs/api/openapi-2.0.json
 
   go:run:
+    env:
+      HBOX_DEMO: true
     desc: Starts the backend api server (depends on generate task)
     dir: backend
     deps:

backend/app/api/handlers/v1/v1_ctrl_auth.go

@@ -28,8 +28,8 @@ type (
 	}
 
 	LoginForm struct {
-		Username     string `json:"username"`
-		Password     string `json:"password"`
+		Username     string `json:"username" example:"[email protected]"`
+		Password     string `json:"password" example:"admin"`
 		StayLoggedIn bool   `json:"stayLoggedIn"`
 	}
 )
@@ -79,17 +79,15 @@ type AuthProvider interface {
 
 // HandleAuthLogin godoc
 //
-//	@Summary	User Login
-//	@Tags		Authentication
-//	@Accept		x-www-form-urlencoded
-//	@Accept		application/json
-//	@Param		username	formData	string		false	"string"	example([email protected])
-//	@Param		password	formData	string		false	"string"	example(admin)
-//	@Param		payload		body		LoginForm	true	"Login Data"
-//	@Param		provider	query		string		false	"auth provider"
-//	@Produce	json
-//	@Success	200	{object}	TokenResponse
-//	@Router		/v1/users/login [POST]
+//	@Summary User Login
+//	@Tags    Authentication
+//	@Accept  x-www-form-urlencoded
+//	@Accept  application/json
+//	@Param   payload body     LoginForm true "Login Data"
+//	@Param   provider    query    string   false "auth provider"
+//	@Produce json
+//	@Success 200 {object} TokenResponse
+//	@Router  /v1/users/login [POST]
 func (ctrl *V1Controller) HandleAuthLogin(ps ...AuthProvider) errchain.HandlerFunc {
 	if len(ps) == 0 {
 		panic("no auth providers provided")

backend/app/api/handlers/v1/v1_ctrl_items.go

@@ -4,10 +4,12 @@ import (
 	"database/sql"
 	"encoding/csv"
 	"errors"
+	"fmt"
 	"math/big"
 	"net/http"
 	"net/url"
 	"strings"
+	"time"
 
 	"github.com/google/uuid"
 	"github.com/hay-kot/httpkit/errchain"
@@ -290,13 +292,14 @@ func (ctrl *V1Controller) HandleGetAllCustomFieldValues() errchain.HandlerFunc {
 
 // HandleItemsImport godocs
 //
-//	@Summary	Import Items
-//	@Tags		Items
-//	@Produce	json
-//	@Success	204
-//	@Param		csv	formData	file	true	"Image to upload"
-//	@Router		/v1/items/import [Post]
-//	@Security	Bearer
+//	@Summary  Import Items
+//	@Tags     Items
+//	@Accept   multipart/form-data
+//	@Produce  json
+//	@Success  204
+//	@Param    csv formData file true "Image to upload"
+//	@Router   /v1/items/import [Post]
+//	@Security Bearer
 func (ctrl *V1Controller) HandleItemsImport() errchain.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) error {
 		err := r.ParseMultipartForm(ctrl.maxUploadSize << 20)
@@ -340,8 +343,11 @@ func (ctrl *V1Controller) HandleItemsExport() errchain.HandlerFunc {
 			return validate.NewRequestError(err, http.StatusInternalServerError)
 		}
 
+		timestamp := time.Now().Format("2006-01-02_15-04-05")      // YYYY-MM-DD_HH-MM-SS format
+		filename := fmt.Sprintf("homebox-items_%s.csv", timestamp) // add timestamp to filename
+
 		w.Header().Set("Content-Type", "text/csv")
-		w.Header().Set("Content-Disposition", "attachment;filename=homebox-items.csv")
+		w.Header().Set("Content-Disposition", fmt.Sprintf("attachment;filename=%s", filename))
 
 		writer := csv.NewWriter(w)
 		writer.Comma = ','

backend/app/api/handlers/v1/v1_ctrl_items_attachments.go

@@ -23,17 +23,18 @@ type (
 
 // HandleItemAttachmentCreate godocs
 //
-//	@Summary	Create Item Attachment
-//	@Tags		Items Attachments
-//	@Produce	json
-//	@Param		id		path		string	true	"Item ID"
-//	@Param		file	formData	file	true	"File attachment"
-//	@Param		type	formData	string	true	"Type of file"
-//	@Param		name	formData	string	true	"name of the file including extension"
-//	@Success	200		{object}	repo.ItemOut
-//	@Failure	422		{object}	validate.ErrorResponse
-//	@Router		/v1/items/{id}/attachments [POST]
-//	@Security	Bearer
+//	@Summary  Create Item Attachment
+//	@Tags     Items Attachments
+//	@Accept   multipart/form-data
+//	@Produce  json
+//	@Param    id   path     string true "Item ID"
+//	@Param    file formData file   true "File attachment"
+//	@Param    type formData string true "Type of file"
+//	@Param    name formData string true "name of the file including extension"
+//	@Success  200  {object} repo.ItemOut
+//	@Failure  422  {object} validate.ErrorResponse
+//	@Router   /v1/items/{id}/attachments [POST]
+//	@Security Bearer
 func (ctrl *V1Controller) HandleItemAttachmentCreate() errchain.HandlerFunc {
 	return func(w http.ResponseWriter, r *http.Request) error {
 		err := r.ParseMultipartForm(ctrl.maxUploadSize << 20)

backend/app/api/handlers/v1/v1_ctrl_maint_entry.go

@@ -12,13 +12,14 @@ import (
 
 // HandleMaintenanceLogGet godoc
 //
-//	@Summary	Get Maintenance Log
-//	@Tags		Item Maintenance
-//	@Produce	json
-//	@Param		filters	query	repo.MaintenanceFilters	false	"which maintenance to retrieve"
-//	@Success	200		{array}	repo.MaintenanceEntryWithDetails[]
-//	@Router		/v1/items/{id}/maintenance [GET]
-//	@Security	Bearer
+//	@Summary  Get Maintenance Log
+//	@Tags     Item Maintenance
+//	@Produce  json
+//	@Param    id  path     string true "Item ID"
+//	@Param    filters query    repo.MaintenanceFilters     false "which maintenance to retrieve"
+//	@Success  200       {array} repo.MaintenanceEntryWithDetails[]
+//	@Router   /v1/items/{id}/maintenance [GET]
+//	@Security Bearer
 func (ctrl *V1Controller) HandleMaintenanceLogGet() errchain.HandlerFunc {
 	fn := func(r *http.Request, ID uuid.UUID, filters repo.MaintenanceFilters) ([]repo.MaintenanceEntryWithDetails, error) {
 		auth := services.NewContext(r.Context())
@@ -30,13 +31,14 @@ func (ctrl *V1Controller) HandleMaintenanceLogGet() errchain.HandlerFunc {
 
 // HandleMaintenanceEntryCreate godoc
 //
-//	@Summary	Create Maintenance Entry
-//	@Tags		Item Maintenance
-//	@Produce	json
-//	@Param		payload	body		repo.MaintenanceEntryCreate	true	"Entry Data"
-//	@Success	201		{object}	repo.MaintenanceEntry
-//	@Router		/v1/items/{id}/maintenance [POST]
-//	@Security	Bearer
+//	@Summary  Create Maintenance Entry
+//	@Tags     Item Maintenance
+//	@Produce  json
+//	@Param    id  path     string true "Item ID"
+//	@Param    payload body     repo.MaintenanceEntryCreate true "Entry Data"
+//	@Success  201     {object} repo.MaintenanceEntry
+//	@Router   /v1/items/{id}/maintenance [POST]
+//	@Security Bearer
 func (ctrl *V1Controller) HandleMaintenanceEntryCreate() errchain.HandlerFunc {
 	fn := func(r *http.Request, itemID uuid.UUID, body repo.MaintenanceEntryCreate) (repo.MaintenanceEntry, error) {
 		auth := services.NewContext(r.Context())

backend/app/api/handlers/v1/v1_ctrl_maintenance.go

@@ -30,13 +30,14 @@ func (ctrl *V1Controller) HandleMaintenanceGetAll() errchain.HandlerFunc {
 
 // HandleMaintenanceEntryUpdate godoc
 //
-//	@Summary	Update Maintenance Entry
-//	@Tags		Maintenance
-//	@Produce	json
-//	@Param		payload	body		repo.MaintenanceEntryUpdate	true	"Entry Data"
-//	@Success	200		{object}	repo.MaintenanceEntry
-//	@Router		/v1/maintenance/{id} [PUT]
-//	@Security	Bearer
+//	@Summary  Update Maintenance Entry
+//	@Tags     Maintenance
+//	@Produce  json
+//	@Param    id  path     string true "Maintenance ID"
+//	@Param    payload body     repo.MaintenanceEntryUpdate true "Entry Data"
+//	@Success  200     {object} repo.MaintenanceEntry
+//	@Router   /v1/maintenance/{id} [PUT]
+//	@Security Bearer
 func (ctrl *V1Controller) HandleMaintenanceEntryUpdate() errchain.HandlerFunc {
 	fn := func(r *http.Request, entryID uuid.UUID, body repo.MaintenanceEntryUpdate) (repo.MaintenanceEntry, error) {
 		auth := services.NewContext(r.Context())
@@ -48,12 +49,13 @@ func (ctrl *V1Controller) HandleMaintenanceEntryUpdate() errchain.HandlerFunc {
 
 // HandleMaintenanceEntryDelete godoc
 //
-//	@Summary	Delete Maintenance Entry
-//	@Tags		Maintenance
-//	@Produce	json
-//	@Success	204
-//	@Router		/v1/maintenance/{id} [DELETE]
-//	@Security	Bearer
+//	@Summary  Delete Maintenance Entry
+//	@Tags     Maintenance
+//	@Produce  json
+//	@Param    id  path     string true "Maintenance ID"
+//	@Success  204
+//	@Router   /v1/maintenance/{id} [DELETE]
+//	@Security Bearer
 func (ctrl *V1Controller) HandleMaintenanceEntryDelete() errchain.HandlerFunc {
 	fn := func(r *http.Request, entryID uuid.UUID) (any, error) {
 		auth := services.NewContext(r.Context())

backend/app/api/handlers/v1/v1_ctrl_notifiers.go

@@ -83,14 +83,13 @@ func (ctrl *V1Controller) HandleUpdateNotifier() errchain.HandlerFunc {
 
 // HandlerNotifierTest godoc
 //
-//	@Summary	Test Notifier
-//	@Tags		Notifiers
-//	@Produce	json
-//	@Param		id	path	string	true	"Notifier ID"
-//	@Param		url	query	string	true	"URL"
-//	@Success	204
-//	@Router		/v1/notifiers/test [POST]
-//	@Security	Bearer
+//	@Summary  Test Notifier
+//	@Tags     Notifiers
+//	@Produce  json
+//	@Param url query string true "URL"
+//	@Success  204
+//	@Router   /v1/notifiers/test [POST]
+//	@Security Bearer
 func (ctrl *V1Controller) HandlerNotifierTest() errchain.HandlerFunc {
 	type body struct {
 		URL string `json:"url" validate:"required"`