@acmekit/docs-shared 2.13.41

package/dist/index.d.mts

@@ -0,0 +1,174 @@
+declare const DOCS_ROUTE_VIRTUAL_MODULE = "virtual:acmekit/docs-routes";
+declare const DOCS_SIDEBAR_VIRTUAL_MODULE = "virtual:acmekit/docs-sidebar";
+declare const DOCS_CONFIG_VIRTUAL_MODULE = "virtual:acmekit/docs-config";
+declare const DOCS_SEARCH_VIRTUAL_MODULE = "virtual:acmekit/docs-search";
+declare const DOCS_VIRTUAL_MODULES: readonly ["virtual:acmekit/docs-routes", "virtual:acmekit/docs-sidebar", "virtual:acmekit/docs-config", "virtual:acmekit/docs-search"];
+
+/**
+ * Frontmatter metadata extracted from MDX/MD files.
+ */
+type DocsFrontMatter = {
+    title?: string;
+    description?: string;
+    sidebar_label?: string;
+    sidebar_position?: number;
+    sidebar_autogenerate_exclude?: boolean;
+    tags?: string[];
+    toc_max_depth?: number;
+    hide_content_menu?: boolean;
+    /** Icon identifier for this documentation area (only on area index.mdx) */
+    area_icon?: string;
+    /** Sort position for this documentation area (only on area index.mdx) */
+    area_position?: number;
+};
+/**
+ * A single entry in the docs route table.
+ */
+type DocsRouteEntry = {
+    /** URL path relative to docs base (e.g. "/getting-started/installation") */
+    path: string;
+    /** Absolute filesystem path to the source file */
+    componentPath: string;
+    /** File type */
+    type: "mdx" | "md" | "tsx";
+    /** Extracted frontmatter (MDX/MD only) */
+    frontmatter?: DocsFrontMatter;
+};
+/**
+ * A sidebar tree node.
+ */
+type DocsSidebarItem = {
+    type: "link" | "category" | "separator" | "sidebar";
+    /** Display title in the sidebar */
+    title: string;
+    /** URL path (for "link" type, and optionally for clickable "category") */
+    path?: string;
+    /** Sidebar ID for drill-in navigation (for "sidebar" type) */
+    sidebar_id?: string;
+    /** Nested items (for "category" and "sidebar" types) */
+    children?: DocsSidebarItem[];
+    /** Ordering position (ascending, lower = higher) */
+    position?: number;
+    /** If true, path is used as a direct URL href (not hash fragment) */
+    isPathHref?: boolean;
+    /** If true, category starts expanded */
+    initialOpen?: boolean;
+    /** If true, children are already loaded (used by sidebar provider) */
+    loaded?: boolean;
+    /** Optional badge to display next to the item */
+    badge?: {
+        variant: "purple" | "orange" | "green" | "blue" | "red" | "neutral";
+        text: string;
+    };
+};
+/**
+ * A sidebar definition.
+ */
+type DocsSidebar = {
+    sidebar_id: string;
+    title: string;
+    items: DocsSidebarItem[];
+};
+/**
+ * A search index entry for client-side search.
+ */
+type DocsSearchEntry = {
+    /** URL path relative to docs base */
+    path: string;
+    /** Page title from frontmatter */
+    title: string;
+    /** Page description from frontmatter */
+    description: string;
+    /** Truncated plain-text body content */
+    body: string;
+};
+/**
+ * A documentation area (top-level directory in multi-area mode).
+ */
+type DocsArea = {
+    /** Slug derived from directory name (e.g. "dev", "user-guide") */
+    id: string;
+    /** Display title from the area's index.mdx frontmatter */
+    title: string;
+    /** Optional icon identifier from area_icon frontmatter */
+    icon?: string;
+    /** Sort position from area_position frontmatter */
+    position?: number;
+    /** The sidebar_id for this area's sidebar */
+    sidebar_id: string;
+};
+/**
+ * Shape of the `config.ts` file inside a `src/docs/` directory.
+ * Both project and plugin docs use this same shape.
+ */
+type DocsConfigFile = {
+    /** Display title for the documentation */
+    title?: string;
+    /** Documentation description */
+    description?: string;
+    /** Icon identifier */
+    icon?: string;
+    /** Enable multi-area documentation mode */
+    areas?: boolean;
+    /** Version info displayed in the docs sidebar */
+    version?: {
+        number: string;
+        releaseUrl?: string;
+    };
+    /** Base path where docs are served. Default: "/docs" */
+    path?: `/${string}`;
+    /** Backend URL for API calls from the docs UI */
+    backendUrl?: string;
+};
+/**
+ * Build-time descriptor for a plugin's docs source.
+ */
+type PluginDocsSource = {
+    /** Kebab-case plugin slug (e.g. "analytics") */
+    slug: string;
+    /** Absolute path to docs dir (local) or package path (package) */
+    resolve: string;
+    /** Source type */
+    type: "local" | "package";
+};
+/**
+ * Runtime plugin info for the docs UI.
+ */
+type DocsPluginInfo = {
+    /** Plugin slug */
+    slug: string;
+    /** Display title (from plugin's config.ts or formatted slug) */
+    title: string;
+    /** Plugin description */
+    description?: string;
+    /** Icon identifier */
+    icon?: string;
+    /** Sidebar ID for this plugin's sidebar */
+    sidebar_id: string;
+};
+/**
+ * Docs configuration object passed via virtual module.
+ */
+type DocsConfig = {
+    /** Documentation title */
+    title: string;
+    /** Documentation description */
+    description?: string;
+    /** Logo URL */
+    logo?: string;
+    /** Base path where docs are mounted (e.g. "/docs") */
+    basePath: string;
+    /** Version info */
+    version?: {
+        number: string;
+        releaseUrl?: string;
+    };
+    /** Generated sidebar definitions */
+    sidebars?: DocsSidebar[];
+    /** Documentation areas (only in multi-area mode) */
+    areas?: DocsArea[];
+    /** Plugin docs info (for portal cards and UI) */
+    plugins?: DocsPluginInfo[];
+};
+
+export { DOCS_CONFIG_VIRTUAL_MODULE, DOCS_ROUTE_VIRTUAL_MODULE, DOCS_SEARCH_VIRTUAL_MODULE, DOCS_SIDEBAR_VIRTUAL_MODULE, DOCS_VIRTUAL_MODULES, type DocsArea, type DocsConfig, type DocsConfigFile, type DocsFrontMatter, type DocsPluginInfo, type DocsRouteEntry, type DocsSearchEntry, type DocsSidebar, type DocsSidebarItem, type PluginDocsSource };

package/dist/index.d.ts

@@ -0,0 +1,174 @@
+declare const DOCS_ROUTE_VIRTUAL_MODULE = "virtual:acmekit/docs-routes";
+declare const DOCS_SIDEBAR_VIRTUAL_MODULE = "virtual:acmekit/docs-sidebar";
+declare const DOCS_CONFIG_VIRTUAL_MODULE = "virtual:acmekit/docs-config";
+declare const DOCS_SEARCH_VIRTUAL_MODULE = "virtual:acmekit/docs-search";
+declare const DOCS_VIRTUAL_MODULES: readonly ["virtual:acmekit/docs-routes", "virtual:acmekit/docs-sidebar", "virtual:acmekit/docs-config", "virtual:acmekit/docs-search"];
+
+/**
+ * Frontmatter metadata extracted from MDX/MD files.
+ */
+type DocsFrontMatter = {
+    title?: string;
+    description?: string;
+    sidebar_label?: string;
+    sidebar_position?: number;
+    sidebar_autogenerate_exclude?: boolean;
+    tags?: string[];
+    toc_max_depth?: number;
+    hide_content_menu?: boolean;
+    /** Icon identifier for this documentation area (only on area index.mdx) */
+    area_icon?: string;
+    /** Sort position for this documentation area (only on area index.mdx) */
+    area_position?: number;
+};
+/**
+ * A single entry in the docs route table.
+ */
+type DocsRouteEntry = {
+    /** URL path relative to docs base (e.g. "/getting-started/installation") */
+    path: string;
+    /** Absolute filesystem path to the source file */
+    componentPath: string;
+    /** File type */
+    type: "mdx" | "md" | "tsx";
+    /** Extracted frontmatter (MDX/MD only) */
+    frontmatter?: DocsFrontMatter;
+};
+/**
+ * A sidebar tree node.
+ */
+type DocsSidebarItem = {
+    type: "link" | "category" | "separator" | "sidebar";
+    /** Display title in the sidebar */
+    title: string;
+    /** URL path (for "link" type, and optionally for clickable "category") */
+    path?: string;
+    /** Sidebar ID for drill-in navigation (for "sidebar" type) */
+    sidebar_id?: string;
+    /** Nested items (for "category" and "sidebar" types) */
+    children?: DocsSidebarItem[];
+    /** Ordering position (ascending, lower = higher) */
+    position?: number;
+    /** If true, path is used as a direct URL href (not hash fragment) */
+    isPathHref?: boolean;
+    /** If true, category starts expanded */
+    initialOpen?: boolean;
+    /** If true, children are already loaded (used by sidebar provider) */
+    loaded?: boolean;
+    /** Optional badge to display next to the item */
+    badge?: {
+        variant: "purple" | "orange" | "green" | "blue" | "red" | "neutral";
+        text: string;
+    };
+};
+/**
+ * A sidebar definition.
+ */
+type DocsSidebar = {
+    sidebar_id: string;
+    title: string;
+    items: DocsSidebarItem[];
+};
+/**
+ * A search index entry for client-side search.
+ */
+type DocsSearchEntry = {
+    /** URL path relative to docs base */
+    path: string;
+    /** Page title from frontmatter */
+    title: string;
+    /** Page description from frontmatter */
+    description: string;
+    /** Truncated plain-text body content */
+    body: string;
+};
+/**
+ * A documentation area (top-level directory in multi-area mode).
+ */
+type DocsArea = {
+    /** Slug derived from directory name (e.g. "dev", "user-guide") */
+    id: string;
+    /** Display title from the area's index.mdx frontmatter */
+    title: string;
+    /** Optional icon identifier from area_icon frontmatter */
+    icon?: string;
+    /** Sort position from area_position frontmatter */
+    position?: number;
+    /** The sidebar_id for this area's sidebar */
+    sidebar_id: string;
+};
+/**
+ * Shape of the `config.ts` file inside a `src/docs/` directory.
+ * Both project and plugin docs use this same shape.
+ */
+type DocsConfigFile = {
+    /** Display title for the documentation */
+    title?: string;
+    /** Documentation description */
+    description?: string;
+    /** Icon identifier */
+    icon?: string;
+    /** Enable multi-area documentation mode */
+    areas?: boolean;
+    /** Version info displayed in the docs sidebar */
+    version?: {
+        number: string;
+        releaseUrl?: string;
+    };
+    /** Base path where docs are served. Default: "/docs" */
+    path?: `/${string}`;
+    /** Backend URL for API calls from the docs UI */
+    backendUrl?: string;
+};
+/**
+ * Build-time descriptor for a plugin's docs source.
+ */
+type PluginDocsSource = {
+    /** Kebab-case plugin slug (e.g. "analytics") */
+    slug: string;
+    /** Absolute path to docs dir (local) or package path (package) */
+    resolve: string;
+    /** Source type */
+    type: "local" | "package";
+};
+/**
+ * Runtime plugin info for the docs UI.
+ */
+type DocsPluginInfo = {
+    /** Plugin slug */
+    slug: string;
+    /** Display title (from plugin's config.ts or formatted slug) */
+    title: string;
+    /** Plugin description */
+    description?: string;
+    /** Icon identifier */
+    icon?: string;
+    /** Sidebar ID for this plugin's sidebar */
+    sidebar_id: string;
+};
+/**
+ * Docs configuration object passed via virtual module.
+ */
+type DocsConfig = {
+    /** Documentation title */
+    title: string;
+    /** Documentation description */
+    description?: string;
+    /** Logo URL */
+    logo?: string;
+    /** Base path where docs are mounted (e.g. "/docs") */
+    basePath: string;
+    /** Version info */
+    version?: {
+        number: string;
+        releaseUrl?: string;
+    };
+    /** Generated sidebar definitions */
+    sidebars?: DocsSidebar[];
+    /** Documentation areas (only in multi-area mode) */
+    areas?: DocsArea[];
+    /** Plugin docs info (for portal cards and UI) */
+    plugins?: DocsPluginInfo[];
+};
+
+export { DOCS_CONFIG_VIRTUAL_MODULE, DOCS_ROUTE_VIRTUAL_MODULE, DOCS_SEARCH_VIRTUAL_MODULE, DOCS_SIDEBAR_VIRTUAL_MODULE, DOCS_VIRTUAL_MODULES, type DocsArea, type DocsConfig, type DocsConfigFile, type DocsFrontMatter, type DocsPluginInfo, type DocsRouteEntry, type DocsSearchEntry, type DocsSidebar, type DocsSidebarItem, type PluginDocsSource };

package/dist/index.js

@@ -0,0 +1,49 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  DOCS_CONFIG_VIRTUAL_MODULE: () => DOCS_CONFIG_VIRTUAL_MODULE,
+  DOCS_ROUTE_VIRTUAL_MODULE: () => DOCS_ROUTE_VIRTUAL_MODULE,
+  DOCS_SEARCH_VIRTUAL_MODULE: () => DOCS_SEARCH_VIRTUAL_MODULE,
+  DOCS_SIDEBAR_VIRTUAL_MODULE: () => DOCS_SIDEBAR_VIRTUAL_MODULE,
+  DOCS_VIRTUAL_MODULES: () => DOCS_VIRTUAL_MODULES
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/virtual-modules/constants.ts
+var DOCS_ROUTE_VIRTUAL_MODULE = `virtual:acmekit/docs-routes`;
+var DOCS_SIDEBAR_VIRTUAL_MODULE = `virtual:acmekit/docs-sidebar`;
+var DOCS_CONFIG_VIRTUAL_MODULE = `virtual:acmekit/docs-config`;
+var DOCS_SEARCH_VIRTUAL_MODULE = `virtual:acmekit/docs-search`;
+var DOCS_VIRTUAL_MODULES = [
+  DOCS_ROUTE_VIRTUAL_MODULE,
+  DOCS_SIDEBAR_VIRTUAL_MODULE,
+  DOCS_CONFIG_VIRTUAL_MODULE,
+  DOCS_SEARCH_VIRTUAL_MODULE
+];
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  DOCS_CONFIG_VIRTUAL_MODULE,
+  DOCS_ROUTE_VIRTUAL_MODULE,
+  DOCS_SEARCH_VIRTUAL_MODULE,
+  DOCS_SIDEBAR_VIRTUAL_MODULE,
+  DOCS_VIRTUAL_MODULES
+});

package/dist/index.mjs

@@ -0,0 +1,18 @@
+// src/virtual-modules/constants.ts
+var DOCS_ROUTE_VIRTUAL_MODULE = `virtual:acmekit/docs-routes`;
+var DOCS_SIDEBAR_VIRTUAL_MODULE = `virtual:acmekit/docs-sidebar`;
+var DOCS_CONFIG_VIRTUAL_MODULE = `virtual:acmekit/docs-config`;
+var DOCS_SEARCH_VIRTUAL_MODULE = `virtual:acmekit/docs-search`;
+var DOCS_VIRTUAL_MODULES = [
+  DOCS_ROUTE_VIRTUAL_MODULE,
+  DOCS_SIDEBAR_VIRTUAL_MODULE,
+  DOCS_CONFIG_VIRTUAL_MODULE,
+  DOCS_SEARCH_VIRTUAL_MODULE
+];
+export {
+  DOCS_CONFIG_VIRTUAL_MODULE,
+  DOCS_ROUTE_VIRTUAL_MODULE,
+  DOCS_SEARCH_VIRTUAL_MODULE,
+  DOCS_SIDEBAR_VIRTUAL_MODULE,
+  DOCS_VIRTUAL_MODULES
+};

package/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "@acmekit/docs-shared",
+  "description": "Shared code for AcmeKit docs packages.",
+  "version": "2.13.41",
+  "types": "dist/index.d.ts",
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/acmekit/acmekit",
+    "directory": "packages/docs/docs-shared"
+  },
+  "files": [
+    "dist",
+    "package.json"
+  ],
+  "scripts": {
+    "build": "yarn run -T tsup"
+  },
+  "packageManager": "yarn@3.2.1"
+}