jails-js 6.9.8 → 6.9.10

package/readme.md

@@ -1,13 +1,16 @@
-<p align="center">
-  <img width="200" src="https://github.com/user-attachments/assets/8b4dbfb9-f05e-4b83-8d42-8847038a97e2" alt="Jails" />
-</p>
 
-<h1 align="center">Jails</h1>
 
-<h3 align="center">An Elegant and Minimalistic<br /> Web Components Micro-Framework</h3>
+<p align="center" height="100">
+  <img width="250"  alt="Jails - A minimalistic Micro Framework" src="https://github.com/user-attachments/assets/5e2eee1a-5f8f-4eed-abba-7422a5258245" />
+  
+</p>
+
+<h1 align="center">An Elegant and Minimalistic<br /> Micro-Framework</h3>
 
 <div align="center">
-  <table align="center" border="0">
+  <br />
+    <br />
+  <table width="100%" align="center" border="0">
     <tr><td align="center">🏝 Built for <br/><a href="https://www.patterns.dev/posts/islands-architecture/" target="_blank">Island Architecture</a></td</tr>
     <td align="center">ƛ Inspired by <br/><a href="https://guide.elm-lang.org/architecture/" target="_blank">Elm Architecture</a></td>
     <td align="center">🔗 Ready for <br/><a href="https://htmx.org/essays/hypermedia-driven-applications" target="_blank">hypermedia applications</a></td></tr>
@@ -28,9 +31,19 @@
 The JavaScript ecosystem, including browsers and tools, has undergone significant evolution over the years. However, it's evident that many of the complexities introduced by frameworks today may not be essential for the majority of web applications. The prevailing trend in modern app development seems to prioritize expertise in frameworks over mastery of the language itself, often leading to a sense of being confined within the framework ecosystem.
 
 Jails was designed to be:
-- **Decoupled** - Backend-agnostic, our solution seamlessly integrates with any backend framework or programming language. It refrains from importing styles and ensures a clean demarcation by avoiding mixing HTML within the codebase.
-- **Lightweight** - Lightweight, weighing in at just around 5kb when gzipped. It enhances your application's performance by progressively lightening the load, separating HTML from your JavaScript code. This practice results in smaller bundles and a more streamlined application.
-- **Interoperable** - It seamlessly integrates and functions alongside any other vanilla UI or behavioral libraries. You no longer need to wait for a specific Jails Chart.js library to be available; simply integrate it into your application hassle-free.
+
+<table width="100%" align="center" border="0">
+    <tr>
+      <th>🧩 Decoupled</th>
+      <th>⚡️ Lightweight</th>
+      <th>📦 Interoperable</th>
+    </tr>
+    <tr>
+      <td align="center">Backend-agnostic, our solution seamlessly integrates with any backend framework or back-end programming language.</td>
+      <td align="center">Lightweight, just around 5kb when gzipped. It enhances your application's performance by progressively, separating HTML from your JavaScript code. </td>
+      <td align="center">It seamlessly integrates and functions alongside any other vanilla UI or behavioral libraries. </td>
+    </tr>    
+</table>
 
 <br clear="all" />
 <br />

package/src/element.ts

@@ -45,3 +45,7 @@ export const Element = ({ component, templates, start }) => {
 		}
 	}
 }
+
+export const getInstance = ( node ) => {
+	return register.get(node)
+}

package/src/index.ts

@@ -1,14 +1,16 @@
-import { Element } from './element'
+import { Element, getInstance } from './element'
 import { template, templateConfig as config } from './template-system'
 
+globalThis.__jails__ = globalThis.__jails__ || { components: {} }
+globalThis.__jails__.getInstance = getInstance
+
+export { getInstance }
 export { publish, subscribe } from './utils/pubsub'
 
 export const templateConfig = (options) => {
 	config( options )
 }
 
-globalThis.__jails__ = globalThis.__jails__ || { components: {} }
-
 export const register = ( name, module, dependencies ) => {
 	const { components } = globalThis.__jails__
 	components[ name ] = { name, module, dependencies }

package/tsconfig.json

@@ -2,7 +2,6 @@
   "compilerOptions": {
 		"declaration": true,
     "emitDeclarationOnly": true,
-    "outDir": "dist",
     /* Visit https://aka.ms/tsconfig to read more about this file */
 
     /* Projects */

package/types.d.ts

@@ -9,7 +9,7 @@ export declare const templateConfig: (options: any) => void;
 export declare const register: (name: string, module: any, dependencies?: any) => void
 export declare const start: (target?: HTMLElement) => void;
 export declare const subscribe:( subject: string, callback: (data:any) => void ) => Function
-export declare const publish: ( subject: string, data :any ) => void
+export declare const publish: ( subject: string, data ?:any ) => void
 
 export type Component = {
 
@@ -24,11 +24,11 @@ export type Component = {
 		getRaw() : any
 	}
 
-	effect( callback: ( state: any ) => Promise<any> | void )
+	effect( callback: ( state: any ) => Promise<any> | void ): void
 
 	main( mainArgs: ( t: Component ) => void ): void
 
-	publish( name: string, value: any ) : void
+	publish( name: string, value?: any ) : void
 
 	subscribe( name: string, value: Function ) : Function