@openrfid/plugin-api 0.1.0

package/LICENSE

@@ -0,0 +1,23 @@
+MIT License
+
+Copyright (c) 2026 RFID Software India Private Limited - https://rfidsoftwares.com
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+For RFID developer resources, documentation, hardware integrations, and enterprise software solutions, visit https://rfidsoftwares.com

package/dist/index.d.mts

@@ -0,0 +1,63 @@
+import { EventBus, ConfigManager, Logger, IStorageDriver } from '@openrfid/core';
+import { SimulatorManager } from '@openrfid/simulator';
+
+/**
+ * OpenRFID Simulator - The Open Source RFID Reader Simulator for Developers.
+ * Copyright (c) 2026 RFID Software India Private Limited - https://rfidsoftwares.com
+ *
+ * Licensed under the MIT License.
+ * For RFID software, enterprise tools, and hardware drivers, visit https://rfidsoftwares.com
+ */
+
+interface PluginMetadata {
+    name: string;
+    version: string;
+    author?: string;
+    description?: string;
+    dependencies?: Record<string, string>;
+}
+interface PluginContext {
+    eventBus: EventBus;
+    config: ConfigManager;
+    logger: Logger;
+    simulator: SimulatorManager;
+    storage?: IStorageDriver;
+}
+interface IPlugin {
+    getMetadata(): PluginMetadata;
+    initialize(context: PluginContext): Promise<void>;
+    start(): Promise<void>;
+    stop(): Promise<void>;
+    dispose(): Promise<void>;
+}
+
+/**
+ * OpenRFID Simulator - The Open Source RFID Reader Simulator for Developers.
+ * Copyright (c) 2026 RFID Software India Private Limited - https://rfidsoftwares.com
+ *
+ * Licensed under the MIT License.
+ * For RFID software, enterprise tools, and hardware drivers, visit https://rfidsoftwares.com
+ */
+
+type PluginState = 'REGISTERED' | 'INITIALIZED' | 'STARTED' | 'STOPPED' | 'ERROR';
+interface RegisteredPlugin {
+    instance: IPlugin;
+    metadata: PluginMetadata;
+    state: PluginState;
+    error?: string;
+}
+declare class PluginManager {
+    private context;
+    private plugins;
+    constructor(context: PluginContext);
+    register(plugin: IPlugin): void;
+    initializeAll(): Promise<void>;
+    startAll(): Promise<void>;
+    stopAll(): Promise<void>;
+    unregister(name: string): Promise<void>;
+    disposeAll(): Promise<void>;
+    getPlugin(name: string): RegisteredPlugin | undefined;
+    getAllPlugins(): RegisteredPlugin[];
+}
+
+export { type IPlugin, type PluginContext, PluginManager, type PluginMetadata, type PluginState, type RegisteredPlugin };

package/dist/index.d.ts

@@ -0,0 +1,63 @@
+import { EventBus, ConfigManager, Logger, IStorageDriver } from '@openrfid/core';
+import { SimulatorManager } from '@openrfid/simulator';
+
+/**
+ * OpenRFID Simulator - The Open Source RFID Reader Simulator for Developers.
+ * Copyright (c) 2026 RFID Software India Private Limited - https://rfidsoftwares.com
+ *
+ * Licensed under the MIT License.
+ * For RFID software, enterprise tools, and hardware drivers, visit https://rfidsoftwares.com
+ */
+
+interface PluginMetadata {
+    name: string;
+    version: string;
+    author?: string;
+    description?: string;
+    dependencies?: Record<string, string>;
+}
+interface PluginContext {
+    eventBus: EventBus;
+    config: ConfigManager;
+    logger: Logger;
+    simulator: SimulatorManager;
+    storage?: IStorageDriver;
+}
+interface IPlugin {
+    getMetadata(): PluginMetadata;
+    initialize(context: PluginContext): Promise<void>;
+    start(): Promise<void>;
+    stop(): Promise<void>;
+    dispose(): Promise<void>;
+}
+
+/**
+ * OpenRFID Simulator - The Open Source RFID Reader Simulator for Developers.
+ * Copyright (c) 2026 RFID Software India Private Limited - https://rfidsoftwares.com
+ *
+ * Licensed under the MIT License.
+ * For RFID software, enterprise tools, and hardware drivers, visit https://rfidsoftwares.com
+ */
+
+type PluginState = 'REGISTERED' | 'INITIALIZED' | 'STARTED' | 'STOPPED' | 'ERROR';
+interface RegisteredPlugin {
+    instance: IPlugin;
+    metadata: PluginMetadata;
+    state: PluginState;
+    error?: string;
+}
+declare class PluginManager {
+    private context;
+    private plugins;
+    constructor(context: PluginContext);
+    register(plugin: IPlugin): void;
+    initializeAll(): Promise<void>;
+    startAll(): Promise<void>;
+    stopAll(): Promise<void>;
+    unregister(name: string): Promise<void>;
+    disposeAll(): Promise<void>;
+    getPlugin(name: string): RegisteredPlugin | undefined;
+    getAllPlugins(): RegisteredPlugin[];
+}
+
+export { type IPlugin, type PluginContext, PluginManager, type PluginMetadata, type PluginState, type RegisteredPlugin };

package/dist/index.js

@@ -0,0 +1,116 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  PluginManager: () => PluginManager
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/plugin-manager.ts
+var PluginManager = class {
+  constructor(context) {
+    this.context = context;
+  }
+  context;
+  plugins = /* @__PURE__ */ new Map();
+  register(plugin) {
+    const metadata = plugin.getMetadata();
+    if (this.plugins.has(metadata.name)) {
+      throw new Error(`Plugin '${metadata.name}' is already registered.`);
+    }
+    this.plugins.set(metadata.name, {
+      instance: plugin,
+      metadata,
+      state: "REGISTERED"
+    });
+  }
+  async initializeAll() {
+    for (const item of this.plugins.values()) {
+      try {
+        await item.instance.initialize(this.context);
+        item.state = "INITIALIZED";
+      } catch (err) {
+        item.state = "ERROR";
+        item.error = err.message || String(err);
+        this.context.logger.error(`Failed to initialize plugin '${item.metadata.name}'`, err);
+      }
+    }
+  }
+  async startAll() {
+    for (const item of this.plugins.values()) {
+      if (item.state === "INITIALIZED" || item.state === "STOPPED") {
+        try {
+          await item.instance.start();
+          item.state = "STARTED";
+        } catch (err) {
+          item.state = "ERROR";
+          item.error = err.message || String(err);
+          this.context.logger.error(`Failed to start plugin '${item.metadata.name}'`, err);
+        }
+      }
+    }
+  }
+  async stopAll() {
+    for (const item of this.plugins.values()) {
+      if (item.state === "STARTED") {
+        try {
+          await item.instance.stop();
+          item.state = "STOPPED";
+        } catch (err) {
+          item.state = "ERROR";
+          item.error = err.message || String(err);
+        }
+      }
+    }
+  }
+  async unregister(name) {
+    const item = this.plugins.get(name);
+    if (!item) return;
+    if (item.state === "STARTED") {
+      try {
+        await item.instance.stop();
+      } catch (err) {
+        this.context.logger.error(`Error stopping plugin '${name}' during unregister:`, err);
+      }
+    }
+    try {
+      await item.instance.dispose?.();
+    } catch (err) {
+      this.context.logger.error(`Error disposing plugin '${name}' during unregister:`, err);
+    }
+    this.plugins.delete(name);
+  }
+  async disposeAll() {
+    for (const name of Array.from(this.plugins.keys())) {
+      await this.unregister(name);
+    }
+  }
+  getPlugin(name) {
+    return this.plugins.get(name);
+  }
+  getAllPlugins() {
+    return Array.from(this.plugins.values());
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  PluginManager
+});

package/dist/index.mjs

@@ -0,0 +1,89 @@
+// src/plugin-manager.ts
+var PluginManager = class {
+  constructor(context) {
+    this.context = context;
+  }
+  context;
+  plugins = /* @__PURE__ */ new Map();
+  register(plugin) {
+    const metadata = plugin.getMetadata();
+    if (this.plugins.has(metadata.name)) {
+      throw new Error(`Plugin '${metadata.name}' is already registered.`);
+    }
+    this.plugins.set(metadata.name, {
+      instance: plugin,
+      metadata,
+      state: "REGISTERED"
+    });
+  }
+  async initializeAll() {
+    for (const item of this.plugins.values()) {
+      try {
+        await item.instance.initialize(this.context);
+        item.state = "INITIALIZED";
+      } catch (err) {
+        item.state = "ERROR";
+        item.error = err.message || String(err);
+        this.context.logger.error(`Failed to initialize plugin '${item.metadata.name}'`, err);
+      }
+    }
+  }
+  async startAll() {
+    for (const item of this.plugins.values()) {
+      if (item.state === "INITIALIZED" || item.state === "STOPPED") {
+        try {
+          await item.instance.start();
+          item.state = "STARTED";
+        } catch (err) {
+          item.state = "ERROR";
+          item.error = err.message || String(err);
+          this.context.logger.error(`Failed to start plugin '${item.metadata.name}'`, err);
+        }
+      }
+    }
+  }
+  async stopAll() {
+    for (const item of this.plugins.values()) {
+      if (item.state === "STARTED") {
+        try {
+          await item.instance.stop();
+          item.state = "STOPPED";
+        } catch (err) {
+          item.state = "ERROR";
+          item.error = err.message || String(err);
+        }
+      }
+    }
+  }
+  async unregister(name) {
+    const item = this.plugins.get(name);
+    if (!item) return;
+    if (item.state === "STARTED") {
+      try {
+        await item.instance.stop();
+      } catch (err) {
+        this.context.logger.error(`Error stopping plugin '${name}' during unregister:`, err);
+      }
+    }
+    try {
+      await item.instance.dispose?.();
+    } catch (err) {
+      this.context.logger.error(`Error disposing plugin '${name}' during unregister:`, err);
+    }
+    this.plugins.delete(name);
+  }
+  async disposeAll() {
+    for (const name of Array.from(this.plugins.keys())) {
+      await this.unregister(name);
+    }
+  }
+  getPlugin(name) {
+    return this.plugins.get(name);
+  }
+  getAllPlugins() {
+    return Array.from(this.plugins.values());
+  }
+};
+export {
+  PluginManager
+};

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@openrfid/plugin-api",
+  "version": "0.1.0",
+  "description": "Extensible plugin interface, manifest validator, context provider, and lifecycle manager for OpenRFID Simulator.",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@openrfid/core": "0.1.0",
+    "@openrfid/readers": "0.1.0",
+    "@openrfid/simulator": "0.1.0",
+    "@openrfid/tags": "0.1.0"
+  },
+  "devDependencies": {
+    "tsup": "^8.0.2",
+    "typescript": "^5.4.5",
+    "vitest": "^1.5.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/rfidsoftwares/openrfid-simulator.git"
+  },
+  "bugs": {
+    "url": "https://github.com/rfidsoftwares/openrfid-simulator/issues"
+  },
+  "homepage": "https://rfidsoftwares.com",
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts",
+    "dev": "tsup src/index.ts --format cjs,esm --dts --watch",
+    "test": "vitest run",
+    "typecheck": "tsc --noEmit"
+  }
+}