@lukoweb/apitogo 0.1.24 → 0.1.37

package/src/config/validators/ModulesSchema.ts

@@ -0,0 +1,312 @@
+import type { ComponentType, ReactNode } from "react";
+import { z } from "zod";
+
+const ModuleToggleSchema = z
+  .object({
+    enabled: z
+      .boolean()
+      .describe("Whether this module is active in the application."),
+  })
+  .partial();
+
+export const DocsModuleSchema = ModuleToggleSchema.extend({
+  files: z.union([z.string(), z.array(z.string())]).optional(),
+  publishMarkdown: z.boolean().optional(),
+  defaultOptions: z
+    .object({
+      toc: z.boolean(),
+      copyPage: z.boolean().optional(),
+      disablePager: z.boolean(),
+      showLastModified: z.boolean(),
+      suggestEdit: z
+        .object({
+          url: z.string(),
+          text: z.string().optional(),
+        })
+        .optional(),
+    })
+    .partial()
+    .optional(),
+  llms: z
+    .object({
+      llmsTxt: z.boolean().optional(),
+      llmsTxtFull: z.boolean().optional(),
+      includeProtected: z.boolean().optional(),
+    })
+    .optional(),
+});
+
+export const LandingLinkSchema = z.object({
+  label: z.string(),
+  href: z.string(),
+});
+
+export const LandingFeatureSchema = z.object({
+  title: z.string(),
+  description: z.string(),
+});
+
+export const LandingHeroSchema = z
+  .object({
+    title: z.string().optional(),
+    subtitle: z.string().optional(),
+    description: z.string().optional(),
+  })
+  .optional();
+
+export const LandingContentSchema = z
+  .object({
+    hero: LandingHeroSchema,
+    features: z.array(LandingFeatureSchema).optional(),
+    primaryAction: LandingLinkSchema.optional(),
+    secondaryAction: LandingLinkSchema.optional(),
+    showPoweredBy: z.boolean().optional(),
+  })
+  .optional();
+
+export const DashboardContentSchema = z
+  .object({
+    title: z.string().optional(),
+    subtitle: z.string().optional(),
+    description: z.string().optional(),
+    quickLinks: z.array(LandingLinkSchema).optional(),
+  })
+  .optional();
+
+export const ProfileContentSchema = z
+  .object({
+    title: z.string().optional(),
+    description: z.string().optional(),
+  })
+  .optional();
+
+export const PlanTierSchema = z.object({
+  name: z.string(),
+  price: z.string().optional(),
+  description: z.string().optional(),
+});
+
+export const PlansContentSchema = z
+  .object({
+    title: z.string().optional(),
+    description: z.string().optional(),
+    tiers: z.array(PlanTierSchema).optional(),
+  })
+  .optional();
+
+export const SubmodulePageFields = {
+  page: z
+    .string()
+    .optional()
+    .describe(
+      "Path to a custom page component file, relative to the project root.",
+    ),
+  component: z
+    .custom<ComponentType | ReactNode>()
+    .optional()
+    .describe("Custom React component for this sub-module page."),
+};
+
+export const LandingModuleSchema = ModuleToggleSchema.extend({
+  path: z.string().default("/").describe("Route path for the landing page."),
+  component: z
+    .custom<ComponentType | ReactNode>()
+    .optional()
+    .describe("Custom React component for the landing page."),
+  page: z
+    .string()
+    .optional()
+    .describe(
+      "Path to a custom landing page component file, relative to the project root.",
+    ),
+  layout: z
+    .enum(["default", "landing", "none"])
+    .default("landing")
+    .describe(
+      "Layout wrapper: landing (header + footer), default (docs layout), or none.",
+    ),
+  content: LandingContentSchema.describe(
+    "Default landing page content when no custom component is provided.",
+  ),
+});
+
+export const UserManagementModuleSchema = ModuleToggleSchema.extend({
+  routes: z
+    .object({
+      login: z.string().default("/signin"),
+      register: z.string().default("/signup"),
+      profile: z.string().default("profile"),
+      logout: z.string().default("/signout"),
+    })
+    .partial()
+    .optional(),
+  page: SubmodulePageFields.page,
+  component: SubmodulePageFields.component,
+  content: ProfileContentSchema.describe(
+    "Default profile page content when no custom component is provided.",
+  ),
+});
+
+export const ApiKeysModuleSchema = ModuleToggleSchema.extend({
+  path: z
+    .string()
+    .default("settings/api-keys")
+    .describe("Route path for API key management."),
+});
+
+export const PlansModuleSchema = ModuleToggleSchema.extend({
+  path: z
+    .string()
+    .default("plans")
+    .describe("Route path for plans and subscription management."),
+  page: SubmodulePageFields.page,
+  component: SubmodulePageFields.component,
+  content: PlansContentSchema.describe(
+    "Default plans page content when no custom component is provided.",
+  ),
+});
+
+export const DashboardModuleSchema = ModuleToggleSchema.extend({
+  path: z
+    .string()
+    .default("dashboard")
+    .describe("Route path for the user dashboard."),
+  page: SubmodulePageFields.page,
+  component: SubmodulePageFields.component,
+  content: DashboardContentSchema.describe(
+    "Default dashboard page content when no custom component is provided.",
+  ),
+});
+
+export const UserPanelModuleSchema = ModuleToggleSchema.extend({
+  basePath: z
+    .string()
+    .default("/account")
+    .describe("Base path prefix for user panel routes."),
+  dashboard: DashboardModuleSchema.optional(),
+  userManagement: UserManagementModuleSchema.optional(),
+  apiKeys: ApiKeysModuleSchema.optional(),
+  plans: PlansModuleSchema.optional(),
+});
+
+export const ModulesSchema = z
+  .object({
+    docs: DocsModuleSchema.optional().describe(
+      "Documentation module — MD/MDX pages and OpenAPI reference.",
+    ),
+    landing: LandingModuleSchema.optional().describe(
+      "Landing page module — marketing or home page.",
+    ),
+    userPanel: UserPanelModuleSchema.optional().describe(
+      "User panel module — authenticated user area with sub-modules.",
+    ),
+  })
+  .optional();
+
+export type DocsModuleConfig = z.infer<typeof DocsModuleSchema>;
+export type LandingModuleConfig = z.infer<typeof LandingModuleSchema>;
+export type UserManagementModuleConfig = z.infer<
+  typeof UserManagementModuleSchema
+>;
+export type ApiKeysModuleConfig = z.infer<typeof ApiKeysModuleSchema>;
+export type PlansModuleConfig = z.infer<typeof PlansModuleSchema>;
+export type DashboardModuleConfig = z.infer<typeof DashboardModuleSchema>;
+export type UserPanelModuleConfig = z.infer<typeof UserPanelModuleSchema>;
+export type ModulesConfig = z.infer<typeof ModulesSchema>;
+
+export type ResolvedDocsModule = {
+  enabled: boolean;
+  files?: string | string[];
+  publishMarkdown?: boolean;
+  defaultOptions?: DocsModuleConfig["defaultOptions"];
+  llms?: DocsModuleConfig["llms"];
+};
+
+export type LandingLinkConfig = z.infer<typeof LandingLinkSchema>;
+export type LandingFeatureConfig = z.infer<typeof LandingFeatureSchema>;
+export type LandingContentConfig = z.infer<typeof LandingContentSchema>;
+export type DashboardContentConfig = z.infer<typeof DashboardContentSchema>;
+export type ProfileContentConfig = z.infer<typeof ProfileContentSchema>;
+export type PlansContentConfig = z.infer<typeof PlansContentSchema>;
+export type PlanTierConfig = z.infer<typeof PlanTierSchema>;
+
+export type ResolvedLandingContent = {
+  hero?: {
+    title?: string;
+    subtitle?: string;
+    description?: string;
+  };
+  features?: LandingFeatureConfig[];
+  primaryAction?: LandingLinkConfig;
+  secondaryAction?: LandingLinkConfig;
+  showPoweredBy?: boolean;
+};
+
+export type ResolvedLandingModule = {
+  enabled: boolean;
+  path: string;
+  component?: ComponentType | ReactNode;
+  layout: "default" | "landing" | "none";
+  content: ResolvedLandingContent;
+};
+
+export type ResolvedDashboardContent = {
+  title?: string;
+  subtitle?: string;
+  description?: string;
+  quickLinks?: LandingLinkConfig[];
+};
+
+export type ResolvedProfileContent = {
+  title?: string;
+  description?: string;
+};
+
+export type ResolvedPlansContent = {
+  title?: string;
+  description?: string;
+  tiers?: PlanTierConfig[];
+};
+
+export type ResolvedUserManagementModule = {
+  enabled: boolean;
+  routes: {
+    login: string;
+    register: string;
+    profile: string;
+    logout: string;
+  };
+  content: ResolvedProfileContent;
+};
+
+export type ResolvedApiKeysModule = {
+  enabled: boolean;
+  path: string;
+};
+
+export type ResolvedPlansModule = {
+  enabled: boolean;
+  path: string;
+  content: ResolvedPlansContent;
+};
+
+export type ResolvedDashboardModule = {
+  enabled: boolean;
+  path: string;
+  content: ResolvedDashboardContent;
+};
+
+export type ResolvedUserPanelModule = {
+  enabled: boolean;
+  basePath: string;
+  dashboard: ResolvedDashboardModule;
+  userManagement: ResolvedUserManagementModule;
+  apiKeys: ResolvedApiKeysModule;
+  plans: ResolvedPlansModule;
+};
+
+export type ResolvedModulesConfig = {
+  docs: ResolvedDocsModule;
+  landing: ResolvedLandingModule;
+  userPanel: ResolvedUserPanelModule;
+};

package/src/config/validators/ProtectedRoutesSchema.ts

@@ -1,35 +1,35 @@
-import { z } from "zod/mini";
-import type { UseAuthReturn } from "../../lib/authentication/hook.js";
-import type { ZudokuContext } from "../../lib/core/ZudokuContext.js";
-import { normalizeProtectedRoutes } from "../../lib/core/ZudokuContext.js";
-import {
-  type ProtectedRouteResult,
-  type ReasonCode,
-  REASON_CODES,
-} from "./reason-codes.js";
-
-export { REASON_CODES, type ReasonCode, type ProtectedRouteResult };
-
-export type CallbackContext = {
-  auth: UseAuthReturn;
-  context: ZudokuContext;
-  reasonCode: typeof REASON_CODES;
-};
-type ProtectedRouteCallback = (c: CallbackContext) => ProtectedRouteResult;
-export type ProtectedRoutesInput = z.input<typeof ProtectedRoutesInputSchema>;
-export type ProtectedRoutes = z.output<typeof ProtectedRoutesInputSchema>;
-
-export const ProtectedRoutesInputSchema = z.optional(
-  z.union([
-    z.array(z.string()),
-    z.record(
-      z.string(),
-      z.custom<ProtectedRouteCallback>((val) => typeof val === "function"),
-    ),
-  ]),
-);
-
-export const ProtectedRoutesSchema = z.pipe(
-  ProtectedRoutesInputSchema,
-  z.transform(normalizeProtectedRoutes),
-);
+import { z } from "zod/mini";
+import type { UseAuthReturn } from "../../lib/authentication/hook.js";
+import type { ZudokuContext } from "../../lib/core/ZudokuContext.js";
+import { normalizeProtectedRoutes } from "../../lib/core/ZudokuContext.js";
+import {
+  type ProtectedRouteResult,
+  type ReasonCode,
+  REASON_CODES,
+} from "./reason-codes.js";
+
+export { REASON_CODES, type ReasonCode, type ProtectedRouteResult };
+
+export type CallbackContext = {
+  auth: UseAuthReturn;
+  context: ZudokuContext;
+  reasonCode: typeof REASON_CODES;
+};
+type ProtectedRouteCallback = (c: CallbackContext) => ProtectedRouteResult;
+export type ProtectedRoutesInput = z.input<typeof ProtectedRoutesInputSchema>;
+export type ProtectedRoutes = z.output<typeof ProtectedRoutesInputSchema>;
+
+export const ProtectedRoutesInputSchema = z.optional(
+  z.union([
+    z.array(z.string()),
+    z.record(
+      z.string(),
+      z.custom<ProtectedRouteCallback>((val) => typeof val === "function"),
+    ),
+  ]),
+);
+
+export const ProtectedRoutesSchema = z.pipe(
+  ProtectedRoutesInputSchema,
+  z.transform(normalizeProtectedRoutes),
+);