@zyno-io/ts-server-foundation 26.712.36

package/package.json

@@ -0,0 +1,124 @@
+{
+    "name": "@zyno-io/ts-server-foundation",
+    "version": "26.712.36",
+    "description": "TypeScript server foundation with reflected type metadata",
+    "license": "MIT",
+    "bin": {
+        "ts-server-foundation": "dist/src/cli/tsf.js",
+        "tsf": "dist/src/cli/tsf.js",
+        "tsf-create-app": "dist/src/cli/tsf-create-app.js",
+        "tsf-dev": "dist/src/cli/tsf-dev.js",
+        "tsf-gen-proto": "dist/src/cli/tsf-gen-proto.js",
+        "tsf-install": "dist/src/cli/tsf-install.js",
+        "tsf-migrate": "dist/src/cli/tsf-migrate.js",
+        "tsf-test": "dist/src/cli/tsf-test.js",
+        "tsf-update": "dist/src/cli/tsf-update.js"
+    },
+    "files": [
+        "dist/src/",
+        "dist/devconsole/",
+        "docs/content/",
+        "docs/.vitepress/config.mts",
+        "docs/openapi.md",
+        "resources/",
+        "template-app/",
+        "types.d.ts",
+        "package.json",
+        "!docs/.vitepress/dist/"
+    ],
+    "type": "commonjs",
+    "main": "./dist/src/index.js",
+    "types": "./dist/src/index.d.ts",
+    "exports": {
+        ".": {
+            "types": "./dist/src/index.d.ts",
+            "import": "./dist/src/index.js",
+            "require": "./dist/src/index.js"
+        },
+        "./otel": {
+            "types": "./dist/src/telemetry/otel/index.d.ts",
+            "import": "./dist/src/telemetry/otel/index.js",
+            "require": "./dist/src/telemetry/otel/index.js"
+        }
+    },
+    "scripts": {
+        "clean": "rm -rf dist",
+        "build": "yarn clean && ttsc -p tsconfig.json && yarn build:type-compiler && yarn build:devconsole && chmod +x dist/src/cli/*.js",
+        "build:dirty": "ttsc -p tsconfig.json && yarn build:type-compiler && yarn build:devconsole && chmod +x dist/src/cli/*.js",
+        "build:type-compiler": "rm -rf dist/src/type-compiler && mkdir -p dist/src/type-compiler && cp -R src/type-compiler/index.cjs src/type-compiler/go dist/src/type-compiler/",
+        "build:devconsole": "vite build --config devconsole/vite.config.ts",
+        "docs:dev": "vitepress dev docs --host 0.0.0.0",
+        "docs:build": "vitepress build docs",
+        "docs:preview": "vitepress preview docs --host 0.0.0.0",
+        "gen:devconsole-proto": "tsf-gen-proto resources/proto/devconsole.proto src/devconsole/generated",
+        "format": "oxfmt && oxlint src --fix",
+        "test": "yarn build && dotenv -e .env.test -- tsf-test",
+        "test:type-compiler-go": "node scripts/test-type-compiler-go.cjs",
+        "test:dirty": "yarn build:dirty && APP_ENV=test node --test \"dist/tests/**/*.spec.js\"",
+        "test-app": "yarn clean && ttsc -p tsconfig.test-app.json && APP_ENV=test node dist/test-app/bootstrap.js",
+        "postinstall": "true"
+    },
+    "dependencies": {
+        "@bufbuild/protobuf": "^2.12.1",
+        "@opentelemetry/api": "^1.9.1",
+        "@opentelemetry/exporter-metrics-otlp-http": "^0.220.0",
+        "@opentelemetry/exporter-prometheus": "^0.220.0",
+        "@opentelemetry/exporter-trace-otlp-http": "^0.220.0",
+        "@opentelemetry/instrumentation": "^0.220.0",
+        "@opentelemetry/instrumentation-dns": "^0.63.0",
+        "@opentelemetry/instrumentation-http": "^0.220.0",
+        "@opentelemetry/instrumentation-ioredis": "^0.68.0",
+        "@opentelemetry/instrumentation-mysql2": "^0.66.0",
+        "@opentelemetry/instrumentation-pg": "^0.72.0",
+        "@opentelemetry/instrumentation-undici": "^0.30.0",
+        "@opentelemetry/resources": "^2.9.0",
+        "@opentelemetry/sdk-metrics": "^2.9.0",
+        "@opentelemetry/sdk-trace-base": "^2.9.0",
+        "@opentelemetry/sdk-trace-node": "^2.9.0",
+        "@sentry/node": "^10.64.0",
+        "@types/ws": "^8.18.1",
+        "@zyno-io/config": "^1.14.0",
+        "bcrypt": "^6.0.0",
+        "bullmq": "^5.79.3",
+        "busboy": "^1.6.0",
+        "debug": "^4.4.3",
+        "fast-jwt": "^6.2.4",
+        "file-type": "^22.0.1",
+        "google-libphonenumber": "^3.2.44",
+        "ioredis": "^5.11.1",
+        "mysql2": "^3.22.6",
+        "nodemailer": "^9.0.3",
+        "pg": "^8.22.0",
+        "pino": "^10.3.1",
+        "pino-pretty": "^13.1.3",
+        "postmark": "^5.0.0",
+        "protoc": "^35.1.0",
+        "ts-proto": "^2.12.0",
+        "tslib": "^2.8.1",
+        "uuidv7": "^1.2.1",
+        "vue": "^3.5.39",
+        "vue-router": "^5.1.0",
+        "ws": "^8.21.0",
+        "yaml": "^2.9.0"
+    },
+    "devDependencies": {
+        "@types/bcrypt": "^6.0.0",
+        "@types/busboy": "^1.5.4",
+        "@types/debug": "^4.1.13",
+        "@types/google-libphonenumber": "^7.4.30",
+        "@types/node": "^26.1.1",
+        "@types/nodemailer": "^8.0.1",
+        "@types/pg": "^8.20.0",
+        "@vitejs/plugin-vue": "^6.0.7",
+        "dotenv-cli": "^11.0.0",
+        "lefthook": "^2.1.10",
+        "oxlint": "^1.73.0",
+        "ttsc": "0.18.3",
+        "typescript": "7.0.2",
+        "vite": "^8.1.4",
+        "vite-plugin-oxlint": "^2.1.2",
+        "vite-plugin-vue-tailwind-auto-reference": "^2.0.2",
+        "vitepress": "^1.6.4"
+    },
+    "packageManager": "yarn@4.17.1"
+}

package/resources/proto/devconsole.proto

@@ -0,0 +1,286 @@
+syntax = "proto3";
+
+package sgnl24.DevConsole;
+
+///
+/// Framework
+///
+
+message PingPong {}
+
+message WriteByteStream { bytes chunk = 1; }
+message FinishByteStream {}
+message DestroyByteStream { optional string error = 1; }
+message ByteStreamOperation {
+  int32 streamId = 1;
+  oneof operation {
+    WriteByteStream write = 2;
+    FinishByteStream finish = 3;
+    DestroyByteStream destroy = 4;
+  }
+}
+message TraceContext {
+  string traceId = 1;
+  string spanId = 2;
+  int32 traceFlags = 3;
+}
+
+///
+/// Downstream requests (server-initiated push events)
+///
+
+message DEventRequest {
+  string type = 1;
+  string jsonData = 2;
+}
+message DEventResponse {}
+
+///
+/// Upstream requests (client-initiated)
+///
+
+// REPL
+
+message UReplEvalRequest {
+  string code = 1;
+}
+message UReplEvalResponse {
+  string output = 1;
+  optional string error = 2;
+}
+
+message UReplCompleteRequest {
+  string code = 1;
+  int32 cursorPos = 2;
+}
+message UReplCompleteItem {
+  string label = 1;
+  string kind = 2;
+}
+message UReplCompleteResponse {
+  repeated UReplCompleteItem items = 1;
+  int32 replaceStart = 2;
+  int32 replaceEnd = 3;
+}
+
+// Overview / Dashboard
+
+message UGetOverviewRequest {}
+message UGetOverviewResponse {
+  string name = 1;
+  string version = 2;
+  int64 uptime = 3;
+  string env = 4;
+  int32 httpEntries = 5;
+  int32 srpcMessages = 6;
+  int32 srpcActiveConnections = 7;
+  int32 srpcDisconnected = 8;
+}
+
+message UGetProcessRequest {}
+message UGetProcessResponse {
+  int32 pid = 1;
+  int64 rss = 2;
+  int64 heapTotal = 3;
+  int64 heapUsed = 4;
+  int64 external = 5;
+  int64 arrayBuffers = 6;
+  int64 cpuUser = 7;
+  int64 cpuSystem = 8;
+  double uptime = 9;
+  string nodeVersion = 10;
+  string platform = 11;
+  string arch = 12;
+}
+
+// Environment
+
+message UGetEnvRequest {}
+message UGetEnvResponse {
+  string jsonData = 1;
+}
+
+// HTTP Requests
+
+message UGetRequestsRequest {}
+message UGetRequestsResponse {
+  string jsonData = 1;
+}
+
+// Routes
+
+message UGetRoutesRequest {}
+message UGetRoutesRoute {
+  repeated string methods = 1;
+  string path = 2;
+  optional string controller = 3;
+  optional string methodName = 4;
+}
+message UGetRoutesResponse {
+  repeated UGetRoutesRoute routes = 1;
+}
+
+// sRPC
+
+message UGetSrpcRequest {}
+message UGetSrpcResponse {
+  string jsonData = 1;
+}
+
+message UGetSrpcMessagesRequest {
+  optional string streamId = 1;
+}
+message UGetSrpcMessagesResponse {
+  string jsonData = 1;
+}
+
+// Workers
+
+message UGetWorkersRequest {}
+message UGetWorkersResponse {
+  string jsonData = 1;
+}
+
+message UGetWorkersJobsRequest {}
+message UGetWorkersJobsResponse {
+  string jsonData = 1;
+}
+
+// Database
+
+message UGetDatabaseEntitiesRequest {}
+message UGetDatabaseEntity {
+  string name = 1;
+  string table = 2;
+  repeated string columns = 3;
+  string quotedTable = 4;
+}
+message UGetDatabaseEntitiesResponse {
+  repeated UGetDatabaseEntity entities = 1;
+}
+
+message UDatabaseQueryRequest {
+  string sql = 1;
+}
+message UDatabaseQueryRow {
+  repeated string values = 1;
+}
+message UDatabaseQueryResponse {
+  repeated string columns = 1;
+  repeated UDatabaseQueryRow rows = 2;
+  int32 rowCount = 3;
+  optional int32 affectedRows = 4;
+  optional string error = 5;
+}
+
+// Health Checks
+
+message UGetHealthChecksRequest {}
+message UGetHealthChecksResponse {
+  string jsonData = 1;
+}
+
+// Clear
+
+message UClearRequestsRequest {}
+message UClearRequestsResponse {}
+
+message UClearSrpcMessagesRequest {}
+message UClearSrpcMessagesResponse {}
+
+// Database Log
+
+message UGetDatabaseQueriesRequest {}
+message UGetDatabaseQueriesResponse {
+  string jsonData = 1;
+}
+
+message UClearDatabaseQueriesRequest {}
+message UClearDatabaseQueriesResponse {}
+
+// Mutexes
+
+message UGetMutexesRequest {}
+message UGetMutexesResponse {
+  string jsonData = 1;
+}
+
+///
+/// Client & Server message containers
+///
+
+message DevConsoleClientMessage {
+  string requestId = 1;
+  bool reply = 2;
+  optional string error = 3;
+  optional bool userError = 4;
+  optional TraceContext trace = 5;
+
+  oneof request {
+    // framework
+    PingPong pingPong = 50;
+    ByteStreamOperation byteStreamOperation = 51;
+
+    // downstream responses (responding to server)
+    DEventResponse dEventResponse = 2000;
+
+    // upstream requests (client-initiated)
+    UReplEvalRequest uReplEvalRequest = 2100;
+    UReplCompleteRequest uReplCompleteRequest = 2101;
+    UGetOverviewRequest uGetOverviewRequest = 2102;
+    UGetProcessRequest uGetProcessRequest = 2103;
+    UGetEnvRequest uGetEnvRequest = 2104;
+    UGetRequestsRequest uGetRequestsRequest = 2105;
+    UGetRoutesRequest uGetRoutesRequest = 2106;
+    UGetSrpcRequest uGetSrpcRequest = 2107;
+    UGetSrpcMessagesRequest uGetSrpcMessagesRequest = 2108;
+    UGetWorkersRequest uGetWorkersRequest = 2109;
+    UGetWorkersJobsRequest uGetWorkersJobsRequest = 2110;
+    UGetDatabaseEntitiesRequest uGetDatabaseEntitiesRequest = 2111;
+    UDatabaseQueryRequest uDatabaseQueryRequest = 2112;
+    UGetHealthChecksRequest uGetHealthChecksRequest = 2113;
+    UGetMutexesRequest uGetMutexesRequest = 2114;
+    UClearRequestsRequest uClearRequestsRequest = 2115;
+    UClearSrpcMessagesRequest uClearSrpcMessagesRequest = 2116;
+    UGetDatabaseQueriesRequest uGetDatabaseQueriesRequest = 2117;
+    UClearDatabaseQueriesRequest uClearDatabaseQueriesRequest = 2118;
+  }
+}
+
+message DevConsoleServerMessage {
+  string requestId = 1;
+  bool reply = 2;
+  optional string error = 3;
+  optional bool userError = 4;
+  optional TraceContext trace = 5;
+
+  oneof response {
+    // framework
+    PingPong pingPong = 50;
+    ByteStreamOperation byteStreamOperation = 51;
+
+    // downstream requests (server-initiated)
+    DEventRequest dEventRequest = 2000;
+
+    // upstream responses (replies to client)
+    UReplEvalResponse uReplEvalResponse = 2100;
+    UReplCompleteResponse uReplCompleteResponse = 2101;
+    UGetOverviewResponse uGetOverviewResponse = 2102;
+    UGetProcessResponse uGetProcessResponse = 2103;
+    UGetEnvResponse uGetEnvResponse = 2104;
+    UGetRequestsResponse uGetRequestsResponse = 2105;
+    UGetRoutesResponse uGetRoutesResponse = 2106;
+    UGetSrpcResponse uGetSrpcResponse = 2107;
+    UGetSrpcMessagesResponse uGetSrpcMessagesResponse = 2108;
+    UGetWorkersResponse uGetWorkersResponse = 2109;
+    UGetWorkersJobsResponse uGetWorkersJobsResponse = 2110;
+    UGetDatabaseEntitiesResponse uGetDatabaseEntitiesResponse = 2111;
+    UDatabaseQueryResponse uDatabaseQueryResponse = 2112;
+    UGetHealthChecksResponse uGetHealthChecksResponse = 2113;
+    UGetMutexesResponse uGetMutexesResponse = 2114;
+    UClearRequestsResponse uClearRequestsResponse = 2115;
+    UClearSrpcMessagesResponse uClearSrpcMessagesResponse = 2116;
+    UGetDatabaseQueriesResponse uGetDatabaseQueriesResponse = 2117;
+    UClearDatabaseQueriesResponse uClearDatabaseQueriesResponse = 2118;
+  }
+}

package/template-app/.env.development

@@ -0,0 +1,10 @@
+APP_ENV=development
+PORT=3000
+DB_ADAPTER=mysql
+MYSQL_HOST=127.0.0.1
+MYSQL_PORT=3306
+MYSQL_USER=root
+MYSQL_PASSWORD_SECRET=
+MYSQL_DATABASE=%%APP_DB_NAME%%
+REDIS_PREFIX=%%APP_REDIS_PREFIX%%
+

package/template-app/gitignore.tmpl

@@ -0,0 +1,11 @@
+dist/
+node_modules/
+.yarn/*
+!.yarn/cache/
+!.yarn/releases/
+!.yarn/plugins/
+!.yarn/sdks/
+!.yarn/versions/
+*.log
+.env.local
+.env.*.local

package/template-app/package.json.tmpl

@@ -0,0 +1,25 @@
+{
+    "name": "%%PACKAGE_NAME%%",
+    "version": "0.1.0",
+    "private": true,
+    "main": "./dist/src/index.js",
+    "scripts": {
+        "build": "tsf-dev build",
+        "dev": "tsf-dev run -- server:start",
+        "migrate": "tsf-dev migrate",
+        "migrate:create": "tsf-dev migrate:create",
+        "test": "tsf-dev test",
+        "test:debug": "tsf-dev test --debug",
+        "postinstall": "tsf-install"
+    },
+    "dependencies": {
+        "@zyno-io/ts-server-foundation": "%%FOUNDATION_VERSION%%",
+        "tslib": "^2.8.1"
+    },
+    "devDependencies": {
+        "@types/node": "^26",
+        "ttsc": "%%TTSC_VERSION%%",
+        "typescript": "%%TYPESCRIPT_VERSION%%"
+    },
+    "packageManager": "yarn@4.17.1"
+}

package/template-app/src/app.ts

@@ -0,0 +1,13 @@
+import { createApp } from '@zyno-io/ts-server-foundation';
+
+import { AppConfig } from './config';
+import { ExampleController } from './controllers/Example.controller';
+import { DB } from './database';
+import { ExampleService } from './services/Example.service';
+
+export const app = createApp({
+    config: AppConfig,
+    db: DB,
+    controllers: [ExampleController],
+    providers: [ExampleService]
+});

package/template-app/src/config.ts

@@ -0,0 +1,5 @@
+import { BaseAppConfig } from '@zyno-io/ts-server-foundation';
+
+export class AppConfig extends BaseAppConfig {
+    APP_ENV = 'development';
+}

package/template-app/src/controllers/Example.controller.ts

@@ -0,0 +1,19 @@
+import { ApiResponse, http, HttpBody } from '@zyno-io/ts-server-foundation';
+
+import { ExampleEntity } from '../entities/Example.entity';
+import { ExampleService } from '../services/Example.service';
+
+@http.controller('/examples')
+export class ExampleController {
+    constructor(private readonly examples: ExampleService) {}
+
+    @http.GET()
+    list() {
+        return this.examples.findAll();
+    }
+
+    @http.POST()
+    async create(body: HttpBody<{ name: string }>): ApiResponse<ExampleEntity, 201> {
+        return this.examples.create(body.name);
+    }
+}

package/template-app/src/database.ts

@@ -0,0 +1,5 @@
+import { createMySQLDatabase } from '@zyno-io/ts-server-foundation';
+
+import { ExampleEntity } from './entities/Example.entity';
+
+export class DB extends createMySQLDatabase({}, [ExampleEntity]) {}

package/template-app/src/entities/Example.entity.ts

@@ -0,0 +1,9 @@
+import { AutoIncrement, entity, PrimaryKey } from '@zyno-io/ts-server-foundation';
+import { BaseEntity } from '@zyno-io/ts-server-foundation';
+
+@entity.name('examples')
+export class ExampleEntity extends BaseEntity {
+    id!: number & AutoIncrement & PrimaryKey;
+    name!: string;
+    createdAt: Date = new Date();
+}

package/template-app/src/index.ts

@@ -0,0 +1,7 @@
+#!/usr/bin/env node
+
+require('@zyno-io/ts-server-foundation/otel').init();
+
+const { app } = require('./app');
+
+app.run();

package/template-app/src/migrations/.gitkeep

@@ -0,0 +1,2 @@
+# keep migrations directory
+

package/template-app/src/services/Example.service.ts

@@ -0,0 +1,20 @@
+import { createPersistedEntity, ScopedLogger } from '@zyno-io/ts-server-foundation';
+
+import { DB } from '../database';
+import { ExampleEntity } from '../entities/Example.entity';
+
+export class ExampleService {
+    constructor(
+        private readonly db: DB,
+        private readonly logger: ScopedLogger
+    ) {}
+
+    async findAll(): Promise<ExampleEntity[]> {
+        return this.db.query(ExampleEntity).orderBy('id', 'desc').find();
+    }
+
+    async create(name: string): Promise<ExampleEntity> {
+        this.logger.info('Creating example', { name });
+        return createPersistedEntity(ExampleEntity, { name });
+    }
+}

package/template-app/tests/app.spec.ts

@@ -0,0 +1,8 @@
+import assert from 'node:assert/strict';
+import { test } from 'node:test';
+
+import { app } from '../src/app';
+
+test('creates the application', () => {
+    assert.equal(app.config.APP_ENV, 'test');
+});

package/template-app/tsconfig.json

@@ -0,0 +1,26 @@
+{
+    "compilerOptions": {
+        "target": "ES2022",
+        "lib": ["ES2022"],
+        "module": "commonjs",
+        "rootDir": ".",
+        "outDir": "dist",
+        "declaration": false,
+        "sourceMap": true,
+        "strict": true,
+        "esModuleInterop": true,
+        "forceConsistentCasingInFileNames": true,
+        "skipLibCheck": true,
+        "experimentalDecorators": true,
+        "emitDecoratorMetadata": true,
+        "importHelpers": true,
+        "types": ["node"],
+        "plugins": [
+            {
+                "transform": "./node_modules/@zyno-io/ts-server-foundation/dist/src/type-compiler/index.cjs"
+            }
+        ]
+    },
+    "include": ["src/**/*.ts"],
+    "reflection": true
+}

package/template-app/tsconfig.test.json

@@ -0,0 +1,5 @@
+{
+    "extends": "./tsconfig.json",
+    "include": ["src/**/*.ts", "tests/**/*.ts"],
+    "reflection": true
+}

package/types.d.ts

@@ -0,0 +1,4 @@
+declare module '*.json' {
+    const value: unknown;
+    export default value;
+}