docs: presentation mode

Author: alexanbj

.gitignore

@@ -5,6 +5,7 @@ dist/
 storybook-static/
 next-env.d.ts
 
+packages/icons-react/icons.tsx
 
 # editors
 .idea/
@@ -17,5 +18,4 @@ next-env.d.ts
 
 # Secrets
 .FIGMA_TOKEN
-.vercel
-packages/icons-react/icons.tsx
+.env.local

apps/docs/.env.example

@@ -0,0 +1,2 @@
+# Creata a viewer token at sanity.io/manage
+SANITY_VIEWER_TOKEN=

apps/docs/.gitignore

@@ -4,3 +4,6 @@
 public/resources/icons/
 public/storybook
 component-props.ts
+docgen.ts
+
+.env

apps/docs/app/routes/_docs.tsx

@@ -0,0 +1,71 @@
+import { sanityFetch } from '@/lib/sanity';
+import { VisualEditing } from '@/lib/visual-editing';
+import appCss from '@/styles/app.css?url';
+import { Footer } from '@/ui/footer';
+import { MainNav } from '@/ui/main-nav';
+import { GrunnmurenProvider } from '@obosbbl/grunnmuren-react';
+import {
+  type NavigateOptions,
+  Outlet,
+  ScrollRestoration,
+  type ToOptions,
+  createFileRoute,
+  useRouter,
+} from '@tanstack/react-router';
+import { defineQuery } from 'groq';
+
+const COMPONENTS_NAVIGATION_QUERY = defineQuery(
+  // make sure the slug is always a string so we don't have add fallback value in code just to make TypeScript happy
+  `*[_type == "component"]{ _id, name, 'slug': coalesce(slug.current, '')} | order(name asc)`,
+);
+
+// This is the shared layout for all the Grunnmuren docs pages that are "public", ie not the Sanity studio
+export const Route = createFileRoute('/_docs')({
+  component: RootLayout,
+  head: () => ({
+    links: [{ rel: 'stylesheet', href: appCss }],
+    meta: [
+      {
+        title: "Grunnmuren - OBOS' Design System",
+      },
+    ],
+  }),
+  loader: () => sanityFetch({ query: COMPONENTS_NAVIGATION_QUERY }),
+});
+
+function RootLayout() {
+  const router = useRouter();
+
+  return (
+    <>
+      <GrunnmurenProvider
+        locale="nb"
+        // This integrates RAC/Grunnmuren with TanStack router
+        // Giving us typesafe routes
+        // See https://react-spectrum.adobe.com/react-aria/routing.html#tanstack-router
+        navigate={(to, options) => router.navigate({ to, ...options })}
+        useHref={(to) => router.buildLocation({ to }).href}
+      >
+        <div className="grid min-h-screen lg:flex">
+          <div className="flex grow flex-col px-6">
+            <main className="grow">
+              <Outlet />
+            </main>
+            <Footer />
+          </div>
+          <MainNav />
+        </div>
+      </GrunnmurenProvider>
+      <ScrollRestoration />
+      <VisualEditing />
+    </>
+  );
+}
+
+// See comments on GrunnmurenProvider in <RootLayout />
+declare module 'react-aria-components' {
+  interface RouterConfig {
+    href: ToOptions['to'];
+    routerOptions: Omit<NavigateOptions, keyof ToOptions>;
+  }
+}

apps/docs/app/routes/_docs/komponenter/$slug.tsx

@@ -0,0 +1,53 @@
+import * as badgeExamples from '@/examples/badge';
+import * as buttonExamples from '@/examples/button';
+import { sanityFetch } from '@/lib/sanity.server';
+import { Content } from '@/ui/content';
+import { PropsTable } from '@/ui/props-table';
+import { createFileRoute, notFound } from '@tanstack/react-router';
+import * as props from 'docgen';
+import { defineQuery } from 'groq';
+
+const COMPONENT_QUERY = defineQuery(
+  `*[_type == "component" && slug.current == $slug][0]{ content, "name": coalesce(name, '') }`,
+);
+
+export const Route = createFileRoute('/_docs/komponenter/$slug')({
+  component: Page,
+  loader: async ({ params }) => {
+    const res = await sanityFetch({
+      data: {
+        query: COMPONENT_QUERY,
+        params: { slug: params.slug },
+      },
+    });
+
+    if (res.data == null) {
+      throw notFound();
+    }
+
+    const componentName = res.data.name;
+    const componentProps = props[componentName].props;
+
+    return { data: res.data, componentProps };
+  },
+});
+
+function Page() {
+  const { data, componentProps } = Route.useLoaderData();
+
+  // @ts-expect-error this works for now until we figure how to make the examples work better with Sanity
+  const { scope, examples } = {
+    Button: buttonExamples,
+    Badge: badgeExamples,
+  }[data.name];
+
+  return (
+    <>
+      <h1 className="heading-l mb-12 mt-9">{data.name}</h1>
+
+      <Content content={data.content ?? []} />
+
+      <PropsTable props={componentProps} />
+    </>
+  );
+}

apps/docs/app/routes/api/preview-mode/disable.ts

@@ -0,0 +1,14 @@
+import { createAPIFileRoute } from '@tanstack/start/api';
+import { deleteCookie, sendRedirect } from 'vinxi/http';
+
+export const APIRoute = createAPIFileRoute('/api/preview-mode/disable')({
+  GET: () => {
+    deleteCookie('__sanity_preview', {
+      path: '/',
+      secure: import.meta.env.PROD,
+      httpOnly: true,
+      sameSite: 'strict',
+    });
+    sendRedirect('/');
+  },
+});

apps/docs/app/routes/api/preview-mode/enable.ts

@@ -0,0 +1,37 @@
+import { randomBytes } from 'node:crypto';
+import { client } from '@/lib/sanity';
+import { validatePreviewUrl } from '@sanity/preview-url-secret';
+import { createAPIFileRoute } from '@tanstack/start/api';
+import { SanityClient } from 'sanity';
+import { sendRedirect, setCookie } from 'vinxi/http';
+
+export const APIRoute = createAPIFileRoute('/api/preview-mode/enable')({
+  GET: async ({ request }) => {
+    if (!process.env.SANITY_VIEWER_TOKEN) {
+      throw new Response('Preview mode missing token', { status: 401 });
+    }
+
+    const clientWithToken = client.withConfig({
+      token: process.env.SANITY_VIEWER_TOKEN,
+    });
+
+    const { isValid, redirectTo = '/' } = await validatePreviewUrl(
+      clientWithToken,
+      request.url,
+    );
+
+    if (!isValid) {
+      throw new Response('Invalid secret', { status: 401 });
+    }
+
+    // we can use sameSite: 'strict' because we're running an embedded studio
+    // setCookie('__sanity_preview', randomBytes(16).toString('hex'), {
+    setCookie('__sanity_preview', 'true', {
+      path: '/',
+      secure: import.meta.env.PROD,
+      httpOnly: true,
+      sameSite: 'strict',
+    });
+    sendRedirect(redirectTo);
+  },
+});

apps/docs/dktp/main.yml

@@ -16,6 +16,9 @@ properties:
     containers:
       - image: dktprodacr.azurecr.io/grunnmuren/docs:${IMAGE_TAG}
         name: docs
+        env:
+          - name: SANITY_VIEWER_TOKEN
+            secretRef: ${todo}
         resources:
           cpu: 0.25
           memory: 0.5Gi

apps/docs/package.json

@@ -29,8 +29,11 @@
     "@sanity/client": "7.12.1",
     "@sanity/code-input": "6.0.3",
     "@sanity/image-url": "^1.2.0",
+    "@sanity/presentation": "1.21.1",
+    "@sanity/preview-url-secret": "2.1.0",
     "@sanity/table": "2.0.0",
     "@sanity/vision": "4.14.2",
+    "@sanity/visual-editing": "2.12.0",
     "@tanstack/nitro-v2-vite-plugin": "1.133.19",
     "@tanstack/react-router": "1.135.0",
     "@tanstack/react-start": "1.135.0",

apps/docs/sanity.config.ts

@@ -3,6 +3,7 @@ import { codeInput } from '@sanity/code-input';
 import { table } from '@sanity/table';
 import { visionTool } from '@sanity/vision';
 import { defineConfig } from 'sanity';
+import { defineDocuments, presentationTool } from 'sanity/presentation';
 import { structureTool } from 'sanity/structure';
 import { schemaTypes } from './studio/schema-types';
 
@@ -70,6 +71,22 @@ export default defineConfig({
     visionTool(),
     codeInput(),
     table(),
+    presentationTool({
+      previewUrl: {
+        previewMode: {
+          enable: '/api/preview-mode/enable',
+          disable: '/api/preview-mode/disable',
+        },
+      },
+      resolve: {
+        mainDocuments: defineDocuments([
+          {
+            route: '/komponenter/:slug',
+            filter: `_type == "component" && slug.current == $slug`,
+          },
+        ]),
+      },
+    }),
   ],
   schema: {
     types: schemaTypes,