pulumi-package-docs 0.8.0 → 0.9.1

package/src/routes/providers.$name.functions.$token.tsx

@@ -2,16 +2,19 @@ import { Link, createFileRoute, notFound } from '@tanstack/react-router'
 
 import { MemberDetail } from '@/components/MemberDetail'
 import { getProvider } from '@/lib/pulumi/api'
-import { tokenDisplayName } from '@/lib/pulumi/token'
+import { findTokenBySlug, tokenDisplayName } from '@/lib/pulumi/token'
 
 export const Route = createFileRoute('/providers/$name/functions/$token')({
   loader: async ({ params }) => {
     const entry = await getProvider({ data: params.name })
-    const fn = entry?.schema?.functions?.[params.token]
-    if (!fn) throw notFound()
+    const functions = entry?.schema?.functions
+    const token =
+      functions && findTokenBySlug(Object.keys(functions), params.token)
+    const fn = token ? functions[token] : undefined
+    if (!token || !fn) throw notFound()
     return {
       providerName: params.name,
-      token: params.token,
+      token,
       fn,
       runtime: entry?.runtime,
     }

package/src/routes/providers.$name.index.tsx

@@ -3,7 +3,7 @@ import { Link, createFileRoute, notFound } from '@tanstack/react-router'
 import { getProvider } from '@/lib/pulumi/api'
 import { resolveDescription } from '@/lib/pulumi/description'
 import { summarizeDescription } from '@/lib/pulumi/examples'
-import { tokenDisplayName } from '@/lib/pulumi/token'
+import { tokenDisplayName, tokenSlug } from '@/lib/pulumi/token'
 import type { SchemaFunction, SchemaResource } from '@/lib/pulumi/types'
 
 export const Route = createFileRoute('/providers/$name/')({
@@ -43,7 +43,7 @@ function MemberListItem({
 
   return (
     <li className="doc-list-item">
-      <Link to={to} params={{ name: providerName, token }}>
+      <Link to={to} params={{ name: providerName, token: tokenSlug(token) }}>
         <code>{tokenDisplayName(token)}</code>
       </Link>
       {deprecated && <span className="badge badge-warning">Deprecated</span>}

package/src/routes/providers.$name.resources.$token.tsx

@@ -2,16 +2,19 @@ import { Link, createFileRoute, notFound } from '@tanstack/react-router'
 
 import { MemberDetail } from '@/components/MemberDetail'
 import { getProvider } from '@/lib/pulumi/api'
-import { tokenDisplayName } from '@/lib/pulumi/token'
+import { findTokenBySlug, tokenDisplayName } from '@/lib/pulumi/token'
 
 export const Route = createFileRoute('/providers/$name/resources/$token')({
   loader: async ({ params }) => {
     const entry = await getProvider({ data: params.name })
-    const resource = entry?.schema?.resources?.[params.token]
-    if (!resource) throw notFound()
+    const resources = entry?.schema?.resources
+    const token =
+      resources && findTokenBySlug(Object.keys(resources), params.token)
+    const resource = token ? resources[token] : undefined
+    if (!token || !resource) throw notFound()
     return {
       providerName: params.name,
-      token: params.token,
+      token,
       resource,
       runtime: entry?.runtime,
     }

package/vite.config.ts

@@ -38,9 +38,49 @@ function printMcpUrl(): Plugin {
   }
 }
 
+// Set by `pulumi-package-docs static` (see bin/static.js). A static build
+// prerenders every page to HTML under `dist-static/client` so the result can
+// be published to GitHub/GitLab Pages, where there's no server to render them.
+const staticDocs = process.env.VITE_STATIC_DOCS === 'true'
+// The path the site is served under, e.g. "/<repo>/" for a GitHub/GitLab
+// Pages project site. Vite prefixes asset URLs with it, and the router picks
+// it up as its basepath via `import.meta.env.BASE_URL`.
+const base = process.env.PULUMI_DOCS_BASE || '/'
+
 const config = defineConfig({
+  base,
+  // A static build goes to its own output directory, so generating a site
+  // never clobbers the `dist/` build that `pulumi-package-docs` serves.
+  ...(staticDocs
+    ? {
+        build: { outDir: 'dist-static' },
+        preview: { host: '127.0.0.1' },
+      }
+    : {}),
   resolve: { tsconfigPaths: true },
-  plugins: [tanstackStart(), viteReact(), printMcpUrl()],
+  plugins: [
+    tanstackStart(
+      staticDocs
+        ? {
+            // Crawling from the index reaches every provider page and, from
+            // there, every resource/function page — so the page list follows
+            // whatever the project's Pulumi.yaml declares, with nothing to
+            // enumerate here.
+            pages: [{ path: '/' }],
+            prerender: {
+              enabled: true,
+              crawlLinks: true,
+              failOnError: true,
+              // `/mcp` is a server endpoint (Streamable HTTP), not a page;
+              // there's nothing to prerender and no server to serve it from.
+              filter: (page) => page.path !== '/mcp',
+            },
+          }
+        : undefined,
+    ),
+    viteReact(),
+    printMcpUrl(),
+  ],
 })
 
 export default config

package/dist/client/assets/MemberDetail-BS9DbqEt.js

@@ -1 +0,0 @@
-import{o as e}from"./useSelector-BIt42tGI.js";import{o as t}from"./index-2FzxAhzN.js";import{i as n,n as r,o as i,r as a}from"./token-oQmZfAP3.js";var o=e();function s({example:e}){return e?(0,o.jsxs)(`div`,{className:`code-example`,children:[(0,o.jsx)(`span`,{className:`code-example-lang`,children:e.language}),(0,o.jsx)(`pre`,{children:(0,o.jsx)(`code`,{children:e.code})})]}):(0,o.jsx)(`p`,{className:`empty-state`,children:`No examples in the schema.`})}function c(e){if(!e)return`any`;if(e.$ref){let t=e.$ref.split(`/`).pop()??e.$ref;return decodeURIComponent(t)}return e.type===`array`&&e.items?`${c(e.items)}[]`:e.type??`any`}function l(e){return e.replace(/([a-z0-9])([A-Z])/g,`$1_$2`).replace(/([A-Z]+)([A-Z][a-z])/g,`$1_$2`).toLowerCase()}function u(e){return e.length===0?e:e.charAt(0).toUpperCase()+e.slice(1)}function d(e,t){switch(t){case`python`:return l(e);case`go`:case`dotnet`:return u(e);default:return e}}function f({properties:e,required:t,runtime:n}){let r=Object.keys(e??{});if(r.length===0)return(0,o.jsx)(`p`,{className:`empty-state`,children:`None`});let a=new Set(t??[]);return(0,o.jsxs)(`table`,{className:`props-table`,children:[(0,o.jsx)(`thead`,{children:(0,o.jsxs)(`tr`,{children:[(0,o.jsx)(`th`,{children:`Name`}),(0,o.jsx)(`th`,{children:`Type`}),(0,o.jsx)(`th`,{children:`Required`}),(0,o.jsx)(`th`,{children:`Description`})]})}),(0,o.jsx)(`tbody`,{children:r.map(t=>{let r=e[t];return(0,o.jsxs)(`tr`,{children:[(0,o.jsx)(`td`,{children:(0,o.jsx)(`code`,{children:d(t,n)})}),(0,o.jsx)(`td`,{children:(0,o.jsx)(`code`,{children:c(r)})}),(0,o.jsx)(`td`,{children:a.has(t)?`yes`:`no`}),(0,o.jsx)(`td`,{children:i(r.description,n)??``})]},t)})})]})}function p({providerName:e,kind:c,displayName:l,token:u,description:d,deprecationMessage:p,runtime:m,inputProperties:h,requiredInputs:g,outputProperties:_,requiredOutputs:v}){let y=i(d,m),b=n(y),x=a(r(y),m);return(0,o.jsxs)(`main`,{className:`provider-detail`,children:[(0,o.jsxs)(t,{to:`/providers/$name`,params:{name:e},className:`back-link`,children:[`← Back to `,e]}),(0,o.jsx)(`h1`,{children:l}),(0,o.jsxs)(`p`,{className:`subtitle`,children:[(0,o.jsx)(`span`,{className:`badge ${c===`Resource`?`badge-resource`:`badge-function`}`,children:c}),` `,`· `,(0,o.jsx)(`code`,{children:u})]}),p&&(0,o.jsxs)(`p`,{className:`banner banner-warning`,children:[`Deprecated: `,p]}),b?.split(/\n{2,}/).map((e,t)=>(0,o.jsx)(`p`,{children:e},t)),(0,o.jsx)(`h2`,{children:`Example`}),(0,o.jsx)(s,{example:x}),(0,o.jsx)(`h2`,{children:`Inputs`}),(0,o.jsx)(f,{properties:h,required:g,runtime:m}),(0,o.jsx)(`h2`,{children:`Outputs`}),(0,o.jsx)(f,{properties:_,required:v,runtime:m})]})}export{p as t};