@xyd-js/plugins 0.0.0-build-2acf05c-20251207022018 → 0.0.0-build-83b15db-20251213220910

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xyd-js/plugins",
-  "version": "0.0.0-build-2acf05c-20251207022018",
+  "version": "0.0.0-build-83b15db-20251213220910",
   "description": "",
   "main": "./dist/index.js",
   "type": "module",
@@ -11,10 +11,10 @@
     }
   },
   "dependencies": {
-    "@xyd-js/uniform": "0.0.0-build-2acf05c-20251207022018"
+    "@xyd-js/uniform": "0.0.0-build-83b15db-20251213220910"
   },
   "peerDependencies": {
-    "@xyd-js/framework": "0.0.0-build-2acf05c-20251207022018"
+    "@xyd-js/framework": "0.0.0-build-83b15db-20251213220910"
   },
   "devDependencies": {
     "@vitest/coverage-v8": "^1.3.1",

package/src/index.ts

@@ -1,8 +1,9 @@
 import type {Plugin as Vite} from "vite"
 import React from "react"
+import { Plugin as MarkdownPlugin } from 'unified';
 
 import {type UniformPlugin as Uniform} from "@xyd-js/uniform"
-import {HeadConfig, Settings} from "@xyd-js/core"
+import {HeadConfig, Settings, Metadata} from "@xyd-js/core"
 import type {SurfaceTarget} from "@xyd-js/framework"
 
 // // TODO: share with theme-api ?
@@ -15,28 +16,50 @@ export type PluginComponents = {
     component: React.ComponentType<any>,
     name?: string,
     dist?: string // TODO: fix in the future
+    isInline?: boolean // true if component should be inlined instead of imported
 }[] | {
     [component: string]: React.ComponentType<any>
 }
 
+export interface HookCallbackArgs {
+    metadata: Metadata<any>
+}
+
 /**
  * Plugin interface
  *
  * @example
  * ```ts
  * function myPlugin(): Plugin {
- *     return {
- *         name: "my-plugin",
- *         vite: [
- *             {
- *                 name: "my-vite-plugin",
- *             }
- *         ],
- *         uniform: [
- *             pluginOpenAIMeta,
- *         ],
- *         atlas: {
- *             components: {
+ *     return (settings) => {
+ *         return {
+ *             name: "my-plugin",
+ *             vite: [
+ *                 {
+ *                     name: "my-vite-plugin",
+ *                 }
+ *             ],
+ *             uniform: [
+ *                 pluginOpenAIMeta,
+ *             ],
+ *             components: [
+ *                 {
+ *                     component: MyComponent,
+ *                     name: "MyComponent",
+ *                     dist: "./dist/MyComponent.js"
+ *                 }
+ *             ],
+ *             head: [
+ *                 ["style", {}, "body { margin: 0; }"]
+ *             ],
+ *             markdown: {
+ *                 remark: [remarkPlugin],
+ *                 rehype: [rehypePlugin],
+ *             },
+ *             hooks: {
+ *                 applyComponents(cfg) {
+ *                     return cfg?.metadata?.component === "my-plugin";
+ *                 }
  *             }
  *         }
  *     }
@@ -51,8 +74,16 @@ export interface PluginConfig {
     components?: PluginComponents
     head?: HeadConfig[]
     markdown?: {
-        remark: any[],
-        rehype: any[],
+        remark?: MarkdownPlugin[],
+        rehype?: MarkdownPlugin[],
+        remarkRehypeHandlers?: any // TODO: fix any
+    },
+    hooks?: {
+        //  TODO: types
+        applyComponents?: (cfg: HookCallbackArgs) => boolean
+
+        // TODO: finish
+        // applyHeads?: (cfg: any) => boolean
     }
 }
 
@@ -63,4 +94,4 @@ export type Plugin = (settings: Readonly<Settings>) => PluginConfig
 // }
 // customComponents?: {
 //     [name: string]: PluginCustomComponents
-// },
+// },