merge development into main

.github/workflows/sparrowproxy-selfhost.yml

@@ -0,0 +1,57 @@
+name: Self-host Docker Image
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    environment: self-host
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Read version from package.json
+        id: version
+        run: |
+          if ! command -v jq >/dev/null 2>&1; then
+            echo "jq not found"; exit 1
+          fi
+          V=$(jq -r '.version' package.json)
+          if [ -z "$V" ] || [ "$V" = "null" ]; then
+            echo "Version not found in package.json"; exit 1
+          fi
+          if ! [[ "$V" =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
+            echo "Version $V is not valid semver (expected X.Y.Z)"; exit 1
+          fi
+          echo "full=$V" >> "$GITHUB_OUTPUT"
+
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+
+      - name: Set up Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Log in to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_PASSWORD }}
+
+      - name: Build and push (multi-arch)
+        run: |
+          set -euo pipefail
+          VERSION='${{ steps.version.outputs.full }}'
+          echo "Building image tag: $VERSION" 
+          docker buildx build \
+            --platform linux/amd64,linux/arm64 \
+            -t $DOCKER_IMAGE_NAME:$VERSION \
+            -t sparrowapi/sparrow-proxy:latest \
+            --push .

package.json

@@ -1,6 +1,6 @@
 {
   "name": "sparrow-proxy",
-  "version": "0.0.1",
+  "version": "2.33.0",
   "description": "",
   "author": "",
   "private": true,
@@ -24,14 +24,20 @@
     "@nestjs/common": "^10.0.0",
     "@nestjs/core": "^10.0.0",
     "@nestjs/platform-express": "^10.0.0",
+    "@nestjs/platform-fastify": "^11.1.6",
     "@nestjs/platform-socket.io": "^10.4.8",
     "@nestjs/platform-ws": "^10.4.8",
     "@nestjs/swagger": "^8.0.7",
     "@nestjs/websockets": "^10.4.8",
     "@types/ws": "^8.5.13",
     "axios": "^1.7.7",
+    "class-transformer": "0.5.1",
+    "class-transformer-validator": "^0.9.1",
+    "class-validator": "^0.14.0",
+    "fastify": "4.28.1",
     "form-data": "^4.0.1",
     "ipaddr.js": "^2.2.0",
+    "json5": "^2.2.3",
     "reflect-metadata": "^0.2.0",
     "rxjs": "^7.8.1",
     "socket.io-client": "^4.8.1"

src/Types/http-client.ts

@@ -0,0 +1,12 @@
+export interface HttpClientResponseInterface<T> {
+  status: "success" | "error";
+  isSuccessful: boolean;
+  message: string;
+  data: T;
+}
+
+export interface HttpClientBackendResponseInterface<T> {
+  data: T;
+  message: string;
+  statusCode: number;
+}

src/enum/httpRequest.enum.ts

@@ -0,0 +1,33 @@
+export interface KeyWrapper {
+  key: string;
+}
+
+export interface ValueWrapper {
+  value: string;
+}
+
+export enum RequestDataTypeEnum {
+  JSON = "JSON",
+  XML = "XML",
+  HTML = "HTML",
+  TEXT = "Text",
+  JAVASCRIPT = "JavaScript",
+  IMAGE = "Image",
+}
+
+export enum ResponseStatusCode {
+  OK = "200 OK",
+  CREATED = "201 Created",
+  ACCEPTED = "202 Accepted",
+  NO_CONTENT = "204 No Content",
+  BAD_REQUEST = "400 Bad Request",
+  UNAUTHORIZED = "401 Unauthorized",
+  FORBIDDEN = "403 Forbidden",
+  NOT_FOUND = "404 Not Found",
+  METHOD_NOT_ALLOWED = "405 Method Not Allowed",
+  INTERNAL_SERVER_ERROR = "500 Internal Server Error",
+  SERVICE_UNAVAILABLE = "503 Service Unavailable",
+  ERROR = "Not Found",
+}
+
+export interface KeyValue extends KeyWrapper, ValueWrapper {}

src/enum/httpResponseFormat.ts

@@ -0,0 +1,25 @@
+import type { HttpClientResponseInterface } from "src/Types/http-client";
+
+export const success = <T>(data: T): HttpClientResponseInterface<T> => {
+  return {
+    status: "success",
+    isSuccessful: true,
+    message: "",
+    data,
+  };
+};
+
+export const error = <T>(
+  error: string,
+  data?: T,
+  tabId: string = "",
+): HttpClientResponseInterface<T> => {
+  return {
+    status: "error",
+    isSuccessful: false,
+    message: error,
+    data,
+  };
+};
+
+

src/enum/testflow.enum.ts

@@ -0,0 +1,59 @@
+export enum BodyModeEnum {
+  "none" = "none",
+  "application/json" = "application/json",
+  "application/xml" = "application/xml",
+  "application/yaml" = "application/yaml",
+  "application/x-www-form-urlencoded" = "application/x-www-form-urlencoded",
+  "multipart/form-data" = "multipart/form-data",
+  "application/javascript" = "application/javascript",
+  "text/plain" = "text/plain",
+  "text/html" = "text/html",
+}
+
+export enum AuthModeEnum {
+  "No Auth" = "No Auth",
+  "Inherit Auth" = "Inherit Auth",
+  "API Key" = "API Key",
+  "Bearer Token" = "Bearer Token",
+  "Basic Auth" = "Basic Auth",
+}
+
+
+export enum AddTo {
+  Header = "Header",
+  QueryParameter = "Query Parameter",
+}
+
+export class Auth {
+  bearerToken?: string;
+  basicAuth?: {
+    username: string;
+    password: string;
+  };
+  apiKey?: {
+    authKey: string;
+    authValue: string | unknown;
+    addTo: AddTo;
+  };
+}
+
+export type TFKeyValueStoreType = {
+  key: string;
+  value: string;
+  checked?: boolean;
+};
+
+export interface TFAPIResponseType {
+  body?: string;
+  headers?: object;
+  status?: string;
+}
+
+export enum RequestDataTypeEnum {
+  JSON = "JSON",
+  XML = "XML",
+  HTML = "HTML",
+  TEXT = "Text",
+  JAVASCRIPT = "JavaScript",
+  IMAGE = "Image",
+}