@krak-stack/registry 0.1.18 → 0.1.20

package/dist/lib/{docs-core.d.ts → docs.d.ts}

@@ -1,5 +1,10 @@
 import { Schema } from "effect";
-import { type ReactNode } from "react";
+import { type ComponentPropsWithoutRef, type ForwardRefExoticComponent, type RefAttributes, type ReactNode } from "react";
+type DocsIconProps = ComponentPropsWithoutRef<"svg"> & {
+    absoluteStrokeWidth?: boolean;
+    size?: string | number;
+};
+export type DocsIcon = ForwardRefExoticComponent<DocsIconProps & RefAttributes<SVGSVGElement>>;
 export type DocsLocale = string;
 export declare const DocsSection: Schema.String;
 export type DocsSection = typeof DocsSection.Type;
@@ -18,6 +23,7 @@ export declare const DocsFrontmatter: Schema.Struct<{
     readonly createdAt: Schema.optional<Schema.String>;
     readonly updatedAt: Schema.optional<Schema.String>;
     readonly legacySlugs: Schema.optional<Schema.$Array<Schema.String>>;
+    readonly tags: Schema.optional<Schema.$Array<Schema.NonEmptyString>>;
 }>;
 export declare const DocsHeadingSchema: Schema.Struct<{
     readonly depth: Schema.Literals<readonly [2, 3]>;
@@ -25,6 +31,10 @@ export declare const DocsHeadingSchema: Schema.Struct<{
     readonly title: Schema.String;
 }>;
 export type DocsHeading = typeof DocsHeadingSchema.Type;
+export declare const DocsCodeBlockSchema: Schema.Struct<{
+    readonly code: Schema.String;
+    readonly language: Schema.String;
+}>;
 export declare const DocsPageSchema: Schema.Struct<{
     readonly slug: Schema.String;
     readonly path: Schema.String;
@@ -38,11 +48,17 @@ export declare const DocsPageSchema: Schema.Struct<{
     readonly createdAt: Schema.optional<Schema.String>;
     readonly updatedAt: Schema.optional<Schema.String>;
     readonly legacySlugs: Schema.optional<Schema.$Array<Schema.String>>;
+    readonly tags: Schema.optional<Schema.$Array<Schema.NonEmptyString>>;
+    readonly codeBlocks: Schema.$Array<Schema.Struct<{
+        readonly code: Schema.String;
+        readonly language: Schema.String;
+    }>>;
     readonly headings: Schema.$Array<Schema.Struct<{
         readonly depth: Schema.Literals<readonly [2, 3]>;
         readonly id: Schema.String;
         readonly title: Schema.String;
     }>>;
+    readonly html: Schema.String;
     readonly searchText: Schema.String;
     readonly sourceFile: Schema.String;
     readonly source: Schema.String;
@@ -57,9 +73,6 @@ type DocsSourceOptions = {
 export type DocsSourceConfig = DocsSourceOptions & {
     pages: ReadonlyArray<unknown>;
 };
-export type MdxDocsSourceConfig = DocsSourceOptions & {
-    files: Readonly<Record<string, string>>;
-};
 export declare const createDocsSource: (config: DocsSourceConfig) => {
     locales: readonly string[];
     pages: readonly {
@@ -75,11 +88,17 @@ export declare const createDocsSource: (config: DocsSourceConfig) => {
         readonly createdAt?: string | undefined;
         readonly updatedAt?: string | undefined;
         readonly legacySlugs?: readonly string[] | undefined;
+        readonly tags?: readonly string[] | undefined;
+        readonly codeBlocks: readonly Schema.Struct.ReadonlySide<{
+            readonly code: Schema.String;
+            readonly language: Schema.String;
+        }, "Type">[];
         readonly headings: readonly Schema.Struct.ReadonlySide<{
             readonly depth: Schema.Literals<readonly [2, 3]>;
             readonly id: Schema.String;
             readonly title: Schema.String;
         }, "Type">[];
+        readonly html: string;
         readonly searchText: string;
         readonly sourceFile: string;
         readonly source: string;
@@ -97,11 +116,17 @@ export declare const createDocsSource: (config: DocsSourceConfig) => {
         readonly createdAt?: string | undefined;
         readonly updatedAt?: string | undefined;
         readonly legacySlugs?: readonly string[] | undefined;
+        readonly tags?: readonly string[] | undefined;
+        readonly codeBlocks: readonly Schema.Struct.ReadonlySide<{
+            readonly code: Schema.String;
+            readonly language: Schema.String;
+        }, "Type">[];
         readonly headings: readonly Schema.Struct.ReadonlySide<{
             readonly depth: Schema.Literals<readonly [2, 3]>;
             readonly id: Schema.String;
             readonly title: Schema.String;
         }, "Type">[];
+        readonly html: string;
         readonly searchText: string;
         readonly sourceFile: string;
         readonly source: string;
@@ -120,11 +145,17 @@ export declare const createDocsSource: (config: DocsSourceConfig) => {
             readonly createdAt?: string | undefined;
             readonly updatedAt?: string | undefined;
             readonly legacySlugs?: readonly string[] | undefined;
+            readonly tags?: readonly string[] | undefined;
+            readonly codeBlocks: readonly Schema.Struct.ReadonlySide<{
+                readonly code: Schema.String;
+                readonly language: Schema.String;
+            }, "Type">[];
             readonly headings: readonly Schema.Struct.ReadonlySide<{
                 readonly depth: Schema.Literals<readonly [2, 3]>;
                 readonly id: Schema.String;
                 readonly title: Schema.String;
             }, "Type">[];
+            readonly html: string;
             readonly searchText: string;
             readonly sourceFile: string;
             readonly source: string;
@@ -142,11 +173,17 @@ export declare const createDocsSource: (config: DocsSourceConfig) => {
             readonly createdAt?: string | undefined;
             readonly updatedAt?: string | undefined;
             readonly legacySlugs?: readonly string[] | undefined;
+            readonly tags?: readonly string[] | undefined;
+            readonly codeBlocks: readonly Schema.Struct.ReadonlySide<{
+                readonly code: Schema.String;
+                readonly language: Schema.String;
+            }, "Type">[];
             readonly headings: readonly Schema.Struct.ReadonlySide<{
                 readonly depth: Schema.Literals<readonly [2, 3]>;
                 readonly id: Schema.String;
                 readonly title: Schema.String;
             }, "Type">[];
+            readonly html: string;
             readonly searchText: string;
             readonly sourceFile: string;
             readonly source: string;
@@ -165,11 +202,17 @@ export declare const createDocsSource: (config: DocsSourceConfig) => {
         readonly createdAt?: string | undefined;
         readonly updatedAt?: string | undefined;
         readonly legacySlugs?: readonly string[] | undefined;
+        readonly tags?: readonly string[] | undefined;
+        readonly codeBlocks: readonly Schema.Struct.ReadonlySide<{
+            readonly code: Schema.String;
+            readonly language: Schema.String;
+        }, "Type">[];
         readonly headings: readonly Schema.Struct.ReadonlySide<{
             readonly depth: Schema.Literals<readonly [2, 3]>;
             readonly id: Schema.String;
             readonly title: Schema.String;
         }, "Type">[];
+        readonly html: string;
         readonly searchText: string;
         readonly sourceFile: string;
         readonly source: string;
@@ -187,11 +230,17 @@ export declare const createDocsSource: (config: DocsSourceConfig) => {
         readonly createdAt?: string | undefined;
         readonly updatedAt?: string | undefined;
         readonly legacySlugs?: readonly string[] | undefined;
+        readonly tags?: readonly string[] | undefined;
+        readonly codeBlocks: readonly Schema.Struct.ReadonlySide<{
+            readonly code: Schema.String;
+            readonly language: Schema.String;
+        }, "Type">[];
         readonly headings: readonly Schema.Struct.ReadonlySide<{
             readonly depth: Schema.Literals<readonly [2, 3]>;
             readonly id: Schema.String;
             readonly title: Schema.String;
         }, "Type">[];
+        readonly html: string;
         readonly searchText: string;
         readonly sourceFile: string;
         readonly source: string;
@@ -202,143 +251,6 @@ export type DocsSearchResult = {
     page: DocsPage;
     heading?: DocsHeading;
 };
-export declare const createMdxDocsSource: (config: MdxDocsSourceConfig) => {
-    locales: readonly string[];
-    pages: readonly {
-        readonly slug: string;
-        readonly path: string;
-        readonly title: string;
-        readonly description: string;
-        readonly icon?: string | undefined;
-        readonly order: number;
-        readonly locale: string;
-        readonly section: string;
-        readonly type: "concept" | "how-to" | "reference" | "runbook" | "tutorial";
-        readonly createdAt?: string | undefined;
-        readonly updatedAt?: string | undefined;
-        readonly legacySlugs?: readonly string[] | undefined;
-        readonly headings: readonly Schema.Struct.ReadonlySide<{
-            readonly depth: Schema.Literals<readonly [2, 3]>;
-            readonly id: Schema.String;
-            readonly title: Schema.String;
-        }, "Type">[];
-        readonly searchText: string;
-        readonly sourceFile: string;
-        readonly source: string;
-    }[];
-    getPage: (slug: string, locale: DocsLocale) => {
-        readonly slug: string;
-        readonly path: string;
-        readonly title: string;
-        readonly description: string;
-        readonly icon?: string | undefined;
-        readonly order: number;
-        readonly locale: string;
-        readonly section: string;
-        readonly type: "concept" | "how-to" | "reference" | "runbook" | "tutorial";
-        readonly createdAt?: string | undefined;
-        readonly updatedAt?: string | undefined;
-        readonly legacySlugs?: readonly string[] | undefined;
-        readonly headings: readonly Schema.Struct.ReadonlySide<{
-            readonly depth: Schema.Literals<readonly [2, 3]>;
-            readonly id: Schema.String;
-            readonly title: Schema.String;
-        }, "Type">[];
-        readonly searchText: string;
-        readonly sourceFile: string;
-        readonly source: string;
-    } | undefined;
-    getPageNeighbors: (slug: string, locale: DocsLocale) => {
-        previous: {
-            readonly slug: string;
-            readonly path: string;
-            readonly title: string;
-            readonly description: string;
-            readonly icon?: string | undefined;
-            readonly order: number;
-            readonly locale: string;
-            readonly section: string;
-            readonly type: "concept" | "how-to" | "reference" | "runbook" | "tutorial";
-            readonly createdAt?: string | undefined;
-            readonly updatedAt?: string | undefined;
-            readonly legacySlugs?: readonly string[] | undefined;
-            readonly headings: readonly Schema.Struct.ReadonlySide<{
-                readonly depth: Schema.Literals<readonly [2, 3]>;
-                readonly id: Schema.String;
-                readonly title: Schema.String;
-            }, "Type">[];
-            readonly searchText: string;
-            readonly sourceFile: string;
-            readonly source: string;
-        } | undefined;
-        next: {
-            readonly slug: string;
-            readonly path: string;
-            readonly title: string;
-            readonly description: string;
-            readonly icon?: string | undefined;
-            readonly order: number;
-            readonly locale: string;
-            readonly section: string;
-            readonly type: "concept" | "how-to" | "reference" | "runbook" | "tutorial";
-            readonly createdAt?: string | undefined;
-            readonly updatedAt?: string | undefined;
-            readonly legacySlugs?: readonly string[] | undefined;
-            readonly headings: readonly Schema.Struct.ReadonlySide<{
-                readonly depth: Schema.Literals<readonly [2, 3]>;
-                readonly id: Schema.String;
-                readonly title: Schema.String;
-            }, "Type">[];
-            readonly searchText: string;
-            readonly sourceFile: string;
-            readonly source: string;
-        } | undefined;
-    };
-    getPages: (locale: DocsLocale) => {
-        readonly slug: string;
-        readonly path: string;
-        readonly title: string;
-        readonly description: string;
-        readonly icon?: string | undefined;
-        readonly order: number;
-        readonly locale: string;
-        readonly section: string;
-        readonly type: "concept" | "how-to" | "reference" | "runbook" | "tutorial";
-        readonly createdAt?: string | undefined;
-        readonly updatedAt?: string | undefined;
-        readonly legacySlugs?: readonly string[] | undefined;
-        readonly headings: readonly Schema.Struct.ReadonlySide<{
-            readonly depth: Schema.Literals<readonly [2, 3]>;
-            readonly id: Schema.String;
-            readonly title: Schema.String;
-        }, "Type">[];
-        readonly searchText: string;
-        readonly sourceFile: string;
-        readonly source: string;
-    }[];
-    resolvePage: (slug: string, locale: DocsLocale) => {
-        readonly slug: string;
-        readonly path: string;
-        readonly title: string;
-        readonly description: string;
-        readonly icon?: string | undefined;
-        readonly order: number;
-        readonly locale: string;
-        readonly section: string;
-        readonly type: "concept" | "how-to" | "reference" | "runbook" | "tutorial";
-        readonly createdAt?: string | undefined;
-        readonly updatedAt?: string | undefined;
-        readonly legacySlugs?: readonly string[] | undefined;
-        readonly headings: readonly Schema.Struct.ReadonlySide<{
-            readonly depth: Schema.Literals<readonly [2, 3]>;
-            readonly id: Schema.String;
-            readonly title: Schema.String;
-        }, "Type">[];
-        readonly searchText: string;
-        readonly sourceFile: string;
-        readonly source: string;
-    } | undefined;
-};
 export type DocsConfig = {
     source: DocsSource;
     basePath: `/${string}`;
@@ -347,18 +259,25 @@ export type DocsConfig = {
     siteName: string;
     defaultLocale?: DocsLocale;
     messages?: (locale: DocsLocale) => DocsMessageOverrides;
+    icons?: Readonly<Record<string, DocsIcon>>;
+    navigate?: (href: string) => void;
     brand?: {
         label: string;
         subtitle: () => string;
-        icon: string;
+        icon: DocsIcon;
         href: string;
     };
     resources?: {
         label: () => string;
         items: ReadonlyArray<DocsResource>;
     };
+    sidebarGroups?: ReadonlyArray<{
+        label: () => string;
+        items: ReadonlyArray<DocsResource>;
+    }>;
     githubLabel?: string;
     sectionOrder?: ReadonlyArray<DocsSection>;
+    navigation?: (page: DocsPage) => boolean;
     github?: {
         url: `https://${string}`;
         branch?: string;
@@ -370,13 +289,15 @@ export declare const makeDocs: (config: DocsConfig) => {
     brand: {
         label: string;
         subtitle: () => string;
-        icon: string;
+        icon: DocsIcon;
         href: string;
     };
     defaultSlug: string;
     editUrl: (page: DocsPage) => string | undefined;
     githubUrl: string | undefined;
     githubLabel: string;
+    icons: Readonly<Record<string, DocsIcon>>;
+    navigate: (href: string) => void;
     getHead: ({ locale, page, }: {
         locale: DocsLocale;
         page?: DocsPage;
@@ -416,6 +337,10 @@ export declare const makeDocs: (config: DocsConfig) => {
         label: () => string;
         items: ReadonlyArray<DocsResource>;
     } | undefined;
+    sidebarGroups: readonly {
+        label: () => string;
+        items: ReadonlyArray<DocsResource>;
+    }[] | undefined;
     source: {
         locales: readonly string[];
         pages: readonly {
@@ -431,11 +356,17 @@ export declare const makeDocs: (config: DocsConfig) => {
             readonly createdAt?: string | undefined;
             readonly updatedAt?: string | undefined;
             readonly legacySlugs?: readonly string[] | undefined;
+            readonly tags?: readonly string[] | undefined;
+            readonly codeBlocks: readonly Schema.Struct.ReadonlySide<{
+                readonly code: Schema.String;
+                readonly language: Schema.String;
+            }, "Type">[];
             readonly headings: readonly Schema.Struct.ReadonlySide<{
                 readonly depth: Schema.Literals<readonly [2, 3]>;
                 readonly id: Schema.String;
                 readonly title: Schema.String;
             }, "Type">[];
+            readonly html: string;
             readonly searchText: string;
             readonly sourceFile: string;
             readonly source: string;
@@ -453,11 +384,17 @@ export declare const makeDocs: (config: DocsConfig) => {
             readonly createdAt?: string | undefined;
             readonly updatedAt?: string | undefined;
             readonly legacySlugs?: readonly string[] | undefined;
+            readonly tags?: readonly string[] | undefined;
+            readonly codeBlocks: readonly Schema.Struct.ReadonlySide<{
+                readonly code: Schema.String;
+                readonly language: Schema.String;
+            }, "Type">[];
             readonly headings: readonly Schema.Struct.ReadonlySide<{
                 readonly depth: Schema.Literals<readonly [2, 3]>;
                 readonly id: Schema.String;
                 readonly title: Schema.String;
             }, "Type">[];
+            readonly html: string;
             readonly searchText: string;
             readonly sourceFile: string;
             readonly source: string;
@@ -476,11 +413,17 @@ export declare const makeDocs: (config: DocsConfig) => {
                 readonly createdAt?: string | undefined;
                 readonly updatedAt?: string | undefined;
                 readonly legacySlugs?: readonly string[] | undefined;
+                readonly tags?: readonly string[] | undefined;
+                readonly codeBlocks: readonly Schema.Struct.ReadonlySide<{
+                    readonly code: Schema.String;
+                    readonly language: Schema.String;
+                }, "Type">[];
                 readonly headings: readonly Schema.Struct.ReadonlySide<{
                     readonly depth: Schema.Literals<readonly [2, 3]>;
                     readonly id: Schema.String;
                     readonly title: Schema.String;
                 }, "Type">[];
+                readonly html: string;
                 readonly searchText: string;
                 readonly sourceFile: string;
                 readonly source: string;
@@ -498,11 +441,17 @@ export declare const makeDocs: (config: DocsConfig) => {
                 readonly createdAt?: string | undefined;
                 readonly updatedAt?: string | undefined;
                 readonly legacySlugs?: readonly string[] | undefined;
+                readonly tags?: readonly string[] | undefined;
+                readonly codeBlocks: readonly Schema.Struct.ReadonlySide<{
+                    readonly code: Schema.String;
+                    readonly language: Schema.String;
+                }, "Type">[];
                 readonly headings: readonly Schema.Struct.ReadonlySide<{
                     readonly depth: Schema.Literals<readonly [2, 3]>;
                     readonly id: Schema.String;
                     readonly title: Schema.String;
                 }, "Type">[];
+                readonly html: string;
                 readonly searchText: string;
                 readonly sourceFile: string;
                 readonly source: string;
@@ -521,11 +470,17 @@ export declare const makeDocs: (config: DocsConfig) => {
             readonly createdAt?: string | undefined;
             readonly updatedAt?: string | undefined;
             readonly legacySlugs?: readonly string[] | undefined;
+            readonly tags?: readonly string[] | undefined;
+            readonly codeBlocks: readonly Schema.Struct.ReadonlySide<{
+                readonly code: Schema.String;
+                readonly language: Schema.String;
+            }, "Type">[];
             readonly headings: readonly Schema.Struct.ReadonlySide<{
                 readonly depth: Schema.Literals<readonly [2, 3]>;
                 readonly id: Schema.String;
                 readonly title: Schema.String;
             }, "Type">[];
+            readonly html: string;
             readonly searchText: string;
             readonly sourceFile: string;
             readonly source: string;
@@ -543,11 +498,17 @@ export declare const makeDocs: (config: DocsConfig) => {
             readonly createdAt?: string | undefined;
             readonly updatedAt?: string | undefined;
             readonly legacySlugs?: readonly string[] | undefined;
+            readonly tags?: readonly string[] | undefined;
+            readonly codeBlocks: readonly Schema.Struct.ReadonlySide<{
+                readonly code: Schema.String;
+                readonly language: Schema.String;
+            }, "Type">[];
             readonly headings: readonly Schema.Struct.ReadonlySide<{
                 readonly depth: Schema.Literals<readonly [2, 3]>;
                 readonly id: Schema.String;
                 readonly title: Schema.String;
             }, "Type">[];
+            readonly html: string;
             readonly searchText: string;
             readonly sourceFile: string;
             readonly source: string;
@@ -566,11 +527,17 @@ export declare const makeDocs: (config: DocsConfig) => {
         readonly createdAt?: string | undefined;
         readonly updatedAt?: string | undefined;
         readonly legacySlugs?: readonly string[] | undefined;
+        readonly tags?: readonly string[] | undefined;
+        readonly codeBlocks: readonly Schema.Struct.ReadonlySide<{
+            readonly code: Schema.String;
+            readonly language: Schema.String;
+        }, "Type">[];
         readonly headings: readonly Schema.Struct.ReadonlySide<{
             readonly depth: Schema.Literals<readonly [2, 3]>;
             readonly id: Schema.String;
             readonly title: Schema.String;
         }, "Type">[];
+        readonly html: string;
         readonly searchText: string;
         readonly sourceFile: string;
         readonly source: string;
@@ -589,11 +556,17 @@ export declare const makeDocs: (config: DocsConfig) => {
             readonly createdAt?: string | undefined;
             readonly updatedAt?: string | undefined;
             readonly legacySlugs?: readonly string[] | undefined;
+            readonly tags?: readonly string[] | undefined;
+            readonly codeBlocks: readonly Schema.Struct.ReadonlySide<{
+                readonly code: Schema.String;
+                readonly language: Schema.String;
+            }, "Type">[];
             readonly headings: readonly Schema.Struct.ReadonlySide<{
                 readonly depth: Schema.Literals<readonly [2, 3]>;
                 readonly id: Schema.String;
                 readonly title: Schema.String;
             }, "Type">[];
+            readonly html: string;
             readonly searchText: string;
             readonly sourceFile: string;
             readonly source: string;
@@ -613,11 +586,17 @@ export declare const makeDocs: (config: DocsConfig) => {
                 readonly createdAt?: string | undefined;
                 readonly updatedAt?: string | undefined;
                 readonly legacySlugs?: readonly string[] | undefined;
+                readonly tags?: readonly string[] | undefined;
+                readonly codeBlocks: readonly Schema.Struct.ReadonlySide<{
+                    readonly code: Schema.String;
+                    readonly language: Schema.String;
+                }, "Type">[];
                 readonly headings: readonly Schema.Struct.ReadonlySide<{
                     readonly depth: Schema.Literals<readonly [2, 3]>;
                     readonly id: Schema.String;
                     readonly title: Schema.String;
                 }, "Type">[];
+                readonly html: string;
                 readonly searchText: string;
                 readonly sourceFile: string;
                 readonly source: string;
@@ -635,11 +614,17 @@ export declare const makeDocs: (config: DocsConfig) => {
                 readonly createdAt?: string | undefined;
                 readonly updatedAt?: string | undefined;
                 readonly legacySlugs?: readonly string[] | undefined;
+                readonly tags?: readonly string[] | undefined;
+                readonly codeBlocks: readonly Schema.Struct.ReadonlySide<{
+                    readonly code: Schema.String;
+                    readonly language: Schema.String;
+                }, "Type">[];
                 readonly headings: readonly Schema.Struct.ReadonlySide<{
                     readonly depth: Schema.Literals<readonly [2, 3]>;
                     readonly id: Schema.String;
                     readonly title: Schema.String;
                 }, "Type">[];
+                readonly html: string;
                 readonly searchText: string;
                 readonly sourceFile: string;
                 readonly source: string;
@@ -664,11 +649,17 @@ export declare const makeDocs: (config: DocsConfig) => {
             readonly createdAt?: string | undefined;
             readonly updatedAt?: string | undefined;
             readonly legacySlugs?: readonly string[] | undefined;
+            readonly tags?: readonly string[] | undefined;
+            readonly codeBlocks: readonly Schema.Struct.ReadonlySide<{
+                readonly code: Schema.String;
+                readonly language: Schema.String;
+            }, "Type">[];
             readonly headings: readonly Schema.Struct.ReadonlySide<{
                 readonly depth: Schema.Literals<readonly [2, 3]>;
                 readonly id: Schema.String;
                 readonly title: Schema.String;
             }, "Type">[];
+            readonly html: string;
             readonly searchText: string;
             readonly sourceFile: string;
             readonly source: string;
@@ -708,9 +699,9 @@ export type DocsRouteMessages = {
 export type DocsMessageOverrides = Partial<DocsRouteMessages>;
 export declare const getDocsMessages: (locale: DocsLocale, overrides?: DocsMessageOverrides) => DocsRouteMessages;
 export type DocsResource = {
+    badge?: () => string;
     label: () => string;
     href: string;
-    icon: string;
     external?: boolean;
 };
 export type DocsResolution = NonNullable<ReturnType<DocsCatalog["resolve"]>>;