@lukoweb/apitogo 0.1.24 → 0.1.38

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>
+  );
+};

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

@@ -1,132 +1,132 @@
-import { useState } from "react";
-import type { SchemaObject } from "../../../oas/parser/index.js";
-import { Badge } from "../../../ui/Badge.js";
-import { Frame, FramePanel } from "../../../ui/Frame.js";
-import { cn } from "../../../util/cn.js";
-import { SchemaView } from "./SchemaView.js";
-import {
-  decideExclusivity,
-  labelForVariant,
-  quickGuards,
-  unionVariants,
-} from "./union-helpers.js";
-
-const DecisionTable = ({
-  variants,
-  schema,
-  selectedVariant,
-  onSelectVariant,
-}: {
-  variants: SchemaObject[];
-  schema: SchemaObject;
-  selectedVariant: string;
-  onSelectVariant: (label: string) => void;
-}) => {
-  const rows = variants.map((v, i) => ({
-    label: labelForVariant(i, v),
-    guards: quickGuards(v, schema),
-  }));
-
-  return (
-    <div className="flex flex-col gap-2 text-sm">
-      <h4 className="font-medium">Decision Table</h4>
-      <div className="border rounded-md overflow-hidden">
-        <table className="w-full">
-          <thead>
-            <tr className="border-b bg-muted/50">
-              <th className="text-left p-2 font-medium">Variant</th>
-              <th className="text-left p-2 font-medium">Matching Criteria</th>
-            </tr>
-          </thead>
-          <tbody className="divide-y">
-            {rows.map((row) => (
-              <tr key={row.label} className="hover:bg-muted/30">
-                <td className="p-2 font-medium">
-                  <button
-                    type="button"
-                    className={cn(
-                      "hover:underline",
-                      selectedVariant === row.label && "text-primary",
-                    )}
-                    onClick={() => onSelectVariant(row.label)}
-                  >
-                    {row.label}
-                  </button>
-                </td>
-                <td className="p-2 text-muted-foreground text-xs">
-                  {row.guards.length > 0
-                    ? row.guards.join(" · ")
-                    : "No specific criteria"}
-                </td>
-              </tr>
-            ))}
-          </tbody>
-        </table>
-      </div>
-    </div>
-  );
-};
-
-export const UnionView = ({
-  schema,
-  cardHeader,
-}: {
-  schema: SchemaObject;
-  cardHeader?: React.ReactNode;
-}) => {
-  const mode = Array.isArray(schema.oneOf)
-    ? "oneOf"
-    : Array.isArray(schema.anyOf)
-      ? "anyOf"
-      : undefined;
-
-  const variants = mode ? unionVariants(schema) : [];
-  const [selectedVariant, setSelectedVariant] = useState(() =>
-    variants[0] ? labelForVariant(0, variants[0]) : "",
-  );
-
-  if (!mode) return null;
-
-  const exclusivity = decideExclusivity(schema);
-
-  const semanticsMessage =
-    exclusivity === "exactly-one" ? (
-      <>
-        Exactly one variant <b>must match</b>.
-      </>
-    ) : (
-      <>
-        At least one variant <b>must match</b>. Multiple variants{" "}
-        <i>may match</i> simultaneously.
-      </>
-    );
-
-  const currentVariantIndex = variants.findIndex(
-    (v, i) => labelForVariant(i, v) === selectedVariant,
-  );
-  const currentVariant =
-    currentVariantIndex >= 0 ? variants[currentVariantIndex] : null;
-
-  return (
-    <Frame>
-      {cardHeader}
-      <FramePanel className="text-sm flex flex-col gap-4">
-        <div className="flex items-center gap-2">
-          <Badge variant="outline">{mode}</Badge>
-          <div className="flex-1 p-2">
-            <span className="text-sm">{semanticsMessage}</span>
-          </div>
-        </div>
-
-        <DecisionTable
-          variants={variants}
-          schema={schema}
-          selectedVariant={selectedVariant}
-          onSelectVariant={setSelectedVariant}
-        />
-        <strong>Properties for {selectedVariant}:</strong>
-        {currentVariant && <SchemaView schema={currentVariant} />}
-      </FramePanel>
-    </Frame>
-  );
-};
+import { useState } from "react";
+import type { SchemaObject } from "../../../oas/parser/index.js";
+import { Badge } from "../../../ui/Badge.js";
+import { Frame, FramePanel } from "../../../ui/Frame.js";
+import { cn } from "../../../util/cn.js";
+import { SchemaView } from "./SchemaView.js";
+import {
+  decideExclusivity,
+  labelForVariant,
+  quickGuards,
+  unionVariants,
+} from "./union-helpers.js";
+
+const DecisionTable = ({
+  variants,
+  schema,
+  selectedVariant,
+  onSelectVariant,
+}: {
+  variants: SchemaObject[];
+  schema: SchemaObject;
+  selectedVariant: string;
+  onSelectVariant: (label: string) => void;
+}) => {
+  const rows = variants.map((v, i) => ({
+    label: labelForVariant(i, v),
+    guards: quickGuards(v, schema),
+  }));
+
+  return (
+    <div className="flex flex-col gap-2 text-sm">
+      <h4 className="font-medium">Decision Table</h4>
+      <div className="border rounded-md overflow-hidden">
+        <table className="w-full">
+          <thead>
+            <tr className="border-b bg-muted/50">
+              <th className="text-left p-2 font-medium">Variant</th>
+              <th className="text-left p-2 font-medium">Matching Criteria</th>
+            </tr>
+          </thead>
+          <tbody className="divide-y">
+            {rows.map((row) => (
+              <tr key={row.label} className="hover:bg-muted/30">
+                <td className="p-2 font-medium">
+                  <button
+                    type="button"
+                    className={cn(
+                      "hover:underline",
+                      selectedVariant === row.label && "text-primary",
+                    )}
+                    onClick={() => onSelectVariant(row.label)}
+                  >
+                    {row.label}
+                  </button>
+                </td>
+                <td className="p-2 text-muted-foreground text-xs">
+                  {row.guards.length > 0
+                    ? row.guards.join(" · ")
+                    : "No specific criteria"}
+                </td>
+              </tr>
+            ))}
+          </tbody>
+        </table>
+      </div>
+    </div>
+  );
+};
+
+export const UnionView = ({
+  schema,
+  cardHeader,
+}: {
+  schema: SchemaObject;
+  cardHeader?: React.ReactNode;
+}) => {
+  const mode = Array.isArray(schema.oneOf)
+    ? "oneOf"
+    : Array.isArray(schema.anyOf)
+      ? "anyOf"
+      : undefined;
+
+  const variants = mode ? unionVariants(schema) : [];
+  const [selectedVariant, setSelectedVariant] = useState(() =>
+    variants[0] ? labelForVariant(0, variants[0]) : "",
+  );
+
+  if (!mode) return null;
+
+  const exclusivity = decideExclusivity(schema);
+
+  const semanticsMessage =
+    exclusivity === "exactly-one" ? (
+      <>
+        Exactly one variant <b>must match</b>.
+      </>
+    ) : (
+      <>
+        At least one variant <b>must match</b>. Multiple variants{" "}
+        <i>may match</i> simultaneously.
+      </>
+    );
+
+  const currentVariantIndex = variants.findIndex(
+    (v, i) => labelForVariant(i, v) === selectedVariant,
+  );
+  const currentVariant =
+    currentVariantIndex >= 0 ? variants[currentVariantIndex] : null;
+
+  return (
+    <Frame>
+      {cardHeader}
+      <FramePanel className="text-sm flex flex-col gap-4">
+        <div className="flex items-center gap-2">
+          <Badge variant="outline">{mode}</Badge>
+          <div className="flex-1 p-2">
+            <span className="text-sm">{semanticsMessage}</span>
+          </div>
+        </div>
+
+        <DecisionTable
+          variants={variants}
+          schema={schema}
+          selectedVariant={selectedVariant}
+          onSelectVariant={setSelectedVariant}
+        />
+        <strong>Properties for {selectedVariant}:</strong>
+        {currentVariant && <SchemaView schema={currentVariant} />}
+      </FramePanel>
+    </Frame>
+  );
+};