tspace-spear 1.2.8 → 1.2.9

package/dist/lib/core/client/index.d.ts

@@ -1,15 +1,4 @@
-import type { AnyRoutes, RoutesWithMethod, RequestBody, RequestQuery, RequestParams, RequestFiles, ResponseType } from "../compiler/types";
-type RequestInput<TRoutes extends AnyRoutes, TPath extends keyof TRoutes, TMethod extends keyof TRoutes[TPath]> = RequestParams<TRoutes, TPath, TMethod> extends never ? {
-    params?: never;
-    query?: RequestQuery<TRoutes, TPath, TMethod>;
-    body?: RequestBody<TRoutes, TPath, TMethod>;
-    files?: RequestFiles<TRoutes, TPath, TMethod>;
-} : {
-    params: RequestParams<TRoutes, TPath, TMethod>;
-    query?: RequestQuery<TRoutes, TPath, TMethod>;
-    body?: RequestBody<TRoutes, TPath, TMethod>;
-    files?: RequestFiles<TRoutes, TPath, TMethod>;
-};
+import type { AnyRoutes, RoutesWithMethod, ResponseType, RequestInput, OptionalIfEmpty, ApiResponse } from "./types";
 /**
  * Type-safe HTTP client built on top of the native Fetch API.
  *
@@ -41,42 +30,23 @@ type RequestInput<TRoutes extends AnyRoutes, TPath extends keyof TRoutes, TMetho
  * })
  *
  * // fully typed response
- * console.log(res.cats)
+ * if(res.ok)
+ *  console.log(res.cats)
  * ```
  */
 declare class ApiClient<TRoutes extends AnyRoutes> {
     private baseURL;
     constructor(baseURL: string);
-    protected request<TPath extends keyof TRoutes, TMethod extends keyof TRoutes[TPath]>(method: TMethod, path: TPath, input?: RequestInput<TRoutes, TPath, TMethod>): Promise<{
-        ok: boolean;
-        status: number;
-        data: ResponseType<TRoutes, TPath, TMethod>;
-    }>;
-    get<TPath extends RoutesWithMethod<TRoutes, "GET">>(path: TPath, input?: RequestInput<TRoutes, TPath, "GET">): Promise<{
-        ok: boolean;
-        status: number;
-        data: ResponseType<TRoutes, TPath, "GET">;
-    }>;
-    post<TPath extends RoutesWithMethod<TRoutes, "POST">>(path: TPath, input: RequestInput<TRoutes, TPath, "POST">): Promise<{
-        ok: boolean;
-        status: number;
-        data: ResponseType<TRoutes, TPath, "POST">;
-    }>;
-    put<TPath extends RoutesWithMethod<TRoutes, "PUT">>(path: TPath, input: RequestInput<TRoutes, TPath, "PUT">): Promise<{
-        ok: boolean;
-        status: number;
-        data: ResponseType<TRoutes, TPath, "PUT">;
-    }>;
-    patch<TPath extends RoutesWithMethod<TRoutes, "PATCH">>(path: TPath, input: RequestInput<TRoutes, TPath, "PATCH">): Promise<{
-        ok: boolean;
-        status: number;
-        data: ResponseType<TRoutes, TPath, "PATCH">;
-    }>;
-    delete<TPath extends RoutesWithMethod<TRoutes, "DELETE">>(path: TPath, input?: RequestInput<TRoutes, TPath, "DELETE">): Promise<{
-        ok: boolean;
-        status: number;
-        data: ResponseType<TRoutes, TPath, "DELETE">;
-    }>;
+    private request;
+    get<TPath extends RoutesWithMethod<TRoutes, "GET">>(path: TPath, ...args: OptionalIfEmpty<RequestInput<TRoutes, TPath, "GET">>): Promise<ApiResponse<ResponseType<TRoutes, TPath, "GET">>>;
+    post<TPath extends RoutesWithMethod<TRoutes, "POST">>(path: TPath, ...args: OptionalIfEmpty<RequestInput<TRoutes, TPath, "POST">>): Promise<ApiResponse<ResponseType<TRoutes, TPath, "POST">>>;
+    put<TPath extends RoutesWithMethod<TRoutes, "PUT">>(path: TPath, ...args: OptionalIfEmpty<RequestInput<TRoutes, TPath, "PUT">>): Promise<ApiResponse<ResponseType<TRoutes, TPath, "PUT">>>;
+    patch<TPath extends RoutesWithMethod<TRoutes, "PATCH">>(path: TPath, ...args: OptionalIfEmpty<RequestInput<TRoutes, TPath, "PATCH">>): Promise<ApiResponse<ResponseType<TRoutes, TPath, "PATCH">>>;
+    delete<TPath extends RoutesWithMethod<TRoutes, "DELETE">>(path: TPath, ...args: OptionalIfEmpty<RequestInput<TRoutes, TPath, "DELETE">>): Promise<ApiResponse<ResponseType<TRoutes, TPath, "DELETE">>>;
+    upload<TMethod extends "POST" | "PUT" | "PATCH" = "POST", TPath extends RoutesWithMethod<TRoutes, TMethod> = RoutesWithMethod<TRoutes, TMethod>>(path: TPath, options: {
+        method?: TMethod;
+        formdata: FormData;
+    }): Promise<ApiResponse<ResponseType<TRoutes, TPath, TMethod>>>;
 }
 export { ApiClient };
 export default ApiClient;

package/dist/lib/core/client/index.js

@@ -25,17 +25,25 @@ var __importStar = (this && this.__importStar) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ApiClient = void 0;
 let fetchFn = null;
-async function getFetch() {
+const getFetch = async () => {
     if (fetchFn)
         return fetchFn;
-    if (globalThis.fetch) {
-        fetchFn = globalThis.fetch;
+    // Browser OR modern Node v18+ (preferred)
+    if (typeof globalThis.fetch === "function") {
+        fetchFn = globalThis.fetch.bind(globalThis);
         return fetchFn;
     }
+    // Legacy Node fallback
     const mod = await Promise.resolve().then(() => __importStar(require("node-fetch")));
     fetchFn = mod.default;
     return fetchFn;
-}
+};
+const isFormData = (value) => {
+    return (value != null &&
+        typeof value === "object" &&
+        typeof value.append === "function" &&
+        typeof value.getHeaders === "function");
+};
 /**
  * Type-safe HTTP client built on top of the native Fetch API.
  *
@@ -67,7 +75,8 @@ async function getFetch() {
  * })
  *
  * // fully typed response
- * console.log(res.cats)
+ * if(res.ok)
+ *  console.log(res.cats)
  * ```
  */
 class ApiClient {
@@ -92,50 +101,62 @@ class ApiClient {
         if (!fetchFn) {
             throw new Error("Fetch is not available. Use Node 18+ or polyfill.");
         }
+        let body = input?.body
+            ? JSON.stringify(input.body)
+            : undefined;
+        let headers = {
+            "Content-Type": "application/json",
+        };
+        const isFileUpload = isFormData(input?.body);
+        if (isFileUpload) {
+            body = input?.body;
+            headers = undefined;
+        }
         const res = await fetchFn(url, {
             method: method,
-            headers: {
-                "Content-Type": "application/json",
-            },
-            body: input?.body
-                ? JSON.stringify(input.body)
-                : undefined,
+            headers,
+            body
         });
         const contentType = res.headers.get("content-type");
         const isJson = contentType?.includes("application/json");
         const data = isJson
             ? await res.json()
             : await res.text();
-        // if (!res.ok) {
-        //   throw new Error(
-        //     data?.message ||
-        //       data?.error ||
-        //       (typeof data === "string"
-        //         ? data
-        //         : `HTTP ${res.status}`),
-        //   );
-        // }
         return {
             ok: res.ok,
+            headers: res.headers,
             status: res.status,
-            data,
+            data: data,
         };
     }
-    async get(path, input) {
+    async get(path, ...args) {
+        const input = args[0];
         return this.request("GET", path, input);
     }
-    async post(path, input) {
+    async post(path, ...args) {
+        const input = args[0];
         return this.request("POST", path, input);
     }
-    async put(path, input) {
+    async put(path, ...args) {
+        const input = args[0];
         return this.request("PUT", path, input);
     }
-    async patch(path, input) {
+    async patch(path, ...args) {
+        const input = args[0];
         return this.request("PATCH", path, input);
     }
-    async delete(path, input) {
+    async delete(path, ...args) {
+        const input = args[0];
         return this.request("DELETE", path, input);
     }
+    async upload(path, options) {
+        const { method = "POST", formdata } = options;
+        return this.request(method, path, 
+        //@ts-ignore
+        {
+            body: formdata
+        });
+    }
 }
 exports.ApiClient = ApiClient;
 exports.default = ApiClient;

package/dist/lib/core/client/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/lib/core/client/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAmCA,IAAI,OAAO,GAAwB,IAAI,CAAC;AAExC,KAAK,UAAU,QAAQ;IACrB,IAAI,OAAO;QAAE,OAAO,OAAO,CAAC;IAE5B,IAAI,UAAU,CAAC,KAAK,EAAE,CAAC;QACrB,OAAO,GAAG,UAAU,CAAC,KAAK,CAAC;QAC3B,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,MAAM,GAAG,GAAG,wDAAa,YAAY,GAAC,CAAC;IACvC,OAAO,GAAG,GAAG,CAAC,OAAkC,CAAC;IAEjD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAM,SAAS;IAGL,OAAO,CAAS;IAExB,YAAY,OAAe;QACzB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAES,KAAK,CAAC,OAAO,CAIrB,MAAe,EACf,IAAW,EACX,KAIC;QAWC,IAAI,GAAG,GAAG,IAAI,CAAC,OAAO,GAAI,IAAe,CAAA;QAGzC,IAAI,KAAK,EAAE,MAAM,EAAE,CAAC;YAClB,KAAK,MAAM,GAAG,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;gBAC/B,GAAG,GAAG,GAAG,CAAC,OAAO,CACf,IAAI,GAAG,EAAE,EACT,kBAAkB,CAAE,KAAK,CAAC,MAAc,CAAC,GAAG,CAAC,CAAC,CAC/C,CAAA;YACH,CAAC;QACH,CAAC;QAED,IAAI,KAAK,EAAE,KAAK,EAAE,CAAC;YACjB,MAAM,WAAW,GAAG,IAAI,eAAe,CACrC,KAAK,CAAC,KAAY,CACnB,CAAC,QAAQ,EAAE,CAAA;YAEZ,IAAI,WAAW,EAAE,CAAC;gBAChB,GAAG,IAAI,IAAI,WAAW,EAAE,CAAA;YAC1B,CAAC;QACH,CAAC;QAEH,OAAO,GAAG,MAAM,QAAQ,EAAE,CAAC;QAE3B,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;QACvE,CAAC;QAED,MAAM,GAAG,GAAG,MAAM,OAAO,CAAC,GAAG,EAAE;YAC7B,MAAM,EAAE,MAAgB;YAExB,OAAO,EAAE;gBACP,cAAc,EACZ,kBAAkB;aACrB;YAED,IAAI,EAAE,KAAK,EAAE,IAAI;gBACf,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC;gBAC5B,CAAC,CAAC,SAAS;SACd,CAAC,CAAC;QAEH,MAAM,WAAW,GACf,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QAElC,MAAM,MAAM,GACV,WAAW,EAAE,QAAQ,CACnB,kBAAkB,CACnB,CAAC;QAEJ,MAAM,IAAI,GAAG,MAAM;YACjB,CAAC,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE;YAClB,CAAC,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC;QAErB,iBAAiB;QACjB,qBAAqB;QACrB,uBAAuB;QACvB,uBAAuB;QACvB,kCAAkC;QAClC,iBAAiB;QACjB,mCAAmC;QACnC,OAAO;QACP,IAAI;QAEJ,OAAO;YACL,EAAE,EAAG,GAAG,CAAC,EAAE;YACX,MAAM,EAAE,GAAG,CAAC,MAAM;YAClB,IAAI;SACL,CAAA;IACH,CAAC;IAEM,KAAK,CAAC,GAAG,CAMd,IAAW,EACX,KAIC;QAED,OAAO,IAAI,CAAC,OAAO,CACjB,KAAK,EACL,IAAI,EACJ,KAAK,CACN,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,IAAI,CAMf,IAAW,EACX,KAIC;QAED,OAAO,IAAI,CAAC,OAAO,CACjB,MAAM,EACN,IAAI,EACJ,KAAK,CACN,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,GAAG,CAMd,IAAW,EACX,KAIC;QAED,OAAO,IAAI,CAAC,OAAO,CACjB,KAAK,EACL,IAAI,EACJ,KAAK,CACN,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,KAAK,CAMhB,IAAW,EACX,KAIC;QAED,OAAO,IAAI,CAAC,OAAO,CACjB,OAAO,EACP,IAAI,EACJ,KAAK,CACN,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,MAAM,CAMjB,IAAW,EACX,KAIC;QAED,OAAO,IAAI,CAAC,OAAO,CACjB,QAAQ,EACR,IAAI,EACJ,KAAK,CACN,CAAC;IACJ,CAAC;CACF;AAEQ,8BAAS;AAClB,kBAAe,SAAS,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/lib/core/client/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AASA,IAAI,OAAO,GAAwB,IAAI,CAAC;AAExC,MAAM,QAAQ,GAAG,KAAK,IAAI,EAAE;IAC1B,IAAI,OAAO;QAAE,OAAO,OAAO,CAAC;IAE5B,0CAA0C;IAC1C,IAAI,OAAO,UAAU,CAAC,KAAK,KAAK,UAAU,EAAE,CAAC;QAC3C,OAAO,GAAG,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC5C,OAAO,OAAO,CAAC;IACjB,CAAC;IAED,uBAAuB;IACvB,MAAM,GAAG,GAAG,wDAAa,YAAY,GAAC,CAAC;IACvC,OAAO,GAAG,GAAG,CAAC,OAAkC,CAAC;IAEjD,OAAO,OAAO,CAAC;AACjB,CAAC,CAAC;AAEF,MAAM,UAAU,GAAG,CAAC,KAAc,EAAW,EAAE;IAC7C,OAAO,CACL,KAAK,IAAI,IAAI;QACb,OAAO,KAAK,KAAK,QAAQ;QACzB,OAAQ,KAAa,CAAC,MAAM,KAAK,UAAU;QAC3C,OAAQ,KAAa,CAAC,UAAU,KAAK,UAAU,CAChD,CAAC;AACJ,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAM,SAAS;IAGL,OAAO,CAAS;IAExB,YAAY,OAAe;QACzB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;IACzB,CAAC;IAEO,KAAK,CAAC,OAAO,CAInB,MAAe,EACf,IAAW,EACX,KAIC;QAWC,IAAI,GAAG,GAAG,IAAI,CAAC,OAAO,GAAI,IAAe,CAAA;QAGzC,IAAI,KAAK,EAAE,MAAM,EAAE,CAAC;YAClB,KAAK,MAAM,GAAG,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;gBAC/B,GAAG,GAAG,GAAG,CAAC,OAAO,CACf,IAAI,GAAG,EAAE,EACT,kBAAkB,CAAE,KAAK,CAAC,MAAc,CAAC,GAAG,CAAC,CAAC,CAC/C,CAAA;YACH,CAAC;QACH,CAAC;QAED,IAAI,KAAK,EAAE,KAAK,EAAE,CAAC;YACjB,MAAM,WAAW,GAAG,IAAI,eAAe,CACrC,KAAK,CAAC,KAAY,CACnB,CAAC,QAAQ,EAAE,CAAA;YAEZ,IAAI,WAAW,EAAE,CAAC;gBAChB,GAAG,IAAI,IAAI,WAAW,EAAE,CAAA;YAC1B,CAAC;QACH,CAAC;QAEH,OAAO,GAAG,MAAM,QAAQ,EAAE,CAAC;QAE3B,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;QACvE,CAAC;QAED,IAAI,IAAI,GAAQ,KAAK,EAAE,IAAI;YACzB,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,CAAC;YAC5B,CAAC,CAAC,SAAS,CAAA;QAEb,IAAI,OAAO,GAAQ;YACjB,cAAc,EACZ,kBAAkB;SACrB,CAAA;QAED,MAAM,YAAY,GAAG,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QAE7C,IAAG,YAAY,EAAE,CAAC;YAChB,IAAI,GAAG,KAAK,EAAE,IAAI,CAAC;YACnB,OAAO,GAAG,SAAS,CAAC;QACtB,CAAC;QAED,MAAM,GAAG,GAAG,MAAM,OAAO,CAAC,GAAG,EAAE;YAC7B,MAAM,EAAE,MAAgB;YACxB,OAAO;YACP,IAAI;SACL,CAAC,CAAC;QAEH,MAAM,WAAW,GACf,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,CAAC;QAElC,MAAM,MAAM,GACV,WAAW,EAAE,QAAQ,CACnB,kBAAkB,CACnB,CAAC;QAEJ,MAAM,IAAI,GAAG,MAAM;YACjB,CAAC,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE;YAClB,CAAC,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAAC;QAErB,OAAO;YACL,EAAE,EAAQ,GAAG,CAAC,EAAE;YAChB,OAAO,EAAG,GAAG,CAAC,OAAO;YACrB,MAAM,EAAI,GAAG,CAAC,MAAa;YAC3B,IAAI,EAAM,IAAI;SACf,CAAA;IACH,CAAC;IAEM,KAAK,CAAC,GAAG,CAMd,IAAW,EACX,GAAG,IAA0D;QAE7D,MAAM,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QACtB,OAAO,IAAI,CAAC,OAAO,CACjB,KAAK,EACL,IAAI,EACJ,KAAK,CACN,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,IAAI,CAMf,IAAW,EACX,GAAG,IAA2D;QAE9D,MAAM,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QAEtB,OAAO,IAAI,CAAC,OAAO,CACjB,MAAM,EACN,IAAI,EACJ,KAAK,CACN,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,GAAG,CAMd,IAAW,EACX,GAAG,IAA0D;QAE7D,MAAM,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QAEtB,OAAO,IAAI,CAAC,OAAO,CACjB,KAAK,EACL,IAAI,EACJ,KAAK,CACN,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,KAAK,CAMhB,IAAW,EACX,GAAG,IAA4D;QAE/D,MAAM,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QAEtB,OAAO,IAAI,CAAC,OAAO,CACjB,OAAO,EACP,IAAI,EACJ,KAAK,CACN,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,MAAM,CAMjB,IAAW,EACX,GAAG,IAA6D;QAEhE,MAAM,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QAEtB,OAAO,IAAI,CAAC,OAAO,CACjB,QAAQ,EACR,IAAI,EACJ,KAAK,CACN,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,MAAM,CAIjB,IAAW,EACX,OAGC;QAED,MAAM,EAAE,MAAM,GAAG,MAAiB,EAAE,QAAQ,EAAE,GAAG,OAAO,CAAC;QAEzD,OAAO,IAAI,CAAC,OAAO,CACjB,MAAM,EACN,IAAI;QACJ,YAAY;QACZ;YACE,IAAI,EAAG,QAAQ;SAChB,CACF,CAAC;IACJ,CAAC;CAEF;AAEQ,8BAAS;AAClB,kBAAe,SAAS,CAAC"}

package/dist/lib/core/{compiler → client}/types.d.ts

@@ -12,3 +12,32 @@ export type RequestFiles<TRoutes extends AnyRoutes, TPath extends keyof TRoutes,
 export type ResponseType<TRoutes extends AnyRoutes, TPath extends keyof TRoutes, TMethod extends keyof TRoutes[TPath]> = TRoutes[TPath][TMethod] extends {
     response: infer R;
 } ? Awaited<R> : never;
+export type Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};
+export type ExactProperty<Key extends string, T> = [
+    T
+] extends [never] ? {
+    [K in Key]?: never;
+} : undefined extends T ? {
+    [K in Key]?: T;
+} : {} extends T ? {
+    [K in Key]?: T;
+} : {
+    [K in Key]: T;
+};
+export type OptionalIfEmpty<T> = {} extends T ? [input?: T] : [input: T];
+export type RequestInput<TRoutes extends AnyRoutes, TPath extends keyof TRoutes, TMethod extends keyof TRoutes[TPath]> = Prettify<ExactProperty<"params", RequestParams<TRoutes, TPath, TMethod>> & ExactProperty<"query", RequestQuery<TRoutes, TPath, TMethod>> & ExactProperty<"body", RequestBody<TRoutes, TPath, TMethod>> & ExactProperty<"files", RequestFiles<TRoutes, TPath, TMethod>>>;
+export type SuccessStatus = 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 208 | 226;
+export type ErrorStatus = 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 421 | 422 | 423 | 424 | 425 | 426 | 428 | 429 | 431 | 451 | 500 | 501 | 502 | 503 | 504 | 505 | 506 | 507 | 508 | 510 | 511;
+export type ApiResponse<T, E = any> = {
+    ok: true;
+    status: SuccessStatus;
+    headers: Headers;
+    data: T;
+} | {
+    ok: false;
+    status: ErrorStatus;
+    headers: Headers;
+    data: E;
+};

package/dist/lib/core/client/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/lib/core/client/types.ts"],"names":[],"mappings":""}

package/dist/lib/core/compiler/generator.d.ts

@@ -1,18 +1,16 @@
 type Route = {
     method: string;
     path: string;
-    response: string;
     body: string;
     params: string;
     query: string;
     files: string;
+    response: string;
 };
 type Options = {
-    controllers: {
-        folder: string;
-        name: RegExp;
-    };
+    folder: string;
+    name: RegExp;
     output?: string;
 };
-export declare function generateRoutes(options: Options): Promise<Route[] | undefined>;
+export declare const generateRoutes: (globalPrefix: string, options: Options) => Promise<Route[] | undefined>;
 export {};

package/dist/lib/core/compiler/generator.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.generateRoutes = generateRoutes;
+exports.generateRoutes = void 0;
 const ts_morph_1 = require("ts-morph");
 const typescript_1 = __importDefault(require("typescript"));
 const fs_1 = __importDefault(require("fs"));
@@ -17,15 +17,30 @@ const HTTP_METHODS = {
     Options: "OPTIONS",
     Head: "HEAD",
 };
-function normalizePath(p) {
+const normalizeType = (t) => {
+    return t
+        .split("|")
+        .map(v => v.trim())
+        .filter(v => v !== "null" &&
+        v !== "undefined")[0] || "string";
+};
+const maybeObject = (v) => {
+    const s = v.trim();
+    return s.startsWith("{") && s.endsWith("}");
+};
+const maybeArrayObject = (v) => {
+    const s = v.trim();
+    return s.endsWith("}[]");
+};
+const normalizePath = (p) => {
     return ("/" +
         p
             .replace(/['"`]/g, "")
             .replace(/\/+/g, "/")
             .replace(/\/$/, "")
             .replace(/^\//, ""));
-}
-function splitTopLevel(input) {
+};
+const splitTopLevel = (input) => {
     const parts = [];
     let current = "";
     let depth = 0;
@@ -45,11 +60,11 @@ function splitTopLevel(input) {
         parts.push(current.trim());
     }
     return parts;
-}
-function parseType(type) {
+};
+const parseType = (type) => {
     type = type.trim();
     if (type === "never") {
-        return null;
+        return undefined;
     }
     if (type.startsWith("Record<")) {
         return {};
@@ -121,6 +136,8 @@ function parseType(type) {
         return "boolean";
     if (type === "date")
         return "date";
+    if (type === "Date")
+        return "Date";
     if (type === "string | undefined")
         return "string";
     if (type === "number | undefined")
@@ -129,6 +146,8 @@ function parseType(type) {
         return "boolean";
     if (type === "date | undefined")
         return "date";
+    if (type === "Date | undefined")
+        return "Date";
     if (type.includes("| undefined")) {
         return type;
     }
@@ -139,11 +158,9 @@ function parseType(type) {
         return type.replace(/"/g, "");
     }
     // fallback
-    return {
-        $ref: type
-    };
-}
-function resolveType(type) {
+    return "string";
+};
+const resolveType = (type) => {
     if (type.getSymbol()?.getName() === "Promise") {
         type = type.getTypeArguments()[0];
     }
@@ -161,8 +178,28 @@ function resolveType(type) {
         return "any";
     if (type.isUnknown())
         return "unknown";
-    if (type.isStringLiteral())
+    if (type.isStringLiteral() ||
+        type.isBooleanLiteral() ||
+        type.isNumberLiteral())
         return type.getText();
+    if (type.getText() === 'Date' &&
+        type.getSymbol()?.getName() === 'Date') {
+        return "Date";
+    }
+    if (type.getText().includes("ServerResponse") &&
+        type.getText().includes("THttpResponder")) {
+        const filtered = type
+            .getIntersectionTypes()
+            .filter((t) => {
+            const text = t.getText();
+            return (!text.includes("ServerResponse") &&
+                !text.includes("THttpResponder"));
+        });
+        const t = filtered[0];
+        if (t == null)
+            return 'never';
+        return resolveType(t);
+    }
     if (type.isUnion()) {
         const text = type.getText();
         if (text.includes('| null') || text.includes('| undefined')) {
@@ -185,8 +222,8 @@ function resolveType(type) {
         const el = type.getArrayElementTypeOrThrow();
         return `${resolveType(el)}[]`;
     }
-    const props = type.getProperties();
-    if (props.length) {
+    if (type.getProperties().length) {
+        const props = type.getProperties();
         const obj = [];
         for (const prop of props) {
             const decl = prop.getDeclarations()[0];
@@ -214,8 +251,8 @@ function resolveType(type) {
         return `{ ${obj.join("; ")} }`;
     }
     return type.getText();
-}
-function extractPropertyType(type, key, node) {
+};
+const extractPropertyType = (type, key, node) => {
     const prop = type.getProperty(key);
     if (!prop)
         return "never";
@@ -226,12 +263,12 @@ function extractPropertyType(type, key, node) {
     if (!text || text.includes("undefined"))
         return "never";
     return resolveType(t) ?? "never";
-}
-async function generateRoutes(options) {
+};
+const generateRoutes = async (globalPrefix, options) => {
     const project = new ts_morph_1.Project({
         tsConfigFilePath: path_1.default.resolve(process.cwd(), "tsconfig.json"),
     });
-    project.addSourceFilesAtPaths(path_1.default.join(options.controllers.folder, "**/*"));
+    project.addSourceFilesAtPaths(path_1.default.join(options.folder, "**/*"));
     const files = project.getSourceFiles();
     if (!files.length) {
         console.log("No controller files found");
@@ -240,7 +277,7 @@ async function generateRoutes(options) {
     const routes = [];
     for (const file of files) {
         const filename = file.getBaseName();
-        if (!options.controllers.name.test(filename))
+        if (!options.name.test(filename))
             continue;
         for (const cls of file.getClasses()) {
             const controller = cls.getDecorator("Controller");
@@ -267,10 +304,12 @@ async function generateRoutes(options) {
                     const firstParam = method.getParameters()[0];
                     if (firstParam) {
                         const type = firstParam.getType();
-                        body = extractPropertyType(type, "body", firstParam);
                         params = extractPropertyType(type, "params", firstParam);
                         query = extractPropertyType(type, "query", firstParam);
+                        body = extractPropertyType(type, "body", firstParam);
                         files = extractPropertyType(type, "files", firstParam);
+                        if (body === 'Record<string, any>')
+                            body = "never";
                     }
                     routes.push({
                         method: http,
@@ -279,7 +318,7 @@ async function generateRoutes(options) {
                         body,
                         params,
                         query,
-                        files,
+                        files
                     });
                 }
             }
@@ -313,9 +352,93 @@ async function generateRoutes(options) {
   }`;
     })
         .join("\n");
-    const formatValue = (v) => {
-        if (typeof v === "string")
-            return `"${v.replace(/"/g, '')}"`;
+    const formatExampleValue = (v) => {
+        if (v === null) {
+            return "null";
+        }
+        if (v === undefined) {
+            return "undefined";
+        }
+        if (typeof v === "string") {
+            const t = normalizeType(v.trim());
+            if (maybeObject(t)) {
+                const inner = t.trim().slice(1, -1);
+                const result = Object.fromEntries(splitTopLevel(inner)
+                    .map(s => s.trim())
+                    .filter(Boolean)
+                    .map(pair => {
+                    const idx = pair.indexOf(":");
+                    const key = pair.slice(0, idx).trim();
+                    const type = pair.slice(idx + 1).trim();
+                    return [key.replace(/\?/g, ''), type];
+                }));
+                return formatExampleValue(result);
+            }
+            if (maybeArrayObject(t)) {
+                const s = v.trim();
+                const output = s.replace(/(\w+):\s*(\{[^}]+\})\[\]/, '$1: [$2]').match(/\{(.*)\}/)?.[1];
+                if (!output)
+                    return `[]`;
+                const result = Object.fromEntries(splitTopLevel(output)
+                    .map(s => s.trim())
+                    .filter(Boolean)
+                    .map(pair => {
+                    const idx = pair.indexOf(":");
+                    const key = pair.slice(0, idx).trim();
+                    const type = pair.slice(idx + 1).trim();
+                    return [key, type];
+                }));
+                return formatExampleValue(result);
+            }
+            switch (t) {
+                case "string":
+                    return `"example"`;
+                case "string[]":
+                    return `["example1", "example2", "example3"]`;
+                case "number":
+                    return "123";
+                case "number[]":
+                    return "[1 ,2, 3]";
+                case "boolean":
+                    return "true";
+                case "boolean[]":
+                    return "[true, false, true]";
+                case "null":
+                    return "null";
+                case "null[]":
+                    return "[null, null, null]";
+                case "undefined":
+                    return "undefined";
+                case "undefined[]":
+                    return "[undefined, undefined, undefined]";
+                case "date":
+                case "Date":
+                    return `"2000-01-01T00:00:00.000Z"`;
+                case "date[]":
+                case "Date[]":
+                    return `["2000-01-01T00:00:00.000Z","2000-01-02T00:00:00.000Z","2000-01-03T00:00:00.000Z"]`;
+                default:
+                    return `"${t.replace(/"/g, "")}"`;
+            }
+        }
+        if (Array.isArray(v)) {
+            if (v.length === 0) {
+                return "[]";
+            }
+            return `[${formatExampleValue(v[0])}]`;
+        }
+        if (typeof v === "object") {
+            const entries = Object.entries(v).map(([key, value]) => {
+                if (key.includes("uuid")) {
+                    return `${key}: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"`;
+                }
+                if (key === "id" || key.endsWith("id")) {
+                    return `${key}: 123`;
+                }
+                return `${key}: ${formatExampleValue(value)}`;
+            });
+            return `{ ${entries.map(v => `${v}`).join(", ")} }`;
+        }
         return JSON.stringify(v);
     };
     const groupedValues = routes.reduce((acc, route) => {
@@ -336,11 +459,11 @@ async function generateRoutes(options) {
         const methodBlock = Object.entries(methods)
             .map(([method, c]) => `
     ${method}: {
-      params: ${formatValue(c.params)},
-      query: ${formatValue(c.query)},
-      body: ${formatValue(c.body)},
-      files: ${formatValue(c.files)},
-      response: ${formatValue(c.response)}
+      params: ${formatExampleValue(c.params)},
+      query: ${formatExampleValue(c.query)},
+      body: ${formatExampleValue(c.body)},
+      files: ${formatExampleValue(c.files)},
+      response: ${formatExampleValue(c.response)}
     }`).join(",\n");
         return `
   "${path}": {
@@ -352,16 +475,20 @@ async function generateRoutes(options) {
 // @ts-nocheck
 // AUTO GENERATED FILE
 // DO NOT EDIT
+// **Response values shown here are examples only.
+${globalPrefix ?
+        `// **The App is using the configuration:
+// globalPrefix: '${globalPrefix}'` : ''}
 
 export const appRoutes = {
 ${routerMapValues}
-}
+};
 
 export interface AppRoutes {
 ${routeMapTypes}
-}
+};
 
-export type AppRoute = keyof AppRoutes
+export type AppRoute = keyof AppRoutes;
 `;
     const outPath = options.output
         ? `${__dirname}/${options.output}/pre-routes.ts`
@@ -369,15 +496,17 @@ export type AppRoute = keyof AppRoutes
     await fs_1.default.promises.mkdir(path_1.default.dirname(outPath), {
         recursive: true,
     });
-    await fs_1.default.promises.writeFile(outPath, output);
     const compiled = typescript_1.default.transpileModule(output, {
         compilerOptions: {
             module: typescript_1.default.ModuleKind.CommonJS,
-            target: typescript_1.default.ScriptTarget.ES2020,
+            target: typescript_1.default.ScriptTarget.ESNext
         },
     });
-    const jsPath = outPath.replace(/\.ts$/, ".js");
-    await fs_1.default.promises.writeFile(jsPath, compiled.outputText, "utf8");
+    await Promise.all([
+        fs_1.default.promises.writeFile(outPath, output),
+        fs_1.default.promises.writeFile(outPath.replace(/\.ts$/, ".js"), compiled.outputText)
+    ]);
     return routes;
-}
+};
+exports.generateRoutes = generateRoutes;
 //# sourceMappingURL=generator.js.map