@pinegrow/vite-plugin 3.0.0-beta.14 → 3.0.0-beta.140

package/package.json

@@ -1,13 +1,15 @@
 {
 	"name": "@pinegrow/vite-plugin",
-	"version": "3.0.0-beta.14",
+	"version": "3.0.0-beta.140",
 	"description": "Pinegrow Vite Plugin",
 	"type": "module",
 	"files": [
-		"dist"
+		"dist",
+		"./types.d.ts"
 	],
 	"main": "./dist/index.cjs",
 	"module": "./dist/index.cjs",
+	"types": "./types.d.ts",
 	"exports": {
 		".": {
 			"import": "./dist/index.cjs",
@@ -16,12 +18,18 @@
 		"./dev": {
 			"import": "./src/index.js",
 			"require": "./src/index.js"
+		},
+		"./vue": {
+			"import": "./dist/vue/index.js"
+		},
+		"./pgia": {
+			"import": "./dist/pgia/index.js"
 		}
 	},
 	"keywords": [
 		"pinegrow",
-		"pinegrow-plugin",
-		"vite plugin",
+		"vue-designer",
+		"vite-plugin",
 		"@pinegrow/vite-plugin"
 	],
 	"author": "Pinegrow (http://pinegrow.com/)",
@@ -33,6 +41,8 @@
 		"increment-beta-version": "npm version prerelease --preid=beta"
 	},
 	"dependencies": {
+		"@vue/compiler-sfc": "^3.2.45",
+		"magic-string": "^0.27.0",
 		"node-html-parser": "^5.2.0"
 	}
 }

package/types.d.ts

@@ -0,0 +1,100 @@
+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.
+	 * Relative path from the project root to the root of a monorepo.
+	 */
+	repoRoot?: string
+
+	/**
+	 * Absolute path to a custom config file (for eg, vite-dev.config.js).
+	 * Relative path from the project root to a custom config file (for eg, vite-dev.config.js).
+	 */
+	configPath?: string
+
+	/**
+	 * Key of the devtools exposed on the window object.
+	 * For instructions, check Config Panel in Vue Designer
+	 */
+	devtoolsKey?: string
+
+	/**
+	 * Preferred format for icons in icon-picker - https://github.com/antfu/icones/blob/main/src/utils/case.ts
+	 * To see the different formats, go to https://icones.js.org/collection/mdi, turn off name copying mode if active, select an icon. In the bottom drawer, next to the icon-name & copy icon, there is dropup icon. Click the drop-up to see the different formats.
+	 * * @default 'unocss' // For eg, i-material-symbols-home
+	 *
+	 */
+	iconPreferredCase?:
+		| 'unocss'
+		| 'bare'
+		| 'barePascal'
+		| 'iconify'
+		| 'dash'
+		| 'camel'
+		| 'pascal'
+		| 'component'
+		| 'componentKebab'
+
+	/**
+	 * Router history modes - 'html5', 'hash'
+	 * @default 'html5'
+	 */
+
+	routerHistoryMode?: string //
+
+	/**
+	 * 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')] as pluginPath, along with a unique key
+	 */
+	plugins?: PinegrowExternalPlugin[] | string | string[]
+
+	/**
+	 * Pinegrow TailwindCSS plugin options
+	 */
+	tailwindcss?: PinegrowTailwindCSSModuleOptions
+}
+
+interface PinegrowVitePlugin<VitePluginOption> {
+	/**
+	 * Pinegrow Live Designer options
+	 * For details, check https://pinegrow.com/vue-designer
+	 */
+	liveDesigner?: {
+		[key in string]?: any
+	} & LiveDesignerOptions
+}
+
+declare function export_default(liveDesigner: LiveDesignerOptions): PinegrowVitePlugin
+
+export { PinegrowVitePlugin, LiveDesignerOptions, export_default as default, export_default as liveDesigner }
+