@splendidlabz/utils 1.5.0-beta.5 → 1.5.0-beta.6

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @splendidlabz/utils
 
+## 1.5.0-beta.6
+
+### Minor Changes
+
+- Add utilities for SSE
+
 ## 1.5.0-beta.5
 
 ### Minor Changes

package/dom/observers/resize-observer.js

@@ -2,10 +2,40 @@
 import { dispatchEvent } from '../events.js'
 import { useObserverMethodOnTarget } from './observer.js'
 
+/**
+ * Creates and manages a ResizeObserver instance to monitor size changes of a target element.
+ * 
+ * @param {Element|Window|NodeList|Element[]} target - The element(s) to observe. 
+ *   - If window is provided, document.body will be observed instead.
+ *   - If NodeList or Array of elements is provided, all elements will be observed.
+ * @param {Object} options - Configuration options for the resize observer
+ * @param {boolean} [options.observe=true] - Whether to start observing immediately. If false, the observer won't be created.
+ * @param {Function} [options.callback] - Optional callback function that will be called when resize changes are detected.
+ *                                          If not provided, a 'resize-obs' event will be dispatched on the target.
+ * @param {Object} [options...] - Additional options to pass to ResizeObserver.observe()
+ * 
+ * @returns {Object} An object with methods to control the observer:
+ *   - observe(target, options): Start observing a new target element
+ *   - unobserve(target): Stop observing a target element
+ *   - disconnect(): Disconnect the observer and stop all observations
+ *   - destroy(): Alias for disconnect()
+ * 
+ * @example
+ * // Basic usage with callback
+ * resizeObserver(element, {
+ *   callback: ({ entry, entries, observer }) => {
+ *     console.log('Element resized:', entry.contentRect);
+ *   }
+ * });
+ * 
+ * @example
+ * // Usage with event listener
+ * resizeObserver(element);
+ * element.addEventListener('resize-obs', ({ detail }) => {
+ *   console.log('Element resized:', detail.entry.contentRect);
+ * });
+ */
 export function resizeObserver(target, options) {
-  // We set the option here to prevent observer from being created unless necessary.
-  options = { observe: true, ...options }
-  if (!options.observe) return
   const { callback, ...opts } = options
   const observer = new ResizeObserver(observerFn)
 

package/lib/index.js

@@ -7,6 +7,7 @@ export * from './functions/index.js'
 export * from './numbers/index.js'
 export * from './objects/index.js'
 export * from './promises/index.js'
+export * from './sse.js'
 export * from './strings/index.js'
 export * from './style/index.js'
 export * from './symbols/index.js'

package/lib/sse.js

@@ -0,0 +1,64 @@
+// Server Sent Events (SSE) 
+import { omitEmpty } from './objects/omit-empty.js'
+
+export function createSSE({ event, data, id, retry }) {
+  const eventString = event ? `event: ${event}\n` : ''
+  const idString = id ? `id: ${id}\n` : ''
+  const retryString = retry ? `retry: ${retry}\n` : ''
+  
+  if (typeof data === 'object') data = JSON.stringify(data)
+  const dataString = data ? `data: ${data}\n` : ''
+
+  return `${eventString}${dataString}${idString}${retryString}\n`
+}
+
+/**
+ * Parses a single SSE message into a structured object
+ * @param {string} message - The raw SSE message
+ * @returns {Object|null} The parsed message or null if invalid
+ * @property {string} [event] - The event type if specified
+ * @property {string|Object} data - The message data (parsed as JSON if possible)
+ * @property {string} [id] - The message ID if specified
+ * @property {number} [retry] - The retry interval if specified
+ */
+export function parseSSE(message) {
+  // console.log('parsing SSE', message);
+  const lines = message.split('\n')
+  const result = {
+    event: 'message', // Default event type
+    data: '',
+    id: null,
+    retry: null
+  }
+
+  for (const line of lines) {
+    if (line.startsWith('data:')) {
+      const data = line.slice(5).trim()
+      // Try to parse as JSON
+      try { result.data = JSON.parse(data) } 
+      // If not JSON, use as string
+      catch { result.data = data }
+      continue
+    } 
+    
+    if (line.startsWith('event:')) {
+      result.event = line.slice(6).trim()
+      continue
+    } 
+    
+    if (line.startsWith('id:')) {
+      result.id = line.slice(3).trim()
+      continue
+    } 
+    
+    if (line.startsWith('retry:')) {
+      result.retry = parseInt(line.slice(6).trim(), 10)
+      continue
+    }
+  }
+
+
+  const ret = omitEmpty(result)
+  // Only return if we have data
+  return ret.data ? ret : null
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@splendidlabz/utils",
-  "version": "1.5.0-beta.5",
+  "version": "1.5.0-beta.6",
   "description": "",
   "type": "module",
   "sideEffects": false,