@vezham/start 26.0.0-beta.2 → 26.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/lib/layouts/app/index.d.ts +1 -1
- package/dist/lib/layouts/docs/components.d.ts +1 -1
- package/dist/lib/layouts/docs/layout-components.d.ts +1 -1
- package/dist/lib/layouts/docs/layouts.d.ts +2 -2
- package/dist/lib/layouts/docs/page-actions.variants.d.ts +2 -2
- package/dist/lib/layouts/docs/page-content.d.ts +2 -2
- package/dist/lib/layouts/docs/pages.d.ts +3 -3
- package/dist/lib/layouts/docs/types.d.ts +2 -2
- package/dist/lib/mdx/index.d.ts +21 -21
- package/dist/lib/pages/docs/openapi/index.d.ts +1 -1
- package/dist/lib/pages/docs/route/index.d.ts +3 -3
- package/dist/lib/provider/next/config.d.ts +1 -1
- package/dist/lib/provider/next/provider.d.ts +1 -1
- package/dist/lib/provider/next/root-document.d.ts +1 -1
- package/dist/lib/provider/shared/config.d.ts +1 -1
- package/dist/lib/provider/shared/devtools.d.ts +1 -1
- package/dist/lib/provider/shared/provider.d.ts +3 -3
- package/dist/lib/provider/shared/types.d.ts +3 -3
- package/dist/lib/provider/tanstack/config.d.ts +1 -1
- package/dist/lib/provider/tanstack/provider.d.ts +1 -1
- package/dist/lib/provider/tanstack/root-document.d.ts +2 -2
- package/dist/lib/provider/tanstack-docs/config.d.ts +3 -3
- package/dist/lib/provider/tanstack-docs/i18n.d.ts +1 -1
- package/dist/lib/provider/tanstack-docs/routes.d.ts +1 -1
- package/dist/lib/provider/tanstack-docs/search.d.ts +1 -1
- package/dist/lib/provider/vite/config.d.ts +1 -1
- package/dist/lib/provider/vite/provider.d.ts +1 -1
- package/dist/lib/runtime/docs/i18n.d.ts +2 -2
- package/dist/lib/runtime/docs/icons.d.ts +2 -2
- package/dist/lib/runtime/docs/openapi.d.ts +2 -2
- package/dist/lib/runtime/docs/pages.d.ts +16 -16
- package/dist/lib/runtime/docs/runtime.d.ts +110 -110
- package/dist/lib/runtime/docs/static.d.ts +3 -3
- package/dist/lib/story/index.d.ts +1 -1
- package/package.json +4 -4
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { DocsLayoutProps, DocsPageProps } from './types';
|
|
1
|
+
import type { DocsLayoutProps, DocsPageProps } from './types';
|
|
2
2
|
export declare const DocsLayout: ({ shell, ...props }: DocsLayoutProps) => import("react").JSX.Element;
|
|
3
3
|
export declare const DocsPage: ({ full, shell, toc, ...props }: DocsPageProps) => import("react").JSX.Element;
|
|
4
4
|
//# sourceMappingURL=components.d.ts.map
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { DocsLayoutProps } from './types';
|
|
1
|
+
import type { DocsLayoutProps } from './types';
|
|
2
2
|
type Props = Omit<DocsLayoutProps, 'shell'>;
|
|
3
3
|
export declare const HomeDocsLayout: (props: Props) => import("react").JSX.Element;
|
|
4
4
|
export declare const GlassDocsLayout: (props: Props) => import("react").JSX.Element;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { ReactNode } from 'react';
|
|
2
|
-
import { DocsLayoutProps, DocsShell } from './types';
|
|
1
|
+
import type { ReactNode } from 'react';
|
|
2
|
+
import type { DocsLayoutProps, DocsShell } from './types';
|
|
3
3
|
type Props = Omit<DocsLayoutProps, 'shell'>;
|
|
4
4
|
export declare const layouts: Record<DocsShell, (props: Props) => ReactNode>;
|
|
5
5
|
export {};
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export declare const pageActionsVariants: import(
|
|
1
|
+
export declare const pageActionsVariants: import("tailwind-variants").TVReturnType<{
|
|
2
2
|
open: {
|
|
3
3
|
true: {
|
|
4
4
|
chevron: string;
|
|
@@ -26,7 +26,7 @@ export declare const pageActionsVariants: import('tailwind-variants').TVReturnTy
|
|
|
26
26
|
description: string;
|
|
27
27
|
externalIcon: string;
|
|
28
28
|
error: string;
|
|
29
|
-
}, import(
|
|
29
|
+
}, import("tailwind-variants").TVReturnTypeLike<{
|
|
30
30
|
open: {
|
|
31
31
|
true: {
|
|
32
32
|
chevron: string;
|
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
import { ComponentProps } from 'react';
|
|
1
|
+
import type { ComponentProps } from 'react';
|
|
2
2
|
import { DocsBody, DocsDescription, DocsPage as DocsPagePrimitive, DocsTitle } from '@vezham/docs-react/layouts/docs/page';
|
|
3
|
-
import { DocsBody as NotebookDocsBody, DocsDescription as NotebookDocsDescription, DocsPage as NotebookDocsPage, DocsTitle as NotebookDocsTitle } from '@vezham/docs-react/layouts/notebook/page';
|
|
4
|
-
import { DocsShell } from './types';
|
|
5
3
|
import * as FluxPage from '@vezham/docs-react/layouts/flux/page';
|
|
6
4
|
import * as GlassPage from '@vezham/docs-react/layouts/glass/page';
|
|
5
|
+
import { DocsBody as NotebookDocsBody, DocsDescription as NotebookDocsDescription, DocsPage as NotebookDocsPage, DocsTitle as NotebookDocsTitle } from '@vezham/docs-react/layouts/notebook/page';
|
|
6
|
+
import type { DocsShell } from './types';
|
|
7
7
|
export type DocsPageToc = ComponentProps<typeof DocsPagePrimitive>['toc'];
|
|
8
8
|
declare const pages: {
|
|
9
9
|
docs: {
|
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
import { ComponentProps, ReactNode } from 'react';
|
|
1
|
+
import type { ComponentProps, ReactNode } from 'react';
|
|
2
2
|
import { DocsLayout as DocsLayoutPrimitive } from '@vezham/docs-react/layouts/docs';
|
|
3
3
|
import { DocsLayout as NotebookLayoutPrimitive } from '@vezham/docs-react/layouts/notebook';
|
|
4
|
-
import { DocsPageToc } from './pages';
|
|
4
|
+
import type { DocsPageToc } from './pages';
|
|
5
5
|
export type DocsShell = 'docs' | 'flux' | 'glass' | 'home' | 'notebook';
|
|
6
6
|
export type DocsLayoutProps = {
|
|
7
7
|
children: ReactNode;
|
package/dist/lib/mdx/index.d.ts
CHANGED
|
@@ -1,26 +1,26 @@
|
|
|
1
|
-
import { ElementType } from 'react';
|
|
1
|
+
import type { ElementType } from 'react';
|
|
2
2
|
type MDXComponents = Record<string, ElementType>;
|
|
3
3
|
export declare const getMDXComponents: (components?: MDXComponents) => {
|
|
4
|
-
CodeBlockTab: typeof import(
|
|
5
|
-
CodeBlockTabs: typeof import(
|
|
6
|
-
CodeBlockTabsList: typeof import(
|
|
7
|
-
CodeBlockTabsTrigger: typeof import(
|
|
8
|
-
pre: (props: import(
|
|
9
|
-
Card: typeof import(
|
|
10
|
-
Cards: typeof import(
|
|
11
|
-
a: import(
|
|
12
|
-
img: (props: import(
|
|
13
|
-
h1: (props: import(
|
|
14
|
-
h2: (props: import(
|
|
15
|
-
h3: (props: import(
|
|
16
|
-
h4: (props: import(
|
|
17
|
-
h5: (props: import(
|
|
18
|
-
h6: (props: import(
|
|
19
|
-
table: (props: import(
|
|
20
|
-
Callout: typeof import(
|
|
21
|
-
CalloutContainer: typeof import(
|
|
22
|
-
CalloutTitle: typeof import(
|
|
23
|
-
CalloutDescription: typeof import(
|
|
4
|
+
CodeBlockTab: typeof import("@vezham/docs-react/components/codeblock").CodeBlockTab;
|
|
5
|
+
CodeBlockTabs: typeof import("@vezham/docs-react/components/codeblock").CodeBlockTabs;
|
|
6
|
+
CodeBlockTabsList: typeof import("@vezham/docs-react/components/codeblock").CodeBlockTabsList;
|
|
7
|
+
CodeBlockTabsTrigger: typeof import("@vezham/docs-react/components/codeblock").CodeBlockTabsTrigger;
|
|
8
|
+
pre: (props: import("react").HTMLAttributes<HTMLPreElement>) => React.JSX.Element;
|
|
9
|
+
Card: typeof import("@vezham/docs-react/components/card").Card;
|
|
10
|
+
Cards: typeof import("@vezham/docs-react/components/card").Cards;
|
|
11
|
+
a: import("react").FC<import("react").AnchorHTMLAttributes<HTMLAnchorElement>>;
|
|
12
|
+
img: (props: import("react").ImgHTMLAttributes<HTMLImageElement>) => React.JSX.Element;
|
|
13
|
+
h1: (props: import("react").HTMLAttributes<HTMLHeadingElement>) => React.JSX.Element;
|
|
14
|
+
h2: (props: import("react").HTMLAttributes<HTMLHeadingElement>) => React.JSX.Element;
|
|
15
|
+
h3: (props: import("react").HTMLAttributes<HTMLHeadingElement>) => React.JSX.Element;
|
|
16
|
+
h4: (props: import("react").HTMLAttributes<HTMLHeadingElement>) => React.JSX.Element;
|
|
17
|
+
h5: (props: import("react").HTMLAttributes<HTMLHeadingElement>) => React.JSX.Element;
|
|
18
|
+
h6: (props: import("react").HTMLAttributes<HTMLHeadingElement>) => React.JSX.Element;
|
|
19
|
+
table: (props: import("react").TableHTMLAttributes<HTMLTableElement>) => React.JSX.Element;
|
|
20
|
+
Callout: typeof import("@vezham/docs-react/components/callout").Callout;
|
|
21
|
+
CalloutContainer: typeof import("@vezham/docs-react/components/callout").CalloutContainer;
|
|
22
|
+
CalloutTitle: typeof import("@vezham/docs-react/components/callout").CalloutTitle;
|
|
23
|
+
CalloutDescription: typeof import("@vezham/docs-react/components/callout").CalloutDescription;
|
|
24
24
|
};
|
|
25
25
|
export {};
|
|
26
26
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare const OpenAPIPage: import(
|
|
1
|
+
export declare const OpenAPIPage: import("react").FC<import("@vezham/docs-openapi/ui").OpenAPIPageProps>;
|
|
2
2
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { ComponentProps, ComponentType, ReactNode } from 'react';
|
|
2
|
-
import { SerializedPageTree } from '@vezham/docs-core/source/client';
|
|
3
|
-
import { DocsLayoutProps, DocsPage } from '../../../layouts/docs';
|
|
1
|
+
import type { ComponentProps, ComponentType, ReactNode } from 'react';
|
|
2
|
+
import { type SerializedPageTree } from '@vezham/docs-core/source/client';
|
|
3
|
+
import { type DocsLayoutProps, DocsPage } from '../../../layouts/docs';
|
|
4
4
|
import { getMDXComponents } from '../../../mdx';
|
|
5
5
|
type Toc = ComponentProps<typeof DocsPage>['toc'];
|
|
6
6
|
type MDXComponent = ComponentType<{
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { FC, ReactNode } from 'react';
|
|
2
|
-
import { DevtoolsApp } from '@vezham/devtools';
|
|
3
|
-
import { Props, ProviderEnv } from './types';
|
|
1
|
+
import type { FC, ReactNode } from 'react';
|
|
2
|
+
import type { DevtoolsApp } from '@vezham/devtools';
|
|
3
|
+
import type { Props, ProviderEnv } from './types';
|
|
4
4
|
interface CreateProviderProps {
|
|
5
5
|
env: ProviderEnv;
|
|
6
6
|
renderDevtools?: (options: {
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { AxiosRequestConfig } from 'axios';
|
|
2
|
-
import { ReactNode } from 'react';
|
|
3
|
-
import { AppRuntime } from '@vezham/devtools';
|
|
1
|
+
import type { AxiosRequestConfig } from 'axios';
|
|
2
|
+
import type { ReactNode } from 'react';
|
|
3
|
+
import type { AppRuntime } from '@vezham/devtools';
|
|
4
4
|
interface AxiosProps {
|
|
5
5
|
onRequest?: (config: AxiosRequestConfig) => {};
|
|
6
6
|
onError?: (error: any) => {};
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { Props } from '../shared/types';
|
|
1
|
+
import type { Props } from '../shared/types';
|
|
2
2
|
export declare const defineConfig: ({ children, ...props }: Props) => import("react").JSX.Element;
|
|
3
3
|
export declare const createRootComponent: (props: Props) => () => import("react").JSX.Element;
|
|
4
4
|
//# sourceMappingURL=config.d.ts.map
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { I18nAPI } from '@vezham/docs-core/i18n';
|
|
2
|
-
import { RootProviderProps } from '@vezham/docs-react/provider/tanstack';
|
|
3
|
-
import { Props } from '../shared/types';
|
|
1
|
+
import type { I18nAPI } from '@vezham/docs-core/i18n';
|
|
2
|
+
import { type RootProviderProps } from '@vezham/docs-react/provider/tanstack';
|
|
3
|
+
import type { Props } from '../shared/types';
|
|
4
4
|
type DocsConfigProps = Props & {
|
|
5
5
|
rootProvider?: Omit<RootProviderProps, 'children'>;
|
|
6
6
|
};
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { I18nAPI } from '@vezham/docs-core/i18n';
|
|
1
|
+
import type { I18nAPI } from '@vezham/docs-core/i18n';
|
|
2
2
|
export declare const getLanguageDisplayName: (language: string) => string;
|
|
3
3
|
export declare const createDocsTranslations: <Language extends string>(i18n: I18nAPI<Language>, overrides?: Partial<Record<Language, Record<string, string>>>) => Partial<Record<Language, Record<string, string>>>;
|
|
4
4
|
//# sourceMappingURL=i18n.d.ts.map
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { I18nAPI } from '@vezham/docs-core/i18n';
|
|
1
|
+
import type { I18nAPI } from '@vezham/docs-core/i18n';
|
|
2
2
|
export declare const parseRouteLocale: <Language extends string, Params extends {
|
|
3
3
|
lang?: string;
|
|
4
4
|
}>(i18n: I18nAPI<Language>, params: Params) => false | Params;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { SharedProps } from '@vezham/docs-react/components/dialog/search';
|
|
1
|
+
import { type SharedProps } from '@vezham/docs-react/components/dialog/search';
|
|
2
2
|
declare const DocsSearchDialog: (props: SharedProps) => import("react").JSX.Element;
|
|
3
3
|
export { DocsSearchDialog };
|
|
4
4
|
//# sourceMappingURL=search.d.ts.map
|
|
@@ -1,10 +1,10 @@
|
|
|
1
|
-
import { I18nConfig } from '@vezham/docs-core/i18n';
|
|
1
|
+
import { type I18nConfig } from '@vezham/docs-core/i18n';
|
|
2
2
|
export type DocsI18nInput<Languages extends readonly string[]> = {
|
|
3
3
|
defaultLanguage: Languages[number];
|
|
4
4
|
hideLocale?: I18nConfig<Languages[number]>['hideLocale'];
|
|
5
5
|
languages: Languages;
|
|
6
6
|
};
|
|
7
|
-
export declare const createDocsI18n: <const Languages extends readonly string[]>(config: DocsI18nInput<Languages>) => import(
|
|
7
|
+
export declare const createDocsI18n: <const Languages extends readonly string[]>(config: DocsI18nInput<Languages>) => import("@vezham/docs-core/i18n").I18nAPI<Languages[number]>;
|
|
8
8
|
export declare const normalizeLocale: <Locale extends string>(i18n: {
|
|
9
9
|
defaultLanguage: Locale;
|
|
10
10
|
languages: readonly Locale[];
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { CSSProperties, ReactNode } from 'react';
|
|
2
|
-
import { LoaderPlugin } from '@vezham/docs-core/source';
|
|
1
|
+
import { type CSSProperties, type ReactNode } from 'react';
|
|
2
|
+
import type { LoaderPlugin } from '@vezham/docs-core/source';
|
|
3
3
|
import { metaSchema, pageSchema } from '@vezham/docs-core/source/schema';
|
|
4
4
|
export declare const defaultDocsIconAssetBaseUrl = "https://cdn.jsdelivr.net/npm/@vezham/icons@1.0.7/dist/cdn/icons";
|
|
5
5
|
export type DocsIconName = string;
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { OpenAPIOptions, createOpenAPI } from '@vezham/docs-openapi/server';
|
|
1
|
+
import { type OpenAPIOptions, createOpenAPI } from '@vezham/docs-openapi/server';
|
|
2
2
|
type OpenAPIDocument = Exclude<NonNullable<OpenAPIOptions['input']>, string[]>[string];
|
|
3
3
|
export type DocsOpenAPIPlugin = {
|
|
4
4
|
loaderPlugin: () => ReturnType<ReturnType<typeof createOpenAPI>['loaderPlugin']>;
|
|
@@ -31,7 +31,7 @@ export type DocsPageLike = {
|
|
|
31
31
|
};
|
|
32
32
|
export declare const parseOpenAPIDocument: (filePath: string, source: string) => OpenAPIDocument;
|
|
33
33
|
export declare const openAPIDocumentIdFromPath: (filePath: string, openapiDir?: string) => string;
|
|
34
|
-
export declare const createOpenAPIFromSources: ({ files, openapiDir, rootDocument, rootDocumentId }: CreateOpenAPIFromSourcesOptions) => import(
|
|
34
|
+
export declare const createOpenAPIFromSources: ({ files, openapiDir, rootDocument, rootDocumentId }: CreateOpenAPIFromSourcesOptions) => import("@vezham/docs-openapi/server").OpenAPIServer;
|
|
35
35
|
export declare const getOpenAPIDocumentId: (page: DocsPageLike) => string | undefined;
|
|
36
36
|
export declare const preloadDocsOpenAPIPage: <Page extends DocsPageLike>(page: Page, openapi: {
|
|
37
37
|
preloadOpenAPIPage: (page: Page) => Promise<unknown>;
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { StaticSource } from '@vezham/docs-core/source';
|
|
2
|
-
import { DocsRouteHeadOptions } from './head';
|
|
3
|
-
import { createStaticDocsRuntimeBase } from './runtime';
|
|
1
|
+
import type { StaticSource } from '@vezham/docs-core/source';
|
|
2
|
+
import { type DocsRouteHeadOptions } from './head';
|
|
3
|
+
import { type createStaticDocsRuntimeBase } from './runtime';
|
|
4
4
|
export type DocsPageInput = {
|
|
5
5
|
lang?: string;
|
|
6
6
|
pathFormat?: 'slug' | 'markdown-url';
|
|
@@ -21,16 +21,16 @@ export declare const createDocsPageRuntime: <Docs extends StaticSource, const La
|
|
|
21
21
|
docs: Docs;
|
|
22
22
|
} extends infer T ? T extends {
|
|
23
23
|
docs: Docs;
|
|
24
|
-
} ? T extends Record<infer K extends string, import(
|
|
25
|
-
pageData: import(
|
|
26
|
-
metaData: import(
|
|
27
|
-
}>> ? { [k in K]: T[k] extends import(
|
|
28
|
-
pageData: import(
|
|
29
|
-
metaData: import(
|
|
30
|
-
}> ? import(
|
|
31
|
-
pageData: import(
|
|
32
|
-
metaData: import(
|
|
33
|
-
}> ? import(
|
|
24
|
+
} ? T extends Record<infer K extends string, import("@vezham/docs-core/source").SourceUnion<{
|
|
25
|
+
pageData: import("@vezham/docs-core/source").PageData;
|
|
26
|
+
metaData: import("@vezham/docs-core/source").MetaData;
|
|
27
|
+
}>> ? { [k in K]: T[k] extends import("@vezham/docs-core/source").SourceUnion<infer D extends {
|
|
28
|
+
pageData: import("@vezham/docs-core/source").PageData;
|
|
29
|
+
metaData: import("@vezham/docs-core/source").MetaData;
|
|
30
|
+
}> ? import("@vezham/docs-core/source").Page<k, D["pageData"]> : never; }[K] : T extends import("@vezham/docs-core/source").SourceUnion<infer D extends {
|
|
31
|
+
pageData: import("@vezham/docs-core/source").PageData;
|
|
32
|
+
metaData: import("@vezham/docs-core/source").MetaData;
|
|
33
|
+
}> ? import("@vezham/docs-core/source").Page<undefined, D["pageData"]> : never : never : never;
|
|
34
34
|
};
|
|
35
35
|
loadDocsPage: ({ slugs, lang, routeBase }: {
|
|
36
36
|
slugs: string[];
|
|
@@ -43,7 +43,7 @@ export declare const createDocsPageRuntime: <Docs extends StaticSource, const La
|
|
|
43
43
|
routePath: string;
|
|
44
44
|
path: string;
|
|
45
45
|
markdownUrl: string;
|
|
46
|
-
pageTree: import(
|
|
46
|
+
pageTree: import("@vezham/docs-core/source/client").SerializedPageTree;
|
|
47
47
|
openapiData: unknown;
|
|
48
48
|
}>;
|
|
49
49
|
getDocsRouteHead: (data?: Awaited<ReturnType<({ slugs, lang, routeBase }: {
|
|
@@ -57,7 +57,7 @@ export declare const createDocsPageRuntime: <Docs extends StaticSource, const La
|
|
|
57
57
|
routePath: string;
|
|
58
58
|
path: string;
|
|
59
59
|
markdownUrl: string;
|
|
60
|
-
pageTree: import(
|
|
60
|
+
pageTree: import("@vezham/docs-core/source/client").SerializedPageTree;
|
|
61
61
|
openapiData: unknown;
|
|
62
62
|
}>>>) => {
|
|
63
63
|
meta?: undefined;
|
|
@@ -91,7 +91,7 @@ export declare const createDocsPageRuntime: <Docs extends StaticSource, const La
|
|
|
91
91
|
routePath: string;
|
|
92
92
|
path: string;
|
|
93
93
|
markdownUrl: string;
|
|
94
|
-
pageTree: import(
|
|
94
|
+
pageTree: import("@vezham/docs-core/source/client").SerializedPageTree;
|
|
95
95
|
openapiData: unknown;
|
|
96
96
|
}>;
|
|
97
97
|
};
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
import { I18nConfig } from '@vezham/docs-core/i18n';
|
|
2
|
-
import { SearchAPI } from '@vezham/docs-core/search/server';
|
|
3
|
-
import { StaticSource } from '@vezham/docs-core/source';
|
|
4
|
-
import { DocsI18nInput } from './i18n';
|
|
5
|
-
import { DocsOpenAPIPlugin, DocsOpenAPIPreloader, DocsOpenAPIRuntime, OpenAPISourceFiles } from './openapi';
|
|
1
|
+
import type { I18nConfig } from '@vezham/docs-core/i18n';
|
|
2
|
+
import { type SearchAPI } from '@vezham/docs-core/search/server';
|
|
3
|
+
import { type StaticSource } from '@vezham/docs-core/source';
|
|
4
|
+
import { type DocsI18nInput } from './i18n';
|
|
5
|
+
import { type DocsOpenAPIPlugin, type DocsOpenAPIPreloader, type DocsOpenAPIRuntime, type OpenAPISourceFiles } from './openapi';
|
|
6
6
|
export type DocsCollectionSource<Docs extends StaticSource = StaticSource> = {
|
|
7
7
|
toDocsSource: () => Docs;
|
|
8
8
|
};
|
|
@@ -17,101 +17,101 @@ export type CreateStaticDocsRuntimeOptions<Docs extends StaticSource, Languages
|
|
|
17
17
|
rootDocumentId?: string;
|
|
18
18
|
};
|
|
19
19
|
export declare const createStaticDocsRuntimeBase: <Docs extends StaticSource, const Languages extends readonly string[]>({ docs, docsRoute, i18n: i18nConfig, openapiDir, openapiFiles, rootDocument, rootDocumentId }: CreateStaticDocsRuntimeOptions<Docs, Languages>) => {
|
|
20
|
-
source: import(
|
|
20
|
+
source: import("@vezham/docs-core/source").LoaderOutput<{
|
|
21
21
|
meta: {
|
|
22
22
|
docs: Docs;
|
|
23
23
|
} extends infer T ? T extends {
|
|
24
24
|
docs: Docs;
|
|
25
|
-
} ? T extends Record<infer K extends string, import(
|
|
26
|
-
pageData: import(
|
|
27
|
-
metaData: import(
|
|
28
|
-
}>> ? { [k in K]: T[k] extends import(
|
|
29
|
-
pageData: import(
|
|
30
|
-
metaData: import(
|
|
31
|
-
}> ? import(
|
|
32
|
-
pageData: import(
|
|
33
|
-
metaData: import(
|
|
34
|
-
}> ? import(
|
|
25
|
+
} ? T extends Record<infer K extends string, import("@vezham/docs-core/source").SourceUnion<{
|
|
26
|
+
pageData: import("@vezham/docs-core/source").PageData;
|
|
27
|
+
metaData: import("@vezham/docs-core/source").MetaData;
|
|
28
|
+
}>> ? { [k in K]: T[k] extends import("@vezham/docs-core/source").SourceUnion<infer D extends {
|
|
29
|
+
pageData: import("@vezham/docs-core/source").PageData;
|
|
30
|
+
metaData: import("@vezham/docs-core/source").MetaData;
|
|
31
|
+
}> ? import("@vezham/docs-core/source").Meta<k, D["metaData"]> : never; }[K] : T extends import("@vezham/docs-core/source").SourceUnion<infer D extends {
|
|
32
|
+
pageData: import("@vezham/docs-core/source").PageData;
|
|
33
|
+
metaData: import("@vezham/docs-core/source").MetaData;
|
|
34
|
+
}> ? import("@vezham/docs-core/source").Meta<undefined, D["metaData"]> : never : never : never;
|
|
35
35
|
page: {
|
|
36
36
|
docs: Docs;
|
|
37
37
|
} extends infer T_1 ? T_1 extends {
|
|
38
38
|
docs: Docs;
|
|
39
|
-
} ? T_1 extends Record<infer K_1 extends string, import(
|
|
40
|
-
pageData: import(
|
|
41
|
-
metaData: import(
|
|
42
|
-
}>> ? { [k_1 in K_1]: T_1[k_1] extends import(
|
|
43
|
-
pageData: import(
|
|
44
|
-
metaData: import(
|
|
45
|
-
}> ? import(
|
|
46
|
-
pageData: import(
|
|
47
|
-
metaData: import(
|
|
48
|
-
}> ? import(
|
|
49
|
-
i18n: import(
|
|
39
|
+
} ? T_1 extends Record<infer K_1 extends string, import("@vezham/docs-core/source").SourceUnion<{
|
|
40
|
+
pageData: import("@vezham/docs-core/source").PageData;
|
|
41
|
+
metaData: import("@vezham/docs-core/source").MetaData;
|
|
42
|
+
}>> ? { [k_1 in K_1]: T_1[k_1] extends import("@vezham/docs-core/source").SourceUnion<infer D_1 extends {
|
|
43
|
+
pageData: import("@vezham/docs-core/source").PageData;
|
|
44
|
+
metaData: import("@vezham/docs-core/source").MetaData;
|
|
45
|
+
}> ? import("@vezham/docs-core/source").Page<k_1, D_1["pageData"]> : never; }[K_1] : T_1 extends import("@vezham/docs-core/source").SourceUnion<infer D_1 extends {
|
|
46
|
+
pageData: import("@vezham/docs-core/source").PageData;
|
|
47
|
+
metaData: import("@vezham/docs-core/source").MetaData;
|
|
48
|
+
}> ? import("@vezham/docs-core/source").Page<undefined, D_1["pageData"]> : never : never : never;
|
|
49
|
+
i18n: import("@vezham/docs-core/i18n").I18nAPI<Languages[number]>;
|
|
50
50
|
}>;
|
|
51
51
|
preloadOpenAPIPage: (page: {
|
|
52
52
|
docs: Docs;
|
|
53
53
|
} extends infer T_2 ? T_2 extends {
|
|
54
54
|
docs: Docs;
|
|
55
|
-
} ? T_2 extends Record<infer K_1 extends string, import(
|
|
56
|
-
pageData: import(
|
|
57
|
-
metaData: import(
|
|
58
|
-
}>> ? { [k_2 in K_1]: T_2[k_2] extends import(
|
|
59
|
-
pageData: import(
|
|
60
|
-
metaData: import(
|
|
61
|
-
}> ? import(
|
|
62
|
-
pageData: import(
|
|
63
|
-
metaData: import(
|
|
64
|
-
}> ? import(
|
|
55
|
+
} ? T_2 extends Record<infer K_1 extends string, import("@vezham/docs-core/source").SourceUnion<{
|
|
56
|
+
pageData: import("@vezham/docs-core/source").PageData;
|
|
57
|
+
metaData: import("@vezham/docs-core/source").MetaData;
|
|
58
|
+
}>> ? { [k_2 in K_1]: T_2[k_2] extends import("@vezham/docs-core/source").SourceUnion<infer D_2 extends {
|
|
59
|
+
pageData: import("@vezham/docs-core/source").PageData;
|
|
60
|
+
metaData: import("@vezham/docs-core/source").MetaData;
|
|
61
|
+
}> ? import("@vezham/docs-core/source").Page<k_2, D_2["pageData"]> : never; }[K_1] : T_2 extends import("@vezham/docs-core/source").SourceUnion<infer D_1 extends {
|
|
62
|
+
pageData: import("@vezham/docs-core/source").PageData;
|
|
63
|
+
metaData: import("@vezham/docs-core/source").MetaData;
|
|
64
|
+
}> ? import("@vezham/docs-core/source").Page<undefined, D_1["pageData"]> : never : never : never) => Promise<unknown> | undefined;
|
|
65
65
|
getLLMText: (page: {
|
|
66
66
|
docs: Docs;
|
|
67
67
|
} extends infer T_2 ? T_2 extends {
|
|
68
68
|
docs: Docs;
|
|
69
|
-
} ? T_2 extends Record<infer K_1 extends string, import(
|
|
70
|
-
pageData: import(
|
|
71
|
-
metaData: import(
|
|
72
|
-
}>> ? { [k_2 in K_1]: T_2[k_2] extends import(
|
|
73
|
-
pageData: import(
|
|
74
|
-
metaData: import(
|
|
75
|
-
}> ? import(
|
|
76
|
-
pageData: import(
|
|
77
|
-
metaData: import(
|
|
78
|
-
}> ? import(
|
|
79
|
-
i18n: import(
|
|
69
|
+
} ? T_2 extends Record<infer K_1 extends string, import("@vezham/docs-core/source").SourceUnion<{
|
|
70
|
+
pageData: import("@vezham/docs-core/source").PageData;
|
|
71
|
+
metaData: import("@vezham/docs-core/source").MetaData;
|
|
72
|
+
}>> ? { [k_2 in K_1]: T_2[k_2] extends import("@vezham/docs-core/source").SourceUnion<infer D_2 extends {
|
|
73
|
+
pageData: import("@vezham/docs-core/source").PageData;
|
|
74
|
+
metaData: import("@vezham/docs-core/source").MetaData;
|
|
75
|
+
}> ? import("@vezham/docs-core/source").Page<k_2, D_2["pageData"]> : never; }[K_1] : T_2 extends import("@vezham/docs-core/source").SourceUnion<infer D_1 extends {
|
|
76
|
+
pageData: import("@vezham/docs-core/source").PageData;
|
|
77
|
+
metaData: import("@vezham/docs-core/source").MetaData;
|
|
78
|
+
}> ? import("@vezham/docs-core/source").Page<undefined, D_1["pageData"]> : never : never : never) => Promise<string>;
|
|
79
|
+
i18n: import("@vezham/docs-core/i18n").I18nAPI<Languages[number]>;
|
|
80
80
|
};
|
|
81
81
|
export declare const createDocsSource: <Docs extends StaticSource, I18n extends I18nConfig>({ docs, docsRoute, i18n, openapi }: {
|
|
82
82
|
docs: Docs;
|
|
83
83
|
docsRoute?: string;
|
|
84
84
|
i18n: I18n;
|
|
85
85
|
openapi: DocsOpenAPIPlugin;
|
|
86
|
-
}) => import(
|
|
86
|
+
}) => import("@vezham/docs-core/source").LoaderOutput<{
|
|
87
87
|
meta: {
|
|
88
88
|
docs: Docs;
|
|
89
89
|
} extends infer T ? T extends {
|
|
90
90
|
docs: Docs;
|
|
91
|
-
} ? T extends Record<infer K extends string, import(
|
|
92
|
-
pageData: import(
|
|
93
|
-
metaData: import(
|
|
94
|
-
}>> ? { [k in K]: T[k] extends import(
|
|
95
|
-
pageData: import(
|
|
96
|
-
metaData: import(
|
|
97
|
-
}> ? import(
|
|
98
|
-
pageData: import(
|
|
99
|
-
metaData: import(
|
|
100
|
-
}> ? import(
|
|
91
|
+
} ? T extends Record<infer K extends string, import("@vezham/docs-core/source").SourceUnion<{
|
|
92
|
+
pageData: import("@vezham/docs-core/source").PageData;
|
|
93
|
+
metaData: import("@vezham/docs-core/source").MetaData;
|
|
94
|
+
}>> ? { [k in K]: T[k] extends import("@vezham/docs-core/source").SourceUnion<infer D extends {
|
|
95
|
+
pageData: import("@vezham/docs-core/source").PageData;
|
|
96
|
+
metaData: import("@vezham/docs-core/source").MetaData;
|
|
97
|
+
}> ? import("@vezham/docs-core/source").Meta<k, D["metaData"]> : never; }[K] : T extends import("@vezham/docs-core/source").SourceUnion<infer D extends {
|
|
98
|
+
pageData: import("@vezham/docs-core/source").PageData;
|
|
99
|
+
metaData: import("@vezham/docs-core/source").MetaData;
|
|
100
|
+
}> ? import("@vezham/docs-core/source").Meta<undefined, D["metaData"]> : never : never : never;
|
|
101
101
|
page: {
|
|
102
102
|
docs: Docs;
|
|
103
103
|
} extends infer T_1 ? T_1 extends {
|
|
104
104
|
docs: Docs;
|
|
105
|
-
} ? T_1 extends Record<infer K_1 extends string, import(
|
|
106
|
-
pageData: import(
|
|
107
|
-
metaData: import(
|
|
108
|
-
}>> ? { [k_1 in K_1]: T_1[k_1] extends import(
|
|
109
|
-
pageData: import(
|
|
110
|
-
metaData: import(
|
|
111
|
-
}> ? import(
|
|
112
|
-
pageData: import(
|
|
113
|
-
metaData: import(
|
|
114
|
-
}> ? import(
|
|
105
|
+
} ? T_1 extends Record<infer K_1 extends string, import("@vezham/docs-core/source").SourceUnion<{
|
|
106
|
+
pageData: import("@vezham/docs-core/source").PageData;
|
|
107
|
+
metaData: import("@vezham/docs-core/source").MetaData;
|
|
108
|
+
}>> ? { [k_1 in K_1]: T_1[k_1] extends import("@vezham/docs-core/source").SourceUnion<infer D_1 extends {
|
|
109
|
+
pageData: import("@vezham/docs-core/source").PageData;
|
|
110
|
+
metaData: import("@vezham/docs-core/source").MetaData;
|
|
111
|
+
}> ? import("@vezham/docs-core/source").Page<k_1, D_1["pageData"]> : never; }[K_1] : T_1 extends import("@vezham/docs-core/source").SourceUnion<infer D_1 extends {
|
|
112
|
+
pageData: import("@vezham/docs-core/source").PageData;
|
|
113
|
+
metaData: import("@vezham/docs-core/source").MetaData;
|
|
114
|
+
}> ? import("@vezham/docs-core/source").Page<undefined, D_1["pageData"]> : never : never : never;
|
|
115
115
|
i18n: I18n;
|
|
116
116
|
}>;
|
|
117
117
|
export declare const createDocsRuntime: <Docs extends StaticSource, I18n extends I18nConfig>({ docs, docsRoute, i18n, openapi }: {
|
|
@@ -120,65 +120,65 @@ export declare const createDocsRuntime: <Docs extends StaticSource, I18n extends
|
|
|
120
120
|
i18n: I18n;
|
|
121
121
|
openapi: DocsOpenAPIPlugin & DocsOpenAPIRuntime & DocsOpenAPIPreloader;
|
|
122
122
|
}) => {
|
|
123
|
-
source: import(
|
|
123
|
+
source: import("@vezham/docs-core/source").LoaderOutput<{
|
|
124
124
|
meta: {
|
|
125
125
|
docs: Docs;
|
|
126
126
|
} extends infer T ? T extends {
|
|
127
127
|
docs: Docs;
|
|
128
|
-
} ? T extends Record<infer K extends string, import(
|
|
129
|
-
pageData: import(
|
|
130
|
-
metaData: import(
|
|
131
|
-
}>> ? { [k in K]: T[k] extends import(
|
|
132
|
-
pageData: import(
|
|
133
|
-
metaData: import(
|
|
134
|
-
}> ? import(
|
|
135
|
-
pageData: import(
|
|
136
|
-
metaData: import(
|
|
137
|
-
}> ? import(
|
|
128
|
+
} ? T extends Record<infer K extends string, import("@vezham/docs-core/source").SourceUnion<{
|
|
129
|
+
pageData: import("@vezham/docs-core/source").PageData;
|
|
130
|
+
metaData: import("@vezham/docs-core/source").MetaData;
|
|
131
|
+
}>> ? { [k in K]: T[k] extends import("@vezham/docs-core/source").SourceUnion<infer D extends {
|
|
132
|
+
pageData: import("@vezham/docs-core/source").PageData;
|
|
133
|
+
metaData: import("@vezham/docs-core/source").MetaData;
|
|
134
|
+
}> ? import("@vezham/docs-core/source").Meta<k, D["metaData"]> : never; }[K] : T extends import("@vezham/docs-core/source").SourceUnion<infer D extends {
|
|
135
|
+
pageData: import("@vezham/docs-core/source").PageData;
|
|
136
|
+
metaData: import("@vezham/docs-core/source").MetaData;
|
|
137
|
+
}> ? import("@vezham/docs-core/source").Meta<undefined, D["metaData"]> : never : never : never;
|
|
138
138
|
page: {
|
|
139
139
|
docs: Docs;
|
|
140
140
|
} extends infer T_1 ? T_1 extends {
|
|
141
141
|
docs: Docs;
|
|
142
|
-
} ? T_1 extends Record<infer K_1 extends string, import(
|
|
143
|
-
pageData: import(
|
|
144
|
-
metaData: import(
|
|
145
|
-
}>> ? { [k_1 in K_1]: T_1[k_1] extends import(
|
|
146
|
-
pageData: import(
|
|
147
|
-
metaData: import(
|
|
148
|
-
}> ? import(
|
|
149
|
-
pageData: import(
|
|
150
|
-
metaData: import(
|
|
151
|
-
}> ? import(
|
|
142
|
+
} ? T_1 extends Record<infer K_1 extends string, import("@vezham/docs-core/source").SourceUnion<{
|
|
143
|
+
pageData: import("@vezham/docs-core/source").PageData;
|
|
144
|
+
metaData: import("@vezham/docs-core/source").MetaData;
|
|
145
|
+
}>> ? { [k_1 in K_1]: T_1[k_1] extends import("@vezham/docs-core/source").SourceUnion<infer D_1 extends {
|
|
146
|
+
pageData: import("@vezham/docs-core/source").PageData;
|
|
147
|
+
metaData: import("@vezham/docs-core/source").MetaData;
|
|
148
|
+
}> ? import("@vezham/docs-core/source").Page<k_1, D_1["pageData"]> : never; }[K_1] : T_1 extends import("@vezham/docs-core/source").SourceUnion<infer D_1 extends {
|
|
149
|
+
pageData: import("@vezham/docs-core/source").PageData;
|
|
150
|
+
metaData: import("@vezham/docs-core/source").MetaData;
|
|
151
|
+
}> ? import("@vezham/docs-core/source").Page<undefined, D_1["pageData"]> : never : never : never;
|
|
152
152
|
i18n: I18n;
|
|
153
153
|
}>;
|
|
154
154
|
preloadOpenAPIPage: (page: {
|
|
155
155
|
docs: Docs;
|
|
156
156
|
} extends infer T_2 ? T_2 extends {
|
|
157
157
|
docs: Docs;
|
|
158
|
-
} ? T_2 extends Record<infer K_1 extends string, import(
|
|
159
|
-
pageData: import(
|
|
160
|
-
metaData: import(
|
|
161
|
-
}>> ? { [k_2 in K_1]: T_2[k_2] extends import(
|
|
162
|
-
pageData: import(
|
|
163
|
-
metaData: import(
|
|
164
|
-
}> ? import(
|
|
165
|
-
pageData: import(
|
|
166
|
-
metaData: import(
|
|
167
|
-
}> ? import(
|
|
158
|
+
} ? T_2 extends Record<infer K_1 extends string, import("@vezham/docs-core/source").SourceUnion<{
|
|
159
|
+
pageData: import("@vezham/docs-core/source").PageData;
|
|
160
|
+
metaData: import("@vezham/docs-core/source").MetaData;
|
|
161
|
+
}>> ? { [k_2 in K_1]: T_2[k_2] extends import("@vezham/docs-core/source").SourceUnion<infer D_2 extends {
|
|
162
|
+
pageData: import("@vezham/docs-core/source").PageData;
|
|
163
|
+
metaData: import("@vezham/docs-core/source").MetaData;
|
|
164
|
+
}> ? import("@vezham/docs-core/source").Page<k_2, D_2["pageData"]> : never; }[K_1] : T_2 extends import("@vezham/docs-core/source").SourceUnion<infer D_1 extends {
|
|
165
|
+
pageData: import("@vezham/docs-core/source").PageData;
|
|
166
|
+
metaData: import("@vezham/docs-core/source").MetaData;
|
|
167
|
+
}> ? import("@vezham/docs-core/source").Page<undefined, D_1["pageData"]> : never : never : never) => Promise<unknown> | undefined;
|
|
168
168
|
getLLMText: (page: {
|
|
169
169
|
docs: Docs;
|
|
170
170
|
} extends infer T_2 ? T_2 extends {
|
|
171
171
|
docs: Docs;
|
|
172
|
-
} ? T_2 extends Record<infer K_1 extends string, import(
|
|
173
|
-
pageData: import(
|
|
174
|
-
metaData: import(
|
|
175
|
-
}>> ? { [k_2 in K_1]: T_2[k_2] extends import(
|
|
176
|
-
pageData: import(
|
|
177
|
-
metaData: import(
|
|
178
|
-
}> ? import(
|
|
179
|
-
pageData: import(
|
|
180
|
-
metaData: import(
|
|
181
|
-
}> ? import(
|
|
172
|
+
} ? T_2 extends Record<infer K_1 extends string, import("@vezham/docs-core/source").SourceUnion<{
|
|
173
|
+
pageData: import("@vezham/docs-core/source").PageData;
|
|
174
|
+
metaData: import("@vezham/docs-core/source").MetaData;
|
|
175
|
+
}>> ? { [k_2 in K_1]: T_2[k_2] extends import("@vezham/docs-core/source").SourceUnion<infer D_2 extends {
|
|
176
|
+
pageData: import("@vezham/docs-core/source").PageData;
|
|
177
|
+
metaData: import("@vezham/docs-core/source").MetaData;
|
|
178
|
+
}> ? import("@vezham/docs-core/source").Page<k_2, D_2["pageData"]> : never; }[K_1] : T_2 extends import("@vezham/docs-core/source").SourceUnion<infer D_1 extends {
|
|
179
|
+
pageData: import("@vezham/docs-core/source").PageData;
|
|
180
|
+
metaData: import("@vezham/docs-core/source").MetaData;
|
|
181
|
+
}> ? import("@vezham/docs-core/source").Page<undefined, D_1["pageData"]> : never : never : never) => Promise<string>;
|
|
182
182
|
};
|
|
183
183
|
export declare const getDocsLLMSIndex: (source: unknown) => string;
|
|
184
184
|
export declare const createSearchServer: (source: unknown) => SearchAPI;
|
|
@@ -1,7 +1,7 @@
|
|
|
1
|
-
import { StaticSource } from '@vezham/docs-core/source';
|
|
2
|
-
import { DocsRouteHeadOptions } from './head';
|
|
1
|
+
import type { StaticSource } from '@vezham/docs-core/source';
|
|
2
|
+
import { type DocsRouteHeadOptions } from './head';
|
|
3
3
|
import { createDocsPageRuntime } from './pages';
|
|
4
|
-
import { CreateStaticDocsRuntimeOptions, createStaticDocsRuntimeBase } from './runtime';
|
|
4
|
+
import { type CreateStaticDocsRuntimeOptions, createStaticDocsRuntimeBase } from './runtime';
|
|
5
5
|
type PageOptions = {
|
|
6
6
|
docs: {
|
|
7
7
|
getPage: (path: string) => {
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
export declare const defineStory: <C extends import(
|
|
1
|
+
export declare const defineStory: <C extends import("react").FC<any>>(options: import("@vezham/docs-story/vite/client").StoryOptions<C>) => import("@vezham/docs-story/vite/client").Story<C>;
|
|
2
2
|
//# sourceMappingURL=index.d.ts.map
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vezham/start",
|
|
3
|
-
"version": "26.0.0
|
|
3
|
+
"version": "26.0.0",
|
|
4
4
|
"repository": {
|
|
5
5
|
"type": "git",
|
|
6
6
|
"url": "git+https://github.com/vezham/vx-fe-pkgs.git",
|
|
@@ -95,9 +95,9 @@
|
|
|
95
95
|
"LICENSE"
|
|
96
96
|
],
|
|
97
97
|
"dependencies": {
|
|
98
|
-
"@vezham/devtools": "26.0.0
|
|
99
|
-
"@vezham/env": "26.0.0
|
|
100
|
-
"@vezham/template": "26.0.0
|
|
98
|
+
"@vezham/devtools": "26.0.0",
|
|
99
|
+
"@vezham/env": "26.0.0",
|
|
100
|
+
"@vezham/template": "26.0.0",
|
|
101
101
|
"yaml": "2.9.1"
|
|
102
102
|
}
|
|
103
103
|
}
|