@xyd-js/core 0.0.0-build-56377ca-20251013180714 → 0.0.0-build-1f6458c-20251015205119

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # @xyd-js/core
 
-## 0.0.0-build-56377ca-20251013180714
+## 0.0.0-build-1f6458c-20251015205119
 
 ### Patch Changes
 

package/dist/index.d.ts

@@ -12,7 +12,7 @@ interface Metadata<P = void> {
     title: string;
     /** Title to display in the sidebar navigation */
     sidebarTitle?: string;
-    /** Disply description for SEO purposes */
+    /** Display description for SEO/llms.txt purposes */
     description?: string;
     /**  Icon identifier for the navigation item */
     icon?: string;
@@ -498,6 +498,10 @@ interface Settings {
      * SEO configuration
      */
     seo?: SEO;
+    /**
+     * AI configuration
+     */
+    ai?: AI;
     /**
      * Advanced configuration
      */
@@ -1250,7 +1254,7 @@ interface IntegrationAnalytics {
 }
 /**
  * LiveSession analytics configuration
-*/
+ */
 interface IntegrationAnalyticsLiveSession {
     /** LiveSession's TrackID */
     trackId: string;
@@ -1460,6 +1464,84 @@ interface SEO {
         [tag: string]: string;
     };
 }
+/**
+ * AI configuration
+ */
+interface AI {
+    /**
+     * LLMs txt configuration
+     *
+     *
+     * @example
+     * ```json
+     * {
+     *   "title": "LLMs txt",
+     *   "domain": "https://www.example.com",
+     *   "summary": "Summary of the LLMs txt",
+     *   "sections": { "section1": { "title": "Section 1", "url": "https://www.example.com", "description": "Description of section 1" } }
+     * }
+     * ```
+     *
+     * or
+     * @example
+     * ```json
+     * "llmsTxt": "llms.txt"
+     * ```
+     *
+     * or
+     * @example
+     * ```json
+     * "llmsTxt": "# LLMs txt \n ## Section 1 \n ## Section 2 \n ### Section 2"
+     * ```
+     *
+     */
+    llmsTxt?: false | LLMsTxt | llmsTxtString;
+}
+/**
+ * LLMs txt as a path to a file or a llms.txt content
+ */
+type llmsTxtString = string;
+/**
+ * LLMs txt configuration
+ */
+interface LLMsTxt {
+    /**
+     * Title of the LLMs txt
+     * @example "LLMs txt"
+     */
+    title: string;
+    /**
+     * Base URL of the LLMs txt
+     */
+    baseUrl: string;
+    /**
+     * Description of the LLMs txt
+     */
+    summary?: string;
+    /**
+     * Sections of the LLMs txt
+     */
+    sections?: LLMsTxtSectionMap;
+}
+type LLMsTxtSectionMap = {
+    [section: string]: {
+        /**
+         * Title of the section
+         * @example "Section 1"
+         */
+        title: string;
+        /**
+         * URL of the section
+         * @example "https://www.example.com"
+         */
+        url: string;
+        /**
+         * Description of the section
+         * @example "Description of section 1"
+         */
+        description: string;
+    };
+};
 /**
  * Advanced configuration
  */
@@ -1587,4 +1669,4 @@ interface UserPreferences {
     themeColors?: ThemeColors;
 }
 
-export type { API, APIAuth, APIFile, APIFileAdvanced, APIFileMap, APIInfo, APIInfoRequest, Advanced, AnchorHeader, Anchors, Appearance, AppearanceBanner, AppearanceButtons, AppearanceContent, AppearanceFooter, AppearanceHeader, AppearanceLogo, AppearanceSearch, AppearanceSidebar, AppearanceTables, AppearanceTabs, AppsDirectory, Coder, Colors, ComponentLike, Components, EditLink, Engine, EnginePaths, EngineUniform, Font, HeadConfig, IconLibrary, Icons, IntegrationABTesting, IntegrationABTestingGrowthBook, IntegrationABTestingLaunchDarkly, IntegrationABTestingProviders, IntegrationAnalytics, IntegrationAnalyticsLiveSession, IntegrationAppGithubStar, IntegrationAppSupademo, IntegrationSearch, IntegrationSupport, IntegrationSupportChatwoot, IntegrationSupportIntercom, IntegrationSupportLivechat, Integrations, JSONComponent, Logo, MetaTags, Metadata, MetadataMap, Navigation, NavigationItem, NavigationItemButton, NavigationItemSocial, PageLayout, PageMetaUniform, PageMetaUniformDetails, PageURL, PluginConfig, Plugins, Redirects, SEO, Script, SearchType, Segment, Settings, Sidebar, SidebarDropdown, SidebarNavigation, SidebarRoute, Social, Tabs, Theme, ThemeColors, ThemeFont, ThemePresetName, TocCard, UserPreferences, VirtualPage, WebEditor, WebEditorBanner, WebEditorFooter, WebEditorFooterLink, WebEditorFooterLinkItem, WebEditorFooterLinks, WebEditorHeader, WebEditorNavigationItem, WebEditorSubHeader, Writer };
+export type { AI, API, APIAuth, APIFile, APIFileAdvanced, APIFileMap, APIInfo, APIInfoRequest, Advanced, AnchorHeader, Anchors, Appearance, AppearanceBanner, AppearanceButtons, AppearanceContent, AppearanceFooter, AppearanceHeader, AppearanceLogo, AppearanceSearch, AppearanceSidebar, AppearanceTables, AppearanceTabs, AppsDirectory, Coder, Colors, ComponentLike, Components, EditLink, Engine, EnginePaths, EngineUniform, Font, HeadConfig, IconLibrary, Icons, IntegrationABTesting, IntegrationABTestingGrowthBook, IntegrationABTestingLaunchDarkly, IntegrationABTestingProviders, IntegrationAnalytics, IntegrationAnalyticsLiveSession, IntegrationAppGithubStar, IntegrationAppSupademo, IntegrationSearch, IntegrationSupport, IntegrationSupportChatwoot, IntegrationSupportIntercom, IntegrationSupportLivechat, Integrations, JSONComponent, LLMsTxt, LLMsTxtSectionMap, Logo, MetaTags, Metadata, MetadataMap, Navigation, NavigationItem, NavigationItemButton, NavigationItemSocial, PageLayout, PageMetaUniform, PageMetaUniformDetails, PageURL, PluginConfig, Plugins, Redirects, SEO, Script, SearchType, Segment, Settings, Sidebar, SidebarDropdown, SidebarNavigation, SidebarRoute, Social, Tabs, Theme, ThemeColors, ThemeFont, ThemePresetName, TocCard, UserPreferences, VirtualPage, WebEditor, WebEditorBanner, WebEditorFooter, WebEditorFooterLink, WebEditorFooterLinkItem, WebEditorFooterLinks, WebEditorHeader, WebEditorNavigationItem, WebEditorSubHeader, Writer, llmsTxtString };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyd-js/core",
-  "version": "0.0.0-build-56377ca-20251013180714",
+  "version": "0.0.0-build-1f6458c-20251015205119",
   "description": "",
   "type": "module",
   "main": "dist/index.js",

package/src/types/metadata.ts

@@ -14,7 +14,7 @@ export interface Metadata<P = void> {
     /** Title to display in the sidebar navigation */
     sidebarTitle?: string
 
-    /** Disply description for SEO purposes */
+    /** Display description for SEO/llms.txt purposes */
     description?: string
 
     /**  Icon identifier for the navigation item */