@lukoweb/apitogo 0.2.22 → 0.2.24

package/src/lib/plugins/openapi/processors/removeExtensions.ts

@@ -1,29 +1,29 @@
-import type { ProcessorArg } from "../../../../config/validators/BuildSchema.js";
-import type { OpenAPIDocument } from "../../../oas/parser/index.js";
-import { type RecordAny, traverse } from "./traverse.js";
-
-interface RemoveExtensionsOptions {
-  keys?: string[];
-  shouldRemove?: (key: string) => boolean;
-}
-
-// Remove all `x-` prefixed key/value pairs, or filter by names if provided
-export const removeExtensions =
-  ({ keys, shouldRemove }: RemoveExtensionsOptions = {}) =>
-  ({ schema }: ProcessorArg) =>
-    traverse(schema, (spec) => {
-      const result: RecordAny = {};
-
-      for (const [key, value] of Object.entries(spec)) {
-        const isExtension = key.startsWith("x-");
-        const shouldBeRemoved =
-          isExtension &&
-          (keys === undefined || keys.includes(key)) &&
-          (!shouldRemove || shouldRemove(key));
-
-        if (shouldBeRemoved) continue;
-
-        result[key] = value;
-      }
-      return result;
-    }) as OpenAPIDocument;
+import type { ProcessorArg } from "../../../../config/validators/BuildSchema.js";
+import type { OpenAPIDocument } from "../../../oas/parser/index.js";
+import { type RecordAny, traverse } from "./traverse.js";
+
+interface RemoveExtensionsOptions {
+  keys?: string[];
+  shouldRemove?: (key: string) => boolean;
+}
+
+// Remove all `x-` prefixed key/value pairs, or filter by names if provided
+export const removeExtensions =
+  ({ keys, shouldRemove }: RemoveExtensionsOptions = {}) =>
+  ({ schema }: ProcessorArg) =>
+    traverse(schema, (spec) => {
+      const result: RecordAny = {};
+
+      for (const [key, value] of Object.entries(spec)) {
+        const isExtension = key.startsWith("x-");
+        const shouldBeRemoved =
+          isExtension &&
+          (keys === undefined || keys.includes(key)) &&
+          (!shouldRemove || shouldRemove(key));
+
+        if (shouldBeRemoved) continue;
+
+        result[key] = value;
+      }
+      return result;
+    }) as OpenAPIDocument;

package/src/lib/plugins/openapi/processors/removeParameters.ts

@@ -1,103 +1,103 @@
-import type { ProcessorArg } from "../../../../config/validators/BuildSchema.js";
-import type { OpenAPIDocument } from "../../../oas/parser/index.js";
-import { type RecordAny, traverse } from "./traverse.js";
-
-interface RemoveParametersOptions {
-  // Names of parameters to remove
-  names?: string[];
-  // Specific locations to remove parameters from ('query', 'header', 'path', 'cookie')
-  in?: string[];
-  // Custom filter function
-  shouldRemove?: ({ parameter }: { parameter: RecordAny }) => boolean;
-}
-
-export const removeParameters =
-  ({ names, in: locations, shouldRemove }: RemoveParametersOptions = {}) =>
-  ({ schema }: ProcessorArg) =>
-    traverse(schema, (spec) => {
-      // Helper function to filter parameters
-      const filterParameters = (parameters: RecordAny[]) =>
-        parameters.filter((p) => {
-          if (names?.includes(p.name)) return false;
-          if (locations?.includes(p.in)) return false;
-          if (shouldRemove?.({ parameter: p })) return false;
-          return true;
-        });
-
-      // Handle components.parameters
-      if (spec.components?.parameters) {
-        spec = {
-          ...spec,
-          components: {
-            ...spec.components,
-            parameters: Object.fromEntries(
-              Object.entries(spec.components.parameters).filter(
-                ([_, param]) => {
-                  const p = param as RecordAny;
-                  if (p.$ref) return true; // Skip references
-                  return (
-                    !names?.includes(p.name) &&
-                    !locations?.includes(p.in) &&
-                    !shouldRemove?.({ parameter: p })
-                  );
-                },
-              ),
-            ),
-          },
-        };
-      }
-
-      // Handle paths
-      if (spec.paths) {
-        const updatedPaths: RecordAny = {};
-
-        for (const [path, pathItem] of Object.entries(spec.paths)) {
-          if (typeof pathItem !== "object" || pathItem === null) {
-            updatedPaths[path] = pathItem;
-            continue;
-          }
-
-          let updatedPathItem = { ...pathItem };
-
-          // Handle path-level parameters
-          if (
-            "parameters" in updatedPathItem &&
-            Array.isArray(updatedPathItem.parameters)
-          ) {
-            updatedPathItem.parameters = filterParameters(
-              updatedPathItem.parameters,
-            );
-          }
-
-          // Handle operation-level parameters
-          for (const method of Object.keys(updatedPathItem)) {
-            const pathItemWithMethods = updatedPathItem as Record<
-              string,
-              RecordAny
-            >;
-
-            if (
-              method === "parameters" ||
-              typeof pathItemWithMethods[method] !== "object"
-            ) {
-              continue;
-            }
-
-            const operation = pathItemWithMethods[method];
-            if (Array.isArray(operation.parameters)) {
-              pathItemWithMethods[method] = {
-                ...operation,
-                parameters: filterParameters(operation.parameters),
-              };
-              updatedPathItem = pathItemWithMethods;
-            }
-          }
-
-          updatedPaths[path] = updatedPathItem;
-        }
-
-        spec = { ...spec, paths: updatedPaths };
-      }
-
-      return spec;
-    }) as OpenAPIDocument;
+import type { ProcessorArg } from "../../../../config/validators/BuildSchema.js";
+import type { OpenAPIDocument } from "../../../oas/parser/index.js";
+import { type RecordAny, traverse } from "./traverse.js";
+
+interface RemoveParametersOptions {
+  // Names of parameters to remove
+  names?: string[];
+  // Specific locations to remove parameters from ('query', 'header', 'path', 'cookie')
+  in?: string[];
+  // Custom filter function
+  shouldRemove?: ({ parameter }: { parameter: RecordAny }) => boolean;
+}
+
+export const removeParameters =
+  ({ names, in: locations, shouldRemove }: RemoveParametersOptions = {}) =>
+  ({ schema }: ProcessorArg) =>
+    traverse(schema, (spec) => {
+      // Helper function to filter parameters
+      const filterParameters = (parameters: RecordAny[]) =>
+        parameters.filter((p) => {
+          if (names?.includes(p.name)) return false;
+          if (locations?.includes(p.in)) return false;
+          if (shouldRemove?.({ parameter: p })) return false;
+          return true;
+        });
+
+      // Handle components.parameters
+      if (spec.components?.parameters) {
+        spec = {
+          ...spec,
+          components: {
+            ...spec.components,
+            parameters: Object.fromEntries(
+              Object.entries(spec.components.parameters).filter(
+                ([_, param]) => {
+                  const p = param as RecordAny;
+                  if (p.$ref) return true; // Skip references
+                  return (
+                    !names?.includes(p.name) &&
+                    !locations?.includes(p.in) &&
+                    !shouldRemove?.({ parameter: p })
+                  );
+                },
+              ),
+            ),
+          },
+        };
+      }
+
+      // Handle paths
+      if (spec.paths) {
+        const updatedPaths: RecordAny = {};
+
+        for (const [path, pathItem] of Object.entries(spec.paths)) {
+          if (typeof pathItem !== "object" || pathItem === null) {
+            updatedPaths[path] = pathItem;
+            continue;
+          }
+
+          let updatedPathItem = { ...pathItem };
+
+          // Handle path-level parameters
+          if (
+            "parameters" in updatedPathItem &&
+            Array.isArray(updatedPathItem.parameters)
+          ) {
+            updatedPathItem.parameters = filterParameters(
+              updatedPathItem.parameters,
+            );
+          }
+
+          // Handle operation-level parameters
+          for (const method of Object.keys(updatedPathItem)) {
+            const pathItemWithMethods = updatedPathItem as Record<
+              string,
+              RecordAny
+            >;
+
+            if (
+              method === "parameters" ||
+              typeof pathItemWithMethods[method] !== "object"
+            ) {
+              continue;
+            }
+
+            const operation = pathItemWithMethods[method];
+            if (Array.isArray(operation.parameters)) {
+              pathItemWithMethods[method] = {
+                ...operation,
+                parameters: filterParameters(operation.parameters),
+              };
+              updatedPathItem = pathItemWithMethods;
+            }
+          }
+
+          updatedPaths[path] = updatedPathItem;
+        }
+
+        spec = { ...spec, paths: updatedPaths };
+      }
+
+      return spec;
+    }) as OpenAPIDocument;

package/src/lib/plugins/openapi/processors/removePaths.ts

@@ -1,57 +1,57 @@
-import type { ProcessorArg } from "../../../../config/validators/BuildSchema.js";
-import type { OpenAPIDocument } from "../../../oas/parser/index.js";
-import { type RecordAny, traverse } from "./traverse.js";
-
-interface RemovePathsOptions {
-  // Path definitions, e.g., { '/path': true, '/path-2': ['get'] }
-  paths?: Record<string, true | string[]>;
-  shouldRemove?: (options: {
-    path: string;
-    method: true | string;
-    operation: RecordAny;
-  }) => boolean;
-}
-
-export const removePaths =
-  ({ paths = {}, shouldRemove }: RemovePathsOptions) =>
-  ({ schema }: ProcessorArg) =>
-    traverse(schema, (spec) => {
-      if (!spec.paths) return spec;
-
-      const updatedPaths: RecordAny = {};
-
-      for (const [path, methods] of Object.entries(spec.paths)) {
-        const operations = spec.paths[path];
-
-        // If the path is explicitly marked for removal in `paths`
-        if (paths[path] === true) continue;
-
-        // If the path should be removed via `shouldRemove`
-        if (shouldRemove?.({ path, method: true, operation: operations }))
-          continue;
-
-        if (typeof methods === "object" && methods !== null) {
-          const filteredPath = Object.fromEntries(
-            Object.entries(methods).filter(([method]) => {
-              const operations = spec.paths[path][method];
-              const isMethodToRemove =
-                Array.isArray(paths[path]) && paths[path].includes(method);
-
-              const isMethodFiltered = shouldRemove?.({
-                path,
-                method,
-                operation: operations,
-              });
-
-              return !isMethodToRemove && !isMethodFiltered;
-            }),
-          );
-
-          updatedPaths[path] = filteredPath;
-        } else {
-          updatedPaths[path] = methods;
-        }
-      }
-
-      return { ...spec, paths: updatedPaths };
-    }) as OpenAPIDocument;
+import type { ProcessorArg } from "../../../../config/validators/BuildSchema.js";
+import type { OpenAPIDocument } from "../../../oas/parser/index.js";
+import { type RecordAny, traverse } from "./traverse.js";
+
+interface RemovePathsOptions {
+  // Path definitions, e.g., { '/path': true, '/path-2': ['get'] }
+  paths?: Record<string, true | string[]>;
+  shouldRemove?: (options: {
+    path: string;
+    method: true | string;
+    operation: RecordAny;
+  }) => boolean;
+}
+
+export const removePaths =
+  ({ paths = {}, shouldRemove }: RemovePathsOptions) =>
+  ({ schema }: ProcessorArg) =>
+    traverse(schema, (spec) => {
+      if (!spec.paths) return spec;
+
+      const updatedPaths: RecordAny = {};
+
+      for (const [path, methods] of Object.entries(spec.paths)) {
+        const operations = spec.paths[path];
+
+        // If the path is explicitly marked for removal in `paths`
+        if (paths[path] === true) continue;
+
+        // If the path should be removed via `shouldRemove`
+        if (shouldRemove?.({ path, method: true, operation: operations }))
+          continue;
+
+        if (typeof methods === "object" && methods !== null) {
+          const filteredPath = Object.fromEntries(
+            Object.entries(methods).filter(([method]) => {
+              const operations = spec.paths[path][method];
+              const isMethodToRemove =
+                Array.isArray(paths[path]) && paths[path].includes(method);
+
+              const isMethodFiltered = shouldRemove?.({
+                path,
+                method,
+                operation: operations,
+              });
+
+              return !isMethodToRemove && !isMethodFiltered;
+            }),
+          );
+
+          updatedPaths[path] = filteredPath;
+        } else {
+          updatedPaths[path] = methods;
+        }
+      }
+
+      return { ...spec, paths: updatedPaths };
+    }) as OpenAPIDocument;

package/src/lib/plugins/openapi/processors/traverse.ts

@@ -1 +1 @@
-export { type RecordAny, traverse } from "../../../util/traverse.js";
+export { type RecordAny, traverse } from "../../../util/traverse.js";

package/src/lib/plugins/openapi/schema/SchemaExampleAndDefault.tsx

@@ -1,39 +1,39 @@
-import type { SchemaObject } from "../../../oas/parser/index.js";
-import { SelectOnClick } from "../components/SelectOnClick.js";
-
-export const SchemaExampleAndDefault = ({
-  schema,
-}: {
-  schema: SchemaObject;
-}) => {
-  const example = schema.examples?.at(0);
-  const defaultValue = schema.default;
-
-  if (example === undefined && defaultValue === undefined) return null;
-
-  return (
-    <div className="flex flex-col gap-1">
-      {example !== undefined && (
-        <div>
-          <span className="text-muted-foreground">Example: </span>
-          <SelectOnClick className="border rounded-sm px-1 font-mono">
-            {typeof example === "object" || typeof example === "boolean"
-              ? JSON.stringify(example)
-              : example}
-          </SelectOnClick>
-        </div>
-      )}
-      {defaultValue !== undefined && (
-        <div>
-          <span className="text-muted-foreground">Default: </span>
-          <SelectOnClick className="border rounded-sm px-1 font-mono">
-            {typeof defaultValue === "object" ||
-            typeof defaultValue === "boolean"
-              ? JSON.stringify(defaultValue)
-              : defaultValue}
-          </SelectOnClick>
-        </div>
-      )}
-    </div>
-  );
-};
+import type { SchemaObject } from "../../../oas/parser/index.js";
+import { SelectOnClick } from "../components/SelectOnClick.js";
+
+export const SchemaExampleAndDefault = ({
+  schema,
+}: {
+  schema: SchemaObject;
+}) => {
+  const example = schema.examples?.at(0);
+  const defaultValue = schema.default;
+
+  if (example === undefined && defaultValue === undefined) return null;
+
+  return (
+    <div className="flex flex-col gap-1">
+      {example !== undefined && (
+        <div>
+          <span className="text-muted-foreground">Example: </span>
+          <SelectOnClick className="border rounded-sm px-1 font-mono">
+            {typeof example === "object" || typeof example === "boolean"
+              ? JSON.stringify(example)
+              : example}
+          </SelectOnClick>
+        </div>
+      )}
+      {defaultValue !== undefined && (
+        <div>
+          <span className="text-muted-foreground">Default: </span>
+          <SelectOnClick className="border rounded-sm px-1 font-mono">
+            {typeof defaultValue === "object" ||
+            typeof defaultValue === "boolean"
+              ? JSON.stringify(defaultValue)
+              : defaultValue}
+          </SelectOnClick>
+        </div>
+      )}
+    </div>
+  );
+};