@inkeep/cxkit-docusaurus 0.0.0-dev-20250226022822

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Chakra UI
+
+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/README.md

@@ -0,0 +1,50 @@
+# @inkeep/cxkit-docusaurus
+
+A Docusaurus plugin that integrates Inkeep Chat Button and Search Bar components into your documentation site.
+
+## Installation
+
+```bash
+npm install @inkeep/cxkit-docusaurus
+# or
+yarn add @inkeep/cxkit-docusaurus
+# or
+pnpm add @inkeep/cxkit-docusaurus
+```
+
+## Configuration
+
+Add the plugin to your `docusaurus.config.js`:
+
+```js
+const baseSettings = {
+  apiKey: 'YOUR_API_KEY',
+}
+module.exports = {
+  plugins: [
+    [
+      '@inkeep/cxkit-docusaurus',
+      {
+        ChatButton: {
+          // Props for InkeepChatButton component
+          baseSettings,
+          modalSettings: {
+            // Props for InkeepChatButton modal
+            shortcutKey: null,
+          },
+        },
+        SearchBar: {
+          // Props for InkeepSearchBar component
+          baseSettings,
+        },
+      },
+    ],
+  ],
+}
+```
+
+> Adding the component key to plugin options means enabling it, removing it means disabling it.
+
+## License
+
+Inkeep, Inc. Customer License (IICL) v1.1

package/dist/define-config.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const n=e=>e;exports.defineConfig=n;

package/dist/define-config.d.cts

@@ -0,0 +1,3 @@
+import { PluginConfig } from './types';
+export type * from '@inkeep/cxkit-react';
+export declare const defineConfig: (config: PluginConfig) => PluginConfig;

package/dist/define-config.d.ts

@@ -0,0 +1,3 @@
+import { PluginConfig } from './types';
+export type * from '@inkeep/cxkit-react';
+export declare const defineConfig: (config: PluginConfig) => PluginConfig;

package/dist/define-config.js

@@ -0,0 +1,4 @@
+const n = (e) => e;
+export {
+  n as defineConfig
+};

package/dist/index.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperties(exports,{__esModule:{value:!0},[Symbol.toStringTag]:{value:"Module"}});const e=require("path"),g=require("./utils/consts.cjs"),l=require("./define-config.cjs");function u(o,n){const{siteConfig:r,siteDir:i}=o;return r.themeConfig.inkeep||(r.themeConfig.inkeep=n),{name:g.PLUGIN_NAME,getThemePath(){return e.resolve(__dirname,"./theme")},getTypeScriptThemePath(){return e.resolve(__dirname,"./theme")},getClientModules(){const s=[n.config,"inkeep.config.ts","inkeep.config.js"].filter(Boolean);for(const f of s){const t=e.resolve(i,f);try{return require.resolve(t),[t]}catch(c){console.error("Error resolving Inkeep config:",c)}}return[]}}}exports.defineConfig=l.defineConfig;exports.default=u;

package/dist/index.d.cts

@@ -0,0 +1,9 @@
+import { Plugin } from '@docusaurus/types';
+import { InkeepPluginOptions, PluginTheme } from './types';
+export * from './define-config';
+export default function inkeepPlugin(context: {
+    siteConfig: {
+        themeConfig: PluginTheme;
+    };
+    siteDir: string;
+}, options: InkeepPluginOptions): Plugin;

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+import { Plugin } from '@docusaurus/types';
+import { InkeepPluginOptions, PluginTheme } from './types';
+export * from './define-config';
+export default function inkeepPlugin(context: {
+    siteConfig: {
+        themeConfig: PluginTheme;
+    };
+    siteDir: string;
+}, options: InkeepPluginOptions): Plugin;

package/dist/index.js

@@ -0,0 +1,33 @@
+import e from "path";
+import { PLUGIN_NAME as c } from "./utils/consts.js";
+import { defineConfig as u } from "./define-config.js";
+function a(t, r) {
+  const { siteConfig: o, siteDir: i } = t;
+  return o.themeConfig.inkeep || (o.themeConfig.inkeep = r), {
+    name: c,
+    getThemePath() {
+      return e.resolve(__dirname, "./theme");
+    },
+    getTypeScriptThemePath() {
+      return e.resolve(__dirname, "./theme");
+    },
+    getClientModules() {
+      const f = [r.config, "inkeep.config.ts", "inkeep.config.js"].filter(
+        Boolean
+      );
+      for (const s of f) {
+        const n = e.resolve(i, s);
+        try {
+          return require.resolve(n), [n];
+        } catch (g) {
+          console.error("Error resolving Inkeep config:", g);
+        }
+      }
+      return [];
+    }
+  };
+}
+export {
+  a as default,
+  u as defineConfig
+};

package/dist/theme/ChatButton.d.cts

@@ -0,0 +1 @@
+export default function ChatButtonWrapper(): import("react/jsx-runtime").JSX.Element | null;

package/dist/theme/ChatButton.d.ts

@@ -0,0 +1 @@
+export default function ChatButtonWrapper(): import("react/jsx-runtime").JSX.Element | null;

package/dist/theme/Root.d.cts

@@ -0,0 +1,4 @@
+import { default as React } from 'react';
+export default function Root({ children }: {
+    children: React.ReactNode;
+}): import("react/jsx-runtime").JSX.Element;

package/dist/theme/Root.d.ts

@@ -0,0 +1,4 @@
+import { default as React } from 'react';
+export default function Root({ children }: {
+    children: React.ReactNode;
+}): import("react/jsx-runtime").JSX.Element;

package/dist/theme/SearchBar.d.cts

@@ -0,0 +1 @@
+export default function SearchBarWrapper(): import("react/jsx-runtime").JSX.Element | null;

package/dist/theme/SearchBar.d.ts

@@ -0,0 +1 @@
+export default function SearchBarWrapper(): import("react/jsx-runtime").JSX.Element | null;

package/dist/utils/config.d.cts

@@ -0,0 +1,3 @@
+import { PluginConfig } from '../types';
+import { InkeepConfig } from '@inkeep/cxkit-react';
+export declare function useConfig(component: keyof PluginConfig): InkeepConfig | null;

package/dist/utils/config.d.ts

@@ -0,0 +1,3 @@
+import { PluginConfig } from '../types';
+import { InkeepConfig } from '@inkeep/cxkit-react';
+export declare function useConfig(component: keyof PluginConfig): InkeepConfig | null;

package/dist/utils/consts.cjs

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e="docusaurus-plugin-inkeep";exports.PLUGIN_NAME=e;

package/dist/utils/consts.d.cts

@@ -0,0 +1 @@
+export declare const PLUGIN_NAME = "docusaurus-plugin-inkeep";

package/dist/utils/consts.d.ts

@@ -0,0 +1 @@
+export declare const PLUGIN_NAME = "docusaurus-plugin-inkeep";

package/dist/utils/consts.js

@@ -0,0 +1,4 @@
+const u = "docusaurus-plugin-inkeep";
+export {
+  u as PLUGIN_NAME
+};

package/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "@inkeep/cxkit-docusaurus",
+  "version": "0.0.0-dev-20250226022822",
+  "description": "Docusaurus plugin for Inkeep Chat and Search components",
+  "license": "Inkeep, Inc. Customer License (IICL) v1.1",
+  "homepage": "",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/inkeep/widget",
+    "directory": "packages/docusaurus"
+  },
+  "type": "module",
+  "main": "dist/index.cjs",
+  "files": [
+    "dist"
+  ],
+  "clean-package": "../../clean-package.config.json",
+  "publishConfig": {
+    "access": "public"
+  },
+  "sideEffects": false,
+  "peerDependencies": {
+    "react": ">=16.8.0",
+    "react-dom": ">=16.8.0"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "1.9.4",
+    "@docusaurus/module-type-aliases": "3.7.0",
+    "@docusaurus/types": "^3.0.0",
+    "@types/node": "22.10.2",
+    "@types/react": "19.0.10",
+    "clean-package": "2.2.0",
+    "globby": "14.0.2",
+    "react": "19.0.0",
+    "typescript": "5.7.3",
+    "vite": "5.4.11",
+    "vite-plugin-dts": "4.4.0",
+    "@inkeep/cxkit-types": "0.0.0-dev-20250226022822"
+  },
+  "dependencies": {
+    "merge-anything": "6.0.2",
+    "path": "^0.12.7",
+    "@inkeep/cxkit-react": "0.0.0-dev-20250226022822"
+  },
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "source": "./src/index.ts",
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "scripts": {
+    "build": "vite build",
+    "lint": "biome lint ./src",
+    "typecheck": "tsc"
+  }
+}