docs sync

Author: Frank

packages/openauth/src/ui/password.tsx

@@ -158,7 +158,7 @@ export interface PasswordUIOptions {
  * Creates a UI for the Password provider flow.
  * @param input - Configure the UI.
  */
-export function PasswordUI(input: PasswordUIOptions) {
+export function PasswordUI(input: PasswordUIOptions): PasswordConfig {
   const copy = {
     ...DEFAULT_COPY,
     ...input.copy,
@@ -384,5 +384,5 @@ export function PasswordUI(input: PasswordUIOptions) {
         },
       })
     },
-  } satisfies PasswordConfig
+  }
 }

www/astro.config.mjs

@@ -89,6 +89,7 @@ export default defineConfig({
           items: [
             { label: "Apple", slug: "docs/adapter/apple" },
             { label: "Google", slug: "docs/adapter/google" },
+            { label: "Password", slug: "docs/adapter/password" },
           ],
         },
         {
@@ -102,7 +103,11 @@ export default defineConfig({
         },
         {
           label: "Storage",
-          items: ["docs/storage/memory", "docs/storage/dynamo", "docs/storage/cloudflare"],
+          items: [
+            "docs/storage/memory",
+            "docs/storage/dynamo",
+            "docs/storage/cloudflare",
+          ],
         },
       ],
     }),

www/generate.ts

@@ -338,7 +338,7 @@ function renderInterfaces(module: TypeDoc.DeclarationReflection) {
         `**Type** ${renderSignatureAsType(m.signatures![0])}`,
         `</InlineSection>`,
         `</Section>`,
-        renderComment(m.comment),
+        renderComment(m.signatures![0].comment),
         `</Segment>`,
       ]),
     ]
@@ -434,7 +434,7 @@ function renderType(type: TypeDoc.SomeType): Text {
     type.type === "reflection" &&
     type.declaration.kind === TypeDoc.ReflectionKind.TypeLiteral
   ) {
-    return `<code class="primitive">object type</code>`
+    return renderCallbackType(type)
   }
   return `<code class="primitive">${type.type}</code>`
 
@@ -502,6 +502,10 @@ function renderType(type: TypeDoc.SomeType): Text {
         )}<code class="symbol">)[]</code>`
       : `${renderType(type.elementType)}<code class="symbol">[]</code>`
   }
+  function renderCallbackType(type: TypeDoc.ReflectionType) {
+    //  return renderSignatureAsType(type.declaration.signatures![0])
+    return `<code class="primitive">object type</code>`
+  }
   function renderTypescriptType(type: TypeDoc.ReferenceType) {
     // ie. Record<string, string>
     return [
@@ -517,10 +521,20 @@ function renderType(type: TypeDoc.SomeType): Text {
 
     if (type.reflection?.kind === TypeDoc.ReflectionKind.Class) {
       const r = type.reflection as TypeDoc.DeclarationReflection
-      if (r.sources?.[0]?.fileName.endsWith("error.ts")) {
+      if (r.sources?.[0]?.fileName.endsWith("error.ts"))
         return `[<code class="type">${r.name}</code>](/docs/authorizer#${r.name.toLowerCase()})`
+    }
+
+    if (type.reflection?.kind === TypeDoc.ReflectionKind.Interface) {
+      const r = type.reflection as TypeDoc.DeclarationReflection
+      if (
+        r.sources?.[0]?.fileName.startsWith("packages/openauth/src/adapter/")
+      ) {
+        const adapter = r.sources?.[0]?.fileName.split("/").pop()?.split(".")[0]
+        return `[<code class="type">${r.name}</code>](/docs/adapter/${adapter}#${r.name.toLowerCase()})`
       }
     }
+
     return `[<code class="type">${type.name}</code>](#${type.name.toLowerCase()})`
   }
 }
@@ -643,6 +657,7 @@ async function build() {
     entryPoints: [
       "../packages/openauth/src/adapter/apple.ts",
       "../packages/openauth/src/adapter/google.ts",
+      "../packages/openauth/src/adapter/password.ts",
       "../packages/openauth/src/session.ts",
       "../packages/openauth/src/ui/theme.ts",
       "../packages/openauth/src/ui/code.tsx",