@rivascva/dt-idl 1.1.49 → 1.1.51

package/go/utils/responder/responder.go

@@ -9,31 +9,37 @@ import (
 )
 
 type Responder[T ~string] interface {
+	// Writes a JSON response to the given response writer.
+	//
+	// The given data is converted to JSON. An error response is written if the marshal fails.
 	Write(w http.ResponseWriter, status int, data any)
+	// Writes a JSON error response to the given response writer.
+	//
+	// The response is based on the shared "Error" schema.
 	WriteError(w http.ResponseWriter, status int, message string)
+	// Writes a JSON error response with a specific code to the given response writer.
+	//
+	// The response is based on the shared "Error" schema.
 	WriteErrorWithCode(w http.ResponseWriter, status int, code T, message string)
 }
 
 type StandardResponder[T ~string] struct {
-	log           logger.Logger
-	baseErrorCode T
+	logger      logger.Logger
+	defaultCode T
 }
 
-func NewStandardResponder[T ~string](log logger.Logger, baseErrorCode T) *StandardResponder[T] {
+func NewStandardResponder[T ~string](logger logger.Logger, defaultCode T) *StandardResponder[T] {
 	return &StandardResponder[T]{
-		log:           log,
-		baseErrorCode: baseErrorCode,
+		logger:      logger,
+		defaultCode: defaultCode,
 	}
 }
 
-// Writes a JSON response to the given response writer.
-//
-// The given data is converted to JSON. An error response is written if the marshal fails.
 func (r *StandardResponder[T]) Write(w http.ResponseWriter, status int, data any) {
 	// encode the given data object
 	out, err := json.Marshal(data)
 	if err != nil {
-		r.log.Error(fmt.Errorf("Write: failed to marshal the data: %w", err))
+		r.logger.Error(fmt.Errorf("Write: failed to marshal the data: %w", err))
 		r.WriteError(w, http.StatusInternalServerError, "error encoding the data")
 		return
 	}
@@ -42,22 +48,14 @@ func (r *StandardResponder[T]) Write(w http.ResponseWriter, status int, data any
 	w.WriteHeader(status)
 	_, err = w.Write(out)
 	if err != nil {
-		r.log.Fatal(fmt.Errorf("Write: failed to write a response: %w", err))
+		r.logger.Fatal(fmt.Errorf("Write: failed to write a response: %w", err))
 	}
 }
 
-// Writes a JSON error response to the given response writer.
-//
-// The response is based on the generated "api.Error" schema.
 func (r *StandardResponder[T]) WriteError(w http.ResponseWriter, status int, message string) {
-	r.WriteErrorWithCode(w, status, r.baseErrorCode, message)
+	r.WriteErrorWithCode(w, status, r.defaultCode, message)
 }
 
-// Writes a JSON error response with a specific code to the given response writer.
-//
-// The code is based on the generated "api.ErrorCode" enum.
-//
-// The response is based on the generated "api.Error" schema.
 func (r *StandardResponder[T]) WriteErrorWithCode(w http.ResponseWriter, status int, code T, message string) {
 	// encode an error object with the given message
 	out, err := json.Marshal(Error[T]{
@@ -66,13 +64,13 @@ func (r *StandardResponder[T]) WriteErrorWithCode(w http.ResponseWriter, status
 		Message: message,
 	})
 	if err != nil {
-		r.log.Fatal(fmt.Errorf("WriteErrorWithCode: failed to marshal the error: %w", err))
+		r.logger.Fatal(fmt.Errorf("WriteErrorWithCode: failed to marshal the error: %w", err))
 	}
 
 	// write the data to the given writer
 	w.WriteHeader(status)
 	_, err = w.Write(out)
 	if err != nil {
-		r.log.Fatal(fmt.Errorf("WriteErrorWithCode: failed to write a response: %w", err))
+		r.logger.Fatal(fmt.Errorf("WriteErrorWithCode: failed to write a response: %w", err))
 	}
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rivascva/dt-idl",
-  "version": "1.1.49",
+  "version": "1.1.51",
   "description": "Dream Trade - Interface Definition Language",
   "main": "dist/index.cjs.js",
   "module": "dist/index.esm.js",