@xyd-js/plugins 0.1.0-xyd.2

package/CHANGELOG.md

@@ -0,0 +1,19 @@
+# @xyd-js/plugins
+
+## 0.1.0-xyd.2
+
+### Patch Changes
+
+- test
+- Updated dependencies
+  - @xyd-js/framework@0.1.0-xyd.34
+  - @xyd-js/uniform@0.1.0-xyd.17
+
+## 0.1.0-xyd.1
+
+### Patch Changes
+
+- update packages
+- Updated dependencies
+  - @xyd-js/framework@0.1.0-xyd.33
+  - @xyd-js/uniform@0.1.0-xyd.16

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 xyd
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE. 

package/dist/index.d.ts

@@ -0,0 +1,616 @@
+import { Plugin as Plugin$1 } from 'vite';
+import * as React from 'react';
+import React__default from 'react';
+import { UniformPlugin } from '@xyd-js/uniform';
+import { SurfaceTarget } from '@xyd-js/framework/react';
+
+type RawTheme = {
+    name?: string;
+    type?: string;
+    tokenColors?: ThemeSetting[];
+    colors?: {
+        [key: string]: string;
+    };
+    [key: string]: any;
+};
+type ThemeSetting = {
+    name?: string;
+    scope?: string | string[];
+    settings: {
+        fontStyle?: string;
+        foreground?: string;
+        background?: string;
+    };
+};
+declare const THEME_NAMES: readonly ["dark-plus", "dracula-soft", "dracula", "github-dark", "github-dark-dimmed", "github-from-css", "github-light", "light-plus", "material-darker", "material-default", "material-from-css", "material-lighter", "material-ocean", "material-palenight", "min-dark", "min-light", "monokai", "nord", "one-dark-pro", "poimandres", "slack-dark", "slack-ochin", "solarized-dark", "solarized-light"];
+type NamesTuple$1 = typeof THEME_NAMES;
+type StringTheme = NamesTuple$1[number];
+type Theme$1 = StringTheme | RawTheme;
+
+/**
+ * Main settings interface for the application
+ */
+interface Settings {
+    /** Theme configuration for the application */
+    theme?: Theme;
+    /** Navigation configuration */
+    navigation?: Navigation;
+    /** API configuration */
+    api?: API;
+    /** Integrations configuration */
+    integrations?: Integrations;
+    /** Plugins configuration */
+    plugins?: Plugins;
+    /**
+     * @internal
+     * @unsafe
+     *
+     * Redirects configuration
+     */
+    redirects?: Redirects[];
+    /**
+     * @unsafe
+     * SEO configuration
+     */
+    seo?: SEO;
+    /** Engine configuration */
+    engine?: Engine;
+}
+/**
+ * Theme configuration that changes the look and feel of the project
+ */
+interface Theme {
+    /**
+     * A preset theme configuration that changes the look and feel of the project.
+     * A theme is a set of default styling configurations.
+     *
+     * Example built-in themes: `cosmo`, `gusto`, `poetry`, `picasso`
+     */
+    readonly name: ThemePresetName | (string & {});
+    /**
+     * The default color scheme to use.
+     */
+    defaultColorScheme?: "light" | "dark" | "os";
+    /**
+     * Path to logo image or object with path to "light" and "dark" mode logo images, and where the logo links to.
+     * SVG format is recommended as it does not pixelate and the file size is generally smaller.
+     */
+    logo?: string | Logo | React.JSX.Element;
+    /**
+     * Coder configuration for the theme, including options like syntax highlighting.
+     */
+    coder?: Coder;
+    /**
+     * Banner configuration for the theme.
+     */
+    banner?: Banner;
+    /** Path to the favicon image. For example: /path/to/favicon.svg */
+    favicon?: string;
+    /** The defult level of the table of contents. */
+    maxTocDepth?: number;
+    /** Head configuration */
+    head?: HeadConfig[];
+    /** The iconify library */
+    icons?: Icons;
+    /**
+     * Custom scripts to be added to the head of the every page.
+     * Paths are relative to the root of the project or absolute.
+     */
+    scripts?: Script[];
+}
+/**
+ * Coder configuration for the theme, including options like syntax highlighting.
+ */
+interface Coder {
+    /**
+     * If `true` then code blocks will have line numbers.
+     */
+    lines?: boolean;
+    /**
+     * If `true` then code blocks will have a scrollbar.
+     */
+    scroll?: boolean;
+    /**
+     * Syntax highlighting configuration.
+     */
+    syntaxHighlight?: Theme$1;
+}
+/**
+ * Configuration type for head elements that can be added to the HTML head.
+ * Format: [tagName, attributes]
+ *
+ * @example: ['script', { src: 'https://example.com/script.js', defer: true }]
+ */
+type HeadConfig = [string, Record<string, string | boolean>];
+type Script = string;
+/**
+ * Logo configuration interface
+ */
+interface Logo {
+    /** Path to the logo in light mode. For example: `/path/to/logo.svg` */
+    light?: string;
+    /** Path to the logo in dark mode. For example: `/path/to/logo.svg` */
+    dark?: string;
+    /** Where clicking on the logo links you to */
+    href?: string;
+}
+/**
+ * Banner configuration interface
+ */
+interface Banner {
+    /**
+     * Banner content.
+     */
+    content: string | React.JSX.Element;
+    /**
+     * Banner label.
+     */
+    label?: string;
+    /**
+     * Banner kind.
+     */
+    kind?: "secondary";
+    /**
+     * Banner icon.
+     */
+    icon?: string;
+}
+interface IconLibrary {
+    /** The iconify library name */
+    name: string;
+    /** The iconify library version */
+    version?: string;
+    /** The default iconify icon name */
+    default?: boolean;
+    /** Merge icons from the library into the default iconify library */
+    noprefix?: boolean;
+}
+interface Icons {
+    /** The iconify library */
+    library?: string | string[] | IconLibrary | IconLibrary[];
+}
+/** Available theme preset names */
+type ThemePresetName = "poetry" | "cosmo" | "opener" | "picasso";
+/**
+ * Navigation configuration interface
+ */
+interface Navigation {
+    /** Definition of sidebar - an array of groups with all the pages within that group */
+    sidebar: (SidebarRoute | Sidebar | string)[];
+    /** Array of headers */
+    header?: Header[];
+    /** Array of segments */
+    segments?: Segment[];
+    /**
+     * Array of version names. Only use this if you want to show different versions of docs
+     * with a dropdown in the navigation bar.
+     */
+    /** Anchors, includes the icon, name, and url */
+    anchors?: AnchorRoot;
+}
+/**
+ * Sidebar multi-group configuration
+ */
+interface SidebarRoute {
+    /** Route for this sidebar group */
+    route: string;
+    /** Sidebar pages within this group */
+    pages: Sidebar[];
+}
+/**
+ * Sidebar configuration
+ */
+interface Sidebar {
+    /** The name of the group */
+    group?: string;
+    /**
+     * The relative paths to the markdown files that will serve as pages.
+     * Note: groups are recursive, so to add a sub-folder add another group object in the page array.
+     */
+    pages?: PageURL[];
+    /**
+     * The icon of the group.
+     */
+    icon?: string;
+    /**
+     * The sort order of the group.
+     */
+    sort?: number;
+}
+/**
+ * Page URL type
+ */
+type PageURL = string | VirtualPage | Sidebar;
+/**
+ * @internal
+ *
+ * Virtual page type
+ *
+ * Virtual pages are composition of pages, needed for templating e.g in uniform
+ *
+ * Example:
+ *
+ * {
+ *  pages: [0
+ *    ".xyd/.cache/.content/docs/rest/todo:docs/rest/todo",
+ *  ]
+ * }
+ *
+ * above will be rendered as docs/rest/todo.md using composition from xyd's `.content`
+ */
+type VirtualPage = string | {
+    /** The virtual page to use for the page */
+    virtual: string;
+    /** The page to use for the page */
+    page: string;
+    /** The template to use for the page */
+    templates?: string | string[];
+};
+/**
+ * Segment configuration
+ */
+interface Segment {
+    /** Route for this segment */
+    route: string;
+    /** Title of this segment */
+    title: string;
+    /** Items within this segment */
+    pages: SegmentPage[];
+}
+interface SegmentPage {
+    page: string;
+    title: string;
+}
+/**
+ * Header configuration
+ */
+type Header = {
+    /** The name of the button */
+    title?: string;
+    /** The url once you click on the button */
+    page?: string;
+    /** Float the header to the right */
+    float?: "right";
+};
+/**
+ * Anchor configuration
+ */
+interface Anchor {
+    /** The iconify icon name */
+    icon?: string;
+    /** The name of the anchor label */
+    name?: string;
+    /**
+     * The start of the URL that marks what pages go in the anchor.
+     * Generally, this is the name of the folder you put your pages in.
+     */
+    url?: string;
+}
+/**
+ * Anchor root configuration
+ */
+interface AnchorRoot {
+    /** Bottom anchors */
+    bottom?: Anchor[];
+}
+/**
+ * API configuration interface
+ */
+interface API {
+    /**
+     * OpenAPI configuration
+     */
+    openapi?: APIFile;
+    /**
+     * GraphQL configuration
+     */
+    graphql?: APIFile;
+    /**
+     * Sources configuration
+     */
+    sources?: APIFile;
+}
+/**
+ * API file configuration. Can be a path, an array of paths, a map of paths, or an advanced configuration
+ */
+type APIFile = string | string[] | APIFileMap | APIFileAdvanced;
+/**
+ * API file map type
+ */
+type APIFileMap = {
+    [name: string]: string | APIFileAdvanced;
+};
+/**
+ * API file advanced type
+ */
+type APIFileAdvanced = {
+    /** API information configuration */
+    info?: APIInfo;
+    /** Route configuration */
+    route: string;
+};
+/**
+ * API file type - can be a string, array of strings, or a map of strings
+ */
+/**
+ * API information configuration
+ */
+interface APIInfo {
+    /**
+     * The base url for all API endpoints. If baseUrl is an array, it will enable
+     * for multiple base url options that the user can toggle.
+     */
+    baseUrl?: string;
+    /** Authentication information */
+    auth?: APIAuth;
+    /**
+     * The name of the authentication parameter used in the API playground.
+     * If method is basic, the format should be [usernameName]:[passwordName]
+     */
+    name?: string;
+    /**
+     * The default value that's designed to be a prefisx for the authentication input field.
+     * E.g. If an inputPrefix of AuthKey would inherit the default input result of the authentication field as AuthKey.
+     */
+    inputPrefix?: string;
+    /** Configurations for the API playground */
+    playground?: APIPlayground;
+    /** Request configuration */
+    request?: APIInfoRequest;
+}
+/**
+ * API authentication configuration
+ */
+interface APIAuth {
+    /** The authentication strategy used for all API endpoints */
+    method: "bearer" | "basic" | "key";
+}
+/**
+ * API playground configuration
+ */
+interface APIPlayground {
+    /** Playground display mode */
+    mode?: "show" | "simple" | "hide";
+}
+/**
+ * API request configuration
+ */
+interface APIInfoRequest {
+    /** Configurations for the auto-generated API request examples */
+    example?: {
+        /**
+         * An array of strings that determine the order of the languages of the auto-generated request examples.
+         * You can either define custom languages utilizing x-codeSamples or use our default languages which include
+         * bash, python, javascript, php, go, java
+         */
+        languages?: string[];
+    };
+}
+/**
+ * Integrations configuration
+ */
+interface Integrations {
+    /**
+     * Configurations to add third-party analytics integrations.
+     * See full list of supported analytics here.
+     */
+    analytics?: IntegrationAnalytics;
+    /**
+     * Configurations to add third-party search integrations.
+     * See full list of supported search here.
+     */
+    search?: IntegrationSearch;
+    apps?: IntegrationApps;
+}
+/**
+ * Analytics configuration
+ */
+interface IntegrationAnalytics {
+    /** Livesession analytics configuration */
+    livesession?: {
+        /** Livesession's TrackID */
+        trackId: string;
+    };
+}
+/**
+ * Search configuration
+ */
+interface IntegrationSearch {
+    /** Algolia search configuration */
+    algolia?: {
+        /** Algolia application ID */
+        appId: string;
+        /** Algolia API key */
+        apiKey: string;
+    };
+    orama?: {
+        /** Orama endpoint */
+        endpoint: string;
+        /** Orama API key */
+        apiKey: string;
+        /** Orama suggestions */
+        suggestions?: string[];
+    } | boolean;
+}
+interface IntegrationApps {
+    /**
+     * Github star app configuration.
+     * List of all [options](https://github.com/buttons/react-github-btn).
+     */
+    githubStar?: IntegrationAppGithubStar;
+}
+interface IntegrationAppGithubStar {
+    /**
+     * The title of the Github button
+     */
+    title: string;
+    /**
+     * The label of the Github Button
+     */
+    label?: string;
+    /**
+     * The href of the Github project
+     */
+    href: string;
+    /**
+     * The data-show-count of the Github project
+     */
+    dataShowCount?: boolean;
+    /**
+     * The data-icon of the Github button
+     */
+    dataIcon?: string;
+    /**
+     * The data-size of the Github button
+     */
+    dataSize?: string;
+    /**
+     * The aria-label of the Github button
+     */
+    ariaLabel?: string;
+}
+/**
+ * Plugin configuration
+ *
+ * @example
+ * 1)
+ * {
+ *  plugins: [
+ *    "livesession",
+ *  ]
+ * }
+ *
+ * or 2)
+ * {
+ *  plugins: [
+ *    [
+ *      "livesession",
+ *      "accountID.websiteID",
+ *      {
+ *          keystrokes: true
+ *      }
+ *    ]
+ *  ]
+ * }
+ *
+ * @example [audience:dev]
+ * You can also use the type to define the plugin config in your code:
+ *
+ * const livesessionPlugin: PluginConfig<"livesession", [string, { keystrokes: boolean }]> = [
+ *    "livesession",
+ *    "accountID.websiteID",
+ *    {
+ *        keystrokes: true
+ *    }
+ * ]
+ */
+type Plugins = (string | PluginConfig$1)[];
+type PluginConfig$1<PluginName extends string = string, PluginArgs extends unknown[] = unknown[]> = [PluginName, ...PluginArgs];
+/**
+ * Redirects configuration
+ */
+interface Redirects {
+    /** Source path to redirect from */
+    source: string;
+    /** Destination path to redirect to */
+    destination: string;
+}
+/**
+ * SEO configuration
+ */
+interface SEO {
+    /**
+     * Domain name
+     */
+    domain?: string;
+    /**
+     * Meta tags
+     */
+    metatags?: {
+        [tag: string]: string;
+    };
+}
+/**
+ * Config configuration
+ */
+interface Engine {
+    /**
+     * Path aliases for imports. Avoid long relative paths by creating shortcuts.
+     *
+     * @example
+     * ```json
+     * {
+     *   "paths": {
+     *     "@my-package/*": ["../my-package/src/*"],
+     *     "@livesession-go/*": ["https://github.com/livesession/livesession-go/*"]
+     *   }
+     * }
+     * ```
+     *
+     * Usage:
+     * ```typescript
+     * // Instead of
+     * @importCode("../../../my-package/src/components/Badge.tsx")
+     *
+     * // Use
+     * @importCode("@my-package/src/components/Badge.tsx")
+     * ```
+     */
+    paths?: EnginePaths;
+    /**
+     * @unsafe
+     *
+     * Uniform configuration
+     *
+     */
+    uniform?: EngineUniform;
+}
+type EnginePaths = {
+    [key: string]: string[];
+};
+type EngineUniform = {
+    /**
+     * If `true` then virtual pages will not created and generated content will be stored on disk
+     */
+    store?: boolean;
+};
+
+interface PluginCustomComponents {
+    component: React__default.ComponentType<any>;
+    surface: SurfaceTarget;
+}
+/**
+ * Plugin interface
+ *
+ * @example
+ * ```ts
+ * function myPlugin(): Plugin {
+ *     return {
+ *         name: "my-plugin",
+ *         vite: [
+ *             {
+ *                 name: "my-vite-plugin",
+ *             }
+ *         ],
+ *         uniform: [
+ *             pluginOpenAIMeta,
+ *         ],
+ *         atlas: {
+ *             components: {
+ *             }
+ *         }
+ *     }
+ * }
+ * ```
+ */
+interface PluginConfig {
+    name: string;
+    vite?: Plugin$1[];
+    uniform?: UniformPlugin<any>[];
+    customComponents?: {
+        [name: string]: PluginCustomComponents;
+    };
+}
+type Plugin = (settings: Settings) => PluginConfig;
+
+export type { Plugin, PluginConfig, PluginCustomComponents };

package/dist/index.js

@@ -0,0 +1 @@
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@xyd-js/plugins",
+  "version": "0.1.0-xyd.2",
+  "description": "",
+  "main": "./dist/index.js",
+  "type": "module",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "import": "./dist/index.js"
+    }
+  },
+  "dependencies": {
+    "@xyd-js/uniform": "0.1.0-xyd.17"
+  },
+  "peerDependencies": {
+    "@xyd-js/framework": "0.1.0-xyd.34"
+  },
+  "devDependencies": {
+    "@vitest/coverage-v8": "^1.3.1",
+    "vite": "^6.1.0",
+    "vitest": "^1.3.1",
+    "rimraf": "^3.0.2",
+    "tsup": "^8.3.0"
+  },
+  "scripts": {
+    "clean": "rimraf build",
+    "prebuild": "pnpm clean",
+    "build": "tsup",
+    "test": "vitest",
+    "test:coverage": "vitest run --coverage"
+  }
+}

package/src/index.ts

@@ -0,0 +1,52 @@
+import type { Plugin as Vite } from "vite"
+import React from "react"
+
+import { type UniformPlugin as Uniform } from "@xyd-js/uniform"
+import { Settings } from "@xyd-js/core"
+import type { SurfaceTarget } from "@xyd-js/framework/react"
+
+// TODO: share with theme-api ?
+export interface PluginCustomComponents {
+    component: React.ComponentType<any>
+    surface: SurfaceTarget
+}
+
+/**
+ * Plugin interface
+ * 
+ * @example
+ * ```ts
+ * function myPlugin(): Plugin {
+ *     return {
+ *         name: "my-plugin",
+ *         vite: [
+ *             {
+ *                 name: "my-vite-plugin",
+ *             }
+ *         ],
+ *         uniform: [
+ *             pluginOpenAIMeta,
+ *         ],
+ *         atlas: {
+ *             components: {
+ *             }
+ *         }
+ *     }
+ * }
+ * ```
+ */
+export interface PluginConfig {
+    name: string
+    vite?: Vite[]
+
+    uniform?: Uniform<any>[] // TODO: fix any
+
+    // atlas?: { // TODO: in the future
+    //     components?: any
+    // }
+    customComponents?: {
+        [name: string]: PluginCustomComponents
+    } 
+}
+
+export type Plugin = (settings: Settings) => PluginConfig

package/tsconfig.json

@@ -0,0 +1,22 @@
+{
+  "compilerOptions": {
+    "module": "esnext",
+    "esModuleInterop": true,
+    "moduleResolution": "bundler",
+    "target": "esnext",
+    "baseUrl": ".",
+    "lib": ["dom", "dom.iterable", "esnext"],
+    "allowJs": true,
+    "skipLibCheck": true,
+    "strict": false,
+    "noEmit": true,
+    "incremental": false,
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "jsx": "preserve",
+    "plugins": [],
+    "strictNullChecks": true
+  },
+  "include": ["src/**/*.ts", "src/**/*.tsx"],
+  "exclude": ["node_modules"]
+}

package/tsup.config.ts

@@ -0,0 +1,33 @@
+import {copyFile} from 'node:fs/promises';
+import {join} from 'node:path';
+
+import {defineConfig, Options} from 'tsup';
+
+import pkg from './package.json';
+
+const deps = [
+    // ...Object.keys(pkg.dependencies || {}),
+    ...Object.keys(pkg.devDependencies || {}),
+]
+const config: Options = {
+    entry: {
+        index: 'src/index.ts',
+    },
+    dts: {
+        entry: {
+            index: 'src/index.ts',
+        },
+        resolve: true, // Resolve external types
+    },
+    format: ['esm'],
+    platform: 'node',
+    shims: false,
+    splitting: false,
+    sourcemap: true,
+    clean: true,
+    external: [
+        ...deps,
+    ]
+}
+
+export default defineConfig(config);