@camera.ui/browser 0.0.1

package/dist/src/plugins/plugin.d.ts

@@ -0,0 +1,47 @@
+/**
+ *
+ * @url https://github.com/homebridge/homebridge/blob/src/plugin.ts
+ * (c) Homebridge <https://github.com/homebridge>
+ *
+ **/
+import { PluginConfigService } from './config';
+import type { CameraUiAPI, PluginConstructor } from '../api';
+import type { IPackageJson, CameraUiPlugin } from '../api/types';
+import type { PluginContract } from './types';
+export interface Context {
+    engines?: Record<string, string>;
+    dependencies?: Record<string, string>;
+}
+/**
+ * Represents a loaded camera.ui plugin.
+ */
+export declare class Plugin {
+    disabled: boolean;
+    private logger;
+    private configService;
+    private _info;
+    private _contract;
+    readonly id: string;
+    readonly pluginName: string;
+    readonly displayName: string;
+    readonly scope?: string;
+    private readonly isESM;
+    config: PluginConfigService;
+    readonly isSymLink: boolean;
+    readonly installPath: string;
+    readonly configFile: string;
+    readonly storagePath: string;
+    private readonly main;
+    private loadContext?;
+    private pluginInitializer?;
+    private pluginConstructor;
+    get info(): CameraUiPlugin;
+    get contract(): PluginContract;
+    constructor(pluginName: string, installPath: string, packageJSON: IPackageJson, pluginId: string, scope?: string, storagePath?: string);
+    getPluginConstructor(pluginName: string): PluginConstructor;
+    initialize(api: CameraUiAPI): void | Promise<void>;
+    load(): Promise<void>;
+    registerPlugin(constructor: PluginConstructor, contract: PluginContract): void;
+    reparsePackageJson(): CameraUiPlugin;
+    private parsePackageJson;
+}

package/dist/src/plugins/plugin.js

@@ -0,0 +1,215 @@
+"use strict";
+/**
+ *
+ * @url https://github.com/homebridge/homebridge/blob/src/plugin.ts
+ * (c) Homebridge <https://github.com/homebridge>
+ *
+ **/
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Plugin = void 0;
+const assert_1 = __importDefault(require("assert"));
+const compare_versions_1 = __importDefault(require("compare-versions"));
+const path_1 = __importDefault(require("path"));
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const url_1 = require("url");
+const tsyringe_1 = require("tsyringe");
+const _1 = require(".");
+const config_1 = require("./config");
+const config_2 = require("../services/config");
+// Workaround for https://github.com/microsoft/TypeScript/issues/43329
+const _importDynamic = new Function('modulePath', 'return import(modulePath)');
+/**
+ * Represents a loaded camera.ui plugin.
+ */
+let Plugin = class Plugin {
+    disabled = false;
+    logger;
+    configService;
+    // private _id!: string;
+    _info;
+    _contract;
+    id;
+    pluginName;
+    displayName;
+    scope;
+    isESM;
+    config;
+    isSymLink;
+    installPath;
+    configFile;
+    storagePath;
+    main;
+    loadContext;
+    pluginInitializer; // default exported function from the plugin that initializes it
+    pluginConstructor = new Map();
+    get info() {
+        return this._info;
+    }
+    get contract() {
+        return this._contract;
+    }
+    constructor(pluginName, installPath, packageJSON, pluginId, scope, storagePath) {
+        this.logger = tsyringe_1.container.resolve('logger');
+        this.configService = tsyringe_1.container.resolve('configService');
+        this.id = pluginId;
+        this._info = this.parsePackageJson(packageJSON, installPath);
+        this.pluginName = pluginName;
+        this.displayName = this.info.displayName;
+        this.scope = scope;
+        this.installPath = installPath;
+        this.main = '';
+        this.isSymLink = fs_extra_1.default.lstatSync(this.installPath).isSymbolicLink();
+        this.storagePath = path_1.default.resolve(storagePath || this.configService.PLUGINS_STORAGE_PATH, this.pluginName);
+        this.configFile = path_1.default.resolve(this.storagePath, 'config.json');
+        this.config = new config_1.PluginConfigService(this.configFile);
+        // figure out the main module
+        // exports is available - https://nodejs.org/dist/latest-v14.x/docs/api/packages.html#packages_package_entry_points
+        if (packageJSON.exports) {
+            // main entrypoint - https://nodejs.org/dist/latest-v14.x/docs/api/packages.html#packages_main_entry_point_export
+            if (typeof packageJSON.exports === 'string') {
+                this.main = packageJSON.exports;
+            }
+            else {
+                // subpath export - https://nodejs.org/dist/latest-v14.x/docs/api/packages.html#packages_subpath_exports
+                // conditional exports - https://nodejs.org/dist/latest-v14.x/docs/api/packages.html#packages_conditional_exports
+                const exports = packageJSON.exports.import || packageJSON.exports.require || packageJSON.exports.node || packageJSON.exports.default || packageJSON.exports['.'];
+                // check if conditional export is nested
+                if (typeof exports !== 'string') {
+                    if (exports.import) {
+                        this.main = exports.import;
+                    }
+                    else {
+                        this.main = exports.require || exports.node || exports.default;
+                    }
+                }
+                else {
+                    this.main = exports;
+                }
+            }
+        }
+        // exports search was not successful, fallback to package.main, using index.js as fallback
+        if (!this.main) {
+            this.main = packageJSON.main || './index.js';
+        }
+        // check if it is a ESM module
+        this.isESM = this.main.endsWith('.mjs') || (this.main.endsWith('.js') && packageJSON.type === 'module');
+        this.loadContext = {
+            engines: packageJSON.engines,
+            dependencies: packageJSON.dependencies,
+        };
+    }
+    getPluginConstructor(pluginName) {
+        const constructor = this.pluginConstructor.get(pluginName);
+        if (!constructor) {
+            throw new Error(`The requested plugin '${pluginName}' was not registered by the plugin '${this.pluginName}'.`);
+        }
+        return constructor;
+    }
+    initialize(api) {
+        if (!this.pluginInitializer) {
+            throw new Error("Tried to initialize a plugin which hasn't been loaded yet!");
+        }
+        return this.pluginInitializer(api);
+    }
+    async load() {
+        const context = this.loadContext;
+        (0, assert_1.default)(context, 'Reached illegal state. Plugin state is undefined!');
+        this.loadContext = undefined;
+        // pluck out the camera.ui version requirement
+        if (!context.engines || !context.engines['camera.ui']) {
+            throw new Error(`Plugin ${this.installPath} does not contain the 'camera.ui' package in 'engines'.`);
+        }
+        const versionRequired = context.engines['camera.ui'];
+        const nodeVersionRequired = context.engines.node;
+        // make sure the version is satisfied by the currently running version of camera.ui
+        if (!compare_versions_1.default.compare(config_2.ConfigService.VERSION.replace(/[^\d.]/g, ''), versionRequired.replace(/[^\d.]/g, ''), '>=')) {
+            this.logger.warn(`The plugin "${this.pluginName}" requires a camera.ui version of ${versionRequired} which does \
+not satisfy the current camera.ui version of ${config_2.ConfigService.VERSION}. You may need to update this plugin (or camera.ui) to a newer version. \
+You may face unexpected issues or stability problems running this plugin.`);
+        }
+        // make sure the version is satisfied by the currently running version of Node
+        if (nodeVersionRequired && !compare_versions_1.default.compare(process.version, nodeVersionRequired.replace(/[^\d.]/g, ''), '>=')) {
+            this.logger.warn(`The plugin "${this.pluginName}" requires Node.js version of ${nodeVersionRequired} which does \
+not satisfy the current Node.js version of ${process.version}. You may need to upgrade your installation of Node.js`);
+        }
+        const dependencies = context.dependencies || {};
+        if (dependencies['camera.ui']) {
+            this.logger.error(`The plugin "${this.pluginName}" defines 'camera.ui' in their 'dependencies' section, \
+meaning they carry an additional copy of camera.ui. This not only wastes disk space, but also can cause \
+major incompatibility issues and thus is considered bad practice. Please inform the developer to update their plugin!`);
+        }
+        const mainPath = path_1.default.join(this.installPath, this.main);
+        const pluginModules = this.isESM ? await _importDynamic((0, url_1.pathToFileURL)(mainPath).href) : require(mainPath);
+        if (typeof pluginModules === 'function') {
+            this.pluginInitializer = pluginModules;
+        }
+        else if (pluginModules && typeof pluginModules.default === 'function') {
+            this.pluginInitializer = pluginModules.default;
+        }
+        else {
+            throw new Error(`Plugin ${this.installPath} does not export a initializer function from main.`);
+        }
+    }
+    registerPlugin(constructor, contract) {
+        if (this.pluginConstructor.has(contract.pluginName)) {
+            throw new Error(`Plugin '${contract.pluginName}' tried to register '${contract.pluginName}' which has already been registered!`);
+        }
+        this._contract = {
+            // displayName: contract.displayName,
+            pluginName: contract.pluginName,
+            builtIns: contract.builtIns || [],
+            extension: contract.extension,
+        };
+        this.pluginConstructor.set(contract.pluginName, constructor);
+    }
+    reparsePackageJson() {
+        const pjson = _1.PluginManager.loadPackageJSON(this.installPath);
+        this._info = this.parsePackageJson(pjson, this.installPath);
+        return this._info;
+    }
+    parsePackageJson(pjson, installPath) {
+        const pluginPackageJson = {
+            id: this.id,
+            disabled: this.configService.config?.plugins?.disabledPlugins?.includes(this.pluginName) || false,
+            private: pjson.private || false,
+            pluginName: pjson.name,
+            displayName: pjson.displayName || _1.PluginManager.transformDisplaName(pjson.name),
+            author: pjson.author ? (typeof pjson.author === 'string' ? pjson.author : pjson.author.name) : undefined,
+            description: pjson.description ? pjson.description.replace(/(?:https?|ftp):\/\/[\n\S]+/g, '').trim() : pjson.name,
+            installedVersion: pjson.version || '0.0.0',
+            latestVersion: pjson.version || '0.0.0',
+            globalInstall: false,
+            publicPackage: pjson.private || false,
+            engines: pjson.engines,
+            installPath,
+            links: {
+                npm: `https://www.npmjs.com/package/${this.pluginName}`,
+                homepage: pjson.homepage,
+            },
+        };
+        return pluginPackageJson;
+    }
+};
+exports.Plugin = Plugin;
+exports.Plugin = Plugin = __decorate([
+    (0, tsyringe_1.registry)([
+        {
+            token: 'configService',
+            useValue: (0, tsyringe_1.delay)(() => config_2.ConfigService),
+        },
+    ]),
+    __metadata("design:paramtypes", [String, String, Object, String, String, String])
+], Plugin);
+//# sourceMappingURL=plugin.js.map

package/dist/src/plugins/plugin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"plugin.js","sourceRoot":"","sources":["../../../../../src/plugins/plugin.ts"],"names":[],"mappings":";AAAA;;;;;IAKI;;;;;;;;;;;;;;;AAEJ,oDAA4B;AAC5B,wEAA+C;AAC/C,gDAAwB;AACxB,wDAA0B;AAC1B,6BAAoC;AACpC,uCAAsD;AAEtD,wBAAkC;AAClC,qCAA+C;AAC/C,+CAAmD;AAanD,sEAAsE;AACtE,MAAM,cAAc,GAAG,IAAI,QAAQ,CAAC,YAAY,EAAE,2BAA2B,CAAC,CAAC;AAE/E;;GAEG;AAOI,IAAM,MAAM,GAAZ,MAAM,MAAM;IACV,QAAQ,GAAG,KAAK,CAAC;IAEhB,MAAM,CAAS;IACf,aAAa,CAAgB;IAErC,wBAAwB;IAChB,KAAK,CAAkB;IACvB,SAAS,CAAkB;IAEnB,EAAE,CAAS;IAEX,UAAU,CAAS;IACnB,WAAW,CAAS;IACpB,KAAK,CAAU;IACd,KAAK,CAAU;IAEzB,MAAM,CAAsB;IAEnB,SAAS,CAAU;IACnB,WAAW,CAAS;IACpB,UAAU,CAAS;IACnB,WAAW,CAAS;IAEnB,IAAI,CAAS;IACtB,WAAW,CAAW;IAEtB,iBAAiB,CAAqB,CAAC,gEAAgE;IACvG,iBAAiB,GAAG,IAAI,GAAG,EAA6B,CAAC;IAEjE,IAAW,IAAI;QACb,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,YAAY,UAAkB,EAAE,WAAmB,EAAE,WAAyB,EAAE,QAAgB,EAAE,KAAc,EAAE,WAAoB;QACpI,IAAI,CAAC,MAAM,GAAG,oBAAS,CAAC,OAAO,CAAS,QAAQ,CAAC,CAAC;QAClD,IAAI,CAAC,aAAa,GAAG,oBAAS,CAAC,OAAO,CAAgB,eAAe,CAAC,CAAC;QAEvE,IAAI,CAAC,EAAE,GAAG,QAAQ,CAAC;QAEnB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,gBAAgB,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC;QAE7D,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC;QACzC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;QAC/B,IAAI,CAAC,IAAI,GAAG,EAAE,CAAC;QAEf,IAAI,CAAC,SAAS,GAAG,kBAAE,CAAC,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,cAAc,EAAE,CAAC;QACjE,IAAI,CAAC,WAAW,GAAG,cAAI,CAAC,OAAO,CAAC,WAAW,IAAI,IAAI,CAAC,aAAa,CAAC,oBAAoB,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;QACzG,IAAI,CAAC,UAAU,GAAG,cAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC;QAEhE,IAAI,CAAC,MAAM,GAAG,IAAI,4BAAmB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAEvD,6BAA6B;QAC7B,mHAAmH;QACnH,IAAI,WAAW,CAAC,OAAO,EAAE,CAAC;YACxB,iHAAiH;YACjH,IAAI,OAAO,WAAW,CAAC,OAAO,KAAK,QAAQ,EAAE,CAAC;gBAC5C,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC,OAAO,CAAC;YAClC,CAAC;iBAAM,CAAC;gBACN,wGAAwG;gBACxG,iHAAiH;gBACjH,MAAM,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC,MAAM,IAAI,WAAW,CAAC,OAAO,CAAC,OAAO,IAAI,WAAW,CAAC,OAAO,CAAC,IAAI,IAAI,WAAW,CAAC,OAAO,CAAC,OAAO,IAAI,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;gBAEjK,wCAAwC;gBACxC,IAAI,OAAO,OAAO,KAAK,QAAQ,EAAE,CAAC;oBAChC,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;wBACnB,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,MAAM,CAAC;oBAC7B,CAAC;yBAAM,CAAC;wBACN,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,OAAO,IAAI,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,OAAO,CAAC;oBACjE,CAAC;gBACH,CAAC;qBAAM,CAAC;oBACN,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC;gBACtB,CAAC;YACH,CAAC;QACH,CAAC;QAED,0FAA0F;QAC1F,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;YACf,IAAI,CAAC,IAAI,GAAG,WAAW,CAAC,IAAI,IAAI,YAAY,CAAC;QAC/C,CAAC;QAED,8BAA8B;QAC9B,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,WAAW,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC;QAExG,IAAI,CAAC,WAAW,GAAG;YACjB,OAAO,EAAE,WAAW,CAAC,OAAO;YAC5B,YAAY,EAAE,WAAW,CAAC,YAAY;SACvC,CAAC;IACJ,CAAC;IAEM,oBAAoB,CAAC,UAAkB;QAC5C,MAAM,WAAW,GAAG,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,UAAU,CAAC,CAAC;QAE3D,IAAI,CAAC,WAAW,EAAE,CAAC;YACjB,MAAM,IAAI,KAAK,CAAC,yBAAyB,UAAU,uCAAuC,IAAI,CAAC,UAAU,IAAI,CAAC,CAAC;QACjH,CAAC;QAED,OAAO,WAAW,CAAC;IACrB,CAAC;IAEM,UAAU,CAAC,GAAgB;QAChC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC5B,MAAM,IAAI,KAAK,CAAC,4DAA4D,CAAC,CAAC;QAChF,CAAC;QAED,OAAO,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC;IACrC,CAAC;IAEM,KAAK,CAAC,IAAI;QACf,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC;QACjC,IAAA,gBAAM,EAAC,OAAO,EAAE,mDAAmD,CAAC,CAAC;QAErE,IAAI,CAAC,WAAW,GAAG,SAAS,CAAC;QAE7B,8CAA8C;QAC9C,IAAI,CAAC,OAAO,CAAC,OAAO,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;YACtD,MAAM,IAAI,KAAK,CAAC,UAAU,IAAI,CAAC,WAAW,yDAAyD,CAAC,CAAC;QACvG,CAAC;QAED,MAAM,eAAe,GAAG,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;QACrD,MAAM,mBAAmB,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC;QAEjD,mFAAmF;QACnF,IAAI,CAAC,0BAAe,CAAC,OAAO,CAAC,sBAAa,CAAC,OAAO,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,EAAE,eAAe,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,EAAE,IAAI,CAAC,EAAE,CAAC;YACzH,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,eAAe,IAAI,CAAC,UAAU,qCAAqC,eAAe;+CAC1D,sBAAa,CAAC,OAAO;0EACM,CAAC,CAAC;QACxE,CAAC;QAED,8EAA8E;QAC9E,IAAI,mBAAmB,IAAI,CAAC,0BAAe,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,EAAE,mBAAmB,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,EAAE,IAAI,CAAC,EAAE,CAAC;YACvH,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,eAAe,IAAI,CAAC,UAAU,iCAAiC,mBAAmB;6CAC5D,OAAO,CAAC,OAAO,wDAAwD,CAAC,CAAC;QAClH,CAAC;QAED,MAAM,YAAY,GAAG,OAAO,CAAC,YAAY,IAAI,EAAE,CAAC;QAChD,IAAI,YAAY,CAAC,WAAW,CAAC,EAAE,CAAC;YAC9B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,eAAe,IAAI,CAAC,UAAU;;sHAEgE,CAAC,CAAC;QACpH,CAAC;QAED,MAAM,QAAQ,GAAG,cAAI,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QACxD,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,cAAc,CAAC,IAAA,mBAAa,EAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAE1G,IAAI,OAAO,aAAa,KAAK,UAAU,EAAE,CAAC;YACxC,IAAI,CAAC,iBAAiB,GAAG,aAAa,CAAC;QACzC,CAAC;aAAM,IAAI,aAAa,IAAI,OAAO,aAAa,CAAC,OAAO,KAAK,UAAU,EAAE,CAAC;YACxE,IAAI,CAAC,iBAAiB,GAAG,aAAa,CAAC,OAAO,CAAC;QACjD,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,KAAK,CAAC,UAAU,IAAI,CAAC,WAAW,oDAAoD,CAAC,CAAC;QAClG,CAAC;IACH,CAAC;IAEM,cAAc,CAAC,WAA8B,EAAE,QAAwB;QAC5E,IAAI,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE,CAAC;YACpD,MAAM,IAAI,KAAK,CAAC,WAAW,QAAQ,CAAC,UAAU,wBAAwB,QAAQ,CAAC,UAAU,sCAAsC,CAAC,CAAC;QACnI,CAAC;QAED,IAAI,CAAC,SAAS,GAAG;YACf,qCAAqC;YACrC,UAAU,EAAE,QAAQ,CAAC,UAAU;YAC/B,QAAQ,EAAE,QAAQ,CAAC,QAAQ,IAAI,EAAE;YACjC,SAAS,EAAE,QAAQ,CAAC,SAAS;SAC9B,CAAC;QAEF,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,QAAQ,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC;IAC/D,CAAC;IAEM,kBAAkB;QACvB,MAAM,KAAK,GAAG,gBAAa,CAAC,eAAe,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAC9D,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,gBAAgB,CAAC,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;QAC5D,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAEO,gBAAgB,CAAC,KAAmB,EAAE,WAAmB;QAC/D,MAAM,iBAAiB,GAAmB;YACxC,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,QAAQ,EAAE,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,OAAO,EAAE,eAAe,EAAE,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,KAAK;YACjG,OAAO,EAAE,KAAK,CAAC,OAAO,IAAI,KAAK;YAC/B,UAAU,EAAE,KAAK,CAAC,IAAI;YACtB,WAAW,EAAE,KAAK,CAAC,WAAW,IAAI,gBAAa,CAAC,mBAAmB,CAAC,KAAK,CAAC,IAAI,CAAC;YAC/E,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,OAAO,KAAK,CAAC,MAAM,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS;YACxG,WAAW,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,6BAA6B,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI;YACjH,gBAAgB,EAAE,KAAK,CAAC,OAAO,IAAI,OAAO;YAC1C,aAAa,EAAE,KAAK,CAAC,OAAO,IAAI,OAAO;YACvC,aAAa,EAAE,KAAK;YACpB,aAAa,EAAE,KAAK,CAAC,OAAO,IAAI,KAAK;YACrC,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,WAAW;YACX,KAAK,EAAE;gBACL,GAAG,EAAE,iCAAiC,IAAI,CAAC,UAAU,EAAE;gBACvD,QAAQ,EAAE,KAAK,CAAC,QAAQ;aACzB;SACF,CAAC;QAEF,OAAO,iBAAiB,CAAC;IAC3B,CAAC;CACF,CAAA;AA5MY,wBAAM;iBAAN,MAAM;IANlB,IAAA,mBAAQ,EAAC;QACR;YACE,KAAK,EAAE,eAAe;YACtB,QAAQ,EAAE,IAAA,gBAAK,EAAC,GAAG,EAAE,CAAC,sBAAa,CAAC;SACrC;KACF,CAAC;;GACW,MAAM,CA4MlB"}

package/dist/src/plugins/schema.d.ts

@@ -0,0 +1,268 @@
+import { type ZodTypeAny, z } from 'zod';
+import type { RootSchema, JsonSchema, JsonSchemaString, JsonSchemaAnyOf, JsonSchemaArray, JsonSchemaBoolean, JsonSchemaButton, JsonSchemaEnum, JsonSchemaNumber, JsonSchemaObject, JsonSchemaObjectWithButtons, PluginJsonSchema, PluginRootSchema, PluginJsonSchemaForm } from './types';
+type RootZodSchema = z.ZodObject<Record<string, ZodTypeAny>, 'strict', ZodTypeAny, {
+    [x: string]: any;
+}, {
+    [x: string]: any;
+}>;
+type OptionalZodString = z.ZodOptional<z.ZodString> | z.ZodString | z.ZodOptional<z.ZodEffects<z.ZodString, string, string>> | z.ZodEffects<z.ZodString, string, string>;
+type OptionalZodNumber = z.ZodOptional<z.ZodNumber> | z.ZodNumber | z.ZodOptional<z.ZodEffects<z.ZodNumber, number, number>> | z.ZodEffects<z.ZodNumber, number, number>;
+type OptionalZodBoolean = z.ZodOptional<z.ZodBoolean> | z.ZodBoolean;
+type OptionalZodZobject = z.ZodOptional<z.ZodObject<Record<string, z.ZodTypeAny>, 'strict', z.ZodTypeAny, {
+    [x: string]: any;
+}, {
+    [x: string]: any;
+}>> | z.ZodObject<Record<string, z.ZodTypeAny>, 'strict', z.ZodTypeAny, {
+    [x: string]: any;
+}, {
+    [x: string]: any;
+}> | z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>> | z.ZodRecord<z.ZodString, z.ZodAny>;
+type OptionalZodArray = z.ZodOptional<z.ZodType<any, any, any>> | z.ZodType<any, any, any>;
+type OptionalZodEnum = z.ZodOptional<z.ZodUnion<[z.ZodTypeAny, z.ZodTypeAny, ...z.ZodTypeAny[]]>> | z.ZodUnion<[z.ZodTypeAny, z.ZodTypeAny, ...z.ZodTypeAny[]]>;
+type OptionalZodEnumMultiple = z.ZodOptional<z.ZodArray<z.ZodUnion<[ZodTypeAny, ZodTypeAny, ...ZodTypeAny[]]>, 'many'>> | z.ZodArray<z.ZodUnion<[ZodTypeAny, ZodTypeAny, ...ZodTypeAny[]]>, 'many'>;
+type ZodAny = z.ZodType<any, any, any>;
+/**
+ * Generate root JSON schema from value.
+ *
+ * @param value - Value.
+ * @returns - Root JSON schema.
+ */
+export declare const generateRootSchema: (value: Record<string, any>) => RootSchema;
+/**
+ * Generate JSON schema from value.
+ *
+ * @param value - Value.
+ * @returns - JSON schema.
+ */
+export declare const generateSchema: (value: any) => JsonSchema;
+/**
+ * Generate a JSON object from a given Root JSON schema.
+ *
+ * @param rootSchema - The Root JSON schema.
+ * @returns - The generated JSON object.
+ */
+export declare const generateJsonFromRootSchema: (rootSchema: RootSchema | PluginRootSchema) => Record<string, any>;
+/**
+ * Generate a JSON object from a JSON schema.
+ *
+ * @param jsonSchema - The JSON schema.
+ * @returns - The generated JSON object.
+ */
+export declare const generateJsonFromSchema: (jsonSchema: JsonSchema | PluginJsonSchema) => any;
+/**
+ * Generate a JSON object from a given JSON schema and use values from a config file.
+ *
+ * @param jsonSchema - The JSON schema.
+ * @param config - The config file with values to use.
+ * @returns - The generated JSON object.
+ */
+export declare const generateJsonFromSchemaWithConfig: (jsonSchema: JsonSchema | PluginJsonSchema, config: Record<string, any>, path?: string) => any;
+/**
+ * Removes all functions from a given Plugin JSON schema form.
+ *
+ * @param schemaForm - The Plugin JSON schema form from which the functions should be removed.
+ * @returns - The Plugin JSON schema form without functions.
+ */
+export declare const removeFunctionsFromSchemaForm: (schemaForm: PluginJsonSchemaForm) => PluginJsonSchemaForm;
+/**
+ * Removes all functions from a given Plugin JSON schema.
+ *
+ * @param jsonSchema - The JSON schema from which the functions should be removed.
+ * @returns - The JSON schema without functions.
+ */
+export declare const removeFunctionsFromSchema: (jsonSchema: PluginJsonSchema) => PluginJsonSchema;
+/**
+ * Converts a config path to a schema path.
+ *
+ * @param configPath - The config path to be converted.
+ * @returns - The converted schema path.
+ */
+export declare const configPathToSchemaPath: (configPath: string) => string;
+/**
+ * Converts a schema path to a config path.
+ *
+ * @param schemaPath - The schema path to be converted.
+ * @returns - The converted config path.
+ */
+export declare const schemaPathToConfigPath: (schemaPath: string) => string;
+/**
+ * Recursively searches a JSON object for a specific, potentially nested key path and returns its value.
+ *
+ * @param obj - The JSON object to be searched.
+ * @param path - The key path to search for.
+ * @returns - The value of the searched key path, if found, otherwise undefined.
+ */
+export declare const getValueByPath: (obj: any, path: string) => any;
+/**
+ * Generates a Zod schema from a given JSON schema.
+ *
+ * @param jsonSchema - The JSON schema from which the Zod schema should be generated.
+ * @returns - The generated Zod schema.
+ */
+export declare const generateZodSchemaFromRoot: (rootSchema: RootSchema) => RootZodSchema;
+/**
+ * Generates a Zod schema from a given JSON schema.
+ *
+ * @param jsonSchema - The JSON schema from which the Zod schema should be generated.
+ * @param initial - A boolean indicating whether this is the initial call to the function.
+ *                  This is used for handling nested schemas.
+ * @returns - The generated Zod schema.
+ */
+export declare const generateZodSchema: (jsonSchema: JsonSchema) => ZodAny;
+/**
+ * Generates a JSON schema for a number.
+ *
+ * @param value - The number for which the JSON schema should be generated.
+ * @returns - The generated JSON schema for the number.
+ */
+export declare const generateNumberSchema: (value: number) => JsonSchemaNumber;
+/**
+ * Generates a JSON schema for a boolean.
+ *
+ * @param value - The boolean for which the JSON schema should be generated.
+ * @returns - The generated JSON schema for the boolean.
+ */
+export declare const genereateBooleanSchema: (value: boolean) => JsonSchemaBoolean;
+/**
+ * Generates a JSON schema for a string.
+ *
+ * @param value - The string for which the JSON schema should be generated.
+ * @returns - The generated JSON schema for the string.
+ */
+export declare const generateStringSchema: (value: string) => JsonSchemaString;
+/**
+ * Generates a JSON schema for an enum.
+ *
+ * @param value - The enum for which the JSON schema should be generated.
+ * @param type - The type of the enum.
+ * @returns - The generated JSON schema for the enum.
+ */
+export declare const generateEnumSchema: (value: (string | number | boolean)[], type: 'string' | 'number' | 'boolean') => JsonSchemaEnum;
+/**
+ * Generates a JSON schema for an object.
+ *
+ * @param value - The object for which the JSON schema should be generated.
+ * @returns - The generated JSON schema for the object.
+ */
+export declare const generateObjectSchema: (value: Record<string, any>) => JsonSchemaObject;
+/**
+ * Generates a JSON schema for an object including up to two buttons.
+ *
+ * @param value - The object for which the JSON schema should be generated.
+ * @param buttons - Array of min one button and up to two buttons to be included in the schema.
+ * @returns - The generated JSON schema for the object.
+ */
+export declare const generateObjectSchemaWithButtons: (value: Record<string, any>, buttons: [JsonSchemaButton, JsonSchemaButton?]) => JsonSchemaObjectWithButtons;
+/**
+ * Generates a JSON schema for an array.
+ *
+ * @param array - The array for which the JSON schema should be generated.
+ * @returns - The generated JSON schema for the array.
+ */
+export declare const generateArraySchema: (array: any[]) => JsonSchemaArray;
+/**
+ * Checks if the given JSON schema is of string type.
+ *
+ * @param jsonSchema - The JSON schema to check.
+ * @returns - True if the JSON schema is of string type, false otherwise.
+ */
+export declare const isStringType: (jsonSchema: Partial<JsonSchema>) => jsonSchema is JsonSchemaString;
+/**
+ * Checks if the given JSON schema is of number type.
+ *
+ * @param jsonSchema - The JSON schema to check.
+ * @returns - True if the JSON schema is of number type, false otherwise.
+ */
+export declare const isNumberType: (jsonSchema: Partial<JsonSchema>) => jsonSchema is JsonSchemaNumber;
+/**
+ * Checks if the given JSON schema is of boolean type.
+ *
+ * @param jsonSchema - The JSON schema to check.
+ * @returns - True if the JSON schema is of boolean type, false otherwise.
+ */
+export declare const isBooleanType: (jsonSchema: Partial<JsonSchema>) => jsonSchema is JsonSchemaBoolean;
+/**
+ * Checks if the given JSON schema is of enum type.
+ *
+ * @param jsonSchema - The JSON schema to check.
+ * @returns - True if the JSON schema is of enum type, false otherwise.
+ */
+export declare const isEnumType: (jsonSchema: Partial<JsonSchema>) => jsonSchema is JsonSchemaEnum;
+/**
+ * Checks if the given JSON schema is of object type.
+ *
+ * @param jsonSchema - The JSON schema to check.
+ * @returns - True if the JSON schema is of object type, false otherwise.
+ */
+export declare const isObjectType: (jsonSchema: Partial<JsonSchema>) => jsonSchema is JsonSchemaObject;
+/**
+ * Checks if the given JSON schema is of object type with buttons.
+ *
+ * @param jsonSchema - The JSON schema to check.
+ * @returns - True if the JSON schema is of object type with buttons, false otherwise.
+ */
+export declare const isObjectTypeWithButtons: (jsonSchema: Partial<JsonSchema>) => jsonSchema is JsonSchemaObjectWithButtons;
+/**
+ * Checks if the given JSON schema is of array type.
+ *
+ * @param jsonSchema - The JSON schema to check.
+ * @returns - True if the JSON schema is of array type, false otherwise.
+ */
+export declare const isArrayType: (jsonSchema: Partial<JsonSchema>) => jsonSchema is JsonSchemaArray;
+/**
+ * Checks if the given value is a JSON AnyOf Schema.
+ *
+ * @param value - The value to check.
+ * @returns - True if the value is a JSON AnyOf schema, false otherwise.
+ */
+export declare const isAnyOfSchema: (value: any) => value is JsonSchemaAnyOf;
+/**
+ * Checks if the given value is a JSON Primitive schema.
+ *
+ * @param value - The value to check.
+ * @returns - True if the value is a JSON schema, false otherwise.
+ */
+export declare const isPrimitiveType: (value: any) => value is JsonSchemaString | JsonSchemaNumber | JsonSchemaBoolean | JsonSchemaEnum;
+/**
+ * Creates a Zod string schema from a given JSON schema.
+ *
+ * @param jsonSchema - The JSON schema from which the Zod schema should be created.
+ * @returns - The created Zod string schema.
+ */
+export declare const createZodStringSchema: (jsonSchema: JsonSchemaString) => OptionalZodString;
+/**
+ * Creates a Zod number schema from a given JSON schema.
+ *
+ * @param jsonSchema - The JSON schema from which the Zod schema should be created.
+ * @returns - The created Zod number schema.
+ */
+export declare const createZodNumberSchema: (jsonSchema: JsonSchemaNumber) => OptionalZodNumber;
+/**
+ * Creates a Zod boolean schema from a given JSON schema.
+ *
+ * @param jsonSchema - The JSON schema from which the Zod schema should be created.
+ * @returns - The created Zod boolean schema.
+ */
+export declare const createZodBooleanSchema: (jsonSchema: JsonSchemaBoolean) => OptionalZodBoolean;
+/**
+ * Creates a Zod union schema from a given JSON schema.
+ *
+ * @param jsonSchema - The JSON schema from which the Zod schema should be created.
+ * @returns - The created Zod union schema.
+ */
+export declare const createEnumSchema: (jsonSchema: JsonSchemaEnum) => OptionalZodEnum | OptionalZodEnumMultiple;
+/**
+ * Creates a Zod object schema from a given JSON schema.
+ *
+ * @param jsonSchema - The JSON schema from which the Zod schema should be created.
+ * @returns - The created Zod object schema.
+ */
+export declare const createZodObjectSchema: (jsonSchema: JsonSchemaObject) => OptionalZodZobject;
+/**
+ * Creates a Zod array schema from a given JSON schema.
+ *
+ * @param jsonSchema - The JSON schema from which the Zod schema should be created.
+ * @returns - The created Zod array schema.
+ */
+export declare const createZodArraySchema: (jsonSchema: JsonSchemaArray) => OptionalZodArray;
+export {};