@lukoweb/apitogo 0.1.24 → 0.1.37

package/src/lib/oas/parser/upgrade/index.ts

@@ -1,174 +1,174 @@
-import { type RecordAny, traverse } from "../../../util/traverse.js";
-import type { OpenAPIDocument } from "../index.js";
-/**
- * Upgrade from OpenAPI 3.0.x to 3.1.0
- *
- * Taken from https://github.com/scalar/openapi-parser/blob/main/packages/openapi-parser/src/utils/upgradeFromThreeToThreeOne.ts
- * https://www.openapis.org/blog/2021/02/16/migrating-from-openapi-3-0-to-3-1-0
- */
-
-export const upgradeSchema = (schema: RecordAny): OpenAPIDocument => {
-  if (schema.openapi?.startsWith("3.0")) {
-    schema.openapi = "3.1.1";
-  }
-
-  schema = traverse(schema, (sub) => {
-    if (typeof sub.type !== "undefined" && sub.nullable === true) {
-      sub.type = ["null", sub.type];
-      delete sub.nullable;
-    }
-
-    return sub;
-  });
-
-  schema = traverse(schema, (sub) => {
-    if (sub.exclusiveMinimum === true) {
-      sub.exclusiveMinimum = sub.minimum;
-      delete sub.minimum;
-    } else if (sub.exclusiveMinimum === false) {
-      delete sub.exclusiveMinimum;
-    }
-
-    if (sub.exclusiveMaximum === true) {
-      sub.exclusiveMaximum = sub.maximum;
-      delete sub.maximum;
-    } else if (sub.exclusiveMaximum === false) {
-      delete sub.exclusiveMaximum;
-    }
-
-    return sub;
-  });
-
-  schema = traverse(schema, (sub, path) => {
-    if (sub.example !== undefined) {
-      // Arrays in schemas
-      if (isSchemaPath(path ?? [])) {
-        sub.examples = [sub.example];
-      } else {
-        // Objects everywhere else
-        sub.examples = {
-          default: {
-            value: sub.example,
-          },
-        };
-      }
-      delete sub.example;
-    }
-    return sub;
-  });
-
-  // Multipart file uploads with a binary file
-  schema = traverse(schema, (schema, path) => {
-    if (schema.type === "object" && schema.properties !== undefined) {
-      // Check if this is a multipart request body schema
-      const parentPath = path?.slice(0, -1);
-      const isMultipart = parentPath?.some((segment, index) => {
-        return (
-          segment === "content" && path?.[index + 1] === "multipart/form-data"
-        );
-      });
-
-      if (isMultipart) {
-        // Types
-        // biome-ignore lint/suspicious/noExplicitAny: Allow any type
-        const entries: [string, any][] = Object.entries(schema.properties);
-
-        for (const [, value] of entries) {
-          if (
-            typeof value === "object" &&
-            value.type === "string" &&
-            value.format === "binary"
-          ) {
-            value.contentMediaType = "application/octet-stream";
-            delete value.format;
-          }
-        }
-      }
-    }
-
-    return schema;
-  });
-
-  // Uploading a binary file in a POST request
-  schema = traverse(schema, (schema, path) => {
-    if (
-      path?.includes("content") &&
-      path.includes("application/octet-stream")
-    ) {
-      return {};
-    }
-
-    if (schema.type === "string" && schema.format === "binary") {
-      return {
-        type: "string",
-        contentMediaType: "application/octet-stream",
-      };
-    }
-
-    return schema;
-  });
-
-  schema = traverse(schema, (sub) => {
-    if (sub.type === "string" && sub.format === "binary") {
-      // biome-ignore lint/suspicious/noExplicitAny: Allow any type
-      return undefined as any;
-    }
-
-    return sub;
-  });
-
-  // Uploading an image with base64 encoding
-  schema = traverse(schema, (sub) => {
-    if (sub.type === "string" && sub.format === "base64") {
-      return {
-        type: "string",
-        contentEncoding: "base64",
-      };
-    }
-
-    return sub;
-  });
-
-  schema = traverse(schema, (schema, path) => {
-    if (schema.type === "string" && schema.format === "byte") {
-      const parentPath = path?.slice(0, -1);
-      const contentMediaType = parentPath?.find(
-        (_, index) => path?.[index - 1] === "content",
-      );
-
-      return {
-        type: "string",
-        contentEncoding: "base64",
-        contentMediaType,
-      };
-    }
-
-    return schema;
-  });
-
-  return schema as OpenAPIDocument;
-};
-
-export function isSchemaPath(path: string[]): boolean {
-  const schemaLocations = [
-    ["components", "schemas"],
-    "properties",
-    "items",
-    "allOf",
-    "anyOf",
-    "oneOf",
-    "not",
-    "additionalProperties",
-  ];
-
-  return (
-    schemaLocations.some((location) => {
-      if (Array.isArray(location)) {
-        return location.every((segment, index) => path[index] === segment);
-      }
-      return path.includes(location);
-    }) ||
-    path.includes("schema") ||
-    path.some((segment) => segment.endsWith("Schema"))
-  );
-}
+import { type RecordAny, traverse } from "../../../util/traverse.js";
+import type { OpenAPIDocument } from "../index.js";
+/**
+ * Upgrade from OpenAPI 3.0.x to 3.1.0
+ *
+ * Taken from https://github.com/scalar/openapi-parser/blob/main/packages/openapi-parser/src/utils/upgradeFromThreeToThreeOne.ts
+ * https://www.openapis.org/blog/2021/02/16/migrating-from-openapi-3-0-to-3-1-0
+ */
+
+export const upgradeSchema = (schema: RecordAny): OpenAPIDocument => {
+  if (schema.openapi?.startsWith("3.0")) {
+    schema.openapi = "3.1.1";
+  }
+
+  schema = traverse(schema, (sub) => {
+    if (typeof sub.type !== "undefined" && sub.nullable === true) {
+      sub.type = ["null", sub.type];
+      delete sub.nullable;
+    }
+
+    return sub;
+  });
+
+  schema = traverse(schema, (sub) => {
+    if (sub.exclusiveMinimum === true) {
+      sub.exclusiveMinimum = sub.minimum;
+      delete sub.minimum;
+    } else if (sub.exclusiveMinimum === false) {
+      delete sub.exclusiveMinimum;
+    }
+
+    if (sub.exclusiveMaximum === true) {
+      sub.exclusiveMaximum = sub.maximum;
+      delete sub.maximum;
+    } else if (sub.exclusiveMaximum === false) {
+      delete sub.exclusiveMaximum;
+    }
+
+    return sub;
+  });
+
+  schema = traverse(schema, (sub, path) => {
+    if (sub.example !== undefined) {
+      // Arrays in schemas
+      if (isSchemaPath(path ?? [])) {
+        sub.examples = [sub.example];
+      } else {
+        // Objects everywhere else
+        sub.examples = {
+          default: {
+            value: sub.example,
+          },
+        };
+      }
+      delete sub.example;
+    }
+    return sub;
+  });
+
+  // Multipart file uploads with a binary file
+  schema = traverse(schema, (schema, path) => {
+    if (schema.type === "object" && schema.properties !== undefined) {
+      // Check if this is a multipart request body schema
+      const parentPath = path?.slice(0, -1);
+      const isMultipart = parentPath?.some((segment, index) => {
+        return (
+          segment === "content" && path?.[index + 1] === "multipart/form-data"
+        );
+      });
+
+      if (isMultipart) {
+        // Types
+        // biome-ignore lint/suspicious/noExplicitAny: Allow any type
+        const entries: [string, any][] = Object.entries(schema.properties);
+
+        for (const [, value] of entries) {
+          if (
+            typeof value === "object" &&
+            value.type === "string" &&
+            value.format === "binary"
+          ) {
+            value.contentMediaType = "application/octet-stream";
+            delete value.format;
+          }
+        }
+      }
+    }
+
+    return schema;
+  });
+
+  // Uploading a binary file in a POST request
+  schema = traverse(schema, (schema, path) => {
+    if (
+      path?.includes("content") &&
+      path.includes("application/octet-stream")
+    ) {
+      return {};
+    }
+
+    if (schema.type === "string" && schema.format === "binary") {
+      return {
+        type: "string",
+        contentMediaType: "application/octet-stream",
+      };
+    }
+
+    return schema;
+  });
+
+  schema = traverse(schema, (sub) => {
+    if (sub.type === "string" && sub.format === "binary") {
+      // biome-ignore lint/suspicious/noExplicitAny: Allow any type
+      return undefined as any;
+    }
+
+    return sub;
+  });
+
+  // Uploading an image with base64 encoding
+  schema = traverse(schema, (sub) => {
+    if (sub.type === "string" && sub.format === "base64") {
+      return {
+        type: "string",
+        contentEncoding: "base64",
+      };
+    }
+
+    return sub;
+  });
+
+  schema = traverse(schema, (schema, path) => {
+    if (schema.type === "string" && schema.format === "byte") {
+      const parentPath = path?.slice(0, -1);
+      const contentMediaType = parentPath?.find(
+        (_, index) => path?.[index - 1] === "content",
+      );
+
+      return {
+        type: "string",
+        contentEncoding: "base64",
+        contentMediaType,
+      };
+    }
+
+    return schema;
+  });
+
+  return schema as OpenAPIDocument;
+};
+
+export function isSchemaPath(path: string[]): boolean {
+  const schemaLocations = [
+    ["components", "schemas"],
+    "properties",
+    "items",
+    "allOf",
+    "anyOf",
+    "oneOf",
+    "not",
+    "additionalProperties",
+  ];
+
+  return (
+    schemaLocations.some((location) => {
+      if (Array.isArray(location)) {
+        return location.every((segment, index) => path[index] === segment);
+      }
+      return path.includes(location);
+    }) ||
+    path.includes("schema") ||
+    path.some((segment) => segment.endsWith("Schema"))
+  );
+}

package/src/lib/plugins/api-catalog/index.tsx

@@ -1,119 +1,119 @@
-import { matchPath } from "react-router";
-import type { NavigationItem } from "../../../config/validators/NavigationSchema.js";
-import type { AuthState } from "../../authentication/state.js";
-import type { ApitogoPlugin } from "../../core/plugins.js";
-import { joinUrl } from "../../util/joinUrl.js";
-import { slugify } from "../../util/slugify.js";
-
-export const getKey = (category: string, tag: string) =>
-  slugify(`${category}-${tag}`);
-
-export type ApiCatalogItem = {
-  path: string;
-  label: string;
-  description: string;
-  categories: CatalogCategory[];
-};
-
-export type CatalogCategory = {
-  label: string;
-  tags: string[];
-};
-
-export type ApiCatalogPluginOptions = {
-  path: string;
-  label: string;
-  categories?: CatalogCategory[];
-  items: ApiCatalogItem[];
-  filterCatalogItems?: FilterCatalogItemsFn;
-};
-
-export type CatalogContext = {
-  auth: AuthState;
-};
-
-export type FilterCatalogItemsFn = (
-  items: ApiCatalogItem[],
-  { auth }: CatalogContext,
-) => ApiCatalogItem[];
-
-export const apiCatalogPlugin = ({
-  path,
-  items,
-  label,
-  categories = [],
-  filterCatalogItems,
-}: {
-  path: string;
-  label: string;
-  categories?: CatalogCategory[];
-  items: ApiCatalogItem[];
-  filterCatalogItems?: FilterCatalogItemsFn;
-}): ApitogoPlugin => {
-  const paths = Object.fromEntries(
-    categories.flatMap((category) =>
-      [undefined, ...category.tags].map((tag) => [
-        joinUrl(path, tag ? getKey(category.label, tag) : undefined),
-        tag,
-      ]),
-    ),
-  );
-
-  return {
-    getNavigation: async (currentPath) => {
-      const matches = Object.keys(paths).some((path) =>
-        matchPath(path, currentPath),
-      );
-
-      if (!matches) {
-        return [];
-      }
-
-      const navigation: NavigationItem[] = categories.map((category) => ({
-        type: "category",
-        label: category.label,
-        collapsible: false,
-        items: category.tags.map((tag) => ({
-          type: "link",
-          to: joinUrl(path, getKey(category.label, tag)),
-          label: tag,
-          badge: {
-            label: String(
-              items.filter((api) =>
-                api.categories.find((c) => c.tags.includes(tag)),
-              ).length,
-            ),
-            color: "outline",
-          },
-        })),
-      }));
-
-      navigation.unshift({
-        type: "link",
-        to: joinUrl(path),
-        label: "Overview",
-        badge: { label: String(items.length), color: "outline" },
-      });
-
-      return navigation;
-    },
-    getRoutes: () =>
-      Object.entries(paths).map(([path, tag]) => ({
-        path,
-        async lazy() {
-          const { Catalog } = await import("./Catalog.js");
-          return {
-            element: (
-              <Catalog
-                label={label}
-                categoryLabel={tag}
-                items={items}
-                filterCatalogItems={filterCatalogItems}
-                categories={categories}
-              />
-            ),
-          };
-        },
-      })),
-  };
-};
+import { matchPath } from "react-router";
+import type { NavigationItem } from "../../../config/validators/NavigationSchema.js";
+import type { AuthState } from "../../authentication/state.js";
+import type { ApitogoPlugin } from "../../core/plugins.js";
+import { joinUrl } from "../../util/joinUrl.js";
+import { slugify } from "../../util/slugify.js";
+
+export const getKey = (category: string, tag: string) =>
+  slugify(`${category}-${tag}`);
+
+export type ApiCatalogItem = {
+  path: string;
+  label: string;
+  description: string;
+  categories: CatalogCategory[];
+};
+
+export type CatalogCategory = {
+  label: string;
+  tags: string[];
+};
+
+export type ApiCatalogPluginOptions = {
+  path: string;
+  label: string;
+  categories?: CatalogCategory[];
+  items: ApiCatalogItem[];
+  filterCatalogItems?: FilterCatalogItemsFn;
+};
+
+export type CatalogContext = {
+  auth: AuthState;
+};
+
+export type FilterCatalogItemsFn = (
+  items: ApiCatalogItem[],
+  { auth }: CatalogContext,
+) => ApiCatalogItem[];
+
+export const apiCatalogPlugin = ({
+  path,
+  items,
+  label,
+  categories = [],
+  filterCatalogItems,
+}: {
+  path: string;
+  label: string;
+  categories?: CatalogCategory[];
+  items: ApiCatalogItem[];
+  filterCatalogItems?: FilterCatalogItemsFn;
+}): ApitogoPlugin => {
+  const paths = Object.fromEntries(
+    categories.flatMap((category) =>
+      [undefined, ...category.tags].map((tag) => [
+        joinUrl(path, tag ? getKey(category.label, tag) : undefined),
+        tag,
+      ]),
+    ),
+  );
+
+  return {
+    getNavigation: async (currentPath) => {
+      const matches = Object.keys(paths).some((path) =>
+        matchPath(path, currentPath),
+      );
+
+      if (!matches) {
+        return [];
+      }
+
+      const navigation: NavigationItem[] = categories.map((category) => ({
+        type: "category",
+        label: category.label,
+        collapsible: false,
+        items: category.tags.map((tag) => ({
+          type: "link",
+          to: joinUrl(path, getKey(category.label, tag)),
+          label: tag,
+          badge: {
+            label: String(
+              items.filter((api) =>
+                api.categories.find((c) => c.tags.includes(tag)),
+              ).length,
+            ),
+            color: "outline",
+          },
+        })),
+      }));
+
+      navigation.unshift({
+        type: "link",
+        to: joinUrl(path),
+        label: "Overview",
+        badge: { label: String(items.length), color: "outline" },
+      });
+
+      return navigation;
+    },
+    getRoutes: () =>
+      Object.entries(paths).map(([path, tag]) => ({
+        path,
+        async lazy() {
+          const { Catalog } = await import("./Catalog.js");
+          return {
+            element: (
+              <Catalog
+                label={label}
+                categoryLabel={tag}
+                items={items}
+                filterCatalogItems={filterCatalogItems}
+                categories={categories}
+              />
+            ),
+          };
+        },
+      })),
+  };
+};

package/src/lib/plugins/api-keys/ProtectedRoute.tsx

@@ -1,33 +1,33 @@
-import { Outlet } from "react-router";
-import { useAuth } from "../../authentication/hook.js";
-import { DeveloperHint } from "../../components/DeveloperHint.js";
-import { Button } from "../../ui/Button.js";
-
-export const ProtectedRoute = () => {
-  const auth = useAuth();
-
-  // TODO: should we suspend here somehow?
-  if (auth.isAuthEnabled && auth.isPending) {
-    return null;
-  }
-
-  if (!auth.isAuthEnabled) {
-    return (
-      <div className="flex flex-col justify-center gap-2 items-center h-1/2">
-        <DeveloperHint className="max-w-[600px]">
-          Authentication needs to be enabled for API keys to work. Enable it in
-          your Zudoku configuration under <code>authentication</code>.
-        </DeveloperHint>
-      </div>
-    );
-  }
-
-  return auth.isAuthenticated ? (
-    <Outlet />
-  ) : (
-    <div className="flex flex-col justify-center gap-2 items-center h-1/2">
-      Please login first to view this page
-      <Button onClick={() => auth.login()}>Login</Button>
-    </div>
-  );
-};
+import { Outlet } from "react-router";
+import { useAuth } from "../../authentication/hook.js";
+import { DeveloperHint } from "../../components/DeveloperHint.js";
+import { Button } from "../../ui/Button.js";
+
+export const ProtectedRoute = () => {
+  const auth = useAuth();
+
+  // TODO: should we suspend here somehow?
+  if (auth.isAuthEnabled && auth.isPending) {
+    return null;
+  }
+
+  if (!auth.isAuthEnabled) {
+    return (
+      <div className="flex flex-col justify-center gap-2 items-center h-1/2">
+        <DeveloperHint className="max-w-[600px]">
+          Authentication needs to be enabled for API keys to work. Enable it in
+          your Zudoku configuration under <code>authentication</code>.
+        </DeveloperHint>
+      </div>
+    );
+  }
+
+  return auth.isAuthenticated ? (
+    <Outlet />
+  ) : (
+    <div className="flex flex-col justify-center gap-2 items-center h-1/2">
+      Please login first to view this page
+      <Button onClick={() => auth.login()}>Login</Button>
+    </div>
+  );
+};