@pinegrow/vite-plugin 3.0.0-beta.133 → 3.0.0-beta.134

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@pinegrow/vite-plugin",
-	"version": "3.0.0-beta.133",
+	"version": "3.0.0-beta.134",
 	"description": "Pinegrow Vite Plugin",
 	"type": "module",
 	"files": [

package/types.d.ts

@@ -1,6 +1,34 @@
 import type { PinegrowTailwindCSSModuleOptions } from '@pinegrow/tailwindcss-plugin'
 import type { PluginOption as VitePluginOption } from 'vite'
 
+interface PinegrowExternalPlugin {
+	/**
+	 * Display name in Props Panel and Library Panels
+	 * Eg, "My Awesome Lib 3.3.1", defaults to key if not provided
+	 */
+	name?: string
+	/**
+	 * Unique key that doesn't conflict with other pinegrow frameworks
+	 * Run `Object.values(pinegrow.getFrameworks()).map(fx => fx.key)` in Vue Designer's devtools console for existing keys
+	 *
+	 * Allowed characters - alphanumeric with hyphens or period, no spaces
+	 * Eg, 'my-awesome-lib'
+	 */
+	key: string
+	/**
+	 * Web-types of component library (or) pinegrow commonjs plugin
+	 * Must return an absolute path
+	 *
+	 * Use path functions according to the project module type (commonjs/module)
+	 * For eg, path.resolve(__dirname, '../relative-path/my-lib.cjs')
+	 * (or)
+	 * import { fileURLToPath, URL } from 'node:url'
+	 * fileURLToPath(new URL('./relative-path/web-types.json', import.meta.url)) // web-types of component library
+	 * fileURLToPath(new URL('./relative-path/my-lib.cjs', import.meta.url)) // pinegrow commonjs plugin
+	 */
+	pluginPath: string
+}
+
 export interface LiveDesignerOptions {
 	/**
 	 * Absolute path to the root of a monorepo.
@@ -46,9 +74,9 @@ export interface LiveDesignerOptions {
 
 	/**
 	 * Array of Pinegrow plugins (npm package names)
-	 * To use file-based Pinegrow Plugins, provide the absolute path of the plugin file, for eg, [path.resolve(__dirname, './pg-plugin/index.js')]
+	 * To use file-based Pinegrow Plugins, provide the absolute path of the plugin file, for eg, [path.resolve(__dirname, './pg-plugin/index.js')] as pluginPath, along with a unique key
 	 */
-	plugins?: string[]
+	plugins?: PinegrowExternalPlugin[] | string | string[]
 
 	/**
 	 * Pinegrow TailwindCSS plugin options