@unispechq/unispec-core 0.1.0 → 0.1.1

package/src/converters/index.ts

@@ -1,120 +1,120 @@
-import { UniSpecDocument, UniSpecWebSocketProtocol, UniSpecWebSocketChannel } from "../types";
-
-export interface OpenAPIDocument {
-  [key: string]: unknown;
-}
-
-export interface GraphQLSDLOutput {
-  sdl: string;
-}
-
-export interface WebSocketModel {
-  [key: string]: unknown;
-}
-
-export function toOpenAPI(doc: UniSpecDocument): OpenAPIDocument {
-  const service = doc.service;
-  const rest = service.protocols?.rest as any | undefined;
-
-  const info = {
-    title: service.title ?? service.name,
-    description: service.description,
-  };
-
-  const servers = rest?.servers ?? [];
-  const paths = rest?.paths ?? {};
-
-  // Transparently forward additional REST protocol fields into the OpenAPI document.
-  // This allows users to describe components, security, tags and other structures
-  // without forcing a specific REST model at the core layer.
-  const { servers: _omitServers, paths: _omitPaths, ...restExtras } = rest ?? {};
-
-  return {
-    openapi: "3.1.0",
-    info,
-    servers,
-    paths,
-    ...restExtras,
-    "x-unispec": doc,
-  };
-}
-
-export function toGraphQLSDL(doc: UniSpecDocument): GraphQLSDLOutput {
-  // Minimal implementation: generate a basic SDL that exposes service metadata
-  // via a Query field. This does not attempt to interpret the full GraphQL
-  // protocol structure yet, but provides a stable, deterministic SDL shape
-  // based on top-level UniSpec document fields.
-
-  const graphql = doc.service.protocols?.graphql;
-  const customSDL = graphql?.schema?.sdl;
-
-  if (typeof customSDL === "string" && customSDL.trim()) {
-    return { sdl: customSDL };
-  }
-
-  const service = doc.service;
-  const title = service.title ?? service.name;
-  const description = service.description ?? "";
-
-  const lines: string[] = [];
-
-  if (title || description) {
-    lines.push("\"\"");
-    if (title) {
-      lines.push(title);
-    }
-    if (description) {
-      lines.push("");
-      lines.push(description);
-    }
-    lines.push("\"\"");
-  }
-
-  lines.push("schema {");
-  lines.push("  query: Query");
-  lines.push("}");
-  lines.push("");
-  lines.push("type Query {");
-  lines.push("  _serviceInfo: String!\n");
-  lines.push("}");
-
-  const sdl = lines.join("\n");
-  return { sdl };
-}
-
-export function toWebSocketModel(doc: UniSpecDocument): WebSocketModel {
-  // Base WebSocket model intended for a modern, dashboard-oriented UI.
-  // It exposes service metadata, a normalized list of channels and the raw
-  // websocket protocol object, while also embedding the original UniSpec
-  // document under a technical key for debugging and introspection.
-
-  const service = doc.service;
-  const websocket = (service.protocols?.websocket ?? {}) as UniSpecWebSocketProtocol;
-
-  const channelsRecord = (websocket && typeof websocket === "object" && websocket.channels && typeof websocket.channels === "object")
-    ? (websocket.channels as Record<string, UniSpecWebSocketChannel>)
-    : {};
-
-  const channels = Object.keys(channelsRecord).sort().map((name) => {
-    const channel = channelsRecord[name] ?? {};
-    return {
-      name,
-      summary: channel.summary ?? channel.title,
-      description: channel.description,
-      direction: channel.direction,
-      messages: channel.messages,
-      raw: channel,
-    };
-  });
-
-  return {
-    service: {
-      name: service.name,
-      title: service.title,
-      description: service.description,
-    },
-    channels,
-    rawProtocol: websocket,
-    "x-unispec-ws": doc,
-  };
-}
+import { UniSpecDocument, UniSpecWebSocketProtocol, UniSpecWebSocketChannel } from "../types";
+
+export interface OpenAPIDocument {
+  [key: string]: unknown;
+}
+
+export interface GraphQLSDLOutput {
+  sdl: string;
+}
+
+export interface WebSocketModel {
+  [key: string]: unknown;
+}
+
+export function toOpenAPI(doc: UniSpecDocument): OpenAPIDocument {
+  const service = doc.service;
+  const rest = service.protocols?.rest as any | undefined;
+
+  const info = {
+    title: service.title ?? service.name,
+    description: service.description,
+  };
+
+  const servers = rest?.servers ?? [];
+  const paths = rest?.paths ?? {};
+
+  // Transparently forward additional REST protocol fields into the OpenAPI document.
+  // This allows users to describe components, security, tags and other structures
+  // without forcing a specific REST model at the core layer.
+  const { servers: _omitServers, paths: _omitPaths, ...restExtras } = rest ?? {};
+
+  return {
+    openapi: "3.1.0",
+    info,
+    servers,
+    paths,
+    ...restExtras,
+    "x-unispec": doc,
+  };
+}
+
+export function toGraphQLSDL(doc: UniSpecDocument): GraphQLSDLOutput {
+  // Minimal implementation: generate a basic SDL that exposes service metadata
+  // via a Query field. This does not attempt to interpret the full GraphQL
+  // protocol structure yet, but provides a stable, deterministic SDL shape
+  // based on top-level UniSpec document fields.
+
+  const graphql = doc.service.protocols?.graphql;
+  const customSDL = graphql?.schema?.sdl;
+
+  if (typeof customSDL === "string" && customSDL.trim()) {
+    return { sdl: customSDL };
+  }
+
+  const service = doc.service;
+  const title = service.title ?? service.name;
+  const description = service.description ?? "";
+
+  const lines: string[] = [];
+
+  if (title || description) {
+    lines.push("\"\"");
+    if (title) {
+      lines.push(title);
+    }
+    if (description) {
+      lines.push("");
+      lines.push(description);
+    }
+    lines.push("\"\"");
+  }
+
+  lines.push("schema {");
+  lines.push("  query: Query");
+  lines.push("}");
+  lines.push("");
+  lines.push("type Query {");
+  lines.push("  _serviceInfo: String!\n");
+  lines.push("}");
+
+  const sdl = lines.join("\n");
+  return { sdl };
+}
+
+export function toWebSocketModel(doc: UniSpecDocument): WebSocketModel {
+  // Base WebSocket model intended for a modern, dashboard-oriented UI.
+  // It exposes service metadata, a normalized list of channels and the raw
+  // websocket protocol object, while also embedding the original UniSpec
+  // document under a technical key for debugging and introspection.
+
+  const service = doc.service;
+  const websocket = (service.protocols?.websocket ?? {}) as UniSpecWebSocketProtocol;
+
+  const channelsRecord = (websocket && typeof websocket === "object" && websocket.channels && typeof websocket.channels === "object")
+    ? (websocket.channels as Record<string, UniSpecWebSocketChannel>)
+    : {};
+
+  const channels = Object.keys(channelsRecord).sort().map((name) => {
+    const channel = channelsRecord[name] ?? {};
+    return {
+      name,
+      summary: channel.summary ?? channel.title,
+      description: channel.description,
+      direction: channel.direction,
+      messages: channel.messages,
+      raw: channel,
+    };
+  });
+
+  return {
+    service: {
+      name: service.name,
+      title: service.title,
+      description: service.description,
+    },
+    channels,
+    rawProtocol: websocket,
+    "x-unispec-ws": doc,
+  };
+}