@octanejs/docusaurus 0.0.3 → 0.0.5

package/types/index.d.ts

@@ -41,17 +41,29 @@ export interface ImportedDocusaurusModule {
 
 export type DocusaurusModule = string | ImportedDocusaurusModule;
 
+export type DocusaurusRouteModule =
+	DocusaurusModule | DocusaurusRouteModules | DocusaurusRouteModule[];
+
+export interface DocusaurusRouteModules {
+	[name: string]: DocusaurusRouteModule;
+}
+
+export interface DocusaurusPluginIdentifier {
+	name: string;
+	id: string;
+}
+
 export interface DocusaurusManifestRoute {
 	id: string;
 	path: string;
 	component: DocusaurusModule;
 	exact: boolean;
 	priority?: number;
-	modules?: Record<string, DocusaurusModule | DocusaurusModule[]>;
-	context?: unknown;
-	props?: unknown;
+	modules?: DocusaurusRouteModules;
+	context?: DocusaurusRouteModules;
+	props?: Record<string, unknown>;
 	metadata?: unknown;
-	plugin?: unknown;
+	plugin?: DocusaurusPluginIdentifier;
 	attributes?: Record<string, unknown>;
 	children: DocusaurusManifestRoute[];
 }
@@ -65,6 +77,46 @@ export interface DocusaurusManifestAliases {
 	themeInit: Record<string, string>;
 }
 
+export interface DocusaurusManifestSite {
+	title: string;
+	tagline: string;
+	url: string;
+	baseUrl: string;
+	favicon?: string;
+	noIndex: boolean;
+	trailingSlash?: boolean;
+	themeConfig: Record<string, any>;
+	customFields: Record<string, any>;
+}
+
+export interface DocusaurusLocaleConfig {
+	label: string;
+	direction: 'ltr' | 'rtl';
+	htmlLang: string;
+	calendar: string;
+	path: string;
+	translate: boolean;
+	url: string;
+	baseUrl: string;
+}
+
+export interface DocusaurusManifestI18n {
+	defaultLocale: string;
+	locales: string[];
+	currentLocale: string;
+	localeConfigs: Record<string, DocusaurusLocaleConfig>;
+}
+
+export interface DocusaurusManifestDocument {
+	htmlAttributes: {
+		lang: string;
+		dir: string;
+	};
+	headTags: string;
+	preBodyTags: string;
+	postBodyTags: string;
+}
+
 export interface DocusaurusManifest {
 	schemaVersion: 1;
 	docusaurusVersion: string;
@@ -72,6 +124,13 @@ export interface DocusaurusManifest {
 	generatedFilesDir: string;
 	outDir: string;
 	baseUrl: string;
+	site: DocusaurusManifestSite;
+	i18n: DocusaurusManifestI18n;
+	siteMetadata: Record<string, any>;
+	document: DocusaurusManifestDocument;
+	assets: {
+		clientModules: string[];
+	};
 	routesPaths: string[];
 	routes: DocusaurusManifestRoute[];
 	globalData: Record<string, unknown>;

package/types/server.d.ts

@@ -0,0 +1,80 @@
+import type { RenderOptions, RenderResult } from 'octane/static';
+import type { StaticHandler, StaticHandlerContext } from '@octanejs/remix-router';
+import type { DocusaurusManifest } from './index.js';
+import type { DocusaurusRouteModuleRegistry } from './client.js';
+
+export interface DocusaurusPrerenderOptions extends RenderOptions {
+	basename?: string;
+	requestContext?: unknown;
+}
+
+export interface DocusaurusLinkAsset {
+	href: string;
+	integrity?: string;
+	crossOrigin?: 'anonymous' | 'use-credentials';
+	referrerPolicy?: string;
+	media?: string;
+}
+
+export interface DocusaurusScriptAsset {
+	src: string;
+	type?: string;
+	async?: boolean;
+	defer?: boolean;
+	integrity?: string;
+	crossOrigin?: 'anonymous' | 'use-credentials';
+	referrerPolicy?: string;
+}
+
+export interface DocusaurusDocumentAssets {
+	stylesheets?: Array<string | DocusaurusLinkAsset>;
+	modulePreloads?: Array<string | DocusaurusLinkAsset>;
+	scripts?: Array<string | DocusaurusScriptAsset>;
+}
+
+export interface DocusaurusDocumentOptions {
+	rootId?: string;
+	nonce?: string;
+	htmlAttributes?: Record<string, string | boolean | null | undefined>;
+	bodyAttributes?: Record<string, string | boolean | null | undefined>;
+	assets?: DocusaurusDocumentAssets;
+	hydrate?: string | DocusaurusScriptAsset;
+}
+
+export interface DocusaurusDocumentPrerenderOptions extends DocusaurusPrerenderOptions {
+	document?: DocusaurusDocumentOptions;
+}
+
+export interface DocusaurusPrerenderResult extends RenderResult {
+	context: StaticHandlerContext;
+}
+
+export interface DocusaurusDocumentPrerenderResult extends DocusaurusPrerenderResult {
+	bodyHtml: string;
+}
+
+export declare function createDocusaurusStaticHandler(
+	manifest: DocusaurusManifest,
+	registry: DocusaurusRouteModuleRegistry,
+	options?: { basename?: string },
+): StaticHandler;
+
+export declare function prerenderDocusaurusRoute(
+	request: Request | string | URL,
+	manifest: DocusaurusManifest,
+	registry: DocusaurusRouteModuleRegistry,
+	options?: DocusaurusPrerenderOptions,
+): Promise<DocusaurusPrerenderResult | Response>;
+
+export declare function renderDocusaurusDocument(
+	rendered: RenderResult,
+	manifest: DocusaurusManifest,
+	options?: DocusaurusDocumentOptions,
+): string;
+
+export declare function prerenderDocusaurusDocument(
+	request: Request | string | URL,
+	manifest: DocusaurusManifest,
+	registry: DocusaurusRouteModuleRegistry,
+	options?: DocusaurusDocumentPrerenderOptions,
+): Promise<DocusaurusDocumentPrerenderResult | Response>;

package/types/theme.d.ts

@@ -0,0 +1,8 @@
+export interface OctaneDocusaurusThemePlugin {
+	name: '@octanejs/docusaurus-theme-classic';
+	getThemePath(): string;
+	getClientModules(): string[];
+}
+
+export declare function octaneClassicTheme(): OctaneDocusaurusThemePlugin;
+export default octaneClassicTheme;

package/types/virtual.d.ts

@@ -0,0 +1,10 @@
+declare module 'virtual:octane-docusaurus-manifest' {
+	const manifest: import('@octanejs/docusaurus').DocusaurusManifest;
+	export default manifest;
+}
+
+declare module 'virtual:octane-docusaurus-routes' {
+	export const manifest: import('@octanejs/docusaurus').DocusaurusManifest;
+	export const routeModules: import('@octanejs/docusaurus/client').DocusaurusRouteModuleRegistry;
+	export const routes: import('@octanejs/remix-router').RouteObject[];
+}

package/types/vite.d.ts

@@ -1,8 +1,11 @@
+/// <reference path="./virtual.d.ts" />
+
 import type { CompileMdxResult } from '@octanejs/mdx/compile';
 import type { DocusaurusManifest, LoadDocusaurusSiteOptions } from './index.js';
 import type { CompileDocusaurusMdxOptions } from './mdx.js';
 
 export declare const DOCUSAURUS_MANIFEST_ID = 'virtual:octane-docusaurus-manifest';
+export declare const DOCUSAURUS_ROUTES_ID = 'virtual:octane-docusaurus-routes';
 
 export interface DocusaurusMdxPluginOptions extends Omit<
 	CompileDocusaurusMdxOptions,
@@ -28,6 +31,15 @@ export interface DocusaurusBridgePlugin {
 		getManifest(): Promise<DocusaurusManifest>;
 		reload(): Promise<DocusaurusManifest>;
 	};
+	configureServer(server: {
+		moduleGraph: {
+			getModuleById(id: string): unknown;
+			invalidateModule(module: unknown): void;
+		};
+		ws: {
+			send(payload: { type: 'full-reload' }): void;
+		};
+	}): void;
 	configResolved(config: { root?: string; command: string }): Promise<void>;
 	buildStart(this: { addWatchFile?(id: string): void }): Promise<void>;
 	watchChange(id: string): Promise<void>;