@krak-stack/registry 0.1.1 → 0.1.3

package/dist/lib/docs-core.d.ts

@@ -0,0 +1,681 @@
+import { Schema } from "effect";
+import { type ReactNode } from "react";
+export type DocsLocale = string;
+export declare const DocsSection: Schema.String;
+export type DocsSection = typeof DocsSection.Type;
+export declare const DocsPageType: Schema.Literals<readonly ["concept", "tutorial", "how-to", "reference", "runbook"]>;
+export type DocsPageType = typeof DocsPageType.Type;
+export declare const DocsFrontmatter: Schema.Struct<{
+    readonly slug: Schema.String;
+    readonly path: Schema.String;
+    readonly title: Schema.String;
+    readonly description: Schema.String;
+    readonly icon: Schema.String;
+    readonly order: Schema.Number;
+    readonly locale: Schema.String;
+    readonly section: Schema.String;
+    readonly type: Schema.Literals<readonly ["concept", "tutorial", "how-to", "reference", "runbook"]>;
+    readonly legacySlugs: Schema.optional<Schema.$Array<Schema.String>>;
+}>;
+export declare const DocsHeadingSchema: Schema.Struct<{
+    readonly depth: Schema.Literals<readonly [2, 3]>;
+    readonly id: Schema.String;
+    readonly title: Schema.String;
+}>;
+export type DocsHeading = typeof DocsHeadingSchema.Type;
+export declare const DocsPageSchema: Schema.Struct<{
+    readonly slug: Schema.String;
+    readonly path: Schema.String;
+    readonly title: Schema.String;
+    readonly description: Schema.String;
+    readonly icon: Schema.String;
+    readonly order: Schema.Number;
+    readonly locale: Schema.String;
+    readonly section: Schema.String;
+    readonly type: Schema.Literals<readonly ["concept", "tutorial", "how-to", "reference", "runbook"]>;
+    readonly legacySlugs: Schema.optional<Schema.$Array<Schema.String>>;
+    readonly headings: Schema.$Array<Schema.Struct<{
+        readonly depth: Schema.Literals<readonly [2, 3]>;
+        readonly id: Schema.String;
+        readonly title: Schema.String;
+    }>>;
+    readonly searchText: Schema.String;
+    readonly sourceFile: Schema.String;
+    readonly source: Schema.String;
+}>;
+export type DocsPage = typeof DocsPageSchema.Type;
+export declare const slugifyDocsHeading: (value: string) => string;
+type DocsSourceOptions = {
+    locales: ReadonlyArray<DocsLocale>;
+    requireLocaleParity?: boolean;
+    matchesLocale?: (file: string, locale: DocsLocale) => boolean;
+};
+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 {
+        readonly slug: string;
+        readonly path: string;
+        readonly title: string;
+        readonly description: string;
+        readonly icon: string;
+        readonly order: number;
+        readonly locale: string;
+        readonly section: string;
+        readonly type: "concept" | "how-to" | "reference" | "runbook" | "tutorial";
+        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;
+        readonly order: number;
+        readonly locale: string;
+        readonly section: string;
+        readonly type: "concept" | "how-to" | "reference" | "runbook" | "tutorial";
+        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;
+            readonly order: number;
+            readonly locale: string;
+            readonly section: string;
+            readonly type: "concept" | "how-to" | "reference" | "runbook" | "tutorial";
+            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;
+            readonly order: number;
+            readonly locale: string;
+            readonly section: string;
+            readonly type: "concept" | "how-to" | "reference" | "runbook" | "tutorial";
+            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;
+        readonly order: number;
+        readonly locale: string;
+        readonly section: string;
+        readonly type: "concept" | "how-to" | "reference" | "runbook" | "tutorial";
+        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;
+        readonly order: number;
+        readonly locale: string;
+        readonly section: string;
+        readonly type: "concept" | "how-to" | "reference" | "runbook" | "tutorial";
+        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 DocsSource = ReturnType<typeof createDocsSource>;
+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;
+        readonly order: number;
+        readonly locale: string;
+        readonly section: string;
+        readonly type: "concept" | "how-to" | "reference" | "runbook" | "tutorial";
+        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;
+        readonly order: number;
+        readonly locale: string;
+        readonly section: string;
+        readonly type: "concept" | "how-to" | "reference" | "runbook" | "tutorial";
+        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;
+            readonly order: number;
+            readonly locale: string;
+            readonly section: string;
+            readonly type: "concept" | "how-to" | "reference" | "runbook" | "tutorial";
+            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;
+            readonly order: number;
+            readonly locale: string;
+            readonly section: string;
+            readonly type: "concept" | "how-to" | "reference" | "runbook" | "tutorial";
+            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;
+        readonly order: number;
+        readonly locale: string;
+        readonly section: string;
+        readonly type: "concept" | "how-to" | "reference" | "runbook" | "tutorial";
+        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;
+        readonly order: number;
+        readonly locale: string;
+        readonly section: string;
+        readonly type: "concept" | "how-to" | "reference" | "runbook" | "tutorial";
+        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}`;
+    defaultSlug: string;
+    origin: `http://${string}` | `https://${string}`;
+    siteName: string;
+    defaultLocale?: DocsLocale;
+    messages?: (locale: DocsLocale) => DocsMessageOverrides;
+    brand?: {
+        label: string;
+        subtitle: () => string;
+        icon: string;
+        href: string;
+    };
+    resources?: {
+        label: () => string;
+        items: ReadonlyArray<DocsResource>;
+    };
+    githubLabel?: string;
+    sectionOrder?: ReadonlyArray<DocsSection>;
+    github?: {
+        url: `https://${string}`;
+        branch?: string;
+    };
+};
+export declare const makeDocs: (config: DocsConfig) => {
+    basePath: string;
+    brand: {
+        label: string;
+        subtitle: () => string;
+        icon: string;
+        href: string;
+    };
+    defaultSlug: string;
+    editUrl: (page: DocsPage) => string | undefined;
+    githubUrl: string | undefined;
+    githubLabel: string;
+    getHead: ({ locale, page, }: {
+        locale: DocsLocale;
+        page?: DocsPage;
+    }) => {
+        meta: ({
+            title: string;
+            name?: undefined;
+            property?: undefined;
+            content?: undefined;
+        } | {
+            title?: undefined;
+            name: string;
+            content: string;
+            property?: undefined;
+        } | {
+            title?: undefined;
+            name?: undefined;
+            property: string;
+            content: string;
+        })[];
+        links: ({
+            rel: string;
+            href: string;
+        } | {
+            rel: string;
+            hrefLang: string;
+            href: string;
+        })[];
+    };
+    getMessages: (locale: DocsLocale) => DocsRouteMessages;
+    origin: string;
+    resources: {
+        label: () => string;
+        items: ReadonlyArray<DocsResource>;
+    } | undefined;
+    source: {
+        locales: readonly string[];
+        pages: readonly {
+            readonly slug: string;
+            readonly path: string;
+            readonly title: string;
+            readonly description: string;
+            readonly icon: string;
+            readonly order: number;
+            readonly locale: string;
+            readonly section: string;
+            readonly type: "concept" | "how-to" | "reference" | "runbook" | "tutorial";
+            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;
+            readonly order: number;
+            readonly locale: string;
+            readonly section: string;
+            readonly type: "concept" | "how-to" | "reference" | "runbook" | "tutorial";
+            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;
+                readonly order: number;
+                readonly locale: string;
+                readonly section: string;
+                readonly type: "concept" | "how-to" | "reference" | "runbook" | "tutorial";
+                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;
+                readonly order: number;
+                readonly locale: string;
+                readonly section: string;
+                readonly type: "concept" | "how-to" | "reference" | "runbook" | "tutorial";
+                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;
+            readonly order: number;
+            readonly locale: string;
+            readonly section: string;
+            readonly type: "concept" | "how-to" | "reference" | "runbook" | "tutorial";
+            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;
+            readonly order: number;
+            readonly locale: string;
+            readonly section: string;
+            readonly type: "concept" | "how-to" | "reference" | "runbook" | "tutorial";
+            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;
+    };
+    pages: (locale: DocsLocale) => {
+        readonly slug: string;
+        readonly path: string;
+        readonly title: string;
+        readonly description: string;
+        readonly icon: string;
+        readonly order: number;
+        readonly locale: string;
+        readonly section: string;
+        readonly type: "concept" | "how-to" | "reference" | "runbook" | "tutorial";
+        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;
+    }[];
+    resolve: (routeSlug: string | undefined, locale: DocsLocale) => {
+        page: {
+            readonly slug: string;
+            readonly path: string;
+            readonly title: string;
+            readonly description: string;
+            readonly icon: string;
+            readonly order: number;
+            readonly locale: string;
+            readonly section: string;
+            readonly type: "concept" | "how-to" | "reference" | "runbook" | "tutorial";
+            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;
+        };
+        canonical: boolean;
+        neighbors: {
+            previous: {
+                readonly slug: string;
+                readonly path: string;
+                readonly title: string;
+                readonly description: string;
+                readonly icon: string;
+                readonly order: number;
+                readonly locale: string;
+                readonly section: string;
+                readonly type: "concept" | "how-to" | "reference" | "runbook" | "tutorial";
+                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;
+                readonly order: number;
+                readonly locale: string;
+                readonly section: string;
+                readonly type: "concept" | "how-to" | "reference" | "runbook" | "tutorial";
+                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;
+        };
+    } | undefined;
+    search: (query: string, locale: DocsLocale, options?: {
+        limit?: number;
+    }) => DocsSearchResult[];
+    sections: (locale: DocsLocale) => {
+        id: string;
+        pages: {
+            readonly slug: string;
+            readonly path: string;
+            readonly title: string;
+            readonly description: string;
+            readonly icon: string;
+            readonly order: number;
+            readonly locale: string;
+            readonly section: string;
+            readonly type: "concept" | "how-to" | "reference" | "runbook" | "tutorial";
+            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;
+        }[];
+    }[];
+    url: (page: DocsPage, locale: DocsLocale) => string;
+};
+export type DocsCatalog = ReturnType<typeof makeDocs>;
+export type DocsRouteMessages = {
+    title: string;
+    description: string;
+    copied: string;
+    copyCode: string;
+    copyLink: string;
+    copyTable: string;
+    downloadTable: string;
+    onThisPage: string;
+    searchTitle: string;
+    searchDescription: string;
+    searchPlaceholder: string;
+    searchInputPlaceholder: string;
+    searchEmpty: string;
+    skipToContent: string;
+    editPage: string;
+    latestVersionNotice: string;
+    pageNavigation: string;
+    previous: string;
+    next: string;
+    notFoundTitle: string;
+    notFoundDescription: string;
+    notFoundAction: string;
+    sectionLabel: (section: DocsSection) => string;
+    pageTypeLabel: (type: DocsPageType) => string;
+};
+export type DocsMessageOverrides = Partial<DocsRouteMessages>;
+export declare const getDocsMessages: (locale: DocsLocale, overrides?: DocsMessageOverrides) => DocsRouteMessages;
+export type DocsResource = {
+    label: () => string;
+    href: string;
+    icon: string;
+    external?: boolean;
+};
+export type DocsResolution = NonNullable<ReturnType<DocsCatalog["resolve"]>>;
+export type DocsLayoutProps = {
+    children: ReactNode;
+    docs: DocsCatalog;
+    headerActions?: ReactNode;
+    locale: DocsLocale;
+};
+export declare const DocsLayout: ({ children, docs, headerActions, locale, }: DocsLayoutProps) => import("react").JSX.Element;
+export type DocsPageProps = {
+    children?: ReactNode;
+    docs: DocsCatalog;
+    resolution: DocsResolution;
+};
+type DocsPageSectionProps = Omit<DocsPageProps, "children">;
+export declare const DocsHeader: ({ docs, resolution }: DocsPageSectionProps) => import("react").JSX.Element;
+export declare const DocsContent: ({ docs, resolution }: DocsPageSectionProps) => import("react").JSX.Element;
+export declare const DocsFooter: ({ docs, resolution }: DocsPageSectionProps) => import("react").JSX.Element;
+export declare const DocsPage: ({ children, docs, resolution }: DocsPageProps) => import("react").JSX.Element;
+export declare const DocsNotFound: ({ docs, locale, }: {
+    docs: DocsCatalog;
+    locale: DocsLocale;
+}) => import("react").JSX.Element;
+export {};