@autobe/utils 0.29.1 → 0.30.0-dev.20260315

package/src/interface/AutoBeOpenApiTypeChecker.ts

@@ -1,43 +1,127 @@
-import { AutoBeOpenApi } from "@autobe/interface";
-
-export namespace AutoBeOpenApiTypeChecker {
-  export const isArray = (
-    schema: AutoBeOpenApi.IJsonSchema,
-  ): schema is AutoBeOpenApi.IJsonSchema.IArray =>
-    (schema as AutoBeOpenApi.IJsonSchema.IArray).type === "array";
-
-  export const isObject = (
-    schema: AutoBeOpenApi.IJsonSchema,
-  ): schema is AutoBeOpenApi.IJsonSchema.IObject =>
-    (schema as AutoBeOpenApi.IJsonSchema.IObject).type === "object";
-
-  export const isOneOf = (
-    schema: AutoBeOpenApi.IJsonSchema,
-  ): schema is AutoBeOpenApi.IJsonSchema.IOneOf =>
-    (schema as AutoBeOpenApi.IJsonSchema.IOneOf).oneOf !== undefined;
-
-  export const isReference = (
-    schema: AutoBeOpenApi.IJsonSchema,
-  ): schema is AutoBeOpenApi.IJsonSchema.IReference =>
-    (schema as AutoBeOpenApi.IJsonSchema.IReference).$ref !== undefined;
-
-  export const isConstant = (
-    schema: AutoBeOpenApi.IJsonSchema,
-  ): schema is AutoBeOpenApi.IJsonSchema.IConstant =>
-    (schema as AutoBeOpenApi.IJsonSchema.IConstant).const !== undefined;
-
-  export const isInteger = (
-    schema: AutoBeOpenApi.IJsonSchema,
-  ): schema is AutoBeOpenApi.IJsonSchema.IInteger =>
-    (schema as AutoBeOpenApi.IJsonSchema.IInteger).type === "integer";
-
-  export const isNumber = (
-    schema: AutoBeOpenApi.IJsonSchema,
-  ): schema is AutoBeOpenApi.IJsonSchema.INumber =>
-    (schema as AutoBeOpenApi.IJsonSchema.INumber).type === "number";
-
-  export const isString = (
-    schema: AutoBeOpenApi.IJsonSchema,
-  ): schema is AutoBeOpenApi.IJsonSchema.IString =>
-    (schema as AutoBeOpenApi.IJsonSchema.IString).type === "string";
-}
+import { AutoBeOpenApi } from "@autobe/interface";
+import { OpenApiTypeChecker } from "@typia/utils";
+
+export namespace AutoBeOpenApiTypeChecker {
+  export const getKind = (schema: AutoBeOpenApi.IJsonSchema): string => {
+    if (isReference(schema)) return "$ref";
+    else if (isConstant(schema)) return JSON.stringify(schema.const);
+    else if (isOneOf(schema))
+      return schema.oneOf.map((s) => getKind(s)).join(" | ");
+    else if (isArray(schema)) return `Array<${getKind(schema.items)}>`;
+    else if (isObject(schema)) return "object";
+    else if (isString(schema)) return "string";
+    else if (isInteger(schema)) return "integer";
+    else if (isNumber(schema)) return "number";
+    else if (isBoolean(schema)) return "boolean";
+    else if (isNull(schema)) return "null";
+    schema satisfies never;
+    return "unknown";
+  };
+
+  export const isArray = (
+    schema: AutoBeOpenApi.IJsonSchema,
+  ): schema is AutoBeOpenApi.IJsonSchema.IArray =>
+    (schema as AutoBeOpenApi.IJsonSchema.IArray).type === "array";
+
+  export const isObject = (
+    schema: AutoBeOpenApi.IJsonSchema,
+  ): schema is AutoBeOpenApi.IJsonSchema.IObject =>
+    (schema as AutoBeOpenApi.IJsonSchema.IObject).type === "object";
+
+  export const isOneOf = (
+    schema: AutoBeOpenApi.IJsonSchema,
+  ): schema is AutoBeOpenApi.IJsonSchema.IOneOf =>
+    (schema as AutoBeOpenApi.IJsonSchema.IOneOf).oneOf !== undefined;
+
+  export const isReference = (
+    schema: AutoBeOpenApi.IJsonSchema,
+  ): schema is AutoBeOpenApi.IJsonSchema.IReference =>
+    (schema as AutoBeOpenApi.IJsonSchema.IReference).$ref !== undefined;
+
+  export const isConstant = (
+    schema: AutoBeOpenApi.IJsonSchema,
+  ): schema is AutoBeOpenApi.IJsonSchema.IConstant =>
+    (schema as AutoBeOpenApi.IJsonSchema.IConstant).const !== undefined;
+
+  export const isBoolean = (
+    schema: AutoBeOpenApi.IJsonSchema,
+  ): schema is AutoBeOpenApi.IJsonSchema.IBoolean =>
+    (schema as AutoBeOpenApi.IJsonSchema.IBoolean).type === "boolean";
+
+  export const isInteger = (
+    schema: AutoBeOpenApi.IJsonSchema,
+  ): schema is AutoBeOpenApi.IJsonSchema.IInteger =>
+    (schema as AutoBeOpenApi.IJsonSchema.IInteger).type === "integer";
+
+  export const isNumber = (
+    schema: AutoBeOpenApi.IJsonSchema,
+  ): schema is AutoBeOpenApi.IJsonSchema.INumber =>
+    (schema as AutoBeOpenApi.IJsonSchema.INumber).type === "number";
+
+  export const isString = (
+    schema: AutoBeOpenApi.IJsonSchema,
+  ): schema is AutoBeOpenApi.IJsonSchema.IString =>
+    (schema as AutoBeOpenApi.IJsonSchema.IString).type === "string";
+
+  export const isNull = (
+    schema: AutoBeOpenApi.IJsonSchema,
+  ): schema is AutoBeOpenApi.IJsonSchema.INull =>
+    (schema as AutoBeOpenApi.IJsonSchema.INull).type === "null";
+
+  export const isNullable = (schema: AutoBeOpenApi.IJsonSchema): boolean =>
+    isNull(schema) ||
+    (isOneOf(schema) && schema.oneOf.some((sub) => isNull(sub)));
+
+  export const visit = (props: {
+    components: AutoBeOpenApi.IComponents;
+    schema: AutoBeOpenApi.IJsonSchema;
+    closure: (schema: AutoBeOpenApi.IJsonSchema, accessor: string) => void;
+  }): void =>
+    OpenApiTypeChecker.visit({
+      components: props.components,
+      schema: props.schema,
+      closure: (schema, accessor) => {
+        props.closure(schema as AutoBeOpenApi.IJsonSchema, accessor);
+      },
+    });
+
+  export const skim = (props: {
+    closure: (schema: AutoBeOpenApi.IJsonSchema, accessor: string) => void;
+    schema: AutoBeOpenApi.IJsonSchema;
+    accessor: string;
+  }): void => {
+    props.closure(props.schema, props.accessor);
+    if (isOneOf(props.schema))
+      props.schema.oneOf.forEach((sub, index) =>
+        skim({
+          closure: props.closure,
+          schema: sub,
+          accessor: `${props.accessor}.oneOf[${index}]`,
+        }),
+      );
+    else if (isArray(props.schema))
+      skim({
+        closure: props.closure,
+        schema: props.schema.items,
+        accessor: `${props.accessor}.items`,
+      });
+    else if (isObject(props.schema)) {
+      if (
+        typeof props.schema.additionalProperties === "object" &&
+        props.schema.additionalProperties !== null
+      )
+        skim({
+          closure: props.closure,
+          schema: props.schema.additionalProperties,
+          accessor: `${props.accessor}.additionalProperties`,
+        });
+      for (const [key, value] of Object.entries(props.schema.properties))
+        if (value)
+          skim({
+            closure: props.closure,
+            schema: value,
+            accessor: `${props.accessor}.properties[${JSON.stringify(key)}]`,
+          });
+    }
+  };
+}

package/src/interface/index.ts

@@ -1,6 +1,6 @@
-export * from "./AutoBeOpenApiEndpointComparator";
-export * from "./AutoBeOpenApiTypeChecker";
-export * from "./invertOpenApiDocument";
-export * from "./revertOpenApiAccessor";
-export * from "./transformOpenApiDocument";
-export * from "./missedOpenApiSchemas";
+export * from "./AutoBeOpenApiEndpointComparator";
+export * from "./AutoBeOpenApiTypeChecker";
+export * from "./invertOpenApiDocument";
+export * from "./revertOpenApiAccessor";
+export * from "./transformOpenApiDocument";
+export * from "./missedOpenApiSchemas";

package/src/interface/invertOpenApiDocument.ts

@@ -1,68 +1,80 @@
-import { AutoBeOpenApi } from "@autobe/interface";
-import {
-  HttpMigration,
-  IHttpMigrateApplication,
-  OpenApi,
-  OpenApiTypeChecker,
-} from "@samchon/openapi";
-
-export function invertOpenApiDocument(
-  document: OpenApi.IDocument,
-): AutoBeOpenApi.IDocument {
-  const app: IHttpMigrateApplication = HttpMigration.application(document);
-  return {
-    operations: app.routes
-      .filter((r) => r.query === null)
-      .map(
-        (r) =>
-          ({
-            specification: empty("specification"),
-            authorizationType: null,
-            method: r.method as "post",
-            path: r.path,
-            summary: r.operation().summary ?? empty("summary"),
-            description: r.operation().description ?? empty("description"),
-            parameters: r.parameters.map(
-              (p) =>
-                ({
-                  name: p.name,
-                  description:
-                    p.parameter().description ?? empty("description"),
-                  schema: p.schema as any,
-                }) satisfies AutoBeOpenApi.IParameter,
-            ),
-            requestBody:
-              r.body?.type === "application/json" &&
-              OpenApiTypeChecker.isReference(r.body.schema)
-                ? {
-                    description: r.body.description() ?? empty("description"),
-                    typeName: r.body.schema.$ref.split("/").pop()!,
-                  }
-                : null,
-            responseBody:
-              r.success?.type === "application/json" &&
-              OpenApiTypeChecker.isReference(r.success.schema)
-                ? {
-                    description:
-                      r.success.description() ?? empty("description"),
-                    typeName: r.success.schema.$ref.split("/").pop()!,
-                  }
-                : null,
-            authorizationActor: null,
-            name: r.accessor.at(-1)!,
-            prerequisites: [],
-          }) satisfies AutoBeOpenApi.IOperation,
-      ),
-    components: {
-      schemas: (document.components?.schemas ?? {}) as Record<
-        string,
-        AutoBeOpenApi.IJsonSchemaDescriptive
-      >,
-      authorizations: [],
-    },
-  };
-}
-
-function empty(key: string): string {
-  return `Describe ${key} as much as possible with clear and concise words.`;
-}
+import { AutoBeOpenApi } from "@autobe/interface";
+import { IHttpMigrateApplication, OpenApi } from "@typia/interface";
+import { HttpMigration, OpenApiTypeChecker } from "@typia/utils";
+
+export function invertOpenApiDocument(
+  document: OpenApi.IDocument,
+): AutoBeOpenApi.IDocument {
+  const app: IHttpMigrateApplication = HttpMigration.application(document);
+  return {
+    operations: app.routes
+      .filter((r) => r.query === null)
+      .map(
+        (r) =>
+          ({
+            authorizationType: null,
+            method: r.method as "post",
+            path: r.path,
+            description:
+              writeDescription(r.operation()) ?? empty("description"),
+            specification: r.operation()
+              ? // biome-ignore lint: intended
+                ((r.operation() as any)["x-autobe-specification"] ??
+                empty("x-autobe-specification"))
+              : empty("x-autobe-specification"),
+            accessor: r.accessor,
+            parameters: r.parameters.map(
+              (p) =>
+                ({
+                  name: p.name,
+                  description:
+                    p.parameter().description ?? empty("description"),
+                  // biome-ignore lint: intended
+                  schema: p.schema as any,
+                }) satisfies AutoBeOpenApi.IParameter,
+            ),
+            requestBody:
+              r.body?.type === "application/json" &&
+              OpenApiTypeChecker.isReference(r.body.schema)
+                ? {
+                    description: r.body.description() ?? empty("description"),
+                    typeName: r.body.schema.$ref.split("/").pop()!,
+                  }
+                : null,
+            responseBody:
+              r.success?.type === "application/json" &&
+              OpenApiTypeChecker.isReference(r.success.schema)
+                ? {
+                    description:
+                      r.success.description() ?? empty("description"),
+                    typeName: r.success.schema.$ref.split("/").pop()!,
+                  }
+                : null,
+            authorizationActor: null,
+            name: r.accessor.at(-1)!,
+            prerequisites: [],
+          }) satisfies AutoBeOpenApi.IOperation,
+      ),
+    components: {
+      schemas: (document.components?.schemas ?? {}) as Record<
+        string,
+        AutoBeOpenApi.IJsonSchemaDescriptive
+      >,
+      authorizations: [],
+    },
+  };
+}
+
+function writeDescription(operation: OpenApi.IOperation): string | undefined {
+  if (operation.summary === undefined && operation.description === undefined)
+    return undefined;
+  if (operation.summary === undefined) return operation.description;
+  else if (operation.description === undefined) return operation.summary;
+  else if (operation.description.startsWith(operation.summary))
+    return operation.description;
+  return `${operation.summary}${operation.summary.endsWith(".") ? "" : "."}\n\n${operation.description}`;
+}
+
+function empty(key: string): string {
+  return `Describe ${key} as much as possible with clear and concise words.`;
+}

package/src/interface/missedOpenApiSchemas.ts

@@ -1,25 +1,25 @@
-import { AutoBeOpenApi } from "@autobe/interface";
-import { OpenApiTypeChecker } from "@samchon/openapi";
-
-export const missedOpenApiSchemas = (
-  document: AutoBeOpenApi.IDocument,
-): string[] => {
-  const missed: Set<string> = new Set();
-  const check = (name: string) => {
-    if (document.components.schemas[name] === undefined) missed.add(name);
-  };
-  for (const op of document.operations) {
-    if (op.requestBody !== null) check(op.requestBody.typeName);
-    if (op.responseBody !== null) check(op.responseBody.typeName);
-  }
-  for (const value of Object.values(document.components.schemas))
-    OpenApiTypeChecker.visit({
-      components: document.components,
-      schema: value,
-      closure: (next) => {
-        if (OpenApiTypeChecker.isReference(next))
-          check(next.$ref.split("/").pop()!);
-      },
-    });
-  return Array.from(missed);
-};
+import { AutoBeOpenApi } from "@autobe/interface";
+import { OpenApiTypeChecker } from "@typia/utils";
+
+export const missedOpenApiSchemas = (
+  document: AutoBeOpenApi.IDocument,
+): string[] => {
+  const missed: Set<string> = new Set();
+  const check = (name: string) => {
+    if (document.components.schemas[name] === undefined) missed.add(name);
+  };
+  for (const op of document.operations) {
+    if (op.requestBody !== null) check(op.requestBody.typeName);
+    if (op.responseBody !== null) check(op.responseBody.typeName);
+  }
+  for (const value of Object.values(document.components.schemas))
+    OpenApiTypeChecker.visit({
+      components: document.components,
+      schema: value,
+      closure: (next) => {
+        if (OpenApiTypeChecker.isReference(next))
+          check(next.$ref.split("/").pop()!);
+      },
+    });
+  return Array.from(missed);
+};

package/src/interface/revertOpenApiAccessor.ts

@@ -1,25 +1,25 @@
-import { AutoBeOpenApi } from "@autobe/interface";
-import {
-  HttpMigration,
-  IHttpMigrateApplication,
-  IHttpMigrateRoute,
-  OpenApi,
-} from "@samchon/openapi";
-
-import { transformOpenApiDocument } from "./transformOpenApiDocument";
-
-export const revertOpenApiAccessor = (
-  document: AutoBeOpenApi.IDocument,
-): void => {
-  const regular: OpenApi.IDocument = transformOpenApiDocument(document);
-  const migrate: IHttpMigrateApplication = HttpMigration.application(regular);
-  for (const op of document.operations) {
-    const route: IHttpMigrateRoute | undefined = migrate.routes.find(
-      (r) => r.method === op.method && r.path === op.path,
-    );
-    if (route === undefined) continue;
-    if (route.accessor.length !== 0 && route.accessor.at(-1) !== op.name)
-      op.name = route.accessor.at(-1)!;
-    op.accessor = route.accessor;
-  }
-};
+import { AutoBeOpenApi } from "@autobe/interface";
+import {
+  IHttpMigrateApplication,
+  IHttpMigrateRoute,
+  OpenApi,
+} from "@typia/interface";
+import { HttpMigration } from "@typia/utils";
+
+import { transformOpenApiDocument } from "./transformOpenApiDocument";
+
+export const revertOpenApiAccessor = (
+  document: AutoBeOpenApi.IDocument,
+): void => {
+  const regular: OpenApi.IDocument = transformOpenApiDocument(document);
+  const migrate: IHttpMigrateApplication = HttpMigration.application(regular);
+  for (const op of document.operations) {
+    const route: IHttpMigrateRoute | undefined = migrate.routes.find(
+      (r) => r.method === op.method && r.path === op.path,
+    );
+    if (route === undefined) continue;
+    if (route.accessor.length !== 0 && route.accessor.at(-1) !== op.name)
+      op.name = route.accessor.at(-1)!;
+    op.accessor = route.accessor;
+  }
+};

package/src/interface/transformOpenApiDocument.ts

@@ -1,91 +1,94 @@
-import { AutoBeOpenApi } from "@autobe/interface";
-import {
-  HttpMigration,
-  IHttpMigrateApplication,
-  OpenApi,
-  OpenApiV3_1,
-} from "@samchon/openapi";
-import { HashMap } from "tstl";
-
-import { AutoBeOpenApiEndpointComparator } from "./AutoBeOpenApiEndpointComparator";
-
-export function transformOpenApiDocument(
-  document: AutoBeOpenApi.IDocument,
-): OpenApi.IDocument {
-  const dict: HashMap<AutoBeOpenApi.IEndpoint, string> = new HashMap(
-    AutoBeOpenApiEndpointComparator.hashCode,
-    AutoBeOpenApiEndpointComparator.equals,
-  );
-  const paths: Record<string, OpenApi.IPath> = {};
-
-  for (const op of document.operations) {
-    dict.set(op, op.name);
-    paths[op.path] ??= {};
-    paths[op.path][op.method] = {
-      summary: op.summary,
-      description:
-        op.description +
-        (op.authorizationType !== null &&
-        op.responseBody?.typeName.endsWith(".IAuthorized") === true
-          ? "\n\n@setHeader token.access Authorization"
-          : ""),
-      parameters: op.parameters.map((p) => ({
-        name: p.name,
-        in: "path",
-        schema: p.schema,
-        description: p.description,
-        required: true,
-      })),
-      requestBody: op.requestBody
-        ? {
-            content: {
-              "application/json": {
-                schema: {
-                  $ref: `#/components/schemas/${op.requestBody.typeName}`,
-                },
-              },
-            },
-            description: op.requestBody.description,
-            required: true,
-          }
-        : undefined,
-      responses: op.responseBody
-        ? {
-            [op.method === "post" ? 201 : 200]: {
-              content: {
-                "application/json": {
-                  schema: {
-                    $ref: `#/components/schemas/${op.responseBody.typeName}`,
-                  },
-                },
-              },
-              description: op.responseBody.description,
-            },
-          }
-        : undefined,
-      ...{
-        "x-autobe-prerequisites": op.prerequisites,
-        "x-autobe-specification": op.specification,
-        "x-samchon-accessor": op.accessor,
-      },
-    };
-  }
-
-  const result: OpenApi.IDocument = OpenApi.convert({
-    openapi: "3.1.0",
-    paths,
-    components: document.components,
-  } as OpenApiV3_1.IDocument);
-  const migrate: IHttpMigrateApplication = HttpMigration.application(result);
-  migrate.routes.forEach((r) => {
-    if (r.method === "head") return;
-    const name: string = dict.get({
-      method: r.method,
-      path: r.path,
-    });
-    if (r.accessor.length >= 2 && r.accessor.at(-2) === name) r.accessor.pop();
-    r.accessor[r.accessor.length - 1] = name;
-    r.operation()["x-samchon-accessor"] = r.accessor;
-  });
-  return result;
-}
+import { AutoBeOpenApi } from "@autobe/interface";
+import {
+  IHttpMigrateApplication,
+  OpenApi,
+  OpenApiV3_2,
+} from "@typia/interface";
+import { HttpMigration, OpenApiConverter } from "@typia/utils";
+import { HashMap } from "tstl";
+
+import { StringUtil } from "../StringUtil";
+import { AutoBeOpenApiEndpointComparator } from "./AutoBeOpenApiEndpointComparator";
+
+export function transformOpenApiDocument(
+  input: AutoBeOpenApi.IDocument,
+): OpenApi.IDocument {
+  const dict: HashMap<AutoBeOpenApi.IEndpoint, string> = new HashMap(
+    AutoBeOpenApiEndpointComparator.hashCode,
+    AutoBeOpenApiEndpointComparator.equals,
+  );
+  const paths: Record<string, OpenApi.IPath> = {};
+
+  for (const op of input.operations) {
+    dict.set(op, op.name);
+    paths[op.path] ??= {};
+    paths[op.path][op.method] = {
+      summary: StringUtil.summary(op.description),
+      description:
+        op.description +
+        (op.authorizationType !== null &&
+        op.responseBody?.typeName.endsWith(".IAuthorized") === true
+          ? "\n\n@setHeader token.access Authorization"
+          : ""),
+      parameters: op.parameters.map((p) => ({
+        name: p.name,
+        in: "path",
+        schema: p.schema,
+        required: true,
+        description: p.description,
+      })),
+      requestBody: op.requestBody
+        ? {
+            content: {
+              "application/json": {
+                schema: {
+                  $ref: `#/components/schemas/${op.requestBody.typeName}`,
+                },
+              },
+            },
+            description: op.requestBody.description,
+            required: true,
+          }
+        : undefined,
+      responses: op.responseBody
+        ? {
+            [op.method === "post" ? 201 : 200]: {
+              content: {
+                "application/json": {
+                  schema: {
+                    $ref: `#/components/schemas/${op.responseBody.typeName}`,
+                  },
+                },
+              },
+              description: op.responseBody.description,
+            },
+          }
+        : undefined,
+      ...{
+        "x-autobe-authorization-type": op.authorizationType,
+        "x-autobe-authorization-actor": op.authorizationActor,
+        "x-autobe-prerequisites": op.prerequisites,
+        "x-samchon-accessor": op.accessor,
+        "x-autobe-specification": op.specification,
+      },
+    };
+  }
+
+  const document: OpenApi.IDocument = OpenApiConverter.upgradeDocument({
+    openapi: "3.2.0",
+    paths,
+    components: input.components,
+  } as OpenApiV3_2.IDocument);
+  const migrate: IHttpMigrateApplication = HttpMigration.application(document);
+  migrate.routes.forEach((r) => {
+    if (r.method === "head") return;
+    const name: string = dict.get({
+      method: r.method as "post",
+      path: r.path,
+    });
+    if (r.accessor.length >= 2 && r.accessor.at(-2) === name) r.accessor.pop();
+    r.accessor[r.accessor.length - 1] = name;
+    r.operation()["x-samchon-accessor"] = r.accessor;
+  });
+  return document;
+}

package/src/prisma/index.ts

@@ -1 +1 @@
-export * from "./writePrismaApplication";
+export * from "./writePrismaApplication";