@clarify-labs/cli 0.10.3 → 0.11.0

package/output/index.cjs

@@ -1,5 +1,5 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const require_engine = require("./engine-BDdPszs2.cjs");
+const require_engine = require("./engine-BfkoyVNo.cjs");
 exports.ClarifyEngine = require_engine.ClarifyEngine;
 exports.createClarifyEngine = require_engine.createClarifyEngine;
 exports.createViteAdapter = require_engine.createViteAdapter;

package/output/index.js

@@ -1,2 +1,2 @@
-import { c as defineConfig, n as createClarifyEngine, s as createViteAdapter, t as ClarifyEngine } from "./engine-CyFtr8Pz.js";
+import { c as defineConfig, n as createClarifyEngine, s as createViteAdapter, t as ClarifyEngine } from "./engine-DfF5RJjC.js";
 export { ClarifyEngine, createClarifyEngine, createViteAdapter, defineConfig };

package/output/parsers/routes/routes.d.ts

@@ -1,4 +1,4 @@
-import { ContentRoute, ContentSection, ClarifyNavigationNode, ClarifyPagesConfig, ClarifyPagesGroup, ClarifyPagesItem, ClarifyRouteIntent, ClarifyLocalizedText, ClarifyTabsConfig, LocalizedNavigation, LocalizedTabbedNavigation, ResolvedClarifyI18nConfig, TabbedNavigation } from '../../types.js';
+import { ContentRoute, ContentSection, ClarifyNavigationNode, ClarifyPagesConfig, ClarifyPagesGroup, ClarifyPagesItem, ClarifyRouteIntent, ClarifyLocalizedText, ClarifyTabsConfig, LocalizedNavigation, LocalizedTabbedNavigation, ResolvedClarifyLocalesConfig, TabbedNavigation } from '../../types.js';
 import { ContentProcessor } from '../content/content.js';
 export type FindContentRoutesOptions = {
     contentProcessor?: ContentProcessor;
@@ -12,15 +12,15 @@ export declare function basePathFromRef(ref: string): string;
 export declare function openAPIPagePathFromRef(ref: string, tagFilter?: string[], explicitPath?: string): string;
 export declare function routePathFromRef(ref: string, explicitPath?: string): string;
 export declare function virtualModuleIdFromRef(ref: string): string;
-export declare function localizedRoutePath(basePath: string, locale: string, _i18n: ResolvedClarifyI18nConfig): string;
+export declare function localizedRoutePath(basePath: string, locale: string, _i18n: ResolvedClarifyLocalesConfig): string;
 export declare function resolveLocalizedText(text: ClarifyLocalizedText | undefined, locale: string, fallbackLocale?: string): string | undefined;
 export declare function findContentRoutes(dir: string, base?: string, options?: FindContentRoutesOptions): Promise<ContentRoute[]>;
-export declare function withAlternates(route: ContentRoute, routes: ContentRoute[], i18n: ResolvedClarifyI18nConfig): ContentRoute;
-export declare function findLocalizedContentRoutes(contentRoot: string, i18n?: ResolvedClarifyI18nConfig, options?: FindContentRoutesOptions): Promise<ContentRoute[]>;
+export declare function withAlternates(route: ContentRoute, routes: ContentRoute[], locales: ResolvedClarifyLocalesConfig): ContentRoute;
+export declare function findLocalizedContentRoutes(contentRoot: string, locales?: ResolvedClarifyLocalesConfig, options?: FindContentRoutesOptions): Promise<ContentRoute[]>;
 export declare function buildNavigation(routes: ContentRoute[]): ClarifyNavigationNode[];
 export declare function routeIntentFromPagesItem(item: ClarifyPagesItem): ClarifyRouteIntent;
-export declare function applyConfiguredPageRoutePaths(routes: ContentRoute[], tabs?: ClarifyTabsConfig, i18n?: ResolvedClarifyI18nConfig): ContentRoute[];
+export declare function applyConfiguredPageRoutePaths(routes: ContentRoute[], tabs?: ClarifyTabsConfig, locales?: ResolvedClarifyLocalesConfig): ContentRoute[];
 export declare function buildNavigationFromTabsConfig(routes: ContentRoute[], tabs: ClarifyTabsConfig): TabbedNavigation;
 export declare function buildNavigationFromConfig(routes: ContentRoute[], config: ClarifyPagesGroup[]): ClarifyNavigationNode[];
-export declare function buildLocalizedNavigation(routes: ContentRoute[], config: ClarifyPagesConfig | undefined, i18n?: ResolvedClarifyI18nConfig): LocalizedNavigation | undefined;
-export declare function buildLocalizedNavigationFromTabsConfig(routes: ContentRoute[], tabs: ClarifyTabsConfig, i18n?: ResolvedClarifyI18nConfig): LocalizedTabbedNavigation | undefined;
+export declare function buildLocalizedNavigation(routes: ContentRoute[], config: ClarifyPagesConfig | undefined, localesConfig?: ResolvedClarifyLocalesConfig): LocalizedNavigation | undefined;
+export declare function buildLocalizedNavigationFromTabsConfig(routes: ContentRoute[], tabs: ClarifyTabsConfig, localesConfig?: ResolvedClarifyLocalesConfig): LocalizedTabbedNavigation | undefined;

package/output/parsers/routes/routes.test-utils.d.ts

@@ -1,4 +1,4 @@
-import { ContentRoute, ResolvedClarifyI18nConfig } from '../../types.js';
+import { ContentRoute, ResolvedClarifyLocalesConfig } from '../../types.js';
 type ContentRouteFixture = Partial<Omit<ContentRoute, 'kind' | 'meta' | 'module' | 'source'>> & {
     kind?: ContentRoute['kind'];
     title?: string;
@@ -16,5 +16,5 @@ type ContentRouteFixture = Partial<Omit<ContentRoute, 'kind' | 'meta' | 'module'
 };
 export declare function contentRoute(route?: ContentRouteFixture): ContentRoute;
 export declare function mdxRoute(route?: ContentRouteFixture): ContentRoute;
-export declare const testI18n: ResolvedClarifyI18nConfig;
+export declare const testI18n: ResolvedClarifyLocalesConfig;
 export {};

package/output/plugins/source-links/source-links.d.ts

@@ -1,3 +1,3 @@
-import { ClarifySourceConfig, ContentRoute } from '../../types.js';
-export declare function createSourceEditUrl(filePath: string, contentRoot: string, source: ClarifySourceConfig): string;
-export declare function attachSourceEditUrls(routes: ContentRoute[], contentRoot: string, source?: ClarifySourceConfig): void;
+import { ClarifyRepositoryConfig, ContentRoute } from '../../types.js';
+export declare function createSourceEditUrl(filePath: string, contentRoot: string, source: ClarifyRepositoryConfig): string;
+export declare function attachSourceEditUrls(routes: ContentRoute[], contentRoot: string, source?: ClarifyRepositoryConfig): void;

package/output/types.d.ts

@@ -19,14 +19,16 @@ export type ClarifyLocaleConfig = {
     label: string;
     dir?: 'ltr' | 'rtl';
 };
-export type ClarifyI18nConfig = {
-    /** Default visible locale. Content is read from rootDirectory/defaultLocale. */
-    defaultLocale?: string;
+export type ClarifyLocalesConfig = {
+    /** Default visible locale. Localized content is read from rootDirectory/<locale>. */
+    default?: string;
     /** Missing translation behavior. Fallback uses default locale content. */
     missing?: 'fallback' | '404' | 'hide';
     locales: ClarifyLocaleConfig[];
 };
-export type ResolvedClarifyI18nConfig = Required<Pick<ClarifyI18nConfig, 'defaultLocale' | 'missing'>> & {
+export type ResolvedClarifyLocalesConfig = {
+    default: string;
+    missing: 'fallback' | '404' | 'hide';
     locales: ClarifyLocaleConfig[];
 };
 export type ClarifyNavbarLink = {
@@ -49,10 +51,10 @@ export type ClarifyVariableValue = ClarifyVariablePrimitive | {
     [key: string]: ClarifyVariableValue;
 };
 export type ClarifyVariablesConfig = Record<string, ClarifyVariableValue>;
-export type ClarifySourceConfig = {
+export type ClarifyRepositoryConfig = {
     /** Repository web URL, for example https://github.com/owner/repo. */
-    repository: string;
-    /** Source branch used for edit links. Default: main. */
+    url?: string;
+    /** Source branch. Default: main. */
     branch?: string;
     /** Directory prefix inside the repository that maps to rootDirectory. */
     directory?: string;
@@ -102,8 +104,6 @@ export type ClarifyThemeConfig = {
     tokens?: ClarifyThemeTokensConfig;
     /** Documentation layout overrides applied on top of the selected preset. */
     layout?: ClarifyThemeLayoutConfig;
-    /** Expose the live theme editor in the built site. Dev mode enables it automatically. */
-    editor?: boolean;
 };
 export type ResolvedClarifyThemeTokensConfig = {
     colors: Required<ClarifyThemeColorTokensConfig>;
@@ -114,7 +114,6 @@ export type ResolvedClarifyThemeConfig = {
     preset: ClarifyThemePreset;
     tokens: ResolvedClarifyThemeTokensConfig;
     layout: ResolvedClarifyThemeLayoutConfig;
-    editor: boolean;
 };
 export type ClarifyPagesItem = string | ClarifyPagesGroup | {
     page: string;
@@ -175,6 +174,44 @@ export type ClarifyTabItem = {
     pages?: ClarifyPagesConfig;
 };
 export type ClarifyTabsConfig = ClarifyTabItem[];
+export type ClarifyNavigationConfig = {
+    /** Links displayed in the top navigation. */
+    links?: ClarifyNavbarLink[];
+    /** Top-level documentation tabs. Each tab owns its sidebar pages. */
+    tabs?: ClarifyTabsConfig;
+};
+export type ClarifyFeatureConfig<Options extends object = Record<never, never>> = boolean | ({
+    enabled?: boolean;
+} & Options);
+export type ClarifyFeaturesConfig = {
+    search?: ClarifyFeatureConfig<{
+        provider?: 'pagefind';
+    }>;
+    repository?: ClarifyFeatureConfig<ClarifyRepositoryConfig>;
+    themeEditor?: ClarifyFeatureConfig;
+    openapi?: ClarifyFeatureConfig<{
+        playground?: boolean;
+    }>;
+};
+export type ResolvedClarifyFeaturesConfig = {
+    search: {
+        enabled: boolean;
+        provider: 'pagefind';
+    };
+    repository: {
+        enabled: boolean;
+        url?: string;
+        branch?: string;
+        directory?: string;
+    };
+    themeEditor: {
+        enabled: boolean;
+    };
+    openapi: {
+        enabled: boolean;
+        playground: boolean;
+    };
+};
 export type ClarifyProjectConfig = {
     /** Site title. Used in Header and SEO meta tags. */
     title?: string;
@@ -182,54 +219,47 @@ export type ClarifyProjectConfig = {
     description?: string;
     /** Canonical public site URL. Enables sitemap.xml and robots.txt generation. */
     siteUrl?: string;
-    /** Source repository configuration for Edit this page links. */
-    source?: ClarifySourceConfig;
+    /** Route prefix where the site is mounted. Default: '/'. */
+    routePrefix?: string;
+    /** Path or URL prefix for emitted assets. Defaults to routePrefix. */
+    assetPrefix?: string;
     /** Path to site logo image (relative to rootDirectory or absolute). Supports light/dark mode. */
     logo?: ClarifyLogoConfig;
     /** URL used when clicking the top navigation logo. Defaults to '/'. */
     homeUrl?: string;
     /** Favicon path or light/dark variants. */
     favicon?: ClarifyFaviconConfig;
-    /** Theme preset, token overrides, and editor options. */
+    /** Theme preset, token overrides, and layout options. */
     theme?: ClarifyThemeConfig;
-    /** Base path for the docs site. Default: '/' */
-    routePrefix?: string;
-    /** Base path or URL for emitted static assets. Defaults to routePrefix. */
-    assetPrefix?: string;
-    /** Top navigation links. */
-    navbar?: {
-        links?: ClarifyNavbarLink[];
-    };
+    /** Top navigation links and documentation tabs. */
+    navigation?: ClarifyNavigationConfig;
     /** Announcement banner displayed at the top of the page. */
     banner?: ClarifyBannerConfig;
     /** Footer configuration. */
     footer?: ClarifyFooterConfig;
+    /** Localized content configuration. */
+    locales?: ClarifyLocalesConfig;
     /** Reusable constants available in supported content via {{ variableName }} placeholders. */
     variables?: ClarifyVariablesConfig;
-    /** Native multi-language support. Locale content lives under rootDirectory/{locale}. */
-    i18n?: ClarifyI18nConfig;
-    /** Top-level documentation tabs. Each tab owns its own sidebar pages. */
-    tabs?: ClarifyTabsConfig;
+    /** Optional product capabilities. All built-in features are enabled by default. */
+    features?: ClarifyFeaturesConfig;
 };
 export type ResolvedProjectConfig = {
     title: string;
-    logo?: ClarifyLogoConfig;
-    homeUrl?: string;
     description: string;
     siteUrl?: string;
-    source?: ClarifySourceConfig;
     routePrefix: string;
     assetPrefix: string;
+    logo?: ClarifyLogoConfig;
+    homeUrl?: string;
     favicon?: ClarifyFaviconConfig;
     theme: ResolvedClarifyThemeConfig;
-    navbar?: {
-        links?: ClarifyNavbarLink[];
-    };
+    navigation?: ClarifyNavigationConfig;
     banner?: ClarifyBannerConfig;
     footer?: ClarifyFooterConfig;
+    locales?: ResolvedClarifyLocalesConfig;
     variables: ClarifyVariablesConfig;
-    i18n?: ResolvedClarifyI18nConfig;
-    tabs?: ClarifyTabsConfig;
+    features: ResolvedClarifyFeaturesConfig;
 };
 export type ContentSection = {
     id: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clarify-labs/cli",
-  "version": "0.10.3",
+  "version": "0.11.0",
   "license": "AGPL-3.0-only",
   "type": "module",
   "repository": {
@@ -39,8 +39,8 @@
   },
   "dependencies": {
     "@apidevtools/swagger-parser": "^12.1.0",
-    "@clarify-labs/renderer": "0.10.3",
-    "@clarify-labs/templates": "0.10.3",
+    "@clarify-labs/renderer": "0.11.0",
+    "@clarify-labs/templates": "0.11.0",
     "@mdx-js/mdx": "^3.1.1",
     "@mdx-js/rollup": "^3.1.1",
     "@shikijs/rehype": "^4.3.0",