@brillout/docpress 0.16.43 → 0.16.44

package/code-blocks/components/ChoiceGroup.tsx

@@ -12,7 +12,7 @@ function ChoiceGroupContainer({
   children,
   choiceGroupAll,
 }: { children: React.ReactNode; choiceGroupAll: ChoiceGroupWithParent[] }) {
-  const renderCustomSelect = choiceGroupAll.some((choiceGroup) => choiceGroup.lvl === 0 && !choiceGroup.hidden)
+  const renderCustomSelect = (choiceGroupAll ?? []).some((choiceGroup) => choiceGroup.lvl === 0 && !choiceGroup.hidden)
   return (
     <div className="choice-group-container">
       {children}
@@ -49,7 +49,7 @@ function ChoiceGroup({ children, choiceGroup }: { children: React.ReactNode; cho
 const OPTION_HEIGHT = 25
 function CustomSelect({ choiceGroup }: { choiceGroup: ChoiceGroupWithParent }) {
   const radioId = useId()
-  const choicesAll = usePageContext().config.docpress.choices
+  const choicesAll = usePageContext().resolved.choices
   const { name: groupName, emptyChoices, default: defaultChoice, hidden, parentChoiceGroup, isBuiltIn } = choiceGroup
   const [selectedChoice, setSelectedChoice] = useCurrentSelection(groupName, defaultChoice)
   const [expanded, setExpanded] = useState(false)
@@ -57,7 +57,7 @@ function CustomSelect({ choiceGroup }: { choiceGroup: ChoiceGroupWithParent }) {
   const [parentSelectedChoice] = useCurrentSelection(parentChoiceGroup?.name || '', parentChoiceGroup?.default || '')
   const setPrevPosition = useRestoreScroll([selectedChoice])
 
-  const { choices } = isBuiltIn ? choiceGroup : choicesAll![groupName]!
+  const choices = (isBuiltIn ? choiceGroup : choicesAll![groupName]!).choices
   const isHidden = parentChoiceGroup ? !parentChoiceGroup.choices.includes(parentSelectedChoice) : hidden
   const isEmptyChoice = (choice: string) => emptyChoices.includes(choice)
   const filteredChoices = choices.filter((choice) => !isEmptyChoice(choice.name))
@@ -104,7 +104,7 @@ function CustomSelect({ choiceGroup }: { choiceGroup: ChoiceGroupWithParent }) {
             readOnly
           />
           <span className="choice-select__option-content">
-            <img src={icon} alt="" aria-hidden="true" style={iconStyle} />
+            {icon && <img src={icon} alt="" aria-hidden="true" style={iconStyle} />}
             {choice}
           </span>
         </label>

package/code-blocks/components/Tabs.tsx

@@ -11,7 +11,7 @@ function Tabs({ choice, hide = [] }: { choice: string; hide: string[] }) {
   const radioId = useId()
   const groupName = choice
   const pageContext = usePageContext()
-  const choicesAll = pageContext.config.docpress.choices
+  const choicesAll = pageContext.resolved.choices
   assertUsage(choicesAll && choicesAll[groupName], `${groupName} is unknown`)
   const { choices, default: defaultChoice } = choicesAll[groupName]
   const [selectedChoice, setSelectedChoice] = useCurrentSelection(groupName, defaultChoice)
@@ -40,7 +40,7 @@ function Tabs({ choice, hide = [] }: { choice: string; hide: string[] }) {
               }}
             />
             <span className="choice-tabs__tab-content">
-              <img src={icon} alt="" aria-hidden="true" style={iconStyle} />
+              {icon && <img src={icon} alt="" aria-hidden="true" style={iconStyle} />}
               {choice}
             </span>
           </label>

package/code-blocks/types.ts

@@ -1,9 +1,10 @@
 export type { ChoiceGroup, ChoiceGroupWithParent, ParentChoiceGroup }
 
-import type { Config } from '../types/Config.js'
+import type { Config, ChoiceItem } from '../types/Config.js'
 
-type ChoiceGroup = NonNullable<Config['choices']>[string] & {
+type ChoiceGroup = Omit<NonNullable<Config['choices']>[string], 'choices'> & {
   name: string
+  choices: ChoiceItem[]
   emptyChoices: string[]
   hidden: boolean
   lvl: number

package/code-blocks/utils/generateChoiceGroupCode.ts

@@ -8,6 +8,7 @@ import type { MdxJsxAttribute, MdxJsxFlowElement, MdxJsxFlowElementData } from '
 import { getVikeConfig } from 'vike/plugin'
 import { assertUsage } from '../../utils/assert.js'
 import { valueToEstree } from 'estree-util-value-to-estree'
+import { resolveChoices } from './resolveChoices.js'
 
 type ChoiceNode = {
   choiceValue: string
@@ -143,7 +144,7 @@ function resolveChoiceGroupNodes(choiceNodes: ChoiceNode[]) {
   const vikeConfig = getVikeConfig()
   const choices = choiceNodes.map((choiceNode) => choiceNode.choiceValue)
   const { choices: choicesConfig } = vikeConfig.config.docpress
-  const choicesAll = { ...CHOICES_BUILT_IN, ...choicesConfig }
+  const choicesAll = resolveChoices({ ...CHOICES_BUILT_IN, ...choicesConfig })
 
   // Resolve to the group that defines ALL of the block's values. Matching a group that merely
   // shares ANY value would mis-resolve a custom group that collides with a built-in on a single
@@ -153,13 +154,12 @@ function resolveChoiceGroupNodes(choiceNodes: ChoiceNode[]) {
   )
   assertUsage(groupName, `Missing group name for [${choices}]. Define it in +docpress.choices.`)
 
-  const emptyChoices = choicesAll[groupName]!.choices.filter((choice) => !choices.includes(choice.name)).map(
-    (choice) => choice.name,
-  )
+  const group = choicesAll[groupName]!
+  const emptyChoices = group.choices.filter((choice) => !choices.includes(choice.name)).map((choice) => choice.name)
 
   const choiceGroup = {
     name: groupName,
-    ...choicesAll[groupName]!,
+    ...group,
     emptyChoices,
   }
 

package/code-blocks/utils/resolveChoices.ts

@@ -0,0 +1,15 @@
+export { resolveChoices }
+export type { ResolvedChoices }
+
+import type { Choice, ChoiceItem } from '../../types/Config.js'
+
+type ResolvedChoices = Record<string, Omit<Choice, 'choices'> & { choices: ChoiceItem[] }>
+
+function resolveChoices(choicesConfig: Record<string, Choice>): ResolvedChoices {
+  return Object.fromEntries(
+    Object.entries(choicesConfig).map(([name, group]) => [name, { ...group, choices: group.choices.map(resolveChoice) }]),
+  )
+}
+function resolveChoice(choice: string | ChoiceItem): ChoiceItem {
+  return typeof choice === 'string' ? { name: choice } : choice
+}

package/dist/code-blocks/components/Tabs.js

@@ -9,7 +9,7 @@ function Tabs({ choice, hide = [] }) {
     const radioId = useId();
     const groupName = choice;
     const pageContext = usePageContext();
-    const choicesAll = pageContext.config.docpress.choices;
+    const choicesAll = pageContext.resolved.choices;
     assertUsage(choicesAll && choicesAll[groupName], `${groupName} is unknown`);
     const { choices, default: defaultChoice } = choicesAll[groupName];
     const [selectedChoice, setSelectedChoice] = useCurrentSelection(groupName, defaultChoice);
@@ -22,6 +22,6 @@ function Tabs({ choice, hide = [] }) {
                     setSelectedChoice(choice);
                 } }),
             React.createElement("span", { className: "choice-tabs__tab-content" },
-                React.createElement("img", { src: icon, alt: "", "aria-hidden": "true", style: iconStyle }),
+                icon && React.createElement("img", { src: icon, alt: "", "aria-hidden": "true", style: iconStyle }),
                 choice)))))));
 }

package/dist/code-blocks/types.d.ts

@@ -1,7 +1,8 @@
 export type { ChoiceGroup, ChoiceGroupWithParent, ParentChoiceGroup };
-import type { Config } from '../types/Config.js';
-type ChoiceGroup = NonNullable<Config['choices']>[string] & {
+import type { Config, ChoiceItem } from '../types/Config.js';
+type ChoiceGroup = Omit<NonNullable<Config['choices']>[string], 'choices'> & {
     name: string;
+    choices: ChoiceItem[];
     emptyChoices: string[];
     hidden: boolean;
     lvl: number;

package/dist/code-blocks/utils/generateChoiceGroupCode.js

@@ -2,6 +2,7 @@ export { generateChoiceGroupCode, expressionToAttribute };
 import { getVikeConfig } from 'vike/plugin';
 import { assertUsage } from '../../utils/assert.js';
 import { valueToEstree } from 'estree-util-value-to-estree';
+import { resolveChoices } from './resolveChoices.js';
 // TODO: determine icon representation for CHOICES_BUILT_IN given lack of SVG/file import support
 // use SVG URLs for now
 const CHOICES_BUILT_IN = {
@@ -118,16 +119,17 @@ function resolveChoiceGroupNodes(choiceNodes) {
     const vikeConfig = getVikeConfig();
     const choices = choiceNodes.map((choiceNode) => choiceNode.choiceValue);
     const { choices: choicesConfig } = vikeConfig.config.docpress;
-    const choicesAll = { ...CHOICES_BUILT_IN, ...choicesConfig };
+    const choicesAll = resolveChoices({ ...CHOICES_BUILT_IN, ...choicesConfig });
     // Resolve to the group that defines ALL of the block's values. Matching a group that merely
     // shares ANY value would mis-resolve a custom group that collides with a built-in on a single
     // value — e.g. a `runtime` group [Node, Bun, Deno, Cloudflare] sharing `Bun` with `pkgManager`.
     const groupName = Object.keys(choicesAll).find((key) => choices.every((choice) => choicesAll[key].choices.some(({ name }) => name === choice)));
     assertUsage(groupName, `Missing group name for [${choices}]. Define it in +docpress.choices.`);
-    const emptyChoices = choicesAll[groupName].choices.filter((choice) => !choices.includes(choice.name)).map((choice) => choice.name);
+    const group = choicesAll[groupName];
+    const emptyChoices = group.choices.filter((choice) => !choices.includes(choice.name)).map((choice) => choice.name);
     const choiceGroup = {
         name: groupName,
-        ...choicesAll[groupName],
+        ...group,
         emptyChoices,
     };
     const mergedChoiceNodes = choiceGroup.choices.map((choice) => {

package/dist/code-blocks/utils/resolveChoices.d.ts

@@ -0,0 +1,7 @@
+export { resolveChoices };
+export type { ResolvedChoices };
+import type { Choice, ChoiceItem } from '../../types/Config.js';
+type ResolvedChoices = Record<string, Omit<Choice, 'choices'> & {
+    choices: ChoiceItem[];
+}>;
+declare function resolveChoices(choicesConfig: Record<string, Choice>): ResolvedChoices;

package/dist/code-blocks/utils/resolveChoices.js

@@ -0,0 +1,7 @@
+export { resolveChoices };
+function resolveChoices(choicesConfig) {
+    return Object.fromEntries(Object.entries(choicesConfig).map(([name, group]) => [name, { ...group, choices: group.choices.map(resolveChoice) }]));
+}
+function resolveChoice(choice) {
+    return typeof choice === 'string' ? { name: choice } : choice;
+}

package/dist/renderer/usePageContext.d.ts

@@ -16,6 +16,7 @@ declare function usePageContextLegacy(): {
     pageTitle: string | null;
     documentTitle: string;
     activeCategoryName: string;
+    choices: import("../code-blocks/utils/resolveChoices.js").ResolvedChoices | undefined;
 };
 declare function usePageContext(): PageContext;
 declare function PageContextProvider({ pageContext, children, }: {

package/dist/resolvePageContext.d.ts

@@ -16,4 +16,5 @@ declare function resolvePageContext(pageContext: PageContextServer): {
     pageTitle: string | null;
     documentTitle: string;
     activeCategoryName: string;
+    choices: import("./code-blocks/utils/resolveChoices.js").ResolvedChoices | undefined;
 };

package/dist/resolvePageContext.js

@@ -4,6 +4,7 @@ import { jsxToTextContent } from './utils/jsxToTextContent.js';
 import pc from '@brillout/picocolors';
 import { parseMarkdownMini } from './parseMarkdownMini.js';
 import { determineNavItemsColumnLayout } from './determineNavItemsColumnLayout.js';
+import { resolveChoices } from './code-blocks/utils/resolveChoices.js';
 function resolvePageContext(pageContext) {
     const config = pageContext.globalContext.config.docpress;
     const { urlPathname } = pageContext;
@@ -45,6 +46,7 @@ function resolvePageContext(pageContext) {
     }
     // Don't show landing page in navigation
     navItemsAll = navItemsAll.filter((navItem) => navItem.url !== '/');
+    const choices = config.choices && resolveChoices(config.choices);
     const resolved = {
         navItemsAll,
         navItemsDetached,
@@ -54,6 +56,7 @@ function resolvePageContext(pageContext) {
         pageTitle,
         documentTitle,
         activeCategoryName,
+        choices,
     };
     return resolved;
 }

package/dist/types/Config.d.ts

@@ -1,4 +1,4 @@
-export type { Config };
+export type { Config, Choice, ChoiceItem };
 import type { HeadingDefinition, HeadingDetachedDefinition } from './Heading.js';
 import type React from 'react';
 type Config = {
@@ -47,11 +47,13 @@ type Category = string | {
     /** Hide from Algolia search */
     hide?: boolean;
 };
+/** A choice. A plain `string` is shorthand for `{ name: string }` (no icon). */
+type ChoiceItem = {
+    name: string;
+    icon?: string;
+    iconStyle?: React.CSSProperties;
+};
 type Choice = {
-    choices: {
-        name: string;
-        icon: string;
-        iconStyle?: React.CSSProperties;
-    }[];
+    choices: (string | ChoiceItem)[];
     default: string;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brillout/docpress",
-  "version": "0.16.43",
+  "version": "0.16.44",
   "type": "module",
   "dependencies": {
     "@brillout/picocolors": "^1.0.10",

package/resolvePageContext.ts

@@ -18,6 +18,7 @@ import { jsxToTextContent } from './utils/jsxToTextContent.js'
 import pc from '@brillout/picocolors'
 import { parseMarkdownMini } from './parseMarkdownMini.js'
 import { determineNavItemsColumnLayout } from './determineNavItemsColumnLayout.js'
+import { resolveChoices } from './code-blocks/utils/resolveChoices.js'
 
 type PageSectionResolved = {
   url: string | null
@@ -80,6 +81,8 @@ function resolvePageContext(pageContext: PageContextServer) {
   // Don't show landing page in navigation
   navItemsAll = navItemsAll.filter((navItem) => navItem.url !== '/')
 
+  const choices = config.choices && resolveChoices(config.choices)
+
   const resolved = {
     navItemsAll,
     navItemsDetached,
@@ -89,6 +92,7 @@ function resolvePageContext(pageContext: PageContextServer) {
     pageTitle,
     documentTitle,
     activeCategoryName,
+    choices,
   }
   return resolved
 }

package/types/Config.ts

@@ -1,4 +1,4 @@
-export type { Config }
+export type { Config, Choice, ChoiceItem }
 
 import type { HeadingDefinition, HeadingDetachedDefinition } from './Heading.js'
 import type React from 'react'
@@ -62,7 +62,9 @@ type Category =
       hide?: boolean
     }
 
+/** A choice. A plain `string` is shorthand for `{ name: string }` (no icon). */
+type ChoiceItem = { name: string; icon?: string; iconStyle?: React.CSSProperties }
 type Choice = {
-  choices: { name: string; icon: string; iconStyle?: React.CSSProperties }[]
+  choices: (string | ChoiceItem)[]
   default: string
 }