lumia-plugin 0.1.4 → 0.1.5

package/README.md

@@ -1,13 +1,13 @@
 # Lumia Stream Plugin CLI
 
-The `@lumiastream/plugin-cli` package bundles the command-line tools for creating, building, and validating Lumia Stream plugins without pulling the full SDK into your runtime dependencies.
+The `lumia-plugin` package bundles the command-line tools for creating, building, and validating Lumia Stream plugins without pulling the full SDK into your runtime dependencies.
 
 ## Commands
 
 ```
-npx @lumiastream/plugin-cli create <directory>
-npx @lumiastream/plugin-cli build [--dir <path>] [--out <file>]
-npx @lumiastream/plugin-cli validate <plugin-directory>
+npx lumia-plugin create <directory>
+npx lumia-plugin build [--dir <path>] [--out <file>]
+npx lumia-plugin validate <plugin-directory>
 ```
 
 Run any command with `--help` to see detailed options.

package/examples/base-plugin/README.md

@@ -11,7 +11,7 @@ This template demonstrates a handful of common Lumia Stream plugin capabilities:
 Use the CLI to copy and customise the template:
 
 ```
-npx @lumiastream/plugin-cli create my-plugin
+npx lumia-plugin create my-plugin
 ```
 
 After scaffolding you can tailor the manifest, code, and README to match your idea.

package/examples/base-plugin/main.js

@@ -1,143 +1,150 @@
-const { Plugin } = require('@lumiastream/plugin-sdk');
+const { Plugin } = require("@lumiastream/plugin");
 
 const VARIABLE_NAMES = {
-  lastMessage: 'last_message',
-  lastAlertColor: 'last_alert_color',
+	lastMessage: "last_message",
+	lastAlertColor: "last_alert_color",
 };
 
 const DEFAULTS = {
-  welcomeMessage: 'Hello from Showcase Plugin!',
-  color: '#00c2ff',
-  alertDuration: 5,
+	welcomeMessage: "Hello from Showcase Plugin!",
+	color: "#00c2ff",
+	alertDuration: 5,
 };
 
 class ShowcasePluginTemplate extends Plugin {
-  async onload() {
-    const message = this._currentMessage();
-    await this._log('Plugin loaded');
-    await this._rememberMessage(message);
-
-    if (this.settings.autoAlert === 'load') {
-      await this._triggerSampleAlert({
-        color: this.settings.favoriteColor,
-        duration: DEFAULTS.alertDuration,
-      });
-    }
-  }
-
-  async onunload() {
-    await this._log('Plugin unloaded');
-  }
-
-  async onsettingsupdate(settings, previous = {}) {
-    await this._log('Settings updated');
-
-    if (settings?.welcomeMessage && settings.welcomeMessage !== previous?.welcomeMessage) {
-      await this._rememberMessage(settings.welcomeMessage);
-    }
-
-    if (settings?.autoAlert === 'load' && previous?.autoAlert !== 'load') {
-      await this._log('Auto alert configured to fire on load');
-    }
-  }
-
-  async actions(config = {}) {
-    const actions = Array.isArray(config.actions) ? config.actions : [];
-    for (const action of actions) {
-      switch (action?.type) {
-        case 'log_message':
-          await this._handleLogMessage(action.data);
-          break;
-        case 'update_variable':
-          await this._handleUpdateVariable(action.data);
-          break;
-        case 'trigger_alert':
-          await this._triggerSampleAlert(action.data);
-          break;
-        default:
-          await this._log(`Unknown action type: ${action?.type ?? 'undefined'}`);
-      }
-    }
-  }
-
-  _tag() {
-    return `[${this.manifest?.id ?? 'showcase-plugin'}]`;
-  }
-
-  _currentMessage() {
-    return (
-      this.settings?.welcomeMessage ||
-      `Hello from ${this.manifest?.name ?? 'Showcase Plugin'}!`
-    );
-  }
-
-  async _log(message, severity = 'info') {
-    const prefix = this._tag();
-    const decorated =
-      severity === 'warn'
-        ? `${prefix} ⚠️ ${message}`
-        : severity === 'error'
-        ? `${prefix} ❌ ${message}`
-        : `${prefix} ${message}`;
-
-    await this.lumia.addLog(decorated);
-  }
-
-  async _rememberMessage(value) {
-    await this.lumia.setVariable(VARIABLE_NAMES.lastMessage, value);
-  }
-
-  async _handleLogMessage(data = {}) {
-    const message = data?.message || this._currentMessage();
-    const severity = data?.severity || 'info';
-
-    await this._log(message, severity);
-
-    if (typeof this.lumia.showToast === 'function') {
-      await this.lumia.showToast({
-        message: `${this.manifest?.name ?? 'Plugin'}: ${message}`,
-        time: 4,
-      });
-    }
-
-    if (this.settings.autoAlert === 'after-log') {
-      await this._triggerSampleAlert({
-        color: this.settings.favoriteColor,
-        duration: DEFAULTS.alertDuration,
-      });
-    }
-  }
-
-  async _handleUpdateVariable(data = {}) {
-    const value = data?.value ?? new Date().toISOString();
-    await this._rememberMessage(value);
-    await this._log(`Stored variable value: ${value}`);
-  }
-
-  async _triggerSampleAlert(data = {}) {
-    const color =
-      data?.color ||
-      this.settings?.favoriteColor ||
-      DEFAULTS.color;
-    const duration = Number(data?.duration) || DEFAULTS.alertDuration;
-
-    try {
-      const success = await this.lumia.triggerAlert({
-        alert: 'sample_light',
-        extraSettings: { color, duration },
-      });
-
-      if (!success) {
-        await this._log('Sample alert reported failure', 'warn');
-        return;
-      }
-
-      await this.lumia.setVariable(VARIABLE_NAMES.lastAlertColor, color);
-      await this._log(`Triggered sample alert with color ${color} for ${duration}s`);
-    } catch (error) {
-      await this._log(`Failed to trigger sample alert: ${error.message ?? error}`, 'error');
-    }
-  }
+	async onload() {
+		const message = this._currentMessage();
+		await this._log("Plugin loaded");
+		await this._rememberMessage(message);
+
+		if (this.settings.autoAlert === "load") {
+			await this._triggerSampleAlert({
+				color: this.settings.favoriteColor,
+				duration: DEFAULTS.alertDuration,
+			});
+		}
+	}
+
+	async onunload() {
+		await this._log("Plugin unloaded");
+	}
+
+	async onsettingsupdate(settings, previous = {}) {
+		await this._log("Settings updated");
+
+		if (
+			settings?.welcomeMessage &&
+			settings.welcomeMessage !== previous?.welcomeMessage
+		) {
+			await this._rememberMessage(settings.welcomeMessage);
+		}
+
+		if (settings?.autoAlert === "load" && previous?.autoAlert !== "load") {
+			await this._log("Auto alert configured to fire on load");
+		}
+	}
+
+	async actions(config = {}) {
+		const actions = Array.isArray(config.actions) ? config.actions : [];
+		for (const action of actions) {
+			switch (action?.type) {
+				case "log_message":
+					await this._handleLogMessage(action.data);
+					break;
+				case "update_variable":
+					await this._handleUpdateVariable(action.data);
+					break;
+				case "trigger_alert":
+					await this._triggerSampleAlert(action.data);
+					break;
+				default:
+					await this._log(
+						`Unknown action type: ${action?.type ?? "undefined"}`
+					);
+			}
+		}
+	}
+
+	_tag() {
+		return `[${this.manifest?.id ?? "showcase-plugin"}]`;
+	}
+
+	_currentMessage() {
+		return (
+			this.settings?.welcomeMessage ||
+			`Hello from ${this.manifest?.name ?? "Showcase Plugin"}!`
+		);
+	}
+
+	async _log(message, severity = "info") {
+		const prefix = this._tag();
+		const decorated =
+			severity === "warn"
+				? `${prefix} ⚠️ ${message}`
+				: severity === "error"
+				? `${prefix} ❌ ${message}`
+				: `${prefix} ${message}`;
+
+		await this.lumia.addLog(decorated);
+	}
+
+	async _rememberMessage(value) {
+		await this.lumia.setVariable(VARIABLE_NAMES.lastMessage, value);
+	}
+
+	async _handleLogMessage(data = {}) {
+		const message = data?.message || this._currentMessage();
+		const severity = data?.severity || "info";
+
+		await this._log(message, severity);
+
+		if (typeof this.lumia.showToast === "function") {
+			await this.lumia.showToast({
+				message: `${this.manifest?.name ?? "Plugin"}: ${message}`,
+				time: 4,
+			});
+		}
+
+		if (this.settings.autoAlert === "after-log") {
+			await this._triggerSampleAlert({
+				color: this.settings.favoriteColor,
+				duration: DEFAULTS.alertDuration,
+			});
+		}
+	}
+
+	async _handleUpdateVariable(data = {}) {
+		const value = data?.value ?? new Date().toISOString();
+		await this._rememberMessage(value);
+		await this._log(`Stored variable value: ${value}`);
+	}
+
+	async _triggerSampleAlert(data = {}) {
+		const color = data?.color || this.settings?.favoriteColor || DEFAULTS.color;
+		const duration = Number(data?.duration) || DEFAULTS.alertDuration;
+
+		try {
+			const success = await this.lumia.triggerAlert({
+				alert: "sample_light",
+				extraSettings: { color, duration },
+			});
+
+			if (!success) {
+				await this._log("Sample alert reported failure", "warn");
+				return;
+			}
+
+			await this.lumia.setVariable(VARIABLE_NAMES.lastAlertColor, color);
+			await this._log(
+				`Triggered sample alert with color ${color} for ${duration}s`
+			);
+		} catch (error) {
+			await this._log(
+				`Failed to trigger sample alert: ${error.message ?? error}`,
+				"error"
+			);
+		}
+	}
 }
 
 module.exports = ShowcasePluginTemplate;

package/examples/base-plugin/package.json

@@ -1,10 +1,10 @@
 {
-  "name": "lumia-showcase-plugin-template",
-  "version": "1.0.0",
-  "private": true,
-  "description": "Internal template illustrating logging, variables, actions, and alerts for Lumia Stream plugins.",
-  "main": "main.js",
-  "dependencies": {
-    "@lumiastream/plugin-sdk": "^0.1.0"
-  }
+	"name": "lumia-showcase-plugin-template",
+	"version": "1.0.0",
+	"private": true,
+	"description": "Internal template illustrating logging, variables, actions, and alerts for Lumia Stream plugins.",
+	"main": "main.js",
+	"dependencies": {
+		"@lumiastream/plugin": "^0.1.0"
+	}
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "lumia-plugin",
-	"version": "0.1.4",
+	"version": "0.1.5",
 	"description": "Command-line tools for creating, building, and validating Lumia Stream plugins.",
 	"bin": {
 		"lumia-plugin": "scripts/cli.js"

package/scripts/build-plugin.js

@@ -43,7 +43,7 @@ function parseArgs() {
 function printHelp() {
 	console.log(`Build a .lumiaplugin archive for distribution.
 
-Usage: npx @lumiastream/plugin-cli build [options]
+Usage: npx lumia-plugin build [options]
 
 Options:
   --dir, -d   Plugin directory (defaults to cwd)

package/scripts/create-plugin.js

@@ -23,7 +23,7 @@ function toDisplayName(id) {
 }
 
 function printHelp() {
-  console.log(`Scaffold a new Lumia Stream plugin directory using the showcase template.\n\nUsage: npx @lumiastream/plugin-cli create [target-directory]\n\nExamples:\n  npx @lumiastream/plugin-cli create ./plugins/my-plugin\n  npx @lumiastream/plugin-cli create my-awesome-plugin\n`);
+  console.log(`Scaffold a new Lumia Stream plugin directory using the showcase template.\n\nUsage: npx lumia-plugin create [target-directory]\n\nExamples:\n  npx lumia-plugin create ./plugins/my-plugin\n  npx lumia-plugin create my-awesome-plugin\n`);
 }
 
 async function ensureEmptyDir(targetDir) {

package/scripts/utils.js

@@ -1,109 +1,129 @@
-const fs = require('fs');
-const path = require('path');
-const JSZip = require('jszip');
+const fs = require("fs");
+const path = require("path");
+const JSZip = require("jszip");
 
 const DEFAULT_IGNORE = new Set([
-  '.git',
-  '.DS_Store',
-  'Thumbs.db',
-  'package-lock.json',
-  'yarn.lock',
-  '.npmrc',
-  '.gitignore',
+	".git",
+	".DS_Store",
+	"Thumbs.db",
+	"package-lock.json",
+	"yarn.lock",
+	".npmrc",
+	".gitignore",
 ]);
 
 function toPosix(p) {
-  return p.split(path.sep).join('/');
+	return p.split(path.sep).join("/");
 }
 
 async function readManifest(pluginDir) {
-  const manifestPath = path.join(pluginDir, 'manifest.json');
-  const raw = await fs.promises.readFile(manifestPath, 'utf8');
-  return { manifest: JSON.parse(raw), manifestPath };
+	const manifestPath = path.join(pluginDir, "manifest.json");
+	const raw = await fs.promises.readFile(manifestPath, "utf8");
+	return { manifest: JSON.parse(raw), manifestPath };
 }
 
 function validateManifest(manifest) {
-  const errors = [];
-  const requiredStringFields = ['id', 'name', 'version', 'author', 'description', 'license', 'lumiaVersion'];
-  for (const field of requiredStringFields) {
-    const value = manifest[field];
-    if (typeof value !== 'string' || value.trim().length === 0) {
-      errors.push(`Missing or invalid manifest field: ${field}`);
-    }
-  }
+	const errors = [];
+	const requiredStringFields = [
+		"id",
+		"name",
+		"version",
+		"author",
+		"description",
+		"license",
+		"lumiaVersion",
+	];
+	for (const field of requiredStringFields) {
+		const value = manifest[field];
+		if (typeof value !== "string" || value.trim().length === 0) {
+			errors.push(`Missing or invalid manifest field: ${field}`);
+		}
+	}
 
-  if (!manifest.category || (typeof manifest.category !== 'string' && !Array.isArray(manifest.category))) {
-    errors.push('Manifest must declare a category string');
-  }
+	if (
+		!manifest.category ||
+		(typeof manifest.category !== "string" && !Array.isArray(manifest.category))
+	) {
+		errors.push("Manifest must declare a category string");
+	}
 
-  if (!manifest.config || typeof manifest.config !== 'object') {
-    errors.push('Manifest config must be an object');
-  }
+	if (!manifest.config || typeof manifest.config !== "object") {
+		errors.push("Manifest config must be an object");
+	}
 
-  if (manifest.config) {
-    if (manifest.config.settings && !Array.isArray(manifest.config.settings)) {
-      errors.push('config.settings must be an array when provided');
-    }
-    if (manifest.config.actions && !Array.isArray(manifest.config.actions)) {
-      errors.push('config.actions must be an array when provided');
-    }
-    if (manifest.config.variables && !Array.isArray(manifest.config.variables)) {
-      errors.push('config.variables must be an array when provided');
-    }
-    if (manifest.config.alerts && !Array.isArray(manifest.config.alerts)) {
-      errors.push('config.alerts must be an array when provided');
-    }
-  }
+	if (manifest.config) {
+		if (manifest.config.settings && !Array.isArray(manifest.config.settings)) {
+			errors.push("config.settings must be an array when provided");
+		}
+		if (manifest.config.actions && !Array.isArray(manifest.config.actions)) {
+			errors.push("config.actions must be an array when provided");
+		}
+		if (
+			manifest.config.variables &&
+			!Array.isArray(manifest.config.variables)
+		) {
+			errors.push("config.variables must be an array when provided");
+		}
+		if (manifest.config.alerts && !Array.isArray(manifest.config.alerts)) {
+			errors.push("config.alerts must be an array when provided");
+		}
+	}
 
-  return errors;
+	return errors;
 }
 
 async function collectFiles(pluginDir, ignore = DEFAULT_IGNORE) {
-  const entries = [];
+	const entries = [];
 
-  async function walk(currentDir) {
-    const list = await fs.promises.readdir(currentDir, { withFileTypes: true });
-    for (const entry of list) {
-      if (ignore.has(entry.name)) continue;
-      const absolute = path.join(currentDir, entry.name);
-      const relative = path.relative(pluginDir, absolute);
-      if (!relative || relative.startsWith('..')) continue;
+	async function walk(currentDir) {
+		const list = await fs.promises.readdir(currentDir, { withFileTypes: true });
+		for (const entry of list) {
+			if (ignore.has(entry.name)) continue;
+			const absolute = path.join(currentDir, entry.name);
+			const relative = path.relative(pluginDir, absolute);
+			if (!relative || relative.startsWith("..")) continue;
 
-      // Skip bundled Lumia packages in node_modules
-      if (relative === 'node_modules/@lumiastream'
-          || relative.startsWith('node_modules/@lumiastream/plugin-sdk')
-          || relative.startsWith('node_modules/@lumiastream/plugin-cli')) {
-        continue;
-      }
+			// Skip bundled Lumia packages in node_modules
+			if (
+				relative === "node_modules/@lumiastream" ||
+				relative.startsWith("node_modules/@lumiastream/plugin") ||
+				relative.startsWith("node_modules/lumia-plugin")
+			) {
+				continue;
+			}
 
-      if (entry.isDirectory()) {
-        await walk(absolute);
-      } else if (entry.isFile()) {
-        entries.push({ absolute, relative: toPosix(relative) });
-      }
-    }
-  }
+			if (entry.isDirectory()) {
+				await walk(absolute);
+			} else if (entry.isFile()) {
+				entries.push({ absolute, relative: toPosix(relative) });
+			}
+		}
+	}
 
-  await walk(pluginDir);
-  return entries;
+	await walk(pluginDir);
+	return entries;
 }
 
 async function createPluginArchive(pluginDir, outputFile, files) {
-  const zip = new JSZip();
-  for (const file of files) {
-    const data = await fs.promises.readFile(file.absolute);
-    zip.file(file.relative, data);
-  }
-  const content = await zip.generateAsync({ type: 'nodebuffer', compression: 'DEFLATE', compressionOptions: { level: 9 } });
-  await fs.promises.mkdir(path.dirname(outputFile), { recursive: true });
-  await fs.promises.writeFile(outputFile, content);
-  return outputFile;
+	const zip = new JSZip();
+	for (const file of files) {
+		const data = await fs.promises.readFile(file.absolute);
+		zip.file(file.relative, data);
+	}
+	const content = await zip.generateAsync({
+		type: "nodebuffer",
+		compression: "DEFLATE",
+		compressionOptions: { level: 9 },
+	});
+	await fs.promises.mkdir(path.dirname(outputFile), { recursive: true });
+	await fs.promises.writeFile(outputFile, content);
+	return outputFile;
 }
 
 module.exports = {
-  readManifest,
-  validateManifest,
-  collectFiles,
-  createPluginArchive,
-  DEFAULT_IGNORE,
+	readManifest,
+	validateManifest,
+	collectFiles,
+	createPluginArchive,
+	DEFAULT_IGNORE,
 };