jails.stdlib 1.1.0 → 1.2.0

package/channel/README.md

@@ -0,0 +1,97 @@
+# channel
+
+```ts 
+Channel({
+  target?: Window | HTMLIFrameElement,
+  accept?: string[],
+  origin?: string
+}) 
+```
+
+
+# 📬 Channel API Documentation
+
+The `channel` utility provides a lightweight, secure interface for sending and receiving messages between windows or iframes using `postMessage`.
+
+---
+
+## ✅ Features
+
+* Easy dispatch and subscription to custom message actions.
+* Secure origin validation.
+* Works with iframes or separate window contexts.
+
+---
+
+## 🧪 Usage
+
+### Parent Page
+
+```ts
+import { Channel } from 'jails.stdlib/channel'
+
+const channel = Channel({
+  target: document.getElementById('myIframe'), // <iframe id="myIframe" />
+  accept: ['*']         // Allowed origins
+})
+
+// Send message to iframe
+channel.send('hello', { user: 'Alice' })
+
+// Add more listeners later
+channel.on('hi', (data) => {
+  console.log('Iframe said hi!', data)
+})
+```
+
+### Iframe Page
+
+```ts
+const channel = Channel({
+  target: window.parent,
+  accept: ['*']
+})
+```
+
+---
+
+## 🧹 API
+
+### `Channel(options)`
+
+Creates a new Channel instance.
+
+#### Options:
+
+| Option    | Type                          | Description                             |
+| --------- | ----------------------------- | --------------------------------------- |
+| `target`  | `Window \| HTMLIFrameElement` | Target to send messages to              |
+| `accept`  | `string[]`                    | Allowed origins (`['*']` to accept all) |
+| `origin`  | `string`                      | The origin used when sending messages, `default`: location.origin |
+
+---
+
+### `.emit(event: string, payload?: any)`
+
+Sends a message to the target window.
+
+```ts
+channel.emit('say:hi', { name: 'Bob' })
+```
+
+---
+
+### `.on(event: string, callback: function )`
+
+Listen to an event from the target window.
+
+```ts
+channel.on('logout', () => console.log('Logging out...'))
+```
+
+---
+
+## 🔒 Security Notes
+
+* Always **specify allowed origins** in `accept` to avoid cross-site scripting risks.
+* Avoid using `'*'` unless absolutely necessary (e.g., during development).

package/channel/index.d.ts

@@ -0,0 +1,9 @@
+export declare const Channel: ({ target, accept, origin }: {
+    target?: any;
+    accept?: any;
+    origin?: string;
+}) => {
+    on(name: any, callback: any): void;
+    emit(event: any, ...payload: any[]): void;
+    remove(name: any): void;
+};

package/channel/index.js

@@ -0,0 +1,30 @@
+const a = ({
+  target: o = null,
+  accept: i = [],
+  origin: d = location.origin
+}) => {
+  const t = (o == null ? void 0 : o.contentWindow) || o, s = {};
+  return window.addEventListener("message", (n) => {
+    if (i.includes("*") || i.includes(n.origin)) {
+      const { payload: e, event: l } = n.data;
+      s[l] && s[l].apply(null, e);
+    } else
+      throw {
+        type: "ACCESS DENIED",
+        message: "Cant receive message from: " + n.origin
+      };
+  }), {
+    on(n, e) {
+      s[n] = e;
+    },
+    emit(n, ...e) {
+      t.postMessage({ event: n, payload: e }, d);
+    },
+    remove(n) {
+      delete s[n];
+    }
+  };
+};
+export {
+  a as Channel
+};

package/channel/index.ts

@@ -0,0 +1,39 @@
+
+export const Channel = ({
+	target  = null as any,  
+	accept  = [] as any, 
+	origin  = location.origin
+}) => {
+
+	const win = target?.contentWindow || target 
+	const events = {}
+	
+	window.addEventListener('message', (e) => {
+		if( accept.includes('*') || accept.includes(e.origin) ) {
+			const { payload, event } = e.data 
+			if( events[event] ) {
+				events[event].apply(null, payload)
+			}
+		} else {
+			throw {
+				type	: 'ACCESS DENIED', 
+				message	: 'Cant receive message from: ' + e.origin
+			}
+		}
+	})
+
+	return {
+
+		on(name, callback) {
+			events[name] = callback
+		},
+
+		emit(event, ...payload) {
+			win.postMessage({ event, payload }, origin)
+		},
+
+		remove(name) {
+			delete events[name]
+		}
+	}
+}

package/channel/index.umd.js

@@ -0,0 +1 @@
+(function(n,i){typeof exports=="object"&&typeof module!="undefined"?i(exports):typeof define=="function"&&define.amd?define(["exports"],i):(n=typeof globalThis!="undefined"?globalThis:n||self,i(n.channel={}))})(this,(function(n){"use strict";const i=({target:s=null,accept:d=[],origin:f=location.origin})=>{const u=(s==null?void 0:s.contentWindow)||s,t={};return window.addEventListener("message",e=>{if(d.includes("*")||d.includes(e.origin)){const{payload:o,event:l}=e.data;t[l]&&t[l].apply(null,o)}else throw{type:"ACCESS DENIED",message:"Cant receive message from: "+e.origin}}),{on(e,o){t[e]=o},emit(e,...o){u.postMessage({event:e,payload:o},f)},remove(e){delete t[e]}}};n.Channel=i,Object.defineProperty(n,Symbol.toStringTag,{value:"Module"})}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jails.stdlib",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "The Jails Standard Library",
   "types": "index.d.ts",
   "repository": {

package/messenger/README.md

@@ -1,109 +0,0 @@
-# messenger
-
-```ts 
-messenger({
-  target?: Window | HTMLIFrameElement,
-  accept?: string[],
-  actions?: Record<string, (payload: any) => void>,
-  origin?: string
-}) 
-```
-# 📬 Messenger API Documentation
-
-The `messenger` utility provides a lightweight, secure interface for sending and receiving messages between windows or iframes using `postMessage`.
-
----
-
-## ✅ Features
-
-* Easy dispatch and subscription to custom message actions.
-* Secure origin validation.
-* Works with iframes or separate window contexts.
-* Extensible via `subscribe`.
-
----
-
-## 🧪 Usage
-
-### Parent Page
-
-```ts
-import { messenger } from 'jails.stdlib/messenger'
-
-const msg = messenger({
-  target: document.getElementById('myIframe'), // <iframe id="myIframe" />
-  accept: ['https://child-app.com'],           // Allowed origins
-  actions: {
-    reply(data) {
-      console.log('Received from iframe:', data)
-    }
-  }
-})
-
-// Send message to iframe
-msg.dispatch('init', { user: 'Alice' })
-
-// Add more listeners later
-msg.subscribe({
-  status: (msg) => console.log('Status update:', msg)
-})
-```
-
-### Iframe Page
-
-```ts
-const msg = messenger({
-  target: window.parent,
-  accept: ['https://parent-app.com'],
-  actions: {
-    init(data){
-      console.log('Init from parent:', data)
-      msg.dispatch('reply', { received: true })
-    }
-  }
-})
-```
-
----
-
-## 🧹 API
-
-### `messenger(options)`
-
-Creates a new Messenger instance.
-
-#### Options:
-
-| Option    | Type                          | Description                             |
-| --------- | ----------------------------- | --------------------------------------- |
-| `target`  | `Window \| HTMLIFrameElement` | Target to send messages to              |
-| `accept`  | `string[]`                    | Allowed origins (`['*']` to accept all) |
-| `actions` | `Record<string, Function>`    | Message handlers keyed by action name   |
-| `origin`  | `string`                      | The origin used when sending messages   |
-
----
-
-### `.dispatch(action: string, payload?: any)`
-
-Sends a message to the target window.
-
-```ts
-msg.dispatch('sayHello', { name: 'Bob' })
-```
-
----
-
-### `.subscribe(newActions: Record<string, Function>)`
-
-Adds more actions to the messenger at runtime.
-
-```ts
-msg.subscribe({ logout: () => console.log('Logging out...') })
-```
-
----
-
-## 🔒 Security Notes
-
-* Always **specify allowed origins** in `accept` to avoid cross-site scripting risks.
-* Avoid using `'*'` unless absolutely necessary (e.g., during development).

package/messenger/index.d.ts

@@ -1,9 +0,0 @@
-export declare const messenger: ({ target, accept, actions, origin }?: {
-    target?: any;
-    accept?: any;
-    actions?: any;
-    origin?: string;
-}) => {
-    dispatch(action: string, payload?: any): void;
-    subscribe(actions_: any): void;
-};

package/messenger/index.js

@@ -1,39 +0,0 @@
-var w = Object.defineProperty;
-var l = Object.getOwnPropertySymbols;
-var a = Object.prototype.hasOwnProperty, p = Object.prototype.propertyIsEnumerable;
-var r = (n, i, s) => i in n ? w(n, i, { enumerable: !0, configurable: !0, writable: !0, value: s }) : n[i] = s, d = (n, i) => {
-  for (var s in i || (i = {}))
-    a.call(i, s) && r(n, s, i[s]);
-  if (l)
-    for (var s of l(i))
-      p.call(i, s) && r(n, s, i[s]);
-  return n;
-};
-const f = ({
-  target: n = null,
-  accept: i = [],
-  actions: s = {},
-  origin: c = location.origin
-} = {}) => {
-  const m = (n == null ? void 0 : n.contentWindow) || n;
-  return window.addEventListener("message", (e) => {
-    if (i.includes("*") || i.includes(e.origin)) {
-      const { action: o, payload: u } = e.data;
-      o in s && s[o](u);
-    } else
-      throw {
-        type: "ACCESS DENIED",
-        message: "Cant receive message from: " + e.origin
-      };
-  }), {
-    dispatch(e, o) {
-      m.postMessage({ action: e, payload: o }, c);
-    },
-    subscribe(e) {
-      s = d(d({}, e), s);
-    }
-  };
-};
-export {
-  f as messenger
-};

package/messenger/index.ts

@@ -1,38 +0,0 @@
-
-export const messenger = ({ 
-	
-	target  = null as any,  
-	accept  = [] as any, 
-	actions = {} as any,
-	origin  = location.origin
-
-} = {}) => {
-
-	const win = target?.contentWindow || target
-
-	window.addEventListener('message', ( event ) => {
-
-		if( accept.includes('*') || accept.includes(event.origin) ) {
-			const { action, payload } = event.data 
-			if( action in actions ) {
-				actions[ action ]( payload as any )
-			}
-		} else {
-			throw {
-				type	: 'ACCESS DENIED', 
-				message	: 'Cant receive message from: ' + event.origin
-			}
-		}
-	})
-	
-	return {
-
-		dispatch( action: string, payload?: any ) {
-			win.postMessage({ action, payload }, origin)
-		},
-
-		subscribe( actions_: any ) {
-			actions = { ...actions_, ...actions }
-		}
-	}
-}

package/messenger/index.umd.js

@@ -1 +0,0 @@
-(function(i,e){typeof exports=="object"&&typeof module!="undefined"?e(exports):typeof define=="function"&&define.amd?define(["exports"],e):(i=typeof globalThis!="undefined"?globalThis:i||self,e(i.messenger={}))})(this,(function(i){"use strict";var p=Object.defineProperty;var u=Object.getOwnPropertySymbols;var g=Object.prototype.hasOwnProperty,y=Object.prototype.propertyIsEnumerable;var l=(i,e,n)=>e in i?p(i,e,{enumerable:!0,configurable:!0,writable:!0,value:n}):i[e]=n,f=(i,e)=>{for(var n in e||(e={}))g.call(e,n)&&l(i,n,e[n]);if(u)for(var n of u(e))y.call(e,n)&&l(i,n,e[n]);return i};const e=({target:n=null,accept:t=[],actions:o={},origin:r=location.origin}={})=>{const c=(n==null?void 0:n.contentWindow)||n;return window.addEventListener("message",s=>{if(t.includes("*")||t.includes(s.origin)){const{action:d,payload:m}=s.data;d in o&&o[d](m)}else throw{type:"ACCESS DENIED",message:"Cant receive message from: "+s.origin}}),{dispatch(s,d){c.postMessage({action:s,payload:d},r)},subscribe(s){o=f(f({},s),o)}}};i.messenger=e,Object.defineProperty(i,Symbol.toStringTag,{value:"Module"})}));