Merge dev to stable (#184)

.env.example

@@ -1,7 +1,7 @@
 ## SERVER:
-# Set log verbosity [2]:integer
-# (0=error <- 1=warn <- 2=info <- 3=debug)
-#LOGLEVEL=2
+# Set log verbosity [3]:integer
+# (0=none <- 1=error <- 2=warn <- 3=info <- 4=debug)
+#LOGLEVEL=3
 
 # Port for the server [4000]:integer
 #PORT=4000

.github/workflows/release.yml

@@ -101,7 +101,7 @@ jobs:
           artifacts: dist/*.tar.gz,dist/*.zip
           makeLatest: true
           prerelease: ${{ github.ref != 'refs/heads/stable' }}
-          generateReleaseNotes: true
+          generateReleaseNotes: ${{ github.ref == 'refs/heads/stable' }}
 
       - if: ${{ inputs.artifact-action == 'build-release' }}
         name: Attest artifact

.github/workflows/security.yml

@@ -47,6 +47,6 @@ jobs:
           publish_results: true
 
       - name: Upload to code-scanning
-        uses: github/codeql-action/upload-sarif@c36620d31ac7c881962c3d9dd939c40ec9434f2b # v3.26.12
+        uses: github/codeql-action/upload-sarif@f779452ac5af1c261dce0346a8f964149f49322b # v3.26.13
         with:
           sarif_file: scoreboard.sarif

package.json

@@ -6,7 +6,7 @@
 	"type": "module",
 	"scripts": {
 		"build": "bun run build:server",
-		"build:server": "rm -rf ./dist/ && bun build ./src/server.ts --outdir=./dist/ --target=bun --minify --sourcemap=inline",
+		"build:server": "bun build ./src/server.ts --outfile=./dist/server.js --target=bun --minify --sourcemap=inline",
 		"build:standalone": "bun build ./src/server.ts --outfile=./dist/backend --compile --minify --sourcemap=inline",
 		"build:standalone:darwin-arm64": "bun run build:standalone -- --target=bun-darwin-arm64",
 		"build:standalone:linux-amd64": "bun run build:standalone -- --target=bun-linux-x64-modern",
@@ -31,19 +31,17 @@
 		"start:server": "bun run ./dist/server.js"
 	},
 	"dependencies": {
+		"@hono/swagger-ui": "~0.4.1",
 		"@hono/zod-openapi": "~0.16.4",
-		"@scalar/hono-api-reference": "~0.5.155",
-		"@types/bun": "~1.1.11",
-		"@types/node": "~22.7.7",
-		"chalk": "~5.3.0",
+		"@types/bun": "~1.1.12",
+		"@types/node": "~22.8.1",
 		"env-var": "~7.5.0",
-		"hono": "~4.6.5",
-		"loglevel": "~1.9.2",
+		"hono": "~4.6.7",
 		"typescript": "~5.6.3"
 	},
 	"devDependencies": {
 		"@biomejs/biome": "~1.9.4",
-		"lefthook": "~1.7.22",
+		"lefthook": "~1.8.1",
 		"sort-package-json": "~2.10.1"
 	},
 	"trustedDependencies": [

src/config.ts

@@ -0,0 +1,10 @@
+import { env } from '@x-util/env.ts';
+
+export const config = {
+	protocol: env.tls ? 'https://' : 'http://',
+	apiPath: '/api',
+	storagePath: 'storage/',
+	documentNameLengthMin: 2,
+	documentNameLengthMax: 32,
+	documentNameLengthDefault: 8
+} as const;

src/document/storage.ts

@@ -1,5 +1,5 @@
 import { deserialize, serialize } from 'bun:jsc';
-import { config } from '../server.ts';
+import { config } from '../config.ts';
 import { errorHandler } from '../server/errorHandler.ts';
 import type { Document } from '../types/Document.ts';
 import { ErrorCode } from '../types/ErrorHandler.ts';

src/document/validator.ts

@@ -1,4 +1,4 @@
-import { config } from '../server.ts';
+import { config } from '../config.ts';
 import { errorHandler } from '../server/errorHandler.ts';
 import type { Document } from '../types/Document.ts';
 import { ErrorCode } from '../types/ErrorHandler.ts';

src/endpoints/v1/access.route.ts

@@ -1,7 +1,7 @@
 import { type OpenAPIHono, createRoute, z } from '@hono/zod-openapi';
+import { config } from '../../config.ts';
 import { compression } from '../../document/compression.ts';
 import { storage } from '../../document/storage.ts';
-import { config } from '../../server.ts';
 import { errorHandler, schema } from '../../server/errorHandler.ts';
 import { ErrorCode } from '../../types/ErrorHandler.ts';
 

src/endpoints/v1/accessRaw.route.ts

@@ -1,7 +1,7 @@
 import { type OpenAPIHono, createRoute, z } from '@hono/zod-openapi';
+import { config } from '../../config.ts';
 import { compression } from '../../document/compression.ts';
 import { storage } from '../../document/storage.ts';
-import { config } from '../../server.ts';
 import { errorHandler, schema } from '../../server/errorHandler.ts';
 import { ErrorCode } from '../../types/ErrorHandler.ts';
 

src/endpoints/v1/remove.route.ts

@@ -1,8 +1,8 @@
 import { unlink } from 'node:fs/promises';
 import { type OpenAPIHono, createRoute, z } from '@hono/zod-openapi';
+import { config } from '../../config.ts';
 import { storage } from '../../document/storage.ts';
 import { validator } from '../../document/validator.ts';
-import { config } from '../../server.ts';
 import { errorHandler, schema } from '../../server/errorHandler.ts';
 import { ErrorCode } from '../../types/ErrorHandler.ts';
 

src/endpoints/v2/access.route.ts

@@ -1,8 +1,8 @@
 import { type OpenAPIHono, createRoute, z } from '@hono/zod-openapi';
 import { storage } from '@x-document/storage.ts';
+import { config } from '../../config.ts';
 import { compression } from '../../document/compression.ts';
 import { validator } from '../../document/validator.ts';
-import { config } from '../../server.ts';
 import { errorHandler, schema } from '../../server/errorHandler.ts';
 import { ErrorCode } from '../../types/ErrorHandler.ts';
 

src/endpoints/v2/accessRaw.route.ts

@@ -1,8 +1,8 @@
 import { type OpenAPIHono, createRoute, z } from '@hono/zod-openapi';
 import { storage } from '@x-document/storage.ts';
+import { config } from '../../config.ts';
 import { compression } from '../../document/compression.ts';
 import { validator } from '../../document/validator.ts';
-import { config } from '../../server.ts';
 import { errorHandler, schema } from '../../server/errorHandler.ts';
 import { ErrorCode } from '../../types/ErrorHandler.ts';
 

src/endpoints/v2/edit.route.ts

@@ -1,8 +1,8 @@
 import { type OpenAPIHono, createRoute, z } from '@hono/zod-openapi';
 import { storage } from '@x-document/storage.ts';
+import { config } from '../../config.ts';
 import { compression } from '../../document/compression.ts';
 import { validator } from '../../document/validator.ts';
-import { config } from '../../server.ts';
 import { errorHandler, schema } from '../../server/errorHandler.ts';
 import { middleware } from '../../server/middleware.ts';
 import { ErrorCode } from '../../types/ErrorHandler.ts';

src/endpoints/v2/exists.route.ts

@@ -1,6 +1,6 @@
 import { type OpenAPIHono, createRoute, z } from '@hono/zod-openapi';
+import { config } from '../../config.ts';
 import { validator } from '../../document/validator.ts';
-import { config } from '../../server.ts';
 import { errorHandler, schema } from '../../server/errorHandler.ts';
 import { ErrorCode } from '../../types/ErrorHandler.ts';
 

src/endpoints/v2/publish.route.ts

@@ -1,10 +1,10 @@
 import { type OpenAPIHono, createRoute, z } from '@hono/zod-openapi';
 import { storage } from '@x-document/storage.ts';
 import { StringUtils } from '@x-util/StringUtils.ts';
+import { config } from '../../config.ts';
 import { compression } from '../../document/compression.ts';
 import { crypto } from '../../document/crypto.ts';
 import { validator } from '../../document/validator.ts';
-import { config } from '../../server.ts';
 import { errorHandler, schema } from '../../server/errorHandler.ts';
 import { middleware } from '../../server/middleware.ts';
 import { DocumentVersion } from '../../types/Document.ts';

src/endpoints/v2/remove.route.ts

@@ -1,8 +1,8 @@
 import { unlink } from 'node:fs/promises';
 import { type OpenAPIHono, createRoute, z } from '@hono/zod-openapi';
 import { storage } from '@x-document/storage.ts';
+import { config } from '../../config.ts';
 import { validator } from '../../document/validator.ts';
-import { config } from '../../server.ts';
 import { errorHandler, schema } from '../../server/errorHandler.ts';
 import { ErrorCode } from '../../types/ErrorHandler.ts';
 

src/server.ts

@@ -1,43 +1,22 @@
 import { OpenAPIHono } from '@hono/zod-openapi';
+import { env } from '@x-util/env.ts';
+import { logger } from '@x-util/logger.ts';
 import { serve } from 'bun';
-import { get as envvar } from 'env-var';
 import { cors } from 'hono/cors';
 import { HTTPException } from 'hono/http-exception';
-import { logger } from './logger.ts';
+import { config } from './config.ts';
 import { documentation } from './server/documentation.ts';
 import { endpoints } from './server/endpoints.ts';
 import { errorHandler } from './server/errorHandler.ts';
 import { ErrorCode } from './types/ErrorHandler.ts';
 
-export const env = {
-	port: envvar('PORT').default(4000).asPortNumber(),
-	logLevel: envvar('LOGLEVEL').default(2).asIntPositive(),
-	tls: envvar('TLS').asBoolStrict() ?? true,
-	documentMaxSize: envvar('DOCUMENT_MAXSIZE').default(1024).asIntPositive(),
-	docsEnabled: envvar('DOCS_ENABLED').asBoolStrict() ?? false,
-	docsPath: envvar('DOCS_PATH').default('/docs').asString()
-} as const;
-
-export const config = {
-	protocol: env.tls ? 'https://' : 'http://',
-	apiPath: '/api',
-	storagePath: 'storage/',
-	documentNameLengthMin: 2,
-	documentNameLengthMax: 32,
-	documentNameLengthDefault: 8
-} as const;
+process.on('SIGTERM', async () => await backend.stop());
 
 logger.set(env.logLevel);
 
-process.on('SIGTERM', async () => {
-	await backend.stop();
-});
-
 const instance = new OpenAPIHono().basePath(config.apiPath);
 
 export const server = (): typeof instance => {
-	logger.set(env.logLevel);
-
 	instance.use('*', cors());
 
 	instance.onError((err) => {
@@ -63,6 +42,6 @@ export const server = (): typeof instance => {
 };
 
 const backend = serve({
-	port: env.port,
-	fetch: server().fetch
+	fetch: server().fetch,
+	port: env.port
 });

src/server/documentation.ts

@@ -1,6 +1,7 @@
+import { swaggerUI } from '@hono/swagger-ui';
 import type { OpenAPIHono } from '@hono/zod-openapi';
-import { config, env } from '../server.ts';
-import { middleware } from './middleware.ts';
+import { env } from '@x-util/env.ts';
+import { config } from '../config.ts';
 
 export const documentation = (instance: OpenAPIHono): void => {
 	instance.doc31('/oas.json', (ctx) => ({
@@ -27,8 +28,13 @@ export const documentation = (instance: OpenAPIHono): void => {
 				url: 'https://paste.inetol.net',
 				description: 'Inetol Infrastructure instance'
 			}
-		]
+		].filter((server, index, self) => self.findIndex((x) => x.url === server.url) === index)
 	}));
 
-	instance.get(env.docsPath, middleware.scalar());
+	instance.get(
+		env.docsPath,
+		swaggerUI({
+			url: config.apiPath.concat('/oas.json')
+		})
+	);
 };

src/server/endpoints.ts

@@ -1,7 +1,7 @@
 import type { OpenAPIHono } from '@hono/zod-openapi';
 import { v1 } from '@x-v1/index.ts';
 import { v2 } from '@x-v2/index.ts';
-import { config } from '../server.ts';
+import { config } from '../config.ts';
 
 export const endpoints = (instance: OpenAPIHono): void => {
 	instance.get('/documents/*', (ctx) => {

src/server/middleware.ts

@@ -1,6 +1,5 @@
-import { apiReference } from '@scalar/hono-api-reference';
+import { env } from '@x-util/env.ts';
 import { bodyLimit as middlewareBodyLimit } from 'hono/body-limit';
-import { config, env } from '../server.ts';
 import { ErrorCode } from '../types/ErrorHandler.ts';
 import { errorHandler } from './errorHandler.ts';
 
@@ -12,17 +11,5 @@ export const middleware = {
 				throw errorHandler.send(ErrorCode.documentInvalidSize);
 			}
 		});
-	},
-
-	scalar: () => {
-		return apiReference({
-			pageTitle: 'JSPaste Documentation',
-			theme: 'saturn',
-			layout: 'classic',
-			isEditable: false,
-			spec: {
-				url: config.apiPath.concat('/oas.json')
-			}
-		});
 	}
 } as const;

src/utils/StringUtils.ts

@@ -1,4 +1,4 @@
-import { config } from '../server.ts';
+import { config } from '../config.ts';
 import type { Range } from '../types/Range.ts';
 import { ValidatorUtils } from './ValidatorUtils.ts';
 

src/utils/colors.ts

@@ -0,0 +1,22 @@
+import { type ColorInput, color as bunColor } from 'bun';
+
+const colorString =
+	(color: ColorInput) =>
+	(...text: unknown[]): string => {
+		return bunColor(color, 'ansi') + text.join(' ') + colors.reset;
+	};
+
+export const colors = {
+	red: colorString('#ef5454'),
+	orange: colorString('#ef8354'),
+	yellow: colorString('#efd554'),
+	green: colorString('#70ef54'),
+	turquoise: colorString('#54efef'),
+	blue: colorString('#5954ef'),
+	purple: colorString('#a454ef'),
+	pink: colorString('#ef54d5'),
+	gray: colorString('#888'),
+	black: colorString('#000'),
+	white: colorString('#fff'),
+	reset: '\x1b[0m'
+} as const;

src/utils/env.ts

@@ -0,0 +1,11 @@
+import { LogLevels } from '@x-util/logger.ts';
+import { get } from 'env-var';
+
+export const env = {
+	port: get('PORT').default(4000).asPortNumber(),
+	logLevel: get('LOGLEVEL').default(LogLevels.info).asIntPositive(),
+	tls: get('TLS').asBoolStrict() ?? true,
+	documentMaxSize: get('DOCUMENT_MAXSIZE').default(1024).asIntPositive(),
+	docsEnabled: get('DOCS_ENABLED').asBoolStrict() ?? false,
+	docsPath: get('DOCS_PATH').default('/docs').asString()
+} as const;