@lumiastream/plugin 0.1.8 → 0.1.9

package/README.md

@@ -2,6 +2,8 @@
 
 Official TypeScript/JavaScript SDK for developing plugins for [Lumia Stream](https://lumiastream.com).
 
+![Lumia Stream Plugin](docs/lumiaplugin-banner.png)
+
 ## Installation
 
 ```bash
@@ -99,6 +101,7 @@ The CLI is distributed separately via `lumia-plugin`. Use it with `npx` (require
 - [Getting Started](./docs/getting-started.md)
 - [API Reference](./docs/api-reference.md)
 - [Manifest Guide](./docs/manifest-guide.md)
+- [Field Types Reference](./docs/field-types-reference.md)
 
 ## Examples
 

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 export { Plugin } from './plugin';
 export type { PluginManifest, PluginContext, PluginFormField, PluginAuthConfig, PluginActionsConfig, PluginInstance, PluginConfig, PluginStats, PluginDependency, PluginFile, PluginPackage, PluginVariableDefinition, PluginAlertDefinition, PluginIntegrationConfig, PluginActionDefinition, PluginActionField, PluginSetting, PluginTriggerAlertOptions, PluginDisplayChatOptions, PluginRuntime, ILumiaAPI, } from './types';
 export { PluginStatus, PluginCategory, } from './types';
+export { validatePluginManifest, validateManifest, } from './manifest-validation';
 export default Plugin;
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,YAAY,EACV,cAAc,EACd,aAAa,EACb,eAAe,EACf,gBAAgB,EAChB,mBAAmB,EACnB,cAAc,EACd,YAAY,EACZ,WAAW,EACX,gBAAgB,EAChB,UAAU,EACV,aAAa,EACb,wBAAwB,EACxB,qBAAqB,EACrB,uBAAuB,EACvB,sBAAsB,EACtB,iBAAiB,EACjB,aAAa,EACb,yBAAyB,EACzB,wBAAwB,EACxB,aAAa,EACb,SAAS,GACV,MAAM,SAAS,CAAC;AACjB,OAAO,EACL,YAAY,EACZ,cAAc,GACf,MAAM,SAAS,CAAC;AACjB,eAAe,MAAM,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,UAAU,CAAC;AAClC,YAAY,EACV,cAAc,EACd,aAAa,EACb,eAAe,EACf,gBAAgB,EAChB,mBAAmB,EACnB,cAAc,EACd,YAAY,EACZ,WAAW,EACX,gBAAgB,EAChB,UAAU,EACV,aAAa,EACb,wBAAwB,EACxB,qBAAqB,EACrB,uBAAuB,EACvB,sBAAsB,EACtB,iBAAiB,EACjB,aAAa,EACb,yBAAyB,EACzB,wBAAwB,EACxB,aAAa,EACb,SAAS,GACV,MAAM,SAAS,CAAC;AACjB,OAAO,EACL,YAAY,EACZ,cAAc,GACf,MAAM,SAAS,CAAC;AACjB,OAAO,EACL,sBAAsB,EACtB,gBAAgB,GACjB,MAAM,uBAAuB,CAAC;AAC/B,eAAe,MAAM,CAAC"}

package/dist/index.js

@@ -1,10 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PluginCategory = exports.PluginStatus = exports.Plugin = void 0;
+exports.validateManifest = exports.validatePluginManifest = exports.PluginCategory = exports.PluginStatus = exports.Plugin = void 0;
 var plugin_1 = require("./plugin");
 Object.defineProperty(exports, "Plugin", { enumerable: true, get: function () { return plugin_1.Plugin; } });
 var types_1 = require("./types");
 Object.defineProperty(exports, "PluginStatus", { enumerable: true, get: function () { return types_1.PluginStatus; } });
 Object.defineProperty(exports, "PluginCategory", { enumerable: true, get: function () { return types_1.PluginCategory; } });
+var manifest_validation_1 = require("./manifest-validation");
+Object.defineProperty(exports, "validatePluginManifest", { enumerable: true, get: function () { return manifest_validation_1.validatePluginManifest; } });
+Object.defineProperty(exports, "validateManifest", { enumerable: true, get: function () { return manifest_validation_1.validateManifest; } });
 exports.default = Plugin;
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,mCAAkC;AAAzB,gGAAA,MAAM,OAAA;AAwBf,iCAGiB;AAFf,qGAAA,YAAY,OAAA;AACZ,uGAAA,cAAc,OAAA;AAEhB,kBAAe,MAAM,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,mCAAkC;AAAzB,gGAAA,MAAM,OAAA;AAwBf,iCAGiB;AAFf,qGAAA,YAAY,OAAA;AACZ,uGAAA,cAAc,OAAA;AAEhB,6DAG+B;AAF7B,6HAAA,sBAAsB,OAAA;AACtB,uHAAA,gBAAgB,OAAA;AAElB,kBAAe,MAAM,CAAC"}

package/dist/manifest-validation.d.ts

@@ -0,0 +1,14 @@
+import { PluginManifest } from "./types";
+type PartialManifest = Partial<PluginManifest> & Record<string, unknown>;
+/**
+ * Perform lightweight validation on a plugin manifest definition.
+ * Returns an array of error strings. An empty array indicates the
+ * manifest passed all heuristics.
+ */
+export declare function validatePluginManifest(manifest: PartialManifest | null | undefined): string[];
+/**
+ * Convenience alias preserved for backwards compatibility with the CLI.
+ */
+export declare const validateManifest: typeof validatePluginManifest;
+export default validatePluginManifest;
+//# sourceMappingURL=manifest-validation.d.ts.map

package/dist/manifest-validation.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"manifest-validation.d.ts","sourceRoot":"","sources":["../src/manifest-validation.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAA2B,MAAM,SAAS,CAAC;AAElE,KAAK,eAAe,GAAG,OAAO,CAAC,cAAc,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AA6BzE;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,QAAQ,EAAE,eAAe,GAAG,IAAI,GAAG,SAAS,GAAG,MAAM,EAAE,CAgC7F;AAED;;GAEG;AACH,eAAO,MAAM,gBAAgB,+BAAyB,CAAC;AAEvD,eAAe,sBAAsB,CAAC"}

package/dist/manifest-validation.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateManifest = void 0;
+exports.validatePluginManifest = validatePluginManifest;
+const requiredManifestFields = [
+    "id",
+    "name",
+    "version",
+    "author",
+    "description",
+    "license",
+    "lumiaVersion",
+];
+const configArrayFields = [
+    { key: "settings", message: "config.settings must be an array when provided" },
+    { key: "actions", message: "config.actions must be an array when provided" },
+    { key: "variables", message: "config.variables must be an array when provided" },
+    { key: "alerts", message: "config.alerts must be an array when provided" },
+];
+function isNonEmptyString(value) {
+    return typeof value === "string" && value.trim().length > 0;
+}
+function isPlainObject(value) {
+    return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+/**
+ * Perform lightweight validation on a plugin manifest definition.
+ * Returns an array of error strings. An empty array indicates the
+ * manifest passed all heuristics.
+ */
+function validatePluginManifest(manifest) {
+    const errors = [];
+    if (!isPlainObject(manifest)) {
+        return ["Manifest must be a JSON object"];
+    }
+    for (const field of requiredManifestFields) {
+        const value = manifest[field];
+        if (!isNonEmptyString(value)) {
+            errors.push(`Missing or invalid manifest field: ${String(field)}`);
+        }
+    }
+    const category = manifest.category;
+    if (!category || (typeof category !== "string" && !Array.isArray(category))) {
+        errors.push("Manifest must declare a category string");
+    }
+    const config = manifest.config;
+    if (!isPlainObject(config)) {
+        errors.push("Manifest config must be an object");
+    }
+    else {
+        for (const { key, message } of configArrayFields) {
+            const value = config[key];
+            if (value !== undefined && !Array.isArray(value)) {
+                errors.push(message);
+            }
+        }
+    }
+    return errors;
+}
+/**
+ * Convenience alias preserved for backwards compatibility with the CLI.
+ */
+exports.validateManifest = validatePluginManifest;
+exports.default = validatePluginManifest;
+//# sourceMappingURL=manifest-validation.js.map

package/dist/manifest-validation.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"manifest-validation.js","sourceRoot":"","sources":["../src/manifest-validation.ts"],"names":[],"mappings":";;;AAoCA,wDAgCC;AA9DD,MAAM,sBAAsB,GAAgC;IAC1D,IAAI;IACJ,MAAM;IACN,SAAS;IACT,QAAQ;IACR,aAAa;IACb,SAAS;IACT,cAAc;CACf,CAAC;AAEF,MAAM,iBAAiB,GAAoD;IACzE,EAAE,GAAG,EAAE,UAAU,EAAE,OAAO,EAAE,gDAAgD,EAAE;IAC9E,EAAE,GAAG,EAAE,SAAS,EAAE,OAAO,EAAE,+CAA+C,EAAE;IAC5E,EAAE,GAAG,EAAE,WAAW,EAAE,OAAO,EAAE,iDAAiD,EAAE;IAChF,EAAE,GAAG,EAAE,QAAQ,EAAE,OAAO,EAAE,8CAA8C,EAAE;CAC3E,CAAC;AAEF,SAAS,gBAAgB,CAAC,KAAc;IACtC,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC;AAC9D,CAAC;AAED,SAAS,aAAa,CAAC,KAAc;IACnC,OAAO,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;AAC9E,CAAC;AAED;;;;GAIG;AACH,SAAgB,sBAAsB,CAAC,QAA4C;IACjF,MAAM,MAAM,GAAa,EAAE,CAAC;IAE5B,IAAI,CAAC,aAAa,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC7B,OAAO,CAAC,gCAAgC,CAAC,CAAC;IAC5C,CAAC;IAED,KAAK,MAAM,KAAK,IAAI,sBAAsB,EAAE,CAAC;QAC3C,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;QAC9B,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,EAAE,CAAC;YAC7B,MAAM,CAAC,IAAI,CAAC,sCAAsC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QACrE,CAAC;IACH,CAAC;IAED,MAAM,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC;IACnC,IAAI,CAAC,QAAQ,IAAI,CAAC,OAAO,QAAQ,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC;QAC5E,MAAM,CAAC,IAAI,CAAC,yCAAyC,CAAC,CAAC;IACzD,CAAC;IAED,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC;IAC/B,IAAI,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,CAAC;QAC3B,MAAM,CAAC,IAAI,CAAC,mCAAmC,CAAC,CAAC;IACnD,CAAC;SAAM,CAAC;QACN,KAAK,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,IAAI,iBAAiB,EAAE,CAAC;YACjD,MAAM,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;YAC1B,IAAI,KAAK,KAAK,SAAS,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBACjD,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACvB,CAAC;QACH,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;GAEG;AACU,QAAA,gBAAgB,GAAG,sBAAsB,CAAC;AAEvD,kBAAe,sBAAsB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@lumiastream/plugin",
-	"version": "0.1.8",
+	"version": "0.1.9",
 	"description": "Official Lumia Stream Plugin SDK for building Lumia Stream plugins.",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",