zudoku 0.73.0 → 0.74.0

package/dist/cli/cli.js

@@ -3276,7 +3276,10 @@ var init_ZudokuConfig = __esm({
       keywords: z7.array(z7.string()),
       authors: z7.array(z7.string()),
       creator: z7.string(),
-      publisher: z7.string()
+      publisher: z7.string(),
+      robots: z7.string().describe(
+        'Sets the contents of the `meta[name="robots"]` tag. For example: `noindex, nofollow`.'
+      )
     }).partial();
     FontConfigSchema = z7.union([
       z7.enum(GOOGLE_FONTS),
@@ -3810,7 +3813,7 @@ import {
 // package.json
 var package_default = {
   name: "zudoku",
-  version: "0.72.0",
+  version: "0.73.1",
   type: "module",
   sideEffects: [
     "**/*.css",
@@ -8019,9 +8022,10 @@ var runPrerender = async (options) => {
       rewrites
     });
     if (ZuploEnv.isZuplo && issuer) {
+      const provider = config2.authentication?.type;
       await writeFile5(
         path22.join(dir, DIST_DIR, ".output/zuplo.json"),
-        JSON.stringify({ issuer }, null, 2),
+        JSON.stringify({ issuer, provider }, null, 2),
         "utf-8"
       );
     }

package/dist/declarations/config/validators/ZudokuConfig.d.ts

@@ -6652,6 +6652,7 @@ export declare const ZudokuConfig: z.ZodObject<{
         authors: z.ZodOptional<z.ZodArray<z.ZodString>>;
         creator: z.ZodOptional<z.ZodString>;
         publisher: z.ZodOptional<z.ZodString>;
+        robots: z.ZodOptional<z.ZodString>;
     }, z.core.$strip>>;
     authentication: z.ZodOptional<z.ZodDiscriminatedUnion<[z.ZodObject<{
         type: z.ZodLiteral<"clerk">;

package/dist/declarations/lib/core/ZudokuContext.d.ts

@@ -45,6 +45,7 @@ type Metadata = Partial<{
     authors: string[];
     creator: string;
     publisher: string;
+    robots: string;
 }>;
 type Site = Partial<{
     dir?: "ltr" | "rtl";

package/dist/flat-config.d.ts

@@ -236,6 +236,10 @@ export interface FlatZudokuConfig {
     authors?: string[]
     creator?: string
     publisher?: string
+    /**
+     * Sets the contents of the `meta[name="robots"]` tag. For example: `noindex, nofollow`.
+     */
+    robots?: string
   }
   authentication?: ({
     type: "clerk"

package/docs/configuration/api-catalog.md

@@ -100,8 +100,8 @@ const config = {
   catalogs: {
     path: "/catalog",
     label: "API Catalog",
-    filterItems: (items, { auth: AuthState }) => {
-      return items.filter((items) => items.tags.includes(auth));
+    filterItems: (items, { auth }) => {
+      return items.filter((item) => item.tags.includes("public"));
     },
   },
   // ...

package/docs/configuration/api-reference.md

@@ -201,8 +201,8 @@ const config = {
     options: {
       examplesLanguage: "shell", // Default language for code examples
       supportedLanguages: [
-        { label: "cURL", language: "shell" },
-        { label: "JavaScript", language: "javascript" },
+        { value: "shell", label: "cURL" },
+        { value: "javascript", label: "JavaScript" },
       ],
       disablePlayground: false, // Disable the interactive API playground
       disableSidecar: false, // Disable the sidecar completely
@@ -220,8 +220,8 @@ const config = {
 Available options:
 
 - `examplesLanguage`: Set default language for code examples
-- `supportedLanguages`: Array of language options for code examples. Each option has `label`
-  (display name) and `language` (code identifier)
+- `supportedLanguages`: Array of language options for code examples. Each option has `value` (code
+  identifier) and `label` (display name)
 - `disablePlayground`: Disable the interactive API playground globally
 - `disableSidecar`: Disable the sidecar panel completely
 - `showVersionSelect`: Control version selector visibility

package/docs/configuration/authentication.md

@@ -15,8 +15,8 @@ authentication provider you use.
 
 ## Authentication Providers
 
-Zudoku supports Clerk, Auth0, Supabase, Azure B2C, and any OpenID provider that supports the OpenID
-Connect protocol.
+Zudoku supports Clerk, Auth0, Supabase, Firebase, Azure B2C, and any OpenID provider that supports
+the OpenID Connect protocol (including PingFederate).
 
 Not seeing your authentication provider? [Let us know](https://github.com/zuplo/zudoku/issues)
 
@@ -96,6 +96,32 @@ When configuring your OpenID provider, you will need to set the following:
 By default, the scopes "openid", "profile", and "email" are requested. You can customize these by
 providing your own array of scopes.
 
+### Firebase
+
+For Firebase authentication, you will need your Firebase project configuration. You can find this in
+the Firebase console under Project Settings.
+
+```typescript title="zudoku.config.ts"
+{
+  // ...
+  authentication: {
+    type: "firebase",
+    apiKey: "<your-firebase-api-key>",
+    authDomain: "<your-project>.firebaseapp.com",
+    projectId: "<your-project-id>",
+    appId: "<your-app-id>",
+    providers: ["google", "github", "password"], // Optional
+  },
+  // ...
+}
+```
+
+The `providers` option configures which sign-in methods are available. Supported providers include:
+`google`, `facebook`, `twitter`, `github`, `microsoft`, `apple`, `yahoo`, `password`, `phone`, and
+`emailLink`.
+
+For detailed setup instructions, see the [Firebase setup guide](./authentication-firebase.md).
+
 ### Supabase
 
 To use Supabase as your authentication provider, supply your project's URL, API key, and the OAuth

package/docs/configuration/docs.md

@@ -149,8 +149,7 @@ docs: {
 
 #### `showLastModified`
 
-**Type:** `boolean`  
-**Default:** `false`
+**Type:** `boolean` **Default:** `true`
 
 Whether to show the last modified date by default.
 

package/docs/configuration/footer.mdx

@@ -14,7 +14,7 @@ copyright notice, and logo.
 
 ## Basic Configuration
 
-The footer is configured in your `zudoku.config.tsx` file under the `page.footer` property:
+The footer is configured in your `zudoku.config.tsx` file under the `site.footer` property:
 
 ```tsx
 const config: ZudokuConfig = {
@@ -90,8 +90,8 @@ footer: {
       href: "https://github.com/yourusername",
     },
     {
-      icon: "twitter",
-      href: "https://twitter.com/yourhandle",
+      icon: "x",
+      href: "https://x.com/yourhandle",
       label: "Follow us", // optional label text
     },
   ];

package/docs/configuration/navigation.mdx

@@ -92,6 +92,7 @@ type NavigationLink = {
   to: string;
   label: string;
   icon?: string; // Lucide icon name
+  target?: "_self" | "_blank";
   badge?: {
     label: string;
     color: "green" | "blue" | "yellow" | "red" | "purple" | "indigo" | "gray" | "outline";
@@ -103,7 +104,6 @@ type NavigationLink = {
     | "always"
     | "hide"
     | ((params: { context: ZudokuContext; auth: UseAuthReturn }) => boolean);
-  target?: "_self" | "_blank";
 };
 ```
 </details>

package/docs/configuration/overview.md

@@ -179,6 +179,43 @@ below.
 }
 ```
 
+### `header`
+
+Configures the header navigation and placement of header elements (navigation, search, auth).
+
+```ts
+{
+  header: {
+    navigation: [
+      { label: "Docs", id: "docs" },
+      { label: "API", id: "api" },
+    ],
+    placements: {
+      navigation: "start",    // "start" | "center" | "end"
+      search: "end",          // "start" | "center" | "end"
+      auth: "end",            // "start" | "center" | "end" | "navigation"
+    },
+  }
+}
+```
+
+### `defaults`
+
+Sets global default options for APIs that apply to all API configurations. Individual API options
+will override these defaults when specified.
+
+```ts
+{
+  defaults: {
+    apis: {
+      examplesLanguage: "shell",
+      disablePlayground: false,
+      showVersionSelect: "if-available",
+    },
+  }
+}
+```
+
 ### `docs`
 
 Configures where your non API reference documentation can be found in your folder structure. The

package/docs/configuration/site.md

@@ -70,6 +70,18 @@ The `reloadDocument` option controls whether clicking the logo triggers a full p
 the default) or uses client-side SPA navigation (`false`). A full reload is useful when your landing
 page is served by a different system (e.g. a CMS) outside of Zudoku.
 
+#### Direction (RTL/LTR)
+
+Set the text direction for your site. This is useful for right-to-left languages:
+
+```tsx title=zudoku.config.tsx
+{
+  site: {
+    dir: "rtl", // "ltr" (default) or "rtl"
+  }
+}
+```
+
 #### Colors & Theme
 
 We allow you to fully customize all colors, borders, etc - read more about it in

package/docs/custom-plugins.md

@@ -157,11 +157,15 @@ const navigationPlugin: ZudokuPlugin = {
       },
     ];
   },
-  getSidebar: async (path: string) => {
-    // Return custom sidebar items
-    return {
-      items: [{ id: "custom", label: "Custom Page" }],
-    };
+  getNavigation: async (path: string, context) => {
+    // Return custom navigation items
+    return [
+      {
+        type: "link",
+        to: "/custom",
+        label: "Custom Page",
+      },
+    ];
   },
 };
 ```

package/docs/deploy/vercel.md

@@ -74,7 +74,7 @@ information.
 
 :::caution{title="Redirects"}
 
-If you have redirects configured in your Zuplo configuration, you will need to also add those to
+If you have redirects configured in your Zudoku configuration, you will need to also add those to
 your `vercel.json` file. See the
 [Vercel Configuration](https://vercel.com/docs/projects/project-configuration#redirects) for more
 information.

package/docs/guides/using-multiple-apis.md

@@ -79,7 +79,7 @@ export default config;
 
 Make sure that:
 
-1. The `path` in each API config matches the `href` in the navigation
+1. The `path` in each API config matches the `to` in the navigation
 2. Your OpenAPI files are placed in the correct location as specified in the `input` field
 3. The `label` in navigation matches what you want to display in the sidebar
 

package/docs/markdown/frontmatter.md

@@ -46,9 +46,7 @@ category: Getting Started
 ---
 ```
 
-### `navigation_label`
-
-_Deprecated (`sidebar_label`)_
+### `sidebar_label`
 
 Sets a custom label for the page in the sidebar navigation, allowing you to use a shorter or
 different title than the main page title.
@@ -56,23 +54,25 @@ different title than the main page title.
 ```md
 ---
 title: My Very Long Documentation Page Title
-navigation_label: Short Title
+sidebar_label: Short Title
 ---
 ```
 
-### `navigation_icon`
+The legacy name `navigation_label` is also supported but `sidebar_label` is preferred.
 
-_Deprecated (`sidebar_icon`)_
+### `sidebar_icon`
 
 Specifies a [Lucide icon](https://lucide.dev/icons) to display next to the page in the sidebar
 navigation.
 
 ```md
 ---
-navigation_icon: compass
+sidebar_icon: compass
 ---
 ```
 
+The legacy name `navigation_icon` is also supported but `sidebar_icon` is preferred.
+
 ### `navigation_display`
 
 Specifies the display property of the navigation item. See the
@@ -106,6 +106,17 @@ disable_pager: true
 ---
 ```
 
+### `showLastModified`
+
+Controls whether the last modified date is displayed for this page. Can be used to override the
+[default option](/docs/configuration/docs#showlastmodified).
+
+```md
+---
+showLastModified: false
+---
+```
+
 ### `draft`
 
 Marks a document as a draft. Draft documents are only visible when running in development mode and
@@ -162,8 +173,8 @@ Here's an example showing multiple frontmatter properties used together:
 title: Advanced Configuration Guide
 description: Learn how to configure advanced features in Zudoku
 category: Configuration
-navigation_label: Advanced Config
-navigation_icon: settings
+sidebar_label: Advanced Config
+sidebar_icon: settings
 toc: true
 disable_pager: false
 draft: false

package/docs/markdown/overview.md

@@ -147,7 +147,7 @@ files:
 ---
 title: My Page Title
 description: Page description for SEO
-navigation_icon: book
+sidebar_icon: book
 category: Getting Started
 ---
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "zudoku",
-  "version": "0.73.0",
+  "version": "0.74.0",
   "type": "module",
   "sideEffects": [
     "**/*.css",
@@ -283,7 +283,7 @@
     "@types/unist": "3.0.3",
     "@types/yargs": "17.0.35",
     "@vitest/coverage-v8": "4.0.18",
-    "happy-dom": "20.8.3",
+    "happy-dom": "20.8.9",
     "oxc-parser": "^0.119.0",
     "react": "19.2.4",
     "react-dom": "19.2.4",

package/src/config/validators/ZudokuConfig.ts

@@ -506,6 +506,11 @@ const MetadataSchema = z
     authors: z.array(z.string()),
     creator: z.string(),
     publisher: z.string(),
+    robots: z
+      .string()
+      .describe(
+        'Sets the contents of the `meta[name="robots"]` tag. For example: `noindex, nofollow`.',
+      ),
   })
   .partial();
 

package/src/lib/components/Meta.tsx

@@ -39,6 +39,7 @@ export const Meta = ({ children }: PropsWithChildren) => {
         ))}
         {meta?.creator && <meta name="creator" content={meta.creator} />}
         {meta?.publisher && <meta name="publisher" content={meta.publisher} />}
+        {meta?.robots && <meta name="robots" content={meta.robots} />}
       </Helmet>
       {children}
     </>

package/src/lib/core/ZudokuContext.ts

@@ -65,6 +65,7 @@ type Metadata = Partial<{
   authors: string[];
   creator: string;
   publisher: string;
+  robots: string;
 }>;
 
 type Site = Partial<{

package/src/vite/build.ts

@@ -167,9 +167,11 @@ const runPrerender = async (options: PrerenderOptions) => {
     });
 
     if (ZuploEnv.isZuplo && issuer) {
+      const provider = config.authentication?.type;
+
       await writeFile(
         path.join(dir, DIST_DIR, ".output/zuplo.json"),
-        JSON.stringify({ issuer }, null, 2),
+        JSON.stringify({ issuer, provider }, null, 2),
         "utf-8",
       );
     }