@callstack/rspress-preset 0.6.6 → 0.6.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@callstack/rspress-preset",
-  "version": "0.6.6",
+  "version": "0.6.7",
   "description": "Callstack preset for Rspress docs",
   "author": "Jakub Romańczyk <jakub.romanczyk@callstack.com>",
   "license": "MIT",
@@ -43,7 +43,7 @@
     "@vercel/analytics": "^2.0.1",
     "rsbuild-plugin-open-graph": "^1.1.2",
     "zod": "^4.3.6",
-    "@callstack/rspress-theme": "0.6.6"
+    "@callstack/rspress-theme": "0.6.7"
   },
   "peerDependencies": {
     "@rspress/core": "^2.0.8"

package/dist/index.cjs

@@ -1,236 +0,0 @@
-"use strict";
-const __rslib_import_meta_url__ = /*#__PURE__*/ function() {
-    return "u" < typeof document ? new (require('url'.replace('', ''))).URL('file:' + __filename).href : document.currentScript && document.currentScript.src || new URL('main.js', document.baseURI).href;
-}();
-var __webpack_require__ = {};
-(()=>{
-    __webpack_require__.n = (module)=>{
-        var getter = module && module.__esModule ? ()=>module['default'] : ()=>module;
-        __webpack_require__.d(getter, {
-            a: getter
-        });
-        return getter;
-    };
-})();
-(()=>{
-    __webpack_require__.d = (exports1, definition)=>{
-        for(var key in definition)if (__webpack_require__.o(definition, key) && !__webpack_require__.o(exports1, key)) Object.defineProperty(exports1, key, {
-            enumerable: true,
-            get: definition[key]
-        });
-    };
-})();
-(()=>{
-    __webpack_require__.o = (obj, prop)=>Object.prototype.hasOwnProperty.call(obj, prop);
-})();
-(()=>{
-    __webpack_require__.r = (exports1)=>{
-        if ("u" > typeof Symbol && Symbol.toStringTag) Object.defineProperty(exports1, Symbol.toStringTag, {
-            value: 'Module'
-        });
-        Object.defineProperty(exports1, '__esModule', {
-            value: true
-        });
-    };
-})();
-var __webpack_exports__ = {};
-__webpack_require__.r(__webpack_exports__);
-__webpack_require__.d(__webpack_exports__, {
-    withCallstackPreset: ()=>withCallstackPreset
-});
-const external_node_fs_namespaceObject = require("node:fs");
-var external_node_fs_default = /*#__PURE__*/ __webpack_require__.n(external_node_fs_namespaceObject);
-const external_node_path_namespaceObject = require("node:path");
-var external_node_path_default = /*#__PURE__*/ __webpack_require__.n(external_node_path_namespaceObject);
-const external_node_url_namespaceObject = require("node:url");
-var external_node_url_default = /*#__PURE__*/ __webpack_require__.n(external_node_url_namespaceObject);
-const plugin_namespaceObject = require("@callstack/rspress-theme/plugin");
-const core_namespaceObject = require("@rspress/core");
-const plugin_sitemap_namespaceObject = require("@rspress/plugin-sitemap");
-const external_rsbuild_plugin_open_graph_namespaceObject = require("rsbuild-plugin-open-graph");
-const external_node_util_namespaceObject = require("node:util");
-const external_zod_namespaceObject = require("zod");
-const nonEmptyString = external_zod_namespaceObject.z.string().trim().min(1, {
-    message: 'must be a non-empty string'
-});
-const presetOptionsSchema = external_zod_namespaceObject.z.object({
-    context: nonEmptyString.refine((value)=>external_node_path_default().isAbsolute(value), {
-        message: 'must be an absolute path'
-    }).describe('Absolute path to the project root'),
-    docs: external_zod_namespaceObject.z.object({
-        title: nonEmptyString.describe('Title of the docs'),
-        description: nonEmptyString.describe("Description of the docs"),
-        editUrl: external_zod_namespaceObject.z.string().trim().url({
-            message: 'must be a valid URL'
-        }).describe('Base URL to repository for edit links'),
-        logoLight: nonEmptyString.optional().describe('Filename from docs public directory for light mode logo (default: logo-light.png)'),
-        logoDark: nonEmptyString.optional().describe('Filename from docs public directory for dark mode logo (default: logo-dark.png)'),
-        icon: nonEmptyString.optional().describe('Filename from docs public directory for site icon (default: icon.png)'),
-        ogImage: nonEmptyString.optional().describe('Filename from docs public directory for Open Graph image (default: og.png)'),
-        rootDir: nonEmptyString.optional().describe('Root directory containing markdown docs'),
-        rootUrl: external_zod_namespaceObject.z.string().trim().url({
-            message: 'must be a valid URL'
-        }).describe('Absolute public site origin (e.g. https://example.com)'),
-        socials: external_zod_namespaceObject.z.record(external_zod_namespaceObject.z.string(), external_zod_namespaceObject.z.url()).optional().describe('Map of social icon name to profile URL')
-    }),
-    theme: external_zod_namespaceObject.z.unknown().optional(),
-    vercelAnalytics: external_zod_namespaceObject.z.union([
-        external_zod_namespaceObject.z.boolean(),
-        external_zod_namespaceObject.z.record(external_zod_namespaceObject.z.string(), external_zod_namespaceObject.z.unknown())
-    ]).optional().describe('Enable/disable Vercel Analytics or pass its config (overrides auto-detect)')
-});
-function error(...message) {
-    for (const msg of message)console.error((0, external_node_util_namespaceObject.styleText)('red', msg));
-}
-function validatePresetOptions(options) {
-    const result = presetOptionsSchema.safeParse(options);
-    if (!result.success) {
-        const bullets = result.error.issues.map((issue)=>{
-            const pathSegments = issue.path;
-            const pathLabel = pathSegments.length > 0 ? pathSegments.join('.') : 'root';
-            let current = presetOptionsSchema;
-            for (const segment of pathSegments)if (current instanceof external_zod_namespaceObject.z.ZodObject) {
-                const objectSchema = current;
-                const shape = objectSchema.shape;
-                current = shape[String(segment)];
-            } else if (current instanceof external_zod_namespaceObject.z.ZodRecord) current = current.def.valueType;
-            else break;
-            const description = current?._def?.description;
-            const received = issue.received;
-            const details = received ? `${issue.message} — received ${received}` : issue.message;
-            const withDesc = description ? `${details} (${description})` : details;
-            return `- ${pathLabel}: ${withDesc}`;
-        }).join('\n');
-        error('Invalid @callstack/rspress-preset configuration:');
-        error(bullets);
-        process.exit(1);
-    }
-    return result.data;
-}
-const CALLSTACK_BASE_URL = 'https://www.callstack.com';
-const CALLSTACK_CONTACT_URL = 'https://www.callstack.com/contact';
-const preset_filename = external_node_url_default().fileURLToPath(__rslib_import_meta_url__);
-const preset_dirname = external_node_path_default().dirname(preset_filename);
-function createSocialLinks(socials) {
-    return Object.entries(socials ?? {}).map(([key, value])=>({
-            icon: key,
-            mode: 'link',
-            content: value
-        }));
-}
-function extractXHandle(profileUrl) {
-    try {
-        const url = new URL(profileUrl);
-        const handle = url.pathname.split('/')[1];
-        return `@${handle}`;
-    } catch  {
-        throw new Error('Failed to extract X handle from X profile URL');
-    }
-}
-function addUTMParameters(url, location, siteTitle) {
-    const urlObj = new URL(url);
-    urlObj.searchParams.set('utm_campaign', 'open_source');
-    urlObj.searchParams.set('utm_source', siteTitle);
-    urlObj.searchParams.set('utm_medium', 'referral');
-    urlObj.searchParams.set('utm_content', location);
-    return urlObj.toString();
-}
-function getGlobalStyles(context) {
-    const stylesPath = external_node_path_default().join(context, 'theme/styles.css');
-    return external_node_fs_default().existsSync(stylesPath) ? stylesPath : void 0;
-}
-const createPreset = (config)=>{
-    const { context, docs, vercelAnalytics } = config;
-    const rootDir = external_node_path_default().join(context, docs.rootDir ?? 'docs');
-    const enableVercel = void 0 === vercelAnalytics ? external_node_fs_default().existsSync(external_node_path_default().join(context, 'vercel.json')) : Boolean(vercelAnalytics);
-    const vercelOptions = 'object' == typeof vercelAnalytics ? vercelAnalytics : {};
-    const defaultLinks = {
-        docFooterCTA: addUTMParameters(CALLSTACK_CONTACT_URL, 'FOOTER_CTA', docs.title),
-        homeBanner: addUTMParameters(CALLSTACK_CONTACT_URL, 'HOME_BANNER', docs.title),
-        homeFooter: CALLSTACK_BASE_URL,
-        outlineCTA: addUTMParameters(CALLSTACK_CONTACT_URL, 'OUTLINE_CTA', docs.title)
-    };
-    const theme = {
-        ...config.theme,
-        links: {
-            ...defaultLinks,
-            ...config.theme?.links
-        }
-    };
-    return (0, core_namespaceObject.defineConfig)({
-        root: rootDir,
-        title: docs.title,
-        description: docs.description,
-        icon: docs.icon,
-        llms: true,
-        globalStyles: getGlobalStyles(context),
-        globalUIComponents: enableVercel ? [
-            [
-                external_node_path_default().join(external_node_path_default().dirname(preset_dirname), 'vendor/VercelAnalytics.ts'),
-                {
-                    mode: process.env.NODE_ENV ?? 'development',
-                    ...vercelOptions
-                }
-            ]
-        ] : [],
-        logo: docs.logoLight || docs.logoDark ? {
-            light: docs.logoLight ?? docs.logoDark,
-            dark: docs.logoDark ?? docs.logoLight
-        } : void 0,
-        markdown: {
-            link: {
-                checkDeadLinks: true
-            }
-        },
-        route: {
-            cleanUrls: true
-        },
-        search: {
-            versioned: true,
-            codeBlocks: true
-        },
-        themeConfig: {
-            enableContentAnimation: true,
-            enableScrollToTop: false,
-            footer: {
-                message: `Copyright © ${new Date().getFullYear()} Callstack`
-            },
-            editLink: {
-                docRepoBaseUrl: docs.editUrl
-            },
-            socialLinks: createSocialLinks(docs.socials)
-        },
-        builderConfig: {
-            plugins: [
-                (0, external_rsbuild_plugin_open_graph_namespaceObject.pluginOpenGraph)({
-                    title: docs.title,
-                    type: 'website',
-                    url: docs.rootUrl,
-                    image: docs.rootUrl + docs.ogImage,
-                    description: docs.description,
-                    twitter: docs.socials?.X ? {
-                        site: extractXHandle(docs.socials?.X),
-                        card: 'summary_large_image'
-                    } : void 0
-                })
-            ]
-        },
-        plugins: [
-            (0, plugin_namespaceObject.pluginCallstackTheme)(theme),
-            (0, plugin_sitemap_namespaceObject.pluginSitemap)({
-                siteUrl: docs.rootUrl
-            })
-        ]
-    });
-};
-function withCallstackPreset(options, userConfig) {
-    const parsed = validatePresetOptions(options);
-    return (0, core_namespaceObject.mergeDocConfig)(createPreset(parsed), userConfig);
-}
-exports.withCallstackPreset = __webpack_exports__.withCallstackPreset;
-for(var __rspack_i in __webpack_exports__)if (-1 === [
-    "withCallstackPreset"
-].indexOf(__rspack_i)) exports[__rspack_i] = __webpack_exports__[__rspack_i];
-Object.defineProperty(exports, '__esModule', {
-    value: true
-});

package/dist/index.d.ts

@@ -1 +0,0 @@
-export { withCallstackPreset } from './preset';

package/dist/index.js

@@ -1,187 +0,0 @@
-import node_fs from "node:fs";
-import node_path from "node:path";
-import node_url from "node:url";
-import { pluginCallstackTheme } from "@callstack/rspress-theme/plugin";
-import { defineConfig, mergeDocConfig } from "@rspress/core";
-import { pluginSitemap } from "@rspress/plugin-sitemap";
-import { pluginOpenGraph } from "rsbuild-plugin-open-graph";
-import { styleText } from "node:util";
-import { z } from "zod";
-const nonEmptyString = z.string().trim().min(1, {
-    message: 'must be a non-empty string'
-});
-const presetOptionsSchema = z.object({
-    context: nonEmptyString.refine((value)=>node_path.isAbsolute(value), {
-        message: 'must be an absolute path'
-    }).describe('Absolute path to the project root'),
-    docs: z.object({
-        title: nonEmptyString.describe('Title of the docs'),
-        description: nonEmptyString.describe("Description of the docs"),
-        editUrl: z.string().trim().url({
-            message: 'must be a valid URL'
-        }).describe('Base URL to repository for edit links'),
-        logoLight: nonEmptyString.optional().describe('Filename from docs public directory for light mode logo (default: logo-light.png)'),
-        logoDark: nonEmptyString.optional().describe('Filename from docs public directory for dark mode logo (default: logo-dark.png)'),
-        icon: nonEmptyString.optional().describe('Filename from docs public directory for site icon (default: icon.png)'),
-        ogImage: nonEmptyString.optional().describe('Filename from docs public directory for Open Graph image (default: og.png)'),
-        rootDir: nonEmptyString.optional().describe('Root directory containing markdown docs'),
-        rootUrl: z.string().trim().url({
-            message: 'must be a valid URL'
-        }).describe('Absolute public site origin (e.g. https://example.com)'),
-        socials: z.record(z.string(), z.url()).optional().describe('Map of social icon name to profile URL')
-    }),
-    theme: z.unknown().optional(),
-    vercelAnalytics: z.union([
-        z.boolean(),
-        z.record(z.string(), z.unknown())
-    ]).optional().describe('Enable/disable Vercel Analytics or pass its config (overrides auto-detect)')
-});
-function error(...message) {
-    for (const msg of message)console.error(styleText('red', msg));
-}
-function validatePresetOptions(options) {
-    const result = presetOptionsSchema.safeParse(options);
-    if (!result.success) {
-        const bullets = result.error.issues.map((issue)=>{
-            const pathSegments = issue.path;
-            const pathLabel = pathSegments.length > 0 ? pathSegments.join('.') : 'root';
-            let current = presetOptionsSchema;
-            for (const segment of pathSegments)if (current instanceof z.ZodObject) {
-                const objectSchema = current;
-                const shape = objectSchema.shape;
-                current = shape[String(segment)];
-            } else if (current instanceof z.ZodRecord) current = current.def.valueType;
-            else break;
-            const description = current?._def?.description;
-            const received = issue.received;
-            const details = received ? `${issue.message} — received ${received}` : issue.message;
-            const withDesc = description ? `${details} (${description})` : details;
-            return `- ${pathLabel}: ${withDesc}`;
-        }).join('\n');
-        error('Invalid @callstack/rspress-preset configuration:');
-        error(bullets);
-        process.exit(1);
-    }
-    return result.data;
-}
-const CALLSTACK_BASE_URL = 'https://www.callstack.com';
-const CALLSTACK_CONTACT_URL = 'https://www.callstack.com/contact';
-const preset_filename = node_url.fileURLToPath(import.meta.url);
-const preset_dirname = node_path.dirname(preset_filename);
-function createSocialLinks(socials) {
-    return Object.entries(socials ?? {}).map(([key, value])=>({
-            icon: key,
-            mode: 'link',
-            content: value
-        }));
-}
-function extractXHandle(profileUrl) {
-    try {
-        const url = new URL(profileUrl);
-        const handle = url.pathname.split('/')[1];
-        return `@${handle}`;
-    } catch  {
-        throw new Error('Failed to extract X handle from X profile URL');
-    }
-}
-function addUTMParameters(url, location, siteTitle) {
-    const urlObj = new URL(url);
-    urlObj.searchParams.set('utm_campaign', 'open_source');
-    urlObj.searchParams.set('utm_source', siteTitle);
-    urlObj.searchParams.set('utm_medium', 'referral');
-    urlObj.searchParams.set('utm_content', location);
-    return urlObj.toString();
-}
-function getGlobalStyles(context) {
-    const stylesPath = node_path.join(context, 'theme/styles.css');
-    return node_fs.existsSync(stylesPath) ? stylesPath : void 0;
-}
-const createPreset = (config)=>{
-    const { context, docs, vercelAnalytics } = config;
-    const rootDir = node_path.join(context, docs.rootDir ?? 'docs');
-    const enableVercel = void 0 === vercelAnalytics ? node_fs.existsSync(node_path.join(context, 'vercel.json')) : Boolean(vercelAnalytics);
-    const vercelOptions = 'object' == typeof vercelAnalytics ? vercelAnalytics : {};
-    const defaultLinks = {
-        docFooterCTA: addUTMParameters(CALLSTACK_CONTACT_URL, 'FOOTER_CTA', docs.title),
-        homeBanner: addUTMParameters(CALLSTACK_CONTACT_URL, 'HOME_BANNER', docs.title),
-        homeFooter: CALLSTACK_BASE_URL,
-        outlineCTA: addUTMParameters(CALLSTACK_CONTACT_URL, 'OUTLINE_CTA', docs.title)
-    };
-    const theme = {
-        ...config.theme,
-        links: {
-            ...defaultLinks,
-            ...config.theme?.links
-        }
-    };
-    return defineConfig({
-        root: rootDir,
-        title: docs.title,
-        description: docs.description,
-        icon: docs.icon,
-        llms: true,
-        globalStyles: getGlobalStyles(context),
-        globalUIComponents: enableVercel ? [
-            [
-                node_path.join(node_path.dirname(preset_dirname), 'vendor/VercelAnalytics.ts'),
-                {
-                    mode: process.env.NODE_ENV ?? 'development',
-                    ...vercelOptions
-                }
-            ]
-        ] : [],
-        logo: docs.logoLight || docs.logoDark ? {
-            light: docs.logoLight ?? docs.logoDark,
-            dark: docs.logoDark ?? docs.logoLight
-        } : void 0,
-        markdown: {
-            link: {
-                checkDeadLinks: true
-            }
-        },
-        route: {
-            cleanUrls: true
-        },
-        search: {
-            versioned: true,
-            codeBlocks: true
-        },
-        themeConfig: {
-            enableContentAnimation: true,
-            enableScrollToTop: false,
-            footer: {
-                message: `Copyright © ${new Date().getFullYear()} Callstack`
-            },
-            editLink: {
-                docRepoBaseUrl: docs.editUrl
-            },
-            socialLinks: createSocialLinks(docs.socials)
-        },
-        builderConfig: {
-            plugins: [
-                pluginOpenGraph({
-                    title: docs.title,
-                    type: 'website',
-                    url: docs.rootUrl,
-                    image: docs.rootUrl + docs.ogImage,
-                    description: docs.description,
-                    twitter: docs.socials?.X ? {
-                        site: extractXHandle(docs.socials?.X),
-                        card: 'summary_large_image'
-                    } : void 0
-                })
-            ]
-        },
-        plugins: [
-            pluginCallstackTheme(theme),
-            pluginSitemap({
-                siteUrl: docs.rootUrl
-            })
-        ]
-    });
-};
-function withCallstackPreset(options, userConfig) {
-    const parsed = validatePresetOptions(options);
-    return mergeDocConfig(createPreset(parsed), userConfig);
-}
-export { withCallstackPreset };

package/dist/options.d.ts

@@ -1,28 +0,0 @@
-import type { pluginCallstackTheme } from '@callstack/rspress-theme/plugin';
-import type { AnalyticsProps } from '@vercel/analytics';
-import { z } from 'zod';
-export declare const presetOptionsSchema: z.ZodObject<{
-    context: z.ZodString;
-    docs: z.ZodObject<{
-        title: z.ZodString;
-        description: z.ZodString;
-        editUrl: z.ZodString;
-        logoLight: z.ZodOptional<z.ZodString>;
-        logoDark: z.ZodOptional<z.ZodString>;
-        icon: z.ZodOptional<z.ZodString>;
-        ogImage: z.ZodOptional<z.ZodString>;
-        rootDir: z.ZodOptional<z.ZodString>;
-        rootUrl: z.ZodString;
-        socials: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodURL>>;
-    }, z.core.$strip>;
-    theme: z.ZodOptional<z.ZodUnknown>;
-    vercelAnalytics: z.ZodOptional<z.ZodUnion<readonly [z.ZodBoolean, z.ZodRecord<z.ZodString, z.ZodUnknown>]>>;
-}, z.core.$strip>;
-type ThemeConfig = Parameters<typeof pluginCallstackTheme>[0];
-type PresetSchema = z.infer<typeof presetOptionsSchema>;
-export type PresetConfig = Omit<PresetSchema, 'theme' | 'vercelAnalytics'> & {
-    theme?: ThemeConfig;
-    vercelAnalytics?: boolean | AnalyticsProps;
-};
-export declare function validatePresetOptions(options: unknown): PresetConfig;
-export {};

package/dist/preset.d.ts

@@ -1,3 +0,0 @@
-import type { UserConfig } from '@rspress/core';
-import { type PresetConfig } from './options';
-export declare function withCallstackPreset(options: PresetConfig, userConfig: UserConfig): Promise<UserConfig>;