@gxp-dev/tools 2.0.9 → 2.0.11

package/bin/lib/commands/build.js

@@ -84,11 +84,34 @@ async function packagePlugin(projectPath, buildPath, outputPath) {
 		console.log(`ℹ️  No assets directory found at ${assetDirClean}/`);
 	}
 
-	// Copy app-manifest.json to dist/build/
+	// Process app-manifest.json for bundle
+	let manifest = null;
 	if (fs.existsSync(manifestPath)) {
+		// Parse manifest for optional bundle files
+		try {
+			manifest = JSON.parse(fs.readFileSync(manifestPath, "utf-8"));
+		} catch (error) {
+			console.warn("⚠️  Could not parse app-manifest.json");
+		}
+	}
+
+	// Process optional bundle files (appInstructions, defaultStyling, configuration)
+	if (manifest) {
+		processOptionalBundleFiles(manifest, projectPath, buildPath);
+
+		// Create a clean copy of manifest without the optional file keys (to avoid duplication)
+		const cleanedManifest = { ...manifest };
+		delete cleanedManifest.appInstructionsFile;
+		delete cleanedManifest.appInstructions;
+		delete cleanedManifest.defaultStylingFile;
+		delete cleanedManifest.defaultStyling;
+		delete cleanedManifest.configurationFile;
+		delete cleanedManifest.configuration;
+
+		// Write cleaned manifest to dist/build/
 		const manifestDestPath = path.join(buildPath, "app-manifest.json");
-		fs.copyFileSync(manifestPath, manifestDestPath);
-		console.log("✓ app-manifest.json copied to dist/build/");
+		fs.writeFileSync(manifestDestPath, JSON.stringify(cleanedManifest, null, 2), "utf-8");
+		console.log("✓ app-manifest.json written to dist/build/ (cleaned)");
 	}
 
 	// Create the .gxp package (zip file) in dist/
@@ -106,6 +129,71 @@ async function packagePlugin(projectPath, buildPath, outputPath) {
 	return gxpFilePath;
 }
 
+/**
+ * Process optional bundle files from manifest (appInstructions, defaultStyling)
+ * @param {object} manifest - Parsed app-manifest.json
+ * @param {string} projectPath - Project root path
+ * @param {string} buildPath - Path where built files are (dist/build/)
+ */
+function processOptionalBundleFiles(manifest, projectPath, buildPath) {
+	// Handle appInstructions
+	if (manifest.appInstructionsFile) {
+		// Copy file from specified path
+		const srcPath = path.join(projectPath, manifest.appInstructionsFile);
+		const destPath = path.join(buildPath, "appInstructions.md");
+		if (fs.existsSync(srcPath)) {
+			fs.copyFileSync(srcPath, destPath);
+			console.log(`✓ appInstructions.md copied from ${manifest.appInstructionsFile}`);
+		} else {
+			console.warn(`⚠️  appInstructionsFile not found: ${manifest.appInstructionsFile}`);
+		}
+	} else if (manifest.appInstructions) {
+		// Write text content to file
+		const destPath = path.join(buildPath, "appInstructions.md");
+		fs.writeFileSync(destPath, manifest.appInstructions, "utf-8");
+		console.log("✓ appInstructions.md created from manifest text");
+	}
+
+	// Handle defaultStyling
+	if (manifest.defaultStylingFile) {
+		// Copy file from specified path
+		const srcPath = path.join(projectPath, manifest.defaultStylingFile);
+		const destPath = path.join(buildPath, "default-styling.css");
+		if (fs.existsSync(srcPath)) {
+			fs.copyFileSync(srcPath, destPath);
+			console.log(`✓ default-styling.css copied from ${manifest.defaultStylingFile}`);
+		} else {
+			console.warn(`⚠️  defaultStylingFile not found: ${manifest.defaultStylingFile}`);
+		}
+	} else if (manifest.defaultStyling) {
+		// Write text content to file
+		const destPath = path.join(buildPath, "default-styling.css");
+		fs.writeFileSync(destPath, manifest.defaultStyling, "utf-8");
+		console.log("✓ default-styling.css created from manifest text");
+	}
+
+	// Handle configuration
+	if (manifest.configurationFile) {
+		// Copy file from specified path
+		const srcPath = path.join(projectPath, manifest.configurationFile);
+		const destPath = path.join(buildPath, "configuration.json");
+		if (fs.existsSync(srcPath)) {
+			fs.copyFileSync(srcPath, destPath);
+			console.log(`✓ configuration.json copied from ${manifest.configurationFile}`);
+		} else {
+			console.warn(`⚠️  configurationFile not found: ${manifest.configurationFile}`);
+		}
+	} else if (manifest.configuration) {
+		// Write JSON content to file
+		const destPath = path.join(buildPath, "configuration.json");
+		const jsonContent = typeof manifest.configuration === "string"
+			? manifest.configuration
+			: JSON.stringify(manifest.configuration, null, 2);
+		fs.writeFileSync(destPath, jsonContent, "utf-8");
+		console.log("✓ configuration.json created from manifest JSON");
+	}
+}
+
 /**
  * Recursively copy a directory
  */
@@ -177,6 +265,22 @@ function createGxpPackage(distPath, outputPath) {
 			archive.directory(assetsPath, "assets");
 		}
 
+		// Add optional bundle files
+		const appInstructionsPath = path.join(distPath, "appInstructions.md");
+		if (fs.existsSync(appInstructionsPath)) {
+			archive.file(appInstructionsPath, { name: "appInstructions.md" });
+		}
+
+		const defaultStylingPath = path.join(distPath, "default-styling.css");
+		if (fs.existsSync(defaultStylingPath)) {
+			archive.file(defaultStylingPath, { name: "default-styling.css" });
+		}
+
+		const configurationPath = path.join(distPath, "configuration.json");
+		if (fs.existsSync(configurationPath)) {
+			archive.file(configurationPath, { name: "configuration.json" });
+		}
+
 		archive.finalize();
 	});
 }

package/bin/lib/commands/init.js

@@ -116,6 +116,21 @@ async function initCommand(argv) {
 			dest: "src/DemoPage.vue",
 			desc: "DemoPage.vue (Example component)",
 		},
+		{
+			src: "default-styling.css",
+			dest: "default-styling.css",
+			desc: "default-styling.css",
+		},
+		{
+			src: "app-instructions.md",
+			dest: "app-instructions.md",
+			desc: "app-instructions.md",
+		},
+		{
+			src: "configuration.json",
+			dest: "configuration.json",
+			desc: "configuration.json",
+		},
 		{
 			src: "app-manifest.json",
 			dest: "app-manifest.json",

package/bin/lib/constants.js

@@ -106,7 +106,7 @@ const ENVIRONMENT_URLS = {
 };
 
 // Package name for path resolution
-const PACKAGE_NAME = "@gramercytech/gx-devtools";
+const PACKAGE_NAME = "@gxp-dev/tools";
 
 module.exports = {
 	isWin,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gxp-dev/tools",
-  "version": "2.0.9",
+  "version": "2.0.11",
   "description": "Dev tools to create platform plugins",
   "type": "commonjs",
   "publishConfig": {

package/runtime/vite.config.js

@@ -95,7 +95,7 @@ function getHttpsConfig(env) {
  * Find the gx-devtools package directory (works for both local and global installs)
  */
 function findToolkitPath() {
-	const packageName = "@gramercytech/gx-devtools";
+	const packageName = "@gxp-dev/tools";
 
 	// Try local node_modules first
 	const localPath = path.resolve(process.cwd(), "node_modules", packageName);

package/template/app-manifest.json

@@ -4,6 +4,8 @@
 	"description": "GxToolkit Plugin",
 	"manifest_version": 3,
 	"asset_dir": "/src/assets/",
+	"appInstructionsFile": "app-instructions.md",
+	"defaultStylingFile": "default-styling.css",
 	"settings": {
 		"primary_color": "#FFD600",
 		"background_color": "#ffffff",

package/template/configuration.json

@@ -0,0 +1,15 @@
+{
+    "additionalTabs": [
+        {
+            "type": "card_list",
+            "cards": [
+                {
+                    "cols": 12,
+                    "type": "fields_list",
+                    "title": "Configuration",
+                    "fieldsList": []
+				}
+			]
+		}
+	]
+}