nvent 0.5.15 → 1.0.0-alpha.1

package/dist/module.d.mts

@@ -1,12 +1,185 @@
-import * as _nuxt_schema from '@nuxt/schema';
-import { ModuleConfig, ModuleOptions } from '../dist/runtime/config/types.js';
-export { ModuleOptions } from '../dist/runtime/config/types.js';
+import * as nuxt_schema from 'nuxt/schema';
 
-declare module '@nuxt/schema' {
-    interface RuntimeConfig {
-        nvent: ModuleConfig;
-    }
+/**
+ * nvent module options
+ *
+ * Public API types for the nvent Nuxt module. Kept in a separate file so that
+ * `iii/config.ts` can import them without creating a circular dependency with
+ * `module.ts`.
+ */
+interface NventIiiOptions {
+    iii?: {
+        /** Version of the iii engine to install. Default: 'latest' */
+        version?: string;
+        /** 'local' uses a local binary, 'docker' uses Docker, 'remote' skips lifecycle management */
+        mode?: 'local' | 'docker' | 'remote';
+        /** WebSocket URL for workers to connect to (default: ws://localhost:49134) */
+        wsUrl?: string;
+        /** HTTP port for iii REST API (default: 3111) */
+        httpPort?: number;
+        /** HTTP host for iii REST API (default: 'localhost') */
+        httpHost?: string;
+        /** WebSocket port for workers (default: 49134) */
+        wsPort?: number;
+        /** WebSocket port for the Stream module (default: 3112) */
+        streamPort?: number;
+        /** Whether nvent manages engine lifecycle. Default: true in dev, false in prod */
+        managed?: boolean;
+        modules?: {
+            state?: boolean;
+            queue?: boolean;
+            cron?: boolean;
+            observability?: boolean;
+            stream?: boolean;
+        };
+        /** State module adapter configuration */
+        state?: {
+            adapter?: {
+                type: 'kv';
+                storeMethod?: 'file_based' | 'in_memory';
+                filePath?: string;
+            } | {
+                type: 'redis';
+                redisUrl?: string;
+            };
+        };
+        /**
+         * Queue module configuration.
+         * Named queues must be declared here for the iii engine to route messages through them.
+         */
+        queue?: {
+            adapter?: {
+                type: 'builtin';
+                storeMethod?: 'file_based' | 'in_memory';
+                filePath?: string;
+            } | {
+                type: 'redis';
+                redisUrl?: string;
+            } | {
+                type: 'rabbitmq';
+                amqpUrl?: string;
+            };
+            queueConfigs?: Record<string, {
+                type?: 'standard' | 'fifo';
+                concurrency?: number;
+                maxRetries?: number;
+                backoffMs?: number;
+                /** FIFO only: field in the payload used to group messages */
+                messageGroupField?: string;
+            }>;
+        };
+        /** Cron module adapter configuration */
+        cron?: {
+            adapter?: {
+                type: 'kv';
+            } | {
+                type: 'redis';
+                redisUrl?: string;
+            };
+        };
+        /** WebSocket Stream module configuration */
+        stream?: {
+            host?: string;
+            authFunction?: string | null;
+            adapter?: {
+                type: 'kv';
+                storeMethod?: 'file_based' | 'in_memory';
+                filePath?: string;
+            } | {
+                type: 'redis';
+                redisUrl?: string;
+            };
+        };
+        /** REST API module extra settings */
+        restApi?: {
+            host?: string;
+            defaultTimeout?: number;
+            concurrencyRequestLimit?: number;
+        };
+        /** OtelModule (observability) configuration */
+        observability?: {
+            enabled?: boolean;
+            serviceName?: string;
+            serviceVersion?: string;
+            serviceNamespace?: string;
+            /**
+             * Trace export destination.
+             * 'memory' = queryable via iii API / console (default).
+             * 'otlp'   = external collector (set endpoint too).
+             * 'both'   = memory + otlp.
+             */
+            exporter?: 'memory' | 'otlp' | 'both';
+            endpoint?: string;
+            samplingRatio?: number;
+            memoryMaxSpans?: number;
+            metricsEnabled?: boolean;
+            metricsExporter?: 'memory' | 'otlp';
+            metricsRetentionSeconds?: number;
+            metricsMaxCount?: number;
+            logsEnabled?: boolean;
+            logsExporter?: 'memory' | 'otlp' | 'both';
+            logsMaxCount?: number;
+            logsRetentionSeconds?: number;
+            logsBatchSize?: number;
+            logsFlushIntervalMs?: number;
+            logsSamplingRatio?: number;
+            logsConsoleOutput?: boolean;
+            level?: 'trace' | 'debug' | 'info' | 'warn' | 'error';
+            format?: 'default' | 'json';
+        };
+        /**
+         * Minimum log level for iii engine output.
+         * 'none' silences all output, 'error' shows only errors, 'warn' shows warnings + errors,
+         * 'info' shows everything. Default: 'warn'
+         */
+        logLevel?: 'none' | 'error' | 'warn' | 'info';
+        /**
+         * Enable the iii-console web UI (separate binary, http://localhost:3113).
+         * Pass `true` for defaults or an object to customise.
+         */
+        console?: boolean | {
+            /** Version to install. Default: same as iii engine version */
+            version?: string;
+            /** Port for the console web UI. Default: 3113 */
+            port?: number;
+            /** Host for the console web UI. Default: 'localhost' */
+            host?: string;
+            /** Enable the Flow visualization page */
+            flow?: boolean;
+        };
+    };
+    functions?: {
+        /** Directory under server/ where functions are, relative to serverDir (default: 'functions') */
+        dir?: string;
+        python?: {
+            /**
+             * Path to the Python executable used **in development only** (e.g. a virtualenv).
+             * Has no effect in production — set `NVENT_PYTHON_BIN` env var instead.
+             * Default: 'python3'
+             * Example: '.venv/bin/python3'
+             */
+            devPath?: string;
+            /**
+             * Skip Python worker support entirely (no Python scanning, no workers started).
+             * Useful when the project has no Python functions. Default: false
+             */
+            skip?: boolean;
+        };
+    };
+    app?: {
+        /** Enable the nvent app UI and its built-in route. Default: true */
+        enabled?: boolean;
+        /** Route path for the nvent app. Default: '/_nvent' */
+        routePath?: string;
+        /**
+         * Layout to use for the nvent app route.
+         * Set to false for no layout, or a string to use a named layout.
+         * Default: false
+         */
+        layout?: string | false;
+    };
 }
-declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, {}, true>;
+
+declare const _default: nuxt_schema.NuxtModule<NventIiiOptions, NventIiiOptions, false>;
 
 export { _default as default };

package/dist/module.json

@@ -1,6 +1,6 @@
 {
   "name": "nvent",
-  "version": "0.5.15",
+  "version": "1.0.0-alpha.1",
   "configKey": "nvent",
   "builder": {
     "@nuxt/module-builder": "1.0.2",