@overlaysymphony/core 0.1.0

package/README.md

@@ -0,0 +1,11 @@
+# `@overlaysymphony/core`
+
+The is the core module for the [OverlaySymphony interactive streaming framework](https://github.com/OverlaySymphony/overlaysymphony), though at the moment it only includes a few utility helpers.
+
+**You should not need to use this package directly.**
+
+# OverlaySymphony
+
+An interactive streaming framework for orchestrating overlays, bots, and other services.
+
+> Note: This project is still very much under development. I use it actively on my own stream, so all releases should be fully functional. I will do my best to follow semver, though I cannot make any guarantees about release timelines or stability at this time.

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@overlaysymphony/core",
+  "version": "0.1.0",
+  "description": "Core module for the OverlaySymphony interactive streaming framework.",
+  "homepage": "https://github.com/OverlaySymphony/overlaysymphony",
+  "type": "module",
+  "exports": {
+    "./libs/*": "./src/libs/*/index.js",
+    "./ui/*": "./src/ui/*.js",
+    "./package.json": "./package.json"
+  },
+  "scripts": {
+    "lint": "pnpm run \"/^lint-.*/\"",
+    "lint-typecheck": "tsc --noEmit",
+    "lint-eslint": "eslint --ext .js --ext .jsx --ext .ts --ext .tsx .",
+    "lint-prettier": "prettier --check .",
+    "lint-depcheck": "depcheck .",
+    "test": "vitest",
+    "dev": "echo TODO",
+    "clean": "rm -rf node_modules/.cache tsconfig.tsbuildinfo dist",
+    "build": "echo TODO"
+  },
+  "devDependencies": {
+    "@overlaysymphony/eslint-config": "workspace:*",
+    "@overlaysymphony/tooling": "workspace:*",
+    "@vitest/coverage-v8": "^2.1.2",
+    "depcheck": "catalog:",
+    "eslint": "catalog:",
+    "prettier": "catalog:",
+    "typescript": "catalog:",
+    "vitest": "^2.1.2"
+  }
+}

package/src/libs/broadcast/broadcast.ts

@@ -0,0 +1,16 @@
+export default function createBroadcaster<Data>(
+  name: string,
+  handler?: (data: Data) => void,
+): (data: Data) => void {
+  const channel = new BroadcastChannel(name)
+
+  if (handler) {
+    channel.onmessage = (_event) => {
+      handler(_event.data as Data)
+    }
+  }
+
+  return (data: Data) => {
+    channel.postMessage(data)
+  }
+}

package/src/libs/broadcast/index.ts

@@ -0,0 +1 @@
+export { default } from "./broadcast.js"

package/src/libs/defer/defer.ts

@@ -0,0 +1,19 @@
+export default function createDefer<Data = void>(): {
+  promise: Promise<Data>
+  resolve: (value: Data) => void
+  reject: (reason?: string) => void
+} {
+  let resolve: ((value: Data) => void) | undefined = undefined
+  let reject: ((reason?: string) => void) | undefined = undefined
+
+  const promise = new Promise<Data>((resolve_, reject_) => {
+    resolve = resolve_
+    reject = reject_
+  })
+
+  return {
+    promise,
+    resolve: resolve as Exclude<typeof resolve, undefined>,
+    reject: reject as Exclude<typeof reject, undefined>,
+  }
+}

package/src/libs/defer/index.ts

@@ -0,0 +1 @@
+export { default } from "./defer.js"

package/src/libs/pubsub/index.ts

@@ -0,0 +1,2 @@
+export { default } from "./pubsub.js"
+export * from "./pubsub.js"

package/src/libs/pubsub/pubsub.ts

@@ -0,0 +1,36 @@
+type Handler<Data> = (data: Data) => void
+
+type Subscriber<Data> = (handler: (data: Data) => void) => () => void
+type Dispatcher<Data> = (data: Data) => void
+
+export interface PubSub<Data> {
+  subscribe: Subscriber<Data>
+  dispatch: Dispatcher<Data>
+}
+
+export default function createPubSub<Data>(): PubSub<Data> {
+  const handlers: Array<Handler<Data>> = []
+
+  function subscribe(handler: Handler<Data>) {
+    handlers.push(handler)
+
+    return () => {
+      const index = handlers.indexOf(handler)
+      if (index === -1) return false
+
+      handlers.splice(index, 1)
+      return true
+    }
+  }
+
+  function dispatch(data: Data) {
+    for (const handler of handlers) {
+      handler(data)
+    }
+  }
+
+  return {
+    subscribe,
+    dispatch,
+  }
+}

package/src/libs/querystring/index.ts

@@ -0,0 +1,2 @@
+export { default } from "./querystring.js"
+export * from "./querystring.js"

package/src/libs/querystring/querystring.ts

@@ -0,0 +1,37 @@
+type ParsedQuerystring = Record<
+  string,
+  string | number | boolean | null | undefined
+>
+
+export function stringify(input: ParsedQuerystring): string {
+  const output: string[] = []
+
+  for (const [key, value] of Object.entries(input)) {
+    if (typeof value !== "undefined" && value !== null) {
+      output.push(`${key}=${value}`)
+    }
+  }
+
+  return output.join("&")
+}
+
+export function parse(input: string): ParsedQuerystring {
+  input = decodeURIComponent(input)
+  if (input[0] === "#") input = input.slice(1)
+  if (input[0] === "?") input = input.slice(1)
+
+  if (input.length === 0) {
+    return {}
+  }
+
+  const output: ParsedQuerystring = {}
+
+  for (const pair of input.split("&")) {
+    const [key, value] = pair.split("=")
+    output[key] = value
+  }
+
+  return output
+}
+
+export default { stringify, parse }

package/src/libs/queue/index.ts

@@ -0,0 +1,2 @@
+export { default } from "./queue.js"
+export * from "./queue.js"

package/src/libs/queue/queue.ts

@@ -0,0 +1,71 @@
+type Handler<Data> = (data: Data) => void
+
+type Listener<Data> = (handler: Handler<Data>) => () => void
+type Enqueuer<Data> = (priority: number, data: Data) => void
+type Dismisser = () => void
+
+export interface Queue<Data> {
+  listen: Listener<Data>
+  enqueue: Enqueuer<Data>
+  dismiss: Dismisser
+}
+
+interface QueueItem<Data> {
+  priority: number
+  data: Data
+}
+
+export default function createQueue<Data>(): Queue<Data> {
+  const handlers: Array<Handler<Data>> = []
+  const queue: Array<QueueItem<Data>> = []
+  let current: { data: Data } | undefined = undefined
+
+  function dispatch(data: Data | undefined) {
+    if (typeof data === "undefined") {
+      current = undefined
+      return
+    }
+
+    current = { data }
+    for (const handler of handlers) {
+      handler(current.data)
+    }
+  }
+
+  function listen(handler: Handler<Data>) {
+    handlers.push(handler)
+
+    return () => {
+      const index = handlers.indexOf(handler)
+      if (index === -1) return false
+
+      handlers.splice(index, 1)
+      return true
+    }
+  }
+
+  function enqueue(priority: number, data: Data) {
+    if (!current) {
+      return dispatch(data)
+    }
+
+    const after = queue.findIndex((item) => item.priority < priority)
+
+    if (after === -1) {
+      queue.push({ priority, data })
+    } else {
+      queue.splice(after, 0, { priority, data })
+    }
+  }
+
+  function dismiss() {
+    const { data } = queue.shift() || {}
+    return dispatch(data)
+  }
+
+  return {
+    listen,
+    enqueue,
+    dismiss,
+  }
+}