@ezetgalaxy/titan 26.8.3 → 26.9.0

package/templates/ts/app/titan.d.ts

@@ -0,0 +1,102 @@
+/**
+ * TITAN TYPE DEFINITIONS
+ */
+
+/**
+ * The Titan Request Object passed to actions.
+ */
+interface TitanRequest {
+    body: any;
+    method: "GET" | "POST" | "PUT" | "DELETE" | "PATCH";
+    path: string;
+    headers: {
+        host?: string;
+        "content-type"?: string;
+        "user-agent"?: string;
+        authorization?: string;
+        [key: string]: string | undefined;
+    };
+    params: Record<string, string>;
+    query: Record<string, string>;
+}
+
+interface DbConnection {
+    /**
+     * Execute a SQL query.
+     * @param sql The SQL query string.
+     * @param params (Optional) Parameters for the query ($1, $2, etc).
+     */
+    query(sql: string, params?: any[]): any[];
+}
+
+/**
+ * Define a Titan Action with type inference.
+ * @example
+ * export const hello = defineAction((req) => {
+ *   return req.headers;
+ * });
+ */
+declare function defineAction<T>(actionFn: (req: TitanRequest) => T): (req: TitanRequest) => T;
+
+/**
+ * Titan Runtime Utilities
+ */
+declare const t: {
+    /**
+     * Log messages to the server console with Titan formatting.
+     */
+    log(...args: any[]): void;
+
+    /**
+     * Read a file contents as string.
+     * @param path Relative path to the file from project root.
+     */
+    read(path: string): string;
+
+    fetch(url: string, options?: {
+        method?: "GET" | "POST" | "PUT" | "DELETE" | "PATCH";
+        headers?: Record<string, string>;
+        body?: string | object;
+    }): {
+        ok: boolean;
+        status?: number;
+        body?: string;
+        error?: string;
+    };
+
+    jwt: {
+        sign(
+            payload: object,
+            secret: string,
+            options?: { expiresIn?: string | number }
+        ): string;
+        verify(token: string, secret: string): any;
+    };
+
+    password: {
+        hash(password: string): string;
+        verify(password: string, hash: string): boolean;
+    };
+
+    db: {
+        connect(url: string): DbConnection;
+    };
+};
+
+// Declaring module for import t from "../titan/titan.js"
+declare module "*titan.js" {
+    export interface RouteHandler {
+        reply(value: any): void;
+        action(name: string): void;
+    }
+
+    export interface Titan {
+        get(route: string): RouteHandler;
+        post(route: string): RouteHandler;
+        log(module: string, msg: string): void;
+        start(port?: number, msg?: string): Promise<void>;
+    }
+
+    const t: Titan;
+    export default t;
+}

package/templates/ts/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "titanpl",
+  "version": "1.0.0",
+  "description": "A Titan Planet server (TypeScript)",
+  "type": "module",
+  "titan": {
+    "template": "ts"
+  },
+  "dependencies": {
+    "chokidar": "^5.0.0",
+    "esbuild": "^0.27.2",
+    "typescript": "^5.0.0"
+  },
+  "devDependencies": {
+    "@vitest/coverage-v8": "^3.0.0",
+    "@vitest/ui": "^3.0.0",
+    "vitest": "^3.0.0"
+  },
+  "scripts": {
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "test:ui": "vitest --ui",
+    "typecheck": "tsc --noEmit"
+  }
+}