@asgard/heimdall@0.0.4

Built and signed on GitHub Actions

Built and signed on GitHub Actions

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165
import { Hono } from "npm:hono@~4.7.6";
import { Scalar } from "npm:@scalar/hono-api-reference@~0.8.1";
import { describeRoute, openAPISpecs, type ResolverResult } from "npm:hono-openapi@~0.4.6";

import {
  type HermodServiceConstructor,
  HermodServiceDiscovery,
  type HermodServiceRecord,
} from "jsr:@asgard/hermod@^0.0.4";
import type { HeimdallEndpoint, HeimdallPath } from "./HeimdallEndpoint.ts";

export class HeimdallHonoServer<
  TServices extends HermodServiceConstructor[] = [],
> {
  /**
   * Creates a generic resolver function for the schema.
   *
   * @param resolver - The resolver function to use for the schema.
   * @param schema - The schema to resolve.
   * @returns
   */
  static createGenericResolver<S>(
    //
    // deno-lint-ignore no-explicit-any
    resolver: (schema: any) => any,
  ): HeimdallSchemaResolver<S> {
    return (schema: S) => resolver(schema);
  }
  /**
   * Creates a new Heimdall Hono server.
   *
   * @param options - The options for the server.
   * @returns The server instance.
   */
  static async createServer<
    TServices extends HermodServiceConstructor[],
    TSchemaResolver extends HeimdallSchemaResolver<unknown>,
  >(
    options: HeimdallHonoServerOptions<TServices, TSchemaResolver>,
  ): Promise<HeimdallHonoServer<TServices>> {
    const {
      endpoints,
      app = new Hono(),
      services: serviceConstructors,
      name = "Heimdall",
      description = "Heimdall Hono Server",
      version = "1.0.0",
      resolver,
      serviceDiscovery,
    } = options;

    const services = await serviceDiscovery.register(serviceConstructors);

    endpoints.forEach((endpoint) => {
      const method = endpoint.method.toLowerCase() as
        | "get"
        | "post"
        | "put"
        | "delete"
        | "options";

      const content = endpoint.responseSchema
        ? {
          "application/json": {
            schema: resolver(endpoint.responseSchema),
          },
        }
        : undefined;
      app[method](
        endpoint.path,
        describeRoute({
          description: endpoint.description,
          tags: endpoint.tags,
          responses: {
            200: {
              description: "Successful response",
              content,
            },
          },
        }),
        async (c) => {
          const serviceDiscovery = HermodServiceDiscovery.getInstance();

          const services = await serviceDiscovery.register(
            endpoint.services,
          );

          const body = await c.req.json().catch(() => undefined);
          const p = c.req.param();
          const q = c.req.query();

          const data = await endpoint.body(body);
          const params = await endpoint.params(p);
          const search = await endpoint.search(q);

          const response = await endpoint.execute({
            data,
            params,
            search,
            services,
          });

          const result = await endpoint.response(response);

          return c.json(
            result.body,
            // deno-lint-ignore ban-ts-comment
            // @ts-ignore
            response.statusCode,
          );
        },
      );
    });

    app.get(
      "/openapi",
      openAPISpecs(app, {
        documentation: {
          info: {
            title: name,
            version: version,
            description,
          },
          servers: [],
        },
      }),
    );

    app.get(
      "/reference",
      Scalar({
        theme: "kepler",
        layout: "classic",
        defaultHttpClient: {
          targetKey: "node",
          clientKey: "fetch",
        },
        url: "/openapi",
      }),
    );

    return new HeimdallHonoServer(app, services);
  }

  private constructor(
    readonly app: Hono,
    readonly services: HermodServiceRecord<TServices>,
  ) {}
}

export interface HeimdallHonoServerOptions<
  TServices extends HermodServiceConstructor[],
  TSchemaResolver extends HeimdallSchemaResolver<unknown>,
> {
  app?: Hono;
  name?: string;
  description?: string;
  version?: string;
  endpoints: HeimdallEndpoint<HeimdallPath>[];
  services: TServices;
  resolver: TSchemaResolver;
  serviceDiscovery: HermodServiceDiscovery;
}

export type HeimdallSchemaResolver<T> = (schema: T) => ResolverResult;