@csedl/svelte-on-rails 12.3.2 → 13.0.0

package/index.js

@@ -1,23 +1,6 @@
-import { SvelteOnRails } from "./src/config.js";
-import { Application } from "@hotwired/stimulus"
+export { addComponentStreamListener } from "./src/streams/componentStreamListener.js";
+export { dispatchSvelteStreamEvent } from "./src/streams/dispatch-event.js";
+export { debugLog, streamDebugLog } from "./src/logger.js";
 
 
-//console.error('test-error')
 
-if (!window.Stimulus) {
-    window.Stimulus = Application.start()
-}
-
-// initialize svelte-on-rails
-
-import controller from "./src/hydrate-build/svelte-on-rails-controller.js";
-
-Stimulus.register('svelte-on-rails', controller)
-
-// initialize stream actions
-
-import turboStreamController from "./src/streams/turbo-stream-controller.js";
-
-Stimulus.register('svelte-on-rails-turbo-stream', turboStreamController)
-
-export { SvelteOnRails };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@csedl/svelte-on-rails",
-  "version": "12.3.2",
+  "version": "13.0.0",
   "description": "Client-side runtime for svelte-on-rails: hydration, SSR build support & Turbo Stream actions",
   "main": "index.js",
   "type": "module",
@@ -12,20 +12,12 @@
   },
   "exports": {
     ".": "./index.js",
-    "./utils": "./utils/index.js",
-    "./config": "./src/config.js",
+    "./init": "./src/config.js",
     "./ssr": {
-      "types": "./dist/ssr/dev-module-map.d.ts",
-      "default": "./dist/ssr/dev-module-map.js"
-    },
-    "./src/streams/componentStreamListener": "./src/streams/componentStreamListener.js",
-    "./src/streams/dispatch-event.js": "./src/streams/dispatch-event.js",
-    "./src/logger.js": "./src/logger.js",
-    "./src/config.js": "./src/config.js"
-  },
-  "peerDependencies": {
-    "@hotwired/stimulus": "^3.2.2",
-    "svelte": "^5.50.0"
+      "types": "./ssr.d.ts",
+      "import": "./ssr.js",
+      "default": "./ssr.js"
+    }
   },
   "repository": {
     "type": "git",
@@ -45,6 +37,10 @@
     "vite": "^7.3.1",
     "vite-plugin-dts": "^4.5.4"
   },
+  "peerDependencies": {
+    "@hotwired/stimulus": "^3.2.2",
+    "svelte": "^5.50.0"
+  },
   "dependencies": {
     "fast-glob": "^3.3.2"
   },

package/src/config.js

@@ -1,32 +1,32 @@
+import {Application} from "@hotwired/stimulus";
+import controller from "./hydrate-build/svelte-on-rails-controller.js";
+import turboStreamController from "./streams/turbo-stream-controller.js";
+import {debugLog} from "./logger.js";
+import {validateOptions} from "./utils.js";
 
 let _debug = false;
-
-let _lazyComponents = {}
-let _defaultComponents = import.meta.glob("/**/*.svelte", { eager: false, import: "default" });
-
-import {debugLog} from "./logger.js";
+let _lazyComponents = {};
+let _defaultComponents = import.meta.glob("/**/*.svelte", {eager: false, import: "default"});
 
 export const SvelteOnRails = {
 
     async loadComponent(componentKey) {
-
         // fetch loader from store
 
-        let components
+        let components;
         if (Object.keys(_lazyComponents).length === 0) {
             debugLog("lazyComponents not set: falling back to default «import.meta.glob(['/**/*.svelte'], {eager: false, import: 'default'})»");
             components = _defaultComponents;
         } else {
-            debugLog(`using given lazyComponents`);
-            components = _lazyComponents
+            debugLog("using given lazyComponents");
+            components = _lazyComponents;
         }
 
-
         const loader = components[componentKey];
 
         if (!loader) {
+            console.error(`[SOR] components =>`, components);
             throw new Error(`[SOR] Component not found: «${componentKey}»\nAvailable imported Components are:\n\n+++\n • ${Object.keys(components).join('\n • ')}\n+++\n`);
-            //return;
         } else {
             debugLog(`Component found: ${componentKey}`);
         }
@@ -39,30 +39,59 @@ export const SvelteOnRails = {
             comp = loader;
         } else {
             comp = await loader();
-            if (typeof comp !== 'function') {
+            if (typeof comp !== "function") {
                 throw new Error(`[SOR] Component is not a function: ${componentKey}\nYou may need to use vite.meta.glob(..., {...import: "default"})`);
             }
         }
 
         // finish
 
-        debugLog(`Component loaded:`, comp);
+        debugLog("Component loaded:", comp);
         return comp;
     },
 
-    set lazyComponents(value) {
-        debugLog(`lazyComponents set:`, value);
-        _lazyComponents = value;
-    },
-
-
     get debug() {
         return _debug;
     },
+
     set debug(value) {
         _debug = !!value;
         debugLog(`Debug mode: ${_debug ? "enabled" : "disabled"}`);
     },
+
+    get lazyComponents() {
+        return _lazyComponents;
+    },
+
+    set lazyComponents(value) {
+        debugLog("lazyComponents set:", value);
+        _lazyComponents = value;
+    },
+
+    start(options = {}) {
+
+        validateOptions(options, {
+            debug: "boolean",
+            lazyComponents: "object",
+        });
+
+        if (Object.prototype.hasOwnProperty.call(options, "debug")) {
+            this.debug = options.debug;
+        }
+
+        if (Object.prototype.hasOwnProperty.call(options, "lazyComponents")) {
+            this.lazyComponents = options.lazyComponents;
+        }
+
+        if (!window.Stimulus) {
+            window.Stimulus = Application.start();
+        }
+
+        window.Stimulus.register("svelte-on-rails", controller);
+        window.Stimulus.register("svelte-on-rails-turbo-stream", turboStreamController);
+
+        return this;
+    }
 };
 
 window.SvelteOnRails = SvelteOnRails;

package/src/logger.js

@@ -1,11 +1,11 @@
 import {SvelteOnRails} from './config.js'
 
 export function debugLog(message, object, object2) {
-    log( null, message, object, object2);
+    log(null, message, object, object2);
 }
 
 export function streamDebugLog(message, object, object2) {
-    log( 'stream', message, object, object2);
+    log('stream', message, object, object2);
 }
 
 function log(namespace, message, object, object2) {
@@ -21,4 +21,19 @@ function log(namespace, message, object, object2) {
             console.log(`[SOR]${nmsp} ${message}`);
         }
     }
+}
+
+export function logSeparator(title) {
+    if (!title) {
+        return '='.repeat(80)
+    } else {
+        const tit = `=== ${title} ===`;
+        const l = 80 - tit.length;
+        if (l >= 1) {
+            const l1 = Math.floor(l / 2);
+            return ('='.repeat(l1) + tit + '='.repeat(l - l1))
+        } else {
+            return tit;
+        }
+    }
 }

package/src/utils.js

@@ -29,4 +29,29 @@ export function componentRenderError(component, error, ssr = false) {
       </small>
     </div>
   `)
-}
+}
+
+export function validateOptions(givenOptions, validations) {
+    const validKeys = Object.keys(validations);
+     for (const option of Object.keys(givenOptions)) {
+        // Check if the option is allowed
+        if (!validKeys.includes(option)) {
+            throw new Error(
+                `Invalid option: "${option}". ` +
+                `Available options are:\n • ${validKeys.map(k => `"${k}"`).join("\n • ")}`
+            );
+        }
+
+        // Check the type
+        const expectedType = validations[option];
+        const actualType = typeof givenOptions[option];
+
+        if (actualType !== expectedType) {
+            throw new Error(
+                `Option «${option}»: expected type «${expectedType}», ` +
+                `but received «${actualType}» ` +
+                `(value: ${JSON.stringify(givenOptions[option])})`
+            );
+        }
+    }
+}

package/ssr.d.ts

@@ -0,0 +1,10 @@
+import type { Plugin } from 'vite';
+import * as fastGlob from 'fast-glob';
+
+export declare function devModuleMap(options?: {
+    fileName?: string;
+    includeNodeModules?: boolean;
+    moduleFilter?: (id: string) => boolean;
+}): Plugin;
+
+export { fastGlob };

package/ssr.js

@@ -0,0 +1,4 @@
+import { devModuleMap } from './dist/ssr/dev-module-map.js';
+import fastGlob from 'fast-glob';
+
+export { devModuleMap, fastGlob };

package/vite.config.ts

@@ -25,7 +25,7 @@ export default defineConfig({
             external: [
                 '@hotwired/stimulus',
                 'svelte',
-                // add anything else that should stay external
+                'fast-glob',
             ],
         },
 

package/utils/index.js

@@ -1,3 +0,0 @@
-export { SvelteOnRails } from "../src/config.js";   // assuming config.js uses export default
-export { dispatchSvelteStreamEvent } from "../src/streams/dispatch-event.js";
-export { streamDebugLog } from "../src/logger.js";