zuplo 6.68.8 → 6.68.10

package/docs/articles/monetization/meters.mdx

@@ -43,14 +43,17 @@ Track the total number of API requests:
 }
 ```
 
-Each event contains the subscription ID as the `subject` and a `total` field
-with the quantity to record:
+Each event contains the `subscription` ID linking it to a subscription and a
+`total` field in `data` with the quantity to record:
 
 ```json
 {
+  "id": "5c10fade-1c9e-4d6c-8275-c52c36731d3c",
+  "specversion": "1.0",
   "type": "requests",
-  "subject": "sub_xxxxxxxx",
   "source": "monetization-policy",
+  "subject": "customer-id",
+  "subscription": "01KNVXHQG356VA7T7W0V9N21GH",
   "data": {
     "total": 1
   }
@@ -76,9 +79,12 @@ configured to report 50 tokens per request:
 
 ```json
 {
+  "id": "a1b2c3d4-5678-4abc-8def-1234567890ab",
+  "specversion": "1.0",
   "type": "tokens",
-  "subject": "sub_xxxxxxxx",
   "source": "monetization-policy",
+  "subject": "customer-id",
+  "subscription": "01KNVXHQG356VA7T7W0V9N21GH",
   "data": {
     "total": 50
   }
@@ -99,6 +105,22 @@ Track bytes transferred:
 }
 ```
 
+Each event reports the number of bytes transferred:
+
+```json
+{
+  "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
+  "specversion": "1.0",
+  "type": "data_transfer",
+  "source": "monetization-policy",
+  "subject": "customer-id",
+  "subscription": "01KNVXHQG356VA7T7W0V9N21GH",
+  "data": {
+    "total": 4096
+  }
+}
+```
+
 ## Naming Consistency
 
 The meter `eventType` must match the key used in three places:

package/docs/articles/monetization/troubleshooting.md

@@ -155,7 +155,7 @@ curl -X POST https://dev.zuplo.com/v3/metering/{bucketId}/meters/{meterIdOrSlug}
   -H "Authorization: Bearer {API_KEY}" \
   -H "Content-Type: application/json" \
   -d '{
-    "subject": "{SUBSCRIPTION_ID}",
+    "filterSubscription": ["{SUBSCRIPTION_ID}"],
     "from": "2026-03-01T00:00:00Z",
     "to": "2026-03-31T23:59:59Z",
     "windowSize": "DAY"

package/docs/cli/custom-domain-create.mdx

@@ -0,0 +1,91 @@
+---
+title: "Zuplo CLI: Custom Domain Create"
+sidebar_label: custom-domain create
+---
+
+<CliCommand
+  command="custom-domain create"
+  description="Creates a custom domain in your account"
+  options={[
+  {
+    "name": "hostname",
+    "type": "string",
+    "description": "The hostname for the custom domain",
+    "required": false,
+    "deprecated": false,
+    "hidden": false
+  },
+  {
+    "name": "deployment-name",
+    "type": "string",
+    "description": "The deployment name to assign the custom domain to",
+    "required": false,
+    "deprecated": false,
+    "hidden": false
+  },
+  {
+    "name": "custom-domain-type",
+    "type": "string",
+    "description": "The type of custom domain to create. Defaults to api server-side.",
+    "required": false,
+    "deprecated": false,
+    "hidden": false,
+    "choices": [
+      "api",
+      "dev-portal"
+    ]
+  },
+  {
+    "name": "account",
+    "type": "string",
+    "description": "The account name",
+    "required": false,
+    "deprecated": false,
+    "hidden": false
+  },
+  {
+    "name": "output",
+    "type": "string",
+    "description": "Output format",
+    "default": "default",
+    "required": false,
+    "deprecated": false,
+    "hidden": false,
+    "alias": [
+      "o"
+    ],
+    "choices": [
+      "default",
+      "json"
+    ]
+  }
+]}
+  examples={[
+  [
+    "$0 custom-domain create --hostname api.example.com",
+    "Create an unassigned custom domain"
+  ],
+  [
+    "$0 custom-domain create --hostname api.example.com --output json",
+    "Create a custom domain and output the result as JSON"
+  ],
+  [
+    "$0 custom-domain create \\\n  --hostname api.example.com \\\n  --deployment-name production-deployment",
+    "Create and assign a custom domain to a deployment"
+  ],
+  [
+    "$0 custom-domain create \\\n  --hostname docs.example.com \\\n  --deployment-name production-deployment \\\n  --custom-domain-type dev-portal \\\n  --account my-account",
+    "Create a dev portal custom domain on a specific account"
+  ]
+]}
+  usage="$0 custom-domain create --hostname <hostname> [options]"
+>
+
+</CliCommand>
+
+## Global options
+
+The following global options are available for all commands:
+
+- [`--help`](./global-options.mdx#help)
+- [`--api-key`](./global-options.mdx#api-key)

package/docs/cli/custom-domain-delete.mdx

@@ -0,0 +1,79 @@
+---
+title: "Zuplo CLI: Custom Domain Delete"
+sidebar_label: custom-domain delete
+---
+
+<CliCommand
+  command="custom-domain delete"
+  description="Deletes a custom domain in your account"
+  options={[
+  {
+    "name": "hostname",
+    "type": "string",
+    "description": "The hostname for the custom domain",
+    "required": false,
+    "deprecated": false,
+    "hidden": false
+  },
+  {
+    "name": "deployment-name",
+    "type": "string",
+    "description": "The deployment name for assigned domains. Required when the hostname is assigned to multiple deployments.",
+    "required": false,
+    "deprecated": false,
+    "hidden": false
+  },
+  {
+    "name": "account",
+    "type": "string",
+    "description": "The account name",
+    "required": false,
+    "deprecated": false,
+    "hidden": false
+  },
+  {
+    "name": "output",
+    "type": "string",
+    "description": "Output format",
+    "default": "default",
+    "required": false,
+    "deprecated": false,
+    "hidden": false,
+    "alias": [
+      "o"
+    ],
+    "choices": [
+      "default",
+      "json"
+    ]
+  }
+]}
+  examples={[
+  [
+    "$0 custom-domain delete --hostname api.example.com",
+    "Delete an unassigned custom domain or auto-resolve a single deployment assignment"
+  ],
+  [
+    "$0 custom-domain delete --hostname api.example.com --output json",
+    "Delete a custom domain and output the result as JSON"
+  ],
+  [
+    "$0 custom-domain delete \\\n  --hostname api.example.com \\\n  --deployment-name production-deployment",
+    "Delete a deployment-assigned custom domain explicitly"
+  ],
+  [
+    "$0 custom-domain delete \\\n  --hostname docs.example.com \\\n  --deployment-name portal-deployment \\\n  --account my-account",
+    "Delete a custom domain from a specific account"
+  ]
+]}
+  usage="$0 custom-domain delete --hostname <hostname> [options]"
+>
+
+</CliCommand>
+
+## Global options
+
+The following global options are available for all commands:
+
+- [`--help`](./global-options.mdx#help)
+- [`--api-key`](./global-options.mdx#api-key)

package/docs/cli/custom-domain-list.mdx

@@ -0,0 +1,59 @@
+---
+title: "Zuplo CLI: Custom Domain List"
+sidebar_label: custom-domain list
+---
+
+<CliCommand
+  command="custom-domain list"
+  description="Lists the custom domains in your account"
+  options={[
+  {
+    "name": "account",
+    "type": "string",
+    "description": "The account name",
+    "required": false,
+    "deprecated": false,
+    "hidden": false
+  },
+  {
+    "name": "output",
+    "type": "string",
+    "description": "Output format",
+    "default": "default",
+    "required": false,
+    "deprecated": false,
+    "hidden": false,
+    "alias": [
+      "o"
+    ],
+    "choices": [
+      "default",
+      "json"
+    ]
+  }
+]}
+  examples={[
+  [
+    "$0 custom-domain list",
+    "List all custom domains"
+  ],
+  [
+    "$0 custom-domain list --output json",
+    "List all custom domains as JSON"
+  ],
+  [
+    "$0 custom-domain list --account my-account",
+    "Explicitly specify the account"
+  ]
+]}
+  usage="$0 custom-domain list [options]"
+>
+
+</CliCommand>
+
+## Global options
+
+The following global options are available for all commands:
+
+- [`--help`](./global-options.mdx#help)
+- [`--api-key`](./global-options.mdx#api-key)

package/docs/cli/custom-domain-update.mdx

@@ -0,0 +1,79 @@
+---
+title: "Zuplo CLI: Custom Domain Update"
+sidebar_label: custom-domain update
+---
+
+<CliCommand
+  command="custom-domain update"
+  description="Updates the deployment assignment for a custom domain"
+  options={[
+  {
+    "name": "hostname",
+    "type": "string",
+    "description": "The hostname for the custom domain",
+    "required": false,
+    "deprecated": false,
+    "hidden": false
+  },
+  {
+    "name": "deployment-name",
+    "type": "string",
+    "description": "The deployment name to assign the custom domain to. Omit to detach the current assignment.",
+    "required": false,
+    "deprecated": false,
+    "hidden": false
+  },
+  {
+    "name": "account",
+    "type": "string",
+    "description": "The account name",
+    "required": false,
+    "deprecated": false,
+    "hidden": false
+  },
+  {
+    "name": "output",
+    "type": "string",
+    "description": "Output format",
+    "default": "default",
+    "required": false,
+    "deprecated": false,
+    "hidden": false,
+    "alias": [
+      "o"
+    ],
+    "choices": [
+      "default",
+      "json"
+    ]
+  }
+]}
+  examples={[
+  [
+    "$0 custom-domain update \\\n  --hostname api.example.com \\\n  --deployment-name production-deployment",
+    "Reassign a custom domain to a deployment"
+  ],
+  [
+    "$0 custom-domain update --hostname api.example.com --output json",
+    "Update a custom domain and output the result as JSON"
+  ],
+  [
+    "$0 custom-domain update --hostname api.example.com",
+    "Detach the current deployment assignment while preserving the stage"
+  ],
+  [
+    "$0 custom-domain update \\\n  --hostname docs.example.com \\\n  --deployment-name portal-deployment \\\n  --account my-account",
+    "Update a custom domain on a specific account"
+  ]
+]}
+  usage="$0 custom-domain update --hostname <hostname> [options]"
+>
+
+</CliCommand>
+
+## Global options
+
+The following global options are available for all commands:
+
+- [`--help`](./global-options.mdx#help)
+- [`--api-key`](./global-options.mdx#api-key)

package/docs/dev-portal/zudoku/configuration/api-catalog.md

@@ -99,8 +99,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/dev-portal/zudoku/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/dev-portal/zudoku/configuration/authentication.md

@@ -15,8 +15,8 @@ authentication provider you use.
 
 ## Authentication Providers
 
-Dev Portal supports Clerk, Auth0, Supabase, Azure B2C, and any OpenID provider that supports the OpenID
-Connect protocol.
+Dev Portal 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/dev-portal/zudoku/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/dev-portal/zudoku/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/dev-portal/zudoku/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/dev-portal/zudoku/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/dev-portal/zudoku/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/dev-portal/zudoku/custom-plugins.md

@@ -156,11 +156,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/dev-portal/zudoku/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/dev-portal/zudoku/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](/dev-portal/zudoku/configuration/docs#showlastmodified).
+
+```md
+---
+showLastModified: false
+---
+```
+
 ### `draft`
 
 Marks a document as a draft. Draft documents are only visible when running in development mode and
@@ -161,8 +172,8 @@ Here's an example showing multiple frontmatter properties used together:
 ---
 title: Advanced Configuration Guide
 description: Learn how to configure advanced features in Dev Portal 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/dev-portal/zudoku/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": "zuplo",
-  "version": "6.68.8",
+  "version": "6.68.10",
   "type": "module",
   "description": "The programmable API Gateway",
   "author": "Zuplo, Inc.",
@@ -19,9 +19,9 @@
     "zuplo": "zuplo.js"
   },
   "dependencies": {
-    "@zuplo/cli": "6.68.8",
-    "@zuplo/core": "6.68.8",
-    "@zuplo/runtime": "6.68.8",
+    "@zuplo/cli": "6.68.10",
+    "@zuplo/core": "6.68.10",
+    "@zuplo/runtime": "6.68.10",
     "@zuplo/test": "1.4.0"
   }
 }