npm - @codexsploitx/schemaapi - Versions diffs - 1.0.0 → 1.0.1 - Mend

@codexsploitx/schemaapi 1.0.0 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (50) hide show

package/package.json +1 -1
package/docs/adapters/deno.md +0 -51
package/docs/adapters/express.md +0 -67
package/docs/adapters/fastify.md +0 -64
package/docs/adapters/hapi.md +0 -67
package/docs/adapters/koa.md +0 -61
package/docs/adapters/nest.md +0 -66
package/docs/adapters/next.md +0 -66
package/docs/adapters/remix.md +0 -72
package/docs/cli.md +0 -18
package/docs/consepts.md +0 -18
package/docs/getting_started.md +0 -149
package/docs/sdk.md +0 -25
package/docs/validation.md +0 -228
package/docs/versioning.md +0 -28
package/eslint.config.mjs +0 -34
package/rollup.config.js +0 -19
package/src/adapters/deno.ts +0 -139
package/src/adapters/express.ts +0 -134
package/src/adapters/fastify.ts +0 -133
package/src/adapters/hapi.ts +0 -140
package/src/adapters/index.ts +0 -9
package/src/adapters/koa.ts +0 -128
package/src/adapters/nest.ts +0 -122
package/src/adapters/next.ts +0 -175
package/src/adapters/remix.ts +0 -145
package/src/adapters/ws.ts +0 -132
package/src/core/client.ts +0 -104
package/src/core/contract.ts +0 -534
package/src/core/versioning.test.ts +0 -174
package/src/docs.ts +0 -535
package/src/index.ts +0 -5
package/src/playground.test.ts +0 -98
package/src/playground.ts +0 -13
package/src/sdk.ts +0 -17
package/tests/adapters.deno.test.ts +0 -70
package/tests/adapters.express.test.ts +0 -67
package/tests/adapters.fastify.test.ts +0 -63
package/tests/adapters.hapi.test.ts +0 -66
package/tests/adapters.koa.test.ts +0 -58
package/tests/adapters.nest.test.ts +0 -85
package/tests/adapters.next.test.ts +0 -39
package/tests/adapters.remix.test.ts +0 -52
package/tests/adapters.ws.test.ts +0 -91
package/tests/cli.test.ts +0 -156
package/tests/client.test.ts +0 -110
package/tests/contract.handle.test.ts +0 -267
package/tests/docs.test.ts +0 -96
package/tests/sdk.test.ts +0 -34
package/tsconfig.json +0 -15

package/tests/cli.test.ts DELETED Viewed

@@ -1,156 +0,0 @@
-import { describe, it, expect } from "vitest";
-import childProcess from "child_process";
-import path from "path";
-import fs from "fs";
-import os from "os";
-declare const __dirname: string;
-type CliResult = {
-  stdout: string;
-  stderr: string;
-  code: number | null;
-};
-function runCli(args: string[]): Promise<CliResult> {
-  return new Promise((resolve, reject) => {
-    const binPath = path.join(__dirname, "..", "bin", "schemaapi");
-    childProcess.execFile("node", [binPath, ...args], (error: unknown, stdout: unknown, stderr: unknown) => {
-      const stdoutText = String(stdout ?? "");
-      const stderrText = String(stderr ?? "");
-      if (error && (error as { code?: number }).code !== 0) {
-        const code = (error as { code?: number }).code ?? 1;
-        resolve({ stdout: stdoutText, stderr: stderrText, code });
-        return;
-      }
-      resolve({ stdout: stdoutText, stderr: stderrText, code: 0 });
-    });
-  });
-}
-function runCliInDir(args: string[], cwd: string): Promise<CliResult> {
-  return new Promise((resolve, reject) => {
-    const binPath = path.join(__dirname, "..", "bin", "schemaapi");
-    childProcess.execFile(
-      "node",
-      [binPath, ...args],
-      { cwd },
-      (error: unknown, stdout: unknown, stderr: unknown) => {
-        const stdoutText = String(stdout ?? "");
-        const stderrText = String(stderr ?? "");
-        if (error && (error as { code?: number }).code !== 0) {
-          const code = (error as { code?: number }).code ?? 1;
-          resolve({ stdout: stdoutText, stderr: stderrText, code });
-          return;
-        }
-        resolve({ stdout: stdoutText, stderr: stderrText, code: 0 });
-      }
-    );
-  });
-}
-describe("CLI schemaapi", () => {
-  it("muestra ayuda cuando no se pasan argumentos", async () => {
-    const result = await runCli([]);
-    expect(result.code).toBe(0);
-    expect(result.stdout).toContain("SchemaApi CLI");
-    expect(result.stdout).toContain("Usage:");
-    expect(result.stdout).toContain("schemaapi generate docs");
-  });
-  it("ejecuta generate docs", async () => {
-    const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), "schemaapi-generate-docs-"));
-    const contractsDir = path.join(tmpDir, "contracts");
-    fs.mkdirSync(contractsDir, { recursive: true });
-    const indexPath = path.join(contractsDir, "index.js");
-    const indexContent = [
-      "const exampleContract = {",
-      "  docs() {",
-      "    return { routes: [",
-      '      { method: "GET", path: "/users", params: [], query: [], body: [], headers: [], errors: [] },',
-      "    ] };",
-      "  },",
-      "};",
-      "module.exports = { exampleContract };",
-      "",
-    ].join("\n");
-    fs.writeFileSync(indexPath, indexContent, "utf8");
-    const configPath = path.join(tmpDir, "schemaapi.config.json");
-    const config = {
-      adapter: "express",
-      contractsDir: "contracts",
-    };
-    fs.writeFileSync(configPath, JSON.stringify(config, null, 2));
-    const result = await runCliInDir(["generate", "docs"], tmpDir);
-    expect(result.code).toBe(0);
-    expect(result.stdout).toContain("Generating docs from contract");
-    expect(result.stdout).toContain("Docs generated at:");
-    const outDir = path.join(tmpDir, "schemaapi-docs");
-    const outFile = path.join(outDir, "index.html");
-    expect(fs.existsSync(outDir)).toBe(true);
-    expect(fs.existsSync(outFile)).toBe(true);
-    const html = fs.readFileSync(outFile, "utf8");
-    expect(html).toContain("<!doctype html>");
-    expect(html).toContain("/users");
-  });
-  it("ejecuta generate sdk", async () => {
-    const result = await runCli(["generate", "sdk"]);
-    expect(result.code).toBe(0);
-    expect(result.stdout).toContain("Generating SDK from contract");
-  });
-  it("ejecuta generate tests", async () => {
-    const result = await runCli(["generate", "tests"]);
-    expect(result.code).toBe(0);
-    expect(result.stdout).toContain("Generating tests from contract");
-  });
-  it("ejecuta audit", async () => {
-    const result = await runCli(["audit"]);
-    expect(result.code).toBe(0);
-    expect(result.stdout.trim()).toBe("Running SchemaApi audit");
-  });
-  it("devuelve error para comando generate desconocido", async () => {
-    const result = await runCli(["generate", "unknown"]);
-    expect(result.code).not.toBe(0);
-    expect(result.stderr).toContain("Unknown generate target: unknown");
-  });
-  it("devuelve error para comando desconocido", async () => {
-    const result = await runCli(["unknown"]);
-    expect(result.code).not.toBe(0);
-    expect(result.stderr).toContain("Unknown command: unknown");
-    expect(result.stdout).toContain("SchemaApi CLI");
-  });
-  it("init next crea estructura de contratos y config", async () => {
-    const tmpDir = fs.mkdtempSync(path.join(os.tmpdir(), "schemaapi-init-next-"));
-    const result = await runCliInDir(["init", "next"], tmpDir);
-    expect(result.code).toBe(0);
-    expect(result.stdout).toContain("SchemaApi init completed");
-    const contractsDir = path.join(tmpDir, "contracts");
-    expect(fs.existsSync(contractsDir)).toBe(true);
-    const usersContractPath = path.join(contractsDir, "usersContract.ts");
-    expect(fs.existsSync(usersContractPath)).toBe(true);
-    const usersContent = fs.readFileSync(usersContractPath, "utf8");
-    expect(usersContent).toContain("createContract");
-    const configPath = path.join(tmpDir, "schemaapi.config.json");
-    expect(fs.existsSync(configPath)).toBe(true);
-    const parsed = JSON.parse(fs.readFileSync(configPath, "utf8"));
-    expect(parsed.adapter).toBe("next");
-    expect(parsed.contractsDir).toBe("contracts");
-  });
-});

package/tests/client.test.ts DELETED Viewed

@@ -1,110 +0,0 @@
-import { describe, it, expect, vi } from "vitest";
-import { createClient } from "../src/core/client";
-describe("createClient - SDK básico", () => {
-  it("construye correctamente GET con path params y query", async () => {
-    const fetchMock = vi.fn().mockResolvedValue({
-      ok: true,
-      status: 200,
-      statusText: "OK",
-      json: async () => ({ id: "123" }),
-    } as Response);
-    const client = createClient(
-      { schema: {} as unknown },
-      { baseUrl: "https://api.mysite.com", fetch: fetchMock as any }
-    );
-    const result = await client.users.get({
-      id: "123",
-      includePosts: true,
-      headers: { Authorization: "Bearer token" },
-    });
-    expect(result).toEqual({ id: "123" });
-    expect(fetchMock).toHaveBeenCalledTimes(1);
-    const [url, options] = fetchMock.mock.calls[0];
-    expect(url).toBe("https://api.mysite.com/users/123?includePosts=true");
-    expect(options.method).toBe("GET");
-    expect(options.headers).toMatchObject({
-      "Content-Type": "application/json",
-      Authorization: "Bearer token",
-    });
-    expect(options.body).toBeUndefined();
-  });
-  it("construye correctamente PUT con body", async () => {
-    const fetchMock = vi.fn().mockResolvedValue({
-      ok: true,
-      status: 200,
-      statusText: "OK",
-      json: async () => ({ success: true }),
-    } as Response);
-    const client = createClient(
-      { schema: {} as unknown },
-      { baseUrl: "https://api.mysite.com", fetch: fetchMock as any }
-    );
-    const result = await client.users.put({
-      id: "123",
-      body: { username: "ferum" },
-    });
-    expect(result).toEqual({ success: true });
-    const [url, options] = fetchMock.mock.calls[0];
-    expect(url).toBe("https://api.mysite.com/users/123");
-    expect(options.method).toBe("PUT");
-    expect(options.body).toBe(JSON.stringify({ username: "ferum" }));
-  });
-  it("lanza error si la respuesta HTTP no es ok", async () => {
-    const fetchMock = vi.fn().mockResolvedValue({
-      ok: false,
-      status: 500,
-      statusText: "Server Error",
-      json: async () => ({}),
-    } as Response);
-    const client = createClient(
-      { schema: {} as unknown },
-      { baseUrl: "https://api.mysite.com", fetch: fetchMock as any }
-    );
-    await expect(
-      client.users.get({ id: "123" })
-    ).rejects.toThrow("Request failed: 500 Server Error");
-  });
-  it("construye conexión WS correctamente", async () => {
-    const wsInstance = {
-      close: vi.fn(),
-    };
-    const WebSocketSpy = vi.fn();
-    class MockWebSocket {
-        constructor(url: string) {
-            WebSocketSpy(url);
-            return wsInstance;
-        }
-    }
-    const client = createClient(
-      { schema: {} as unknown },
-      { baseUrl: "https://api.mysite.com", WebSocket: MockWebSocket as any }
-    );
-    const ws = await client.chat.ws({
-      roomId: "lobby",
-      token: "abc"
-    });
-    expect(ws).toBe(wsInstance);
-    expect(WebSocketSpy).toHaveBeenCalledTimes(1);
-    expect(WebSocketSpy).toHaveBeenCalledWith(
-      "wss://api.mysite.com/chat?roomId=lobby&token=abc"
-    );
-  });
-});

package/tests/contract.handle.test.ts DELETED Viewed

@@ -1,267 +0,0 @@
-import { describe, it, expect } from "vitest";
-import { z } from "zod";
-import { createContract, SchemaApiError } from "../src/core/contract";
-describe("createContract.handle - integración", () => {
-  const contract = createContract({
-    "/users/:id": {
-      GET: {
-        params: z.object({ id: z.string().uuid() }),
-        query: z.object({
-          includePosts: z.boolean().optional(),
-        }),
-        headers: z.object({
-          authorization: z.string(),
-        }),
-        roles: ["admin"],
-        response: z.object({
-          id: z.string(),
-          username: z.string(),
-        }),
-        errors: {
-          404: "USER_NOT_FOUND",
-          500: "INTERNAL_ERROR",
-        },
-      },
-    },
-  });
-  it("debe ejecutar el handler cuando todo es válido", async () => {
-    const handler = contract.handle(
-      "GET /users/:id",
-      async (ctx) =>
-        ({
-          id: ctx.params && (ctx.params as any).id,
-          username: "admin",
-        }) as unknown
-    );
-    const result = await handler({
-      params: { id: "550e8400-e29b-41d4-a716-446655440000" },
-      query: { includePosts: true },
-      headers: { authorization: "Bearer token" },
-      user: { role: "admin" },
-    });
-    expect(result).toEqual({
-      id: "550e8400-e29b-41d4-a716-446655440000",
-      username: "admin",
-    });
-  });
-  it("debe lanzar 404 si la ruta no existe", () => {
-    const other = createContract({
-      "/other": {
-        GET: {
-          response: z.object({ ok: z.boolean() }),
-        },
-      },
-    });
-    expect(() =>
-      other.handle("GET /missing", async () => ({ ok: true }))
-    ).toThrowError(/Route \/missing not defined in contract/);
-  });
-  it("debe lanzar 405 si el método no está definido en la ruta", () => {
-    expect(() =>
-      contract.handle("POST /users/:id", async () => ({}))
-    ).toThrowError(/Method POST not defined for route \/users\/:id/);
-  });
-  it("valida path params y lanza 400 si son inválidos", async () => {
-    const handler = contract.handle("GET /users/:id", async () => ({
-      id: "invalid",
-      username: "x",
-    }));
-    await expect(
-      handler({
-        params: { id: "not-a-uuid" },
-        query: {},
-        headers: { authorization: "Bearer token" },
-        user: { role: "admin" },
-      })
-    ).rejects.toMatchObject({
-      code: 400,
-    } as Partial<SchemaApiError>);
-  });
-  it("valida headers y roles, lanza 403 si el rol no está permitido", async () => {
-    const handler = contract.handle("GET /users/:id", async () => ({
-      id: "550e8400-e29b-41d4-a716-446655440000",
-      username: "x",
-    }));
-    await expect(
-      handler({
-        params: { id: "550e8400-e29b-41d4-a716-446655440000" },
-        query: {},
-        headers: { authorization: "Bearer token" },
-        user: { role: "user" },
-      })
-    ).rejects.toMatchObject({
-      code: 403,
-    } as Partial<SchemaApiError>);
-  });
-  it("valida la response y lanza 500 si no cumple el schema", async () => {
-    const handler = contract.handle("GET /users/:id", async () => ({
-      id: "550e8400-e29b-41d4-a716-446655440000",
-      // falta username
-    }));
-    await expect(
-      handler({
-        params: { id: "550e8400-e29b-41d4-a716-446655440000" },
-        query: {},
-        headers: { authorization: "Bearer token" },
-        user: { role: "admin" },
-      })
-    ).rejects.toMatchObject({
-      code: 500,
-    } as Partial<SchemaApiError>);
-  });
-  it("permite errores con status codes declarados en errors", async () => {
-    const c = createContract({
-      "/users/:id": {
-        GET: {
-          params: z.object({ id: z.string().uuid() }),
-          response: z.object({ ok: z.boolean() }),
-          errors: {
-            404: "USER_NOT_FOUND",
-          },
-        },
-      },
-    });
-    const handler = c.handle("GET /users/:id", async () => {
-      throw new SchemaApiError(404, "USER_NOT_FOUND");
-    });
-    await expect(
-      handler({
-        params: { id: "550e8400-e29b-41d4-a716-446655440000" },
-      })
-    ).rejects.toMatchObject({
-      code: 404,
-    } as Partial<SchemaApiError>);
-  });
-  it("rechaza errores con status codes no declarados en errors", async () => {
-    const c = createContract({
-      "/users/:id": {
-        GET: {
-          params: z.object({ id: z.string().uuid() }),
-          response: z.object({ ok: z.boolean() }),
-          errors: {
-            404: "USER_NOT_FOUND",
-          },
-        },
-      },
-    });
-    const handler = c.handle("GET /users/:id", async () => {
-      throw new SchemaApiError(418, "Teapot");
-    });
-    await expect(
-      handler({
-        params: { id: "550e8400-e29b-41d4-a716-446655440000" },
-      })
-    ).rejects.toThrow("418 is not defined in contract.errors");
-  });
-  it("valida media upload con content-type permitido y tamaño válido", async () => {
-    const mediaContract = createContract({
-      "/upload": {
-        POST: {
-          media: {
-            kind: "upload",
-            contentTypes: ["image/png", "image/jpeg"],
-            maxSize: 1024,
-          },
-          body: z.any(),
-          response: z.object({ ok: z.boolean() }),
-        },
-      },
-    });
-    const handler = mediaContract.handle("POST /upload", async () => ({
-      ok: true,
-    }));
-    const result = await handler({
-      headers: {
-        "content-type": "image/png",
-        "content-length": "512",
-      },
-      body: Buffer.from("test"),
-    });
-    expect(result).toEqual({ ok: true });
-  });
-  it("rechaza media upload con content-type no permitido", async () => {
-    const mediaContract = createContract({
-      "/upload": {
-        POST: {
-          media: {
-            kind: "upload",
-            contentTypes: ["image/png"],
-          },
-          body: z.any(),
-          response: z.object({ ok: z.boolean() }),
-        },
-      },
-    });
-    const handler = mediaContract.handle("POST /upload", async () => ({
-      ok: true,
-    }));
-    await expect(
-      handler({
-        headers: {
-          "content-type": "application/pdf",
-        },
-        body: Buffer.from("test"),
-      })
-    ).rejects.toMatchObject({
-      code: 415,
-    } as Partial<SchemaApiError>);
-  });
-  it("rechaza media upload cuando el tamaño excede maxSize", async () => {
-    const mediaContract = createContract({
-      "/upload": {
-        POST: {
-          media: {
-            kind: "upload",
-            contentTypes: ["image/png"],
-            maxSize: 1024,
-          },
-          body: z.any(),
-          response: z.object({ ok: z.boolean() }),
-        },
-      },
-    });
-    const handler = mediaContract.handle("POST /upload", async () => ({
-      ok: true,
-    }));
-    await expect(
-      handler({
-        headers: {
-          "content-type": "image/png",
-          "content-length": "2048",
-        },
-        body: Buffer.from("test"),
-      })
-    ).rejects.toMatchObject({
-      code: 413,
-    } as Partial<SchemaApiError>);
-  });
-});

package/tests/docs.test.ts DELETED Viewed

@@ -1,96 +0,0 @@
-import { describe, it, expect } from "vitest";
-import { z } from "zod";
-import { createContract } from "../src/core/contract";
-import {
-  renderDocs,
-  renderDocsHTML,
-  renderDocsJSON,
-  renderDocsText,
-} from "../src/docs";
-describe("docs generator", () => {
-  const contract = createContract({
-    "/users/:id": {
-      GET: {
-        params: z.object({ id: z.string().uuid() }),
-        query: z.object({ includePosts: z.boolean().optional() }),
-        headers: z.object({ authorization: z.string() }),
-        roles: ["admin"],
-        response: z.object({
-          id: z.string(),
-          username: z.string(),
-        }),
-        errors: {
-          404: "USER_NOT_FOUND",
-        },
-      },
-    },
-  });
-  it("renderDocsJSON devuelve un JSON legible", () => {
-    const docs = contract.docs();
-    const json = renderDocsJSON(docs);
-    const parsed = JSON.parse(json) as unknown;
-    expect(parsed).toBeDefined();
-    expect((parsed as any).routes).toHaveLength(1);
-  });
-  it("renderDocsText genera una representación de texto", () => {
-    const docs = contract.docs();
-    const text = renderDocsText(docs);
-    expect(text).toContain("SchemaApi Contract");
-    expect(text).toContain("GET /users/:id");
-    expect(text).toContain("params:");
-    expect(text).toContain("errors:");
-  });
-  it("renderDocsHTML genera un documento HTML con estilo propio", () => {
-    const docs = contract.docs();
-    const html = renderDocsHTML(docs, { title: "Users API", theme: "dark" });
-    expect(html).toContain("<!doctype html>");
-    expect(html).toContain("Users API");
-    expect(html).toContain("SCHEMAAPI · CONTRACT DOCS");
-    expect(html).toContain('<span class="method method-get">GET</span>');
-    expect(html).toContain('<span class="path">/users/:id</span>');
-    expect(html).toContain("params");
-    expect(html).toContain("errors");
-  });
-  it("renderDocsHTML genera tarjetas con roles y media", () => {
-    const filesContract = createContract({
-      "/files": {
-        POST: {
-          body: z.object({ filename: z.string() }),
-          media: {
-            kind: "upload",
-            contentTypes: ["image/png"],
-            maxSize: 1024,
-          },
-          roles: ["uploader"],
-        },
-      },
-    });
-    const docs = filesContract.docs();
-    const html = renderDocsHTML(docs, { title: "Files API", theme: "light" });
-    expect(html).toContain('class="route-card route-post"');
-    expect(html).toContain('<span class="method method-post">POST</span>');
-    expect(html).toContain('<span class="path">/files</span>');
-    expect(html).toContain("role: uploader");
-    expect(html).toContain("media kind=upload");
-    expect(html).toContain("types=[image/png]");
-    expect(html).toContain("maxSize=1024");
-  });
-  it("renderDocs selecciona el formato correcto", () => {
-    const docs = contract.docs();
-    const html = renderDocs(docs, { format: "html", title: "X" });
-    const json = renderDocs(docs, { format: "json" });
-    const text = renderDocs(docs, { format: "text" });
-    expect(html).toContain("<!doctype html>");
-    expect(() => JSON.parse(json)).not.toThrow();
-    expect(text).toContain("SchemaApi Contract");
-  });
-});

package/tests/sdk.test.ts DELETED Viewed

@@ -1,34 +0,0 @@
-import { describe, it, expect, vi } from "vitest";
-import { generateSDK } from "../src/sdk";
-import { createContract } from "../src/core/contract";
-import { z } from "zod";
-describe("generateSDK", () => {
-  const contract = createContract({
-    "/users/:id": {
-      GET: {
-        params: z.object({ id: z.string() }),
-        response: z.object({ id: z.string() }),
-      },
-    },
-  });
-  it("crea un cliente que usa baseUrl y fetch proporcionado", async () => {
-    const fetchMock = vi.fn().mockResolvedValue({
-      ok: true,
-      status: 200,
-      statusText: "OK",
-      json: async () => ({ id: "123" }),
-    } as Response);
-    const sdk = generateSDK(contract, {
-      baseUrl: "https://api.mysite.com",
-      fetch: fetchMock as any,
-    });
-    const result = await sdk["users"].get({ id: "123" });
-    expect(result).toEqual({ id: "123" });
-    expect(fetchMock).toHaveBeenCalledTimes(1);
-  });
-});

package/tsconfig.json DELETED Viewed

@@ -1,15 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ES2020",
-    "module": "ESNext",
-    "moduleResolution": "Node",
-    "declaration": true,
-    "outDir": "dist",
-    "rootDir": "src",
-    "strict": true,
-    "esModuleInterop": true,
-    "skipLibCheck": true,
-    "forceConsistentCasingInFileNames": true
-  },
-  "include": ["src/**/*"]
-}