Dev (#207)

* feat: big badge configuration * fix: remove google fonts * fix(plugins, server): remove cdn * ci: fix format ignore * feat(server): json configuration * feat: add search route for adding in browser * fix: add arm arch * fix: docker action * fix: engines fallback * doc: change logo * doc: fix logo margin * doc: update version * doc: change layout * dev: add dependabot groups * dev: fix dependabot and format
TxtDot · Jul 24, 2024 · 572531a · 572531a
1 parent d0bc4ff
commit 572531a
Show file tree

Hide file tree

Showing 23 changed files with 2,199 additions and 1,024 deletions.
diff --git a/.dockerignore b/.dockerignore
@@ -1,2 +1,3 @@
 node_modules
-dist
+packages/**/dist/**/*
+packages/**/node_modules/**/*
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -10,3 +10,7 @@ updates:
     target-branch: 'dev'
     schedule:
       interval: 'weekly'
+    groups:
+      deps:
+        patterns:
+          - '*'
diff --git a/.github/workflows/build.yml → .github/workflows/build-check.yml b/.github/workflows/build.yml → .github/workflows/build-check.yml
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml
@@ -0,0 +1,50 @@
+name: Create and publish a Docker image
+
+on:
+  push:
+    branches:
+      - main
+      - dev
+  release:
+    types:
+      - published
+
+env:
+  REGISTRY: ghcr.io
+  IMAGE_NAME: ${{ github.repository }}
+
+jobs:
+  build-and-push-image:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Log in to the Container registry
+        uses: docker/login-action@v3
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@v5
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v5
+        with:
+          context: .
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          platforms: linux/amd64,linux/arm64
diff --git a/.prettierignore b/.prettierignore
@@ -1,2 +1,4 @@
 pnpm-lock.yaml
-packages/**/dist/**/*
+packages/**/dist/**/*
+packages/**/node_modules/**/*
+packages/server/static/third-party/**/*
diff --git a/README.md b/README.md
@@ -1,13 +1,16 @@
-<h1 align="center">
-  <a href="https://github.com/TxtDot/txtdot"><img src="https://github.com/TxtDot/.github/blob/main/imgs/TXTDot%20gh.png?raw=true" alt="txt." width="200"></a>
-  <br>
-  <a href="https://txtdot.github.io/documentation"><img alt="Documentation" src="https://img.shields.io/badge/Documentation-green"></a>
-  <a href="https://github.com/TxtDot/instances"><img alt="Instances" src="https://img.shields.io/badge/Instances-green"></a>
-  <br>
-  <a href="https://github.com/TxtDot/txtdot/blob/main/LICENSE"><img alt="MIT license" src="https://img.shields.io/github/license/txtdot/txtdot?color=blue"></a>
-  <a href="https://github.com/TxtDot/txtdot/releases/latest"><img alt="Latest release" src="https://img.shields.io/github/v/release/TxtDot/txtdot?display_name=release"></a>
-  <a href="https://matrix.to/#/#txtdot:matrix.org"><img alt="Matrix chat" src="https://img.shields.io/badge/chat-matrix-blue"></a>
-</h1>
+<div align="center">
+
+![txtdot logo](https://github.com/TxtDot/.github/raw/main/imgs/txtdot.png)
+
+<a href="https://txtdot.github.io/documentation"><img alt="Documentation" src="https://img.shields.io/badge/Documentation-blue"></a>
+<a href="https://github.com/TxtDot/instances"><img alt="Instances" src="https://img.shields.io/badge/Instances-blue"></a>
+<br>
+<a href="https://github.com/TxtDot/txtdot/blob/main/LICENSE"><img alt="MIT license" src="https://img.shields.io/github/license/txtdot/txtdot?color=blue"></a>
+<a href="https://github.com/TxtDot/txtdot/releases/latest"><img alt="Latest release" src="https://img.shields.io/github/v/release/TxtDot/txtdot?display_name=release"></a>
+
+# txtdot
+
+</div>
 
 HTTP proxy that parses only text, links and pictures from pages
 reducing internet traffic, removing ads and heavy scripts.

diff --git a/packages/plugins/src/middlewares/highlight.tsx b/packages/plugins/src/middlewares/highlight.tsx
@@ -20,14 +20,12 @@ function Highlighter({ content }: { content: string }) {
   return (
     <>
       <style>
-        @import
-        "https://cdn.jsdelivr.net/gh/highlightjs/[email protected]/build/styles/atom-one-light.min.css";
-        @import
-        "https://cdn.jsdelivr.net/gh/highlightjs/[email protected]/build/styles/atom-one-dark.min.css"
-        screen and (prefers-color-scheme: dark);
+        @import "/static/third-party/styles/atom-one-light.min.css"; @import
+        "/static/third-party/styles/atom-one-dark.min.css" screen and
+        (prefers-color-scheme: dark);
       </style>
       <script
-        src="https://cdn.jsdelivr.net/gh/highlightjs/[email protected]/build/highlight.min.js"
+        src="/static/third-party/scripts/highlight.min.js"
         type="text/javascript"
       />
       <script>hljs.highlightAll();</script>

diff --git a/packages/server/package.json b/packages/server/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@txtdot/server",
-  "version": "1.8.0",
+  "version": "1.9.0",
   "private": true,
   "description": "txtdot is an HTTP proxy that parses only text, links and pictures from pages reducing internet bandwidth usage, removing ads and heavy scripts",
   "main": "dist/app.js",
@@ -12,7 +12,7 @@
   "license": "MIT",
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
-    "build": "npm run clean-css && copyfiles ./templates/*.ejs ./templates/**/*.ejs .env ./dist/ && tsc",
+    "build": "npm run clean-css && copyfiles ./templates/*.ejs ./templates/**/*.ejs ./static/third-party/* ./static/third-party/**/* .env ./dist/ && tsc",
     "start": "cd ./dist && node ./src/app.js",
     "clean-css": "cleancss --batch static/*.css -o dist/static --batch-suffix \"\"",
     "dev": "tsc-watch --onSuccess \"node ./dist/src/app.js\""
@@ -21,7 +21,7 @@
     "@fastify/one-line-logger": "^1.3.0",
     "@fastify/static": "^7.0.3",
     "@fastify/swagger": "^8.14.0",
-    "@fastify/swagger-ui": "^3.0.0",
+    "@fastify/swagger-ui": "^4.0.0",
     "@fastify/view": "^9.0.0",
     "@txtdot/plugins": "workspace:*",
     "@txtdot/sdk": "workspace:*",
@@ -32,7 +32,7 @@
     "iconv-lite": "^0.6.3",
     "ip-range-check": "^0.2.0",
     "isomorphic-dompurify": "^2.10.0",
-    "json-schema-to-ts": "^3.0.1",
+    "json-schema-to-ts": "^3.1.0",
     "linkedom": "^0.18.0",
     "micromatch": "^4.0.5",
     "sharp": "^0.33.3"

diff --git a/packages/server/src/distributor.ts b/packages/server/src/distributor.ts
@@ -127,7 +127,9 @@ export class Distributor {
       }
     }
 
-    return await this.engines_fallback[0].handle(input);
+    return await this.engines_fallback[this.engines_fallback.length - 1].handle(
+      input
+    );
   }
 
   async processMiddlewares(

diff --git a/packages/server/src/routes/browser/configuration.ts b/packages/server/src/routes/browser/configuration.ts
@@ -6,11 +6,65 @@ import { indexSchema } from '../../types/requests/browser';
 import config from '../../config';
 
 export default async function configurationRoute(fastify: FastifyInstance) {
-  fastify.get('/configuration', { schema: indexSchema }, async (_, reply) => {
-    return reply.view('/templates/configuration.ejs', {
-      engines: distributor.engines_fallback,
-      middlewares: distributor.middles_fallback,
-      config,
-    });
-  });
+  fastify.get(
+    '/configuration',
+    { schema: indexSchema },
+    async (request, reply) => {
+      return reply.view('/templates/configuration.ejs', {
+        engines: distributor.engines_fallback,
+        middlewares: distributor.middles_fallback,
+        config,
+        base_url: `(${request.protocol}) - ${request.hostname}`,
+      });
+    }
+  );
+
+  fastify.get(
+    '/configuration/json',
+    { schema: indexSchema },
+    async (request, reply) => {
+      reply.header('content-type', 'application/json');
+
+      return {
+        protocol: request.protocol,
+        hostname: request.hostname,
+        version: config.package.version,
+        ...{ ...config.env, host: undefined, port: undefined },
+        engines: distributor.engines_fallback.map((engine) => {
+          return {
+            ...engine,
+            routes: engine.routes.map((route) => {
+              // eslint-disable-next-line @typescript-eslint/no-explicit-any
+              return (route.route as any).spec;
+            }),
+          };
+        }),
+        middlewares: distributor.middles_fallback.map((middleware) => {
+          return {
+            ...middleware,
+            routes: middleware.middles.map((middle) => {
+              // eslint-disable-next-line @typescript-eslint/no-explicit-any
+              return (middle.route as any).spec;
+            }),
+            middles: undefined,
+          };
+        }),
+        routes: [...config.dyn.routes].map((route) => {
+          return route;
+        }),
+      };
+    }
+  );
+
+  fastify.get(
+    '/configuration/badges/big',
+    { schema: indexSchema },
+    async (request, reply) => {
+      reply.header('content-type', 'image/svg+xml');
+      return reply.view('/templates/big_badge.ejs', {
+        config,
+        base_url: `(${request.protocol}) - ${request.hostname}`,
+      });
+    }
+  );
 }
diff --git a/packages/server/src/routes/browser/redirect.ts b/packages/server/src/routes/browser/redirect.ts
@@ -1,6 +1,13 @@
 import { FastifyInstance } from 'fastify';
 
-import { redirectSchema, IRedirectSchema } from '../../types/requests/browser';
+import {
+  redirectSchema,
+  IRedirectSchema,
+  ISearchSchema,
+  searchSchema,
+} from '../../types/requests/browser';
+
+import config from '../../config';
 
 export default async function redirectRoute(fastify: FastifyInstance) {
   fastify.get<IRedirectSchema>(
@@ -17,4 +24,20 @@ export default async function redirectRoute(fastify: FastifyInstance) {
       );
     }
   );
+
+  if (config.env.third_party.searx_url) {
+    fastify.get<ISearchSchema>(
+      '/search',
+      { schema: searchSchema },
+      async (request, reply) => {
+        reply.redirect(
+          `/get?url=${encodeURIComponent(
+            config.env.third_party.searx_url +
+              '/search?q=' +
+              encodeURIComponent(request.query.q)
+          )}`
+        );
+      }
+    );
+  }
 }