@lexibase/rdx-types 2.0.0 → 2.1.0

package/dist/content.d.ts

@@ -29,4 +29,7 @@ export type RdxDocument = {
 
 export type RdxDocsOptions = {
   docsDir?: string
+  /** Internal overlay: missing translated pages use this primary tree. */
+  fallbackDocsDir?: string
+  fallbackOnly?: boolean
 }

package/dist/index.d.ts

@@ -8,6 +8,13 @@ export {
   ResolvedRdxConfig,
 } from './config'
 export {
+  RdxLocaleDefinition,
+  RdxLocale,
+  RdxLocalizationOptions,
+  RdxLocalization,
+  RdxSourceLocalization,
+  RdxSnapshotContext,
+  RdxSnapshotContribution,
   RdxContentSource,
   RdxPlugin,
   RdxPluginCommand,

package/dist/plugins.d.ts

@@ -1,5 +1,39 @@
 import type { ResolvedRdxConfig } from './config'
 
+/** A content language; folder aliases are separate from language tags. */
+export type RdxLocaleDefinition = {
+  code: string
+  label: string
+  folder?: string
+}
+export type RdxLocalizationOptions = {
+  locales: RdxLocaleDefinition[]
+  /** Absolute HTTP(S) URL for community translations, e.g. the repository's locale/ directory. */
+  contributionUrl?: string
+}
+export type RdxLocale = RdxLocaleDefinition & { path: string }
+export type RdxLocalization = {
+  defaultLocale: string
+  locales: RdxLocale[]
+  /** Current contribution destination, shared across languages and editions. */
+  contributionUrl?: string
+}
+/** Language inventory frozen for one content source/edition. */
+export type RdxSourceLocalization = RdxLocalization & {
+  docs: Record<string, string>
+}
+
+export type RdxSnapshotContext = RdxPluginContext & {
+  version: string
+  /** New primary snapshot directory, relative to the project. */
+  snapshotDir: string
+}
+/** Hooks declare files/trees; the snapshot owner copies them in one transaction. */
+export type RdxSnapshotContribution = {
+  directories?: { sourceDir: string; snapshotDir: string }[]
+  files?: { filename: string; content: string }[]
+}
+
 /** A separate documentation tree exposed below /docs/<routePrefix>. */
 export type RdxContentSource = {
   id: string
@@ -9,6 +43,16 @@ export type RdxContentSource = {
   badge?: string
   /** Canonical route prefix to redirect this historical source to. */
   redirectTo?: string
+  /** Canonical snapshot label, including when this source is a redirect alias. */
+  version?: string
+  /** Retained identity metadata for a replaced snapshot; its content is not served. */
+  previousSnapshot?: { version: string; docsDir: string }
+  /** Internal localized view; the original source/edition identity is unchanged. */
+  basePath?: string
+  fallbackDocsDir?: string
+  fallbackOnly?: boolean
+  /** Internal source-language inventory; snapshot values are immutable. */
+  localization?: RdxSourceLocalization
 }
 
 export type RdxPluginContext = {
@@ -27,13 +71,21 @@ export type RdxPluginCommand = {
 export type RdxPlugin = {
   name: string
   apiVersion: 1
-  setup?: (
-    context: RdxPluginContext
-  ) =>
-    | { sources?: RdxContentSource[]; runtimeFiles?: string[] }
+  setup?: (context: RdxPluginContext) =>
+    | {
+        sources?: RdxContentSource[]
+        runtimeFiles?: string[]
+        localization?: RdxLocalizationOptions
+      }
     | void
-    | Promise<{ sources?: RdxContentSource[]; runtimeFiles?: string[] } | void>
+    | Promise<{
+        sources?: RdxContentSource[]
+        runtimeFiles?: string[]
+        localization?: RdxLocalizationOptions
+      } | void>
   commands?: RdxPluginCommand[]
+  /** Synchronous, declaration-only hook. It must not write or reserve paths. */
+  snapshot?: (context: RdxSnapshotContext) => RdxSnapshotContribution | void
 }
 
 export type RdxProject = {
@@ -43,4 +95,7 @@ export type RdxProject = {
   commands: RdxPluginCommand[]
   /** Project-relative files plugins need when serving deployed documentation. */
   runtimeFiles: string[]
+  localization?: RdxLocalization
+  /** Selected locale on a request-scoped view, never a global mutable setting. */
+  locale?: RdxLocale
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lexibase/rdx-types",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "license": "MIT",
   "description": "Shared TypeScript types for RDX documentation projects.",
   "types": "./dist/index.d.ts",