@rivascva/dt-idl 1.1.44 → 1.1.45

package/README.md

@@ -69,3 +69,20 @@ npm install
 ### Deployments
 
 Any merge to `main` with changes to the `ts/*` and `go/*` directory will trigger an automatic deployment to `npm`
+
+### Go Package
+
+To import the Go packages in other repositories, you must follow the steps below to allow importing from a private repository.
+
+#### 1. Add an ssh override in your `~/.gitconfig`
+
+```bash
+[url "git@github.com:"]
+  insteadOf = https://github.com/
+```
+
+#### 2. Add the following export within your `~/.zshrc`
+
+```bash
+export GOPRIVATE=github.com/RivasCVA/*
+```

package/go/utils/logger/logger.go

@@ -6,7 +6,7 @@ import (
 	"os"
 )
 
-type loggerInterface interface {
+type LoggerInterface interface {
 	// Prints an info log message.
 	Info(v ...any)
 	// Prints a warning log message.
@@ -17,7 +17,7 @@ type loggerInterface interface {
 	Fatal(v ...any)
 }
 
-type logger struct {
+type Logger struct {
 	prefix string
 	info   *log.Logger
 	warn   *log.Logger
@@ -28,13 +28,13 @@ type logger struct {
 var Log = New()
 
 // Creates a new logger.
-func New() loggerInterface {
+func New() LoggerInterface {
 	return NewWithPrefix("")
 }
 
 // Creates a new logger with a custom prefix.
-func NewWithPrefix(prefix string) loggerInterface {
-	return &logger{
+func NewWithPrefix(prefix string) LoggerInterface {
+	return &Logger{
 		prefix: prefix,
 		info:   log.New(os.Stdout, "[INFO] ", log.LstdFlags),
 		warn:   log.New(os.Stdout, "[WARN] ", log.LstdFlags),
@@ -42,18 +42,18 @@ func NewWithPrefix(prefix string) loggerInterface {
 	}
 }
 
-func (l *logger) Info(v ...any) {
+func (l *Logger) Info(v ...any) {
 	l.info.Println(l.prefix, fmt.Sprint(v...))
 }
 
-func (l *logger) Warn(v ...any) {
+func (l *Logger) Warn(v ...any) {
 	l.warn.Println(l.prefix, fmt.Sprint(v...))
 }
 
-func (l *logger) Error(v ...any) {
+func (l *Logger) Error(v ...any) {
 	l.error.Println(l.prefix, fmt.Sprint(v...))
 }
 
-func (l *logger) Fatal(v ...any) {
+func (l *Logger) Fatal(v ...any) {
 	l.error.Fatal(l.prefix, fmt.Sprint(v...))
 }

package/go/utils/response/models.go

@@ -0,0 +1,10 @@
+package response
+
+// Base error struct.
+//
+// The struct should match the base "Error" schema in all services.
+type Error[T any] struct {
+	Status  int64  `json:"status"`
+	Code    T      `json:"code"`
+	Message string `json:"message"`
+}

package/go/utils/response/response.go

@@ -0,0 +1,78 @@
+package response
+
+import (
+	"encoding/json"
+	"fmt"
+	"net/http"
+
+	"github.com/RivasCVA/dt-idl/go/utils/logger"
+)
+
+type ResponseInterface[T any] interface {
+	Write(w http.ResponseWriter, status int, data any)
+	WriteError(w http.ResponseWriter, status int, message string)
+	WriteErrorWithCode(w http.ResponseWriter, status int, code T, message string)
+}
+
+type Response[T any] struct {
+	log           logger.LoggerInterface
+	baseErrorCode T
+}
+
+func New[T any](log logger.LoggerInterface, baseErrorCode T) ResponseInterface[T] {
+	return &Response[T]{
+		log:           log,
+		baseErrorCode: baseErrorCode,
+	}
+}
+
+// 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 *Response[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.WriteError(w, http.StatusInternalServerError, "error encoding the data")
+		return
+	}
+
+	// write the data to the given writer
+	w.WriteHeader(status)
+	_, err = w.Write(out)
+	if err != nil {
+		r.log.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 *Response[T]) WriteError(w http.ResponseWriter, status int, message string) {
+	r.WriteErrorWithCode(w, status, r.baseErrorCode, 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 *Response[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]{
+		Status:  int64(status),
+		Code:    code,
+		Message: message,
+	})
+	if err != nil {
+		r.log.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))
+	}
+}

package/package.json

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